ImageVersionsClient (Google Cloud Composer 1.32.0 API)

java.lang.Object
- com.google.cloud.orchestration.airflow.service.v1.ImageVersionsClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class ImageVersionsClient
extends Object
implements com.google.api.gax.core.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:

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImageVersionsClient.ListImageVersionsFixedSizeCollection`
`static class`	`ImageVersionsClient.ListImageVersionsPage`
`static class`	`ImageVersionsClient.ListImageVersionsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ImageVersionsClient(ImageVersionsSettings settings)` Constructs an instance of ImageVersionsClient, using the given settings.
`protected`	`ImageVersionsClient(ImageVersionsStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static ImageVersionsClient`	`create()` Constructs an instance of ImageVersionsClient with default settings.
`static ImageVersionsClient`	`create(ImageVersionsSettings settings)` Constructs an instance of ImageVersionsClient, using the given settings.
`static ImageVersionsClient`	`create(ImageVersionsStub stub)` Constructs an instance of ImageVersionsClient, using the given stub for making calls.
`ImageVersionsSettings`	`getSettings()`
`ImageVersionsStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`ImageVersionsClient.ListImageVersionsPagedResponse`	`listImageVersions(ListImageVersionsRequest request)` List ImageVersions for provided location.
`ImageVersionsClient.ListImageVersionsPagedResponse`	`listImageVersions(String parent)` List ImageVersions for provided location.
`com.google.api.gax.rpc.UnaryCallable<ListImageVersionsRequest,ListImageVersionsResponse>`	`listImageVersionsCallable()` List ImageVersions for provided location.
`com.google.api.gax.rpc.UnaryCallable<ListImageVersionsRequest,ImageVersionsClient.ListImageVersionsPagedResponse>`	`listImageVersionsPagedCallable()` List ImageVersions for provided 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
- ImageVersionsClient
```
protected ImageVersionsClient(ImageVersionsSettings settings)
                       throws IOException
```
  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.
  
  Throws:
  
  IOException
- ImageVersionsClient
```
protected ImageVersionsClient(ImageVersionsStub stub)
```

Method Detail

create

public static final ImageVersionsClient create()
                                        throws IOException

Constructs an instance of ImageVersionsClient with default settings.

Throws:: IOException

create
```
public static final ImageVersionsClient create(ImageVersionsSettings settings)
                                        throws IOException
```
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.

Throws:

IOException

create
```
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).

getSettings

public final ImageVersionsSettings getSettings()

getStub
```
public ImageVersionsStub getStub()
```

listImageVersions

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);
   }
 }

Parameters:: parent - List ImageVersions in the given project and location, in the form: "projects/{projectId}/locations/{locationId}"
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listImageVersions

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);
   }
 }

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

listImageVersionsPagedCallable

public final com.google.api.gax.rpc.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);
   }
 }

listImageVersionsCallable

public final com.google.api.gax.rpc.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;
     }
   }
 }

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

Class ImageVersionsClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ImageVersionsClient

ImageVersionsClient

Method Detail

create

create

create

getSettings

getStub

listImageVersions

listImageVersions

listImageVersionsPagedCallable

listImageVersionsCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination