Class MachineImagesClient (1.40.0)

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

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 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
TypeDescription
MachineImagesClient
Exceptions
TypeDescription
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
NameDescription
settingsMachineImagesSettings
Returns
TypeDescription
MachineImagesClient
Exceptions
TypeDescription
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
NameDescription
stubMachineImagesStub
Returns
TypeDescription
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
NameDescription
settingsMachineImagesSettings

MachineImagesClient(MachineImagesStub stub)

protected MachineImagesClient(MachineImagesStub stub)
Parameter
NameDescription
stubMachineImagesStub

Methods

awaitTermination(long duration, TimeUnit unit)

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

close()

public final void close()

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
NameDescription
requestDeleteMachineImageRequest

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

Returns
TypeDescription
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
NameDescription
projectString

Project ID for this request.

machineImageString

The name of the machine image to delete.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
requestGetMachineImageRequest

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

Returns
TypeDescription
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
NameDescription
projectString

Project ID for this request.

machineImageString

The name of the machine image.

Returns
TypeDescription
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
TypeDescription
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
NameDescription
requestGetIamPolicyMachineImageRequest

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

Returns
TypeDescription
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
NameDescription
projectString

Project ID for this request.

resourceString

Name or id of the resource for this request.

Returns
TypeDescription
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
TypeDescription
UnaryCallable<GetIamPolicyMachineImageRequest,Policy>

getSettings()

public final MachineImagesSettings getSettings()
Returns
TypeDescription
MachineImagesSettings

getStub()

public MachineImagesStub getStub()
Returns
TypeDescription
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
NameDescription
requestInsertMachineImageRequest

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

Returns
TypeDescription
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
NameDescription
projectString

Project ID for this request.

machineImageResourceMachineImage

The body resource for this request

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
OperationCallable<InsertMachineImageRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
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
NameDescription
requestListMachineImagesRequest

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

Returns
TypeDescription
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
NameDescription
projectString

Project ID for this request.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
requestSetIamPolicyMachineImageRequest

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

Returns
TypeDescription
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
NameDescription
projectString

Project ID for this request.

resourceString

Name or id of the resource for this request.

globalSetPolicyRequestResourceGlobalSetPolicyRequest

The body resource for this request

Returns
TypeDescription
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
TypeDescription
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
NameDescription
requestTestIamPermissionsMachineImageRequest

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

Returns
TypeDescription
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
NameDescription
projectString

Project ID for this request.

resourceString

Name or id of the resource for this request.

testPermissionsRequestResourceTestPermissionsRequest

The body resource for this request

Returns
TypeDescription
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
TypeDescription
UnaryCallable<TestIamPermissionsMachineImageRequest,TestPermissionsResponse>