Transcoder v1 API - Class TranscoderService.TranscoderServiceClient (2.4.0)

public class TranscoderService.TranscoderServiceClient : ClientBase<TranscoderService.TranscoderServiceClient>

Reference documentation and code samples for the Transcoder v1 API class TranscoderService.TranscoderServiceClient.

Client for TranscoderService

Inheritance

object > ClientBase > ClientBaseTranscoderServiceTranscoderServiceClient > TranscoderService.TranscoderServiceClient

Namespace

GoogleGoogle.CloudGoogle.Cloud.VideoGoogle.Cloud.Video.TranscoderV1

Assembly

Google.Cloud.Video.Transcoder.V1.dll

Constructors

TranscoderServiceClient()

protected TranscoderServiceClient()

Protected parameterless constructor to allow creation of test doubles.

TranscoderServiceClient(CallInvoker)

public TranscoderServiceClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

TranscoderServiceClient(ChannelBase)

public TranscoderServiceClient(ChannelBase channel)

Creates a new client for TranscoderService

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

TranscoderServiceClient(ClientBaseConfiguration)

protected TranscoderServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateJob(CreateJobRequest, CallOptions)

public virtual Job CreateJob(CreateJobRequest request, CallOptions options)

Creates a job in the specified region.

Parameters
NameDescription
requestCreateJobRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Job

The response received from the server.

CreateJob(CreateJobRequest, Metadata, DateTime?, CancellationToken)

public virtual Job CreateJob(CreateJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a job in the specified region.

Parameters
NameDescription
requestCreateJobRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Job

The response received from the server.

CreateJobAsync(CreateJobRequest, CallOptions)

public virtual AsyncUnaryCall<Job> CreateJobAsync(CreateJobRequest request, CallOptions options)

Creates a job in the specified region.

Parameters
NameDescription
requestCreateJobRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallJob

The call object.

CreateJobAsync(CreateJobRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Job> CreateJobAsync(CreateJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a job in the specified region.

Parameters
NameDescription
requestCreateJobRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallJob

The call object.

CreateJobTemplate(CreateJobTemplateRequest, CallOptions)

public virtual JobTemplate CreateJobTemplate(CreateJobTemplateRequest request, CallOptions options)

Creates a job template in the specified region.

Parameters
NameDescription
requestCreateJobTemplateRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
JobTemplate

The response received from the server.

CreateJobTemplate(CreateJobTemplateRequest, Metadata, DateTime?, CancellationToken)

public virtual JobTemplate CreateJobTemplate(CreateJobTemplateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a job template in the specified region.

Parameters
NameDescription
requestCreateJobTemplateRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
JobTemplate

The response received from the server.

CreateJobTemplateAsync(CreateJobTemplateRequest, CallOptions)

public virtual AsyncUnaryCall<JobTemplate> CreateJobTemplateAsync(CreateJobTemplateRequest request, CallOptions options)

Creates a job template in the specified region.

Parameters
NameDescription
requestCreateJobTemplateRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallJobTemplate

The call object.

CreateJobTemplateAsync(CreateJobTemplateRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<JobTemplate> CreateJobTemplateAsync(CreateJobTemplateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a job template in the specified region.

Parameters
NameDescription
requestCreateJobTemplateRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallJobTemplate

The call object.

DeleteJob(DeleteJobRequest, CallOptions)

public virtual Empty DeleteJob(DeleteJobRequest request, CallOptions options)

Deletes a job.

Parameters
NameDescription
requestDeleteJobRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteJob(DeleteJobRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a job.

Parameters
NameDescription
requestDeleteJobRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteJobAsync(DeleteJobRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteJobAsync(DeleteJobRequest request, CallOptions options)

Deletes a job.

Parameters
NameDescription
requestDeleteJobRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallEmpty

The call object.

DeleteJobAsync(DeleteJobRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a job.

Parameters
NameDescription
requestDeleteJobRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallEmpty

The call object.

DeleteJobTemplate(DeleteJobTemplateRequest, CallOptions)

public virtual Empty DeleteJobTemplate(DeleteJobTemplateRequest request, CallOptions options)

Deletes a job template.

Parameters
NameDescription
requestDeleteJobTemplateRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteJobTemplate(DeleteJobTemplateRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a job template.

Parameters
NameDescription
requestDeleteJobTemplateRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteJobTemplateAsync(DeleteJobTemplateRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteJobTemplateAsync(DeleteJobTemplateRequest request, CallOptions options)

Deletes a job template.

Parameters
NameDescription
requestDeleteJobTemplateRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallEmpty

The call object.

DeleteJobTemplateAsync(DeleteJobTemplateRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a job template.

Parameters
NameDescription
requestDeleteJobTemplateRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallEmpty

The call object.

GetJob(GetJobRequest, CallOptions)

public virtual Job GetJob(GetJobRequest request, CallOptions options)

Returns the job data.

Parameters
NameDescription
requestGetJobRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Job

The response received from the server.

GetJob(GetJobRequest, Metadata, DateTime?, CancellationToken)

public virtual Job GetJob(GetJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the job data.

Parameters
NameDescription
requestGetJobRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Job

The response received from the server.

GetJobAsync(GetJobRequest, CallOptions)

public virtual AsyncUnaryCall<Job> GetJobAsync(GetJobRequest request, CallOptions options)

Returns the job data.

Parameters
NameDescription
requestGetJobRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallJob

The call object.

GetJobAsync(GetJobRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Job> GetJobAsync(GetJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the job data.

Parameters
NameDescription
requestGetJobRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallJob

The call object.

GetJobTemplate(GetJobTemplateRequest, CallOptions)

public virtual JobTemplate GetJobTemplate(GetJobTemplateRequest request, CallOptions options)

Returns the job template data.

Parameters
NameDescription
requestGetJobTemplateRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
JobTemplate

The response received from the server.

GetJobTemplate(GetJobTemplateRequest, Metadata, DateTime?, CancellationToken)

public virtual JobTemplate GetJobTemplate(GetJobTemplateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the job template data.

Parameters
NameDescription
requestGetJobTemplateRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
JobTemplate

The response received from the server.

GetJobTemplateAsync(GetJobTemplateRequest, CallOptions)

public virtual AsyncUnaryCall<JobTemplate> GetJobTemplateAsync(GetJobTemplateRequest request, CallOptions options)

Returns the job template data.

Parameters
NameDescription
requestGetJobTemplateRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallJobTemplate

The call object.

GetJobTemplateAsync(GetJobTemplateRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<JobTemplate> GetJobTemplateAsync(GetJobTemplateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the job template data.

Parameters
NameDescription
requestGetJobTemplateRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallJobTemplate

The call object.

ListJobs(ListJobsRequest, CallOptions)

public virtual ListJobsResponse ListJobs(ListJobsRequest request, CallOptions options)

Lists jobs in the specified region.

Parameters
NameDescription
requestListJobsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListJobsResponse

The response received from the server.

ListJobs(ListJobsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListJobsResponse ListJobs(ListJobsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists jobs in the specified region.

Parameters
NameDescription
requestListJobsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListJobsResponse

The response received from the server.

ListJobsAsync(ListJobsRequest, CallOptions)

public virtual AsyncUnaryCall<ListJobsResponse> ListJobsAsync(ListJobsRequest request, CallOptions options)

Lists jobs in the specified region.

Parameters
NameDescription
requestListJobsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListJobsResponse

The call object.

ListJobsAsync(ListJobsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListJobsResponse> ListJobsAsync(ListJobsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists jobs in the specified region.

Parameters
NameDescription
requestListJobsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListJobsResponse

The call object.

ListJobTemplates(ListJobTemplatesRequest, CallOptions)

public virtual ListJobTemplatesResponse ListJobTemplates(ListJobTemplatesRequest request, CallOptions options)

Lists job templates in the specified region.

Parameters
NameDescription
requestListJobTemplatesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListJobTemplatesResponse

The response received from the server.

ListJobTemplates(ListJobTemplatesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListJobTemplatesResponse ListJobTemplates(ListJobTemplatesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists job templates in the specified region.

Parameters
NameDescription
requestListJobTemplatesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListJobTemplatesResponse

The response received from the server.

ListJobTemplatesAsync(ListJobTemplatesRequest, CallOptions)

public virtual AsyncUnaryCall<ListJobTemplatesResponse> ListJobTemplatesAsync(ListJobTemplatesRequest request, CallOptions options)

Lists job templates in the specified region.

Parameters
NameDescription
requestListJobTemplatesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListJobTemplatesResponse

The call object.

ListJobTemplatesAsync(ListJobTemplatesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListJobTemplatesResponse> ListJobTemplatesAsync(ListJobTemplatesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists job templates in the specified region.

Parameters
NameDescription
requestListJobTemplatesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListJobTemplatesResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override TranscoderService.TranscoderServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration
Returns
TypeDescription
TranscoderServiceTranscoderServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Video.Transcoder.V1.TranscoderService.TranscoderServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)