com.google.cloud.run.v2

Class RevisionsClient

java.lang.Object

com.google.cloud.run.v2.RevisionsClient

All Implemented Interfaces:

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

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

Service Description: Cloud Run Revision Control Plane API.

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 (RevisionsClient revisionsClient = RevisionsClient.create()) {
   RevisionName name = RevisionName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[REVISION]");
   Revision response = revisionsClient.getRevision(name);
 }
 

Note: close() needs to be called on the RevisionsClient 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
GetRevision	Gets information about a Revision.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getRevision(GetRevisionRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getRevision(RevisionName name) getRevision(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getRevisionCallable()
ListRevisions	Lists Revisions from a given Service, or from a given location. Results are sorted by creation time, descending.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listRevisions(ListRevisionsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listRevisions(ServiceName parent) listRevisions(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listRevisionsPagedCallable() listRevisionsCallable()
DeleteRevision	Deletes a Revision.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteRevisionAsync(DeleteRevisionRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteRevisionAsync(RevisionName name) deleteRevisionAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteRevisionOperationCallable() deleteRevisionCallable()

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 RevisionsSettings 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
 RevisionsSettings revisionsSettings =
     RevisionsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RevisionsClient revisionsClient = RevisionsClient.create(revisionsSettings);
 

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
 RevisionsSettings revisionsSettings =
     RevisionsSettings.newBuilder().setEndpoint(myEndpoint).build();
 RevisionsClient revisionsClient = RevisionsClient.create(revisionsSettings);
 

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
 RevisionsSettings revisionsSettings = RevisionsSettings.newHttpJsonBuilder().build();
 RevisionsClient revisionsClient = RevisionsClient.create(revisionsSettings);
 

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RevisionsClient.ListRevisionsFixedSizeCollection
static class	RevisionsClient.ListRevisionsPage
static class	RevisionsClient.ListRevisionsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RevisionsClient(RevisionsSettings settings) Constructs an instance of RevisionsClient, using the given settings.
protected	RevisionsClient(RevisionsStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static RevisionsClient	create() Constructs an instance of RevisionsClient with default settings.
static RevisionsClient	create(RevisionsSettings settings) Constructs an instance of RevisionsClient, using the given settings.
static RevisionsClient	create(RevisionsStub stub) Constructs an instance of RevisionsClient, using the given stub for making calls.
com.google.api.gax.longrunning.OperationFuture<Revision,Revision>	deleteRevisionAsync(DeleteRevisionRequest request) Deletes a Revision.
com.google.api.gax.longrunning.OperationFuture<Revision,Revision>	deleteRevisionAsync(RevisionName name) Deletes a Revision.
com.google.api.gax.longrunning.OperationFuture<Revision,Revision>	deleteRevisionAsync(String name) Deletes a Revision.
com.google.api.gax.rpc.UnaryCallable<DeleteRevisionRequest,com.google.longrunning.Operation>	deleteRevisionCallable() Deletes a Revision.
com.google.api.gax.rpc.OperationCallable<DeleteRevisionRequest,Revision,Revision>	deleteRevisionOperationCallable() Deletes a Revision.
com.google.api.gax.httpjson.longrunning.OperationsClient	getHttpJsonOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
com.google.longrunning.OperationsClient	getOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
Revision	getRevision(GetRevisionRequest request) Gets information about a Revision.
Revision	getRevision(RevisionName name) Gets information about a Revision.
Revision	getRevision(String name) Gets information about a Revision.
com.google.api.gax.rpc.UnaryCallable<GetRevisionRequest,Revision>	getRevisionCallable() Gets information about a Revision.
RevisionsSettings	getSettings()
RevisionsStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
RevisionsClient.ListRevisionsPagedResponse	listRevisions(ListRevisionsRequest request) Lists Revisions from a given Service, or from a given location.
RevisionsClient.ListRevisionsPagedResponse	listRevisions(ServiceName parent) Lists Revisions from a given Service, or from a given location.
RevisionsClient.ListRevisionsPagedResponse	listRevisions(String parent) Lists Revisions from a given Service, or from a given location.
com.google.api.gax.rpc.UnaryCallable<ListRevisionsRequest,ListRevisionsResponse>	listRevisionsCallable() Lists Revisions from a given Service, or from a given location.
com.google.api.gax.rpc.UnaryCallable<ListRevisionsRequest,RevisionsClient.ListRevisionsPagedResponse>	listRevisionsPagedCallable() Lists Revisions from a given Service, or from a given location.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

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

Constructor Detail

RevisionsClient

protected RevisionsClient(RevisionsSettings settings)
                   throws IOException

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

RevisionsClient

protected RevisionsClient(RevisionsStub stub)

Method Detail

create

public static final RevisionsClient create()
                                    throws IOException

Constructs an instance of RevisionsClient with default settings.

Throws:

IOException

create

public static final RevisionsClient create(RevisionsSettings settings)
                                    throws IOException

Constructs an instance of RevisionsClient, 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 RevisionsClient create(RevisionsStub stub)

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

getSettings

public final RevisionsSettings getSettings()

getStub

public RevisionsStub getStub()

getOperationsClient

public final com.google.longrunning.OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

getHttpJsonOperationsClient

@BetaApi
public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

getRevision

public final Revision getRevision(RevisionName name)

Gets information about a Revision.

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 (RevisionsClient revisionsClient = RevisionsClient.create()) {
   RevisionName name = RevisionName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[REVISION]");
   Revision response = revisionsClient.getRevision(name);
 }
 

Parameters:

name - Required. The full name of the Revision. Format: projects/{project}/locations/{location}/services/{service}/revisions/{revision}

Throws:

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

getRevision

public final Revision getRevision(String name)

Gets information about a Revision.

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 (RevisionsClient revisionsClient = RevisionsClient.create()) {
   String name =
       RevisionName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[REVISION]").toString();
   Revision response = revisionsClient.getRevision(name);
 }
 

Parameters:

name - Required. The full name of the Revision. Format: projects/{project}/locations/{location}/services/{service}/revisions/{revision}

Throws:

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

getRevision

public final Revision getRevision(GetRevisionRequest request)

Gets information about a Revision.

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 (RevisionsClient revisionsClient = RevisionsClient.create()) {
   GetRevisionRequest request =
       GetRevisionRequest.newBuilder()
           .setName(
               RevisionName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[REVISION]").toString())
           .build();
   Revision response = revisionsClient.getRevision(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

getRevisionCallable

public final com.google.api.gax.rpc.UnaryCallable<GetRevisionRequest,Revision> getRevisionCallable()

Gets information about a Revision.

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 (RevisionsClient revisionsClient = RevisionsClient.create()) {
   GetRevisionRequest request =
       GetRevisionRequest.newBuilder()
           .setName(
               RevisionName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[REVISION]").toString())
           .build();
   ApiFuture<Revision> future = revisionsClient.getRevisionCallable().futureCall(request);
   // Do something.
   Revision response = future.get();
 }
 

listRevisions

public final RevisionsClient.ListRevisionsPagedResponse listRevisions(ServiceName parent)

Lists Revisions from a given Service, or from a given location. Results are sorted by creation time, descending.

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 (RevisionsClient revisionsClient = RevisionsClient.create()) {
   ServiceName parent = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]");
   for (Revision element : revisionsClient.listRevisions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The Service from which the Revisions should be listed. To list all Revisions across Services, use "-" instead of Service name. Format: projects/{project}/locations/{location}/services/{service}

Throws:

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

listRevisions

public final RevisionsClient.ListRevisionsPagedResponse listRevisions(String parent)

Lists Revisions from a given Service, or from a given location. Results are sorted by creation time, descending.

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 (RevisionsClient revisionsClient = RevisionsClient.create()) {
   String parent = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString();
   for (Revision element : revisionsClient.listRevisions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The Service from which the Revisions should be listed. To list all Revisions across Services, use "-" instead of Service name. Format: projects/{project}/locations/{location}/services/{service}

Throws:

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

listRevisions

public final RevisionsClient.ListRevisionsPagedResponse listRevisions(ListRevisionsRequest request)

Lists Revisions from a given Service, or from a given location. Results are sorted by creation time, descending.

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 (RevisionsClient revisionsClient = RevisionsClient.create()) {
   ListRevisionsRequest request =
       ListRevisionsRequest.newBuilder()
           .setParent(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setShowDeleted(true)
           .build();
   for (Revision element : revisionsClient.listRevisions(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

listRevisionsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListRevisionsRequest,RevisionsClient.ListRevisionsPagedResponse> listRevisionsPagedCallable()

Lists Revisions from a given Service, or from a given location. Results are sorted by creation time, descending.

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 (RevisionsClient revisionsClient = RevisionsClient.create()) {
   ListRevisionsRequest request =
       ListRevisionsRequest.newBuilder()
           .setParent(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setShowDeleted(true)
           .build();
   ApiFuture<Revision> future = revisionsClient.listRevisionsPagedCallable().futureCall(request);
   // Do something.
   for (Revision element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listRevisionsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListRevisionsRequest,ListRevisionsResponse> listRevisionsCallable()

Lists Revisions from a given Service, or from a given location. Results are sorted by creation time, descending.

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 (RevisionsClient revisionsClient = RevisionsClient.create()) {
   ListRevisionsRequest request =
       ListRevisionsRequest.newBuilder()
           .setParent(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setShowDeleted(true)
           .build();
   while (true) {
     ListRevisionsResponse response = revisionsClient.listRevisionsCallable().call(request);
     for (Revision element : response.getRevisionsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

deleteRevisionAsync

public final com.google.api.gax.longrunning.OperationFuture<Revision,Revision> deleteRevisionAsync(RevisionName name)

Deletes a Revision.

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 (RevisionsClient revisionsClient = RevisionsClient.create()) {
   RevisionName name = RevisionName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[REVISION]");
   Revision response = revisionsClient.deleteRevisionAsync(name).get();
 }
 

Parameters:

name - Required. The name of the Revision to delete. Format: projects/{project}/locations/{location}/services/{service}/revisions/{revision}

Throws:

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

deleteRevisionAsync

public final com.google.api.gax.longrunning.OperationFuture<Revision,Revision> deleteRevisionAsync(String name)

Deletes a Revision.

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 (RevisionsClient revisionsClient = RevisionsClient.create()) {
   String name =
       RevisionName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[REVISION]").toString();
   Revision response = revisionsClient.deleteRevisionAsync(name).get();
 }
 

Parameters:

name - Required. The name of the Revision to delete. Format: projects/{project}/locations/{location}/services/{service}/revisions/{revision}

Throws:

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

deleteRevisionAsync

public final com.google.api.gax.longrunning.OperationFuture<Revision,Revision> deleteRevisionAsync(DeleteRevisionRequest request)

Deletes a Revision.

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 (RevisionsClient revisionsClient = RevisionsClient.create()) {
   DeleteRevisionRequest request =
       DeleteRevisionRequest.newBuilder()
           .setName(
               RevisionName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[REVISION]").toString())
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   Revision response = revisionsClient.deleteRevisionAsync(request).get();
 }
 

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

deleteRevisionOperationCallable

public final com.google.api.gax.rpc.OperationCallable<DeleteRevisionRequest,Revision,Revision> deleteRevisionOperationCallable()

Deletes a Revision.

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 (RevisionsClient revisionsClient = RevisionsClient.create()) {
   DeleteRevisionRequest request =
       DeleteRevisionRequest.newBuilder()
           .setName(
               RevisionName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[REVISION]").toString())
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   OperationFuture<Revision, Revision> future =
       revisionsClient.deleteRevisionOperationCallable().futureCall(request);
   // Do something.
   Revision response = future.get();
 }
 

deleteRevisionCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteRevisionRequest,com.google.longrunning.Operation> deleteRevisionCallable()

Deletes a Revision.

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 (RevisionsClient revisionsClient = RevisionsClient.create()) {
   DeleteRevisionRequest request =
       DeleteRevisionRequest.newBuilder()
           .setName(
               RevisionName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[REVISION]").toString())
           .setValidateOnly(true)
           .setEtag("etag3123477")
           .build();
   ApiFuture<Operation> future = revisionsClient.deleteRevisionCallable().futureCall(request);
   // Do something.
   Operation 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