Class EntityTypesClient (1.1.0)

Version 1.1.0

• 2.21.0 (latest)
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public abstract class EntityTypesClient

EntityTypes client wrapper, for convenient use.

Inheritance

Object > EntityTypesClient

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Derived Types

EntityTypesClientImpl

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Remarks

Service for managing [EntityTypes][google.cloud.dialogflow.cx.v3.EntityType].

Properties

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
IReadOnlyList<String>

Remarks

The default EntityTypes scopes are:

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/dialogflow

GrpcClient

public virtual EntityTypes.EntityTypesClient GrpcClient { get; }

The underlying gRPC EntityTypes client

Property Value
Type	Description
EntityTypes.EntityTypesClient

Methods

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

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

Parameters
Name	Description
parent	AgentName Required. The agent to create a entity type for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
entityType	EntityType Required. The entity type to create.
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.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]");
EntityType entityType = new EntityType();
// Make the request
EntityType response = entityTypesClient.CreateEntityType(parent, entityType);

CreateEntityType(CreateEntityTypeRequest, CallSettings)

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

Creates an entity type in the specified agent.

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.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
    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.

Parameters
Name	Description
parent	String Required. The agent to create a entity type for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
entityType	EntityType Required. The entity type to create.
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]/locations/[LOCATION]/agents/[AGENT]";
EntityType entityType = new EntityType();
// Make the request
EntityType response = entityTypesClient.CreateEntityType(parent, entityType);

CreateEntityTypeAsync(AgentName, EntityType, CallSettings)

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

Creates an entity type in the specified agent.

Parameters
Name	Description
parent	AgentName Required. The agent to create a entity type for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
entityType	EntityType Required. The entity type to create.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<EntityType>	A Task containing the RPC response.

Example

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

CreateEntityTypeAsync(AgentName, EntityType, CancellationToken)

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

Creates an entity type in the specified agent.

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

Returns
Type	Description
Task<EntityType>	A Task containing the RPC response.

Example

// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
AgentName parent = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]");
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.

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
Task<EntityType>	A Task containing the RPC response.

Example

// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
CreateEntityTypeRequest request = new CreateEntityTypeRequest
{
    ParentAsAgentName = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
    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.

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
Task<EntityType>	A Task containing the RPC response.

Example

// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
CreateEntityTypeRequest request = new CreateEntityTypeRequest
{
    ParentAsAgentName = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
    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.

Parameters
Name	Description
parent	String Required. The agent to create a entity type for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
entityType	EntityType Required. The entity type to create.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<EntityType>	A Task containing the RPC response.

Example

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

CreateEntityTypeAsync(String, EntityType, CancellationToken)

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

Creates an entity type in the specified agent.

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

Returns
Type	Description
Task<EntityType>	A Task containing the RPC response.

Example

// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[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.

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.FromProjectLocationAgentEntityType("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENTITY_TYPE]"),
    Force = false,
};
// Make the request
entityTypesClient.DeleteEntityType(request);

DeleteEntityType(EntityTypeName, CallSettings)

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

Deletes the specified entity type.

Parameters
Name	Description
name	EntityTypeName Required. The name of the entity type to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.
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.FromProjectLocationAgentEntityType("[PROJECT]", "[LOCATION]", "[AGENT]", "[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.

Parameters
Name	Description
name	String Required. The name of the entity type to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.
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]/locations/[LOCATION]/agents/[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.

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.FromProjectLocationAgentEntityType("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENTITY_TYPE]"),
    Force = false,
};
// Make the request
await entityTypesClient.DeleteEntityTypeAsync(request);

DeleteEntityTypeAsync(DeleteEntityTypeRequest, CancellationToken)

public virtual Task DeleteEntityTypeAsync(DeleteEntityTypeRequest request, CancellationToken cancellationToken)

Deletes the specified entity type.

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.FromProjectLocationAgentEntityType("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENTITY_TYPE]"),
    Force = false,
};
// Make the request
await entityTypesClient.DeleteEntityTypeAsync(request);

DeleteEntityTypeAsync(EntityTypeName, CallSettings)

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

Deletes the specified entity type.

Parameters
Name	Description
name	EntityTypeName Required. The name of the entity type to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.
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.FromProjectLocationAgentEntityType("[PROJECT]", "[LOCATION]", "[AGENT]", "[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.

Parameters
Name	Description
name	EntityTypeName Required. The name of the entity type to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.
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.FromProjectLocationAgentEntityType("[PROJECT]", "[LOCATION]", "[AGENT]", "[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.

Parameters
Name	Description
name	String Required. The name of the entity type to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.
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]/locations/[LOCATION]/agents/[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.

Parameters
Name	Description
name	String Required. The name of the entity type to delete. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.
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]/locations/[LOCATION]/agents/[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. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/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.FromProjectLocationAgentEntityType("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENTITY_TYPE]");
// Make the request
EntityType response = entityTypesClient.GetEntityType(name);

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.FromProjectLocationAgentEntityType("[PROJECT]", "[LOCATION]", "[AGENT]", "[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. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/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]/locations/[LOCATION]/agents/[AGENT]/entityTypes/[ENTITY_TYPE]";
// Make the request
EntityType response = entityTypesClient.GetEntityType(name);

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. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<EntityType>	A Task containing the RPC response.

Example

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

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. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
Task<EntityType>	A Task containing the RPC response.

Example

// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
EntityTypeName name = EntityTypeName.FromProjectLocationAgentEntityType("[PROJECT]", "[LOCATION]", "[AGENT]", "[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
Task<EntityType>	A Task containing the RPC response.

Example

// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
GetEntityTypeRequest request = new GetEntityTypeRequest
{
    EntityTypeName = EntityTypeName.FromProjectLocationAgentEntityType("[PROJECT]", "[LOCATION]", "[AGENT]", "[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
Task<EntityType>	A Task containing the RPC response.

Example

// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
GetEntityTypeRequest request = new GetEntityTypeRequest
{
    EntityTypeName = EntityTypeName.FromProjectLocationAgentEntityType("[PROJECT]", "[LOCATION]", "[AGENT]", "[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. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<EntityType>	A Task containing the RPC response.

Example

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

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. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/entityTypes/<Entity Type ID>.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
Task<EntityType>	A Task containing the RPC response.

Example

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

ListEntityTypes(AgentName, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListEntityTypesResponse, EntityType> ListEntityTypes(AgentName parent, string pageToken = null, int? pageSize = default(int? ), 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 for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
pageToken	String The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	Nullable<Int32> 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
PagedEnumerable<ListEntityTypesResponse, EntityType>	A pageable sequence of EntityType resources.

Example

// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
AgentName parent = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[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(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
PagedEnumerable<ListEntityTypesResponse, EntityType>	A pageable sequence of EntityType resources.

Example

// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
ListEntityTypesRequest request = new ListEntityTypesRequest
{
    ParentAsAgentName = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
    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, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListEntityTypesResponse, EntityType> ListEntityTypes(string parent, string pageToken = null, int? pageSize = default(int? ), 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 for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
pageToken	String The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	Nullable<Int32> 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
PagedEnumerable<ListEntityTypesResponse, EntityType>	A pageable sequence of EntityType resources.

Example

// Create client
EntityTypesClient entityTypesClient = EntityTypesClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[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;

ListEntityTypesAsync(AgentName, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListEntityTypesResponse, EntityType> ListEntityTypesAsync(AgentName parent, string pageToken = null, int? pageSize = default(int? ), 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 for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
pageToken	String The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	Nullable<Int32> 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
PagedAsyncEnumerable<ListEntityTypesResponse, EntityType>	A pageable asynchronous sequence of EntityType resources.

Example

// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
AgentName parent = AgentName.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[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(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
PagedAsyncEnumerable<ListEntityTypesResponse, EntityType>	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.FromProjectLocationAgent("[PROJECT]", "[LOCATION]", "[AGENT]"),
    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, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListEntityTypesResponse, EntityType> ListEntityTypesAsync(string parent, string pageToken = null, int? pageSize = default(int? ), 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 for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
pageToken	String The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	Nullable<Int32> 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
PagedAsyncEnumerable<ListEntityTypesResponse, EntityType>	A pageable asynchronous sequence of EntityType resources.

Example

// Create client
EntityTypesClient entityTypesClient = await EntityTypesClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/agents/[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;

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, FieldMask, CallSettings)

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

Updates the specified entity type.

Parameters
Name	Description
entityType	EntityType Required. The entity type to update.
updateMask	FieldMask 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();
FieldMask updateMask = new FieldMask();
// Make the request
EntityType response = entityTypesClient.UpdateEntityType(entityType, updateMask);

UpdateEntityType(UpdateEntityTypeRequest, CallSettings)

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

Updates the specified entity type.

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, FieldMask, CallSettings)

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

Updates the specified entity type.

Parameters
Name	Description
entityType	EntityType Required. The entity type to update.
updateMask	FieldMask The mask to control which fields get updated.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<EntityType>	A Task containing the RPC response.

Example

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

UpdateEntityTypeAsync(EntityType, FieldMask, CancellationToken)

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

Updates the specified entity type.

Parameters
Name	Description
entityType	EntityType Required. The entity type to update.
updateMask	FieldMask The mask to control which fields get updated.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
Task<EntityType>	A Task containing the RPC response.

Example

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

UpdateEntityTypeAsync(UpdateEntityTypeRequest, CallSettings)

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

Updates the specified entity type.

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

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
Task<EntityType>	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);