Class MachineImagesClient (1.49.0)

Version 1.49.0

• 1.63.0 (latest)
• 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

GitHub Repository

Product Reference

Service Description: The MachineImages 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 (MachineImagesClient machineImagesClient = MachineImagesClient.create()) {
   String project = "project-309310695";
   String machineImage = "machineImage1817774420";
   MachineImage response = machineImagesClient.get(project, machineImage);
 }
 

Note: close() needs to be called on the MachineImagesClient 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
Delete	Deletes the specified machine image. Deleting a machine image is permanent and cannot be undone.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteAsync(DeleteMachineImageRequest request) Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service. deleteAsync(String project, String machineImage) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteOperationCallable() deleteCallable()
Get	Returns the specified machine image.	Request object method variants only take one parameter, a request object, which must be constructed before the call. get(GetMachineImageRequest 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 machineImage) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getCallable()
GetIamPolicy	Gets the access control policy for a resource. May be empty if no such policy or resource exists.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getIamPolicy(GetIamPolicyMachineImageRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getIamPolicy(String project, String resource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getIamPolicyCallable()
Insert	Creates a machine image in the specified project using the data that is included in the request. If you are creating a new machine image to update an existing instance, your new machine image should use the same network or, if applicable, the same subnetwork as the original instance.	Request object method variants only take one parameter, a request object, which must be constructed before the call. insertAsync(InsertMachineImageRequest request) Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service. insertAsync(String project, MachineImage machineImageResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. insertOperationCallable() insertCallable()
List	Retrieves a list of machine images that are contained within the specified project.	Request object method variants only take one parameter, a request object, which must be constructed before the call. list(ListMachineImagesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. list(String project) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listPagedCallable() listCallable()
SetIamPolicy	Sets the access control policy on the specified resource. Replaces any existing policy.	Request object method variants only take one parameter, a request object, which must be constructed before the call. setIamPolicy(SetIamPolicyMachineImageRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. setIamPolicy(String project, String resource, GlobalSetPolicyRequest globalSetPolicyRequestResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setIamPolicyCallable()
TestIamPermissions	Returns permissions that a caller has on the specified resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. testIamPermissions(TestIamPermissionsMachineImageRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. testIamPermissions(String project, String resource, TestPermissionsRequest testPermissionsRequestResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. testIamPermissionsCallable()

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 MachineImagesSettings 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
 MachineImagesSettings machineImagesSettings =
     MachineImagesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 MachineImagesClient machineImagesClient = MachineImagesClient.create(machineImagesSettings);
 

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
 MachineImagesSettings machineImagesSettings =
     MachineImagesSettings.newBuilder().setEndpoint(myEndpoint).build();
 MachineImagesClient machineImagesClient = MachineImagesClient.create(machineImagesSettings);
 

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

Inheritance

java.lang.Object > MachineImagesClient

Static Methods

create()

public static final MachineImagesClient create()

Constructs an instance of MachineImagesClient with default settings.

Returns
Type	Description
MachineImagesClient

Exceptions
Type	Description
IOException

create(MachineImagesSettings settings)

public static final MachineImagesClient create(MachineImagesSettings settings)

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

Returns
Type	Description
MachineImagesClient

Exceptions
Type	Description
IOException

create(MachineImagesStub stub)

public static final MachineImagesClient create(MachineImagesStub stub)

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

Parameter
Name	Description
stub	MachineImagesStub

Returns
Type	Description
MachineImagesClient

Constructors

MachineImagesClient(MachineImagesSettings settings)

protected MachineImagesClient(MachineImagesSettings settings)

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

MachineImagesClient(MachineImagesStub stub)

protected MachineImagesClient(MachineImagesStub stub)

Parameter
Name	Description
stub	MachineImagesStub

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

deleteAsync(DeleteMachineImageRequest request)

public final OperationFuture<Operation,Operation> deleteAsync(DeleteMachineImageRequest request)

Deletes the specified machine image. Deleting a machine image is permanent and cannot be undone.

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 (MachineImagesClient machineImagesClient = MachineImagesClient.create()) {
   DeleteMachineImageRequest request =
       DeleteMachineImageRequest.newBuilder()
           .setMachineImage("machineImage1817774420")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   Operation response = machineImagesClient.deleteAsync(request).get();
 }
 

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

Returns
Type	Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String machineImage)

public final OperationFuture<Operation,Operation> deleteAsync(String project, String machineImage)

Deletes the specified machine image. Deleting a machine image is permanent and cannot be undone.

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 (MachineImagesClient machineImagesClient = MachineImagesClient.create()) {
   String project = "project-309310695";
   String machineImage = "machineImage1817774420";
   Operation response = machineImagesClient.deleteAsync(project, machineImage).get();
 }
 

Parameters
Name	Description
project	String Project ID for this request.
machineImage	String The name of the machine image to delete.

Returns
Type	Description
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteMachineImageRequest,Operation> deleteCallable()

Deletes the specified machine image. Deleting a machine image is permanent and cannot be undone.

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 (MachineImagesClient machineImagesClient = MachineImagesClient.create()) {
   DeleteMachineImageRequest request =
       DeleteMachineImageRequest.newBuilder()
           .setMachineImage("machineImage1817774420")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = machineImagesClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<DeleteMachineImageRequest,Operation>

deleteOperationCallable()

public final OperationCallable<DeleteMachineImageRequest,Operation,Operation> deleteOperationCallable()

Deletes the specified machine image. Deleting a machine image is permanent and cannot be undone.

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 (MachineImagesClient machineImagesClient = MachineImagesClient.create()) {
   DeleteMachineImageRequest request =
       DeleteMachineImageRequest.newBuilder()
           .setMachineImage("machineImage1817774420")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       machineImagesClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
OperationCallable<DeleteMachineImageRequest,Operation,Operation>

get(GetMachineImageRequest request)

public final MachineImage get(GetMachineImageRequest request)

Returns the specified machine image.

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 (MachineImagesClient machineImagesClient = MachineImagesClient.create()) {
   GetMachineImageRequest request =
       GetMachineImageRequest.newBuilder()
           .setMachineImage("machineImage1817774420")
           .setProject("project-309310695")
           .build();
   MachineImage response = machineImagesClient.get(request);
 }
 

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

Returns
Type	Description
MachineImage

get(String project, String machineImage)

public final MachineImage get(String project, String machineImage)

Returns the specified machine image.

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 (MachineImagesClient machineImagesClient = MachineImagesClient.create()) {
   String project = "project-309310695";
   String machineImage = "machineImage1817774420";
   MachineImage response = machineImagesClient.get(project, machineImage);
 }
 

Parameters
Name	Description
project	String Project ID for this request.
machineImage	String The name of the machine image.

Returns
Type	Description
MachineImage

getCallable()

public final UnaryCallable<GetMachineImageRequest,MachineImage> getCallable()

Returns the specified machine image.

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 (MachineImagesClient machineImagesClient = MachineImagesClient.create()) {
   GetMachineImageRequest request =
       GetMachineImageRequest.newBuilder()
           .setMachineImage("machineImage1817774420")
           .setProject("project-309310695")
           .build();
   ApiFuture<MachineImage> future = machineImagesClient.getCallable().futureCall(request);
   // Do something.
   MachineImage response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetMachineImageRequest,MachineImage>

getIamPolicy(GetIamPolicyMachineImageRequest request)

public final Policy getIamPolicy(GetIamPolicyMachineImageRequest request)

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

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 (MachineImagesClient machineImagesClient = MachineImagesClient.create()) {
   GetIamPolicyMachineImageRequest request =
       GetIamPolicyMachineImageRequest.newBuilder()
           .setOptionsRequestedPolicyVersion(-574521795)
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .build();
   Policy response = machineImagesClient.getIamPolicy(request);
 }
 

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

Returns
Type	Description
Policy

getIamPolicy(String project, String resource)

public final Policy getIamPolicy(String project, String resource)

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

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 (MachineImagesClient machineImagesClient = MachineImagesClient.create()) {
   String project = "project-309310695";
   String resource = "resource-341064690";
   Policy response = machineImagesClient.getIamPolicy(project, resource);
 }
 

Parameters
Name	Description
project	String Project ID for this request.
resource	String Name or id of the resource for this request.

Returns
Type	Description
Policy

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyMachineImageRequest,Policy> getIamPolicyCallable()

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

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 (MachineImagesClient machineImagesClient = MachineImagesClient.create()) {
   GetIamPolicyMachineImageRequest request =
       GetIamPolicyMachineImageRequest.newBuilder()
           .setOptionsRequestedPolicyVersion(-574521795)
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .build();
   ApiFuture<Policy> future = machineImagesClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetIamPolicyMachineImageRequest,Policy>

getSettings()

public final MachineImagesSettings getSettings()

Returns
Type	Description
MachineImagesSettings

getStub()

public MachineImagesStub getStub()

Returns
Type	Description
MachineImagesStub

insertAsync(InsertMachineImageRequest request)

public final OperationFuture<Operation,Operation> insertAsync(InsertMachineImageRequest request)

Creates a machine image in the specified project using the data that is included in the request. If you are creating a new machine image to update an existing instance, your new machine image should use the same network or, if applicable, the same subnetwork as the original instance.

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 (MachineImagesClient machineImagesClient = MachineImagesClient.create()) {
   InsertMachineImageRequest request =
       InsertMachineImageRequest.newBuilder()
           .setMachineImageResource(MachineImage.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSourceInstance("sourceInstance-808380976")
           .build();
   Operation response = machineImagesClient.insertAsync(request).get();
 }
 

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

Returns
Type	Description
OperationFuture<Operation,Operation>

insertAsync(String project, MachineImage machineImageResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, MachineImage machineImageResource)

Creates a machine image in the specified project using the data that is included in the request. If you are creating a new machine image to update an existing instance, your new machine image should use the same network or, if applicable, the same subnetwork as the original instance.

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 (MachineImagesClient machineImagesClient = MachineImagesClient.create()) {
   String project = "project-309310695";
   MachineImage machineImageResource = MachineImage.newBuilder().build();
   Operation response = machineImagesClient.insertAsync(project, machineImageResource).get();
 }
 

Parameters
Name	Description
project	String Project ID for this request.
machineImageResource	MachineImage The body resource for this request

Returns
Type	Description
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertMachineImageRequest,Operation> insertCallable()

Creates a machine image in the specified project using the data that is included in the request. If you are creating a new machine image to update an existing instance, your new machine image should use the same network or, if applicable, the same subnetwork as the original instance.

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 (MachineImagesClient machineImagesClient = MachineImagesClient.create()) {
   InsertMachineImageRequest request =
       InsertMachineImageRequest.newBuilder()
           .setMachineImageResource(MachineImage.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSourceInstance("sourceInstance-808380976")
           .build();
   ApiFuture<Operation> future = machineImagesClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<InsertMachineImageRequest,Operation>

insertOperationCallable()

public final OperationCallable<InsertMachineImageRequest,Operation,Operation> insertOperationCallable()

Creates a machine image in the specified project using the data that is included in the request. If you are creating a new machine image to update an existing instance, your new machine image should use the same network or, if applicable, the same subnetwork as the original instance.

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 (MachineImagesClient machineImagesClient = MachineImagesClient.create()) {
   InsertMachineImageRequest request =
       InsertMachineImageRequest.newBuilder()
           .setMachineImageResource(MachineImage.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSourceInstance("sourceInstance-808380976")
           .build();
   OperationFuture<Operation, Operation> future =
       machineImagesClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
OperationCallable<InsertMachineImageRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

list(ListMachineImagesRequest request)

public final MachineImagesClient.ListPagedResponse list(ListMachineImagesRequest request)

Retrieves a list of machine images that are contained within the specified project.

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 (MachineImagesClient machineImagesClient = MachineImagesClient.create()) {
   ListMachineImagesRequest request =
       ListMachineImagesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (MachineImage element : machineImagesClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

Returns
Type	Description
MachineImagesClient.ListPagedResponse

list(String project)

public final MachineImagesClient.ListPagedResponse list(String project)

Retrieves a list of machine images that are contained within the specified project.

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 (MachineImagesClient machineImagesClient = MachineImagesClient.create()) {
   String project = "project-309310695";
   for (MachineImage element : machineImagesClient.list(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
project	String Project ID for this request.

Returns
Type	Description
MachineImagesClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListMachineImagesRequest,MachineImageList> listCallable()

Retrieves a list of machine images that are contained within the specified project.

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 (MachineImagesClient machineImagesClient = MachineImagesClient.create()) {
   ListMachineImagesRequest request =
       ListMachineImagesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     MachineImageList response = machineImagesClient.listCallable().call(request);
     for (MachineImage element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<ListMachineImagesRequest,MachineImageList>

listPagedCallable()

public final UnaryCallable<ListMachineImagesRequest,MachineImagesClient.ListPagedResponse> listPagedCallable()

Retrieves a list of machine images that are contained within the specified project.

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 (MachineImagesClient machineImagesClient = MachineImagesClient.create()) {
   ListMachineImagesRequest request =
       ListMachineImagesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<MachineImage> future = machineImagesClient.listPagedCallable().futureCall(request);
   // Do something.
   for (MachineImage element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<ListMachineImagesRequest,ListPagedResponse>

setIamPolicy(SetIamPolicyMachineImageRequest request)

public final Policy setIamPolicy(SetIamPolicyMachineImageRequest request)

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

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 (MachineImagesClient machineImagesClient = MachineImagesClient.create()) {
   SetIamPolicyMachineImageRequest request =
       SetIamPolicyMachineImageRequest.newBuilder()
           .setGlobalSetPolicyRequestResource(GlobalSetPolicyRequest.newBuilder().build())
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .build();
   Policy response = machineImagesClient.setIamPolicy(request);
 }
 

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

Returns
Type	Description
Policy

setIamPolicy(String project, String resource, GlobalSetPolicyRequest globalSetPolicyRequestResource)

public final Policy setIamPolicy(String project, String resource, GlobalSetPolicyRequest globalSetPolicyRequestResource)

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

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 (MachineImagesClient machineImagesClient = MachineImagesClient.create()) {
   String project = "project-309310695";
   String resource = "resource-341064690";
   GlobalSetPolicyRequest globalSetPolicyRequestResource =
       GlobalSetPolicyRequest.newBuilder().build();
   Policy response =
       machineImagesClient.setIamPolicy(project, resource, globalSetPolicyRequestResource);
 }
 

Parameters
Name	Description
project	String Project ID for this request.
resource	String Name or id of the resource for this request.
globalSetPolicyRequestResource	GlobalSetPolicyRequest The body resource for this request

Returns
Type	Description
Policy

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyMachineImageRequest,Policy> setIamPolicyCallable()

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

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 (MachineImagesClient machineImagesClient = MachineImagesClient.create()) {
   SetIamPolicyMachineImageRequest request =
       SetIamPolicyMachineImageRequest.newBuilder()
           .setGlobalSetPolicyRequestResource(GlobalSetPolicyRequest.newBuilder().build())
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .build();
   ApiFuture<Policy> future = machineImagesClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<SetIamPolicyMachineImageRequest,Policy>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

testIamPermissions(TestIamPermissionsMachineImageRequest request)

public final TestPermissionsResponse testIamPermissions(TestIamPermissionsMachineImageRequest request)

Returns permissions that a caller has on the specified resource.

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 (MachineImagesClient machineImagesClient = MachineImagesClient.create()) {
   TestIamPermissionsMachineImageRequest request =
       TestIamPermissionsMachineImageRequest.newBuilder()
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .setTestPermissionsRequestResource(TestPermissionsRequest.newBuilder().build())
           .build();
   TestPermissionsResponse response = machineImagesClient.testIamPermissions(request);
 }
 

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

Returns
Type	Description
TestPermissionsResponse

testIamPermissions(String project, String resource, TestPermissionsRequest testPermissionsRequestResource)

public final TestPermissionsResponse testIamPermissions(String project, String resource, TestPermissionsRequest testPermissionsRequestResource)

Returns permissions that a caller has on the specified resource.

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 (MachineImagesClient machineImagesClient = MachineImagesClient.create()) {
   String project = "project-309310695";
   String resource = "resource-341064690";
   TestPermissionsRequest testPermissionsRequestResource =
       TestPermissionsRequest.newBuilder().build();
   TestPermissionsResponse response =
       machineImagesClient.testIamPermissions(project, resource, testPermissionsRequestResource);
 }
 

Parameters
Name	Description
project	String Project ID for this request.
resource	String Name or id of the resource for this request.
testPermissionsRequestResource	TestPermissionsRequest The body resource for this request

Returns
Type	Description
TestPermissionsResponse

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsMachineImageRequest,TestPermissionsResponse> testIamPermissionsCallable()

Returns permissions that a caller has on the specified resource.

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 (MachineImagesClient machineImagesClient = MachineImagesClient.create()) {
   TestIamPermissionsMachineImageRequest request =
       TestIamPermissionsMachineImageRequest.newBuilder()
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .setTestPermissionsRequestResource(TestPermissionsRequest.newBuilder().build())
           .build();
   ApiFuture<TestPermissionsResponse> future =
       machineImagesClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestPermissionsResponse response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<TestIamPermissionsMachineImageRequest,TestPermissionsResponse>