Class SnapshotsV1Beta3Client (0.55.0)

Version 0.55.0

• 0.59.0 (latest)
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.5.0

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

GitHub Repository

Product Reference

REST Documentation

RPC Documentation

Service Description: Provides methods to manage snapshots of Google Cloud Dataflow jobs.

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 (SnapshotsV1Beta3Client snapshotsV1Beta3Client = SnapshotsV1Beta3Client.create()) {
   GetSnapshotRequest request =
       GetSnapshotRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setSnapshotId("snapshotId-1113817601")
           .setLocation("location1901043637")
           .build();
   Snapshot response = snapshotsV1Beta3Client.getSnapshot(request);
 }
 

Note: close() needs to be called on the SnapshotsV1Beta3Client 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
GetSnapshot	Gets information about a snapshot.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getSnapshot(GetSnapshotRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getSnapshotCallable()
DeleteSnapshot	Deletes a snapshot.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteSnapshot(DeleteSnapshotRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteSnapshotCallable()
ListSnapshots	Lists snapshots.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listSnapshots(ListSnapshotsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listSnapshotsCallable()

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 SnapshotsV1Beta3Settings 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
 SnapshotsV1Beta3Settings snapshotsV1Beta3Settings =
     SnapshotsV1Beta3Settings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SnapshotsV1Beta3Client snapshotsV1Beta3Client =
     SnapshotsV1Beta3Client.create(snapshotsV1Beta3Settings);
 

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
 SnapshotsV1Beta3Settings snapshotsV1Beta3Settings =
     SnapshotsV1Beta3Settings.newBuilder().setEndpoint(myEndpoint).build();
 SnapshotsV1Beta3Client snapshotsV1Beta3Client =
     SnapshotsV1Beta3Client.create(snapshotsV1Beta3Settings);
 

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
 SnapshotsV1Beta3Settings snapshotsV1Beta3Settings =
     SnapshotsV1Beta3Settings.newHttpJsonBuilder().build();
 SnapshotsV1Beta3Client snapshotsV1Beta3Client =
     SnapshotsV1Beta3Client.create(snapshotsV1Beta3Settings);
 

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

Inheritance

java.lang.Object > SnapshotsV1Beta3Client

Static Methods

create()

public static final SnapshotsV1Beta3Client create()

Constructs an instance of SnapshotsV1Beta3Client with default settings.

Returns
Type	Description
SnapshotsV1Beta3Client

Exceptions
Type	Description
IOException

create(SnapshotsV1Beta3Settings settings)

public static final SnapshotsV1Beta3Client create(SnapshotsV1Beta3Settings settings)

Constructs an instance of SnapshotsV1Beta3Client, 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	SnapshotsV1Beta3Settings

Returns
Type	Description
SnapshotsV1Beta3Client

Exceptions
Type	Description
IOException

create(SnapshotsV1Beta3Stub stub)

public static final SnapshotsV1Beta3Client create(SnapshotsV1Beta3Stub stub)

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

Parameter
Name	Description
stub	SnapshotsV1Beta3Stub

Returns
Type	Description
SnapshotsV1Beta3Client

Constructors

SnapshotsV1Beta3Client(SnapshotsV1Beta3Settings settings)

protected SnapshotsV1Beta3Client(SnapshotsV1Beta3Settings settings)

Constructs an instance of SnapshotsV1Beta3Client, 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	SnapshotsV1Beta3Settings

SnapshotsV1Beta3Client(SnapshotsV1Beta3Stub stub)

protected SnapshotsV1Beta3Client(SnapshotsV1Beta3Stub stub)

Parameter
Name	Description
stub	SnapshotsV1Beta3Stub

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()

deleteSnapshot(DeleteSnapshotRequest request)

public final DeleteSnapshotResponse deleteSnapshot(DeleteSnapshotRequest request)

Deletes a snapshot.

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 (SnapshotsV1Beta3Client snapshotsV1Beta3Client = SnapshotsV1Beta3Client.create()) {
   DeleteSnapshotRequest request =
       DeleteSnapshotRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setSnapshotId("snapshotId-1113817601")
           .setLocation("location1901043637")
           .build();
   DeleteSnapshotResponse response = snapshotsV1Beta3Client.deleteSnapshot(request);
 }
 

Parameter
Name	Description
request	DeleteSnapshotRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
DeleteSnapshotResponse

deleteSnapshotCallable()

public final UnaryCallable<DeleteSnapshotRequest,DeleteSnapshotResponse> deleteSnapshotCallable()

Deletes a snapshot.

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 (SnapshotsV1Beta3Client snapshotsV1Beta3Client = SnapshotsV1Beta3Client.create()) {
   DeleteSnapshotRequest request =
       DeleteSnapshotRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setSnapshotId("snapshotId-1113817601")
           .setLocation("location1901043637")
           .build();
   ApiFuture<DeleteSnapshotResponse> future =
       snapshotsV1Beta3Client.deleteSnapshotCallable().futureCall(request);
   // Do something.
   DeleteSnapshotResponse response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<DeleteSnapshotRequest,DeleteSnapshotResponse>

getSettings()

public final SnapshotsV1Beta3Settings getSettings()

Returns
Type	Description
SnapshotsV1Beta3Settings

getSnapshot(GetSnapshotRequest request)

public final Snapshot getSnapshot(GetSnapshotRequest request)

Gets information about a snapshot.

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 (SnapshotsV1Beta3Client snapshotsV1Beta3Client = SnapshotsV1Beta3Client.create()) {
   GetSnapshotRequest request =
       GetSnapshotRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setSnapshotId("snapshotId-1113817601")
           .setLocation("location1901043637")
           .build();
   Snapshot response = snapshotsV1Beta3Client.getSnapshot(request);
 }
 

Parameter
Name	Description
request	GetSnapshotRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
Snapshot

getSnapshotCallable()

public final UnaryCallable<GetSnapshotRequest,Snapshot> getSnapshotCallable()

Gets information about a snapshot.

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 (SnapshotsV1Beta3Client snapshotsV1Beta3Client = SnapshotsV1Beta3Client.create()) {
   GetSnapshotRequest request =
       GetSnapshotRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setSnapshotId("snapshotId-1113817601")
           .setLocation("location1901043637")
           .build();
   ApiFuture<Snapshot> future = snapshotsV1Beta3Client.getSnapshotCallable().futureCall(request);
   // Do something.
   Snapshot response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetSnapshotRequest,Snapshot>

getStub()

public SnapshotsV1Beta3Stub getStub()

Returns
Type	Description
SnapshotsV1Beta3Stub

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

listSnapshots(ListSnapshotsRequest request)

public final ListSnapshotsResponse listSnapshots(ListSnapshotsRequest request)

Lists snapshots.

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 (SnapshotsV1Beta3Client snapshotsV1Beta3Client = SnapshotsV1Beta3Client.create()) {
   ListSnapshotsRequest request =
       ListSnapshotsRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setJobId("jobId101296568")
           .setLocation("location1901043637")
           .build();
   ListSnapshotsResponse response = snapshotsV1Beta3Client.listSnapshots(request);
 }
 

Parameter
Name	Description
request	ListSnapshotsRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
ListSnapshotsResponse

listSnapshotsCallable()

public final UnaryCallable<ListSnapshotsRequest,ListSnapshotsResponse> listSnapshotsCallable()

Lists snapshots.

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 (SnapshotsV1Beta3Client snapshotsV1Beta3Client = SnapshotsV1Beta3Client.create()) {
   ListSnapshotsRequest request =
       ListSnapshotsRequest.newBuilder()
           .setProjectId("projectId-894832108")
           .setJobId("jobId101296568")
           .setLocation("location1901043637")
           .build();
   ApiFuture<ListSnapshotsResponse> future =
       snapshotsV1Beta3Client.listSnapshotsCallable().futureCall(request);
   // Do something.
   ListSnapshotsResponse response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<ListSnapshotsRequest,ListSnapshotsResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()