com.google.cloud.dialogflow.cx.v3beta1

Class EntityTypesClient

java.lang.Object

com.google.cloud.dialogflow.cx.v3beta1.EntityTypesClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@BetaApi
 @Generated(value="by gapic-generator-java")
public class EntityTypesClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Service for managing [EntityTypes][google.cloud.dialogflow.cx.v3beta1.EntityType].

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName name =
       EntityTypeName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENTITY_TYPE]");
   EntityType response = entityTypesClient.getEntityType(name);
 }
 

Note: close() needs to be called on the EntityTypesClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods

Method	Description	Method Variants
GetEntityType	Retrieves the specified entity type.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getEntityType(GetEntityTypeRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getEntityType(EntityTypeName name) getEntityType(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getEntityTypeCallable()
CreateEntityType	Creates an entity type in the specified agent.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createEntityType(CreateEntityTypeRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createEntityType(AgentName parent, EntityType entityType) createEntityType(String parent, EntityType entityType) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createEntityTypeCallable()
UpdateEntityType	Updates the specified entity type. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateEntityType(UpdateEntityTypeRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateEntityType(EntityType entityType, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateEntityTypeCallable()
DeleteEntityType	Deletes the specified entity type. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteEntityType(DeleteEntityTypeRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteEntityType(EntityTypeName name) deleteEntityType(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteEntityTypeCallable()
ListEntityTypes	Returns the list of all entity types in the specified agent.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listEntityTypes(ListEntityTypesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listEntityTypes(AgentName parent) listEntityTypes(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listEntityTypesPagedCallable() listEntityTypesCallable()
ExportEntityTypes	Exports the selected entity types.	Request object method variants only take one parameter, a request object, which must be constructed before the call. exportEntityTypesAsync(ExportEntityTypesRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. exportEntityTypesOperationCallable() exportEntityTypesCallable()
ImportEntityTypes	Imports the specified entitytypes into the agent.	Request object method variants only take one parameter, a request object, which must be constructed before the call. importEntityTypesAsync(ImportEntityTypesRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. importEntityTypesOperationCallable() importEntityTypesCallable()
ListLocations	Lists information about the supported locations for this service.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listLocations(ListLocationsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listLocationsPagedCallable() listLocationsCallable()
GetLocation	Gets information about a location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getLocation(GetLocationRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getLocationCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of EntityTypesSettings to create(). For example:

To customize credentials:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 EntityTypesSettings entityTypesSettings =
     EntityTypesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 EntityTypesClient entityTypesClient = EntityTypesClient.create(entityTypesSettings);
 

To customize the endpoint:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 EntityTypesSettings entityTypesSettings =
     EntityTypesSettings.newBuilder().setEndpoint(myEndpoint).build();
 EntityTypesClient entityTypesClient = EntityTypesClient.create(entityTypesSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 EntityTypesSettings entityTypesSettings = EntityTypesSettings.newHttpJsonBuilder().build();
 EntityTypesClient entityTypesClient = EntityTypesClient.create(entityTypesSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EntityTypesClient.ListEntityTypesFixedSizeCollection
static class	EntityTypesClient.ListEntityTypesPage
static class	EntityTypesClient.ListEntityTypesPagedResponse
static class	EntityTypesClient.ListLocationsFixedSizeCollection
static class	EntityTypesClient.ListLocationsPage
static class	EntityTypesClient.ListLocationsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EntityTypesClient(EntityTypesSettings settings) Constructs an instance of EntityTypesClient, using the given settings.
protected	EntityTypesClient(EntityTypesStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static EntityTypesClient	create() Constructs an instance of EntityTypesClient with default settings.
static EntityTypesClient	create(EntityTypesSettings settings) Constructs an instance of EntityTypesClient, using the given settings.
static EntityTypesClient	create(EntityTypesStub stub) Constructs an instance of EntityTypesClient, using the given stub for making calls.
EntityType	createEntityType(AgentName parent, EntityType entityType) Creates an entity type in the specified agent.
EntityType	createEntityType(CreateEntityTypeRequest request) Creates an entity type in the specified agent.
EntityType	createEntityType(String parent, EntityType entityType) Creates an entity type in the specified agent.
com.google.api.gax.rpc.UnaryCallable<CreateEntityTypeRequest,EntityType>	createEntityTypeCallable() Creates an entity type in the specified agent.
void	deleteEntityType(DeleteEntityTypeRequest request) Deletes the specified entity type.
void	deleteEntityType(EntityTypeName name) Deletes the specified entity type.
void	deleteEntityType(String name) Deletes the specified entity type.
com.google.api.gax.rpc.UnaryCallable<DeleteEntityTypeRequest,com.google.protobuf.Empty>	deleteEntityTypeCallable() Deletes the specified entity type.
com.google.api.gax.longrunning.OperationFuture<ExportEntityTypesResponse,ExportEntityTypesMetadata>	exportEntityTypesAsync(ExportEntityTypesRequest request) Exports the selected entity types.
com.google.api.gax.rpc.UnaryCallable<ExportEntityTypesRequest,com.google.longrunning.Operation>	exportEntityTypesCallable() Exports the selected entity types.
com.google.api.gax.rpc.OperationCallable<ExportEntityTypesRequest,ExportEntityTypesResponse,ExportEntityTypesMetadata>	exportEntityTypesOperationCallable() Exports the selected entity types.
EntityType	getEntityType(EntityTypeName name) Retrieves the specified entity type.
EntityType	getEntityType(GetEntityTypeRequest request) Retrieves the specified entity type.
EntityType	getEntityType(String name) Retrieves the specified entity type.
com.google.api.gax.rpc.UnaryCallable<GetEntityTypeRequest,EntityType>	getEntityTypeCallable() Retrieves the specified entity type.
com.google.api.gax.httpjson.longrunning.OperationsClient	getHttpJsonOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
com.google.cloud.location.Location	getLocation(com.google.cloud.location.GetLocationRequest request) Gets information about a location.
com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>	getLocationCallable() Gets information about a location.
com.google.longrunning.OperationsClient	getOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
EntityTypesSettings	getSettings()
EntityTypesStub	getStub()
com.google.api.gax.longrunning.OperationFuture<ImportEntityTypesResponse,ImportEntityTypesMetadata>	importEntityTypesAsync(ImportEntityTypesRequest request) Imports the specified entitytypes into the agent.
com.google.api.gax.rpc.UnaryCallable<ImportEntityTypesRequest,com.google.longrunning.Operation>	importEntityTypesCallable() Imports the specified entitytypes into the agent.
com.google.api.gax.rpc.OperationCallable<ImportEntityTypesRequest,ImportEntityTypesResponse,ImportEntityTypesMetadata>	importEntityTypesOperationCallable() Imports the specified entitytypes into the agent.
boolean	isShutdown()
boolean	isTerminated()
EntityTypesClient.ListEntityTypesPagedResponse	listEntityTypes(AgentName parent) Returns the list of all entity types in the specified agent.
EntityTypesClient.ListEntityTypesPagedResponse	listEntityTypes(ListEntityTypesRequest request) Returns the list of all entity types in the specified agent.
EntityTypesClient.ListEntityTypesPagedResponse	listEntityTypes(String parent) Returns the list of all entity types in the specified agent.
com.google.api.gax.rpc.UnaryCallable<ListEntityTypesRequest,ListEntityTypesResponse>	listEntityTypesCallable() Returns the list of all entity types in the specified agent.
com.google.api.gax.rpc.UnaryCallable<ListEntityTypesRequest,EntityTypesClient.ListEntityTypesPagedResponse>	listEntityTypesPagedCallable() Returns the list of all entity types in the specified agent.
EntityTypesClient.ListLocationsPagedResponse	listLocations(com.google.cloud.location.ListLocationsRequest request) Lists information about the supported locations for this service.
com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>	listLocationsCallable() Lists information about the supported locations for this service.
com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,EntityTypesClient.ListLocationsPagedResponse>	listLocationsPagedCallable() Lists information about the supported locations for this service.
void	shutdown()
void	shutdownNow()
EntityType	updateEntityType(EntityType entityType, com.google.protobuf.FieldMask updateMask) Updates the specified entity type.
EntityType	updateEntityType(UpdateEntityTypeRequest request) Updates the specified entity type.
com.google.api.gax.rpc.UnaryCallable<UpdateEntityTypeRequest,EntityType>	updateEntityTypeCallable() Updates the specified entity type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EntityTypesClient

protected EntityTypesClient(EntityTypesSettings settings)
                     throws IOException

Constructs an instance of EntityTypesClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

EntityTypesClient

protected EntityTypesClient(EntityTypesStub stub)

Method Detail

create

public static final EntityTypesClient create()
                                      throws IOException

Constructs an instance of EntityTypesClient with default settings.

Throws:

IOException

create

public static final EntityTypesClient create(EntityTypesSettings settings)
                                      throws IOException

Constructs an instance of EntityTypesClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

public static final EntityTypesClient create(EntityTypesStub stub)

Constructs an instance of EntityTypesClient, using the given stub for making calls. This is for advanced usage - prefer using create(EntityTypesSettings).

getSettings

public final EntityTypesSettings getSettings()

getStub

public EntityTypesStub getStub()

getOperationsClient

public final com.google.longrunning.OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

getHttpJsonOperationsClient

@BetaApi
public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

getEntityType

public final EntityType getEntityType(EntityTypeName name)

Retrieves the specified entity type.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName name =
       EntityTypeName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENTITY_TYPE]");
   EntityType response = entityTypesClient.getEntityType(name);
 }
 

Parameters:

name - Required. The name of the entity type. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getEntityType

public final EntityType getEntityType(String name)

Retrieves the specified entity type.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   String name =
       EntityTypeName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENTITY_TYPE]").toString();
   EntityType response = entityTypesClient.getEntityType(name);
 }
 

Parameters:

name - Required. The name of the entity type. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getEntityType

public final EntityType getEntityType(GetEntityTypeRequest request)

Retrieves the specified entity type.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   GetEntityTypeRequest request =
       GetEntityTypeRequest.newBuilder()
           .setName(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENTITY_TYPE]")
                   .toString())
           .setLanguageCode("languageCode-2092349083")
           .build();
   EntityType response = entityTypesClient.getEntityType(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getEntityTypeCallable

public final com.google.api.gax.rpc.UnaryCallable<GetEntityTypeRequest,EntityType> getEntityTypeCallable()

Retrieves the specified entity type.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   GetEntityTypeRequest request =
       GetEntityTypeRequest.newBuilder()
           .setName(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENTITY_TYPE]")
                   .toString())
           .setLanguageCode("languageCode-2092349083")
           .build();
   ApiFuture<EntityType> future = entityTypesClient.getEntityTypeCallable().futureCall(request);
   // Do something.
   EntityType response = future.get();
 }
 

createEntityType

public final EntityType createEntityType(AgentName parent,
                                         EntityType entityType)

Creates an entity type in the specified agent.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
   EntityType entityType = EntityType.newBuilder().build();
   EntityType response = entityTypesClient.createEntityType(parent, entityType);
 }
 

Parameters:

parent - Required. The agent to create a entity type for. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.

entityType - Required. The entity type to create.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createEntityType

public final EntityType createEntityType(String parent,
                                         EntityType entityType)

Creates an entity type in the specified agent.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   String parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString();
   EntityType entityType = EntityType.newBuilder().build();
   EntityType response = entityTypesClient.createEntityType(parent, entityType);
 }
 

Parameters:

parent - Required. The agent to create a entity type for. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.

entityType - Required. The entity type to create.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createEntityType

public final EntityType createEntityType(CreateEntityTypeRequest request)

Creates an entity type in the specified agent.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   CreateEntityTypeRequest request =
       CreateEntityTypeRequest.newBuilder()
           .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
           .setEntityType(EntityType.newBuilder().build())
           .setLanguageCode("languageCode-2092349083")
           .build();
   EntityType response = entityTypesClient.createEntityType(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createEntityTypeCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateEntityTypeRequest,EntityType> createEntityTypeCallable()

Creates an entity type in the specified agent.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   CreateEntityTypeRequest request =
       CreateEntityTypeRequest.newBuilder()
           .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
           .setEntityType(EntityType.newBuilder().build())
           .setLanguageCode("languageCode-2092349083")
           .build();
   ApiFuture<EntityType> future =
       entityTypesClient.createEntityTypeCallable().futureCall(request);
   // Do something.
   EntityType response = future.get();
 }
 

updateEntityType

public final EntityType updateEntityType(EntityType entityType,
                                         com.google.protobuf.FieldMask updateMask)

Updates the specified entity type.

Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityType entityType = EntityType.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   EntityType response = entityTypesClient.updateEntityType(entityType, updateMask);
 }
 

Parameters:

entityType - Required. The entity type to update.

updateMask - The mask to control which fields get updated.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateEntityType

public final EntityType updateEntityType(UpdateEntityTypeRequest request)

Updates the specified entity type.

Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   UpdateEntityTypeRequest request =
       UpdateEntityTypeRequest.newBuilder()
           .setEntityType(EntityType.newBuilder().build())
           .setLanguageCode("languageCode-2092349083")
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   EntityType response = entityTypesClient.updateEntityType(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateEntityTypeCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateEntityTypeRequest,EntityType> updateEntityTypeCallable()

Updates the specified entity type.

Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   UpdateEntityTypeRequest request =
       UpdateEntityTypeRequest.newBuilder()
           .setEntityType(EntityType.newBuilder().build())
           .setLanguageCode("languageCode-2092349083")
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<EntityType> future =
       entityTypesClient.updateEntityTypeCallable().futureCall(request);
   // Do something.
   EntityType response = future.get();
 }
 

deleteEntityType

public final void deleteEntityType(EntityTypeName name)

Deletes the specified entity type.

Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName name =
       EntityTypeName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENTITY_TYPE]");
   entityTypesClient.deleteEntityType(name);
 }
 

Parameters:

name - Required. The name of the entity type to delete. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteEntityType

public final void deleteEntityType(String name)

Deletes the specified entity type.

Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   String name =
       EntityTypeName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENTITY_TYPE]").toString();
   entityTypesClient.deleteEntityType(name);
 }
 

Parameters:

name - Required. The name of the entity type to delete. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteEntityType

public final void deleteEntityType(DeleteEntityTypeRequest request)

Deletes the specified entity type.

Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   DeleteEntityTypeRequest request =
       DeleteEntityTypeRequest.newBuilder()
           .setName(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENTITY_TYPE]")
                   .toString())
           .setForce(true)
           .build();
   entityTypesClient.deleteEntityType(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteEntityTypeCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteEntityTypeRequest,com.google.protobuf.Empty> deleteEntityTypeCallable()

Deletes the specified entity type.

Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   DeleteEntityTypeRequest request =
       DeleteEntityTypeRequest.newBuilder()
           .setName(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENTITY_TYPE]")
                   .toString())
           .setForce(true)
           .build();
   ApiFuture<Empty> future = entityTypesClient.deleteEntityTypeCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

listEntityTypes

public final EntityTypesClient.ListEntityTypesPagedResponse listEntityTypes(AgentName parent)

Returns the list of all entity types in the specified agent.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
   for (EntityType element : entityTypesClient.listEntityTypes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The agent to list all entity types for. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listEntityTypes

public final EntityTypesClient.ListEntityTypesPagedResponse listEntityTypes(String parent)

Returns the list of all entity types in the specified agent.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   String parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString();
   for (EntityType element : entityTypesClient.listEntityTypes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The agent to list all entity types for. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listEntityTypes

public final EntityTypesClient.ListEntityTypesPagedResponse listEntityTypes(ListEntityTypesRequest request)

Returns the list of all entity types in the specified agent.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   ListEntityTypesRequest request =
       ListEntityTypesRequest.newBuilder()
           .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
           .setLanguageCode("languageCode-2092349083")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (EntityType element : entityTypesClient.listEntityTypes(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listEntityTypesPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListEntityTypesRequest,EntityTypesClient.ListEntityTypesPagedResponse> listEntityTypesPagedCallable()

Returns the list of all entity types in the specified agent.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   ListEntityTypesRequest request =
       ListEntityTypesRequest.newBuilder()
           .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
           .setLanguageCode("languageCode-2092349083")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<EntityType> future =
       entityTypesClient.listEntityTypesPagedCallable().futureCall(request);
   // Do something.
   for (EntityType element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listEntityTypesCallable

public final com.google.api.gax.rpc.UnaryCallable<ListEntityTypesRequest,ListEntityTypesResponse> listEntityTypesCallable()

Returns the list of all entity types in the specified agent.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   ListEntityTypesRequest request =
       ListEntityTypesRequest.newBuilder()
           .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
           .setLanguageCode("languageCode-2092349083")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListEntityTypesResponse response =
         entityTypesClient.listEntityTypesCallable().call(request);
     for (EntityType element : response.getEntityTypesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

exportEntityTypesAsync

public final com.google.api.gax.longrunning.OperationFuture<ExportEntityTypesResponse,ExportEntityTypesMetadata> exportEntityTypesAsync(ExportEntityTypesRequest request)

Exports the selected entity types.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   ExportEntityTypesRequest request =
       ExportEntityTypesRequest.newBuilder()
           .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
           .addAllEntityTypes(new ArrayList<String>())
           .setLanguageCode("languageCode-2092349083")
           .build();
   ExportEntityTypesResponse response = entityTypesClient.exportEntityTypesAsync(request).get();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

exportEntityTypesOperationCallable

public final com.google.api.gax.rpc.OperationCallable<ExportEntityTypesRequest,ExportEntityTypesResponse,ExportEntityTypesMetadata> exportEntityTypesOperationCallable()

Exports the selected entity types.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   ExportEntityTypesRequest request =
       ExportEntityTypesRequest.newBuilder()
           .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
           .addAllEntityTypes(new ArrayList<String>())
           .setLanguageCode("languageCode-2092349083")
           .build();
   OperationFuture<ExportEntityTypesResponse, ExportEntityTypesMetadata> future =
       entityTypesClient.exportEntityTypesOperationCallable().futureCall(request);
   // Do something.
   ExportEntityTypesResponse response = future.get();
 }
 

exportEntityTypesCallable

public final com.google.api.gax.rpc.UnaryCallable<ExportEntityTypesRequest,com.google.longrunning.Operation> exportEntityTypesCallable()

Exports the selected entity types.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   ExportEntityTypesRequest request =
       ExportEntityTypesRequest.newBuilder()
           .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
           .addAllEntityTypes(new ArrayList<String>())
           .setLanguageCode("languageCode-2092349083")
           .build();
   ApiFuture<Operation> future =
       entityTypesClient.exportEntityTypesCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

importEntityTypesAsync

public final com.google.api.gax.longrunning.OperationFuture<ImportEntityTypesResponse,ImportEntityTypesMetadata> importEntityTypesAsync(ImportEntityTypesRequest request)

Imports the specified entitytypes into the agent.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   ImportEntityTypesRequest request =
       ImportEntityTypesRequest.newBuilder()
           .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
           .setTargetEntityType(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENTITY_TYPE]")
                   .toString())
           .build();
   ImportEntityTypesResponse response = entityTypesClient.importEntityTypesAsync(request).get();
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

importEntityTypesOperationCallable

public final com.google.api.gax.rpc.OperationCallable<ImportEntityTypesRequest,ImportEntityTypesResponse,ImportEntityTypesMetadata> importEntityTypesOperationCallable()

Imports the specified entitytypes into the agent.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   ImportEntityTypesRequest request =
       ImportEntityTypesRequest.newBuilder()
           .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
           .setTargetEntityType(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENTITY_TYPE]")
                   .toString())
           .build();
   OperationFuture<ImportEntityTypesResponse, ImportEntityTypesMetadata> future =
       entityTypesClient.importEntityTypesOperationCallable().futureCall(request);
   // Do something.
   ImportEntityTypesResponse response = future.get();
 }
 

importEntityTypesCallable

public final com.google.api.gax.rpc.UnaryCallable<ImportEntityTypesRequest,com.google.longrunning.Operation> importEntityTypesCallable()

Imports the specified entitytypes into the agent.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   ImportEntityTypesRequest request =
       ImportEntityTypesRequest.newBuilder()
           .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
           .setTargetEntityType(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENTITY_TYPE]")
                   .toString())
           .build();
   ApiFuture<Operation> future =
       entityTypesClient.importEntityTypesCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

listLocations

public final EntityTypesClient.ListLocationsPagedResponse listLocations(com.google.cloud.location.ListLocationsRequest request)

Lists information about the supported locations for this service.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : entityTypesClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listLocationsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,EntityTypesClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       entityTypesClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listLocationsCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response = entityTypesClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

getLocation

public final com.google.cloud.location.Location getLocation(com.google.cloud.location.GetLocationRequest request)

Gets information about a location.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = entityTypesClient.getLocation(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getLocationCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> getLocationCallable()

Gets information about a location.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = entityTypesClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException