Dataflow v1beta3 API - Class TemplatesServiceClientImpl (2.0.0-beta09) 

public sealed class TemplatesServiceClientImpl : TemplatesServiceClient

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

TemplatesService client wrapper implementation, for convenient use.

Inheritance

object > TemplatesServiceClient > TemplatesServiceClientImpl

Namespace

Google.Cloud.Dataflow.V1Beta3

Assembly

Google.Cloud.Dataflow.V1Beta3.dll

Remarks

Provides a method to create Cloud Dataflow jobs from templates.

Constructors

TemplatesServiceClientImpl(TemplatesServiceClient, TemplatesServiceSettings, ILogger)

public TemplatesServiceClientImpl(TemplatesService.TemplatesServiceClient grpcClient, TemplatesServiceSettings settings, ILogger logger)

Constructs a client wrapper for the TemplatesService service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient TemplatesServiceTemplatesServiceClient

The underlying gRPC client.
settings TemplatesServiceSettings

The base TemplatesServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override TemplatesService.TemplatesServiceClient GrpcClient { get; }

The underlying gRPC TemplatesService client

Property Value
Type Description
TemplatesServiceTemplatesServiceClient
Overrides

Methods

CreateJobFromTemplate(CreateJobFromTemplateRequest, CallSettings)

public override Job CreateJobFromTemplate(CreateJobFromTemplateRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Job

The RPC response.
Overrides

CreateJobFromTemplateAsync(CreateJobFromTemplateRequest, CallSettings)

public override Task<Job> CreateJobFromTemplateAsync(CreateJobFromTemplateRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskJob

A Task containing the RPC response.
Overrides

GetTemplate(GetTemplateRequest, CallSettings)

public override GetTemplateResponse GetTemplate(GetTemplateRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
GetTemplateResponse

The RPC response.
Overrides

GetTemplateAsync(GetTemplateRequest, CallSettings)

public override Task<GetTemplateResponse> GetTemplateAsync(GetTemplateRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskGetTemplateResponse

A Task containing the RPC response.
Overrides

LaunchTemplate(LaunchTemplateRequest, CallSettings)

public override LaunchTemplateResponse LaunchTemplate(LaunchTemplateRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
LaunchTemplateResponse

The RPC response.
Overrides

LaunchTemplateAsync(LaunchTemplateRequest, CallSettings)

public override Task<LaunchTemplateResponse> LaunchTemplateAsync(LaunchTemplateRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskLaunchTemplateResponse

A Task containing the RPC response.
Overrides