- 2.48.0 (latest)
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.4
- 2.2.0
- 2.1.10
GitHub Repository | Product Reference |
Service Description: Manages versions of a service.
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 (VersionsClient versionsClient = VersionsClient.create()) {
GetVersionRequest request =
GetVersionRequest.newBuilder()
.setName("name3373707")
.setView(VersionView.forNumber(0))
.build();
Version response = versionsClient.getVersion(request);
}
Note: close() needs to be called on the VersionsClient 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 |
---|---|---|
ListVersions |
Lists the versions of a service. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetVersion |
Gets the specified Version resource. By default, only a |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateVersion |
Deploys code and resource files to a new version. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateVersion |
Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses: **Standard environment** *automatic scaling* in the standard environment:
*basic scaling* or *manual scaling* in the standard environment: **Flexible environment** *automatic scaling* in the flexible environment:
*manual scaling* in the flexible environment: |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteVersion |
Deletes an existing Version resource. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
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 VersionsSettings 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
VersionsSettings versionsSettings =
VersionsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
VersionsClient versionsClient = VersionsClient.create(versionsSettings);
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
VersionsSettings versionsSettings =
VersionsSettings.newBuilder().setEndpoint(myEndpoint).build();
VersionsClient versionsClient = VersionsClient.create(versionsSettings);
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
VersionsSettings versionsSettings = VersionsSettings.newHttpJsonBuilder().build();
VersionsClient versionsClient = VersionsClient.create(versionsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final VersionsClient create()
Constructs an instance of VersionsClient with default settings.
Returns | |
---|---|
Type | Description |
VersionsClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(VersionsSettings settings)
public static final VersionsClient create(VersionsSettings settings)
Constructs an instance of VersionsClient, 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 |
VersionsSettings |
Returns | |
---|---|
Type | Description |
VersionsClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(VersionsStub stub)
public static final VersionsClient create(VersionsStub stub)
Constructs an instance of VersionsClient, using the given stub for making calls. This is for advanced usage - prefer using create(VersionsSettings).
Parameter | |
---|---|
Name | Description |
stub |
VersionsStub |
Returns | |
---|---|
Type | Description |
VersionsClient |
Constructors
VersionsClient(VersionsSettings settings)
protected VersionsClient(VersionsSettings settings)
Constructs an instance of VersionsClient, 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 |
VersionsSettings |
VersionsClient(VersionsStub stub)
protected VersionsClient(VersionsStub stub)
Parameter | |
---|---|
Name | Description |
stub |
VersionsStub |
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()
createVersionAsync(CreateVersionRequest request)
public final OperationFuture<Version,CreateVersionMetadataV1> createVersionAsync(CreateVersionRequest request)
Deploys code and resource files to a new version.
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 (VersionsClient versionsClient = VersionsClient.create()) {
CreateVersionRequest request =
CreateVersionRequest.newBuilder()
.setParent("parent-995424086")
.setVersion(Version.newBuilder().build())
.build();
Version response = versionsClient.createVersionAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
CreateVersionRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Version,CreateVersionMetadataV1> |
createVersionCallable()
public final UnaryCallable<CreateVersionRequest,Operation> createVersionCallable()
Deploys code and resource files to a new version.
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 (VersionsClient versionsClient = VersionsClient.create()) {
CreateVersionRequest request =
CreateVersionRequest.newBuilder()
.setParent("parent-995424086")
.setVersion(Version.newBuilder().build())
.build();
ApiFuture<Operation> future = versionsClient.createVersionCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateVersionRequest,Operation> |
createVersionOperationCallable()
public final OperationCallable<CreateVersionRequest,Version,CreateVersionMetadataV1> createVersionOperationCallable()
Deploys code and resource files to a new version.
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 (VersionsClient versionsClient = VersionsClient.create()) {
CreateVersionRequest request =
CreateVersionRequest.newBuilder()
.setParent("parent-995424086")
.setVersion(Version.newBuilder().build())
.build();
OperationFuture<Version, CreateVersionMetadataV1> future =
versionsClient.createVersionOperationCallable().futureCall(request);
// Do something.
Version response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<CreateVersionRequest,Version,CreateVersionMetadataV1> |
deleteVersionAsync(DeleteVersionRequest request)
public final OperationFuture<Empty,OperationMetadataV1> deleteVersionAsync(DeleteVersionRequest request)
Deletes an existing Version resource.
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 (VersionsClient versionsClient = VersionsClient.create()) {
DeleteVersionRequest request =
DeleteVersionRequest.newBuilder().setName("name3373707").build();
versionsClient.deleteVersionAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
DeleteVersionRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,OperationMetadataV1> |
deleteVersionCallable()
public final UnaryCallable<DeleteVersionRequest,Operation> deleteVersionCallable()
Deletes an existing Version resource.
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 (VersionsClient versionsClient = VersionsClient.create()) {
DeleteVersionRequest request =
DeleteVersionRequest.newBuilder().setName("name3373707").build();
ApiFuture<Operation> future = versionsClient.deleteVersionCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteVersionRequest,Operation> |
deleteVersionOperationCallable()
public final OperationCallable<DeleteVersionRequest,Empty,OperationMetadataV1> deleteVersionOperationCallable()
Deletes an existing Version resource.
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 (VersionsClient versionsClient = VersionsClient.create()) {
DeleteVersionRequest request =
DeleteVersionRequest.newBuilder().setName("name3373707").build();
OperationFuture<Empty, OperationMetadataV1> future =
versionsClient.deleteVersionOperationCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DeleteVersionRequest,Empty,OperationMetadataV1> |
getHttpJsonOperationsClient()
public final OperationsClient getHttpJsonOperationsClient()
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()
public final OperationsClient getOperationsClient()
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 |
getSettings()
public final VersionsSettings getSettings()
Returns | |
---|---|
Type | Description |
VersionsSettings |
getStub()
public VersionsStub getStub()
Returns | |
---|---|
Type | Description |
VersionsStub |
getVersion(GetVersionRequest request)
public final Version getVersion(GetVersionRequest request)
Gets the specified Version resource. By default, only a BASIC_VIEW
will be returned. Specify
the FULL_VIEW
parameter to get the full resource.
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 (VersionsClient versionsClient = VersionsClient.create()) {
GetVersionRequest request =
GetVersionRequest.newBuilder()
.setName("name3373707")
.setView(VersionView.forNumber(0))
.build();
Version response = versionsClient.getVersion(request);
}
Parameter | |
---|---|
Name | Description |
request |
GetVersionRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Version |
getVersionCallable()
public final UnaryCallable<GetVersionRequest,Version> getVersionCallable()
Gets the specified Version resource. By default, only a BASIC_VIEW
will be returned. Specify
the FULL_VIEW
parameter to get the full resource.
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 (VersionsClient versionsClient = VersionsClient.create()) {
GetVersionRequest request =
GetVersionRequest.newBuilder()
.setName("name3373707")
.setView(VersionView.forNumber(0))
.build();
ApiFuture<Version> future = versionsClient.getVersionCallable().futureCall(request);
// Do something.
Version response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetVersionRequest,Version> |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
listVersions(ListVersionsRequest request)
public final VersionsClient.ListVersionsPagedResponse listVersions(ListVersionsRequest request)
Lists the versions of a service.
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 (VersionsClient versionsClient = VersionsClient.create()) {
ListVersionsRequest request =
ListVersionsRequest.newBuilder()
.setParent("parent-995424086")
.setView(VersionView.forNumber(0))
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Version element : versionsClient.listVersions(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request |
ListVersionsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
VersionsClient.ListVersionsPagedResponse |
listVersionsCallable()
public final UnaryCallable<ListVersionsRequest,ListVersionsResponse> listVersionsCallable()
Lists the versions of a service.
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 (VersionsClient versionsClient = VersionsClient.create()) {
ListVersionsRequest request =
ListVersionsRequest.newBuilder()
.setParent("parent-995424086")
.setView(VersionView.forNumber(0))
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListVersionsResponse response = versionsClient.listVersionsCallable().call(request);
for (Version element : response.getVersionsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListVersionsRequest,ListVersionsResponse> |
listVersionsPagedCallable()
public final UnaryCallable<ListVersionsRequest,VersionsClient.ListVersionsPagedResponse> listVersionsPagedCallable()
Lists the versions of a service.
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 (VersionsClient versionsClient = VersionsClient.create()) {
ListVersionsRequest request =
ListVersionsRequest.newBuilder()
.setParent("parent-995424086")
.setView(VersionView.forNumber(0))
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Version> future = versionsClient.listVersionsPagedCallable().futureCall(request);
// Do something.
for (Version element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListVersionsRequest,ListVersionsPagedResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
updateVersionAsync(UpdateVersionRequest request)
public final OperationFuture<Version,OperationMetadataV1> updateVersionAsync(UpdateVersionRequest request)
Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:
**Standard environment**
*automatic scaling* in the standard environment:
automatic_scaling.min_idle_instances
automatic_scaling.max_idle_instances
automaticScaling.standard_scheduler_settings.max_instances
automaticScaling.standard_scheduler_settings.min_instances
automaticScaling.standard_scheduler_settings.target_cpu_utilization
automaticScaling.standard_scheduler_settings.target_throughput_utilization
*basic scaling* or *manual scaling* in the standard environment:
**Flexible environment**
*automatic scaling* in the flexible environment:
automatic_scaling.min_total_instances
automatic_scaling.max_total_instances
automatic_scaling.cool_down_period_sec
automatic_scaling.cpu_utilization.target_utilization
*manual scaling* in the flexible environment:
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 (VersionsClient versionsClient = VersionsClient.create()) {
UpdateVersionRequest request =
UpdateVersionRequest.newBuilder()
.setName("name3373707")
.setVersion(Version.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Version response = versionsClient.updateVersionAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
UpdateVersionRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Version,OperationMetadataV1> |
updateVersionCallable()
public final UnaryCallable<UpdateVersionRequest,Operation> updateVersionCallable()
Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:
**Standard environment**
*automatic scaling* in the standard environment:
automatic_scaling.min_idle_instances
automatic_scaling.max_idle_instances
automaticScaling.standard_scheduler_settings.max_instances
automaticScaling.standard_scheduler_settings.min_instances
automaticScaling.standard_scheduler_settings.target_cpu_utilization
automaticScaling.standard_scheduler_settings.target_throughput_utilization
*basic scaling* or *manual scaling* in the standard environment:
**Flexible environment**
*automatic scaling* in the flexible environment:
automatic_scaling.min_total_instances
automatic_scaling.max_total_instances
automatic_scaling.cool_down_period_sec
automatic_scaling.cpu_utilization.target_utilization
*manual scaling* in the flexible environment:
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 (VersionsClient versionsClient = VersionsClient.create()) {
UpdateVersionRequest request =
UpdateVersionRequest.newBuilder()
.setName("name3373707")
.setVersion(Version.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Operation> future = versionsClient.updateVersionCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<UpdateVersionRequest,Operation> |
updateVersionOperationCallable()
public final OperationCallable<UpdateVersionRequest,Version,OperationMetadataV1> updateVersionOperationCallable()
Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:
**Standard environment**
*automatic scaling* in the standard environment:
automatic_scaling.min_idle_instances
automatic_scaling.max_idle_instances
automaticScaling.standard_scheduler_settings.max_instances
automaticScaling.standard_scheduler_settings.min_instances
automaticScaling.standard_scheduler_settings.target_cpu_utilization
automaticScaling.standard_scheduler_settings.target_throughput_utilization
*basic scaling* or *manual scaling* in the standard environment:
**Flexible environment**
*automatic scaling* in the flexible environment:
automatic_scaling.min_total_instances
automatic_scaling.max_total_instances
automatic_scaling.cool_down_period_sec
automatic_scaling.cpu_utilization.target_utilization
*manual scaling* in the flexible environment:
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 (VersionsClient versionsClient = VersionsClient.create()) {
UpdateVersionRequest request =
UpdateVersionRequest.newBuilder()
.setName("name3373707")
.setVersion(Version.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
OperationFuture<Version, OperationMetadataV1> future =
versionsClient.updateVersionOperationCallable().futureCall(request);
// Do something.
Version response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<UpdateVersionRequest,Version,OperationMetadataV1> |