Class EntityTypesClient (4.7.2)

Version 4.7.2

• 4.60.0 (latest)
• 4.59.0
• 4.58.0
• 4.57.0
• 4.55.0
• 4.54.0
• 4.53.0
• 4.52.0
• 4.51.0
• 4.50.0
• 4.49.0
• 4.48.0
• 4.47.0
• 4.46.0
• 4.45.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.35.0
• 4.34.0
• 4.33.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.23.0
• 4.22.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.1
• 4.8.6
• 4.7.5
• 4.6.0
• 4.5.11
• 4.4.0
• 4.3.1

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:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName name = EntityTypeName.ofProjectEntityTypeName("[PROJECT]", "[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:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 EntityTypesSettings entityTypesSettings =
     EntityTypesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 EntityTypesClient entityTypesClient = EntityTypesClient.create(entityTypesSettings);
 

To customize the endpoint:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 EntityTypesSettings entityTypesSettings =
     EntityTypesSettings.newBuilder()
         .setTransportChannelProvider(
             EntityTypesSettings.defaultHttpJsonTransportProviderBuilder().build())
         .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

batchCreateEntitiesAsync(BatchCreateEntitiesRequest request)

public final OperationFuture<Empty,Struct> batchCreateEntitiesAsync(BatchCreateEntitiesRequest request)

Creates multiple new entities in the specified entity type.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  // This snippet has been automatically generated for illustrative purposes only.
  // It may require modifications to work in your environment.
  try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
  BatchCreateEntitiesRequest request =
      BatchCreateEntitiesRequest.newBuilder()
          .setParent(
              EntityTypeName.ofProjectEntityTypeName("[PROJECT]", "[ENTITY_TYPE]").toString())
          .addAllEntities(new ArrayList<EntityType.Entity>())
          .setLanguageCode("languageCode-2092349083")
          .build();
  entityTypesClient.batchCreateEntitiesAsync(request).get();
  }
  

Parameter

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

Returns

Type	Description
OperationFuture<Empty,Struct>

batchCreateEntitiesAsync(EntityTypeName parent, List<EntityType.Entity> entities)

public final OperationFuture<Empty,Struct> batchCreateEntitiesAsync(EntityTypeName parent, List<EntityType.Entity> entities)

Creates multiple new entities in the specified entity type.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  // This snippet has been automatically generated for illustrative purposes only.
  // It may require modifications to work in your environment.
  try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
  EntityTypeName parent = EntityTypeName.ofProjectEntityTypeName("[PROJECT]", "[ENTITY_TYPE]");
  List<EntityType.Entity> entities = new ArrayList<>();
  entityTypesClient.batchCreateEntitiesAsync(parent, entities).get();
  }
  

Parameters

Name	Description
parent	EntityTypeName Required. The name of the entity type to create entities in. Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.
entities	List<Entity> Required. The entities to create.

Returns

Type	Description
OperationFuture<Empty,Struct>

batchCreateEntitiesAsync(EntityTypeName parent, List<EntityType.Entity> entities, String languageCode)

public final OperationFuture<Empty,Struct> batchCreateEntitiesAsync(EntityTypeName parent, List<EntityType.Entity> entities, String languageCode)

Creates multiple new entities in the specified entity type.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  // This snippet has been automatically generated for illustrative purposes only.
  // It may require modifications to work in your environment.
  try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
  EntityTypeName parent = EntityTypeName.ofProjectEntityTypeName("[PROJECT]", "[ENTITY_TYPE]");
  List<EntityType.Entity> entities = new ArrayList<>();
  String languageCode = "languageCode-2092349083";
  entityTypesClient.batchCreateEntitiesAsync(parent, entities, languageCode).get();
  }
  

Parameters

Name	Description
parent	EntityTypeName Required. The name of the entity type to create entities in. Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.
entities	List<Entity> Required. The entities to create.
languageCode	String Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

Returns

Type	Description
OperationFuture<Empty,Struct>

batchCreateEntitiesAsync(String parent, List<EntityType.Entity> entities)

public final OperationFuture<Empty,Struct> batchCreateEntitiesAsync(String parent, List<EntityType.Entity> entities)

Creates multiple new entities in the specified entity type.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  // This snippet has been automatically generated for illustrative purposes only.
  // It may require modifications to work in your environment.
  try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
  String parent =
      EntityTypeName.ofProjectEntityTypeName("[PROJECT]", "[ENTITY_TYPE]").toString();
  List<EntityType.Entity> entities = new ArrayList<>();
  entityTypesClient.batchCreateEntitiesAsync(parent, entities).get();
  }
  

Parameters

Name	Description
parent	String Required. The name of the entity type to create entities in. Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.
entities	List<Entity> Required. The entities to create.

Returns

Type	Description
OperationFuture<Empty,Struct>

batchCreateEntitiesAsync(String parent, List<EntityType.Entity> entities, String languageCode)

public final OperationFuture<Empty,Struct> batchCreateEntitiesAsync(String parent, List<EntityType.Entity> entities, String languageCode)

Creates multiple new entities in the specified entity type.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  // This snippet has been automatically generated for illustrative purposes only.
  // It may require modifications to work in your environment.
  try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
  String parent =
      EntityTypeName.ofProjectEntityTypeName("[PROJECT]", "[ENTITY_TYPE]").toString();
  List<EntityType.Entity> entities = new ArrayList<>();
  String languageCode = "languageCode-2092349083";
  entityTypesClient.batchCreateEntitiesAsync(parent, entities, languageCode).get();
  }
  

Parameters

Name	Description
parent	String Required. The name of the entity type to create entities in. Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.
entities	List<Entity> Required. The entities to create.
languageCode	String Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

Returns

Type	Description
OperationFuture<Empty,Struct>

batchCreateEntitiesCallable()

public final UnaryCallable<BatchCreateEntitiesRequest,Operation> batchCreateEntitiesCallable()

Creates multiple new entities in the specified entity type.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  // This snippet has been automatically generated for illustrative purposes only.
  // It may require modifications to work in your environment.
  try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
  BatchCreateEntitiesRequest request =
      BatchCreateEntitiesRequest.newBuilder()
          .setParent(
              EntityTypeName.ofProjectEntityTypeName("[PROJECT]", "[ENTITY_TYPE]").toString())
          .addAllEntities(new ArrayList<EntityType.Entity>())
          .setLanguageCode("languageCode-2092349083")
          .build();
  ApiFuture<Operation> future =
      entityTypesClient.batchCreateEntitiesCallable().futureCall(request);
  // Do something.
  future.get();
  }
  

Returns

Type	Description
UnaryCallable<BatchCreateEntitiesRequest,Operation>

batchCreateEntitiesOperationCallable()

public final OperationCallable<BatchCreateEntitiesRequest,Empty,Struct> batchCreateEntitiesOperationCallable()

Creates multiple new entities in the specified entity type.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  // This snippet has been automatically generated for illustrative purposes only.
  // It may require modifications to work in your environment.
  try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
  BatchCreateEntitiesRequest request =
      BatchCreateEntitiesRequest.newBuilder()
          .setParent(
              EntityTypeName.ofProjectEntityTypeName("[PROJECT]", "[ENTITY_TYPE]").toString())
          .addAllEntities(new ArrayList<EntityType.Entity>())
          .setLanguageCode("languageCode-2092349083")
          .build();
  OperationFuture<Empty, Struct> future =
      entityTypesClient.batchCreateEntitiesOperationCallable().futureCall(request);
  // Do something.
  future.get();
  }
  

Returns

Type	Description
OperationCallable<BatchCreateEntitiesRequest,Empty,Struct>

batchDeleteEntitiesAsync(BatchDeleteEntitiesRequest request)

public final OperationFuture<Empty,Struct> batchDeleteEntitiesAsync(BatchDeleteEntitiesRequest request)

Deletes entities in the specified entity type.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  // This snippet has been automatically generated for illustrative purposes only.
  // It may require modifications to work in your environment.
  try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
  BatchDeleteEntitiesRequest request =
      BatchDeleteEntitiesRequest.newBuilder()
          .setParent(
              EntityTypeName.ofProjectEntityTypeName("[PROJECT]", "[ENTITY_TYPE]").toString())
          .addAllEntityValues(new ArrayList<String>())
          .setLanguageCode("languageCode-2092349083")
          .build();
  entityTypesClient.batchDeleteEntitiesAsync(request).get();
  }
  

Parameter

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

Returns

Type	Description
OperationFuture<Empty,Struct>

batchDeleteEntitiesAsync(EntityTypeName parent, List<String> entityValues)

public final OperationFuture<Empty,Struct> batchDeleteEntitiesAsync(EntityTypeName parent, List<String> entityValues)

Deletes entities in the specified entity type.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  // This snippet has been automatically generated for illustrative purposes only.
  // It may require modifications to work in your environment.
  try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
  EntityTypeName parent = EntityTypeName.ofProjectEntityTypeName("[PROJECT]", "[ENTITY_TYPE]");
  List<String> entityValues = new ArrayList<>();
  entityTypesClient.batchDeleteEntitiesAsync(parent, entityValues).get();
  }
  

Parameters

Name	Description
parent	EntityTypeName Required. The name of the entity type to delete entries for. Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.
entityValues	List<String> Required. The reference values of the entities to delete. Note that these are not fully-qualified names, i.e. they don't start with projects/<Project ID>.

Returns

Type	Description
OperationFuture<Empty,Struct>

batchDeleteEntitiesAsync(EntityTypeName parent, List<String> entityValues, String languageCode)

public final OperationFuture<Empty,Struct> batchDeleteEntitiesAsync(EntityTypeName parent, List<String> entityValues, String languageCode)

Deletes entities in the specified entity type.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  // This snippet has been automatically generated for illustrative purposes only.
  // It may require modifications to work in your environment.
  try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
  EntityTypeName parent = EntityTypeName.ofProjectEntityTypeName("[PROJECT]", "[ENTITY_TYPE]");
  List<String> entityValues = new ArrayList<>();
  String languageCode = "languageCode-2092349083";
  entityTypesClient.batchDeleteEntitiesAsync(parent, entityValues, languageCode).get();
  }
  

Parameters

Name	Description
parent	EntityTypeName Required. The name of the entity type to delete entries for. Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.
entityValues	List<String> Required. The reference values of the entities to delete. Note that these are not fully-qualified names, i.e. they don't start with projects/<Project ID>.
languageCode	String Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

Returns

Type	Description
OperationFuture<Empty,Struct>

batchDeleteEntitiesAsync(String parent, List<String> entityValues)

public final OperationFuture<Empty,Struct> batchDeleteEntitiesAsync(String parent, List<String> entityValues)

Deletes entities in the specified entity type.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  // This snippet has been automatically generated for illustrative purposes only.
  // It may require modifications to work in your environment.
  try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
  String parent =
      EntityTypeName.ofProjectEntityTypeName("[PROJECT]", "[ENTITY_TYPE]").toString();
  List<String> entityValues = new ArrayList<>();
  entityTypesClient.batchDeleteEntitiesAsync(parent, entityValues).get();
  }
  

Parameters

Name	Description
parent	String Required. The name of the entity type to delete entries for. Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.
entityValues	List<String> Required. The reference values of the entities to delete. Note that these are not fully-qualified names, i.e. they don't start with projects/<Project ID>.

Returns

Type	Description
OperationFuture<Empty,Struct>

batchDeleteEntitiesAsync(String parent, List<String> entityValues, String languageCode)

public final OperationFuture<Empty,Struct> batchDeleteEntitiesAsync(String parent, List<String> entityValues, String languageCode)

Deletes entities in the specified entity type.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  // This snippet has been automatically generated for illustrative purposes only.
  // It may require modifications to work in your environment.
  try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
  String parent =
      EntityTypeName.ofProjectEntityTypeName("[PROJECT]", "[ENTITY_TYPE]").toString();
  List<String> entityValues = new ArrayList<>();
  String languageCode = "languageCode-2092349083";
  entityTypesClient.batchDeleteEntitiesAsync(parent, entityValues, languageCode).get();
  }
  

Parameters

Name	Description
parent	String Required. The name of the entity type to delete entries for. Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.
entityValues	List<String> Required. The reference values of the entities to delete. Note that these are not fully-qualified names, i.e. they don't start with projects/<Project ID>.
languageCode	String Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

Returns

Type	Description
OperationFuture<Empty,Struct>

batchDeleteEntitiesCallable()

public final UnaryCallable<BatchDeleteEntitiesRequest,Operation> batchDeleteEntitiesCallable()

Deletes entities in the specified entity type.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  // This snippet has been automatically generated for illustrative purposes only.
  // It may require modifications to work in your environment.
  try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
  BatchDeleteEntitiesRequest request =
      BatchDeleteEntitiesRequest.newBuilder()
          .setParent(
              EntityTypeName.ofProjectEntityTypeName("[PROJECT]", "[ENTITY_TYPE]").toString())
          .addAllEntityValues(new ArrayList<String>())
          .setLanguageCode("languageCode-2092349083")
          .build();
  ApiFuture<Operation> future =
      entityTypesClient.batchDeleteEntitiesCallable().futureCall(request);
  // Do something.
  future.get();
  }
  

Returns

Type	Description
UnaryCallable<BatchDeleteEntitiesRequest,Operation>

batchDeleteEntitiesOperationCallable()

public final OperationCallable<BatchDeleteEntitiesRequest,Empty,Struct> batchDeleteEntitiesOperationCallable()

Deletes entities in the specified entity type.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  // This snippet has been automatically generated for illustrative purposes only.
  // It may require modifications to work in your environment.
  try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
  BatchDeleteEntitiesRequest request =
      BatchDeleteEntitiesRequest.newBuilder()
          .setParent(
              EntityTypeName.ofProjectEntityTypeName("[PROJECT]", "[ENTITY_TYPE]").toString())
          .addAllEntityValues(new ArrayList<String>())
          .setLanguageCode("languageCode-2092349083")
          .build();
  OperationFuture<Empty, Struct> future =
      entityTypesClient.batchDeleteEntitiesOperationCallable().futureCall(request);
  // Do something.
  future.get();
  }
  

Returns

Type	Description
OperationCallable<BatchDeleteEntitiesRequest,Empty,Struct>

batchDeleteEntityTypesAsync(AgentName parent, List<String> entityTypeNames)

public final OperationFuture<Empty,Struct> batchDeleteEntityTypesAsync(AgentName parent, List<String> entityTypeNames)

Deletes entity types in the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  // This snippet has been automatically generated for illustrative purposes only.
  // It may require modifications to work in your environment.
  try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
  AgentName parent = AgentName.ofProjectName("[PROJECT]");
  List<String> entityTypeNames = new ArrayList<>();
  entityTypesClient.batchDeleteEntityTypesAsync(parent, entityTypeNames).get();
  }
  

Parameters

Name	Description
parent	AgentName Required. The name of the agent to delete all entities types for. Format: projects/<Project ID>/agent.
entityTypeNames	List<String> Required. The names entity types to delete. All names must point to the same agent as parent.

Returns

Type	Description
OperationFuture<Empty,Struct>

batchDeleteEntityTypesAsync(BatchDeleteEntityTypesRequest request)

public final OperationFuture<Empty,Struct> batchDeleteEntityTypesAsync(BatchDeleteEntityTypesRequest request)

Deletes entity types in the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  // This snippet has been automatically generated for illustrative purposes only.
  // It may require modifications to work in your environment.
  try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
  BatchDeleteEntityTypesRequest request =
      BatchDeleteEntityTypesRequest.newBuilder()
          .setParent(AgentName.ofProjectName("[PROJECT]").toString())
          .addAllEntityTypeNames(new ArrayList<String>())
          .build();
  entityTypesClient.batchDeleteEntityTypesAsync(request).get();
  }
  

Parameter

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

Returns

Type	Description
OperationFuture<Empty,Struct>

batchDeleteEntityTypesAsync(String parent, List<String> entityTypeNames)

public final OperationFuture<Empty,Struct> batchDeleteEntityTypesAsync(String parent, List<String> entityTypeNames)

Deletes entity types in the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  // This snippet has been automatically generated for illustrative purposes only.
  // It may require modifications to work in your environment.
  try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
  String parent = AgentName.ofProjectName("[PROJECT]").toString();
  List<String> entityTypeNames = new ArrayList<>();
  entityTypesClient.batchDeleteEntityTypesAsync(parent, entityTypeNames).get();
  }
  

Parameters

Name	Description
parent	String Required. The name of the agent to delete all entities types for. Format: projects/<Project ID>/agent.
entityTypeNames	List<String> Required. The names entity types to delete. All names must point to the same agent as parent.

Returns

Type	Description
OperationFuture<Empty,Struct>

batchDeleteEntityTypesCallable()

public final UnaryCallable<BatchDeleteEntityTypesRequest,Operation> batchDeleteEntityTypesCallable()

Deletes entity types in the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  // This snippet has been automatically generated for illustrative purposes only.
  // It may require modifications to work in your environment.
  try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
  BatchDeleteEntityTypesRequest request =
      BatchDeleteEntityTypesRequest.newBuilder()
          .setParent(AgentName.ofProjectName("[PROJECT]").toString())
          .addAllEntityTypeNames(new ArrayList<String>())
          .build();
  ApiFuture<Operation> future =
      entityTypesClient.batchDeleteEntityTypesCallable().futureCall(request);
  // Do something.
  future.get();
  }
  

Returns

Type	Description
UnaryCallable<BatchDeleteEntityTypesRequest,Operation>

batchDeleteEntityTypesOperationCallable()

public final OperationCallable<BatchDeleteEntityTypesRequest,Empty,Struct> batchDeleteEntityTypesOperationCallable()

Deletes entity types in the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  // This snippet has been automatically generated for illustrative purposes only.
  // It may require modifications to work in your environment.
  try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
  BatchDeleteEntityTypesRequest request =
      BatchDeleteEntityTypesRequest.newBuilder()
          .setParent(AgentName.ofProjectName("[PROJECT]").toString())
          .addAllEntityTypeNames(new ArrayList<String>())
          .build();
  OperationFuture<Empty, Struct> future =
      entityTypesClient.batchDeleteEntityTypesOperationCallable().futureCall(request);
  // Do something.
  future.get();
  }
  

Returns

Type	Description
OperationCallable<BatchDeleteEntityTypesRequest,Empty,Struct>

batchUpdateEntitiesAsync(BatchUpdateEntitiesRequest request)

public final OperationFuture<Empty,Struct> batchUpdateEntitiesAsync(BatchUpdateEntitiesRequest request)

Updates or creates multiple entities in the specified entity type. This method does not affect entities in the entity type that aren't explicitly specified in the request.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  // This snippet has been automatically generated for illustrative purposes only.
  // It may require modifications to work in your environment.
  try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
  BatchUpdateEntitiesRequest request =
      BatchUpdateEntitiesRequest.newBuilder()
          .setParent(
              EntityTypeName.ofProjectEntityTypeName("[PROJECT]", "[ENTITY_TYPE]").toString())
          .addAllEntities(new ArrayList<EntityType.Entity>())
          .setLanguageCode("languageCode-2092349083")
          .setUpdateMask(FieldMask.newBuilder().build())
          .build();
  entityTypesClient.batchUpdateEntitiesAsync(request).get();
  }
  

Parameter

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

Returns

Type	Description
OperationFuture<Empty,Struct>

batchUpdateEntitiesAsync(EntityTypeName parent, List<EntityType.Entity> entities)

public final OperationFuture<Empty,Struct> batchUpdateEntitiesAsync(EntityTypeName parent, List<EntityType.Entity> entities)

Updates or creates multiple entities in the specified entity type. This method does not affect entities in the entity type that aren't explicitly specified in the request.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  // This snippet has been automatically generated for illustrative purposes only.
  // It may require modifications to work in your environment.
  try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
  EntityTypeName parent = EntityTypeName.ofProjectEntityTypeName("[PROJECT]", "[ENTITY_TYPE]");
  List<EntityType.Entity> entities = new ArrayList<>();
  entityTypesClient.batchUpdateEntitiesAsync(parent, entities).get();
  }
  

Parameters

Name	Description
parent	EntityTypeName Required. The name of the entity type to update or create entities in. Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.
entities	List<Entity> Required. The entities to update or create.

Returns

Type	Description
OperationFuture<Empty,Struct>

batchUpdateEntitiesAsync(EntityTypeName parent, List<EntityType.Entity> entities, String languageCode)

public final OperationFuture<Empty,Struct> batchUpdateEntitiesAsync(EntityTypeName parent, List<EntityType.Entity> entities, String languageCode)

Updates or creates multiple entities in the specified entity type. This method does not affect entities in the entity type that aren't explicitly specified in the request.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  // This snippet has been automatically generated for illustrative purposes only.
  // It may require modifications to work in your environment.
  try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
  EntityTypeName parent = EntityTypeName.ofProjectEntityTypeName("[PROJECT]", "[ENTITY_TYPE]");
  List<EntityType.Entity> entities = new ArrayList<>();
  String languageCode = "languageCode-2092349083";
  entityTypesClient.batchUpdateEntitiesAsync(parent, entities, languageCode).get();
  }
  

Parameters

Name	Description
parent	EntityTypeName Required. The name of the entity type to update or create entities in. Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.
entities	List<Entity> Required. The entities to update or create.
languageCode	String Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

Returns

Type	Description
OperationFuture<Empty,Struct>

batchUpdateEntitiesAsync(String parent, List<EntityType.Entity> entities)

public final OperationFuture<Empty,Struct> batchUpdateEntitiesAsync(String parent, List<EntityType.Entity> entities)

Updates or creates multiple entities in the specified entity type. This method does not affect entities in the entity type that aren't explicitly specified in the request.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  // This snippet has been automatically generated for illustrative purposes only.
  // It may require modifications to work in your environment.
  try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
  String parent =
      EntityTypeName.ofProjectEntityTypeName("[PROJECT]", "[ENTITY_TYPE]").toString();
  List<EntityType.Entity> entities = new ArrayList<>();
  entityTypesClient.batchUpdateEntitiesAsync(parent, entities).get();
  }
  

Parameters

Name	Description
parent	String Required. The name of the entity type to update or create entities in. Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.
entities	List<Entity> Required. The entities to update or create.

Returns

Type	Description
OperationFuture<Empty,Struct>

batchUpdateEntitiesAsync(String parent, List<EntityType.Entity> entities, String languageCode)

public final OperationFuture<Empty,Struct> batchUpdateEntitiesAsync(String parent, List<EntityType.Entity> entities, String languageCode)

Updates or creates multiple entities in the specified entity type. This method does not affect entities in the entity type that aren't explicitly specified in the request.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  // This snippet has been automatically generated for illustrative purposes only.
  // It may require modifications to work in your environment.
  try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
  String parent =
      EntityTypeName.ofProjectEntityTypeName("[PROJECT]", "[ENTITY_TYPE]").toString();
  List<EntityType.Entity> entities = new ArrayList<>();
  String languageCode = "languageCode-2092349083";
  entityTypesClient.batchUpdateEntitiesAsync(parent, entities, languageCode).get();
  }
  

Parameters

Name	Description
parent	String Required. The name of the entity type to update or create entities in. Format: projects/<Project ID>/agent/entityTypes/<Entity Type ID>.
entities	List<Entity> Required. The entities to update or create.
languageCode	String Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

Returns

Type	Description
OperationFuture<Empty,Struct>

batchUpdateEntitiesCallable()

public final UnaryCallable<BatchUpdateEntitiesRequest,Operation> batchUpdateEntitiesCallable()

Updates or creates multiple entities in the specified entity type. This method does not affect entities in the entity type that aren't explicitly specified in the request.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  // This snippet has been automatically generated for illustrative purposes only.
  // It may require modifications to work in your environment.
  try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
  BatchUpdateEntitiesRequest request =
      BatchUpdateEntitiesRequest.newBuilder()
          .setParent(
              EntityTypeName.ofProjectEntityTypeName("[PROJECT]", "[ENTITY_TYPE]").toString())
          .addAllEntities(new ArrayList<EntityType.Entity>())
          .setLanguageCode("languageCode-2092349083")
          .setUpdateMask(FieldMask.newBuilder().build())
          .build();
  ApiFuture<Operation> future =
      entityTypesClient.batchUpdateEntitiesCallable().futureCall(request);
  // Do something.
  future.get();
  }
  

Returns

Type	Description
UnaryCallable<BatchUpdateEntitiesRequest,Operation>

batchUpdateEntitiesOperationCallable()

public final OperationCallable<BatchUpdateEntitiesRequest,Empty,Struct> batchUpdateEntitiesOperationCallable()

Updates or creates multiple entities in the specified entity type. This method does not affect entities in the entity type that aren't explicitly specified in the request.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  // This snippet has been automatically generated for illustrative purposes only.
  // It may require modifications to work in your environment.
  try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
  BatchUpdateEntitiesRequest request =
      BatchUpdateEntitiesRequest.newBuilder()
          .setParent(
              EntityTypeName.ofProjectEntityTypeName("[PROJECT]", "[ENTITY_TYPE]").toString())
          .addAllEntities(new ArrayList<EntityType.Entity>())
          .setLanguageCode("languageCode-2092349083")
          .setUpdateMask(FieldMask.newBuilder().build())
          .build();
  OperationFuture<Empty, Struct> future =
      entityTypesClient.batchUpdateEntitiesOperationCallable().futureCall(request);
  // Do something.
  future.get();
  }
  

Returns

Type	Description
OperationCallable<BatchUpdateEntitiesRequest,Empty,Struct>

batchUpdateEntityTypesAsync(BatchUpdateEntityTypesRequest request)

public final OperationFuture<BatchUpdateEntityTypesResponse,Struct> batchUpdateEntityTypesAsync(BatchUpdateEntityTypesRequest request)

Updates/Creates multiple entity types in the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: BatchUpdateEntityTypesResponse

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  // This snippet has been automatically generated for illustrative purposes only.
  // It may require modifications to work in your environment.
  try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
  BatchUpdateEntityTypesRequest request =
      BatchUpdateEntityTypesRequest.newBuilder()
          .setParent(AgentName.ofProjectName("[PROJECT]").toString())
          .setLanguageCode("languageCode-2092349083")
          .setUpdateMask(FieldMask.newBuilder().build())
          .build();
  BatchUpdateEntityTypesResponse response =
      entityTypesClient.batchUpdateEntityTypesAsync(request).get();
  }
  

Parameter

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

Returns

Type	Description
OperationFuture<BatchUpdateEntityTypesResponse,Struct>

batchUpdateEntityTypesCallable()

public final UnaryCallable<BatchUpdateEntityTypesRequest,Operation> batchUpdateEntityTypesCallable()

Updates/Creates multiple entity types in the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: BatchUpdateEntityTypesResponse

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  // This snippet has been automatically generated for illustrative purposes only.
  // It may require modifications to work in your environment.
  try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
  BatchUpdateEntityTypesRequest request =
      BatchUpdateEntityTypesRequest.newBuilder()
          .setParent(AgentName.ofProjectName("[PROJECT]").toString())
          .setLanguageCode("languageCode-2092349083")
          .setUpdateMask(FieldMask.newBuilder().build())
          .build();
  ApiFuture<Operation> future =
      entityTypesClient.batchUpdateEntityTypesCallable().futureCall(request);
  // Do something.
  Operation response = future.get();
  }
  

Returns

Type	Description
UnaryCallable<BatchUpdateEntityTypesRequest,Operation>

batchUpdateEntityTypesOperationCallable()

public final OperationCallable<BatchUpdateEntityTypesRequest,BatchUpdateEntityTypesResponse,Struct> batchUpdateEntityTypesOperationCallable()

Updates/Creates multiple entity types in the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: BatchUpdateEntityTypesResponse

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  // This snippet has been automatically generated for illustrative purposes only.
  // It may require modifications to work in your environment.
  try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
  BatchUpdateEntityTypesRequest request =
      BatchUpdateEntityTypesRequest.newBuilder()
          .setParent(AgentName.ofProjectName("[PROJECT]").toString())
          .setLanguageCode("languageCode-2092349083")
          .setUpdateMask(FieldMask.newBuilder().build())
          .build();
  OperationFuture<BatchUpdateEntityTypesResponse, Struct> future =
      entityTypesClient.batchUpdateEntityTypesOperationCallable().futureCall(request);
  // Do something.
  BatchUpdateEntityTypesResponse response = future.get();
  }
  

Returns

Type	Description
OperationCallable<BatchUpdateEntityTypesRequest,BatchUpdateEntityTypesResponse,Struct>

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.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   AgentName parent = AgentName.ofProjectName("[PROJECT]");
   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>/agent.
entityType	EntityType Required. The entity type to create.

Returns

Type	Description
EntityType

createEntityType(AgentName parent, EntityType entityType, String languageCode)

public final EntityType createEntityType(AgentName parent, EntityType entityType, String languageCode)

Creates an entity type in the specified agent.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   AgentName parent = AgentName.ofProjectName("[PROJECT]");
   EntityType entityType = EntityType.newBuilder().build();
   String languageCode = "languageCode-2092349083";
   EntityType response = entityTypesClient.createEntityType(parent, entityType, languageCode);
 }
 

Parameters

Name	Description
parent	AgentName Required. The agent to create a entity type for. Format: projects/<Project ID>/agent.
entityType	EntityType Required. The entity type to create.
languageCode	String Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

Returns

Type	Description
EntityType

createEntityType(CreateEntityTypeRequest request)

public final EntityType createEntityType(CreateEntityTypeRequest request)

Creates an entity type in the specified agent.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   CreateEntityTypeRequest request =
       CreateEntityTypeRequest.newBuilder()
           .setParent(AgentName.ofProjectName("[PROJECT]").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.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   String parent = AgentName.ofProjectName("[PROJECT]").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>/agent.
entityType	EntityType Required. The entity type to create.

Returns

Type	Description
EntityType

createEntityType(String parent, EntityType entityType, String languageCode)

public final EntityType createEntityType(String parent, EntityType entityType, String languageCode)

Creates an entity type in the specified agent.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   String parent = AgentName.ofProjectName("[PROJECT]").toString();
   EntityType entityType = EntityType.newBuilder().build();
   String languageCode = "languageCode-2092349083";
   EntityType response = entityTypesClient.createEntityType(parent, entityType, languageCode);
 }
 

Parameters

Name	Description
parent	String Required. The agent to create a entity type for. Format: projects/<Project ID>/agent.
entityType	EntityType Required. The entity type to create.
languageCode	String Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

Returns

Type	Description
EntityType

createEntityTypeCallable()

public final UnaryCallable<CreateEntityTypeRequest,EntityType> createEntityTypeCallable()

Creates an entity type in the specified agent.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   CreateEntityTypeRequest request =
       CreateEntityTypeRequest.newBuilder()
           .setParent(AgentName.ofProjectName("[PROJECT]").toString())
           .setEntityType(EntityType.newBuilder().build())
           .setLanguageCode("languageCode-2092349083")
           .build();
   ApiFuture<EntityType> future =
       entityTypesClient.createEntityTypeCallable().futureCall(request);
   // Do something.
   EntityType response = future.get();
 }
 

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 an agent prior to sending it queries. See the training documentation.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   DeleteEntityTypeRequest request =
       DeleteEntityTypeRequest.newBuilder()
           .setName(
               EntityTypeName.ofProjectEntityTypeName("[PROJECT]", "[ENTITY_TYPE]").toString())
           .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 an agent prior to sending it queries. See the training documentation.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName name = EntityTypeName.ofProjectEntityTypeName("[PROJECT]", "[ENTITY_TYPE]");
   entityTypesClient.deleteEntityType(name);
 }
 

Parameter

Name	Description
name	EntityTypeName Required. The name of the entity type to delete. Format: projects/<Project ID>/agent/entityTypes/<EntityType ID>.

deleteEntityType(String name)

public final void deleteEntityType(String name)

Deletes the specified entity type.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   String name = EntityTypeName.ofProjectEntityTypeName("[PROJECT]", "[ENTITY_TYPE]").toString();
   entityTypesClient.deleteEntityType(name);
 }
 

Parameter

Name	Description
name	String Required. The name of the entity type to delete. Format: projects/<Project ID>/agent/entityTypes/<EntityType ID>.

deleteEntityTypeCallable()

public final UnaryCallable<DeleteEntityTypeRequest,Empty> deleteEntityTypeCallable()

Deletes the specified entity type.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   DeleteEntityTypeRequest request =
       DeleteEntityTypeRequest.newBuilder()
           .setName(
               EntityTypeName.ofProjectEntityTypeName("[PROJECT]", "[ENTITY_TYPE]").toString())
           .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:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName name = EntityTypeName.ofProjectEntityTypeName("[PROJECT]", "[ENTITY_TYPE]");
   EntityType response = entityTypesClient.getEntityType(name);
 }
 

Parameter

Name	Description
name	EntityTypeName Required. The name of the entity type. Format: projects/<Project ID>/agent/entityTypes/<EntityType ID>.

Returns

Type	Description
EntityType

getEntityType(EntityTypeName name, String languageCode)

public final EntityType getEntityType(EntityTypeName name, String languageCode)

Retrieves the specified entity type.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName name = EntityTypeName.ofProjectEntityTypeName("[PROJECT]", "[ENTITY_TYPE]");
   String languageCode = "languageCode-2092349083";
   EntityType response = entityTypesClient.getEntityType(name, languageCode);
 }
 

Parameters

Name	Description
name	EntityTypeName Required. The name of the entity type. Format: projects/<Project ID>/agent/entityTypes/<EntityType ID>.
languageCode	String Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

Returns

Type	Description
EntityType

getEntityType(GetEntityTypeRequest request)

public final EntityType getEntityType(GetEntityTypeRequest request)

Retrieves the specified entity type.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   GetEntityTypeRequest request =
       GetEntityTypeRequest.newBuilder()
           .setName(
               EntityTypeName.ofProjectEntityTypeName("[PROJECT]", "[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:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   String name = EntityTypeName.ofProjectEntityTypeName("[PROJECT]", "[ENTITY_TYPE]").toString();
   EntityType response = entityTypesClient.getEntityType(name);
 }
 

Parameter

Name	Description
name	String Required. The name of the entity type. Format: projects/<Project ID>/agent/entityTypes/<EntityType ID>.

Returns

Type	Description
EntityType

getEntityType(String name, String languageCode)

public final EntityType getEntityType(String name, String languageCode)

Retrieves the specified entity type.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   String name = EntityTypeName.ofProjectEntityTypeName("[PROJECT]", "[ENTITY_TYPE]").toString();
   String languageCode = "languageCode-2092349083";
   EntityType response = entityTypesClient.getEntityType(name, languageCode);
 }
 

Parameters

Name	Description
name	String Required. The name of the entity type. Format: projects/<Project ID>/agent/entityTypes/<EntityType ID>.
languageCode	String Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

Returns

Type	Description
EntityType

getEntityTypeCallable()

public final UnaryCallable<GetEntityTypeRequest,EntityType> getEntityTypeCallable()

Retrieves the specified entity type.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   GetEntityTypeRequest request =
       GetEntityTypeRequest.newBuilder()
           .setName(
               EntityTypeName.ofProjectEntityTypeName("[PROJECT]", "[ENTITY_TYPE]").toString())
           .setLanguageCode("languageCode-2092349083")
           .build();
   ApiFuture<EntityType> future = entityTypesClient.getEntityTypeCallable().futureCall(request);
   // Do something.
   EntityType response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<GetEntityTypeRequest,EntityType>

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

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

Returns

Type	Description
OperationsClient

getOperationsClient()

public final OperationsClient getOperationsClient()

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

Returns

Type	Description
OperationsClient

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:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   AgentName parent = AgentName.ofProjectName("[PROJECT]");
   for (EntityType element : entityTypesClient.listEntityTypes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	AgentName Required. The agent to list all entity types from. Format: projects/<Project ID>/agent.

Returns

Type	Description
EntityTypesClient.ListEntityTypesPagedResponse

listEntityTypes(AgentName parent, String languageCode)

public final EntityTypesClient.ListEntityTypesPagedResponse listEntityTypes(AgentName parent, String languageCode)

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   AgentName parent = AgentName.ofProjectName("[PROJECT]");
   String languageCode = "languageCode-2092349083";
   for (EntityType element :
       entityTypesClient.listEntityTypes(parent, languageCode).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters

Name	Description
parent	AgentName Required. The agent to list all entity types from. Format: projects/<Project ID>/agent.
languageCode	String Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

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:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   ListEntityTypesRequest request =
       ListEntityTypesRequest.newBuilder()
           .setParent(AgentName.ofProjectName("[PROJECT]").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:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   String parent = AgentName.ofProjectName("[PROJECT]").toString();
   for (EntityType element : entityTypesClient.listEntityTypes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	String Required. The agent to list all entity types from. Format: projects/<Project ID>/agent.

Returns

Type	Description
EntityTypesClient.ListEntityTypesPagedResponse

listEntityTypes(String parent, String languageCode)

public final EntityTypesClient.ListEntityTypesPagedResponse listEntityTypes(String parent, String languageCode)

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

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   String parent = AgentName.ofProjectName("[PROJECT]").toString();
   String languageCode = "languageCode-2092349083";
   for (EntityType element :
       entityTypesClient.listEntityTypes(parent, languageCode).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters

Name	Description
parent	String Required. The agent to list all entity types from. Format: projects/<Project ID>/agent.
languageCode	String Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

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:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   ListEntityTypesRequest request =
       ListEntityTypesRequest.newBuilder()
           .setParent(AgentName.ofProjectName("[PROJECT]").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;
     }
   }
 }
 

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:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   ListEntityTypesRequest request =
       ListEntityTypesRequest.newBuilder()
           .setParent(AgentName.ofProjectName("[PROJECT]").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);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListEntityTypesRequest,ListEntityTypesPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateEntityType(EntityType entityType)

public final EntityType updateEntityType(EntityType entityType)

Updates the specified entity type.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityType entityType = EntityType.newBuilder().build();
   EntityType response = entityTypesClient.updateEntityType(entityType);
 }
 

Parameter

Name	Description
entityType	EntityType Required. The entity type to update.

Returns

Type	Description
EntityType

updateEntityType(EntityType entityType, String languageCode)

public final EntityType updateEntityType(EntityType entityType, String languageCode)

Updates the specified entity type.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityType entityType = EntityType.newBuilder().build();
   String languageCode = "languageCode-2092349083";
   EntityType response = entityTypesClient.updateEntityType(entityType, languageCode);
 }
 

Parameters

Name	Description
entityType	EntityType Required. The entity type to update.
languageCode	String Optional. The language used to access language-specific data. If not specified, the agent's default language is used. For more information, see Multilingual intent and entity data.

Returns

Type	Description
EntityType

updateEntityType(UpdateEntityTypeRequest request)

public final EntityType updateEntityType(UpdateEntityTypeRequest request)

Updates the specified entity type.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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 an agent prior to sending it queries. See the training documentation.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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();
 }
 

Returns

Type	Description
UnaryCallable<UpdateEntityTypeRequest,EntityType>