Class VersionsClient (2.44.0)

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(VersionsClientversionsClient=VersionsClient.create()){
GetVersionRequestrequest=
GetVersionRequest.newBuilder()
.setName("name3373707")
.setView(VersionView.forNumber(0))
.build();
Versionresponse=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().

Methods
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.

  • listVersions(ListVersionsRequest request)

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

  • listVersionsPagedCallable()

  • listVersionsCallable()

GetVersion

Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.

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

  • getVersion(GetVersionRequest request)

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

  • getVersionCallable()

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.

  • createVersionAsync(CreateVersionRequest request)

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

  • createVersionOperationCallable()

  • createVersionCallable()

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.

  • updateVersionAsync(UpdateVersionRequest request)

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

  • updateVersionOperationCallable()

  • updateVersionCallable()

DeleteVersion

Deletes an existing Version resource.

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

  • deleteVersionAsync(DeleteVersionRequest request)

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

  • deleteVersionOperationCallable()

  • deleteVersionCallable()

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
VersionsSettingsversionsSettings=
VersionsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
VersionsClientversionsClient=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
VersionsSettingsversionsSettings=
VersionsSettings.newBuilder().setEndpoint(myEndpoint).build();
VersionsClientversionsClient=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
VersionsSettingsversionsSettings=VersionsSettings.newHttpJsonBuilder().build();
VersionsClientversionsClient=VersionsClient.create(versionsSettings);

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

Inheritance

java.lang.Object > VersionsClient

Static Methods

create()

publicstaticfinalVersionsClientcreate()

Constructs an instance of VersionsClient with default settings.

Returns
Type Description
VersionsClient
Exceptions
Type Description
IOException

create(VersionsSettings settings)

publicstaticfinalVersionsClientcreate(VersionsSettingssettings)

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)

publicstaticfinalVersionsClientcreate(VersionsStubstub)

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)

protectedVersionsClient(VersionsSettingssettings)

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)

protectedVersionsClient(VersionsStubstub)
Parameter
Name Description
stub VersionsStub

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

createVersionAsync(CreateVersionRequest request)

publicfinalOperationFuture<Version,CreateVersionMetadataV1>createVersionAsync(CreateVersionRequestrequest)

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(VersionsClientversionsClient=VersionsClient.create()){
CreateVersionRequestrequest=
CreateVersionRequest.newBuilder()
.setParent("parent-995424086")
.setVersion(Version.newBuilder().build())
.build();
Versionresponse=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()

publicfinalUnaryCallable<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(VersionsClientversionsClient=VersionsClient.create()){
CreateVersionRequestrequest=
CreateVersionRequest.newBuilder()
.setParent("parent-995424086")
.setVersion(Version.newBuilder().build())
.build();
ApiFuture<Operation>future=versionsClient.createVersionCallable().futureCall(request);
// Do something.
Operationresponse=future.get();
}
Returns
Type Description
UnaryCallable<CreateVersionRequest,Operation>

createVersionOperationCallable()

publicfinalOperationCallable<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(VersionsClientversionsClient=VersionsClient.create()){
CreateVersionRequestrequest=
CreateVersionRequest.newBuilder()
.setParent("parent-995424086")
.setVersion(Version.newBuilder().build())
.build();
OperationFuture<Version,CreateVersionMetadataV1>future=
versionsClient.createVersionOperationCallable().futureCall(request);
// Do something.
Versionresponse=future.get();
}
Returns
Type Description
OperationCallable<CreateVersionRequest,Version,CreateVersionMetadataV1>

deleteVersionAsync(DeleteVersionRequest request)

publicfinalOperationFuture<Empty,OperationMetadataV1>deleteVersionAsync(DeleteVersionRequestrequest)

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(VersionsClientversionsClient=VersionsClient.create()){
DeleteVersionRequestrequest=
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()

publicfinalUnaryCallable<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(VersionsClientversionsClient=VersionsClient.create()){
DeleteVersionRequestrequest=
DeleteVersionRequest.newBuilder().setName("name3373707").build();
ApiFuture<Operation>future=versionsClient.deleteVersionCallable().futureCall(request);
// Do something.
future.get();
}
Returns
Type Description
UnaryCallable<DeleteVersionRequest,Operation>

deleteVersionOperationCallable()

publicfinalOperationCallable<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(VersionsClientversionsClient=VersionsClient.create()){
DeleteVersionRequestrequest=
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()

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

getSettings()

publicfinalVersionsSettingsgetSettings()
Returns
Type Description
VersionsSettings

getStub()

publicVersionsStubgetStub()
Returns
Type Description
VersionsStub

getVersion(GetVersionRequest request)

publicfinalVersiongetVersion(GetVersionRequestrequest)

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(VersionsClientversionsClient=VersionsClient.create()){
GetVersionRequestrequest=
GetVersionRequest.newBuilder()
.setName("name3373707")
.setView(VersionView.forNumber(0))
.build();
Versionresponse=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()

publicfinalUnaryCallable<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(VersionsClientversionsClient=VersionsClient.create()){
GetVersionRequestrequest=
GetVersionRequest.newBuilder()
.setName("name3373707")
.setView(VersionView.forNumber(0))
.build();
ApiFuture<Version>future=versionsClient.getVersionCallable().futureCall(request);
// Do something.
Versionresponse=future.get();
}
Returns
Type Description
UnaryCallable<GetVersionRequest,Version>

isShutdown()

publicbooleanisShutdown()
Returns
Type Description
boolean

isTerminated()

publicbooleanisTerminated()
Returns
Type Description
boolean

listVersions(ListVersionsRequest request)

publicfinalVersionsClient.ListVersionsPagedResponselistVersions(ListVersionsRequestrequest)

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(VersionsClientversionsClient=VersionsClient.create()){
ListVersionsRequestrequest=
ListVersionsRequest.newBuilder()
.setParent("parent-995424086")
.setView(VersionView.forNumber(0))
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for(Versionelement: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()

publicfinalUnaryCallable<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(VersionsClientversionsClient=VersionsClient.create()){
ListVersionsRequestrequest=
ListVersionsRequest.newBuilder()
.setParent("parent-995424086")
.setView(VersionView.forNumber(0))
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while(true){
ListVersionsResponseresponse=versionsClient.listVersionsCallable().call(request);
for(Versionelement:response.getVersionsList()){
// doThingsWith(element);
}
StringnextPageToken=response.getNextPageToken();
if(!Strings.isNullOrEmpty(nextPageToken)){
request=request.toBuilder().setPageToken(nextPageToken).build();
}else{
break;
}
}
}
Returns
Type Description
UnaryCallable<ListVersionsRequest,ListVersionsResponse>

listVersionsPagedCallable()

publicfinalUnaryCallable<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(VersionsClientversionsClient=VersionsClient.create()){
ListVersionsRequestrequest=
ListVersionsRequest.newBuilder()
.setParent("parent-995424086")
.setView(VersionView.forNumber(0))
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Version>future=versionsClient.listVersionsPagedCallable().futureCall(request);
// Do something.
for(Versionelement:future.get().iterateAll()){
// doThingsWith(element);
}
}
Returns
Type Description
UnaryCallable<ListVersionsRequest,ListVersionsPagedResponse>

shutdown()

publicvoidshutdown()

shutdownNow()

publicvoidshutdownNow()

updateVersionAsync(UpdateVersionRequest request)

publicfinalOperationFuture<Version,OperationMetadataV1>updateVersionAsync(UpdateVersionRequestrequest)

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:

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(VersionsClientversionsClient=VersionsClient.create()){
UpdateVersionRequestrequest=
UpdateVersionRequest.newBuilder()
.setName("name3373707")
.setVersion(Version.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Versionresponse=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()

publicfinalUnaryCallable<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:

*basic scaling* or *manual scaling* in the standard environment:

**Flexible environment**

*automatic scaling* in the flexible environment:

*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(VersionsClientversionsClient=VersionsClient.create()){
UpdateVersionRequestrequest=
UpdateVersionRequest.newBuilder()
.setName("name3373707")
.setVersion(Version.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Operation>future=versionsClient.updateVersionCallable().futureCall(request);
// Do something.
Operationresponse=future.get();
}
Returns
Type Description
UnaryCallable<UpdateVersionRequest,Operation>

updateVersionOperationCallable()

publicfinalOperationCallable<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:

*basic scaling* or *manual scaling* in the standard environment:

**Flexible environment**

*automatic scaling* in the flexible environment:

*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(VersionsClientversionsClient=VersionsClient.create()){
UpdateVersionRequestrequest=
UpdateVersionRequest.newBuilder()
.setName("name3373707")
.setVersion(Version.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
OperationFuture<Version,OperationMetadataV1>future=
versionsClient.updateVersionOperationCallable().futureCall(request);
// Do something.
Versionresponse=future.get();
}
Returns
Type Description
OperationCallable<UpdateVersionRequest,Version,OperationMetadataV1>

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.