Dataflow v1beta3 API - Class FlexTemplatesServiceClient (2.0.0-beta09) 

public abstract class FlexTemplatesServiceClient

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

FlexTemplatesService client wrapper, for convenient use.

Inheritance

object > FlexTemplatesServiceClient

Namespace

Google.Cloud.Dataflow.V1Beta3

Assembly

Google.Cloud.Dataflow.V1Beta3.dll

Remarks

Provides a service for Flex templates.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the FlexTemplatesService service, which is a host of "dataflow.googleapis.com" and a port of 443.

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default FlexTemplatesService scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default FlexTemplatesService scopes are:

GrpcClient

public virtual FlexTemplatesService.FlexTemplatesServiceClient GrpcClient { get; }

The underlying gRPC FlexTemplatesService client

Property Value
Type Description
FlexTemplatesServiceFlexTemplatesServiceClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

Methods

Create()

public static FlexTemplatesServiceClient Create()

Synchronously creates a FlexTemplatesServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use FlexTemplatesServiceClientBuilder.

Returns
Type Description
FlexTemplatesServiceClient

The created FlexTemplatesServiceClient.

CreateAsync(CancellationToken)

public static Task<FlexTemplatesServiceClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a FlexTemplatesServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use FlexTemplatesServiceClientBuilder.

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.
Returns
Type Description
TaskFlexTemplatesServiceClient

The task representing the created FlexTemplatesServiceClient.

LaunchFlexTemplate(LaunchFlexTemplateRequest, CallSettings)

public virtual LaunchFlexTemplateResponse LaunchFlexTemplate(LaunchFlexTemplateRequest request, CallSettings callSettings = null)

Launch a job with a FlexTemplate.

Parameters
Name Description
request LaunchFlexTemplateRequest

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
LaunchFlexTemplateResponse

The RPC response.
Example 
// Create client
FlexTemplatesServiceClient flexTemplatesServiceClient = FlexTemplatesServiceClient.Create();
// Initialize request argument(s)
LaunchFlexTemplateRequest request = new LaunchFlexTemplateRequest
{
    ProjectId = "",
    LaunchParameter = new LaunchFlexTemplateParameter(),
    Location = "",
    ValidateOnly = false,
};
// Make the request
LaunchFlexTemplateResponse response = flexTemplatesServiceClient.LaunchFlexTemplate(request);

LaunchFlexTemplateAsync(LaunchFlexTemplateRequest, CallSettings)

public virtual Task<LaunchFlexTemplateResponse> LaunchFlexTemplateAsync(LaunchFlexTemplateRequest request, CallSettings callSettings = null)

Launch a job with a FlexTemplate.

Parameters
Name Description
request LaunchFlexTemplateRequest

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
TaskLaunchFlexTemplateResponse

A Task containing the RPC response.
Example 
// Create client
FlexTemplatesServiceClient flexTemplatesServiceClient = await FlexTemplatesServiceClient.CreateAsync();
// Initialize request argument(s)
LaunchFlexTemplateRequest request = new LaunchFlexTemplateRequest
{
    ProjectId = "",
    LaunchParameter = new LaunchFlexTemplateParameter(),
    Location = "",
    ValidateOnly = false,
};
// Make the request
LaunchFlexTemplateResponse response = await flexTemplatesServiceClient.LaunchFlexTemplateAsync(request);

LaunchFlexTemplateAsync(LaunchFlexTemplateRequest, CancellationToken)

public virtual Task<LaunchFlexTemplateResponse> LaunchFlexTemplateAsync(LaunchFlexTemplateRequest request, CancellationToken cancellationToken)

Launch a job with a FlexTemplate.

Parameters
Name Description
request LaunchFlexTemplateRequest

The request object containing all of the parameters for the API call.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskLaunchFlexTemplateResponse

A Task containing the RPC response.
Example 
// Create client
FlexTemplatesServiceClient flexTemplatesServiceClient = await FlexTemplatesServiceClient.CreateAsync();
// Initialize request argument(s)
LaunchFlexTemplateRequest request = new LaunchFlexTemplateRequest
{
    ProjectId = "",
    LaunchParameter = new LaunchFlexTemplateParameter(),
    Location = "",
    ValidateOnly = false,
};
// Make the request
LaunchFlexTemplateResponse response = await flexTemplatesServiceClient.LaunchFlexTemplateAsync(request);

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type Description
Task

A task representing the asynchronous shutdown operation.
Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.