com.google.cloud.compute.v1

Class ImageFamilyViewsClient

java.lang.Object

com.google.cloud.compute.v1.ImageFamilyViewsClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class ImageFamilyViewsClient
extends Object
implements com.google.api.gax.core.BackgroundResource

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

Methods

Method	Description	Method Variants
Get	Returns the latest image that is part of an image family, is not deprecated and is rolled out in the specified zone.	Request object method variants only take one parameter, a request object, which must be constructed before the call. get(GetImageFamilyViewRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. get(String project, String zone, String family) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getCallable()

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.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ImageFamilyViewsClient(ImageFamilyViewsSettings settings) Constructs an instance of ImageFamilyViewsClient, using the given settings.
protected	ImageFamilyViewsClient(ImageFamilyViewsStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static ImageFamilyViewsClient	create() Constructs an instance of ImageFamilyViewsClient with default settings.
static ImageFamilyViewsClient	create(ImageFamilyViewsSettings settings) Constructs an instance of ImageFamilyViewsClient, using the given settings.
static ImageFamilyViewsClient	create(ImageFamilyViewsStub stub) Constructs an instance of ImageFamilyViewsClient, using the given stub for making calls.
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.
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.
com.google.api.gax.rpc.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.
ImageFamilyViewsSettings	getSettings()
ImageFamilyViewsStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImageFamilyViewsClient

protected ImageFamilyViewsClient(ImageFamilyViewsSettings settings)
                          throws IOException

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.

Throws:

IOException

ImageFamilyViewsClient

protected ImageFamilyViewsClient(ImageFamilyViewsStub stub)

Method Detail

create

public static final ImageFamilyViewsClient create()
                                           throws IOException

Constructs an instance of ImageFamilyViewsClient with default settings.

Throws:

IOException

create

public static final ImageFamilyViewsClient create(ImageFamilyViewsSettings settings)
                                           throws IOException

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.

Throws:

IOException

create

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

getSettings

public final ImageFamilyViewsSettings getSettings()

getStub

public ImageFamilyViewsStub getStub()

get

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:

project - Project ID for this request.

zone - The name of the zone for this request.

family - Name of the image family to search for.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

get

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

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

getCallable

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

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