com.google.cloud.dialogflow.cx.v3beta1

Class EntityTypesClient

java.lang.Object

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

All Implemented Interfaces:

BackgroundResource, AutoCloseable

@BetaApi
 @Generated(value="by gapic-generator-java")
public class EntityTypesClient
extends Object
implements 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:

 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().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

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:

 EntityTypesSettings entityTypesSettings =
     EntityTypesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 EntityTypesClient entityTypesClient = EntityTypesClient.create(entityTypesSettings);
 

To customize the endpoint:

 EntityTypesSettings entityTypesSettings =
     EntityTypesSettings.newBuilder().setEndpoint(myEndpoint).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

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.
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.
UnaryCallable<DeleteEntityTypeRequest,Empty>	deleteEntityTypeCallable() Deletes the specified entity type.
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.
UnaryCallable<GetEntityTypeRequest,EntityType>	getEntityTypeCallable() Retrieves the specified entity type.
EntityTypesSettings	getSettings()
EntityTypesStub	getStub()
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.
UnaryCallable<ListEntityTypesRequest,ListEntityTypesResponse>	listEntityTypesCallable() Returns the list of all entity types in the specified agent.
UnaryCallable<ListEntityTypesRequest,EntityTypesClient.ListEntityTypesPagedResponse>	listEntityTypesPagedCallable() Returns the list of all entity types in the specified agent.
void	shutdown()
void	shutdownNow()
EntityType	updateEntityType(EntityType entityType, FieldMask updateMask) Updates the specified entity type.
EntityType	updateEntityType(UpdateEntityTypeRequest request) Updates the specified entity type.
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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public EntityTypesStub getStub()

listEntityTypes

public final EntityTypesClient.ListEntityTypesPagedResponse listEntityTypes(AgentName parent)

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

Sample code:

 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.

Throws:

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:

 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   String parent =
       EntityTypeName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENTITY_TYPE]").toString();
   for (EntityType element : entityTypesClient.listEntityTypes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The agent to list all entity types for. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.

Throws:

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:

 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   ListEntityTypesRequest request =
       ListEntityTypesRequest.newBuilder()
           .setParent(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENTITY_TYPE]")
                   .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:

ApiException - if the remote call fails

listEntityTypesPagedCallable

public final UnaryCallable<ListEntityTypesRequest,EntityTypesClient.ListEntityTypesPagedResponse> listEntityTypesPagedCallable()

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

Sample code:

 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   ListEntityTypesRequest request =
       ListEntityTypesRequest.newBuilder()
           .setParent(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENTITY_TYPE]")
                   .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 UnaryCallable<ListEntityTypesRequest,ListEntityTypesResponse> listEntityTypesCallable()

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

Sample code:

 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   ListEntityTypesRequest request =
       ListEntityTypesRequest.newBuilder()
           .setParent(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENTITY_TYPE]")
                   .toString())
           .setLanguageCode("languageCode-2092349083")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListEntityTypesResponse response =
         entityTypesClient.listEntityTypesCallable().call(request);
     for (EntityType element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

getEntityType

public final EntityType getEntityType(EntityTypeName name)

Retrieves the specified entity type.

Sample code:

 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>`.

Throws:

ApiException - if the remote call fails

getEntityType

public final EntityType getEntityType(String name)

Retrieves the specified entity type.

Sample code:

 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>`.

Throws:

ApiException - if the remote call fails

getEntityType

public final EntityType getEntityType(GetEntityTypeRequest request)

Retrieves the specified entity type.

Sample code:

 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:

ApiException - if the remote call fails

getEntityTypeCallable

public final UnaryCallable<GetEntityTypeRequest,EntityType> getEntityTypeCallable()

Retrieves the specified entity type.

Sample code:

 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:

 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.

entityType - Required. The entity type to create.

Throws:

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:

 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   String parent =
       EntityTypeName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENTITY_TYPE]").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/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.

entityType - Required. The entity type to create.

Throws:

ApiException - if the remote call fails

createEntityType

public final EntityType createEntityType(CreateEntityTypeRequest request)

Creates an entity type in the specified agent.

Sample code:

 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   CreateEntityTypeRequest request =
       CreateEntityTypeRequest.newBuilder()
           .setParent(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENTITY_TYPE]")
                   .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:

ApiException - if the remote call fails

createEntityTypeCallable

public final UnaryCallable<CreateEntityTypeRequest,EntityType> createEntityTypeCallable()

Creates an entity type in the specified agent.

Sample code:

 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   CreateEntityTypeRequest request =
       CreateEntityTypeRequest.newBuilder()
           .setParent(
               EntityTypeName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENTITY_TYPE]")
                   .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,
                                         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:

 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:

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:

 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:

ApiException - if the remote call fails

updateEntityTypeCallable

public final 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:

 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:

 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>`.

Throws:

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:

 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/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>`.

Throws:

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:

 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:

ApiException - if the remote call fails

deleteEntityTypeCallable

public final UnaryCallable<DeleteEntityTypeRequest,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:

 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();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface BackgroundResource

awaitTermination

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

Specified by:

awaitTermination in interface BackgroundResource

Throws:

InterruptedException