Dialogflow v3 API - Class Versions.VersionsClient (2.2.0)

Version 2.2.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 VersionsClient : ClientBase<Versions.VersionsClient>

Reference documentation and code samples for the Dialogflow v3 API class Versions.VersionsClient.

Client for Versions

Inheritance

Object > ClientBase > ClientBase<Versions.VersionsClient> > Versions.VersionsClient

Inherited Members

ClientBase<Versions.VersionsClient>.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

VersionsClient()

protected VersionsClient()

Protected parameterless constructor to allow creation of test doubles.

VersionsClient(CallInvoker)

public VersionsClient(CallInvoker callInvoker)

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

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

VersionsClient(ChannelBase)

public VersionsClient(ChannelBase channel)

Creates a new client for Versions

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

VersionsClient(ClientBase.ClientBaseConfiguration)

protected VersionsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBase.ClientBaseConfiguration The client configuration.

Methods

CompareVersions(CompareVersionsRequest, CallOptions)

public virtual CompareVersionsResponse CompareVersions(CompareVersionsRequest request, CallOptions options)

Compares the specified base version with target version.

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

Returns
Type	Description
CompareVersionsResponse	The response received from the server.

CompareVersions(CompareVersionsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual CompareVersionsResponse CompareVersions(CompareVersionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Compares the specified base version with target version.

Parameters
Name	Description
request	CompareVersionsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
CompareVersionsResponse	The response received from the server.

CompareVersionsAsync(CompareVersionsRequest, CallOptions)

public virtual AsyncUnaryCall<CompareVersionsResponse> CompareVersionsAsync(CompareVersionsRequest request, CallOptions options)

Compares the specified base version with target version.

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

Returns
Type	Description
AsyncUnaryCall<CompareVersionsResponse>	The call object.

CompareVersionsAsync(CompareVersionsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<CompareVersionsResponse> CompareVersionsAsync(CompareVersionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Compares the specified base version with target version.

Parameters
Name	Description
request	CompareVersionsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<CompareVersionsResponse>	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
Locations.LocationsClient	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
Operations.OperationsClient	A new Operations client for the same target as this client.

CreateVersion(CreateVersionRequest, CallOptions)

public virtual Operation CreateVersion(CreateVersionRequest request, CallOptions options)

Creates a [Version][google.cloud.dialogflow.cx.v3.Version] in the specified [Flow][google.cloud.dialogflow.cx.v3.Flow].

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

• metadata: [CreateVersionOperationMetadata][google.cloud.dialogflow.cx.v3.CreateVersionOperationMetadata]
• response: [Version][google.cloud.dialogflow.cx.v3.Version]

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

Returns
Type	Description
Operation	The response received from the server.

CreateVersion(CreateVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates a [Version][google.cloud.dialogflow.cx.v3.Version] in the specified [Flow][google.cloud.dialogflow.cx.v3.Flow].

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

• metadata: [CreateVersionOperationMetadata][google.cloud.dialogflow.cx.v3.CreateVersionOperationMetadata]
• response: [Version][google.cloud.dialogflow.cx.v3.Version]

Parameters
Name	Description
request	CreateVersionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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.

CreateVersionAsync(CreateVersionRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateVersionAsync(CreateVersionRequest request, CallOptions options)

Creates a [Version][google.cloud.dialogflow.cx.v3.Version] in the specified [Flow][google.cloud.dialogflow.cx.v3.Flow].

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

• metadata: [CreateVersionOperationMetadata][google.cloud.dialogflow.cx.v3.CreateVersionOperationMetadata]
• response: [Version][google.cloud.dialogflow.cx.v3.Version]

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

Returns
Type	Description
AsyncUnaryCall<Operation>	The call object.

CreateVersionAsync(CreateVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates a [Version][google.cloud.dialogflow.cx.v3.Version] in the specified [Flow][google.cloud.dialogflow.cx.v3.Flow].

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

• metadata: [CreateVersionOperationMetadata][google.cloud.dialogflow.cx.v3.CreateVersionOperationMetadata]
• response: [Version][google.cloud.dialogflow.cx.v3.Version]

Parameters
Name	Description
request	CreateVersionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<Operation>	The call object.

DeleteVersion(DeleteVersionRequest, CallOptions)

public virtual Empty DeleteVersion(DeleteVersionRequest request, CallOptions options)

Deletes the specified [Version][google.cloud.dialogflow.cx.v3.Version].

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

Returns
Type	Description
Empty	The response received from the server.

DeleteVersion(DeleteVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes the specified [Version][google.cloud.dialogflow.cx.v3.Version].

Parameters
Name	Description
request	DeleteVersionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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.

DeleteVersionAsync(DeleteVersionRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteVersionAsync(DeleteVersionRequest request, CallOptions options)

Deletes the specified [Version][google.cloud.dialogflow.cx.v3.Version].

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

Returns
Type	Description
AsyncUnaryCall<Empty>	The call object.

DeleteVersionAsync(DeleteVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes the specified [Version][google.cloud.dialogflow.cx.v3.Version].

Parameters
Name	Description
request	DeleteVersionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<Empty>	The call object.

GetVersion(GetVersionRequest, CallOptions)

public virtual Version GetVersion(GetVersionRequest request, CallOptions options)

Retrieves the specified [Version][google.cloud.dialogflow.cx.v3.Version].

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

Returns
Type	Description
Version	The response received from the server.

GetVersion(GetVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Version GetVersion(GetVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Retrieves the specified [Version][google.cloud.dialogflow.cx.v3.Version].

Parameters
Name	Description
request	GetVersionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
Version	The response received from the server.

GetVersionAsync(GetVersionRequest, CallOptions)

public virtual AsyncUnaryCall<Version> GetVersionAsync(GetVersionRequest request, CallOptions options)

Retrieves the specified [Version][google.cloud.dialogflow.cx.v3.Version].

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

Returns
Type	Description
AsyncUnaryCall<Version>	The call object.

GetVersionAsync(GetVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Version> GetVersionAsync(GetVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Retrieves the specified [Version][google.cloud.dialogflow.cx.v3.Version].

Parameters
Name	Description
request	GetVersionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<Version>	The call object.

ListVersions(ListVersionsRequest, CallOptions)

public virtual ListVersionsResponse ListVersions(ListVersionsRequest request, CallOptions options)

Returns the list of all versions in the specified [Flow][google.cloud.dialogflow.cx.v3.Flow].

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

Returns
Type	Description
ListVersionsResponse	The response received from the server.

ListVersions(ListVersionsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListVersionsResponse ListVersions(ListVersionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Returns the list of all versions in the specified [Flow][google.cloud.dialogflow.cx.v3.Flow].

Parameters
Name	Description
request	ListVersionsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
ListVersionsResponse	The response received from the server.

ListVersionsAsync(ListVersionsRequest, CallOptions)

public virtual AsyncUnaryCall<ListVersionsResponse> ListVersionsAsync(ListVersionsRequest request, CallOptions options)

Returns the list of all versions in the specified [Flow][google.cloud.dialogflow.cx.v3.Flow].

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

Returns
Type	Description
AsyncUnaryCall<ListVersionsResponse>	The call object.

ListVersionsAsync(ListVersionsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListVersionsResponse> ListVersionsAsync(ListVersionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Returns the list of all versions in the specified [Flow][google.cloud.dialogflow.cx.v3.Flow].

Parameters
Name	Description
request	ListVersionsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<ListVersionsResponse>	The call object.

LoadVersion(LoadVersionRequest, CallOptions)

public virtual Operation LoadVersion(LoadVersionRequest request, CallOptions options)

Loads resources in the specified version to the draft flow.

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

• metadata: An empty Struct message
• response: An Empty message

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

Returns
Type	Description
Operation	The response received from the server.

LoadVersion(LoadVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Loads resources in the specified version to the draft flow.

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

• metadata: An empty Struct message
• response: An Empty message

Parameters
Name	Description
request	LoadVersionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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.

LoadVersionAsync(LoadVersionRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> LoadVersionAsync(LoadVersionRequest request, CallOptions options)

Loads resources in the specified version to the draft flow.

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

• metadata: An empty Struct message
• response: An Empty message

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

Returns
Type	Description
AsyncUnaryCall<Operation>	The call object.

LoadVersionAsync(LoadVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Loads resources in the specified version to the draft flow.

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

• metadata: An empty Struct message
• response: An Empty message

Parameters
Name	Description
request	LoadVersionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<Operation>	The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override Versions.VersionsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBase.ClientBaseConfiguration

Returns
Type	Description
Versions.VersionsClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.Dialogflow.Cx.V3.Versions.VersionsClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateVersion(UpdateVersionRequest, CallOptions)

public virtual Version UpdateVersion(UpdateVersionRequest request, CallOptions options)

Updates the specified [Version][google.cloud.dialogflow.cx.v3.Version].

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

Returns
Type	Description
Version	The response received from the server.

UpdateVersion(UpdateVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Version UpdateVersion(UpdateVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Updates the specified [Version][google.cloud.dialogflow.cx.v3.Version].

Parameters
Name	Description
request	UpdateVersionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
Version	The response received from the server.

UpdateVersionAsync(UpdateVersionRequest, CallOptions)

public virtual AsyncUnaryCall<Version> UpdateVersionAsync(UpdateVersionRequest request, CallOptions options)

Updates the specified [Version][google.cloud.dialogflow.cx.v3.Version].

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

Returns
Type	Description
AsyncUnaryCall<Version>	The call object.

UpdateVersionAsync(UpdateVersionRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Version> UpdateVersionAsync(UpdateVersionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Updates the specified [Version][google.cloud.dialogflow.cx.v3.Version].

Parameters
Name	Description
request	UpdateVersionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	Nullable<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
AsyncUnaryCall<Version>	The call object.