com.google.cloud.compute.v1

Class ImageClient

java.lang.Object

com.google.cloud.compute.v1.ImageClient

All Implemented Interfaces:

BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
public class ImageClient
extends Object
implements BackgroundResource

Service Description: Creates and runs virtual machines on Google Cloud Platform.

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 (ImageClient imageClient = ImageClient.create()) {
   ProjectGlobalImageName image = ProjectGlobalImageName.of("[PROJECT]", "[IMAGE]");
   Operation response = imageClient.deleteImage(image);
 }
 
 

Note: close() needs to be called on the imageClient 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 ImageSettings to create(). For example:

To customize credentials:

 
 ImageSettings imageSettings =
     ImageSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ImageClient imageClient =
     ImageClient.create(imageSettings);
 
 

To customize the endpoint:

 
 ImageSettings imageSettings =
     ImageSettings.newBuilder().setEndpoint(myEndpoint).build();
 ImageClient imageClient =
     ImageClient.create(imageSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImageClient.ListImagesFixedSizeCollection
static class	ImageClient.ListImagesPage
static class	ImageClient.ListImagesPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ImageClient(ImageSettings settings) Constructs an instance of ImageClient, using the given settings.
protected	ImageClient(ImageStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static ImageClient	create() Constructs an instance of ImageClient with default settings.
static ImageClient	create(ImageSettings settings) Constructs an instance of ImageClient, using the given settings.
static ImageClient	create(ImageStub stub) Constructs an instance of ImageClient, using the given stub for making calls.
Operation	deleteImage(DeleteImageHttpRequest request) Deletes the specified image.
Operation	deleteImage(ProjectGlobalImageName image) Deletes the specified image.
Operation	deleteImage(String image) Deletes the specified image.
UnaryCallable<DeleteImageHttpRequest,Operation>	deleteImageCallable() Deletes the specified image.
Operation	deprecateImage(DeprecateImageHttpRequest request) Sets the deprecation status of an image.
Operation	deprecateImage(ProjectGlobalImageName image, DeprecationStatus deprecationStatusResource) Sets the deprecation status of an image.
Operation	deprecateImage(String image, DeprecationStatus deprecationStatusResource) Sets the deprecation status of an image.
UnaryCallable<DeprecateImageHttpRequest,Operation>	deprecateImageCallable() Sets the deprecation status of an image.
Image	getFromFamilyImage(GetFromFamilyImageHttpRequest request) Returns the latest image that is part of an image family and is not deprecated.
Image	getFromFamilyImage(ProjectGlobalImageFamilyName family) Returns the latest image that is part of an image family and is not deprecated.
Image	getFromFamilyImage(String family) Returns the latest image that is part of an image family and is not deprecated.
UnaryCallable<GetFromFamilyImageHttpRequest,Image>	getFromFamilyImageCallable() Returns the latest image that is part of an image family and is not deprecated.
Policy	getIamPolicyImage(GetIamPolicyImageHttpRequest request) Gets the access control policy for a resource.
Policy	getIamPolicyImage(ProjectGlobalImageResourceName resource) Gets the access control policy for a resource.
Policy	getIamPolicyImage(String resource) Gets the access control policy for a resource.
UnaryCallable<GetIamPolicyImageHttpRequest,Policy>	getIamPolicyImageCallable() Gets the access control policy for a resource.
Image	getImage(GetImageHttpRequest request) Returns the specified image.
Image	getImage(ProjectGlobalImageName image) Returns the specified image.
Image	getImage(String image) Returns the specified image.
UnaryCallable<GetImageHttpRequest,Image>	getImageCallable() Returns the specified image.
ImageSettings	getSettings()
ImageStub	getStub()
Operation	insertImage(Boolean forceCreate, ProjectName project, Image imageResource) Creates an image in the specified project using the data included in the request.
Operation	insertImage(Boolean forceCreate, String project, Image imageResource) Creates an image in the specified project using the data included in the request.
Operation	insertImage(InsertImageHttpRequest request) Creates an image in the specified project using the data included in the request.
UnaryCallable<InsertImageHttpRequest,Operation>	insertImageCallable() Creates an image in the specified project using the data included in the request.
boolean	isShutdown()
boolean	isTerminated()
ImageClient.ListImagesPagedResponse	listImages(ListImagesHttpRequest request) Retrieves the list of custom images available to the specified project.
ImageClient.ListImagesPagedResponse	listImages(ProjectName project) Retrieves the list of custom images available to the specified project.
ImageClient.ListImagesPagedResponse	listImages(String project) Retrieves the list of custom images available to the specified project.
UnaryCallable<ListImagesHttpRequest,ImageList>	listImagesCallable() Retrieves the list of custom images available to the specified project.
UnaryCallable<ListImagesHttpRequest,ImageClient.ListImagesPagedResponse>	listImagesPagedCallable() Retrieves the list of custom images available to the specified project.
Policy	setIamPolicyImage(ProjectGlobalImageResourceName resource, GlobalSetPolicyRequest globalSetPolicyRequestResource) Sets the access control policy on the specified resource.
Policy	setIamPolicyImage(SetIamPolicyImageHttpRequest request) Sets the access control policy on the specified resource.
Policy	setIamPolicyImage(String resource, GlobalSetPolicyRequest globalSetPolicyRequestResource) Sets the access control policy on the specified resource.
UnaryCallable<SetIamPolicyImageHttpRequest,Policy>	setIamPolicyImageCallable() Sets the access control policy on the specified resource.
Operation	setLabelsImage(ProjectGlobalImageResourceName resource, GlobalSetLabelsRequest globalSetLabelsRequestResource) Sets the labels on an image.
Operation	setLabelsImage(SetLabelsImageHttpRequest request) Sets the labels on an image.
Operation	setLabelsImage(String resource, GlobalSetLabelsRequest globalSetLabelsRequestResource) Sets the labels on an image.
UnaryCallable<SetLabelsImageHttpRequest,Operation>	setLabelsImageCallable() Sets the labels on an image.
void	shutdown()
void	shutdownNow()
TestPermissionsResponse	testIamPermissionsImage(ProjectGlobalImageResourceName resource, TestPermissionsRequest testPermissionsRequestResource) Returns permissions that a caller has on the specified resource.
TestPermissionsResponse	testIamPermissionsImage(String resource, TestPermissionsRequest testPermissionsRequestResource) Returns permissions that a caller has on the specified resource.
TestPermissionsResponse	testIamPermissionsImage(TestIamPermissionsImageHttpRequest request) Returns permissions that a caller has on the specified resource.
UnaryCallable<TestIamPermissionsImageHttpRequest,TestPermissionsResponse>	testIamPermissionsImageCallable() Returns permissions that a caller has on the specified resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageClient

protected ImageClient(ImageSettings settings)
               throws IOException

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

ImageClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected ImageClient(ImageStub stub)

Method Detail

create

public static final ImageClient create()
                                throws IOException

Constructs an instance of ImageClient with default settings.

Throws:

IOException

create

public static final ImageClient create(ImageSettings settings)
                                throws IOException

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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final ImageClient create(ImageStub stub)

Constructs an instance of ImageClient, using the given stub for making calls. This is for advanced usage - prefer to use ImageSettings}.

getSettings

public final ImageSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public ImageStub getStub()

deleteImage

@BetaApi
public final Operation deleteImage(ProjectGlobalImageName image)

Deletes the specified image.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   ProjectGlobalImageName image = ProjectGlobalImageName.of("[PROJECT]", "[IMAGE]");
   Operation response = imageClient.deleteImage(image);
 }
 

Parameters:

image - Name of the image resource to delete.

Throws:

ApiException - if the remote call fails

deleteImage

@BetaApi
public final Operation deleteImage(String image)

Deletes the specified image.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   ProjectGlobalImageName image = ProjectGlobalImageName.of("[PROJECT]", "[IMAGE]");
   Operation response = imageClient.deleteImage(image.toString());
 }
 

Parameters:

image - Name of the image resource to delete.

Throws:

ApiException - if the remote call fails

deleteImage

@BetaApi
public final Operation deleteImage(DeleteImageHttpRequest request)

Deletes the specified image.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   String formattedImage = ProjectGlobalImageName.format("[PROJECT]", "[IMAGE]");
   DeleteImageHttpRequest request = DeleteImageHttpRequest.newBuilder()
     .setImage(formattedImage)
     .build();
   Operation response = imageClient.deleteImage(request);
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

deleteImageCallable

@BetaApi
public final UnaryCallable<DeleteImageHttpRequest,Operation> deleteImageCallable()

Deletes the specified image.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   String formattedImage = ProjectGlobalImageName.format("[PROJECT]", "[IMAGE]");
   DeleteImageHttpRequest request = DeleteImageHttpRequest.newBuilder()
     .setImage(formattedImage)
     .build();
   ApiFuture<Operation> future = imageClient.deleteImageCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

deprecateImage

@BetaApi
public final Operation deprecateImage(ProjectGlobalImageName image,
                                               DeprecationStatus deprecationStatusResource)

Sets the deprecation status of an image.

If an empty request body is given, clears the deprecation status instead.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   ProjectGlobalImageName image = ProjectGlobalImageName.of("[PROJECT]", "[IMAGE]");
   DeprecationStatus deprecationStatusResource = DeprecationStatus.newBuilder().build();
   Operation response = imageClient.deprecateImage(image, deprecationStatusResource);
 }
 

Parameters:

image - Image name.

deprecationStatusResource - Deprecation status for a public resource.

Throws:

ApiException - if the remote call fails

deprecateImage

@BetaApi
public final Operation deprecateImage(String image,
                                               DeprecationStatus deprecationStatusResource)

Sets the deprecation status of an image.

If an empty request body is given, clears the deprecation status instead.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   ProjectGlobalImageName image = ProjectGlobalImageName.of("[PROJECT]", "[IMAGE]");
   DeprecationStatus deprecationStatusResource = DeprecationStatus.newBuilder().build();
   Operation response = imageClient.deprecateImage(image.toString(), deprecationStatusResource);
 }
 

Parameters:

image - Image name.

deprecationStatusResource - Deprecation status for a public resource.

Throws:

ApiException - if the remote call fails

deprecateImage

@BetaApi
public final Operation deprecateImage(DeprecateImageHttpRequest request)

Sets the deprecation status of an image.

If an empty request body is given, clears the deprecation status instead.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   String formattedImage = ProjectGlobalImageName.format("[PROJECT]", "[IMAGE]");
   DeprecationStatus deprecationStatusResource = DeprecationStatus.newBuilder().build();
   DeprecateImageHttpRequest request = DeprecateImageHttpRequest.newBuilder()
     .setImage(formattedImage)
     .setDeprecationStatusResource(deprecationStatusResource)
     .build();
   Operation response = imageClient.deprecateImage(request);
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

deprecateImageCallable

@BetaApi
public final UnaryCallable<DeprecateImageHttpRequest,Operation> deprecateImageCallable()

Sets the deprecation status of an image.

If an empty request body is given, clears the deprecation status instead.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   String formattedImage = ProjectGlobalImageName.format("[PROJECT]", "[IMAGE]");
   DeprecationStatus deprecationStatusResource = DeprecationStatus.newBuilder().build();
   DeprecateImageHttpRequest request = DeprecateImageHttpRequest.newBuilder()
     .setImage(formattedImage)
     .setDeprecationStatusResource(deprecationStatusResource)
     .build();
   ApiFuture<Operation> future = imageClient.deprecateImageCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

getImage

@BetaApi
public final Image getImage(ProjectGlobalImageName image)

Returns the specified image. Gets a list of available images by making a list() request.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   ProjectGlobalImageName image = ProjectGlobalImageName.of("[PROJECT]", "[IMAGE]");
   Image response = imageClient.getImage(image);
 }
 

Parameters:

image - Name of the image resource to return.

Throws:

ApiException - if the remote call fails

getImage

@BetaApi
public final Image getImage(String image)

Returns the specified image. Gets a list of available images by making a list() request.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   ProjectGlobalImageName image = ProjectGlobalImageName.of("[PROJECT]", "[IMAGE]");
   Image response = imageClient.getImage(image.toString());
 }
 

Parameters:

image - Name of the image resource to return.

Throws:

ApiException - if the remote call fails

getImage

@BetaApi
public final Image getImage(GetImageHttpRequest request)

Returns the specified image. Gets a list of available images by making a list() request.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   String formattedImage = ProjectGlobalImageName.format("[PROJECT]", "[IMAGE]");
   GetImageHttpRequest request = GetImageHttpRequest.newBuilder()
     .setImage(formattedImage)
     .build();
   Image response = imageClient.getImage(request);
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

getImageCallable

@BetaApi
public final UnaryCallable<GetImageHttpRequest,Image> getImageCallable()

Returns the specified image. Gets a list of available images by making a list() request.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   String formattedImage = ProjectGlobalImageName.format("[PROJECT]", "[IMAGE]");
   GetImageHttpRequest request = GetImageHttpRequest.newBuilder()
     .setImage(formattedImage)
     .build();
   ApiFuture<Image> future = imageClient.getImageCallable().futureCall(request);
   // Do something
   Image response = future.get();
 }
 

getFromFamilyImage

@BetaApi
public final Image getFromFamilyImage(ProjectGlobalImageFamilyName family)

Returns the latest image that is part of an image family and is not deprecated.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   ProjectGlobalImageFamilyName family = ProjectGlobalImageFamilyName.of("[PROJECT]", "[FAMILY]");
   Image response = imageClient.getFromFamilyImage(family);
 }
 

Parameters:

family - Name of the image family to search for.

Throws:

ApiException - if the remote call fails

getFromFamilyImage

@BetaApi
public final Image getFromFamilyImage(String family)

Returns the latest image that is part of an image family and is not deprecated.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   ProjectGlobalImageFamilyName family = ProjectGlobalImageFamilyName.of("[PROJECT]", "[FAMILY]");
   Image response = imageClient.getFromFamilyImage(family.toString());
 }
 

Parameters:

family - Name of the image family to search for.

Throws:

ApiException - if the remote call fails

getFromFamilyImage

@BetaApi
public final Image getFromFamilyImage(GetFromFamilyImageHttpRequest request)

Returns the latest image that is part of an image family and is not deprecated.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   String formattedFamily = ProjectGlobalImageFamilyName.format("[PROJECT]", "[FAMILY]");
   GetFromFamilyImageHttpRequest request = GetFromFamilyImageHttpRequest.newBuilder()
     .setFamily(formattedFamily)
     .build();
   Image response = imageClient.getFromFamilyImage(request);
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

getFromFamilyImageCallable

@BetaApi
public final UnaryCallable<GetFromFamilyImageHttpRequest,Image> getFromFamilyImageCallable()

Returns the latest image that is part of an image family and is not deprecated.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   String formattedFamily = ProjectGlobalImageFamilyName.format("[PROJECT]", "[FAMILY]");
   GetFromFamilyImageHttpRequest request = GetFromFamilyImageHttpRequest.newBuilder()
     .setFamily(formattedFamily)
     .build();
   ApiFuture<Image> future = imageClient.getFromFamilyImageCallable().futureCall(request);
   // Do something
   Image response = future.get();
 }
 

getIamPolicyImage

@BetaApi
public final Policy getIamPolicyImage(ProjectGlobalImageResourceName resource)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   ProjectGlobalImageResourceName resource = ProjectGlobalImageResourceName.of("[PROJECT]", "[RESOURCE]");
   Policy response = imageClient.getIamPolicyImage(resource);
 }
 

Parameters:

resource - Name or id of the resource for this request.

Throws:

ApiException - if the remote call fails

getIamPolicyImage

@BetaApi
public final Policy getIamPolicyImage(String resource)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   ProjectGlobalImageResourceName resource = ProjectGlobalImageResourceName.of("[PROJECT]", "[RESOURCE]");
   Policy response = imageClient.getIamPolicyImage(resource.toString());
 }
 

Parameters:

resource - Name or id of the resource for this request.

Throws:

ApiException - if the remote call fails

getIamPolicyImage

@BetaApi
public final Policy getIamPolicyImage(GetIamPolicyImageHttpRequest request)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   String formattedResource = ProjectGlobalImageResourceName.format("[PROJECT]", "[RESOURCE]");
   GetIamPolicyImageHttpRequest request = GetIamPolicyImageHttpRequest.newBuilder()
     .setResource(formattedResource)
     .build();
   Policy response = imageClient.getIamPolicyImage(request);
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

getIamPolicyImageCallable

@BetaApi
public final UnaryCallable<GetIamPolicyImageHttpRequest,Policy> getIamPolicyImageCallable()

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   String formattedResource = ProjectGlobalImageResourceName.format("[PROJECT]", "[RESOURCE]");
   GetIamPolicyImageHttpRequest request = GetIamPolicyImageHttpRequest.newBuilder()
     .setResource(formattedResource)
     .build();
   ApiFuture<Policy> future = imageClient.getIamPolicyImageCallable().futureCall(request);
   // Do something
   Policy response = future.get();
 }
 

insertImage

@BetaApi
public final Operation insertImage(Boolean forceCreate,
                                            ProjectName project,
                                            Image imageResource)

Creates an image in the specified project using the data included in the request.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   Boolean forceCreate = false;
   ProjectName project = ProjectName.of("[PROJECT]");
   Image imageResource = Image.newBuilder().build();
   Operation response = imageClient.insertImage(forceCreate, project, imageResource);
 }
 

Parameters:

forceCreate - Force image creation if true.

project - Project ID for this request.

imageResource - An Image resource. (== resource_for beta.images ==) (== resource_for v1.images ==)

Throws:

ApiException - if the remote call fails

insertImage

@BetaApi
public final Operation insertImage(Boolean forceCreate,
                                            String project,
                                            Image imageResource)

Creates an image in the specified project using the data included in the request.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   Boolean forceCreate = false;
   ProjectName project = ProjectName.of("[PROJECT]");
   Image imageResource = Image.newBuilder().build();
   Operation response = imageClient.insertImage(forceCreate, project.toString(), imageResource);
 }
 

Parameters:

forceCreate - Force image creation if true.

project - Project ID for this request.

imageResource - An Image resource. (== resource_for beta.images ==) (== resource_for v1.images ==)

Throws:

ApiException - if the remote call fails

insertImage

@BetaApi
public final Operation insertImage(InsertImageHttpRequest request)

Creates an image in the specified project using the data included in the request.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   Boolean forceCreate = false;
   String formattedProject = ProjectName.format("[PROJECT]");
   Image imageResource = Image.newBuilder().build();
   InsertImageHttpRequest request = InsertImageHttpRequest.newBuilder()
     .setForceCreate(forceCreate)
     .setProject(formattedProject)
     .setImageResource(imageResource)
     .build();
   Operation response = imageClient.insertImage(request);
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

insertImageCallable

@BetaApi
public final UnaryCallable<InsertImageHttpRequest,Operation> insertImageCallable()

Creates an image in the specified project using the data included in the request.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   Boolean forceCreate = false;
   String formattedProject = ProjectName.format("[PROJECT]");
   Image imageResource = Image.newBuilder().build();
   InsertImageHttpRequest request = InsertImageHttpRequest.newBuilder()
     .setForceCreate(forceCreate)
     .setProject(formattedProject)
     .setImageResource(imageResource)
     .build();
   ApiFuture<Operation> future = imageClient.insertImageCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

listImages

@BetaApi
public final ImageClient.ListImagesPagedResponse listImages(ProjectName project)

Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (Image element : imageClient.listImages(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

ApiException - if the remote call fails

listImages

@BetaApi
public final ImageClient.ListImagesPagedResponse listImages(String project)

Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (Image element : imageClient.listImages(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

ApiException - if the remote call fails

listImages

@BetaApi
public final ImageClient.ListImagesPagedResponse listImages(ListImagesHttpRequest request)

Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListImagesHttpRequest request = ListImagesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (Image element : imageClient.listImages(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

listImagesPagedCallable

@BetaApi
public final UnaryCallable<ListImagesHttpRequest,ImageClient.ListImagesPagedResponse> listImagesPagedCallable()

Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListImagesHttpRequest request = ListImagesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<ListImagesPagedResponse> future = imageClient.listImagesPagedCallable().futureCall(request);
   // Do something
   for (Image element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listImagesCallable

@BetaApi
public final UnaryCallable<ListImagesHttpRequest,ImageList> listImagesCallable()

Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListImagesHttpRequest request = ListImagesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     ImageList response = imageClient.listImagesCallable().call(request);
     for (Image element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

setIamPolicyImage

@BetaApi
public final Policy setIamPolicyImage(ProjectGlobalImageResourceName resource,
                                               GlobalSetPolicyRequest globalSetPolicyRequestResource)

Sets the access control policy on the specified resource. Replaces any existing policy.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   ProjectGlobalImageResourceName resource = ProjectGlobalImageResourceName.of("[PROJECT]", "[RESOURCE]");
   GlobalSetPolicyRequest globalSetPolicyRequestResource = GlobalSetPolicyRequest.newBuilder().build();
   Policy response = imageClient.setIamPolicyImage(resource, globalSetPolicyRequestResource);
 }
 

Parameters:

resource - Name or id of the resource for this request.

globalSetPolicyRequestResource -

Throws:

ApiException - if the remote call fails

setIamPolicyImage

@BetaApi
public final Policy setIamPolicyImage(String resource,
                                               GlobalSetPolicyRequest globalSetPolicyRequestResource)

Sets the access control policy on the specified resource. Replaces any existing policy.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   ProjectGlobalImageResourceName resource = ProjectGlobalImageResourceName.of("[PROJECT]", "[RESOURCE]");
   GlobalSetPolicyRequest globalSetPolicyRequestResource = GlobalSetPolicyRequest.newBuilder().build();
   Policy response = imageClient.setIamPolicyImage(resource.toString(), globalSetPolicyRequestResource);
 }
 

Parameters:

resource - Name or id of the resource for this request.

globalSetPolicyRequestResource -

Throws:

ApiException - if the remote call fails

setIamPolicyImage

@BetaApi
public final Policy setIamPolicyImage(SetIamPolicyImageHttpRequest request)

Sets the access control policy on the specified resource. Replaces any existing policy.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   String formattedResource = ProjectGlobalImageResourceName.format("[PROJECT]", "[RESOURCE]");
   GlobalSetPolicyRequest globalSetPolicyRequestResource = GlobalSetPolicyRequest.newBuilder().build();
   SetIamPolicyImageHttpRequest request = SetIamPolicyImageHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setGlobalSetPolicyRequestResource(globalSetPolicyRequestResource)
     .build();
   Policy response = imageClient.setIamPolicyImage(request);
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

setIamPolicyImageCallable

@BetaApi
public final UnaryCallable<SetIamPolicyImageHttpRequest,Policy> setIamPolicyImageCallable()

Sets the access control policy on the specified resource. Replaces any existing policy.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   String formattedResource = ProjectGlobalImageResourceName.format("[PROJECT]", "[RESOURCE]");
   GlobalSetPolicyRequest globalSetPolicyRequestResource = GlobalSetPolicyRequest.newBuilder().build();
   SetIamPolicyImageHttpRequest request = SetIamPolicyImageHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setGlobalSetPolicyRequestResource(globalSetPolicyRequestResource)
     .build();
   ApiFuture<Policy> future = imageClient.setIamPolicyImageCallable().futureCall(request);
   // Do something
   Policy response = future.get();
 }
 

setLabelsImage

@BetaApi
public final Operation setLabelsImage(ProjectGlobalImageResourceName resource,
                                               GlobalSetLabelsRequest globalSetLabelsRequestResource)

Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   ProjectGlobalImageResourceName resource = ProjectGlobalImageResourceName.of("[PROJECT]", "[RESOURCE]");
   GlobalSetLabelsRequest globalSetLabelsRequestResource = GlobalSetLabelsRequest.newBuilder().build();
   Operation response = imageClient.setLabelsImage(resource, globalSetLabelsRequestResource);
 }
 

Parameters:

resource - Name or id of the resource for this request.

globalSetLabelsRequestResource -

Throws:

ApiException - if the remote call fails

setLabelsImage

@BetaApi
public final Operation setLabelsImage(String resource,
                                               GlobalSetLabelsRequest globalSetLabelsRequestResource)

Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   ProjectGlobalImageResourceName resource = ProjectGlobalImageResourceName.of("[PROJECT]", "[RESOURCE]");
   GlobalSetLabelsRequest globalSetLabelsRequestResource = GlobalSetLabelsRequest.newBuilder().build();
   Operation response = imageClient.setLabelsImage(resource.toString(), globalSetLabelsRequestResource);
 }
 

Parameters:

resource - Name or id of the resource for this request.

globalSetLabelsRequestResource -

Throws:

ApiException - if the remote call fails

setLabelsImage

@BetaApi
public final Operation setLabelsImage(SetLabelsImageHttpRequest request)

Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   String formattedResource = ProjectGlobalImageResourceName.format("[PROJECT]", "[RESOURCE]");
   GlobalSetLabelsRequest globalSetLabelsRequestResource = GlobalSetLabelsRequest.newBuilder().build();
   SetLabelsImageHttpRequest request = SetLabelsImageHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setGlobalSetLabelsRequestResource(globalSetLabelsRequestResource)
     .build();
   Operation response = imageClient.setLabelsImage(request);
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

setLabelsImageCallable

@BetaApi
public final UnaryCallable<SetLabelsImageHttpRequest,Operation> setLabelsImageCallable()

Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   String formattedResource = ProjectGlobalImageResourceName.format("[PROJECT]", "[RESOURCE]");
   GlobalSetLabelsRequest globalSetLabelsRequestResource = GlobalSetLabelsRequest.newBuilder().build();
   SetLabelsImageHttpRequest request = SetLabelsImageHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setGlobalSetLabelsRequestResource(globalSetLabelsRequestResource)
     .build();
   ApiFuture<Operation> future = imageClient.setLabelsImageCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

testIamPermissionsImage

@BetaApi
public final TestPermissionsResponse testIamPermissionsImage(ProjectGlobalImageResourceName resource,
                                                                      TestPermissionsRequest testPermissionsRequestResource)

Returns permissions that a caller has on the specified resource.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   ProjectGlobalImageResourceName resource = ProjectGlobalImageResourceName.of("[PROJECT]", "[RESOURCE]");
   TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build();
   TestPermissionsResponse response = imageClient.testIamPermissionsImage(resource, testPermissionsRequestResource);
 }
 

Parameters:

resource - Name or id of the resource for this request.

testPermissionsRequestResource -

Throws:

ApiException - if the remote call fails

testIamPermissionsImage

@BetaApi
public final TestPermissionsResponse testIamPermissionsImage(String resource,
                                                                      TestPermissionsRequest testPermissionsRequestResource)

Returns permissions that a caller has on the specified resource.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   ProjectGlobalImageResourceName resource = ProjectGlobalImageResourceName.of("[PROJECT]", "[RESOURCE]");
   TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build();
   TestPermissionsResponse response = imageClient.testIamPermissionsImage(resource.toString(), testPermissionsRequestResource);
 }
 

Parameters:

resource - Name or id of the resource for this request.

testPermissionsRequestResource -

Throws:

ApiException - if the remote call fails

testIamPermissionsImage

@BetaApi
public final TestPermissionsResponse testIamPermissionsImage(TestIamPermissionsImageHttpRequest request)

Returns permissions that a caller has on the specified resource.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   String formattedResource = ProjectGlobalImageResourceName.format("[PROJECT]", "[RESOURCE]");
   TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build();
   TestIamPermissionsImageHttpRequest request = TestIamPermissionsImageHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setTestPermissionsRequestResource(testPermissionsRequestResource)
     .build();
   TestPermissionsResponse response = imageClient.testIamPermissionsImage(request);
 }
 

Parameters:

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

Throws:

ApiException - if the remote call fails

testIamPermissionsImageCallable

@BetaApi
public final UnaryCallable<TestIamPermissionsImageHttpRequest,TestPermissionsResponse> testIamPermissionsImageCallable()

Returns permissions that a caller has on the specified resource.

Sample code:

 try (ImageClient imageClient = ImageClient.create()) {
   String formattedResource = ProjectGlobalImageResourceName.format("[PROJECT]", "[RESOURCE]");
   TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build();
   TestIamPermissionsImageHttpRequest request = TestIamPermissionsImageHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setTestPermissionsRequestResource(testPermissionsRequestResource)
     .build();
   ApiFuture<TestPermissionsResponse> future = imageClient.testIamPermissionsImageCallable().futureCall(request);
   // Do something
   TestPermissionsResponse response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface BackgroundResource

Throws:

InterruptedException