Transcoder v1 API - Class TranscoderService.TranscoderServiceClient (2.3.0)

Version 2.3.0

• 2.9.0 (latest)
• 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.0.0

public class TranscoderServiceClient : ClientBase<TranscoderService.TranscoderServiceClient>

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

Client for TranscoderService

Inheritance

Object > ClientBase > ClientBase<TranscoderService.TranscoderServiceClient> > TranscoderService.TranscoderServiceClient

Inherited Members

ClientBase<TranscoderService.TranscoderServiceClient>.WithHost(String)

ClientBase.CallInvoker

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Video.Transcoder.V1

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
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

TranscoderServiceClient(ChannelBase)

public TranscoderServiceClient(ChannelBase channel)

Creates a new client for TranscoderService

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

TranscoderServiceClient(ClientBase.ClientBaseConfiguration)

protected TranscoderServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBase.ClientBaseConfiguration The client configuration.

Methods

CreateJob(CreateJobRequest, CallOptions)

public virtual Job CreateJob(CreateJobRequest request, CallOptions options)

Creates a job in the specified region.

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

Returns
Type	Description
Job	The response received from the server.

CreateJob(CreateJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates a job in the specified region.

Parameters
Name	Description
request	CreateJobRequest 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
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
Name	Description
request	CreateJobRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<Job>	The call object.

CreateJobAsync(CreateJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates a job in the specified region.

Parameters
Name	Description
request	CreateJobRequest 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<Job>	The call object.

CreateJobTemplate(CreateJobTemplateRequest, CallOptions)

public virtual JobTemplate CreateJobTemplate(CreateJobTemplateRequest request, CallOptions options)

Creates a job template in the specified region.

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

Returns
Type	Description
JobTemplate	The response received from the server.

CreateJobTemplate(CreateJobTemplateRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates a job template in the specified region.

Parameters
Name	Description
request	CreateJobTemplateRequest 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
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
Name	Description
request	CreateJobTemplateRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<JobTemplate>	The call object.

CreateJobTemplateAsync(CreateJobTemplateRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Creates a job template in the specified region.

Parameters
Name	Description
request	CreateJobTemplateRequest 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<JobTemplate>	The call object.

DeleteJob(DeleteJobRequest, CallOptions)

public virtual Empty DeleteJob(DeleteJobRequest request, CallOptions options)

Deletes a job.

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

Returns
Type	Description
Empty	The response received from the server.

DeleteJob(DeleteJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a job.

Parameters
Name	Description
request	DeleteJobRequest 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.

DeleteJobAsync(DeleteJobRequest, CallOptions)

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

Deletes a job.

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

Returns
Type	Description
AsyncUnaryCall<Empty>	The call object.

DeleteJobAsync(DeleteJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a job.

Parameters
Name	Description
request	DeleteJobRequest 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.

DeleteJobTemplate(DeleteJobTemplateRequest, CallOptions)

public virtual Empty DeleteJobTemplate(DeleteJobTemplateRequest request, CallOptions options)

Deletes a job template.

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

Returns
Type	Description
Empty	The response received from the server.

DeleteJobTemplate(DeleteJobTemplateRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a job template.

Parameters
Name	Description
request	DeleteJobTemplateRequest 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.

DeleteJobTemplateAsync(DeleteJobTemplateRequest, CallOptions)

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

Deletes a job template.

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

Returns
Type	Description
AsyncUnaryCall<Empty>	The call object.

DeleteJobTemplateAsync(DeleteJobTemplateRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a job template.

Parameters
Name	Description
request	DeleteJobTemplateRequest 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.

GetJob(GetJobRequest, CallOptions)

public virtual Job GetJob(GetJobRequest request, CallOptions options)

Returns the job data.

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

Returns
Type	Description
Job	The response received from the server.

GetJob(GetJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Returns the job data.

Parameters
Name	Description
request	GetJobRequest 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
Job	The response received from the server.

GetJobAsync(GetJobRequest, CallOptions)

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

Returns the job data.

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

Returns
Type	Description
AsyncUnaryCall<Job>	The call object.

GetJobAsync(GetJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Returns the job data.

Parameters
Name	Description
request	GetJobRequest 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<Job>	The call object.

GetJobTemplate(GetJobTemplateRequest, CallOptions)

public virtual JobTemplate GetJobTemplate(GetJobTemplateRequest request, CallOptions options)

Returns the job template data.

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

Returns
Type	Description
JobTemplate	The response received from the server.

GetJobTemplate(GetJobTemplateRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Returns the job template data.

Parameters
Name	Description
request	GetJobTemplateRequest 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
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
Name	Description
request	GetJobTemplateRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<JobTemplate>	The call object.

GetJobTemplateAsync(GetJobTemplateRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Returns the job template data.

Parameters
Name	Description
request	GetJobTemplateRequest 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<JobTemplate>	The call object.

ListJobs(ListJobsRequest, CallOptions)

public virtual ListJobsResponse ListJobs(ListJobsRequest request, CallOptions options)

Lists jobs in the specified region.

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

Returns
Type	Description
ListJobsResponse	The response received from the server.

ListJobs(ListJobsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Lists jobs in the specified region.

Parameters
Name	Description
request	ListJobsRequest 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
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
Name	Description
request	ListJobsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<ListJobsResponse>	The call object.

ListJobsAsync(ListJobsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Lists jobs in the specified region.

Parameters
Name	Description
request	ListJobsRequest 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<ListJobsResponse>	The call object.

ListJobTemplates(ListJobTemplatesRequest, CallOptions)

public virtual ListJobTemplatesResponse ListJobTemplates(ListJobTemplatesRequest request, CallOptions options)

Lists job templates in the specified region.

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

Returns
Type	Description
ListJobTemplatesResponse	The response received from the server.

ListJobTemplates(ListJobTemplatesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Lists job templates in the specified region.

Parameters
Name	Description
request	ListJobTemplatesRequest 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
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
Name	Description
request	ListJobTemplatesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCall<ListJobTemplatesResponse>	The call object.

ListJobTemplatesAsync(ListJobTemplatesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Lists job templates in the specified region.

Parameters
Name	Description
request	ListJobTemplatesRequest 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<ListJobTemplatesResponse>	The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBase.ClientBaseConfiguration

Returns
Type	Description
TranscoderService.TranscoderServiceClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.Video.Transcoder.V1.TranscoderService.TranscoderServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)