Google Cloud Dialogflow v2beta1 API - Class EntityTypesClient (1.0.0-beta19)

public abstract class EntityTypesClient

Reference documentation and code samples for the Google Cloud Dialogflow v2beta1 API class EntityTypesClient.

EntityTypes client wrapper, for convenient use.

Inheritance

object > EntityTypesClient

Derived Types

Namespace

Google.Cloud.Dialogflow.V2Beta1

Assembly

Google.Cloud.Dialogflow.V2Beta1.dll

Remarks

Service for managing [EntityTypes][google.cloud.dialogflow.v2beta1.EntityType].

Properties

BatchCreateEntitiesOperationsClient

public virtual OperationsClient BatchCreateEntitiesOperationsClient { get; }

The long-running operations client for BatchCreateEntities.

Property Value
Type Description
OperationsClient

BatchDeleteEntitiesOperationsClient

public virtual OperationsClient BatchDeleteEntitiesOperationsClient { get; }

The long-running operations client for BatchDeleteEntities.

Property Value
Type Description
OperationsClient

BatchDeleteEntityTypesOperationsClient

public virtual OperationsClient BatchDeleteEntityTypesOperationsClient { get; }

The long-running operations client for BatchDeleteEntityTypes.

Property Value
Type Description
OperationsClient

BatchUpdateEntitiesOperationsClient

public virtual OperationsClient BatchUpdateEntitiesOperationsClient { get; }

The long-running operations client for BatchUpdateEntities.

Property Value
Type Description
OperationsClient

BatchUpdateEntityTypesOperationsClient

public virtual OperationsClient BatchUpdateEntityTypesOperationsClient { get; }

The long-running operations client for BatchUpdateEntityTypes.

Property Value
Type Description
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the EntityTypes service, which is a host of "dialogflow.googleapis.com" and a port of 443.

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default EntityTypes scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

GrpcClient

public virtual EntityTypes.EntityTypesClient GrpcClient { get; }

The underlying gRPC EntityTypes client

Property Value
Type Description
EntityTypesEntityTypesClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

Methods

BatchCreateEntities(BatchCreateEntitiesRequest, CallSettings)

public virtual Operation<Empty, Struct> BatchCreateEntities(BatchCreateEntitiesRequest request, CallSettings callSettings = null)

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:

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

Parameters
Name Description
request BatchCreateEntitiesRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyStruct

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
BatchCreateEntitiesRequest request = new BatchCreateEntitiesRequest
{
    ParentAsEntityTypeName = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]"),
    Entities =
    {
        new EntityType.Types.Entity(),
    },
    LanguageCode = "",
};
// Make the request
Operation<Empty, Struct> response = entityTypesClient.BatchCreateEntities(request);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = entityTypesClient.PollOnceBatchCreateEntities(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchCreateEntities(EntityTypeName, IEnumerable<Entity>, CallSettings)

public virtual Operation<Empty, Struct> BatchCreateEntities(EntityTypeName parent, IEnumerable<EntityType.Types.Entity> entities, CallSettings callSettings = null)

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:

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

Parameters
Name Description
parent EntityTypeName

Required. The name of the entity type to create entities in. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entities IEnumerableEntityTypeTypesEntity

Required. The entities to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyStruct

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
EntityTypeName parent = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]");
IEnumerable<EntityType.Types.Entity> entities = new EntityType.Types.Entity[]
{
    new EntityType.Types.Entity(),
};
// Make the request
Operation<Empty, Struct> response = entityTypesClient.BatchCreateEntities(parent, entities);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = entityTypesClient.PollOnceBatchCreateEntities(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchCreateEntities(EntityTypeName, IEnumerable<Entity>, string, CallSettings)

public virtual Operation<Empty, Struct> BatchCreateEntities(EntityTypeName parent, IEnumerable<EntityType.Types.Entity> entities, string languageCode, CallSettings callSettings = null)

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:

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

Parameters
Name Description
parent EntityTypeName

Required. The name of the entity type to create entities in. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entities IEnumerableEntityTypeTypesEntity

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyStruct

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
EntityTypeName parent = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]");
IEnumerable<EntityType.Types.Entity> entities = new EntityType.Types.Entity[]
{
    new EntityType.Types.Entity(),
};
string languageCode = "";
// Make the request
Operation<Empty, Struct> response = entityTypesClient.BatchCreateEntities(parent, entities, languageCode);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = entityTypesClient.PollOnceBatchCreateEntities(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchCreateEntities(string, IEnumerable<Entity>, CallSettings)

public virtual Operation<Empty, Struct> BatchCreateEntities(string parent, IEnumerable<EntityType.Types.Entity> entities, CallSettings callSettings = null)

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:

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

Parameters
Name Description
parent string

Required. The name of the entity type to create entities in. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entities IEnumerableEntityTypeTypesEntity

Required. The entities to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyStruct

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/agent/entityTypes/[ENTITY_TYPE]";
IEnumerable<EntityType.Types.Entity> entities = new EntityType.Types.Entity[]
{
    new EntityType.Types.Entity(),
};
// Make the request
Operation<Empty, Struct> response = entityTypesClient.BatchCreateEntities(parent, entities);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = entityTypesClient.PollOnceBatchCreateEntities(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchCreateEntities(string, IEnumerable<Entity>, string, CallSettings)

public virtual Operation<Empty, Struct> BatchCreateEntities(string parent, IEnumerable<EntityType.Types.Entity> entities, string languageCode, CallSettings callSettings = null)

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:

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

Parameters
Name Description
parent string

Required. The name of the entity type to create entities in. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entities IEnumerableEntityTypeTypesEntity

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyStruct

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/agent/entityTypes/[ENTITY_TYPE]";
IEnumerable<EntityType.Types.Entity> entities = new EntityType.Types.Entity[]
{
    new EntityType.Types.Entity(),
};
string languageCode = "";
// Make the request
Operation<Empty, Struct> response = entityTypesClient.BatchCreateEntities(parent, entities, languageCode);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = entityTypesClient.PollOnceBatchCreateEntities(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchCreateEntitiesAsync(BatchCreateEntitiesRequest, CallSettings)

public virtual Task<Operation<Empty, Struct>> BatchCreateEntitiesAsync(BatchCreateEntitiesRequest request, CallSettings callSettings = null)

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:

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

Parameters
Name Description
request BatchCreateEntitiesRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
BatchCreateEntitiesRequest request = new BatchCreateEntitiesRequest
{
    ParentAsEntityTypeName = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]"),
    Entities =
    {
        new EntityType.Types.Entity(),
    },
    LanguageCode = "",
};
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchCreateEntitiesAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchCreateEntitiesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchCreateEntitiesAsync(BatchCreateEntitiesRequest, CancellationToken)

public virtual Task<Operation<Empty, Struct>> BatchCreateEntitiesAsync(BatchCreateEntitiesRequest request, CancellationToken cancellationToken)

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:

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

Parameters
Name Description
request BatchCreateEntitiesRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
BatchCreateEntitiesRequest request = new BatchCreateEntitiesRequest
{
    ParentAsEntityTypeName = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]"),
    Entities =
    {
        new EntityType.Types.Entity(),
    },
    LanguageCode = "",
};
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchCreateEntitiesAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchCreateEntitiesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchCreateEntitiesAsync(EntityTypeName, IEnumerable<Entity>, CallSettings)

public virtual Task<Operation<Empty, Struct>> BatchCreateEntitiesAsync(EntityTypeName parent, IEnumerable<EntityType.Types.Entity> entities, CallSettings callSettings = null)

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:

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

Parameters
Name Description
parent EntityTypeName

Required. The name of the entity type to create entities in. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entities IEnumerableEntityTypeTypesEntity

Required. The entities to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
EntityTypeName parent = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]");
IEnumerable<EntityType.Types.Entity> entities = new EntityType.Types.Entity[]
{
    new EntityType.Types.Entity(),
};
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchCreateEntitiesAsync(parent, entities);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchCreateEntitiesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchCreateEntitiesAsync(EntityTypeName, IEnumerable<Entity>, string, CallSettings)

public virtual Task<Operation<Empty, Struct>> BatchCreateEntitiesAsync(EntityTypeName parent, IEnumerable<EntityType.Types.Entity> entities, string languageCode, CallSettings callSettings = null)

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:

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

Parameters
Name Description
parent EntityTypeName

Required. The name of the entity type to create entities in. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entities IEnumerableEntityTypeTypesEntity

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
EntityTypeName parent = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]");
IEnumerable<EntityType.Types.Entity> entities = new EntityType.Types.Entity[]
{
    new EntityType.Types.Entity(),
};
string languageCode = "";
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchCreateEntitiesAsync(parent, entities, languageCode);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchCreateEntitiesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchCreateEntitiesAsync(EntityTypeName, IEnumerable<Entity>, string, CancellationToken)

public virtual Task<Operation<Empty, Struct>> BatchCreateEntitiesAsync(EntityTypeName parent, IEnumerable<EntityType.Types.Entity> entities, string languageCode, CancellationToken cancellationToken)

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:

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

Parameters
Name Description
parent EntityTypeName

Required. The name of the entity type to create entities in. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entities IEnumerableEntityTypeTypesEntity

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
EntityTypeName parent = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]");
IEnumerable<EntityType.Types.Entity> entities = new EntityType.Types.Entity[]
{
    new EntityType.Types.Entity(),
};
string languageCode = "";
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchCreateEntitiesAsync(parent, entities, languageCode);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchCreateEntitiesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchCreateEntitiesAsync(EntityTypeName, IEnumerable<Entity>, CancellationToken)

public virtual Task<Operation<Empty, Struct>> BatchCreateEntitiesAsync(EntityTypeName parent, IEnumerable<EntityType.Types.Entity> entities, CancellationToken cancellationToken)

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:

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

Parameters
Name Description
parent EntityTypeName

Required. The name of the entity type to create entities in. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entities IEnumerableEntityTypeTypesEntity

Required. The entities to create.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
EntityTypeName parent = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]");
IEnumerable<EntityType.Types.Entity> entities = new EntityType.Types.Entity[]
{
    new EntityType.Types.Entity(),
};
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchCreateEntitiesAsync(parent, entities);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchCreateEntitiesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchCreateEntitiesAsync(string, IEnumerable<Entity>, CallSettings)

public virtual Task<Operation<Empty, Struct>> BatchCreateEntitiesAsync(string parent, IEnumerable<EntityType.Types.Entity> entities, CallSettings callSettings = null)

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:

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

Parameters
Name Description
parent string

Required. The name of the entity type to create entities in. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entities IEnumerableEntityTypeTypesEntity

Required. The entities to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/agent/entityTypes/[ENTITY_TYPE]";
IEnumerable<EntityType.Types.Entity> entities = new EntityType.Types.Entity[]
{
    new EntityType.Types.Entity(),
};
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchCreateEntitiesAsync(parent, entities);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchCreateEntitiesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchCreateEntitiesAsync(string, IEnumerable<Entity>, string, CallSettings)

public virtual Task<Operation<Empty, Struct>> BatchCreateEntitiesAsync(string parent, IEnumerable<EntityType.Types.Entity> entities, string languageCode, CallSettings callSettings = null)

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:

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

Parameters
Name Description
parent string

Required. The name of the entity type to create entities in. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entities IEnumerableEntityTypeTypesEntity

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/agent/entityTypes/[ENTITY_TYPE]";
IEnumerable<EntityType.Types.Entity> entities = new EntityType.Types.Entity[]
{
    new EntityType.Types.Entity(),
};
string languageCode = "";
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchCreateEntitiesAsync(parent, entities, languageCode);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchCreateEntitiesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchCreateEntitiesAsync(string, IEnumerable<Entity>, string, CancellationToken)

public virtual Task<Operation<Empty, Struct>> BatchCreateEntitiesAsync(string parent, IEnumerable<EntityType.Types.Entity> entities, string languageCode, CancellationToken cancellationToken)

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:

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

Parameters
Name Description
parent string

Required. The name of the entity type to create entities in. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entities IEnumerableEntityTypeTypesEntity

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/agent/entityTypes/[ENTITY_TYPE]";
IEnumerable<EntityType.Types.Entity> entities = new EntityType.Types.Entity[]
{
    new EntityType.Types.Entity(),
};
string languageCode = "";
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchCreateEntitiesAsync(parent, entities, languageCode);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchCreateEntitiesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchCreateEntitiesAsync(string, IEnumerable<Entity>, CancellationToken)

public virtual Task<Operation<Empty, Struct>> BatchCreateEntitiesAsync(string parent, IEnumerable<EntityType.Types.Entity> entities, CancellationToken cancellationToken)

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:

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

Parameters
Name Description
parent string

Required. The name of the entity type to create entities in. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entities IEnumerableEntityTypeTypesEntity

Required. The entities to create.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/agent/entityTypes/[ENTITY_TYPE]";
IEnumerable<EntityType.Types.Entity> entities = new EntityType.Types.Entity[]
{
    new EntityType.Types.Entity(),
};
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchCreateEntitiesAsync(parent, entities);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchCreateEntitiesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchDeleteEntities(BatchDeleteEntitiesRequest, CallSettings)

public virtual Operation<Empty, Struct> BatchDeleteEntities(BatchDeleteEntitiesRequest request, CallSettings callSettings = null)

Deletes entities in the specified entity type.

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

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

Parameters
Name Description
request BatchDeleteEntitiesRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyStruct

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
BatchDeleteEntitiesRequest request = new BatchDeleteEntitiesRequest
{
    ParentAsEntityTypeName = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]"),
    EntityValues = { "", },
    LanguageCode = "",
};
// Make the request
Operation<Empty, Struct> response = entityTypesClient.BatchDeleteEntities(request);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = entityTypesClient.PollOnceBatchDeleteEntities(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchDeleteEntities(EntityTypeName, IEnumerable<string>, CallSettings)

public virtual Operation<Empty, Struct> BatchDeleteEntities(EntityTypeName parent, IEnumerable<string> entityValues, CallSettings callSettings = null)

Deletes entities in the specified entity type.

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

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

Parameters
Name Description
parent EntityTypeName

Required. The name of the entity type to delete entries for. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entityValues IEnumerablestring

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyStruct

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
EntityTypeName parent = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]");
IEnumerable<string> entityValues = new string[] { "", };
// Make the request
Operation<Empty, Struct> response = entityTypesClient.BatchDeleteEntities(parent, entityValues);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = entityTypesClient.PollOnceBatchDeleteEntities(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchDeleteEntities(EntityTypeName, IEnumerable<string>, string, CallSettings)

public virtual Operation<Empty, Struct> BatchDeleteEntities(EntityTypeName parent, IEnumerable<string> entityValues, string languageCode, CallSettings callSettings = null)

Deletes entities in the specified entity type.

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

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

Parameters
Name Description
parent EntityTypeName

Required. The name of the entity type to delete entries for. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entityValues IEnumerablestring

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyStruct

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
EntityTypeName parent = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]");
IEnumerable<string> entityValues = new string[] { "", };
string languageCode = "";
// Make the request
Operation<Empty, Struct> response = entityTypesClient.BatchDeleteEntities(parent, entityValues, languageCode);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = entityTypesClient.PollOnceBatchDeleteEntities(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchDeleteEntities(string, IEnumerable<string>, CallSettings)

public virtual Operation<Empty, Struct> BatchDeleteEntities(string parent, IEnumerable<string> entityValues, CallSettings callSettings = null)

Deletes entities in the specified entity type.

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

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

Parameters
Name Description
parent string

Required. The name of the entity type to delete entries for. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entityValues IEnumerablestring

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyStruct

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/agent/entityTypes/[ENTITY_TYPE]";
IEnumerable<string> entityValues = new string[] { "", };
// Make the request
Operation<Empty, Struct> response = entityTypesClient.BatchDeleteEntities(parent, entityValues);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = entityTypesClient.PollOnceBatchDeleteEntities(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchDeleteEntities(string, IEnumerable<string>, string, CallSettings)

public virtual Operation<Empty, Struct> BatchDeleteEntities(string parent, IEnumerable<string> entityValues, string languageCode, CallSettings callSettings = null)

Deletes entities in the specified entity type.

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

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

Parameters
Name Description
parent string

Required. The name of the entity type to delete entries for. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entityValues IEnumerablestring

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyStruct

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/agent/entityTypes/[ENTITY_TYPE]";
IEnumerable<string> entityValues = new string[] { "", };
string languageCode = "";
// Make the request
Operation<Empty, Struct> response = entityTypesClient.BatchDeleteEntities(parent, entityValues, languageCode);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = entityTypesClient.PollOnceBatchDeleteEntities(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchDeleteEntitiesAsync(BatchDeleteEntitiesRequest, CallSettings)

public virtual Task<Operation<Empty, Struct>> BatchDeleteEntitiesAsync(BatchDeleteEntitiesRequest request, CallSettings callSettings = null)

Deletes entities in the specified entity type.

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

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

Parameters
Name Description
request BatchDeleteEntitiesRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
BatchDeleteEntitiesRequest request = new BatchDeleteEntitiesRequest
{
    ParentAsEntityTypeName = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]"),
    EntityValues = { "", },
    LanguageCode = "",
};
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchDeleteEntitiesAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchDeleteEntitiesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchDeleteEntitiesAsync(BatchDeleteEntitiesRequest, CancellationToken)

public virtual Task<Operation<Empty, Struct>> BatchDeleteEntitiesAsync(BatchDeleteEntitiesRequest request, CancellationToken cancellationToken)

Deletes entities in the specified entity type.

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

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

Parameters
Name Description
request BatchDeleteEntitiesRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
BatchDeleteEntitiesRequest request = new BatchDeleteEntitiesRequest
{
    ParentAsEntityTypeName = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]"),
    EntityValues = { "", },
    LanguageCode = "",
};
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchDeleteEntitiesAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchDeleteEntitiesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchDeleteEntitiesAsync(EntityTypeName, IEnumerable<string>, CallSettings)

public virtual Task<Operation<Empty, Struct>> BatchDeleteEntitiesAsync(EntityTypeName parent, IEnumerable<string> entityValues, CallSettings callSettings = null)

Deletes entities in the specified entity type.

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

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

Parameters
Name Description
parent EntityTypeName

Required. The name of the entity type to delete entries for. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entityValues IEnumerablestring

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
EntityTypeName parent = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]");
IEnumerable<string> entityValues = new string[] { "", };
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchDeleteEntitiesAsync(parent, entityValues);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchDeleteEntitiesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchDeleteEntitiesAsync(EntityTypeName, IEnumerable<string>, string, CallSettings)

public virtual Task<Operation<Empty, Struct>> BatchDeleteEntitiesAsync(EntityTypeName parent, IEnumerable<string> entityValues, string languageCode, CallSettings callSettings = null)

Deletes entities in the specified entity type.

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

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

Parameters
Name Description
parent EntityTypeName

Required. The name of the entity type to delete entries for. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entityValues IEnumerablestring

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
EntityTypeName parent = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]");
IEnumerable<string> entityValues = new string[] { "", };
string languageCode = "";
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchDeleteEntitiesAsync(parent, entityValues, languageCode);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchDeleteEntitiesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchDeleteEntitiesAsync(EntityTypeName, IEnumerable<string>, string, CancellationToken)

public virtual Task<Operation<Empty, Struct>> BatchDeleteEntitiesAsync(EntityTypeName parent, IEnumerable<string> entityValues, string languageCode, CancellationToken cancellationToken)

Deletes entities in the specified entity type.

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

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

Parameters
Name Description
parent EntityTypeName

Required. The name of the entity type to delete entries for. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entityValues IEnumerablestring

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
EntityTypeName parent = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]");
IEnumerable<string> entityValues = new string[] { "", };
string languageCode = "";
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchDeleteEntitiesAsync(parent, entityValues, languageCode);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchDeleteEntitiesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchDeleteEntitiesAsync(EntityTypeName, IEnumerable<string>, CancellationToken)

public virtual Task<Operation<Empty, Struct>> BatchDeleteEntitiesAsync(EntityTypeName parent, IEnumerable<string> entityValues, CancellationToken cancellationToken)

Deletes entities in the specified entity type.

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

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

Parameters
Name Description
parent EntityTypeName

Required. The name of the entity type to delete entries for. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entityValues IEnumerablestring

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
EntityTypeName parent = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]");
IEnumerable<string> entityValues = new string[] { "", };
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchDeleteEntitiesAsync(parent, entityValues);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchDeleteEntitiesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchDeleteEntitiesAsync(string, IEnumerable<string>, CallSettings)

public virtual Task<Operation<Empty, Struct>> BatchDeleteEntitiesAsync(string parent, IEnumerable<string> entityValues, CallSettings callSettings = null)

Deletes entities in the specified entity type.

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

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

Parameters
Name Description
parent string

Required. The name of the entity type to delete entries for. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entityValues IEnumerablestring

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/agent/entityTypes/[ENTITY_TYPE]";
IEnumerable<string> entityValues = new string[] { "", };
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchDeleteEntitiesAsync(parent, entityValues);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchDeleteEntitiesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchDeleteEntitiesAsync(string, IEnumerable<string>, string, CallSettings)

public virtual Task<Operation<Empty, Struct>> BatchDeleteEntitiesAsync(string parent, IEnumerable<string> entityValues, string languageCode, CallSettings callSettings = null)

Deletes entities in the specified entity type.

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

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

Parameters
Name Description
parent string

Required. The name of the entity type to delete entries for. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entityValues IEnumerablestring

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/agent/entityTypes/[ENTITY_TYPE]";
IEnumerable<string> entityValues = new string[] { "", };
string languageCode = "";
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchDeleteEntitiesAsync(parent, entityValues, languageCode);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchDeleteEntitiesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchDeleteEntitiesAsync(string, IEnumerable<string>, string, CancellationToken)

public virtual Task<Operation<Empty, Struct>> BatchDeleteEntitiesAsync(string parent, IEnumerable<string> entityValues, string languageCode, CancellationToken cancellationToken)

Deletes entities in the specified entity type.

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

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

Parameters
Name Description
parent string

Required. The name of the entity type to delete entries for. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entityValues IEnumerablestring

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/agent/entityTypes/[ENTITY_TYPE]";
IEnumerable<string> entityValues = new string[] { "", };
string languageCode = "";
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchDeleteEntitiesAsync(parent, entityValues, languageCode);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchDeleteEntitiesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchDeleteEntitiesAsync(string, IEnumerable<string>, CancellationToken)

public virtual Task<Operation<Empty, Struct>> BatchDeleteEntitiesAsync(string parent, IEnumerable<string> entityValues, CancellationToken cancellationToken)

Deletes entities in the specified entity type.

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

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

Parameters
Name Description
parent string

Required. The name of the entity type to delete entries for. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entityValues IEnumerablestring

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/agent/entityTypes/[ENTITY_TYPE]";
IEnumerable<string> entityValues = new string[] { "", };
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchDeleteEntitiesAsync(parent, entityValues);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchDeleteEntitiesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchDeleteEntityTypes(AgentName, IEnumerable<string>, CallSettings)

public virtual Operation<Empty, Struct> BatchDeleteEntityTypes(AgentName parent, IEnumerable<string> entityTypeNames, CallSettings callSettings = null)

Deletes entity types in the specified agent.

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

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

Parameters
Name Description
parent AgentName

Required. The name of the agent to delete all entities types for. Supported formats:

  • projects/<Project ID>/agent,
  • projects/<Project ID>/locations/<Location ID>/agent.
entityTypeNames IEnumerablestring

Required. The names entity types to delete. All names must point to the same agent as parent.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyStruct

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
AgentName parent = AgentName.FromProject("[PROJECT]");
IEnumerable<string> entityTypeNames = new string[] { "", };
// Make the request
Operation<Empty, Struct> response = entityTypesClient.BatchDeleteEntityTypes(parent, entityTypeNames);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = entityTypesClient.PollOnceBatchDeleteEntityTypes(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchDeleteEntityTypes(BatchDeleteEntityTypesRequest, CallSettings)

public virtual Operation<Empty, Struct> BatchDeleteEntityTypes(BatchDeleteEntityTypesRequest request, CallSettings callSettings = null)

Deletes entity types in the specified agent.

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

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

Parameters
Name Description
request BatchDeleteEntityTypesRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyStruct

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
BatchDeleteEntityTypesRequest request = new BatchDeleteEntityTypesRequest
{
    ParentAsAgentName = AgentName.FromProject("[PROJECT]"),
    EntityTypeNames = { "", },
};
// Make the request
Operation<Empty, Struct> response = entityTypesClient.BatchDeleteEntityTypes(request);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = entityTypesClient.PollOnceBatchDeleteEntityTypes(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchDeleteEntityTypes(string, IEnumerable<string>, CallSettings)

public virtual Operation<Empty, Struct> BatchDeleteEntityTypes(string parent, IEnumerable<string> entityTypeNames, CallSettings callSettings = null)

Deletes entity types in the specified agent.

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

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

Parameters
Name Description
parent string

Required. The name of the agent to delete all entities types for. Supported formats:

  • projects/<Project ID>/agent,
  • projects/<Project ID>/locations/<Location ID>/agent.
entityTypeNames IEnumerablestring

Required. The names entity types to delete. All names must point to the same agent as parent.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyStruct

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/agent";
IEnumerable<string> entityTypeNames = new string[] { "", };
// Make the request
Operation<Empty, Struct> response = entityTypesClient.BatchDeleteEntityTypes(parent, entityTypeNames);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = entityTypesClient.PollOnceBatchDeleteEntityTypes(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchDeleteEntityTypesAsync(AgentName, IEnumerable<string>, CallSettings)

public virtual Task<Operation<Empty, Struct>> BatchDeleteEntityTypesAsync(AgentName parent, IEnumerable<string> entityTypeNames, CallSettings callSettings = null)

Deletes entity types in the specified agent.

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

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

Parameters
Name Description
parent AgentName

Required. The name of the agent to delete all entities types for. Supported formats:

  • projects/<Project ID>/agent,
  • projects/<Project ID>/locations/<Location ID>/agent.
entityTypeNames IEnumerablestring

Required. The names entity types to delete. All names must point to the same agent as parent.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
AgentName parent = AgentName.FromProject("[PROJECT]");
IEnumerable<string> entityTypeNames = new string[] { "", };
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchDeleteEntityTypesAsync(parent, entityTypeNames);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchDeleteEntityTypesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchDeleteEntityTypesAsync(AgentName, IEnumerable<string>, CancellationToken)

public virtual Task<Operation<Empty, Struct>> BatchDeleteEntityTypesAsync(AgentName parent, IEnumerable<string> entityTypeNames, CancellationToken cancellationToken)

Deletes entity types in the specified agent.

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

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

Parameters
Name Description
parent AgentName

Required. The name of the agent to delete all entities types for. Supported formats:

  • projects/<Project ID>/agent,
  • projects/<Project ID>/locations/<Location ID>/agent.
entityTypeNames IEnumerablestring

Required. The names entity types to delete. All names must point to the same agent as parent.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
AgentName parent = AgentName.FromProject("[PROJECT]");
IEnumerable<string> entityTypeNames = new string[] { "", };
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchDeleteEntityTypesAsync(parent, entityTypeNames);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchDeleteEntityTypesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchDeleteEntityTypesAsync(BatchDeleteEntityTypesRequest, CallSettings)

public virtual Task<Operation<Empty, Struct>> BatchDeleteEntityTypesAsync(BatchDeleteEntityTypesRequest request, CallSettings callSettings = null)

Deletes entity types in the specified agent.

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

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

Parameters
Name Description
request BatchDeleteEntityTypesRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
BatchDeleteEntityTypesRequest request = new BatchDeleteEntityTypesRequest
{
    ParentAsAgentName = AgentName.FromProject("[PROJECT]"),
    EntityTypeNames = { "", },
};
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchDeleteEntityTypesAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchDeleteEntityTypesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchDeleteEntityTypesAsync(BatchDeleteEntityTypesRequest, CancellationToken)

public virtual Task<Operation<Empty, Struct>> BatchDeleteEntityTypesAsync(BatchDeleteEntityTypesRequest request, CancellationToken cancellationToken)

Deletes entity types in the specified agent.

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

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

Parameters
Name Description
request BatchDeleteEntityTypesRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
BatchDeleteEntityTypesRequest request = new BatchDeleteEntityTypesRequest
{
    ParentAsAgentName = AgentName.FromProject("[PROJECT]"),
    EntityTypeNames = { "", },
};
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchDeleteEntityTypesAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchDeleteEntityTypesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchDeleteEntityTypesAsync(string, IEnumerable<string>, CallSettings)

public virtual Task<Operation<Empty, Struct>> BatchDeleteEntityTypesAsync(string parent, IEnumerable<string> entityTypeNames, CallSettings callSettings = null)

Deletes entity types in the specified agent.

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

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

Parameters
Name Description
parent string

Required. The name of the agent to delete all entities types for. Supported formats:

  • projects/<Project ID>/agent,
  • projects/<Project ID>/locations/<Location ID>/agent.
entityTypeNames IEnumerablestring

Required. The names entity types to delete. All names must point to the same agent as parent.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/agent";
IEnumerable<string> entityTypeNames = new string[] { "", };
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchDeleteEntityTypesAsync(parent, entityTypeNames);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchDeleteEntityTypesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchDeleteEntityTypesAsync(string, IEnumerable<string>, CancellationToken)

public virtual Task<Operation<Empty, Struct>> BatchDeleteEntityTypesAsync(string parent, IEnumerable<string> entityTypeNames, CancellationToken cancellationToken)

Deletes entity types in the specified agent.

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

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

Parameters
Name Description
parent string

Required. The name of the agent to delete all entities types for. Supported formats:

  • projects/<Project ID>/agent,
  • projects/<Project ID>/locations/<Location ID>/agent.
entityTypeNames IEnumerablestring

Required. The names entity types to delete. All names must point to the same agent as parent.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/agent";
IEnumerable<string> entityTypeNames = new string[] { "", };
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchDeleteEntityTypesAsync(parent, entityTypeNames);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchDeleteEntityTypesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchUpdateEntities(BatchUpdateEntitiesRequest, CallSettings)

public virtual Operation<Empty, Struct> BatchUpdateEntities(BatchUpdateEntitiesRequest request, CallSettings callSettings = null)

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.

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

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

Parameters
Name Description
request BatchUpdateEntitiesRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyStruct

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
BatchUpdateEntitiesRequest request = new BatchUpdateEntitiesRequest
{
    ParentAsEntityTypeName = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]"),
    Entities =
    {
        new EntityType.Types.Entity(),
    },
    LanguageCode = "",
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<Empty, Struct> response = entityTypesClient.BatchUpdateEntities(request);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = entityTypesClient.PollOnceBatchUpdateEntities(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchUpdateEntities(EntityTypeName, IEnumerable<Entity>, CallSettings)

public virtual Operation<Empty, Struct> BatchUpdateEntities(EntityTypeName parent, IEnumerable<EntityType.Types.Entity> entities, CallSettings callSettings = null)

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.

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

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

Parameters
Name Description
parent EntityTypeName

Required. The name of the entity type to update or create entities in. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entities IEnumerableEntityTypeTypesEntity

Required. The entities to update or create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyStruct

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
EntityTypeName parent = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]");
IEnumerable<EntityType.Types.Entity> entities = new EntityType.Types.Entity[]
{
    new EntityType.Types.Entity(),
};
// Make the request
Operation<Empty, Struct> response = entityTypesClient.BatchUpdateEntities(parent, entities);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = entityTypesClient.PollOnceBatchUpdateEntities(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchUpdateEntities(EntityTypeName, IEnumerable<Entity>, string, CallSettings)

public virtual Operation<Empty, Struct> BatchUpdateEntities(EntityTypeName parent, IEnumerable<EntityType.Types.Entity> entities, string languageCode, CallSettings callSettings = null)

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.

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

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

Parameters
Name Description
parent EntityTypeName

Required. The name of the entity type to update or create entities in. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entities IEnumerableEntityTypeTypesEntity

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyStruct

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
EntityTypeName parent = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]");
IEnumerable<EntityType.Types.Entity> entities = new EntityType.Types.Entity[]
{
    new EntityType.Types.Entity(),
};
string languageCode = "";
// Make the request
Operation<Empty, Struct> response = entityTypesClient.BatchUpdateEntities(parent, entities, languageCode);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = entityTypesClient.PollOnceBatchUpdateEntities(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchUpdateEntities(string, IEnumerable<Entity>, CallSettings)

public virtual Operation<Empty, Struct> BatchUpdateEntities(string parent, IEnumerable<EntityType.Types.Entity> entities, CallSettings callSettings = null)

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.

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

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

Parameters
Name Description
parent string

Required. The name of the entity type to update or create entities in. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entities IEnumerableEntityTypeTypesEntity

Required. The entities to update or create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyStruct

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/agent/entityTypes/[ENTITY_TYPE]";
IEnumerable<EntityType.Types.Entity> entities = new EntityType.Types.Entity[]
{
    new EntityType.Types.Entity(),
};
// Make the request
Operation<Empty, Struct> response = entityTypesClient.BatchUpdateEntities(parent, entities);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = entityTypesClient.PollOnceBatchUpdateEntities(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchUpdateEntities(string, IEnumerable<Entity>, string, CallSettings)

public virtual Operation<Empty, Struct> BatchUpdateEntities(string parent, IEnumerable<EntityType.Types.Entity> entities, string languageCode, CallSettings callSettings = null)

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.

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

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

Parameters
Name Description
parent string

Required. The name of the entity type to update or create entities in. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entities IEnumerableEntityTypeTypesEntity

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyStruct

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/agent/entityTypes/[ENTITY_TYPE]";
IEnumerable<EntityType.Types.Entity> entities = new EntityType.Types.Entity[]
{
    new EntityType.Types.Entity(),
};
string languageCode = "";
// Make the request
Operation<Empty, Struct> response = entityTypesClient.BatchUpdateEntities(parent, entities, languageCode);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = entityTypesClient.PollOnceBatchUpdateEntities(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchUpdateEntitiesAsync(BatchUpdateEntitiesRequest, CallSettings)

public virtual Task<Operation<Empty, Struct>> BatchUpdateEntitiesAsync(BatchUpdateEntitiesRequest request, CallSettings callSettings = null)

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.

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

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

Parameters
Name Description
request BatchUpdateEntitiesRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
BatchUpdateEntitiesRequest request = new BatchUpdateEntitiesRequest
{
    ParentAsEntityTypeName = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]"),
    Entities =
    {
        new EntityType.Types.Entity(),
    },
    LanguageCode = "",
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchUpdateEntitiesAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchUpdateEntitiesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchUpdateEntitiesAsync(BatchUpdateEntitiesRequest, CancellationToken)

public virtual Task<Operation<Empty, Struct>> BatchUpdateEntitiesAsync(BatchUpdateEntitiesRequest request, CancellationToken cancellationToken)

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.

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

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

Parameters
Name Description
request BatchUpdateEntitiesRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
BatchUpdateEntitiesRequest request = new BatchUpdateEntitiesRequest
{
    ParentAsEntityTypeName = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]"),
    Entities =
    {
        new EntityType.Types.Entity(),
    },
    LanguageCode = "",
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchUpdateEntitiesAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchUpdateEntitiesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchUpdateEntitiesAsync(EntityTypeName, IEnumerable<Entity>, CallSettings)

public virtual Task<Operation<Empty, Struct>> BatchUpdateEntitiesAsync(EntityTypeName parent, IEnumerable<EntityType.Types.Entity> entities, CallSettings callSettings = null)

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.

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

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

Parameters
Name Description
parent EntityTypeName

Required. The name of the entity type to update or create entities in. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entities IEnumerableEntityTypeTypesEntity

Required. The entities to update or create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
EntityTypeName parent = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]");
IEnumerable<EntityType.Types.Entity> entities = new EntityType.Types.Entity[]
{
    new EntityType.Types.Entity(),
};
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchUpdateEntitiesAsync(parent, entities);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchUpdateEntitiesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchUpdateEntitiesAsync(EntityTypeName, IEnumerable<Entity>, string, CallSettings)

public virtual Task<Operation<Empty, Struct>> BatchUpdateEntitiesAsync(EntityTypeName parent, IEnumerable<EntityType.Types.Entity> entities, string languageCode, CallSettings callSettings = null)

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.

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

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

Parameters
Name Description
parent EntityTypeName

Required. The name of the entity type to update or create entities in. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entities IEnumerableEntityTypeTypesEntity

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
EntityTypeName parent = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]");
IEnumerable<EntityType.Types.Entity> entities = new EntityType.Types.Entity[]
{
    new EntityType.Types.Entity(),
};
string languageCode = "";
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchUpdateEntitiesAsync(parent, entities, languageCode);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchUpdateEntitiesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchUpdateEntitiesAsync(EntityTypeName, IEnumerable<Entity>, string, CancellationToken)

public virtual Task<Operation<Empty, Struct>> BatchUpdateEntitiesAsync(EntityTypeName parent, IEnumerable<EntityType.Types.Entity> entities, string languageCode, CancellationToken cancellationToken)

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.

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

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

Parameters
Name Description
parent EntityTypeName

Required. The name of the entity type to update or create entities in. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entities IEnumerableEntityTypeTypesEntity

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
EntityTypeName parent = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]");
IEnumerable<EntityType.Types.Entity> entities = new EntityType.Types.Entity[]
{
    new EntityType.Types.Entity(),
};
string languageCode = "";
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchUpdateEntitiesAsync(parent, entities, languageCode);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchUpdateEntitiesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchUpdateEntitiesAsync(EntityTypeName, IEnumerable<Entity>, CancellationToken)

public virtual Task<Operation<Empty, Struct>> BatchUpdateEntitiesAsync(EntityTypeName parent, IEnumerable<EntityType.Types.Entity> entities, CancellationToken cancellationToken)

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.

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

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

Parameters
Name Description
parent EntityTypeName

Required. The name of the entity type to update or create entities in. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entities IEnumerableEntityTypeTypesEntity

Required. The entities to update or create.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
EntityTypeName parent = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]");
IEnumerable<EntityType.Types.Entity> entities = new EntityType.Types.Entity[]
{
    new EntityType.Types.Entity(),
};
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchUpdateEntitiesAsync(parent, entities);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchUpdateEntitiesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchUpdateEntitiesAsync(string, IEnumerable<Entity>, CallSettings)

public virtual Task<Operation<Empty, Struct>> BatchUpdateEntitiesAsync(string parent, IEnumerable<EntityType.Types.Entity> entities, CallSettings callSettings = null)

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.

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

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

Parameters
Name Description
parent string

Required. The name of the entity type to update or create entities in. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entities IEnumerableEntityTypeTypesEntity

Required. The entities to update or create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/agent/entityTypes/[ENTITY_TYPE]";
IEnumerable<EntityType.Types.Entity> entities = new EntityType.Types.Entity[]
{
    new EntityType.Types.Entity(),
};
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchUpdateEntitiesAsync(parent, entities);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchUpdateEntitiesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchUpdateEntitiesAsync(string, IEnumerable<Entity>, string, CallSettings)

public virtual Task<Operation<Empty, Struct>> BatchUpdateEntitiesAsync(string parent, IEnumerable<EntityType.Types.Entity> entities, string languageCode, CallSettings callSettings = null)

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.

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

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

Parameters
Name Description
parent string

Required. The name of the entity type to update or create entities in. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entities IEnumerableEntityTypeTypesEntity

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/agent/entityTypes/[ENTITY_TYPE]";
IEnumerable<EntityType.Types.Entity> entities = new EntityType.Types.Entity[]
{
    new EntityType.Types.Entity(),
};
string languageCode = "";
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchUpdateEntitiesAsync(parent, entities, languageCode);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchUpdateEntitiesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchUpdateEntitiesAsync(string, IEnumerable<Entity>, string, CancellationToken)

public virtual Task<Operation<Empty, Struct>> BatchUpdateEntitiesAsync(string parent, IEnumerable<EntityType.Types.Entity> entities, string languageCode, CancellationToken cancellationToken)

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.

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

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

Parameters
Name Description
parent string

Required. The name of the entity type to update or create entities in. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entities IEnumerableEntityTypeTypesEntity

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/agent/entityTypes/[ENTITY_TYPE]";
IEnumerable<EntityType.Types.Entity> entities = new EntityType.Types.Entity[]
{
    new EntityType.Types.Entity(),
};
string languageCode = "";
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchUpdateEntitiesAsync(parent, entities, languageCode);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchUpdateEntitiesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchUpdateEntitiesAsync(string, IEnumerable<Entity>, CancellationToken)

public virtual Task<Operation<Empty, Struct>> BatchUpdateEntitiesAsync(string parent, IEnumerable<EntityType.Types.Entity> entities, CancellationToken cancellationToken)

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.

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

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

Parameters
Name Description
parent string

Required. The name of the entity type to update or create entities in. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
entities IEnumerableEntityTypeTypesEntity

Required. The entities to update or create.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationEmptyStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/agent/entityTypes/[ENTITY_TYPE]";
IEnumerable<EntityType.Types.Entity> entities = new EntityType.Types.Entity[]
{
    new EntityType.Types.Entity(),
};
// Make the request
Operation<Empty, Struct> response = await entityTypesClient.BatchUpdateEntitiesAsync(parent, entities);

// Poll until the returned long-running operation is complete
Operation<Empty, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchUpdateEntitiesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

BatchUpdateEntityTypes(BatchUpdateEntityTypesRequest, CallSettings)

public virtual Operation<BatchUpdateEntityTypesResponse, Struct> BatchUpdateEntityTypes(BatchUpdateEntityTypesRequest request, CallSettings callSettings = null)

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][google.cloud.dialogflow.v2beta1.BatchUpdateEntityTypesResponse]

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

Parameters
Name Description
request BatchUpdateEntityTypesRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationBatchUpdateEntityTypesResponseStruct

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
BatchUpdateEntityTypesRequest request = new BatchUpdateEntityTypesRequest
{
    ParentAsAgentName = AgentName.FromProject("[PROJECT]"),
    EntityTypeBatchUri = "",
    LanguageCode = "",
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<BatchUpdateEntityTypesResponse, Struct> response = entityTypesClient.BatchUpdateEntityTypes(request);

// Poll until the returned long-running operation is complete
Operation<BatchUpdateEntityTypesResponse, Struct> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
BatchUpdateEntityTypesResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<BatchUpdateEntityTypesResponse, Struct> retrievedResponse = entityTypesClient.PollOnceBatchUpdateEntityTypes(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    BatchUpdateEntityTypesResponse retrievedResult = retrievedResponse.Result;
}

BatchUpdateEntityTypesAsync(BatchUpdateEntityTypesRequest, CallSettings)

public virtual Task<Operation<BatchUpdateEntityTypesResponse, Struct>> BatchUpdateEntityTypesAsync(BatchUpdateEntityTypesRequest request, CallSettings callSettings = null)

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][google.cloud.dialogflow.v2beta1.BatchUpdateEntityTypesResponse]

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

Parameters
Name Description
request BatchUpdateEntityTypesRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationBatchUpdateEntityTypesResponseStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
BatchUpdateEntityTypesRequest request = new BatchUpdateEntityTypesRequest
{
    ParentAsAgentName = AgentName.FromProject("[PROJECT]"),
    EntityTypeBatchUri = "",
    LanguageCode = "",
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<BatchUpdateEntityTypesResponse, Struct> response = await entityTypesClient.BatchUpdateEntityTypesAsync(request);

// Poll until the returned long-running operation is complete
Operation<BatchUpdateEntityTypesResponse, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
BatchUpdateEntityTypesResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<BatchUpdateEntityTypesResponse, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchUpdateEntityTypesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    BatchUpdateEntityTypesResponse retrievedResult = retrievedResponse.Result;
}

BatchUpdateEntityTypesAsync(BatchUpdateEntityTypesRequest, CancellationToken)

public virtual Task<Operation<BatchUpdateEntityTypesResponse, Struct>> BatchUpdateEntityTypesAsync(BatchUpdateEntityTypesRequest request, CancellationToken cancellationToken)

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][google.cloud.dialogflow.v2beta1.BatchUpdateEntityTypesResponse]

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

Parameters
Name Description
request BatchUpdateEntityTypesRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskOperationBatchUpdateEntityTypesResponseStruct

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
BatchUpdateEntityTypesRequest request = new BatchUpdateEntityTypesRequest
{
    ParentAsAgentName = AgentName.FromProject("[PROJECT]"),
    EntityTypeBatchUri = "",
    LanguageCode = "",
    UpdateMask = new FieldMask(),
};
// Make the request
Operation<BatchUpdateEntityTypesResponse, Struct> response = await entityTypesClient.BatchUpdateEntityTypesAsync(request);

// Poll until the returned long-running operation is complete
Operation<BatchUpdateEntityTypesResponse, Struct> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
BatchUpdateEntityTypesResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<BatchUpdateEntityTypesResponse, Struct> retrievedResponse = await entityTypesClient.PollOnceBatchUpdateEntityTypesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    BatchUpdateEntityTypesResponse retrievedResult = retrievedResponse.Result;
}

Create()

public static EntityTypesClient Create()

Synchronously creates a EntityTypesClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use EntityTypesClientBuilder.

Returns
Type Description
EntityTypesClient

The created EntityTypesClient.

CreateAsync(CancellationToken)

public static Task<EntityTypesClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a EntityTypesClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use EntityTypesClientBuilder.

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskEntityTypesClient

The task representing the created EntityTypesClient.

CreateEntityType(AgentName, EntityType, CallSettings)

public virtual EntityType CreateEntityType(AgentName parent, EntityType entityType, CallSettings callSettings = null)

Creates an entity type in the specified agent.

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

Parameters
Name Description
parent AgentName

Required. The agent to create a entity type for. Supported formats:

  • projects/<Project ID>/agent
  • projects/<Project ID>/locations/<Location ID>/agent
entityType EntityType

Required. The entity type to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EntityType

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
AgentName parent = AgentName.FromProject("[PROJECT]");
EntityType entityType = new EntityType();
// Make the request
EntityType response = entityTypesClient.CreateEntityType(parent, entityType);

CreateEntityType(AgentName, EntityType, string, CallSettings)

public virtual EntityType CreateEntityType(AgentName parent, EntityType entityType, string languageCode, CallSettings callSettings = null)

Creates an entity type in the specified agent.

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

Parameters
Name Description
parent AgentName

Required. The agent to create a entity type for. Supported formats:

  • projects/<Project ID>/agent
  • projects/<Project ID>/locations/<Location 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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EntityType

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
AgentName parent = AgentName.FromProject("[PROJECT]");
EntityType entityType = new EntityType();
string languageCode = "";
// Make the request
EntityType response = entityTypesClient.CreateEntityType(parent, entityType, languageCode);

CreateEntityType(CreateEntityTypeRequest, CallSettings)

public virtual EntityType CreateEntityType(CreateEntityTypeRequest request, CallSettings callSettings = null)

Creates an entity type in the specified agent.

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

Parameters
Name Description
request CreateEntityTypeRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EntityType

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
CreateEntityTypeRequest request = new CreateEntityTypeRequest
{
    ParentAsAgentName = AgentName.FromProject("[PROJECT]"),
    EntityType = new EntityType(),
    LanguageCode = "",
};
// Make the request
EntityType response = entityTypesClient.CreateEntityType(request);

CreateEntityType(string, EntityType, CallSettings)

public virtual EntityType CreateEntityType(string parent, EntityType entityType, CallSettings callSettings = null)

Creates an entity type in the specified agent.

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

Parameters
Name Description
parent string

Required. The agent to create a entity type for. Supported formats:

  • projects/<Project ID>/agent
  • projects/<Project ID>/locations/<Location ID>/agent
entityType EntityType

Required. The entity type to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EntityType

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/agent";
EntityType entityType = new EntityType();
// Make the request
EntityType response = entityTypesClient.CreateEntityType(parent, entityType);

CreateEntityType(string, EntityType, string, CallSettings)

public virtual EntityType CreateEntityType(string parent, EntityType entityType, string languageCode, CallSettings callSettings = null)

Creates an entity type in the specified agent.

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

Parameters
Name Description
parent string

Required. The agent to create a entity type for. Supported formats:

  • projects/<Project ID>/agent
  • projects/<Project ID>/locations/<Location 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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EntityType

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/agent";
EntityType entityType = new EntityType();
string languageCode = "";
// Make the request
EntityType response = entityTypesClient.CreateEntityType(parent, entityType, languageCode);

CreateEntityTypeAsync(AgentName, EntityType, CallSettings)

public virtual Task<EntityType> CreateEntityTypeAsync(AgentName parent, EntityType entityType, CallSettings callSettings = null)

Creates an entity type in the specified agent.

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

Parameters
Name Description
parent AgentName

Required. The agent to create a entity type for. Supported formats:

  • projects/<Project ID>/agent
  • projects/<Project ID>/locations/<Location ID>/agent
entityType EntityType

Required. The entity type to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEntityType

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
AgentName parent = AgentName.FromProject("[PROJECT]");
EntityType entityType = new EntityType();
// Make the request
EntityType response = await entityTypesClient.CreateEntityTypeAsync(parent, entityType);

CreateEntityTypeAsync(AgentName, EntityType, string, CallSettings)

public virtual Task<EntityType> CreateEntityTypeAsync(AgentName parent, EntityType entityType, string languageCode, CallSettings callSettings = null)

Creates an entity type in the specified agent.

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

Parameters
Name Description
parent AgentName

Required. The agent to create a entity type for. Supported formats:

  • projects/<Project ID>/agent
  • projects/<Project ID>/locations/<Location 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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEntityType

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
AgentName parent = AgentName.FromProject("[PROJECT]");
EntityType entityType = new EntityType();
string languageCode = "";
// Make the request
EntityType response = await entityTypesClient.CreateEntityTypeAsync(parent, entityType, languageCode);

CreateEntityTypeAsync(AgentName, EntityType, string, CancellationToken)

public virtual Task<EntityType> CreateEntityTypeAsync(AgentName parent, EntityType entityType, string languageCode, CancellationToken cancellationToken)

Creates an entity type in the specified agent.

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

Parameters
Name Description
parent AgentName

Required. The agent to create a entity type for. Supported formats:

  • projects/<Project ID>/agent
  • projects/<Project ID>/locations/<Location 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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEntityType

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
AgentName parent = AgentName.FromProject("[PROJECT]");
EntityType entityType = new EntityType();
string languageCode = "";
// Make the request
EntityType response = await entityTypesClient.CreateEntityTypeAsync(parent, entityType, languageCode);

CreateEntityTypeAsync(AgentName, EntityType, CancellationToken)

public virtual Task<EntityType> CreateEntityTypeAsync(AgentName parent, EntityType entityType, CancellationToken cancellationToken)

Creates an entity type in the specified agent.

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

Parameters
Name Description
parent AgentName

Required. The agent to create a entity type for. Supported formats:

  • projects/<Project ID>/agent
  • projects/<Project ID>/locations/<Location ID>/agent
entityType EntityType

Required. The entity type to create.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEntityType

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
AgentName parent = AgentName.FromProject("[PROJECT]");
EntityType entityType = new EntityType();
// Make the request
EntityType response = await entityTypesClient.CreateEntityTypeAsync(parent, entityType);

CreateEntityTypeAsync(CreateEntityTypeRequest, CallSettings)

public virtual Task<EntityType> CreateEntityTypeAsync(CreateEntityTypeRequest request, CallSettings callSettings = null)

Creates an entity type in the specified agent.

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

Parameters
Name Description
request CreateEntityTypeRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEntityType

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
CreateEntityTypeRequest request = new CreateEntityTypeRequest
{
    ParentAsAgentName = AgentName.FromProject("[PROJECT]"),
    EntityType = new EntityType(),
    LanguageCode = "",
};
// Make the request
EntityType response = await entityTypesClient.CreateEntityTypeAsync(request);

CreateEntityTypeAsync(CreateEntityTypeRequest, CancellationToken)

public virtual Task<EntityType> CreateEntityTypeAsync(CreateEntityTypeRequest request, CancellationToken cancellationToken)

Creates an entity type in the specified agent.

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

Parameters
Name Description
request CreateEntityTypeRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEntityType

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
CreateEntityTypeRequest request = new CreateEntityTypeRequest
{
    ParentAsAgentName = AgentName.FromProject("[PROJECT]"),
    EntityType = new EntityType(),
    LanguageCode = "",
};
// Make the request
EntityType response = await entityTypesClient.CreateEntityTypeAsync(request);

CreateEntityTypeAsync(string, EntityType, CallSettings)

public virtual Task<EntityType> CreateEntityTypeAsync(string parent, EntityType entityType, CallSettings callSettings = null)

Creates an entity type in the specified agent.

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

Parameters
Name Description
parent string

Required. The agent to create a entity type for. Supported formats:

  • projects/<Project ID>/agent
  • projects/<Project ID>/locations/<Location ID>/agent
entityType EntityType

Required. The entity type to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEntityType

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/agent";
EntityType entityType = new EntityType();
// Make the request
EntityType response = await entityTypesClient.CreateEntityTypeAsync(parent, entityType);

CreateEntityTypeAsync(string, EntityType, string, CallSettings)

public virtual Task<EntityType> CreateEntityTypeAsync(string parent, EntityType entityType, string languageCode, CallSettings callSettings = null)

Creates an entity type in the specified agent.

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

Parameters
Name Description
parent string

Required. The agent to create a entity type for. Supported formats:

  • projects/<Project ID>/agent
  • projects/<Project ID>/locations/<Location 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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEntityType

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/agent";
EntityType entityType = new EntityType();
string languageCode = "";
// Make the request
EntityType response = await entityTypesClient.CreateEntityTypeAsync(parent, entityType, languageCode);

CreateEntityTypeAsync(string, EntityType, string, CancellationToken)

public virtual Task<EntityType> CreateEntityTypeAsync(string parent, EntityType entityType, string languageCode, CancellationToken cancellationToken)

Creates an entity type in the specified agent.

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

Parameters
Name Description
parent string

Required. The agent to create a entity type for. Supported formats:

  • projects/<Project ID>/agent
  • projects/<Project ID>/locations/<Location 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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEntityType

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/agent";
EntityType entityType = new EntityType();
string languageCode = "";
// Make the request
EntityType response = await entityTypesClient.CreateEntityTypeAsync(parent, entityType, languageCode);

CreateEntityTypeAsync(string, EntityType, CancellationToken)

public virtual Task<EntityType> CreateEntityTypeAsync(string parent, EntityType entityType, CancellationToken cancellationToken)

Creates an entity type in the specified agent.

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

Parameters
Name Description
parent string

Required. The agent to create a entity type for. Supported formats:

  • projects/<Project ID>/agent
  • projects/<Project ID>/locations/<Location ID>/agent
entityType EntityType

Required. The entity type to create.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEntityType

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/agent";
EntityType entityType = new EntityType();
// Make the request
EntityType response = await entityTypesClient.CreateEntityTypeAsync(parent, entityType);

DeleteEntityType(DeleteEntityTypeRequest, CallSettings)

public virtual void DeleteEntityType(DeleteEntityTypeRequest request, CallSettings callSettings = null)

Deletes the specified entity type.

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

Parameters
Name Description
request DeleteEntityTypeRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
DeleteEntityTypeRequest request = new DeleteEntityTypeRequest
{
    EntityTypeName = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]"),
};
// Make the request
entityTypesClient.DeleteEntityType(request);

DeleteEntityType(EntityTypeName, CallSettings)

public virtual void DeleteEntityType(EntityTypeName name, CallSettings callSettings = null)

Deletes the specified entity type.

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

Parameters
Name Description
name EntityTypeName

Required. The name of the entity type to delete. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
EntityTypeName name = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]");
// Make the request
entityTypesClient.DeleteEntityType(name);

DeleteEntityType(string, CallSettings)

public virtual void DeleteEntityType(string name, CallSettings callSettings = null)

Deletes the specified entity type.

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

Parameters
Name Description
name string

Required. The name of the entity type to delete. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/agent/entityTypes/[ENTITY_TYPE]";
// Make the request
entityTypesClient.DeleteEntityType(name);

DeleteEntityTypeAsync(DeleteEntityTypeRequest, CallSettings)

public virtual Task DeleteEntityTypeAsync(DeleteEntityTypeRequest request, CallSettings callSettings = null)

Deletes the specified entity type.

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

Parameters
Name Description
request DeleteEntityTypeRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
DeleteEntityTypeRequest request = new DeleteEntityTypeRequest
{
    EntityTypeName = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]"),
};
// Make the request
await entityTypesClient.DeleteEntityTypeAsync(request);

DeleteEntityTypeAsync(DeleteEntityTypeRequest, CancellationToken)

public virtual Task DeleteEntityTypeAsync(DeleteEntityTypeRequest request, CancellationToken cancellationToken)

Deletes the specified entity type.

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

Parameters
Name Description
request DeleteEntityTypeRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
DeleteEntityTypeRequest request = new DeleteEntityTypeRequest
{
    EntityTypeName = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]"),
};
// Make the request
await entityTypesClient.DeleteEntityTypeAsync(request);

DeleteEntityTypeAsync(EntityTypeName, CallSettings)

public virtual Task DeleteEntityTypeAsync(EntityTypeName name, CallSettings callSettings = null)

Deletes the specified entity type.

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

Parameters
Name Description
name EntityTypeName

Required. The name of the entity type to delete. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
EntityTypeName name = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]");
// Make the request
await entityTypesClient.DeleteEntityTypeAsync(name);

DeleteEntityTypeAsync(EntityTypeName, CancellationToken)

public virtual Task DeleteEntityTypeAsync(EntityTypeName name, CancellationToken cancellationToken)

Deletes the specified entity type.

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

Parameters
Name Description
name EntityTypeName

Required. The name of the entity type to delete. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
EntityTypeName name = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]");
// Make the request
await entityTypesClient.DeleteEntityTypeAsync(name);

DeleteEntityTypeAsync(string, CallSettings)

public virtual Task DeleteEntityTypeAsync(string name, CallSettings callSettings = null)

Deletes the specified entity type.

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

Parameters
Name Description
name string

Required. The name of the entity type to delete. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/agent/entityTypes/[ENTITY_TYPE]";
// Make the request
await entityTypesClient.DeleteEntityTypeAsync(name);

DeleteEntityTypeAsync(string, CancellationToken)

public virtual Task DeleteEntityTypeAsync(string name, CancellationToken cancellationToken)

Deletes the specified entity type.

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

Parameters
Name Description
name string

Required. The name of the entity type to delete. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/agent/entityTypes/[ENTITY_TYPE]";
// Make the request
await entityTypesClient.DeleteEntityTypeAsync(name);

GetEntityType(EntityTypeName, CallSettings)

public virtual EntityType GetEntityType(EntityTypeName name, CallSettings callSettings = null)

Retrieves the specified entity type.

Parameters
Name Description
name EntityTypeName

Required. The name of the entity type. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EntityType

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
EntityTypeName name = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]");
// Make the request
EntityType response = entityTypesClient.GetEntityType(name);

GetEntityType(EntityTypeName, string, CallSettings)

public virtual EntityType GetEntityType(EntityTypeName name, string languageCode, CallSettings callSettings = null)

Retrieves the specified entity type.

Parameters
Name Description
name EntityTypeName

Required. The name of the entity type. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type 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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EntityType

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
EntityTypeName name = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]");
string languageCode = "";
// Make the request
EntityType response = entityTypesClient.GetEntityType(name, languageCode);

GetEntityType(GetEntityTypeRequest, CallSettings)

public virtual EntityType GetEntityType(GetEntityTypeRequest request, CallSettings callSettings = null)

Retrieves the specified entity type.

Parameters
Name Description
request GetEntityTypeRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EntityType

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
GetEntityTypeRequest request = new GetEntityTypeRequest
{
    EntityTypeName = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]"),
    LanguageCode = "",
};
// Make the request
EntityType response = entityTypesClient.GetEntityType(request);

GetEntityType(string, CallSettings)

public virtual EntityType GetEntityType(string name, CallSettings callSettings = null)

Retrieves the specified entity type.

Parameters
Name Description
name string

Required. The name of the entity type. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EntityType

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/agent/entityTypes/[ENTITY_TYPE]";
// Make the request
EntityType response = entityTypesClient.GetEntityType(name);

GetEntityType(string, string, CallSettings)

public virtual EntityType GetEntityType(string name, string languageCode, CallSettings callSettings = null)

Retrieves the specified entity type.

Parameters
Name Description
name string

Required. The name of the entity type. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type 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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EntityType

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/agent/entityTypes/[ENTITY_TYPE]";
string languageCode = "";
// Make the request
EntityType response = entityTypesClient.GetEntityType(name, languageCode);

GetEntityTypeAsync(EntityTypeName, CallSettings)

public virtual Task<EntityType> GetEntityTypeAsync(EntityTypeName name, CallSettings callSettings = null)

Retrieves the specified entity type.

Parameters
Name Description
name EntityTypeName

Required. The name of the entity type. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEntityType

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
EntityTypeName name = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]");
// Make the request
EntityType response = await entityTypesClient.GetEntityTypeAsync(name);

GetEntityTypeAsync(EntityTypeName, string, CallSettings)

public virtual Task<EntityType> GetEntityTypeAsync(EntityTypeName name, string languageCode, CallSettings callSettings = null)

Retrieves the specified entity type.

Parameters
Name Description
name EntityTypeName

Required. The name of the entity type. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type 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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEntityType

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
EntityTypeName name = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]");
string languageCode = "";
// Make the request
EntityType response = await entityTypesClient.GetEntityTypeAsync(name, languageCode);

GetEntityTypeAsync(EntityTypeName, string, CancellationToken)

public virtual Task<EntityType> GetEntityTypeAsync(EntityTypeName name, string languageCode, CancellationToken cancellationToken)

Retrieves the specified entity type.

Parameters
Name Description
name EntityTypeName

Required. The name of the entity type. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type 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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEntityType

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
EntityTypeName name = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]");
string languageCode = "";
// Make the request
EntityType response = await entityTypesClient.GetEntityTypeAsync(name, languageCode);

GetEntityTypeAsync(EntityTypeName, CancellationToken)

public virtual Task<EntityType> GetEntityTypeAsync(EntityTypeName name, CancellationToken cancellationToken)

Retrieves the specified entity type.

Parameters
Name Description
name EntityTypeName

Required. The name of the entity type. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEntityType

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
EntityTypeName name = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]");
// Make the request
EntityType response = await entityTypesClient.GetEntityTypeAsync(name);

GetEntityTypeAsync(GetEntityTypeRequest, CallSettings)

public virtual Task<EntityType> GetEntityTypeAsync(GetEntityTypeRequest request, CallSettings callSettings = null)

Retrieves the specified entity type.

Parameters
Name Description
request GetEntityTypeRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEntityType

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
GetEntityTypeRequest request = new GetEntityTypeRequest
{
    EntityTypeName = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]"),
    LanguageCode = "",
};
// Make the request
EntityType response = await entityTypesClient.GetEntityTypeAsync(request);

GetEntityTypeAsync(GetEntityTypeRequest, CancellationToken)

public virtual Task<EntityType> GetEntityTypeAsync(GetEntityTypeRequest request, CancellationToken cancellationToken)

Retrieves the specified entity type.

Parameters
Name Description
request GetEntityTypeRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEntityType

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
GetEntityTypeRequest request = new GetEntityTypeRequest
{
    EntityTypeName = EntityTypeName.FromProjectEntityType("[PROJECT]", "[ENTITY_TYPE]"),
    LanguageCode = "",
};
// Make the request
EntityType response = await entityTypesClient.GetEntityTypeAsync(request);

GetEntityTypeAsync(string, CallSettings)

public virtual Task<EntityType> GetEntityTypeAsync(string name, CallSettings callSettings = null)

Retrieves the specified entity type.

Parameters
Name Description
name string

Required. The name of the entity type. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEntityType

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/agent/entityTypes/[ENTITY_TYPE]";
// Make the request
EntityType response = await entityTypesClient.GetEntityTypeAsync(name);

GetEntityTypeAsync(string, string, CallSettings)

public virtual Task<EntityType> GetEntityTypeAsync(string name, string languageCode, CallSettings callSettings = null)

Retrieves the specified entity type.

Parameters
Name Description
name string

Required. The name of the entity type. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type 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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEntityType

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/agent/entityTypes/[ENTITY_TYPE]";
string languageCode = "";
// Make the request
EntityType response = await entityTypesClient.GetEntityTypeAsync(name, languageCode);

GetEntityTypeAsync(string, string, CancellationToken)

public virtual Task<EntityType> GetEntityTypeAsync(string name, string languageCode, CancellationToken cancellationToken)

Retrieves the specified entity type.

Parameters
Name Description
name string

Required. The name of the entity type. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type 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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEntityType

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/agent/entityTypes/[ENTITY_TYPE]";
string languageCode = "";
// Make the request
EntityType response = await entityTypesClient.GetEntityTypeAsync(name, languageCode);

GetEntityTypeAsync(string, CancellationToken)

public virtual Task<EntityType> GetEntityTypeAsync(string name, CancellationToken cancellationToken)

Retrieves the specified entity type.

Parameters
Name Description
name string

Required. The name of the entity type. Supported formats:

  • projects/<Project ID>/agent/entityTypes/<Entity Type ID>
  • projects/<Project ID>/locations/<Location ID>/agent/entityTypes/<Entity Type ID>
cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEntityType

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/agent/entityTypes/[ENTITY_TYPE]";
// Make the request
EntityType response = await entityTypesClient.GetEntityTypeAsync(name);

ListEntityTypes(AgentName, string, int?, CallSettings)

public virtual PagedEnumerable<ListEntityTypesResponse, EntityType> ListEntityTypes(AgentName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent AgentName

Required. The agent to list all entity types from. Supported formats:

  • projects/<Project ID>/agent
  • projects/<Project ID>/locations/<Location ID>/agent
pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListEntityTypesResponseEntityType

A pageable sequence of EntityType resources.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
AgentName parent = AgentName.FromProject("[PROJECT]");
// Make the request
PagedEnumerable<ListEntityTypesResponse, EntityType> response = entityTypesClient.ListEntityTypes(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (EntityType item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListEntityTypesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (EntityType item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<EntityType> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (EntityType item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListEntityTypes(AgentName, string, string, int?, CallSettings)

public virtual PagedEnumerable<ListEntityTypesResponse, EntityType> ListEntityTypes(AgentName parent, string languageCode, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent AgentName

Required. The agent to list all entity types from. Supported formats:

  • projects/<Project ID>/agent
  • projects/<Project ID>/locations/<Location 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.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListEntityTypesResponseEntityType

A pageable sequence of EntityType resources.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
AgentName parent = AgentName.FromProject("[PROJECT]");
string languageCode = "";
// Make the request
PagedEnumerable<ListEntityTypesResponse, EntityType> response = entityTypesClient.ListEntityTypes(parent, languageCode: languageCode);

// Iterate over all response items, lazily performing RPCs as required
foreach (EntityType item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListEntityTypesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (EntityType item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<EntityType> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (EntityType item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListEntityTypes(ListEntityTypesRequest, CallSettings)

public virtual PagedEnumerable<ListEntityTypesResponse, EntityType> ListEntityTypes(ListEntityTypesRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListEntityTypesRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListEntityTypesResponseEntityType

A pageable sequence of EntityType resources.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
ListEntityTypesRequest request = new ListEntityTypesRequest
{
    ParentAsAgentName = AgentName.FromProject("[PROJECT]"),
    LanguageCode = "",
};
// Make the request
PagedEnumerable<ListEntityTypesResponse, EntityType> response = entityTypesClient.ListEntityTypes(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (EntityType item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListEntityTypesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (EntityType item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<EntityType> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (EntityType item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListEntityTypes(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListEntityTypesResponse, EntityType> ListEntityTypes(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

Required. The agent to list all entity types from. Supported formats:

  • projects/<Project ID>/agent
  • projects/<Project ID>/locations/<Location ID>/agent
pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListEntityTypesResponseEntityType

A pageable sequence of EntityType resources.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/agent";
// Make the request
PagedEnumerable<ListEntityTypesResponse, EntityType> response = entityTypesClient.ListEntityTypes(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (EntityType item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListEntityTypesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (EntityType item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<EntityType> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (EntityType item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListEntityTypes(string, string, string, int?, CallSettings)

public virtual PagedEnumerable<ListEntityTypesResponse, EntityType> ListEntityTypes(string parent, string languageCode, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

Required. The agent to list all entity types from. Supported formats:

  • projects/<Project ID>/agent
  • projects/<Project ID>/locations/<Location 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.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedEnumerableListEntityTypesResponseEntityType

A pageable sequence of EntityType resources.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/agent";
string languageCode = "";
// Make the request
PagedEnumerable<ListEntityTypesResponse, EntityType> response = entityTypesClient.ListEntityTypes(parent, languageCode: languageCode);

// Iterate over all response items, lazily performing RPCs as required
foreach (EntityType item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListEntityTypesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (EntityType item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<EntityType> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (EntityType item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListEntityTypesAsync(AgentName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListEntityTypesResponse, EntityType> ListEntityTypesAsync(AgentName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent AgentName

Required. The agent to list all entity types from. Supported formats:

  • projects/<Project ID>/agent
  • projects/<Project ID>/locations/<Location ID>/agent
pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListEntityTypesResponseEntityType

A pageable asynchronous sequence of EntityType resources.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
AgentName parent = AgentName.FromProject("[PROJECT]");
// Make the request
PagedAsyncEnumerable<ListEntityTypesResponse, EntityType> response = entityTypesClient.ListEntityTypesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((EntityType item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListEntityTypesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (EntityType item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<EntityType> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (EntityType item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListEntityTypesAsync(AgentName, string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListEntityTypesResponse, EntityType> ListEntityTypesAsync(AgentName parent, string languageCode, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent AgentName

Required. The agent to list all entity types from. Supported formats:

  • projects/<Project ID>/agent
  • projects/<Project ID>/locations/<Location 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.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListEntityTypesResponseEntityType

A pageable asynchronous sequence of EntityType resources.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
AgentName parent = AgentName.FromProject("[PROJECT]");
string languageCode = "";
// Make the request
PagedAsyncEnumerable<ListEntityTypesResponse, EntityType> response = entityTypesClient.ListEntityTypesAsync(parent, languageCode: languageCode);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((EntityType item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListEntityTypesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (EntityType item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<EntityType> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (EntityType item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListEntityTypesAsync(ListEntityTypesRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListEntityTypesResponse, EntityType> ListEntityTypesAsync(ListEntityTypesRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListEntityTypesRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListEntityTypesResponseEntityType

A pageable asynchronous sequence of EntityType resources.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
ListEntityTypesRequest request = new ListEntityTypesRequest
{
    ParentAsAgentName = AgentName.FromProject("[PROJECT]"),
    LanguageCode = "",
};
// Make the request
PagedAsyncEnumerable<ListEntityTypesResponse, EntityType> response = entityTypesClient.ListEntityTypesAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((EntityType item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListEntityTypesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (EntityType item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<EntityType> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (EntityType item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListEntityTypesAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListEntityTypesResponse, EntityType> ListEntityTypesAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

Required. The agent to list all entity types from. Supported formats:

  • projects/<Project ID>/agent
  • projects/<Project ID>/locations/<Location ID>/agent
pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListEntityTypesResponseEntityType

A pageable asynchronous sequence of EntityType resources.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/agent";
// Make the request
PagedAsyncEnumerable<ListEntityTypesResponse, EntityType> response = entityTypesClient.ListEntityTypesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((EntityType item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListEntityTypesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (EntityType item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<EntityType> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (EntityType item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListEntityTypesAsync(string, string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListEntityTypesResponse, EntityType> ListEntityTypesAsync(string parent, string languageCode, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

Required. The agent to list all entity types from. Supported formats:

  • projects/<Project ID>/agent
  • projects/<Project ID>/locations/<Location 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.

pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
PagedAsyncEnumerableListEntityTypesResponseEntityType

A pageable asynchronous sequence of EntityType resources.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/agent";
string languageCode = "";
// Make the request
PagedAsyncEnumerable<ListEntityTypesResponse, EntityType> response = entityTypesClient.ListEntityTypesAsync(parent, languageCode: languageCode);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((EntityType item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListEntityTypesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (EntityType item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<EntityType> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (EntityType item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

PollOnceBatchCreateEntities(string, CallSettings)

public virtual Operation<Empty, Struct> PollOnceBatchCreateEntities(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of BatchCreateEntities .

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyStruct

The result of polling the operation.

PollOnceBatchCreateEntitiesAsync(string, CallSettings)

public virtual Task<Operation<Empty, Struct>> PollOnceBatchCreateEntitiesAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of BatchCreateEntities.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyStruct

A task representing the result of polling the operation.

PollOnceBatchDeleteEntities(string, CallSettings)

public virtual Operation<Empty, Struct> PollOnceBatchDeleteEntities(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of BatchDeleteEntities .

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyStruct

The result of polling the operation.

PollOnceBatchDeleteEntitiesAsync(string, CallSettings)

public virtual Task<Operation<Empty, Struct>> PollOnceBatchDeleteEntitiesAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of BatchDeleteEntities.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyStruct

A task representing the result of polling the operation.

PollOnceBatchDeleteEntityTypes(string, CallSettings)

public virtual Operation<Empty, Struct> PollOnceBatchDeleteEntityTypes(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of BatchDeleteEntityTypes.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyStruct

The result of polling the operation.

PollOnceBatchDeleteEntityTypesAsync(string, CallSettings)

public virtual Task<Operation<Empty, Struct>> PollOnceBatchDeleteEntityTypesAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of BatchDeleteEntityTypes.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyStruct

A task representing the result of polling the operation.

PollOnceBatchUpdateEntities(string, CallSettings)

public virtual Operation<Empty, Struct> PollOnceBatchUpdateEntities(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of BatchUpdateEntities .

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationEmptyStruct

The result of polling the operation.

PollOnceBatchUpdateEntitiesAsync(string, CallSettings)

public virtual Task<Operation<Empty, Struct>> PollOnceBatchUpdateEntitiesAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of BatchUpdateEntities.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationEmptyStruct

A task representing the result of polling the operation.

PollOnceBatchUpdateEntityTypes(string, CallSettings)

public virtual Operation<BatchUpdateEntityTypesResponse, Struct> PollOnceBatchUpdateEntityTypes(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of BatchUpdateEntityTypes.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
OperationBatchUpdateEntityTypesResponseStruct

The result of polling the operation.

PollOnceBatchUpdateEntityTypesAsync(string, CallSettings)

public virtual Task<Operation<BatchUpdateEntityTypesResponse, Struct>> PollOnceBatchUpdateEntityTypesAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of BatchUpdateEntityTypes.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskOperationBatchUpdateEntityTypesResponseStruct

A task representing the result of polling the operation.

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type Description
Task

A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UpdateEntityType(EntityType, CallSettings)

public virtual EntityType UpdateEntityType(EntityType entityType, CallSettings callSettings = null)

Updates the specified entity type.

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

Parameters
Name Description
entityType EntityType

Required. The entity type to update.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EntityType

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
EntityType entityType = new EntityType();
// Make the request
EntityType response = entityTypesClient.UpdateEntityType(entityType);

UpdateEntityType(EntityType, string, CallSettings)

public virtual EntityType UpdateEntityType(EntityType entityType, string languageCode, CallSettings callSettings = null)

Updates the specified entity type.

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

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EntityType

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
EntityType entityType = new EntityType();
string languageCode = "";
// Make the request
EntityType response = entityTypesClient.UpdateEntityType(entityType, languageCode);

UpdateEntityType(EntityType, string, FieldMask, CallSettings)

public virtual EntityType UpdateEntityType(EntityType entityType, string languageCode, FieldMask updateMask, CallSettings callSettings = null)

Updates the specified entity type.

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

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.

updateMask FieldMask

Optional. The mask to control which fields get updated.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EntityType

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
EntityType entityType = new EntityType();
string languageCode = "";
FieldMask updateMask = new FieldMask();
// Make the request
EntityType response = entityTypesClient.UpdateEntityType(entityType, languageCode, updateMask);

UpdateEntityType(UpdateEntityTypeRequest, CallSettings)

public virtual EntityType UpdateEntityType(UpdateEntityTypeRequest request, CallSettings callSettings = null)

Updates the specified entity type.

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

Parameters
Name Description
request UpdateEntityTypeRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
EntityType

The RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
UpdateEntityTypeRequest request = new UpdateEntityTypeRequest
{
    EntityType = new EntityType(),
    LanguageCode = "",
    UpdateMask = new FieldMask(),
};
// Make the request
EntityType response = entityTypesClient.UpdateEntityType(request);

UpdateEntityTypeAsync(EntityType, CallSettings)

public virtual Task<EntityType> UpdateEntityTypeAsync(EntityType entityType, CallSettings callSettings = null)

Updates the specified entity type.

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

Parameters
Name Description
entityType EntityType

Required. The entity type to update.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEntityType

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
EntityType entityType = new EntityType();
// Make the request
EntityType response = await entityTypesClient.UpdateEntityTypeAsync(entityType);

UpdateEntityTypeAsync(EntityType, string, CallSettings)

public virtual Task<EntityType> UpdateEntityTypeAsync(EntityType entityType, string languageCode, CallSettings callSettings = null)

Updates the specified entity type.

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

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.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEntityType

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
EntityType entityType = new EntityType();
string languageCode = "";
// Make the request
EntityType response = await entityTypesClient.UpdateEntityTypeAsync(entityType, languageCode);

UpdateEntityTypeAsync(EntityType, string, FieldMask, CallSettings)

public virtual Task<EntityType> UpdateEntityTypeAsync(EntityType entityType, string languageCode, FieldMask updateMask, CallSettings callSettings = null)

Updates the specified entity type.

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

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.

updateMask FieldMask

Optional. The mask to control which fields get updated.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEntityType

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
EntityType entityType = new EntityType();
string languageCode = "";
FieldMask updateMask = new FieldMask();
// Make the request
EntityType response = await entityTypesClient.UpdateEntityTypeAsync(entityType, languageCode, updateMask);

UpdateEntityTypeAsync(EntityType, string, FieldMask, CancellationToken)

public virtual Task<EntityType> UpdateEntityTypeAsync(EntityType entityType, string languageCode, FieldMask updateMask, CancellationToken cancellationToken)

Updates the specified entity type.

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

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.

updateMask FieldMask

Optional. The mask to control which fields get updated.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEntityType

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
EntityType entityType = new EntityType();
string languageCode = "";
FieldMask updateMask = new FieldMask();
// Make the request
EntityType response = await entityTypesClient.UpdateEntityTypeAsync(entityType, languageCode, updateMask);

UpdateEntityTypeAsync(EntityType, string, CancellationToken)

public virtual Task<EntityType> UpdateEntityTypeAsync(EntityType entityType, string languageCode, CancellationToken cancellationToken)

Updates the specified entity type.

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

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.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEntityType

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
EntityType entityType = new EntityType();
string languageCode = "";
// Make the request
EntityType response = await entityTypesClient.UpdateEntityTypeAsync(entityType, languageCode);

UpdateEntityTypeAsync(EntityType, CancellationToken)

public virtual Task<EntityType> UpdateEntityTypeAsync(EntityType entityType, CancellationToken cancellationToken)

Updates the specified entity type.

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

Parameters
Name Description
entityType EntityType

Required. The entity type to update.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEntityType

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
EntityType entityType = new EntityType();
// Make the request
EntityType response = await entityTypesClient.UpdateEntityTypeAsync(entityType);

UpdateEntityTypeAsync(UpdateEntityTypeRequest, CallSettings)

public virtual Task<EntityType> UpdateEntityTypeAsync(UpdateEntityTypeRequest request, CallSettings callSettings = null)

Updates the specified entity type.

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

Parameters
Name Description
request UpdateEntityTypeRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskEntityType

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
UpdateEntityTypeRequest request = new UpdateEntityTypeRequest
{
    EntityType = new EntityType(),
    LanguageCode = "",
    UpdateMask = new FieldMask(),
};
// Make the request
EntityType response = await entityTypesClient.UpdateEntityTypeAsync(request);

UpdateEntityTypeAsync(UpdateEntityTypeRequest, CancellationToken)

public virtual Task<EntityType> UpdateEntityTypeAsync(UpdateEntityTypeRequest request, CancellationToken cancellationToken)

Updates the specified entity type.

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

Parameters
Name Description
request UpdateEntityTypeRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskEntityType

A Task containing the RPC response.

Example
// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
UpdateEntityTypeRequest request = new UpdateEntityTypeRequest
{
    EntityType = new EntityType(),
    LanguageCode = "",
    UpdateMask = new FieldMask(),
};
// Make the request
EntityType response = await entityTypesClient.UpdateEntityTypeAsync(request);