Class VersionsClient (1.0.0)

public abstract class VersionsClient

Versions client wrapper, for convenient use.

Inheritance

System.Object > VersionsClient

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Remarks

Service for managing [Versions][google.cloud.dialogflow.cx.v3.Version].

Properties

CreateVersionOperationsClient

public virtual OperationsClient CreateVersionOperationsClient { get; }

The long-running operations client for CreateVersion.

Property Value
Type Description
Google.LongRunning.OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type Description
System.String

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default Versions scopes.

Property Value
Type Description
System.Collections.Generic.IReadOnlyList<System.String>
Remarks

GrpcClient

public virtual Versions.VersionsClient GrpcClient { get; }

The underlying gRPC Versions client

Property Value
Type Description
Versions.VersionsClient

LoadVersionOperationsClient

public virtual OperationsClient LoadVersionOperationsClient { get; }

The long-running operations client for LoadVersion.

Property Value
Type Description
Google.LongRunning.OperationsClient

Methods

Create()

public static VersionsClient Create()

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

Returns
Type Description
VersionsClient

The created VersionsClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name Description
cancellationToken System.Threading.CancellationToken

The System.Threading.CancellationToken to use while creating the client.

Returns
Type Description
System.Threading.Tasks.Task<VersionsClient>

The task representing the created VersionsClient.

CreateVersion(CreateVersionRequest, CallSettings)

public virtual Operation<Version, CreateVersionOperationMetadata> CreateVersion(CreateVersionRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CreateVersionRequest

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

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Google.LongRunning.Operation<Version, CreateVersionOperationMetadata>

The RPC response.

CreateVersion(FlowName, Version, CallSettings)

public virtual Operation<Version, CreateVersionOperationMetadata> CreateVersion(FlowName parent, Version version, CallSettings callSettings = null)

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

Parameters
Name Description
parent FlowName

Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to create an [Version][google.cloud.dialogflow.cx.v3.Version] for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/flows/&amp;lt;Flow ID&amp;gt;.

version Version

Required. The version to create.

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Google.LongRunning.Operation<Version, CreateVersionOperationMetadata>

The RPC response.

CreateVersion(String, Version, CallSettings)

public virtual Operation<Version, CreateVersionOperationMetadata> CreateVersion(string parent, Version version, CallSettings callSettings = null)

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

Parameters
Name Description
parent System.String

Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to create an [Version][google.cloud.dialogflow.cx.v3.Version] for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/flows/&amp;lt;Flow ID&amp;gt;.

version Version

Required. The version to create.

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Google.LongRunning.Operation<Version, CreateVersionOperationMetadata>

The RPC response.

CreateVersionAsync(CreateVersionRequest, CallSettings)

public virtual Task<Operation<Version, CreateVersionOperationMetadata>> CreateVersionAsync(CreateVersionRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CreateVersionRequest

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

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<Version, CreateVersionOperationMetadata>>

A Task containing the RPC response.

CreateVersionAsync(CreateVersionRequest, CancellationToken)

public virtual Task<Operation<Version, CreateVersionOperationMetadata>> CreateVersionAsync(CreateVersionRequest request, CancellationToken cancellationToken)

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

Parameters
Name Description
request CreateVersionRequest

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

cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<Version, CreateVersionOperationMetadata>>

A Task containing the RPC response.

CreateVersionAsync(FlowName, Version, CallSettings)

public virtual Task<Operation<Version, CreateVersionOperationMetadata>> CreateVersionAsync(FlowName parent, Version version, CallSettings callSettings = null)

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

Parameters
Name Description
parent FlowName

Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to create an [Version][google.cloud.dialogflow.cx.v3.Version] for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/flows/&amp;lt;Flow ID&amp;gt;.

version Version

Required. The version to create.

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<Version, CreateVersionOperationMetadata>>

A Task containing the RPC response.

CreateVersionAsync(FlowName, Version, CancellationToken)

public virtual Task<Operation<Version, CreateVersionOperationMetadata>> CreateVersionAsync(FlowName parent, Version version, CancellationToken cancellationToken)

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

Parameters
Name Description
parent FlowName

Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to create an [Version][google.cloud.dialogflow.cx.v3.Version] for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/flows/&amp;lt;Flow ID&amp;gt;.

version Version

Required. The version to create.

cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<Version, CreateVersionOperationMetadata>>

A Task containing the RPC response.

CreateVersionAsync(String, Version, CallSettings)

public virtual Task<Operation<Version, CreateVersionOperationMetadata>> CreateVersionAsync(string parent, Version version, CallSettings callSettings = null)

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

Parameters
Name Description
parent System.String

Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to create an [Version][google.cloud.dialogflow.cx.v3.Version] for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/flows/&amp;lt;Flow ID&amp;gt;.

version Version

Required. The version to create.

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<Version, CreateVersionOperationMetadata>>

A Task containing the RPC response.

CreateVersionAsync(String, Version, CancellationToken)

public virtual Task<Operation<Version, CreateVersionOperationMetadata>> CreateVersionAsync(string parent, Version version, CancellationToken cancellationToken)

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

Parameters
Name Description
parent System.String

Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to create an [Version][google.cloud.dialogflow.cx.v3.Version] for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/flows/&amp;lt;Flow ID&amp;gt;.

version Version

Required. The version to create.

cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<Version, CreateVersionOperationMetadata>>

A Task containing the RPC response.

DeleteVersion(DeleteVersionRequest, CallSettings)

public virtual void DeleteVersion(DeleteVersionRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request DeleteVersionRequest

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

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

DeleteVersion(VersionName, CallSettings)

public virtual void DeleteVersion(VersionName name, CallSettings callSettings = null)

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

Parameters
Name Description
name VersionName

Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version] to delete. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/flows/&amp;lt;Flow ID&amp;gt;/versions/&amp;lt;Version ID&amp;gt;.

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

DeleteVersion(String, CallSettings)

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

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

Parameters
Name Description
name System.String

Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version] to delete. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/flows/&amp;lt;Flow ID&amp;gt;/versions/&amp;lt;Version ID&amp;gt;.

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

DeleteVersionAsync(DeleteVersionRequest, CallSettings)

public virtual Task DeleteVersionAsync(DeleteVersionRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request DeleteVersionRequest

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

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

DeleteVersionAsync(DeleteVersionRequest, CancellationToken)

public virtual Task DeleteVersionAsync(DeleteVersionRequest request, CancellationToken cancellationToken)

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

Parameters
Name Description
request DeleteVersionRequest

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

cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

DeleteVersionAsync(VersionName, CallSettings)

public virtual Task DeleteVersionAsync(VersionName name, CallSettings callSettings = null)

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

Parameters
Name Description
name VersionName

Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version] to delete. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/flows/&amp;lt;Flow ID&amp;gt;/versions/&amp;lt;Version ID&amp;gt;.

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

DeleteVersionAsync(VersionName, CancellationToken)

public virtual Task DeleteVersionAsync(VersionName name, CancellationToken cancellationToken)

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

Parameters
Name Description
name VersionName

Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version] to delete. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/flows/&amp;lt;Flow ID&amp;gt;/versions/&amp;lt;Version ID&amp;gt;.

cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

DeleteVersionAsync(String, CallSettings)

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

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

Parameters
Name Description
name System.String

Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version] to delete. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/flows/&amp;lt;Flow ID&amp;gt;/versions/&amp;lt;Version ID&amp;gt;.

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

DeleteVersionAsync(String, CancellationToken)

public virtual Task DeleteVersionAsync(string name, CancellationToken cancellationToken)

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

Parameters
Name Description
name System.String

Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version] to delete. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/flows/&amp;lt;Flow ID&amp;gt;/versions/&amp;lt;Version ID&amp;gt;.

cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task

A Task containing the RPC response.

GetVersion(GetVersionRequest, CallSettings)

public virtual Version GetVersion(GetVersionRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request GetVersionRequest

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

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Version

The RPC response.

GetVersion(VersionName, CallSettings)

public virtual Version GetVersion(VersionName name, CallSettings callSettings = null)

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

Parameters
Name Description
name VersionName

Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version]. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/flows/&amp;lt;Flow ID&amp;gt;/versions/&amp;lt;Version ID&amp;gt;.

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Version

The RPC response.

GetVersion(String, CallSettings)

public virtual Version GetVersion(string name, CallSettings callSettings = null)

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

Parameters
Name Description
name System.String

Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version]. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/flows/&amp;lt;Flow ID&amp;gt;/versions/&amp;lt;Version ID&amp;gt;.

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Version

The RPC response.

GetVersionAsync(GetVersionRequest, CallSettings)

public virtual Task<Version> GetVersionAsync(GetVersionRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request GetVersionRequest

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

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Version>

A Task containing the RPC response.

GetVersionAsync(GetVersionRequest, CancellationToken)

public virtual Task<Version> GetVersionAsync(GetVersionRequest request, CancellationToken cancellationToken)

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

Parameters
Name Description
request GetVersionRequest

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

cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Version>

A Task containing the RPC response.

GetVersionAsync(VersionName, CallSettings)

public virtual Task<Version> GetVersionAsync(VersionName name, CallSettings callSettings = null)

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

Parameters
Name Description
name VersionName

Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version]. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/flows/&amp;lt;Flow ID&amp;gt;/versions/&amp;lt;Version ID&amp;gt;.

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Version>

A Task containing the RPC response.

GetVersionAsync(VersionName, CancellationToken)

public virtual Task<Version> GetVersionAsync(VersionName name, CancellationToken cancellationToken)

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

Parameters
Name Description
name VersionName

Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version]. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/flows/&amp;lt;Flow ID&amp;gt;/versions/&amp;lt;Version ID&amp;gt;.

cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Version>

A Task containing the RPC response.

GetVersionAsync(String, CallSettings)

public virtual Task<Version> GetVersionAsync(string name, CallSettings callSettings = null)

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

Parameters
Name Description
name System.String

Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version]. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/flows/&amp;lt;Flow ID&amp;gt;/versions/&amp;lt;Version ID&amp;gt;.

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Version>

A Task containing the RPC response.

GetVersionAsync(String, CancellationToken)

public virtual Task<Version> GetVersionAsync(string name, CancellationToken cancellationToken)

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

Parameters
Name Description
name System.String

Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version]. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/flows/&amp;lt;Flow ID&amp;gt;/versions/&amp;lt;Version ID&amp;gt;.

cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Version>

A Task containing the RPC response.

ListVersions(FlowName, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListVersionsResponse, Version> ListVersions(FlowName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

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

Parameters
Name Description
parent FlowName

Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to list all versions for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/flows/&amp;lt;Flow ID&amp;gt;.

pageToken System.String

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

pageSize System.Nullable<System.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 Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Google.Api.Gax.PagedEnumerable<ListVersionsResponse, Version>

A pageable sequence of Version resources.

ListVersions(ListVersionsRequest, CallSettings)

public virtual PagedEnumerable<ListVersionsResponse, Version> ListVersions(ListVersionsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListVersionsRequest

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

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Google.Api.Gax.PagedEnumerable<ListVersionsResponse, Version>

A pageable sequence of Version resources.

ListVersions(String, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListVersionsResponse, Version> ListVersions(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

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

Parameters
Name Description
parent System.String

Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to list all versions for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/flows/&amp;lt;Flow ID&amp;gt;.

pageToken System.String

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

pageSize System.Nullable<System.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 Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Google.Api.Gax.PagedEnumerable<ListVersionsResponse, Version>

A pageable sequence of Version resources.

ListVersionsAsync(FlowName, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListVersionsResponse, Version> ListVersionsAsync(FlowName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

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

Parameters
Name Description
parent FlowName

Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to list all versions for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/flows/&amp;lt;Flow ID&amp;gt;.

pageToken System.String

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

pageSize System.Nullable<System.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 Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Google.Api.Gax.PagedAsyncEnumerable<ListVersionsResponse, Version>

A pageable asynchronous sequence of Version resources.

ListVersionsAsync(ListVersionsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListVersionsResponse, Version> ListVersionsAsync(ListVersionsRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListVersionsRequest

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

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Google.Api.Gax.PagedAsyncEnumerable<ListVersionsResponse, Version>

A pageable asynchronous sequence of Version resources.

ListVersionsAsync(String, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListVersionsResponse, Version> ListVersionsAsync(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

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

Parameters
Name Description
parent System.String

Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to list all versions for. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/flows/&amp;lt;Flow ID&amp;gt;.

pageToken System.String

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

pageSize System.Nullable<System.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 Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Google.Api.Gax.PagedAsyncEnumerable<ListVersionsResponse, Version>

A pageable asynchronous sequence of Version resources.

LoadVersion(LoadVersionRequest, CallSettings)

public virtual Operation<Empty, Struct> LoadVersion(LoadVersionRequest request, CallSettings callSettings = null)

Loads a specified version to draft version.

Parameters
Name Description
request LoadVersionRequest

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

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, Google.Protobuf.WellKnownTypes.Struct>

The RPC response.

LoadVersion(VersionName, CallSettings)

public virtual Operation<Empty, Struct> LoadVersion(VersionName name, CallSettings callSettings = null)

Loads a specified version to draft version.

Parameters
Name Description
name VersionName

Required. The [Version][google.cloud.dialogflow.cx.v3.Version] to be loaded to draft version. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/flows/&amp;lt;Flow ID&amp;gt;/versions/&amp;lt;Version ID&amp;gt;.

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, Google.Protobuf.WellKnownTypes.Struct>

The RPC response.

LoadVersion(String, CallSettings)

public virtual Operation<Empty, Struct> LoadVersion(string name, CallSettings callSettings = null)

Loads a specified version to draft version.

Parameters
Name Description
name System.String

Required. The [Version][google.cloud.dialogflow.cx.v3.Version] to be loaded to draft version. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/flows/&amp;lt;Flow ID&amp;gt;/versions/&amp;lt;Version ID&amp;gt;.

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, Google.Protobuf.WellKnownTypes.Struct>

The RPC response.

LoadVersionAsync(LoadVersionRequest, CallSettings)

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

Loads a specified version to draft version.

Parameters
Name Description
request LoadVersionRequest

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

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, Google.Protobuf.WellKnownTypes.Struct>>

A Task containing the RPC response.

LoadVersionAsync(LoadVersionRequest, CancellationToken)

public virtual Task<Operation<Empty, Struct>> LoadVersionAsync(LoadVersionRequest request, CancellationToken cancellationToken)

Loads a specified version to draft version.

Parameters
Name Description
request LoadVersionRequest

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

cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, Google.Protobuf.WellKnownTypes.Struct>>

A Task containing the RPC response.

LoadVersionAsync(VersionName, CallSettings)

public virtual Task<Operation<Empty, Struct>> LoadVersionAsync(VersionName name, CallSettings callSettings = null)

Loads a specified version to draft version.

Parameters
Name Description
name VersionName

Required. The [Version][google.cloud.dialogflow.cx.v3.Version] to be loaded to draft version. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/flows/&amp;lt;Flow ID&amp;gt;/versions/&amp;lt;Version ID&amp;gt;.

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, Google.Protobuf.WellKnownTypes.Struct>>

A Task containing the RPC response.

LoadVersionAsync(VersionName, CancellationToken)

public virtual Task<Operation<Empty, Struct>> LoadVersionAsync(VersionName name, CancellationToken cancellationToken)

Loads a specified version to draft version.

Parameters
Name Description
name VersionName

Required. The [Version][google.cloud.dialogflow.cx.v3.Version] to be loaded to draft version. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/flows/&amp;lt;Flow ID&amp;gt;/versions/&amp;lt;Version ID&amp;gt;.

cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, Google.Protobuf.WellKnownTypes.Struct>>

A Task containing the RPC response.

LoadVersionAsync(String, CallSettings)

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

Loads a specified version to draft version.

Parameters
Name Description
name System.String

Required. The [Version][google.cloud.dialogflow.cx.v3.Version] to be loaded to draft version. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/flows/&amp;lt;Flow ID&amp;gt;/versions/&amp;lt;Version ID&amp;gt;.

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, Google.Protobuf.WellKnownTypes.Struct>>

A Task containing the RPC response.

LoadVersionAsync(String, CancellationToken)

public virtual Task<Operation<Empty, Struct>> LoadVersionAsync(string name, CancellationToken cancellationToken)

Loads a specified version to draft version.

Parameters
Name Description
name System.String

Required. The [Version][google.cloud.dialogflow.cx.v3.Version] to be loaded to draft version. Format: projects/&amp;lt;Project ID&amp;gt;/locations/&amp;lt;Location ID&amp;gt;/agents/&amp;lt;Agent ID&amp;gt;/flows/&amp;lt;Flow ID&amp;gt;/versions/&amp;lt;Version ID&amp;gt;.

cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, Google.Protobuf.WellKnownTypes.Struct>>

A Task containing the RPC response.

PollOnceCreateVersion(String, CallSettings)

public virtual Operation<Version, CreateVersionOperationMetadata> PollOnceCreateVersion(string operationName, CallSettings callSettings = null)

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

Parameters
Name Description
operationName System.String

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

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Google.LongRunning.Operation<Version, CreateVersionOperationMetadata>

The result of polling the operation.

PollOnceCreateVersionAsync(String, CallSettings)

public virtual Task<Operation<Version, CreateVersionOperationMetadata>> PollOnceCreateVersionAsync(string operationName, CallSettings callSettings = null)

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

Parameters
Name Description
operationName System.String

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

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<Version, CreateVersionOperationMetadata>>

A task representing the result of polling the operation.

PollOnceLoadVersion(String, CallSettings)

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

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

Parameters
Name Description
operationName System.String

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

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, Google.Protobuf.WellKnownTypes.Struct>

The result of polling the operation.

PollOnceLoadVersionAsync(String, CallSettings)

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

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

Parameters
Name Description
operationName System.String

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

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Google.LongRunning.Operation<Google.Protobuf.WellKnownTypes.Empty, Google.Protobuf.WellKnownTypes.Struct>>

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
System.Threading.Tasks.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.

UpdateVersion(UpdateVersionRequest, CallSettings)

public virtual Version UpdateVersion(UpdateVersionRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request UpdateVersionRequest

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

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Version

The RPC response.

UpdateVersion(Version, FieldMask, CallSettings)

public virtual Version UpdateVersion(Version version, FieldMask updateMask, CallSettings callSettings = null)

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

Parameters
Name Description
version Version

Required. The version to update.

updateMask Google.Protobuf.WellKnownTypes.FieldMask

Required. The mask to control which fields get updated. Currently only description and display_name can be updated.

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Version

The RPC response.

UpdateVersionAsync(UpdateVersionRequest, CallSettings)

public virtual Task<Version> UpdateVersionAsync(UpdateVersionRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request UpdateVersionRequest

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

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Version>

A Task containing the RPC response.

UpdateVersionAsync(UpdateVersionRequest, CancellationToken)

public virtual Task<Version> UpdateVersionAsync(UpdateVersionRequest request, CancellationToken cancellationToken)

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

Parameters
Name Description
request UpdateVersionRequest

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

cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Version>

A Task containing the RPC response.

UpdateVersionAsync(Version, FieldMask, CallSettings)

public virtual Task<Version> UpdateVersionAsync(Version version, FieldMask updateMask, CallSettings callSettings = null)

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

Parameters
Name Description
version Version

Required. The version to update.

updateMask Google.Protobuf.WellKnownTypes.FieldMask

Required. The mask to control which fields get updated. Currently only description and display_name can be updated.

callSettings Google.Api.Gax.Grpc.CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
System.Threading.Tasks.Task<Version>

A Task containing the RPC response.

UpdateVersionAsync(Version, FieldMask, CancellationToken)

public virtual Task<Version> UpdateVersionAsync(Version version, FieldMask updateMask, CancellationToken cancellationToken)

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

Parameters
Name Description
version Version

Required. The version to update.

updateMask Google.Protobuf.WellKnownTypes.FieldMask

Required. The mask to control which fields get updated. Currently only description and display_name can be updated.

cancellationToken System.Threading.CancellationToken

A System.Threading.CancellationToken to use for this RPC.

Returns
Type Description
System.Threading.Tasks.Task<Version>

A Task containing the RPC response.