Class EntityTypesClient (0.11.5)

Version 0.11.5

• 0.64.0 (latest)
• 0.63.0
• 0.62.0
• 0.60.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.7
• 0.13.1
• 0.12.1
• 0.11.5

public class EntityTypesClient implements BackgroundResource

Service Description: Service for managing EntityTypes.

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.

Inheritance

java.lang.Object > EntityTypesClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final EntityTypesClient create()

Constructs an instance of EntityTypesClient with default settings.

Returns

Type	Description
EntityTypesClient

Exceptions

Type	Description
IOException

create(EntityTypesSettings settings)

public static final EntityTypesClient create(EntityTypesSettings settings)

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.

Parameter

Name	Description
settings	EntityTypesSettings

Returns

Type	Description
EntityTypesClient

Exceptions

Type	Description
IOException

create(EntityTypesStub stub)

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

Parameter

Name	Description
stub	EntityTypesStub

Returns

Type	Description
EntityTypesClient

Constructors

EntityTypesClient(EntityTypesSettings settings)

protected EntityTypesClient(EntityTypesSettings settings)

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.

Parameter

Name	Description
settings	EntityTypesSettings

EntityTypesClient(EntityTypesStub stub)

protected EntityTypesClient(EntityTypesStub stub)

Parameter

Name	Description
stub	EntityTypesStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters

Name	Description
duration	long
unit	TimeUnit

Returns

Type	Description
boolean

Exceptions

Type	Description
InterruptedException

close()

public final void close()

createEntityType(AgentName parent, EntityType entityType)

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

Name	Description
parent	AgentName Required. The agent to create a entity type for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
entityType	EntityType Required. The entity type to create.

Returns

Type	Description
EntityType

createEntityType(CreateEntityTypeRequest request)

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(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
           .setEntityType(EntityType.newBuilder().build())
           .setLanguageCode("languageCode-2092349083")
           .build();
   EntityType response = entityTypesClient.createEntityType(request);
 }
 

Parameter

Name	Description
request	CreateEntityTypeRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
EntityType

createEntityType(String parent, EntityType entityType)

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 = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString();
   EntityType entityType = EntityType.newBuilder().build();
   EntityType response = entityTypesClient.createEntityType(parent, entityType);
 }
 

Parameters

Name	Description
parent	String Required. The agent to create a entity type for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
entityType	EntityType Required. The entity type to create.

Returns

Type	Description
EntityType

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(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
           .setEntityType(EntityType.newBuilder().build())
           .setLanguageCode("languageCode-2092349083")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<CreateEntityTypeRequest,EntityType>

deleteEntityType(DeleteEntityTypeRequest request)

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.

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

Parameter

Name	Description
request	DeleteEntityTypeRequest The request object containing all of the parameters for the API call.

deleteEntityType(EntityTypeName name)

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.

Sample code:

 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName name =
       EntityTypeName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENTITY_TYPE]");
   entityTypesClient.deleteEntityType(name);
 }
 

Parameter

Name	Description
name	EntityTypeName Required. The name of the entity type to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.

deleteEntityType(String name)

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.

Sample code:

 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   String name =
       EntityTypeName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENTITY_TYPE]").toString();
   entityTypesClient.deleteEntityType(name);
 }
 

Parameter

Name	Description
name	String Required. The name of the entity type to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.

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.

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

Returns

Type	Description
UnaryCallable<DeleteEntityTypeRequest,Empty>

getEntityType(EntityTypeName name)

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

Parameter

Name	Description
name	EntityTypeName Required. The name of the entity type. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.

Returns

Type	Description
EntityType

getEntityType(GetEntityTypeRequest request)

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

Parameter

Name	Description
request	GetEntityTypeRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
EntityType

getEntityType(String name)

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

Parameter

Name	Description
name	String Required. The name of the entity type. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.

Returns

Type	Description
EntityType

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

Returns

Type	Description
UnaryCallable<GetEntityTypeRequest,EntityType>

getSettings()

public final EntityTypesSettings getSettings()

Returns

Type	Description
EntityTypesSettings

getStub()

public EntityTypesStub getStub()

Returns

Type	Description
EntityTypesStub

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

listEntityTypes(AgentName parent)

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

Parameter

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

Returns

Type	Description
EntityTypesClient.ListEntityTypesPagedResponse

listEntityTypes(ListEntityTypesRequest request)

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(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
           .setLanguageCode("languageCode-2092349083")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (EntityType element : entityTypesClient.listEntityTypes(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListEntityTypesRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
EntityTypesClient.ListEntityTypesPagedResponse

listEntityTypes(String parent)

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 = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString();
   for (EntityType element : entityTypesClient.listEntityTypes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

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

Returns

Type	Description
EntityTypesClient.ListEntityTypesPagedResponse

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(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.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListEntityTypesRequest,ListEntityTypesResponse>

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(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
           .setLanguageCode("languageCode-2092349083")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ListEntityTypesRequest,ListEntityTypesPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateEntityType(EntityType entityType, FieldMask updateMask)

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.

Sample code:

 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityType entityType = EntityType.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   EntityType response = entityTypesClient.updateEntityType(entityType, updateMask);
 }
 

Parameters

Name	Description
entityType	EntityType Required. The entity type to update.
updateMask	FieldMask The mask to control which fields get updated.

Returns

Type	Description
EntityType

updateEntityType(UpdateEntityTypeRequest request)

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.

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

Parameter

Name	Description
request	UpdateEntityTypeRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
EntityType

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.

Sample code:

 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   UpdateEntityTypeRequest request =
       UpdateEntityTypeRequest.newBuilder()
           .setEntityType(EntityType.newBuilder().build())
           .setLanguageCode("languageCode-2092349083")
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<UpdateEntityTypeRequest,EntityType>