Dialogflow v3 API - Class EntityTypes.EntityTypesClient (2.19.0)

Version 2.19.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 class EntityTypes.EntityTypesClient : ClientBase<EntityTypes.EntityTypesClient>

Reference documentation and code samples for the Dialogflow v3 API class EntityTypes.EntityTypesClient.

Client for EntityTypes

Inheritance

object > ClientBase > ClientBaseEntityTypesEntityTypesClient > EntityTypes.EntityTypesClient

Inherited Members

ClientBase<EntityTypes.EntityTypesClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

EntityTypesClient()

protected EntityTypesClient()

Protected parameterless constructor to allow creation of test doubles.

EntityTypesClient(CallInvoker)

public EntityTypesClient(CallInvoker callInvoker)

Creates a new client for EntityTypes that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

EntityTypesClient(ChannelBase)

public EntityTypesClient(ChannelBase channel)

Creates a new client for EntityTypes

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

EntityTypesClient(ClientBaseConfiguration)

protected EntityTypesClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateEntityType(CreateEntityTypeRequest, CallOptions)

public virtual EntityType CreateEntityType(CreateEntityTypeRequest request, CallOptions options)

Creates an entity type in the specified agent.

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

Parameters
Name	Description
request	CreateEntityTypeRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
EntityType	The response received from the server.

CreateEntityType(CreateEntityTypeRequest, Metadata, DateTime?, CancellationToken)

public virtual EntityType CreateEntityType(CreateEntityTypeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an entity type in the specified agent.

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

Parameters
Name	Description
request	CreateEntityTypeRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
EntityType	The response received from the server.

CreateEntityTypeAsync(CreateEntityTypeRequest, CallOptions)

public virtual AsyncUnaryCall<EntityType> CreateEntityTypeAsync(CreateEntityTypeRequest request, CallOptions options)

Creates an entity type in the specified agent.

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

Parameters
Name	Description
request	CreateEntityTypeRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEntityType	The call object.

CreateEntityTypeAsync(CreateEntityTypeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<EntityType> CreateEntityTypeAsync(CreateEntityTypeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an entity type in the specified agent.

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

Parameters
Name	Description
request	CreateEntityTypeRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEntityType	The call object.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type	Description
LocationsLocationsClient	A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

DeleteEntityType(DeleteEntityTypeRequest, CallOptions)

public virtual Empty DeleteEntityType(DeleteEntityTypeRequest request, CallOptions options)

Deletes the specified entity type.

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

Parameters
Name	Description
request	DeleteEntityTypeRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteEntityType(DeleteEntityTypeRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteEntityType(DeleteEntityTypeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the specified entity type.

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

Parameters
Name	Description
request	DeleteEntityTypeRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteEntityTypeAsync(DeleteEntityTypeRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteEntityTypeAsync(DeleteEntityTypeRequest request, CallOptions options)

Deletes the specified entity type.

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

Parameters
Name	Description
request	DeleteEntityTypeRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteEntityTypeAsync(DeleteEntityTypeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteEntityTypeAsync(DeleteEntityTypeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the specified entity type.

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

Parameters
Name	Description
request	DeleteEntityTypeRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

ExportEntityTypes(ExportEntityTypesRequest, CallOptions)

public virtual Operation ExportEntityTypes(ExportEntityTypesRequest request, CallOptions options)

Exports the selected entity types.

Parameters
Name	Description
request	ExportEntityTypesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

ExportEntityTypes(ExportEntityTypesRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation ExportEntityTypes(ExportEntityTypesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Exports the selected entity types.

Parameters
Name	Description
request	ExportEntityTypesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

ExportEntityTypesAsync(ExportEntityTypesRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ExportEntityTypesAsync(ExportEntityTypesRequest request, CallOptions options)

Exports the selected entity types.

Parameters
Name	Description
request	ExportEntityTypesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

ExportEntityTypesAsync(ExportEntityTypesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> ExportEntityTypesAsync(ExportEntityTypesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Exports the selected entity types.

Parameters
Name	Description
request	ExportEntityTypesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

GetEntityType(GetEntityTypeRequest, CallOptions)

public virtual EntityType GetEntityType(GetEntityTypeRequest request, CallOptions options)

Retrieves the specified entity type.

Parameters
Name	Description
request	GetEntityTypeRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
EntityType	The response received from the server.

GetEntityType(GetEntityTypeRequest, Metadata, DateTime?, CancellationToken)

public virtual EntityType GetEntityType(GetEntityTypeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves the specified entity type.

Parameters
Name	Description
request	GetEntityTypeRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
EntityType	The response received from the server.

GetEntityTypeAsync(GetEntityTypeRequest, CallOptions)

public virtual AsyncUnaryCall<EntityType> GetEntityTypeAsync(GetEntityTypeRequest request, CallOptions options)

Retrieves the specified entity type.

Parameters
Name	Description
request	GetEntityTypeRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEntityType	The call object.

GetEntityTypeAsync(GetEntityTypeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<EntityType> GetEntityTypeAsync(GetEntityTypeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves the specified entity type.

Parameters
Name	Description
request	GetEntityTypeRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEntityType	The call object.

ImportEntityTypes(ImportEntityTypesRequest, CallOptions)

public virtual Operation ImportEntityTypes(ImportEntityTypesRequest request, CallOptions options)

Imports the specified entitytypes into the agent.

Parameters
Name	Description
request	ImportEntityTypesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

ImportEntityTypes(ImportEntityTypesRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation ImportEntityTypes(ImportEntityTypesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Imports the specified entitytypes into the agent.

Parameters
Name	Description
request	ImportEntityTypesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

ImportEntityTypesAsync(ImportEntityTypesRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ImportEntityTypesAsync(ImportEntityTypesRequest request, CallOptions options)

Imports the specified entitytypes into the agent.

Parameters
Name	Description
request	ImportEntityTypesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

ImportEntityTypesAsync(ImportEntityTypesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> ImportEntityTypesAsync(ImportEntityTypesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Imports the specified entitytypes into the agent.

Parameters
Name	Description
request	ImportEntityTypesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

ListEntityTypes(ListEntityTypesRequest, CallOptions)

public virtual ListEntityTypesResponse ListEntityTypes(ListEntityTypesRequest request, CallOptions options)

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

Parameters
Name	Description
request	ListEntityTypesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListEntityTypesResponse	The response received from the server.

ListEntityTypes(ListEntityTypesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListEntityTypesResponse ListEntityTypes(ListEntityTypesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ListEntityTypesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListEntityTypesResponse	The response received from the server.

ListEntityTypesAsync(ListEntityTypesRequest, CallOptions)

public virtual AsyncUnaryCall<ListEntityTypesResponse> ListEntityTypesAsync(ListEntityTypesRequest request, CallOptions options)

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

Parameters
Name	Description
request	ListEntityTypesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListEntityTypesResponse	The call object.

ListEntityTypesAsync(ListEntityTypesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListEntityTypesResponse> ListEntityTypesAsync(ListEntityTypesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ListEntityTypesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListEntityTypesResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override EntityTypes.EntityTypesClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
EntityTypesEntityTypesClient

Overrides

ClientBase<EntityTypes.EntityTypesClient>.NewInstance(ClientBase.ClientBaseConfiguration)

UpdateEntityType(UpdateEntityTypeRequest, CallOptions)

public virtual EntityType UpdateEntityType(UpdateEntityTypeRequest request, CallOptions options)

Updates the specified entity type.

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

Parameters
Name	Description
request	UpdateEntityTypeRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
EntityType	The response received from the server.

UpdateEntityType(UpdateEntityTypeRequest, Metadata, DateTime?, CancellationToken)

public virtual EntityType UpdateEntityType(UpdateEntityTypeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the specified entity type.

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

Parameters
Name	Description
request	UpdateEntityTypeRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
EntityType	The response received from the server.

UpdateEntityTypeAsync(UpdateEntityTypeRequest, CallOptions)

public virtual AsyncUnaryCall<EntityType> UpdateEntityTypeAsync(UpdateEntityTypeRequest request, CallOptions options)

Updates the specified entity type.

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

Parameters
Name	Description
request	UpdateEntityTypeRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEntityType	The call object.

UpdateEntityTypeAsync(UpdateEntityTypeRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<EntityType> UpdateEntityTypeAsync(UpdateEntityTypeRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the specified entity type.

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

Parameters
Name	Description
request	UpdateEntityTypeRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEntityType	The call object.