Class ImageFamilyViewsClient (1.7.2)

Version 1.7.2

• 1.65.0 (latest)
• 1.64.0
• 1.63.0
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

public class ImageFamilyViewsClient implements 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:

 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:

 ImageFamilyViewsSettings imageFamilyViewsSettings =
     ImageFamilyViewsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ImageFamilyViewsClient imageFamilyViewsClient =
     ImageFamilyViewsClient.create(imageFamilyViewsSettings);
 

To customize the endpoint:

 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

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final ImageFamilyViewsClient create()

Constructs an instance of ImageFamilyViewsClient with default settings.

Returns

Type	Description
ImageFamilyViewsClient

Exceptions

Type	Description
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

Name	Description
settings	ImageFamilyViewsSettings

Returns

Type	Description
ImageFamilyViewsClient

Exceptions

Type	Description
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

Name	Description
stub	ImageFamilyViewsStub

Returns

Type	Description
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

Name	Description
settings	ImageFamilyViewsSettings

ImageFamilyViewsClient(ImageFamilyViewsStub stub)

protected ImageFamilyViewsClient(ImageFamilyViewsStub stub)

Parameter

Name	Description
stub	ImageFamilyViewsStub

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

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:

 try (ImageFamilyViewsClient imageFamilyViewsClient = ImageFamilyViewsClient.create()) {
   GetImageFamilyViewRequest request =
       GetImageFamilyViewRequest.newBuilder()
           .setFamily("family-1281860764")
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   ImageFamilyView response = imageFamilyViewsClient.get(request);
 }
 

Parameter

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

Returns

Type	Description
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:

 try (ImageFamilyViewsClient imageFamilyViewsClient = ImageFamilyViewsClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String family = "family-1281860764";
   ImageFamilyView response = imageFamilyViewsClient.get(project, zone, family);
 }
 

Parameters

Name	Description
project	String Project ID for this request.
zone	String The name of the zone for this request.
family	String Name of the image family to search for.

Returns

Type	Description
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:

 try (ImageFamilyViewsClient imageFamilyViewsClient = ImageFamilyViewsClient.create()) {
   GetImageFamilyViewRequest request =
       GetImageFamilyViewRequest.newBuilder()
           .setFamily("family-1281860764")
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<GetImageFamilyViewRequest,ImageFamilyView>

getSettings()

public final ImageFamilyViewsSettings getSettings()

Returns

Type	Description
ImageFamilyViewsSettings

getStub()

public ImageFamilyViewsStub getStub()

Returns

Type	Description
ImageFamilyViewsStub

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()