Class TemplatesServiceClient (0.46.0)

GitHub RepositoryProduct ReferenceREST DocumentationRPC Documentation

Service Description: Provides a method to create Cloud Dataflow jobs from templates.

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 (TemplatesServiceClient templatesServiceClient = TemplatesServiceClient.create()) {
   CreateJobFromTemplateRequest request =
       CreateJobFromTemplateRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setJobName("jobName-1438096408")
           .putAllParameters(new HashMap<String, String>())
           .setEnvironment(RuntimeEnvironment.newBuilder().build())
           .setLocation("location1901043637")
           .build();
   Job response = templatesServiceClient.createJobFromTemplate(request);
 }

Note: close() needs to be called on the TemplatesServiceClient 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

CreateJobFromTemplate

Creates a Cloud Dataflow job from a template.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createJobFromTemplate(CreateJobFromTemplateRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createJobFromTemplateCallable()

LaunchTemplate

Launch a template.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • launchTemplate(LaunchTemplateRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • launchTemplateCallable()

GetTemplate

Get the template associated with a template.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getTemplate(GetTemplateRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getTemplateCallable()

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 TemplatesServiceSettings 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
 TemplatesServiceSettings templatesServiceSettings =
     TemplatesServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TemplatesServiceClient templatesServiceClient =
     TemplatesServiceClient.create(templatesServiceSettings);

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
 TemplatesServiceSettings templatesServiceSettings =
     TemplatesServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 TemplatesServiceClient templatesServiceClient =
     TemplatesServiceClient.create(templatesServiceSettings);

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
 TemplatesServiceSettings templatesServiceSettings =
     TemplatesServiceSettings.newHttpJsonBuilder().build();
 TemplatesServiceClient templatesServiceClient =
     TemplatesServiceClient.create(templatesServiceSettings);

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

Inheritance

java.lang.Object > TemplatesServiceClient

Static Methods

create()

public static final TemplatesServiceClient create()

Constructs an instance of TemplatesServiceClient with default settings.

Returns
Type Description
TemplatesServiceClient
Exceptions
Type Description
IOException

create(TemplatesServiceSettings settings)

public static final TemplatesServiceClient create(TemplatesServiceSettings settings)

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

Parameter
Name Description
settings TemplatesServiceSettings
Returns
Type Description
TemplatesServiceClient
Exceptions
Type Description
IOException

create(TemplatesServiceStub stub)

public static final TemplatesServiceClient create(TemplatesServiceStub stub)

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

Parameter
Name Description
stub TemplatesServiceStub
Returns
Type Description
TemplatesServiceClient

Constructors

TemplatesServiceClient(TemplatesServiceSettings settings)

protected TemplatesServiceClient(TemplatesServiceSettings settings)

Constructs an instance of TemplatesServiceClient, 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.

Parameter
Name Description
settings TemplatesServiceSettings

TemplatesServiceClient(TemplatesServiceStub stub)

protected TemplatesServiceClient(TemplatesServiceStub stub)
Parameter
Name Description
stub TemplatesServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

createJobFromTemplate(CreateJobFromTemplateRequest request)

public final Job createJobFromTemplate(CreateJobFromTemplateRequest request)

Creates a Cloud Dataflow job from a template.

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 (TemplatesServiceClient templatesServiceClient = TemplatesServiceClient.create()) {
   CreateJobFromTemplateRequest request =
       CreateJobFromTemplateRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setJobName("jobName-1438096408")
           .putAllParameters(new HashMap<String, String>())
           .setEnvironment(RuntimeEnvironment.newBuilder().build())
           .setLocation("location1901043637")
           .build();
   Job response = templatesServiceClient.createJobFromTemplate(request);
 }
Parameter
Name Description
request CreateJobFromTemplateRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Job

createJobFromTemplateCallable()

public final UnaryCallable<CreateJobFromTemplateRequest,Job> createJobFromTemplateCallable()

Creates a Cloud Dataflow job from a template.

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 (TemplatesServiceClient templatesServiceClient = TemplatesServiceClient.create()) {
   CreateJobFromTemplateRequest request =
       CreateJobFromTemplateRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setJobName("jobName-1438096408")
           .putAllParameters(new HashMap<String, String>())
           .setEnvironment(RuntimeEnvironment.newBuilder().build())
           .setLocation("location1901043637")
           .build();
   ApiFuture<Job> future =
       templatesServiceClient.createJobFromTemplateCallable().futureCall(request);
   // Do something.
   Job response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateJobFromTemplateRequest,Job>

getSettings()

public final TemplatesServiceSettings getSettings()
Returns
Type Description
TemplatesServiceSettings

getStub()

public TemplatesServiceStub getStub()
Returns
Type Description
TemplatesServiceStub

getTemplate(GetTemplateRequest request)

public final GetTemplateResponse getTemplate(GetTemplateRequest request)

Get the template associated with a template.

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 (TemplatesServiceClient templatesServiceClient = TemplatesServiceClient.create()) {
   GetTemplateRequest request =
       GetTemplateRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setLocation("location1901043637")
           .build();
   GetTemplateResponse response = templatesServiceClient.getTemplate(request);
 }
Parameter
Name Description
request GetTemplateRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
GetTemplateResponse

getTemplateCallable()

public final UnaryCallable<GetTemplateRequest,GetTemplateResponse> getTemplateCallable()

Get the template associated with a template.

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 (TemplatesServiceClient templatesServiceClient = TemplatesServiceClient.create()) {
   GetTemplateRequest request =
       GetTemplateRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setLocation("location1901043637")
           .build();
   ApiFuture<GetTemplateResponse> future =
       templatesServiceClient.getTemplateCallable().futureCall(request);
   // Do something.
   GetTemplateResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<GetTemplateRequest,GetTemplateResponse>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

launchTemplate(LaunchTemplateRequest request)

public final LaunchTemplateResponse launchTemplate(LaunchTemplateRequest request)

Launch a template.

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 (TemplatesServiceClient templatesServiceClient = TemplatesServiceClient.create()) {
   LaunchTemplateRequest request =
       LaunchTemplateRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setValidateOnly(true)
           .setLaunchParameters(LaunchTemplateParameters.newBuilder().build())
           .setLocation("location1901043637")
           .build();
   LaunchTemplateResponse response = templatesServiceClient.launchTemplate(request);
 }
Parameter
Name Description
request LaunchTemplateRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
LaunchTemplateResponse

launchTemplateCallable()

public final UnaryCallable<LaunchTemplateRequest,LaunchTemplateResponse> launchTemplateCallable()

Launch a template.

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 (TemplatesServiceClient templatesServiceClient = TemplatesServiceClient.create()) {
   LaunchTemplateRequest request =
       LaunchTemplateRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setValidateOnly(true)
           .setLaunchParameters(LaunchTemplateParameters.newBuilder().build())
           .setLocation("location1901043637")
           .build();
   ApiFuture<LaunchTemplateResponse> future =
       templatesServiceClient.launchTemplateCallable().futureCall(request);
   // Do something.
   LaunchTemplateResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<LaunchTemplateRequest,LaunchTemplateResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()