Class RevisionsClient (0.67.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 0.78.0 (latest)
- 0.76.0
- 0.75.0
- 0.74.0
- 0.73.0
- 0.72.0
- 0.70.0
- 0.68.0
- 0.67.0
- 0.64.0
- 0.63.0
- 0.62.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.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.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.5
- 0.2.1
- 0.1.2
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(RevisionsClientrevisionsClient=RevisionsClient.create()){
RevisionNamename=RevisionName.of("[PROJECT]","[LOCATION]","[SERVICE]","[REVISION]");
Revisionresponse=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().
| 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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteRevision |
Deletes a Revision. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Methods that return long-running operations have "Async" method variants that return
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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
RevisionsSettingsrevisionsSettings=
RevisionsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
RevisionsClientrevisionsClient=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
RevisionsSettingsrevisionsSettings=
RevisionsSettings.newBuilder().setEndpoint(myEndpoint).build();
RevisionsClientrevisionsClient=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
RevisionsSettingsrevisionsSettings=RevisionsSettings.newHttpJsonBuilder().build();
RevisionsClientrevisionsClient=RevisionsClient.create(revisionsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
publicstaticfinalRevisionsClientcreate()Constructs an instance of RevisionsClient with default settings.
| Returns | |
|---|---|
| Type | Description |
RevisionsClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(RevisionsSettings settings)
publicstaticfinalRevisionsClientcreate(RevisionsSettingssettings)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.
| Parameter | |
|---|---|
| Name | Description |
settings |
RevisionsSettings |
| Returns | |
|---|---|
| Type | Description |
RevisionsClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(RevisionsStub stub)
publicstaticfinalRevisionsClientcreate(RevisionsStubstub)Constructs an instance of RevisionsClient, using the given stub for making calls. This is for advanced usage - prefer using create(RevisionsSettings).
| Parameter | |
|---|---|
| Name | Description |
stub |
RevisionsStub |
| Returns | |
|---|---|
| Type | Description |
RevisionsClient |
|
Constructors
RevisionsClient(RevisionsSettings settings)
protectedRevisionsClient(RevisionsSettingssettings)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.
| Parameter | |
|---|---|
| Name | Description |
settings |
RevisionsSettings |
RevisionsClient(RevisionsStub stub)
protectedRevisionsClient(RevisionsStubstub)| Parameter | |
|---|---|
| Name | Description |
stub |
RevisionsStub |
Methods
awaitTermination(long duration, TimeUnit unit)
publicbooleanawaitTermination(longduration,TimeUnitunit)| Parameters | |
|---|---|
| Name | Description |
duration |
long |
unit |
TimeUnit |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
| Exceptions | |
|---|---|
| Type | Description |
InterruptedException |
|
close()
publicfinalvoidclose()deleteRevisionAsync(DeleteRevisionRequest request)
publicfinalOperationFuture<Revision,Revision>deleteRevisionAsync(DeleteRevisionRequestrequest)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(RevisionsClientrevisionsClient=RevisionsClient.create()){
DeleteRevisionRequestrequest=
DeleteRevisionRequest.newBuilder()
.setName(
RevisionName.of("[PROJECT]","[LOCATION]","[SERVICE]","[REVISION]").toString())
.setValidateOnly(true)
.setEtag("etag3123477")
.build();
Revisionresponse=revisionsClient.deleteRevisionAsync(request).get();
}
| Parameter | |
|---|---|
| Name | Description |
request |
DeleteRevisionRequest The request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Revision,Revision> |
|
deleteRevisionAsync(RevisionName name)
publicfinalOperationFuture<Revision,Revision>deleteRevisionAsync(RevisionNamename)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(RevisionsClientrevisionsClient=RevisionsClient.create()){
RevisionNamename=RevisionName.of("[PROJECT]","[LOCATION]","[SERVICE]","[REVISION]");
Revisionresponse=revisionsClient.deleteRevisionAsync(name).get();
}
| Parameter | |
|---|---|
| Name | Description |
name |
RevisionName Required. The name of the Revision to delete. Format: projects/{project}/locations/{location}/services/{service}/revisions/{revision} |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Revision,Revision> |
|
deleteRevisionAsync(String name)
publicfinalOperationFuture<Revision,Revision>deleteRevisionAsync(Stringname)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(RevisionsClientrevisionsClient=RevisionsClient.create()){
Stringname=
RevisionName.of("[PROJECT]","[LOCATION]","[SERVICE]","[REVISION]").toString();
Revisionresponse=revisionsClient.deleteRevisionAsync(name).get();
}
| Parameter | |
|---|---|
| Name | Description |
name |
String Required. The name of the Revision to delete. Format: projects/{project}/locations/{location}/services/{service}/revisions/{revision} |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<Revision,Revision> |
|
deleteRevisionCallable()
publicfinalUnaryCallable<DeleteRevisionRequest,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(RevisionsClientrevisionsClient=RevisionsClient.create()){
DeleteRevisionRequestrequest=
DeleteRevisionRequest.newBuilder()
.setName(
RevisionName.of("[PROJECT]","[LOCATION]","[SERVICE]","[REVISION]").toString())
.setValidateOnly(true)
.setEtag("etag3123477")
.build();
ApiFuture<Operation>future=revisionsClient.deleteRevisionCallable().futureCall(request);
// Do something.
Operationresponse=future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<DeleteRevisionRequest,Operation> |
|
deleteRevisionOperationCallable()
publicfinalOperationCallable<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(RevisionsClientrevisionsClient=RevisionsClient.create()){
DeleteRevisionRequestrequest=
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.
Revisionresponse=future.get();
}
| Returns | |
|---|---|
| Type | Description |
OperationCallable<DeleteRevisionRequest,Revision,Revision> |
|
getHttpJsonOperationsClient()
publicfinalOperationsClientgetHttpJsonOperationsClient()Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
| Returns | |
|---|---|
| Type | Description |
OperationsClient |
|
getOperationsClient()
publicfinalOperationsClientgetOperationsClient()Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
| Returns | |
|---|---|
| Type | Description |
OperationsClient |
|
getRevision(GetRevisionRequest request)
publicfinalRevisiongetRevision(GetRevisionRequestrequest)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(RevisionsClientrevisionsClient=RevisionsClient.create()){
GetRevisionRequestrequest=
GetRevisionRequest.newBuilder()
.setName(
RevisionName.of("[PROJECT]","[LOCATION]","[SERVICE]","[REVISION]").toString())
.build();
Revisionresponse=revisionsClient.getRevision(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
GetRevisionRequest The request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
Revision |
|
getRevision(RevisionName name)
publicfinalRevisiongetRevision(RevisionNamename)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(RevisionsClientrevisionsClient=RevisionsClient.create()){
RevisionNamename=RevisionName.of("[PROJECT]","[LOCATION]","[SERVICE]","[REVISION]");
Revisionresponse=revisionsClient.getRevision(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
RevisionName Required. The full name of the Revision. Format: projects/{project}/locations/{location}/services/{service}/revisions/{revision} |
| Returns | |
|---|---|
| Type | Description |
Revision |
|
getRevision(String name)
publicfinalRevisiongetRevision(Stringname)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(RevisionsClientrevisionsClient=RevisionsClient.create()){
Stringname=
RevisionName.of("[PROJECT]","[LOCATION]","[SERVICE]","[REVISION]").toString();
Revisionresponse=revisionsClient.getRevision(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
String Required. The full name of the Revision. Format: projects/{project}/locations/{location}/services/{service}/revisions/{revision} |
| Returns | |
|---|---|
| Type | Description |
Revision |
|
getRevisionCallable()
publicfinalUnaryCallable<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(RevisionsClientrevisionsClient=RevisionsClient.create()){
GetRevisionRequestrequest=
GetRevisionRequest.newBuilder()
.setName(
RevisionName.of("[PROJECT]","[LOCATION]","[SERVICE]","[REVISION]").toString())
.build();
ApiFuture<Revision>future=revisionsClient.getRevisionCallable().futureCall(request);
// Do something.
Revisionresponse=future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<GetRevisionRequest,Revision> |
|
getSettings()
publicfinalRevisionsSettingsgetSettings()| Returns | |
|---|---|
| Type | Description |
RevisionsSettings |
|
getStub()
publicRevisionsStubgetStub()| Returns | |
|---|---|
| Type | Description |
RevisionsStub |
|
isShutdown()
publicbooleanisShutdown()| Returns | |
|---|---|
| Type | Description |
boolean |
|
isTerminated()
publicbooleanisTerminated()| Returns | |
|---|---|
| Type | Description |
boolean |
|
listRevisions(ListRevisionsRequest request)
publicfinalRevisionsClient.ListRevisionsPagedResponselistRevisions(ListRevisionsRequestrequest)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(RevisionsClientrevisionsClient=RevisionsClient.create()){
ListRevisionsRequestrequest=
ListRevisionsRequest.newBuilder()
.setParent(ServiceName.of("[PROJECT]","[LOCATION]","[SERVICE]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setShowDeleted(true)
.build();
for(Revisionelement:revisionsClient.listRevisions(request).iterateAll()){
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
ListRevisionsRequest The request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
RevisionsClient.ListRevisionsPagedResponse |
|
listRevisions(ServiceName parent)
publicfinalRevisionsClient.ListRevisionsPagedResponselistRevisions(ServiceNameparent)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(RevisionsClientrevisionsClient=RevisionsClient.create()){
ServiceNameparent=ServiceName.of("[PROJECT]","[LOCATION]","[SERVICE]");
for(Revisionelement:revisionsClient.listRevisions(parent).iterateAll()){
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
ServiceName 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} |
| Returns | |
|---|---|
| Type | Description |
RevisionsClient.ListRevisionsPagedResponse |
|
listRevisions(String parent)
publicfinalRevisionsClient.ListRevisionsPagedResponselistRevisions(Stringparent)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(RevisionsClientrevisionsClient=RevisionsClient.create()){
Stringparent=ServiceName.of("[PROJECT]","[LOCATION]","[SERVICE]").toString();
for(Revisionelement:revisionsClient.listRevisions(parent).iterateAll()){
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
String 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} |
| Returns | |
|---|---|
| Type | Description |
RevisionsClient.ListRevisionsPagedResponse |
|
listRevisionsCallable()
publicfinalUnaryCallable<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(RevisionsClientrevisionsClient=RevisionsClient.create()){
ListRevisionsRequestrequest=
ListRevisionsRequest.newBuilder()
.setParent(ServiceName.of("[PROJECT]","[LOCATION]","[SERVICE]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setShowDeleted(true)
.build();
while(true){
ListRevisionsResponseresponse=revisionsClient.listRevisionsCallable().call(request);
for(Revisionelement:response.getRevisionsList()){
// doThingsWith(element);
}
StringnextPageToken=response.getNextPageToken();
if(!Strings.isNullOrEmpty(nextPageToken)){
request=request.toBuilder().setPageToken(nextPageToken).build();
}else{
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListRevisionsRequest,ListRevisionsResponse> |
|
listRevisionsPagedCallable()
publicfinalUnaryCallable<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(RevisionsClientrevisionsClient=RevisionsClient.create()){
ListRevisionsRequestrequest=
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(Revisionelement:future.get().iterateAll()){
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListRevisionsRequest,ListRevisionsPagedResponse> |
|
shutdown()
publicvoidshutdown()shutdownNow()
publicvoidshutdownNow()