Dataflow v1beta3 API - Class TemplatesService.TemplatesServiceClient (2.0.0-beta09) 

public class TemplatesService.TemplatesServiceClient : ClientBase<TemplatesService.TemplatesServiceClient>

Reference documentation and code samples for the Dataflow v1beta3 API class TemplatesService.TemplatesServiceClient.

Client for TemplatesService

Inheritance

object > ClientBase > ClientBaseTemplatesServiceTemplatesServiceClient > TemplatesService.TemplatesServiceClient

Namespace

Google.Cloud.Dataflow.V1Beta3

Assembly

Google.Cloud.Dataflow.V1Beta3.dll

Constructors

TemplatesServiceClient()

protected TemplatesServiceClient()

Protected parameterless constructor to allow creation of test doubles.

TemplatesServiceClient(CallInvoker)

public TemplatesServiceClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

TemplatesServiceClient(ChannelBase)

public TemplatesServiceClient(ChannelBase channel)

Creates a new client for TemplatesService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

TemplatesServiceClient(ClientBaseConfiguration)

protected TemplatesServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateJobFromTemplate(CreateJobFromTemplateRequest, CallOptions)

public virtual Job CreateJobFromTemplate(CreateJobFromTemplateRequest request, CallOptions options)

Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API.

To create a job, we recommend using projects.locations.templates.create with a regional endpoint. Using projects.templates.create is not recommended, because your job will always start in us-central1.

Parameters
Name Description
request CreateJobFromTemplateRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Job

The response received from the server.

CreateJobFromTemplate(CreateJobFromTemplateRequest, Metadata, DateTime?, CancellationToken)

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

Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API.

To create a job, we recommend using projects.locations.templates.create with a regional endpoint. Using projects.templates.create is not recommended, because your job will always start in us-central1.

Parameters
Name Description
request CreateJobFromTemplateRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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.

CreateJobFromTemplateAsync(CreateJobFromTemplateRequest, CallOptions)

public virtual AsyncUnaryCall<Job> CreateJobFromTemplateAsync(CreateJobFromTemplateRequest request, CallOptions options)

Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API.

To create a job, we recommend using projects.locations.templates.create with a regional endpoint. Using projects.templates.create is not recommended, because your job will always start in us-central1.

Parameters
Name Description
request CreateJobFromTemplateRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallJob

The call object.

CreateJobFromTemplateAsync(CreateJobFromTemplateRequest, Metadata, DateTime?, CancellationToken)

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

Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API.

To create a job, we recommend using projects.locations.templates.create with a regional endpoint. Using projects.templates.create is not recommended, because your job will always start in us-central1.

Parameters
Name Description
request CreateJobFromTemplateRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AsyncUnaryCallJob

The call object.

GetTemplate(GetTemplateRequest, CallOptions)

public virtual GetTemplateResponse GetTemplate(GetTemplateRequest request, CallOptions options)

Get the template associated with a template.

To get the template, we recommend using projects.locations.templates.get with a regional endpoint. Using projects.templates.get is not recommended, because only templates that are running in us-central1 are retrieved.

Parameters
Name Description
request GetTemplateRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
GetTemplateResponse

The response received from the server.

GetTemplate(GetTemplateRequest, Metadata, DateTime?, CancellationToken)

public virtual GetTemplateResponse GetTemplate(GetTemplateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get the template associated with a template.

To get the template, we recommend using projects.locations.templates.get with a regional endpoint. Using projects.templates.get is not recommended, because only templates that are running in us-central1 are retrieved.

Parameters
Name Description
request GetTemplateRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
GetTemplateResponse

The response received from the server.

GetTemplateAsync(GetTemplateRequest, CallOptions)

public virtual AsyncUnaryCall<GetTemplateResponse> GetTemplateAsync(GetTemplateRequest request, CallOptions options)

Get the template associated with a template.

To get the template, we recommend using projects.locations.templates.get with a regional endpoint. Using projects.templates.get is not recommended, because only templates that are running in us-central1 are retrieved.

Parameters
Name Description
request GetTemplateRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallGetTemplateResponse

The call object.

GetTemplateAsync(GetTemplateRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<GetTemplateResponse> GetTemplateAsync(GetTemplateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get the template associated with a template.

To get the template, we recommend using projects.locations.templates.get with a regional endpoint. Using projects.templates.get is not recommended, because only templates that are running in us-central1 are retrieved.

Parameters
Name Description
request GetTemplateRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AsyncUnaryCallGetTemplateResponse

The call object.

LaunchTemplate(LaunchTemplateRequest, CallOptions)

public virtual LaunchTemplateResponse LaunchTemplate(LaunchTemplateRequest request, CallOptions options)

Launches a template.

To launch a template, we recommend using projects.locations.templates.launch with a regional endpoint. Using projects.templates.launch is not recommended, because jobs launched from the template will always start in us-central1.

Parameters
Name Description
request LaunchTemplateRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
LaunchTemplateResponse

The response received from the server.

LaunchTemplate(LaunchTemplateRequest, Metadata, DateTime?, CancellationToken)

public virtual LaunchTemplateResponse LaunchTemplate(LaunchTemplateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Launches a template.

To launch a template, we recommend using projects.locations.templates.launch with a regional endpoint. Using projects.templates.launch is not recommended, because jobs launched from the template will always start in us-central1.

Parameters
Name Description
request LaunchTemplateRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
LaunchTemplateResponse

The response received from the server.

LaunchTemplateAsync(LaunchTemplateRequest, CallOptions)

public virtual AsyncUnaryCall<LaunchTemplateResponse> LaunchTemplateAsync(LaunchTemplateRequest request, CallOptions options)

Launches a template.

To launch a template, we recommend using projects.locations.templates.launch with a regional endpoint. Using projects.templates.launch is not recommended, because jobs launched from the template will always start in us-central1.

Parameters
Name Description
request LaunchTemplateRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallLaunchTemplateResponse

The call object.

LaunchTemplateAsync(LaunchTemplateRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<LaunchTemplateResponse> LaunchTemplateAsync(LaunchTemplateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Launches a template.

To launch a template, we recommend using projects.locations.templates.launch with a regional endpoint. Using projects.templates.launch is not recommended, because jobs launched from the template will always start in us-central1.

Parameters
Name Description
request LaunchTemplateRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AsyncUnaryCallLaunchTemplateResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override TemplatesService.TemplatesServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
TemplatesServiceTemplatesServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Dataflow.V1Beta3.TemplatesService.TemplatesServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)