Google Cloud Speech v1 API - Class Adaptation.AdaptationClient (3.8.0)

public class Adaptation.AdaptationClient : ClientBase<Adaptation.AdaptationClient>

Reference documentation and code samples for the Google Cloud Speech v1 API class Adaptation.AdaptationClient.

Client for Adaptation

Inheritance

object > ClientBase > ClientBaseAdaptationAdaptationClient > Adaptation.AdaptationClient

Namespace

Google.Cloud.Speech.V1

Assembly

Google.Cloud.Speech.V1.dll

Constructors

AdaptationClient()

protected AdaptationClient()

Protected parameterless constructor to allow creation of test doubles.

AdaptationClient(CallInvoker)

public AdaptationClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

AdaptationClient(ChannelBase)

public AdaptationClient(ChannelBase channel)

Creates a new client for Adaptation

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

AdaptationClient(ClientBaseConfiguration)

protected AdaptationClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateCustomClass(CreateCustomClassRequest, CallOptions)

public virtual CustomClass CreateCustomClass(CreateCustomClassRequest request, CallOptions options)

Create a custom class.

Parameters
Name Description
request CreateCustomClassRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
CustomClass

The response received from the server.

CreateCustomClass(CreateCustomClassRequest, Metadata, DateTime?, CancellationToken)

public virtual CustomClass CreateCustomClass(CreateCustomClassRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Create a custom class.

Parameters
Name Description
request CreateCustomClassRequest

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
CustomClass

The response received from the server.

CreateCustomClassAsync(CreateCustomClassRequest, CallOptions)

public virtual AsyncUnaryCall<CustomClass> CreateCustomClassAsync(CreateCustomClassRequest request, CallOptions options)

Create a custom class.

Parameters
Name Description
request CreateCustomClassRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallCustomClass

The call object.

CreateCustomClassAsync(CreateCustomClassRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<CustomClass> CreateCustomClassAsync(CreateCustomClassRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Create a custom class.

Parameters
Name Description
request CreateCustomClassRequest

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
AsyncUnaryCallCustomClass

The call object.

CreatePhraseSet(CreatePhraseSetRequest, CallOptions)

public virtual PhraseSet CreatePhraseSet(CreatePhraseSetRequest request, CallOptions options)

Create a set of phrase hints. Each item in the set can be a single word or a multi-word phrase. The items in the PhraseSet are favored by the recognition model when you send a call that includes the PhraseSet.

Parameters
Name Description
request CreatePhraseSetRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
PhraseSet

The response received from the server.

CreatePhraseSet(CreatePhraseSetRequest, Metadata, DateTime?, CancellationToken)

public virtual PhraseSet CreatePhraseSet(CreatePhraseSetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Create a set of phrase hints. Each item in the set can be a single word or a multi-word phrase. The items in the PhraseSet are favored by the recognition model when you send a call that includes the PhraseSet.

Parameters
Name Description
request CreatePhraseSetRequest

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
PhraseSet

The response received from the server.

CreatePhraseSetAsync(CreatePhraseSetRequest, CallOptions)

public virtual AsyncUnaryCall<PhraseSet> CreatePhraseSetAsync(CreatePhraseSetRequest request, CallOptions options)

Create a set of phrase hints. Each item in the set can be a single word or a multi-word phrase. The items in the PhraseSet are favored by the recognition model when you send a call that includes the PhraseSet.

Parameters
Name Description
request CreatePhraseSetRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallPhraseSet

The call object.

CreatePhraseSetAsync(CreatePhraseSetRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<PhraseSet> CreatePhraseSetAsync(CreatePhraseSetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Create a set of phrase hints. Each item in the set can be a single word or a multi-word phrase. The items in the PhraseSet are favored by the recognition model when you send a call that includes the PhraseSet.

Parameters
Name Description
request CreatePhraseSetRequest

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
AsyncUnaryCallPhraseSet

The call object.

DeleteCustomClass(DeleteCustomClassRequest, CallOptions)

public virtual Empty DeleteCustomClass(DeleteCustomClassRequest request, CallOptions options)

Delete a custom class.

Parameters
Name Description
request DeleteCustomClassRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Empty

The response received from the server.

DeleteCustomClass(DeleteCustomClassRequest, Metadata, DateTime?, CancellationToken)

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

Delete a custom class.

Parameters
Name Description
request DeleteCustomClassRequest

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.

DeleteCustomClassAsync(DeleteCustomClassRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteCustomClassAsync(DeleteCustomClassRequest request, CallOptions options)

Delete a custom class.

Parameters
Name Description
request DeleteCustomClassRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEmpty

The call object.

DeleteCustomClassAsync(DeleteCustomClassRequest, Metadata, DateTime?, CancellationToken)

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

Delete a custom class.

Parameters
Name Description
request DeleteCustomClassRequest

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.

DeletePhraseSet(DeletePhraseSetRequest, CallOptions)

public virtual Empty DeletePhraseSet(DeletePhraseSetRequest request, CallOptions options)

Delete a phrase set.

Parameters
Name Description
request DeletePhraseSetRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Empty

The response received from the server.

DeletePhraseSet(DeletePhraseSetRequest, Metadata, DateTime?, CancellationToken)

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

Delete a phrase set.

Parameters
Name Description
request DeletePhraseSetRequest

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.

DeletePhraseSetAsync(DeletePhraseSetRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeletePhraseSetAsync(DeletePhraseSetRequest request, CallOptions options)

Delete a phrase set.

Parameters
Name Description
request DeletePhraseSetRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEmpty

The call object.

DeletePhraseSetAsync(DeletePhraseSetRequest, Metadata, DateTime?, CancellationToken)

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

Delete a phrase set.

Parameters
Name Description
request DeletePhraseSetRequest

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.

GetCustomClass(GetCustomClassRequest, CallOptions)

public virtual CustomClass GetCustomClass(GetCustomClassRequest request, CallOptions options)

Get a custom class.

Parameters
Name Description
request GetCustomClassRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
CustomClass

The response received from the server.

GetCustomClass(GetCustomClassRequest, Metadata, DateTime?, CancellationToken)

public virtual CustomClass GetCustomClass(GetCustomClassRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get a custom class.

Parameters
Name Description
request GetCustomClassRequest

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
CustomClass

The response received from the server.

GetCustomClassAsync(GetCustomClassRequest, CallOptions)

public virtual AsyncUnaryCall<CustomClass> GetCustomClassAsync(GetCustomClassRequest request, CallOptions options)

Get a custom class.

Parameters
Name Description
request GetCustomClassRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallCustomClass

The call object.

GetCustomClassAsync(GetCustomClassRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<CustomClass> GetCustomClassAsync(GetCustomClassRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get a custom class.

Parameters
Name Description
request GetCustomClassRequest

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
AsyncUnaryCallCustomClass

The call object.

GetPhraseSet(GetPhraseSetRequest, CallOptions)

public virtual PhraseSet GetPhraseSet(GetPhraseSetRequest request, CallOptions options)

Get a phrase set.

Parameters
Name Description
request GetPhraseSetRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
PhraseSet

The response received from the server.

GetPhraseSet(GetPhraseSetRequest, Metadata, DateTime?, CancellationToken)

public virtual PhraseSet GetPhraseSet(GetPhraseSetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get a phrase set.

Parameters
Name Description
request GetPhraseSetRequest

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
PhraseSet

The response received from the server.

GetPhraseSetAsync(GetPhraseSetRequest, CallOptions)

public virtual AsyncUnaryCall<PhraseSet> GetPhraseSetAsync(GetPhraseSetRequest request, CallOptions options)

Get a phrase set.

Parameters
Name Description
request GetPhraseSetRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallPhraseSet

The call object.

GetPhraseSetAsync(GetPhraseSetRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<PhraseSet> GetPhraseSetAsync(GetPhraseSetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get a phrase set.

Parameters
Name Description
request GetPhraseSetRequest

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
AsyncUnaryCallPhraseSet

The call object.

ListCustomClasses(ListCustomClassesRequest, CallOptions)

public virtual ListCustomClassesResponse ListCustomClasses(ListCustomClassesRequest request, CallOptions options)

List custom classes.

Parameters
Name Description
request ListCustomClassesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListCustomClassesResponse

The response received from the server.

ListCustomClasses(ListCustomClassesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListCustomClassesResponse ListCustomClasses(ListCustomClassesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

List custom classes.

Parameters
Name Description
request ListCustomClassesRequest

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
ListCustomClassesResponse

The response received from the server.

ListCustomClassesAsync(ListCustomClassesRequest, CallOptions)

public virtual AsyncUnaryCall<ListCustomClassesResponse> ListCustomClassesAsync(ListCustomClassesRequest request, CallOptions options)

List custom classes.

Parameters
Name Description
request ListCustomClassesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListCustomClassesResponse

The call object.

ListCustomClassesAsync(ListCustomClassesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListCustomClassesResponse> ListCustomClassesAsync(ListCustomClassesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

List custom classes.

Parameters
Name Description
request ListCustomClassesRequest

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
AsyncUnaryCallListCustomClassesResponse

The call object.

ListPhraseSet(ListPhraseSetRequest, CallOptions)

public virtual ListPhraseSetResponse ListPhraseSet(ListPhraseSetRequest request, CallOptions options)

List phrase sets.

Parameters
Name Description
request ListPhraseSetRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListPhraseSetResponse

The response received from the server.

ListPhraseSet(ListPhraseSetRequest, Metadata, DateTime?, CancellationToken)

public virtual ListPhraseSetResponse ListPhraseSet(ListPhraseSetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

List phrase sets.

Parameters
Name Description
request ListPhraseSetRequest

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
ListPhraseSetResponse

The response received from the server.

ListPhraseSetAsync(ListPhraseSetRequest, CallOptions)

public virtual AsyncUnaryCall<ListPhraseSetResponse> ListPhraseSetAsync(ListPhraseSetRequest request, CallOptions options)

List phrase sets.

Parameters
Name Description
request ListPhraseSetRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListPhraseSetResponse

The call object.

ListPhraseSetAsync(ListPhraseSetRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListPhraseSetResponse> ListPhraseSetAsync(ListPhraseSetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

List phrase sets.

Parameters
Name Description
request ListPhraseSetRequest

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
AsyncUnaryCallListPhraseSetResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override Adaptation.AdaptationClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
AdaptationAdaptationClient
Overrides

UpdateCustomClass(UpdateCustomClassRequest, CallOptions)

public virtual CustomClass UpdateCustomClass(UpdateCustomClassRequest request, CallOptions options)

Update a custom class.

Parameters
Name Description
request UpdateCustomClassRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
CustomClass

The response received from the server.

UpdateCustomClass(UpdateCustomClassRequest, Metadata, DateTime?, CancellationToken)

public virtual CustomClass UpdateCustomClass(UpdateCustomClassRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Update a custom class.

Parameters
Name Description
request UpdateCustomClassRequest

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
CustomClass

The response received from the server.

UpdateCustomClassAsync(UpdateCustomClassRequest, CallOptions)

public virtual AsyncUnaryCall<CustomClass> UpdateCustomClassAsync(UpdateCustomClassRequest request, CallOptions options)

Update a custom class.

Parameters
Name Description
request UpdateCustomClassRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallCustomClass

The call object.

UpdateCustomClassAsync(UpdateCustomClassRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<CustomClass> UpdateCustomClassAsync(UpdateCustomClassRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Update a custom class.

Parameters
Name Description
request UpdateCustomClassRequest

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
AsyncUnaryCallCustomClass

The call object.

UpdatePhraseSet(UpdatePhraseSetRequest, CallOptions)

public virtual PhraseSet UpdatePhraseSet(UpdatePhraseSetRequest request, CallOptions options)

Update a phrase set.

Parameters
Name Description
request UpdatePhraseSetRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
PhraseSet

The response received from the server.

UpdatePhraseSet(UpdatePhraseSetRequest, Metadata, DateTime?, CancellationToken)

public virtual PhraseSet UpdatePhraseSet(UpdatePhraseSetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Update a phrase set.

Parameters
Name Description
request UpdatePhraseSetRequest

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
PhraseSet

The response received from the server.

UpdatePhraseSetAsync(UpdatePhraseSetRequest, CallOptions)

public virtual AsyncUnaryCall<PhraseSet> UpdatePhraseSetAsync(UpdatePhraseSetRequest request, CallOptions options)

Update a phrase set.

Parameters
Name Description
request UpdatePhraseSetRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallPhraseSet

The call object.

UpdatePhraseSetAsync(UpdatePhraseSetRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<PhraseSet> UpdatePhraseSetAsync(UpdatePhraseSetRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Update a phrase set.

Parameters
Name Description
request UpdatePhraseSetRequest

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
AsyncUnaryCallPhraseSet

The call object.