com.google.dataflow.v1beta3

Class FlexTemplatesServiceClient

java.lang.Object

com.google.dataflow.v1beta3.FlexTemplatesServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@BetaApi
 @Generated(value="by gapic-generator-java")
public class FlexTemplatesServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Provides a service for Flex templates. This feature is not ready yet.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FlexTemplatesServiceClient flexTemplatesServiceClient =
     FlexTemplatesServiceClient.create()) {
   LaunchFlexTemplateRequest request =
       LaunchFlexTemplateRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setLaunchParameter(LaunchFlexTemplateParameter.newBuilder().build())
           .setLocation("location1901043637")
           .setValidateOnly(true)
           .build();
   LaunchFlexTemplateResponse response = flexTemplatesServiceClient.launchFlexTemplate(request);
 }
 

Note: close() needs to be called on the FlexTemplatesServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods

Method	Description	Method Variants
LaunchFlexTemplate	Launch a job with a FlexTemplate.	Request object method variants only take one parameter, a request object, which must be constructed before the call. launchFlexTemplate(LaunchFlexTemplateRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. launchFlexTemplateCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of FlexTemplatesServiceSettings to create(). For example:

To customize credentials:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 FlexTemplatesServiceSettings flexTemplatesServiceSettings =
     FlexTemplatesServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 FlexTemplatesServiceClient flexTemplatesServiceClient =
     FlexTemplatesServiceClient.create(flexTemplatesServiceSettings);
 

To customize the endpoint:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 FlexTemplatesServiceSettings flexTemplatesServiceSettings =
     FlexTemplatesServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 FlexTemplatesServiceClient flexTemplatesServiceClient =
     FlexTemplatesServiceClient.create(flexTemplatesServiceSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 FlexTemplatesServiceSettings flexTemplatesServiceSettings =
     FlexTemplatesServiceSettings.newHttpJsonBuilder().build();
 FlexTemplatesServiceClient flexTemplatesServiceClient =
     FlexTemplatesServiceClient.create(flexTemplatesServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FlexTemplatesServiceClient(FlexTemplatesServiceSettings settings) Constructs an instance of FlexTemplatesServiceClient, using the given settings.
protected	FlexTemplatesServiceClient(FlexTemplatesServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static FlexTemplatesServiceClient	create() Constructs an instance of FlexTemplatesServiceClient with default settings.
static FlexTemplatesServiceClient	create(FlexTemplatesServiceSettings settings) Constructs an instance of FlexTemplatesServiceClient, using the given settings.
static FlexTemplatesServiceClient	create(FlexTemplatesServiceStub stub) Constructs an instance of FlexTemplatesServiceClient, using the given stub for making calls.
FlexTemplatesServiceSettings	getSettings()
FlexTemplatesServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
LaunchFlexTemplateResponse	launchFlexTemplate(LaunchFlexTemplateRequest request) Launch a job with a FlexTemplate.
com.google.api.gax.rpc.UnaryCallable<LaunchFlexTemplateRequest,LaunchFlexTemplateResponse>	launchFlexTemplateCallable() Launch a job with a FlexTemplate.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FlexTemplatesServiceClient

protected FlexTemplatesServiceClient(FlexTemplatesServiceSettings settings)
                              throws IOException

Constructs an instance of FlexTemplatesServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

FlexTemplatesServiceClient

protected FlexTemplatesServiceClient(FlexTemplatesServiceStub stub)

Method Detail

create

public static final FlexTemplatesServiceClient create()
                                               throws IOException

Constructs an instance of FlexTemplatesServiceClient with default settings.

Throws:

IOException

create

public static final FlexTemplatesServiceClient create(FlexTemplatesServiceSettings settings)
                                               throws IOException

Constructs an instance of FlexTemplatesServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

public static final FlexTemplatesServiceClient create(FlexTemplatesServiceStub stub)

Constructs an instance of FlexTemplatesServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(FlexTemplatesServiceSettings).

getSettings

public final FlexTemplatesServiceSettings getSettings()

getStub

public FlexTemplatesServiceStub getStub()

launchFlexTemplate

public final LaunchFlexTemplateResponse launchFlexTemplate(LaunchFlexTemplateRequest request)

Launch a job with a FlexTemplate.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FlexTemplatesServiceClient flexTemplatesServiceClient =
     FlexTemplatesServiceClient.create()) {
   LaunchFlexTemplateRequest request =
       LaunchFlexTemplateRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setLaunchParameter(LaunchFlexTemplateParameter.newBuilder().build())
           .setLocation("location1901043637")
           .setValidateOnly(true)
           .build();
   LaunchFlexTemplateResponse response = flexTemplatesServiceClient.launchFlexTemplate(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

launchFlexTemplateCallable

public final com.google.api.gax.rpc.UnaryCallable<LaunchFlexTemplateRequest,LaunchFlexTemplateResponse> launchFlexTemplateCallable()

Launch a job with a FlexTemplate.

Sample code:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (FlexTemplatesServiceClient flexTemplatesServiceClient =
     FlexTemplatesServiceClient.create()) {
   LaunchFlexTemplateRequest request =
       LaunchFlexTemplateRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setLaunchParameter(LaunchFlexTemplateParameter.newBuilder().build())
           .setLocation("location1901043637")
           .setValidateOnly(true)
           .build();
   ApiFuture<LaunchFlexTemplateResponse> future =
       flexTemplatesServiceClient.launchFlexTemplateCallable().futureCall(request);
   // Do something.
   LaunchFlexTemplateResponse response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException