Class ImageVersionsClient (1.27.0) 

public class ImageVersionsClient implements BackgroundResource

Service Description: Readonly service to query available ImageVersions.

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 (ImageVersionsClient imageVersionsClient = ImageVersionsClient.create()) {
   String parent = "parent-995424086";
   for (ImageVersion element : imageVersionsClient.listImageVersions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Note: close() needs to be called on the ImageVersionsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns 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 ImageVersionsSettings 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
 ImageVersionsSettings imageVersionsSettings =
     ImageVersionsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ImageVersionsClient imageVersionsClient = ImageVersionsClient.create(imageVersionsSettings);

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
 ImageVersionsSettings imageVersionsSettings =
     ImageVersionsSettings.newBuilder().setEndpoint(myEndpoint).build();
 ImageVersionsClient imageVersionsClient = ImageVersionsClient.create(imageVersionsSettings);

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
 ImageVersionsSettings imageVersionsSettings =
     ImageVersionsSettings.newHttpJsonBuilder().build();
 ImageVersionsClient imageVersionsClient = ImageVersionsClient.create(imageVersionsSettings);

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

Inheritance

java.lang.Object > ImageVersionsClient

Implements

BackgroundResource

Static Methods

create()

public static final ImageVersionsClient create()

Constructs an instance of ImageVersionsClient with default settings.

Returns
Type Description
ImageVersionsClient
Exceptions
Type Description
IOException

create(ImageVersionsSettings settings)

public static final ImageVersionsClient create(ImageVersionsSettings settings)

Constructs an instance of ImageVersionsClient, 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 ImageVersionsSettings
Returns
Type Description
ImageVersionsClient
Exceptions
Type Description
IOException

create(ImageVersionsStub stub)

public static final ImageVersionsClient create(ImageVersionsStub stub)

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

Parameter
Name Description
stub ImageVersionsStub
Returns
Type Description
ImageVersionsClient

Constructors

ImageVersionsClient(ImageVersionsSettings settings)

protected ImageVersionsClient(ImageVersionsSettings settings)

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

ImageVersionsClient(ImageVersionsStub stub)

protected ImageVersionsClient(ImageVersionsStub stub)
Parameter
Name Description
stub ImageVersionsStub

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

getSettings()

public final ImageVersionsSettings getSettings()
Returns
Type Description
ImageVersionsSettings

getStub()

public ImageVersionsStub getStub()
Returns
Type Description
ImageVersionsStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listImageVersions(ListImageVersionsRequest request)

public final ImageVersionsClient.ListImageVersionsPagedResponse listImageVersions(ListImageVersionsRequest request)

List ImageVersions for provided location.

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 (ImageVersionsClient imageVersionsClient = ImageVersionsClient.create()) {
   ListImageVersionsRequest request =
       ListImageVersionsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setIncludePastReleases(true)
           .build();
   for (ImageVersion element : imageVersionsClient.listImageVersions(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListImageVersionsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ImageVersionsClient.ListImageVersionsPagedResponse

listImageVersions(String parent)

public final ImageVersionsClient.ListImageVersionsPagedResponse listImageVersions(String parent)

List ImageVersions for provided location.

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 (ImageVersionsClient imageVersionsClient = ImageVersionsClient.create()) {
   String parent = "parent-995424086";
   for (ImageVersion element : imageVersionsClient.listImageVersions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

List ImageVersions in the given project and location, in the form: "projects/{projectId}/locations/{locationId}"
Returns
Type Description
ImageVersionsClient.ListImageVersionsPagedResponse

listImageVersionsCallable()

public final UnaryCallable<ListImageVersionsRequest,ListImageVersionsResponse> listImageVersionsCallable()

List ImageVersions for provided location.

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 (ImageVersionsClient imageVersionsClient = ImageVersionsClient.create()) {
   ListImageVersionsRequest request =
       ListImageVersionsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setIncludePastReleases(true)
           .build();
   while (true) {
     ListImageVersionsResponse response =
         imageVersionsClient.listImageVersionsCallable().call(request);
     for (ImageVersion element : response.getImageVersionsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListImageVersionsRequest,ListImageVersionsResponse>

listImageVersionsPagedCallable()

public final UnaryCallable<ListImageVersionsRequest,ImageVersionsClient.ListImageVersionsPagedResponse> listImageVersionsPagedCallable()

List ImageVersions for provided location.

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 (ImageVersionsClient imageVersionsClient = ImageVersionsClient.create()) {
   ListImageVersionsRequest request =
       ListImageVersionsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setIncludePastReleases(true)
           .build();
   ApiFuture<ImageVersion> future =
       imageVersionsClient.listImageVersionsPagedCallable().futureCall(request);
   // Do something.
   for (ImageVersion element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListImageVersionsRequest,ListImageVersionsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()