EntityTypesClient (Google Cloud Dialog Flow API Parent 2.0.0 API)

java.lang.Object
- com.google.cloud.dialogflow.v2.EntityTypesClient

All Implemented Interfaces:

BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class EntityTypesClient
extends Object
implements BackgroundResource
```
Service Description: Entities are extracted from user input and represent parameters that are meaningful to your application. For example, a date range, a proper name such as a geographic location or landmark, and so on. Entities represent actionable data for your application.
When you define an entity, you can also include synonyms that all map to that entity. For example, "soft drink", "soda", "pop", and so on.
There are three types of entities:
* **System** - entities that are defined by the Dialogflow API for common data types such as date, time, currency, and so on. A system entity is represented by the `EntityType` type.
* **Custom** - entities that are defined by you that represent actionable data that is meaningful to your application. For example, you could define a `pizza.sauce` entity for red or white pizza sauce, a `pizza.cheese` entity for the different types of cheese on a pizza, a `pizza.topping` entity for different toppings, and so on. A custom entity is represented by the `EntityType` type.
* **User** - entities that are built for an individual user such as favorites, preferences, playlists, and so on. A user entity is represented by the [SessionEntityType][google.cloud.dialogflow.v2.SessionEntityType] type.
For more information about entity types, see the [Dialogflow documentation](https://cloud.google.com/dialogflow/docs/entities-overview).
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]", "[ENTITY_TYPE]");
   entityTypesClient.deleteEntityType(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);
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`EntityTypesClient.ListEntityTypesFixedSizeCollection`
`static class`	`EntityTypesClient.ListEntityTypesPage`
`static class`	`EntityTypesClient.ListEntityTypesPagedResponse`

Constructor Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`OperationFuture<Empty,Struct>`	`batchCreateEntitiesAsync(BatchCreateEntitiesRequest request)` Creates multiple new entities in the specified entity type.
`OperationFuture<Empty,Struct>`	`batchCreateEntitiesAsync(EntityTypeName parent, List<EntityType.Entity> entities)` Creates multiple new entities in the specified entity type.
`OperationFuture<Empty,Struct>`	`batchCreateEntitiesAsync(EntityTypeName parent, List<EntityType.Entity> entities, String languageCode)` Creates multiple new entities in the specified entity type.
`OperationFuture<Empty,Struct>`	`batchCreateEntitiesAsync(String parent, List<EntityType.Entity> entities)` Creates multiple new entities in the specified entity type.
`OperationFuture<Empty,Struct>`	`batchCreateEntitiesAsync(String parent, List<EntityType.Entity> entities, String languageCode)` Creates multiple new entities in the specified entity type.
`UnaryCallable<BatchCreateEntitiesRequest,Operation>`	`batchCreateEntitiesCallable()` Creates multiple new entities in the specified entity type.
`OperationCallable<BatchCreateEntitiesRequest,Empty,Struct>`	`batchCreateEntitiesOperationCallable()` Creates multiple new entities in the specified entity type.
`OperationFuture<Empty,Struct>`	`batchDeleteEntitiesAsync(BatchDeleteEntitiesRequest request)` Deletes entities in the specified entity type.
`OperationFuture<Empty,Struct>`	`batchDeleteEntitiesAsync(EntityTypeName parent, List<String> entityValues)` Deletes entities in the specified entity type.
`OperationFuture<Empty,Struct>`	`batchDeleteEntitiesAsync(EntityTypeName parent, List<String> entityValues, String languageCode)` Deletes entities in the specified entity type.
`OperationFuture<Empty,Struct>`	`batchDeleteEntitiesAsync(String parent, List<String> entityValues)` Deletes entities in the specified entity type.
`OperationFuture<Empty,Struct>`	`batchDeleteEntitiesAsync(String parent, List<String> entityValues, String languageCode)` Deletes entities in the specified entity type.
`UnaryCallable<BatchDeleteEntitiesRequest,Operation>`	`batchDeleteEntitiesCallable()` Deletes entities in the specified entity type.
`OperationCallable<BatchDeleteEntitiesRequest,Empty,Struct>`	`batchDeleteEntitiesOperationCallable()` Deletes entities in the specified entity type.
`OperationFuture<Empty,Struct>`	`batchDeleteEntityTypesAsync(AgentName parent, List<String> entityTypeNames)` Deletes entity types in the specified agent.
`OperationFuture<Empty,Struct>`	`batchDeleteEntityTypesAsync(BatchDeleteEntityTypesRequest request)` Deletes entity types in the specified agent.
`OperationFuture<Empty,Struct>`	`batchDeleteEntityTypesAsync(String parent, List<String> entityTypeNames)` Deletes entity types in the specified agent.
`UnaryCallable<BatchDeleteEntityTypesRequest,Operation>`	`batchDeleteEntityTypesCallable()` Deletes entity types in the specified agent.
`OperationCallable<BatchDeleteEntityTypesRequest,Empty,Struct>`	`batchDeleteEntityTypesOperationCallable()` Deletes entity types in the specified agent.
`OperationFuture<Empty,Struct>`	`batchUpdateEntitiesAsync(BatchUpdateEntitiesRequest request)` Updates or creates multiple entities in the specified entity type.
`OperationFuture<Empty,Struct>`	`batchUpdateEntitiesAsync(EntityTypeName parent, List<EntityType.Entity> entities)` Updates or creates multiple entities in the specified entity type.
`OperationFuture<Empty,Struct>`	`batchUpdateEntitiesAsync(EntityTypeName parent, List<EntityType.Entity> entities, String languageCode)` Updates or creates multiple entities in the specified entity type.
`OperationFuture<Empty,Struct>`	`batchUpdateEntitiesAsync(String parent, List<EntityType.Entity> entities)` Updates or creates multiple entities in the specified entity type.
`OperationFuture<Empty,Struct>`	`batchUpdateEntitiesAsync(String parent, List<EntityType.Entity> entities, String languageCode)` Updates or creates multiple entities in the specified entity type.
`UnaryCallable<BatchUpdateEntitiesRequest,Operation>`	`batchUpdateEntitiesCallable()` Updates or creates multiple entities in the specified entity type.
`OperationCallable<BatchUpdateEntitiesRequest,Empty,Struct>`	`batchUpdateEntitiesOperationCallable()` Updates or creates multiple entities in the specified entity type.
`OperationFuture<BatchUpdateEntityTypesResponse,Struct>`	`batchUpdateEntityTypesAsync(BatchUpdateEntityTypesRequest request)` Updates/Creates multiple entity types in the specified agent.
`UnaryCallable<BatchUpdateEntityTypesRequest,Operation>`	`batchUpdateEntityTypesCallable()` Updates/Creates multiple entity types in the specified agent.
`OperationCallable<BatchUpdateEntityTypesRequest,BatchUpdateEntityTypesResponse,Struct>`	`batchUpdateEntityTypesOperationCallable()` Updates/Creates multiple entity types in the specified agent.
`void`	`close()`
`static EntityTypesClient`	`create()` Constructs an instance of EntityTypesClient with default settings.
`static EntityTypesClient`	`create(EntityTypesSettings settings)` Constructs an instance of EntityTypesClient, using the given settings.
`static EntityTypesClient`	`create(EntityTypesStub stub)` Constructs an instance of EntityTypesClient, using the given stub for making calls.
`EntityType`	`createEntityType(AgentName parent, EntityType entityType)` Creates an entity type in the specified agent.
`EntityType`	`createEntityType(AgentName parent, EntityType entityType, String languageCode)` Creates an entity type in the specified agent.
`EntityType`	`createEntityType(CreateEntityTypeRequest request)` Creates an entity type in the specified agent.
`EntityType`	`createEntityType(String parent, EntityType entityType)` Creates an entity type in the specified agent.
`EntityType`	`createEntityType(String parent, EntityType entityType, String languageCode)` Creates an entity type in the specified agent.
`UnaryCallable<CreateEntityTypeRequest,EntityType>`	`createEntityTypeCallable()` Creates an entity type in the specified agent.
`void`	`deleteEntityType(DeleteEntityTypeRequest request)` Deletes the specified entity type.
`void`	`deleteEntityType(EntityTypeName name)` Deletes the specified entity type.
`void`	`deleteEntityType(String name)` Deletes the specified entity type.
`UnaryCallable<DeleteEntityTypeRequest,Empty>`	`deleteEntityTypeCallable()` Deletes the specified entity type.
`EntityType`	`getEntityType(EntityTypeName name)` Retrieves the specified entity type.
`EntityType`	`getEntityType(EntityTypeName name, String languageCode)` Retrieves the specified entity type.
`EntityType`	`getEntityType(GetEntityTypeRequest request)` Retrieves the specified entity type.
`EntityType`	`getEntityType(String name)` Retrieves the specified entity type.
`EntityType`	`getEntityType(String name, String languageCode)` Retrieves the specified entity type.
`UnaryCallable<GetEntityTypeRequest,EntityType>`	`getEntityTypeCallable()` Retrieves the specified entity type.
`OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`EntityTypesSettings`	`getSettings()`
`EntityTypesStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`EntityTypesClient.ListEntityTypesPagedResponse`	`listEntityTypes(AgentName parent)` Returns the list of all entity types in the specified agent.
`EntityTypesClient.ListEntityTypesPagedResponse`	`listEntityTypes(AgentName parent, String languageCode)` Returns the list of all entity types in the specified agent.
`EntityTypesClient.ListEntityTypesPagedResponse`	`listEntityTypes(ListEntityTypesRequest request)` Returns the list of all entity types in the specified agent.
`EntityTypesClient.ListEntityTypesPagedResponse`	`listEntityTypes(String parent)` Returns the list of all entity types in the specified agent.
`EntityTypesClient.ListEntityTypesPagedResponse`	`listEntityTypes(String parent, String languageCode)` Returns the list of all entity types in the specified agent.
`UnaryCallable<ListEntityTypesRequest,ListEntityTypesResponse>`	`listEntityTypesCallable()` Returns the list of all entity types in the specified agent.
`UnaryCallable<ListEntityTypesRequest,EntityTypesClient.ListEntityTypesPagedResponse>`	`listEntityTypesPagedCallable()` Returns the list of all entity types in the specified agent.
`void`	`shutdown()`
`void`	`shutdownNow()`
`EntityType`	`updateEntityType(EntityType entityType)` Updates the specified entity type.
`EntityType`	`updateEntityType(EntityType entityType, String languageCode)` Updates the specified entity type.
`EntityType`	`updateEntityType(UpdateEntityTypeRequest request)` Updates the specified entity type.
`UnaryCallable<UpdateEntityTypeRequest,EntityType>`	`updateEntityTypeCallable()` Updates the specified entity type.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- EntityTypesClient
```
protected EntityTypesClient(EntityTypesSettings settings)
                     throws IOException
```
  Constructs an instance of EntityTypesClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
  
  Throws:
  
  IOException
- EntityTypesClient
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected EntityTypesClient(EntityTypesStub stub)
```

Method Detail

create

public static final EntityTypesClient create()
                                      throws IOException

Constructs an instance of EntityTypesClient with default settings.

Throws:: IOException

create
```
public static final EntityTypesClient create(EntityTypesSettings settings)
                                      throws IOException
```
Constructs an instance of EntityTypesClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

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

Constructs an instance of EntityTypesClient, using the given stub for making calls. This is for advanced usage - prefer to use EntityTypesSettings}.

getSettings

public final EntityTypesSettings getSettings()

getStub

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

getOperationsClient

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
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.

deleteEntityType

public final void deleteEntityType(EntityTypeName name)

Deletes the specified entity type.

Sample code:


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

Parameters:: name - Required. The name of the entity type to delete. Format: `projects/<Project ID>/agent/entityTypes/<EntityType ID>`.
Throws:: ApiException - if the remote call fails

deleteEntityType

public final void deleteEntityType(String name)

Deletes the specified entity type.

Sample code:


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

Parameters:: name - Required. The name of the entity type to delete. Format: `projects/<Project ID>/agent/entityTypes/<EntityType ID>`.
Throws:: ApiException - if the remote call fails

deleteEntityType

public final void deleteEntityType(DeleteEntityTypeRequest request)

Deletes the specified entity type.

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName name = EntityTypeName.of("[PROJECT]", "[ENTITY_TYPE]");
   DeleteEntityTypeRequest request = DeleteEntityTypeRequest.newBuilder()
     .setName(name.toString())
     .build();
   entityTypesClient.deleteEntityType(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

deleteEntityTypeCallable

public final UnaryCallable<DeleteEntityTypeRequest,Empty> deleteEntityTypeCallable()

Deletes the specified entity type.

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName name = EntityTypeName.of("[PROJECT]", "[ENTITY_TYPE]");
   DeleteEntityTypeRequest request = DeleteEntityTypeRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Void> future = entityTypesClient.deleteEntityTypeCallable().futureCall(request);
   // Do something
   future.get();
 }

batchDeleteEntityTypesAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,Struct> batchDeleteEntityTypesAsync(AgentName parent,
                                                                                                                                                                                 List<String> entityTypeNames)

Deletes entity types in the specified agent.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]");
   List<String> entityTypeNames = new ArrayList<>();
   entityTypesClient.batchDeleteEntityTypesAsync(parent, entityTypeNames).get();
 }

Parameters:: parent - Required. The name of the agent to delete all entities types for. Format: `projects/<Project ID>/agent`.; entityTypeNames - Required. The names entity types to delete. All names must point to the same agent as `parent`.
Throws:: ApiException - if the remote call fails

batchDeleteEntityTypesAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,Struct> batchDeleteEntityTypesAsync(String parent,
                                                                                                                                                                                 List<String> entityTypeNames)

Deletes entity types in the specified agent.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]");
   List<String> entityTypeNames = new ArrayList<>();
   entityTypesClient.batchDeleteEntityTypesAsync(parent.toString(), entityTypeNames).get();
 }

Parameters:: parent - Required. The name of the agent to delete all entities types for. Format: `projects/<Project ID>/agent`.; entityTypeNames - Required. The names entity types to delete. All names must point to the same agent as `parent`.
Throws:: ApiException - if the remote call fails

batchDeleteEntityTypesAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,Struct> batchDeleteEntityTypesAsync(BatchDeleteEntityTypesRequest request)

Deletes entity types in the specified agent.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]");
   List<String> entityTypeNames = new ArrayList<>();
   BatchDeleteEntityTypesRequest request = BatchDeleteEntityTypesRequest.newBuilder()
     .setParent(parent.toString())
     .addAllEntityTypeNames(entityTypeNames)
     .build();
   entityTypesClient.batchDeleteEntityTypesAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

batchDeleteEntityTypesOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable<BatchDeleteEntityTypesRequest,Empty,Struct> batchDeleteEntityTypesOperationCallable()

Deletes entity types in the specified agent.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]");
   List<String> entityTypeNames = new ArrayList<>();
   BatchDeleteEntityTypesRequest request = BatchDeleteEntityTypesRequest.newBuilder()
     .setParent(parent.toString())
     .addAllEntityTypeNames(entityTypeNames)
     .build();
   OperationFuture<Empty, Struct> future = entityTypesClient.batchDeleteEntityTypesOperationCallable().futureCall(request);
   // Do something
   future.get();
 }

batchDeleteEntityTypesCallable

public final UnaryCallable<BatchDeleteEntityTypesRequest,Operation> batchDeleteEntityTypesCallable()

Deletes entity types in the specified agent.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]");
   List<String> entityTypeNames = new ArrayList<>();
   BatchDeleteEntityTypesRequest request = BatchDeleteEntityTypesRequest.newBuilder()
     .setParent(parent.toString())
     .addAllEntityTypeNames(entityTypeNames)
     .build();
   ApiFuture<Operation> future = entityTypesClient.batchDeleteEntityTypesCallable().futureCall(request);
   // Do something
   future.get();
 }

batchDeleteEntitiesAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,Struct> batchDeleteEntitiesAsync(EntityTypeName parent,
                                                                                                                                                                              List<String> entityValues)

Deletes entities in the specified entity type.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName parent = EntityTypeName.of("[PROJECT]", "[ENTITY_TYPE]");
   List<String> entityValues = new ArrayList<>();
   entityTypesClient.batchDeleteEntitiesAsync(parent, entityValues).get();
 }

Parameters:: parent - Required. The name of the entity type to delete entries for. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.; entityValues - 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>`.
Throws:: ApiException - if the remote call fails

batchDeleteEntitiesAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,Struct> batchDeleteEntitiesAsync(String parent,
                                                                                                                                                                              List<String> entityValues)

Deletes entities in the specified entity type.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName parent = EntityTypeName.of("[PROJECT]", "[ENTITY_TYPE]");
   List<String> entityValues = new ArrayList<>();
   entityTypesClient.batchDeleteEntitiesAsync(parent.toString(), entityValues).get();
 }

Parameters:: parent - Required. The name of the entity type to delete entries for. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.; entityValues - 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>`.
Throws:: ApiException - if the remote call fails

batchDeleteEntitiesAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,Struct> batchDeleteEntitiesAsync(EntityTypeName parent,
                                                                                                                                                                              List<String> entityValues,
                                                                                                                                                                              String languageCode)

Deletes entities in the specified entity type.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName parent = EntityTypeName.of("[PROJECT]", "[ENTITY_TYPE]");
   List<String> entityValues = new ArrayList<>();
   String languageCode = "";
   entityTypesClient.batchDeleteEntitiesAsync(parent, entityValues, languageCode).get();
 }

Parameters:: parent - Required. The name of the entity type to delete entries for. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.; entityValues - 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 - 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](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
Throws:: ApiException - if the remote call fails

batchDeleteEntitiesAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,Struct> batchDeleteEntitiesAsync(String parent,
                                                                                                                                                                              List<String> entityValues,
                                                                                                                                                                              String languageCode)

Deletes entities in the specified entity type.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName parent = EntityTypeName.of("[PROJECT]", "[ENTITY_TYPE]");
   List<String> entityValues = new ArrayList<>();
   String languageCode = "";
   entityTypesClient.batchDeleteEntitiesAsync(parent.toString(), entityValues, languageCode).get();
 }

Parameters:: parent - Required. The name of the entity type to delete entries for. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.; entityValues - 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 - 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](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
Throws:: ApiException - if the remote call fails

batchDeleteEntitiesAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,Struct> batchDeleteEntitiesAsync(BatchDeleteEntitiesRequest request)

Deletes entities in the specified entity type.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName parent = EntityTypeName.of("[PROJECT]", "[ENTITY_TYPE]");
   List<String> entityValues = new ArrayList<>();
   BatchDeleteEntitiesRequest request = BatchDeleteEntitiesRequest.newBuilder()
     .setParent(parent.toString())
     .addAllEntityValues(entityValues)
     .build();
   entityTypesClient.batchDeleteEntitiesAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

batchDeleteEntitiesOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable<BatchDeleteEntitiesRequest,Empty,Struct> batchDeleteEntitiesOperationCallable()

Deletes entities in the specified entity type.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName parent = EntityTypeName.of("[PROJECT]", "[ENTITY_TYPE]");
   List<String> entityValues = new ArrayList<>();
   BatchDeleteEntitiesRequest request = BatchDeleteEntitiesRequest.newBuilder()
     .setParent(parent.toString())
     .addAllEntityValues(entityValues)
     .build();
   OperationFuture<Empty, Struct> future = entityTypesClient.batchDeleteEntitiesOperationCallable().futureCall(request);
   // Do something
   future.get();
 }

batchDeleteEntitiesCallable

public final UnaryCallable<BatchDeleteEntitiesRequest,Operation> batchDeleteEntitiesCallable()

Deletes entities in the specified entity type.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName parent = EntityTypeName.of("[PROJECT]", "[ENTITY_TYPE]");
   List<String> entityValues = new ArrayList<>();
   BatchDeleteEntitiesRequest request = BatchDeleteEntitiesRequest.newBuilder()
     .setParent(parent.toString())
     .addAllEntityValues(entityValues)
     .build();
   ApiFuture<Operation> future = entityTypesClient.batchDeleteEntitiesCallable().futureCall(request);
   // Do something
   future.get();
 }

listEntityTypes

public final EntityTypesClient.ListEntityTypesPagedResponse listEntityTypes(AgentName parent)

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

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]");
   for (EntityType element : entityTypesClient.listEntityTypes(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. The agent to list all entity types from. Format: `projects/<Project ID>/agent`.
Throws:: ApiException - if the remote call fails

listEntityTypes

public final EntityTypesClient.ListEntityTypesPagedResponse listEntityTypes(String parent)

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

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]");
   for (EntityType element : entityTypesClient.listEntityTypes(parent.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. The agent to list all entity types from. Format: `projects/<Project ID>/agent`.
Throws:: ApiException - if the remote call fails

listEntityTypes

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

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

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]");
   String languageCode = "";
   for (EntityType element : entityTypesClient.listEntityTypes(parent, languageCode).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. The agent to list all entity types from. Format: `projects/<Project ID>/agent`.; languageCode - 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](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
Throws:: ApiException - if the remote call fails

listEntityTypes

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

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

Sample code:


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

Parameters:: parent - Required. The agent to list all entity types from. Format: `projects/<Project ID>/agent`.; languageCode - 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](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
Throws:: ApiException - if the remote call fails

listEntityTypes

public final EntityTypesClient.ListEntityTypesPagedResponse listEntityTypes(ListEntityTypesRequest request)

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

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]");
   ListEntityTypesRequest request = ListEntityTypesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   for (EntityType element : entityTypesClient.listEntityTypes(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

listEntityTypesPagedCallable

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

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

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]");
   ListEntityTypesRequest request = ListEntityTypesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<ListEntityTypesPagedResponse> future = entityTypesClient.listEntityTypesPagedCallable().futureCall(request);
   // Do something
   for (EntityType element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listEntityTypesCallable

public final UnaryCallable<ListEntityTypesRequest,ListEntityTypesResponse> listEntityTypesCallable()

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

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]");
   ListEntityTypesRequest request = ListEntityTypesRequest.newBuilder()
     .setParent(parent.toString())
     .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;
     }
   }
 }

getEntityType

public final EntityType getEntityType(EntityTypeName name)

Retrieves the specified entity type.

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName name = EntityTypeName.of("[PROJECT]", "[ENTITY_TYPE]");
   EntityType response = entityTypesClient.getEntityType(name);
 }

Parameters:: name - Required. The name of the entity type. Format: `projects/<Project ID>/agent/entityTypes/<EntityType ID>`.
Throws:: ApiException - if the remote call fails

getEntityType

public final EntityType getEntityType(String name)

Retrieves the specified entity type.

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName name = EntityTypeName.of("[PROJECT]", "[ENTITY_TYPE]");
   EntityType response = entityTypesClient.getEntityType(name.toString());
 }

Parameters:: name - Required. The name of the entity type. Format: `projects/<Project ID>/agent/entityTypes/<EntityType ID>`.
Throws:: ApiException - if the remote call fails

getEntityType
```
public final EntityType getEntityType(EntityTypeName name,
                                      String languageCode)
```
Retrieves the specified entity type.
Sample code:
```
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName name = EntityTypeName.of("[PROJECT]", "[ENTITY_TYPE]");
   String languageCode = "";
   EntityType response = entityTypesClient.getEntityType(name, languageCode);
 }
 
```
Parameters:

name - Required. The name of the entity type. Format: `projects/<Project ID>/agent/entityTypes/<EntityType ID>`.

languageCode - 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](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

Throws:

ApiException - if the remote call fails

getEntityType
```
public final EntityType getEntityType(String name,
                                      String languageCode)
```
Retrieves the specified entity type.
Sample code:
```
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName name = EntityTypeName.of("[PROJECT]", "[ENTITY_TYPE]");
   String languageCode = "";
   EntityType response = entityTypesClient.getEntityType(name.toString(), languageCode);
 }
 
```
Parameters:

name - Required. The name of the entity type. Format: `projects/<Project ID>/agent/entityTypes/<EntityType ID>`.

languageCode - 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](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

Throws:

ApiException - if the remote call fails

getEntityType

public final EntityType getEntityType(GetEntityTypeRequest request)

Retrieves the specified entity type.

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName name = EntityTypeName.of("[PROJECT]", "[ENTITY_TYPE]");
   GetEntityTypeRequest request = GetEntityTypeRequest.newBuilder()
     .setName(name.toString())
     .build();
   EntityType response = entityTypesClient.getEntityType(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

getEntityTypeCallable

public final UnaryCallable<GetEntityTypeRequest,EntityType> getEntityTypeCallable()

Retrieves the specified entity type.

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName name = EntityTypeName.of("[PROJECT]", "[ENTITY_TYPE]");
   GetEntityTypeRequest request = GetEntityTypeRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<EntityType> future = entityTypesClient.getEntityTypeCallable().futureCall(request);
   // Do something
   EntityType response = future.get();
 }

createEntityType

public final EntityType createEntityType(AgentName parent,
                                         EntityType entityType)

Creates an entity type in the specified agent.

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]");
   EntityType entityType = EntityType.newBuilder().build();
   EntityType response = entityTypesClient.createEntityType(parent, entityType);
 }

Parameters:: parent - Required. The agent to create a entity type for. Format: `projects/<Project ID>/agent`.; entityType - Required. The entity type to create.
Throws:: ApiException - if the remote call fails

createEntityType

public final EntityType createEntityType(String parent,
                                         EntityType entityType)

Creates an entity type in the specified agent.

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]");
   EntityType entityType = EntityType.newBuilder().build();
   EntityType response = entityTypesClient.createEntityType(parent.toString(), entityType);
 }

Parameters:: parent - Required. The agent to create a entity type for. Format: `projects/<Project ID>/agent`.; entityType - Required. The entity type to create.
Throws:: ApiException - if the remote call fails

createEntityType

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

Creates an entity type in the specified agent.

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]");
   EntityType entityType = EntityType.newBuilder().build();
   String languageCode = "";
   EntityType response = entityTypesClient.createEntityType(parent, entityType, languageCode);
 }

Parameters:: parent - Required. The agent to create a entity type for. Format: `projects/<Project ID>/agent`.; entityType - Required. The entity type to create.; languageCode - 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](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
Throws:: ApiException - if the remote call fails

createEntityType

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

Creates an entity type in the specified agent.

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]");
   EntityType entityType = EntityType.newBuilder().build();
   String languageCode = "";
   EntityType response = entityTypesClient.createEntityType(parent.toString(), entityType, languageCode);
 }

Parameters:: parent - Required. The agent to create a entity type for. Format: `projects/<Project ID>/agent`.; entityType - Required. The entity type to create.; languageCode - 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](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
Throws:: ApiException - if the remote call fails

createEntityType

public final EntityType createEntityType(CreateEntityTypeRequest request)

Creates an entity type in the specified agent.

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]");
   EntityType entityType = EntityType.newBuilder().build();
   CreateEntityTypeRequest request = CreateEntityTypeRequest.newBuilder()
     .setParent(parent.toString())
     .setEntityType(entityType)
     .build();
   EntityType response = entityTypesClient.createEntityType(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

createEntityTypeCallable

public final UnaryCallable<CreateEntityTypeRequest,EntityType> createEntityTypeCallable()

Creates an entity type in the specified agent.

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]");
   EntityType entityType = EntityType.newBuilder().build();
   CreateEntityTypeRequest request = CreateEntityTypeRequest.newBuilder()
     .setParent(parent.toString())
     .setEntityType(entityType)
     .build();
   ApiFuture<EntityType> future = entityTypesClient.createEntityTypeCallable().futureCall(request);
   // Do something
   EntityType response = future.get();
 }

updateEntityType

public final EntityType updateEntityType(EntityType entityType)

Updates the specified entity type.

Sample code:


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

Parameters:: entityType - Required. The entity type to update.
Throws:: ApiException - if the remote call fails

updateEntityType
```
public final EntityType updateEntityType(EntityType entityType,
                                         String languageCode)
```
Updates the specified entity type.
Sample code:
```
 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityType entityType = EntityType.newBuilder().build();
   String languageCode = "";
   EntityType response = entityTypesClient.updateEntityType(entityType, languageCode);
 }
 
```
Parameters:

entityType - Required. The entity type to update.

languageCode - 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](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).

Throws:

ApiException - if the remote call fails

updateEntityType

public final EntityType updateEntityType(UpdateEntityTypeRequest request)

Updates the specified entity type.

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityType entityType = EntityType.newBuilder().build();
   UpdateEntityTypeRequest request = UpdateEntityTypeRequest.newBuilder()
     .setEntityType(entityType)
     .build();
   EntityType response = entityTypesClient.updateEntityType(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

updateEntityTypeCallable

public final UnaryCallable<UpdateEntityTypeRequest,EntityType> updateEntityTypeCallable()

Updates the specified entity type.

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityType entityType = EntityType.newBuilder().build();
   UpdateEntityTypeRequest request = UpdateEntityTypeRequest.newBuilder()
     .setEntityType(entityType)
     .build();
   ApiFuture<EntityType> future = entityTypesClient.updateEntityTypeCallable().futureCall(request);
   // Do something
   EntityType response = future.get();
 }

batchUpdateEntityTypesAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<BatchUpdateEntityTypesResponse,Struct> batchUpdateEntityTypesAsync(BatchUpdateEntityTypesRequest request)

Updates/Creates multiple entity types in the specified agent.

Operation <response: [BatchUpdateEntityTypesResponse][google.cloud.dialogflow.v2.BatchUpdateEntityTypesResponse]>

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]");
   BatchUpdateEntityTypesRequest request = BatchUpdateEntityTypesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   BatchUpdateEntityTypesResponse response = entityTypesClient.batchUpdateEntityTypesAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

batchUpdateEntityTypesOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable<BatchUpdateEntityTypesRequest,BatchUpdateEntityTypesResponse,Struct> batchUpdateEntityTypesOperationCallable()

Updates/Creates multiple entity types in the specified agent.

Operation <response: [BatchUpdateEntityTypesResponse][google.cloud.dialogflow.v2.BatchUpdateEntityTypesResponse]>

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]");
   BatchUpdateEntityTypesRequest request = BatchUpdateEntityTypesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   OperationFuture<BatchUpdateEntityTypesResponse, Struct> future = entityTypesClient.batchUpdateEntityTypesOperationCallable().futureCall(request);
   // Do something
   BatchUpdateEntityTypesResponse response = future.get();
 }

batchUpdateEntityTypesCallable

public final UnaryCallable<BatchUpdateEntityTypesRequest,Operation> batchUpdateEntityTypesCallable()

Updates/Creates multiple entity types in the specified agent.

Operation <response: [BatchUpdateEntityTypesResponse][google.cloud.dialogflow.v2.BatchUpdateEntityTypesResponse]>

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]");
   BatchUpdateEntityTypesRequest request = BatchUpdateEntityTypesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<Operation> future = entityTypesClient.batchUpdateEntityTypesCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }

batchCreateEntitiesAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,Struct> batchCreateEntitiesAsync(EntityTypeName parent,
                                                                                                                                                                              List<EntityType.Entity> entities)

Creates multiple new entities in the specified entity type.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName parent = EntityTypeName.of("[PROJECT]", "[ENTITY_TYPE]");
   List<EntityType.Entity> entities = new ArrayList<>();
   entityTypesClient.batchCreateEntitiesAsync(parent, entities).get();
 }

Parameters:: parent - Required. The name of the entity type to create entities in. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.; entities - Required. The entities to create.
Throws:: ApiException - if the remote call fails

batchCreateEntitiesAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,Struct> batchCreateEntitiesAsync(String parent,
                                                                                                                                                                              List<EntityType.Entity> entities)

Creates multiple new entities in the specified entity type.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName parent = EntityTypeName.of("[PROJECT]", "[ENTITY_TYPE]");
   List<EntityType.Entity> entities = new ArrayList<>();
   entityTypesClient.batchCreateEntitiesAsync(parent.toString(), entities).get();
 }

Parameters:: parent - Required. The name of the entity type to create entities in. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.; entities - Required. The entities to create.
Throws:: ApiException - if the remote call fails

batchCreateEntitiesAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,Struct> batchCreateEntitiesAsync(EntityTypeName parent,
                                                                                                                                                                              List<EntityType.Entity> entities,
                                                                                                                                                                              String languageCode)

Creates multiple new entities in the specified entity type.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName parent = EntityTypeName.of("[PROJECT]", "[ENTITY_TYPE]");
   List<EntityType.Entity> entities = new ArrayList<>();
   String languageCode = "";
   entityTypesClient.batchCreateEntitiesAsync(parent, entities, languageCode).get();
 }

Parameters:: parent - Required. The name of the entity type to create entities in. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.; entities - Required. The entities to create.; languageCode - 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](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
Throws:: ApiException - if the remote call fails

batchCreateEntitiesAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,Struct> batchCreateEntitiesAsync(String parent,
                                                                                                                                                                              List<EntityType.Entity> entities,
                                                                                                                                                                              String languageCode)

Creates multiple new entities in the specified entity type.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName parent = EntityTypeName.of("[PROJECT]", "[ENTITY_TYPE]");
   List<EntityType.Entity> entities = new ArrayList<>();
   String languageCode = "";
   entityTypesClient.batchCreateEntitiesAsync(parent.toString(), entities, languageCode).get();
 }

Parameters:: parent - Required. The name of the entity type to create entities in. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.; entities - Required. The entities to create.; languageCode - 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](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
Throws:: ApiException - if the remote call fails

batchCreateEntitiesAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<Empty,Struct> batchCreateEntitiesAsync(BatchCreateEntitiesRequest request)

Creates multiple new entities in the specified entity type.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName parent = EntityTypeName.of("[PROJECT]", "[ENTITY_TYPE]");
   List<EntityType.Entity> entities = new ArrayList<>();
   BatchCreateEntitiesRequest request = BatchCreateEntitiesRequest.newBuilder()
     .setParent(parent.toString())
     .addAllEntities(entities)
     .build();
   entityTypesClient.batchCreateEntitiesAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

batchCreateEntitiesOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable<BatchCreateEntitiesRequest,Empty,Struct> batchCreateEntitiesOperationCallable()

Creates multiple new entities in the specified entity type.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName parent = EntityTypeName.of("[PROJECT]", "[ENTITY_TYPE]");
   List<EntityType.Entity> entities = new ArrayList<>();
   BatchCreateEntitiesRequest request = BatchCreateEntitiesRequest.newBuilder()
     .setParent(parent.toString())
     .addAllEntities(entities)
     .build();
   OperationFuture<Empty, Struct> future = entityTypesClient.batchCreateEntitiesOperationCallable().futureCall(request);
   // Do something
   future.get();
 }

batchCreateEntitiesCallable

public final UnaryCallable<BatchCreateEntitiesRequest,Operation> batchCreateEntitiesCallable()

Creates multiple new entities in the specified entity type.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName parent = EntityTypeName.of("[PROJECT]", "[ENTITY_TYPE]");
   List<EntityType.Entity> entities = new ArrayList<>();
   BatchCreateEntitiesRequest request = BatchCreateEntitiesRequest.newBuilder()
     .setParent(parent.toString())
     .addAllEntities(entities)
     .build();
   ApiFuture<Operation> future = entityTypesClient.batchCreateEntitiesCallable().futureCall(request);
   // Do something
   future.get();
 }

batchUpdateEntitiesAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
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.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName parent = EntityTypeName.of("[PROJECT]", "[ENTITY_TYPE]");
   List<EntityType.Entity> entities = new ArrayList<>();
   entityTypesClient.batchUpdateEntitiesAsync(parent, entities).get();
 }

Parameters:: parent - Required. The name of the entity type to update or create entities in. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.; entities - Required. The entities to update or create.
Throws:: ApiException - if the remote call fails

batchUpdateEntitiesAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
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.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName parent = EntityTypeName.of("[PROJECT]", "[ENTITY_TYPE]");
   List<EntityType.Entity> entities = new ArrayList<>();
   entityTypesClient.batchUpdateEntitiesAsync(parent.toString(), entities).get();
 }

Parameters:: parent - Required. The name of the entity type to update or create entities in. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.; entities - Required. The entities to update or create.
Throws:: ApiException - if the remote call fails

batchUpdateEntitiesAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
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.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName parent = EntityTypeName.of("[PROJECT]", "[ENTITY_TYPE]");
   List<EntityType.Entity> entities = new ArrayList<>();
   String languageCode = "";
   entityTypesClient.batchUpdateEntitiesAsync(parent, entities, languageCode).get();
 }

Parameters:: parent - Required. The name of the entity type to update or create entities in. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.; entities - Required. The entities to update or create.; languageCode - 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](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
Throws:: ApiException - if the remote call fails

batchUpdateEntitiesAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
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.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName parent = EntityTypeName.of("[PROJECT]", "[ENTITY_TYPE]");
   List<EntityType.Entity> entities = new ArrayList<>();
   String languageCode = "";
   entityTypesClient.batchUpdateEntitiesAsync(parent.toString(), entities, languageCode).get();
 }

Parameters:: parent - Required. The name of the entity type to update or create entities in. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.; entities - Required. The entities to update or create.; languageCode - 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](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
Throws:: ApiException - if the remote call fails

batchUpdateEntitiesAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
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.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName parent = EntityTypeName.of("[PROJECT]", "[ENTITY_TYPE]");
   List<EntityType.Entity> entities = new ArrayList<>();
   BatchUpdateEntitiesRequest request = BatchUpdateEntitiesRequest.newBuilder()
     .setParent(parent.toString())
     .addAllEntities(entities)
     .build();
   entityTypesClient.batchUpdateEntitiesAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

batchUpdateEntitiesOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
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.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName parent = EntityTypeName.of("[PROJECT]", "[ENTITY_TYPE]");
   List<EntityType.Entity> entities = new ArrayList<>();
   BatchUpdateEntitiesRequest request = BatchUpdateEntitiesRequest.newBuilder()
     .setParent(parent.toString())
     .addAllEntities(entities)
     .build();
   OperationFuture<Empty, Struct> future = entityTypesClient.batchUpdateEntitiesOperationCallable().futureCall(request);
   // Do something
   future.get();
 }

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.

Operation <response: [google.protobuf.Empty][google.protobuf.Empty]>

Sample code:


 try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
   EntityTypeName parent = EntityTypeName.of("[PROJECT]", "[ENTITY_TYPE]");
   List<EntityType.Entity> entities = new ArrayList<>();
   BatchUpdateEntitiesRequest request = BatchUpdateEntitiesRequest.newBuilder()
     .setParent(parent.toString())
     .addAllEntities(entities)
     .build();
   ApiFuture<Operation> future = entityTypesClient.batchUpdateEntitiesCallable().futureCall(request);
   // Do something
   future.get();
 }

close
```
public final void close()
```
Specified by:

close in interface AutoCloseable

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface BackgroundResource

awaitTermination

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

Specified by:: awaitTermination in interface BackgroundResource
Throws:: InterruptedException

Class EntityTypesClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EntityTypesClient

EntityTypesClient

Method Detail

create

create

create

getSettings

getStub

getOperationsClient

deleteEntityType

deleteEntityType

deleteEntityType

deleteEntityTypeCallable

batchDeleteEntityTypesAsync

batchDeleteEntityTypesAsync

batchDeleteEntityTypesAsync

batchDeleteEntityTypesOperationCallable

batchDeleteEntityTypesCallable

batchDeleteEntitiesAsync

batchDeleteEntitiesAsync

batchDeleteEntitiesAsync

batchDeleteEntitiesAsync

batchDeleteEntitiesAsync

batchDeleteEntitiesOperationCallable

batchDeleteEntitiesCallable

listEntityTypes

listEntityTypes

listEntityTypes

listEntityTypes

listEntityTypes

listEntityTypesPagedCallable

listEntityTypesCallable

getEntityType

getEntityType

getEntityType

getEntityType

getEntityType

getEntityTypeCallable

createEntityType

createEntityType

createEntityType

createEntityType

createEntityType

createEntityTypeCallable

updateEntityType

updateEntityType

updateEntityType

updateEntityTypeCallable

batchUpdateEntityTypesAsync

batchUpdateEntityTypesOperationCallable

batchUpdateEntityTypesCallable

batchCreateEntitiesAsync

batchCreateEntitiesAsync

batchCreateEntitiesAsync

batchCreateEntitiesAsync

batchCreateEntitiesAsync

batchCreateEntitiesOperationCallable

batchCreateEntitiesCallable

batchUpdateEntitiesAsync

batchUpdateEntitiesAsync

batchUpdateEntitiesAsync

batchUpdateEntitiesAsync

batchUpdateEntitiesAsync

batchUpdateEntitiesOperationCallable

batchUpdateEntitiesCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination