Class ImageFamilyViewsClient (1.40.0)

GitHub RepositoryProduct Reference

Service Description: The ImageFamilyViews 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 (ImageFamilyViewsClient imageFamilyViewsClient = ImageFamilyViewsClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String family = "family-1281860764";
   ImageFamilyView response = imageFamilyViewsClient.get(project, zone, family);
 }

Note: close() needs to be called on the ImageFamilyViewsClient 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 ImageFamilyViewsSettings 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
 ImageFamilyViewsSettings imageFamilyViewsSettings =
     ImageFamilyViewsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ImageFamilyViewsClient imageFamilyViewsClient =
     ImageFamilyViewsClient.create(imageFamilyViewsSettings);

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
 ImageFamilyViewsSettings imageFamilyViewsSettings =
     ImageFamilyViewsSettings.newBuilder().setEndpoint(myEndpoint).build();
 ImageFamilyViewsClient imageFamilyViewsClient =
     ImageFamilyViewsClient.create(imageFamilyViewsSettings);

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

Inheritance

java.lang.Object > ImageFamilyViewsClient

Static Methods

create()

public static final ImageFamilyViewsClient create()

Constructs an instance of ImageFamilyViewsClient with default settings.

Returns
TypeDescription
ImageFamilyViewsClient
Exceptions
TypeDescription
IOException

create(ImageFamilyViewsSettings settings)

public static final ImageFamilyViewsClient create(ImageFamilyViewsSettings settings)

Constructs an instance of ImageFamilyViewsClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
NameDescription
settingsImageFamilyViewsSettings
Returns
TypeDescription
ImageFamilyViewsClient
Exceptions
TypeDescription
IOException

create(ImageFamilyViewsStub stub)

public static final ImageFamilyViewsClient create(ImageFamilyViewsStub stub)

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

Parameter
NameDescription
stubImageFamilyViewsStub
Returns
TypeDescription
ImageFamilyViewsClient

Constructors

ImageFamilyViewsClient(ImageFamilyViewsSettings settings)

protected ImageFamilyViewsClient(ImageFamilyViewsSettings settings)

Constructs an instance of ImageFamilyViewsClient, 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
NameDescription
settingsImageFamilyViewsSettings

ImageFamilyViewsClient(ImageFamilyViewsStub stub)

protected ImageFamilyViewsClient(ImageFamilyViewsStub stub)
Parameter
NameDescription
stubImageFamilyViewsStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

close()

public final void close()

get(GetImageFamilyViewRequest request)

public final ImageFamilyView get(GetImageFamilyViewRequest request)

Returns the latest image that is part of an image family, is not deprecated and is rolled out in the specified zone.

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 (ImageFamilyViewsClient imageFamilyViewsClient = ImageFamilyViewsClient.create()) {
   GetImageFamilyViewRequest request =
       GetImageFamilyViewRequest.newBuilder()
           .setFamily("family-1281860764")
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   ImageFamilyView response = imageFamilyViewsClient.get(request);
 }
Parameter
NameDescription
requestGetImageFamilyViewRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
ImageFamilyView

get(String project, String zone, String family)

public final ImageFamilyView get(String project, String zone, String family)

Returns the latest image that is part of an image family, is not deprecated and is rolled out in the specified zone.

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 (ImageFamilyViewsClient imageFamilyViewsClient = ImageFamilyViewsClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String family = "family-1281860764";
   ImageFamilyView response = imageFamilyViewsClient.get(project, zone, family);
 }
Parameters
NameDescription
projectString

Project ID for this request.

zoneString

The name of the zone for this request.

familyString

Name of the image family to search for.

Returns
TypeDescription
ImageFamilyView

getCallable()

public final UnaryCallable<GetImageFamilyViewRequest,ImageFamilyView> getCallable()

Returns the latest image that is part of an image family, is not deprecated and is rolled out in the specified zone.

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 (ImageFamilyViewsClient imageFamilyViewsClient = ImageFamilyViewsClient.create()) {
   GetImageFamilyViewRequest request =
       GetImageFamilyViewRequest.newBuilder()
           .setFamily("family-1281860764")
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   ApiFuture<ImageFamilyView> future = imageFamilyViewsClient.getCallable().futureCall(request);
   // Do something.
   ImageFamilyView response = future.get();
 }
Returns
TypeDescription
UnaryCallable<GetImageFamilyViewRequest,ImageFamilyView>

getSettings()

public final ImageFamilyViewsSettings getSettings()
Returns
TypeDescription
ImageFamilyViewsSettings

getStub()

public ImageFamilyViewsStub getStub()
Returns
TypeDescription
ImageFamilyViewsStub

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()