Class MachineImagesClient
- java.lang.Object
-
- com.google.cloud.compute.v1.MachineImagesClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
@Generated("by gapic-generator-java") public class MachineImagesClient extends Object implements com.google.api.gax.core.BackgroundResource
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:
- 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.
- 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.
- 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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MachineImagesClient.ListFixedSizeCollection
static class
MachineImagesClient.ListPage
static class
MachineImagesClient.ListPagedResponse
-
Constructor Summary
Constructors Modifier Constructor Description protected
MachineImagesClient(MachineImagesSettings settings)
Constructs an instance of MachineImagesClient, using the given settings.protected
MachineImagesClient(MachineImagesStub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
awaitTermination(long duration, TimeUnit unit)
void
close()
static MachineImagesClient
create()
Constructs an instance of MachineImagesClient with default settings.static MachineImagesClient
create(MachineImagesSettings settings)
Constructs an instance of MachineImagesClient, using the given settings.static MachineImagesClient
create(MachineImagesStub stub)
Constructs an instance of MachineImagesClient, using the given stub for making calls.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
deleteAsync(DeleteMachineImageRequest request)
Deletes the specified machine image.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
deleteAsync(String project, String machineImage)
Deletes the specified machine image.com.google.api.gax.rpc.UnaryCallable<DeleteMachineImageRequest,Operation>
deleteCallable()
Deletes the specified machine image.com.google.api.gax.rpc.OperationCallable<DeleteMachineImageRequest,Operation,Operation>
deleteOperationCallable()
Deletes the specified machine image.MachineImage
get(GetMachineImageRequest request)
Returns the specified machine image.MachineImage
get(String project, String machineImage)
Returns the specified machine image.com.google.api.gax.rpc.UnaryCallable<GetMachineImageRequest,MachineImage>
getCallable()
Returns the specified machine image.Policy
getIamPolicy(GetIamPolicyMachineImageRequest request)
Gets the access control policy for a resource.Policy
getIamPolicy(String project, String resource)
Gets the access control policy for a resource.com.google.api.gax.rpc.UnaryCallable<GetIamPolicyMachineImageRequest,Policy>
getIamPolicyCallable()
Gets the access control policy for a resource.MachineImagesSettings
getSettings()
MachineImagesStub
getStub()
com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
insertAsync(InsertMachineImageRequest request)
Creates a machine image in the specified project using the data that is included in the request.com.google.api.gax.longrunning.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.com.google.api.gax.rpc.UnaryCallable<InsertMachineImageRequest,Operation>
insertCallable()
Creates a machine image in the specified project using the data that is included in the request.com.google.api.gax.rpc.OperationCallable<InsertMachineImageRequest,Operation,Operation>
insertOperationCallable()
Creates a machine image in the specified project using the data that is included in the request.boolean
isShutdown()
boolean
isTerminated()
MachineImagesClient.ListPagedResponse
list(ListMachineImagesRequest request)
Retrieves a list of machine images that are contained within the specified project.MachineImagesClient.ListPagedResponse
list(String project)
Retrieves a list of machine images that are contained within the specified project.com.google.api.gax.rpc.UnaryCallable<ListMachineImagesRequest,MachineImageList>
listCallable()
Retrieves a list of machine images that are contained within the specified project.com.google.api.gax.rpc.UnaryCallable<ListMachineImagesRequest,MachineImagesClient.ListPagedResponse>
listPagedCallable()
Retrieves a list of machine images that are contained within the specified project.Policy
setIamPolicy(SetIamPolicyMachineImageRequest request)
Sets the access control policy on the specified resource.Policy
setIamPolicy(String project, String resource, GlobalSetPolicyRequest globalSetPolicyRequestResource)
Sets the access control policy on the specified resource.com.google.api.gax.rpc.UnaryCallable<SetIamPolicyMachineImageRequest,Policy>
setIamPolicyCallable()
Sets the access control policy on the specified resource.void
shutdown()
void
shutdownNow()
TestPermissionsResponse
testIamPermissions(TestIamPermissionsMachineImageRequest request)
Returns permissions that a caller has on the specified resource.TestPermissionsResponse
testIamPermissions(String project, String resource, TestPermissionsRequest testPermissionsRequestResource)
Returns permissions that a caller has on the specified resource.com.google.api.gax.rpc.UnaryCallable<TestIamPermissionsMachineImageRequest,TestPermissionsResponse>
testIamPermissionsCallable()
Returns permissions that a caller has on the specified resource.
-
-
-
Constructor Detail
-
MachineImagesClient
protected MachineImagesClient(MachineImagesSettings settings) throws IOException
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.- Throws:
IOException
-
MachineImagesClient
protected MachineImagesClient(MachineImagesStub stub)
-
-
Method Detail
-
create
public static final MachineImagesClient create() throws IOException
Constructs an instance of MachineImagesClient with default settings.- Throws:
IOException
-
create
public static final MachineImagesClient create(MachineImagesSettings settings) throws IOException
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.- Throws:
IOException
-
create
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).
-
getSettings
public final MachineImagesSettings getSettings()
-
getStub
public MachineImagesStub getStub()
-
deleteAsync
public final com.google.api.gax.longrunning.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:
project
- Project ID for this request.machineImage
- The name of the machine image to delete.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteOperationCallable
public final com.google.api.gax.rpc.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(); }
-
deleteCallable
public final com.google.api.gax.rpc.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(); }
-
get
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:
project
- Project ID for this request.machineImage
- The name of the machine image.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
get
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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getCallable
public final com.google.api.gax.rpc.UnaryCallable<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(); }
-
getIamPolicy
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:
project
- Project ID for this request.resource
- Name or id of the resource for this request.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getIamPolicy
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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getIamPolicyCallable
public final com.google.api.gax.rpc.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(); }
-
insertAsync
public final com.google.api.gax.longrunning.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:
project
- Project ID for this request.machineImageResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
insertAsync
@BetaApi("The surface for long-running operations is not stable yet and may change in the future.") public final com.google.api.gax.longrunning.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
insertOperationCallable
public final com.google.api.gax.rpc.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(); }
-
insertCallable
public final com.google.api.gax.rpc.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(); }
-
list
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); } }
- Parameters:
project
- Project ID for this request.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
list
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); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listPagedCallable
public final com.google.api.gax.rpc.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); } }
-
listCallable
public final com.google.api.gax.rpc.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; } } }
-
setIamPolicy
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:
project
- Project ID for this request.resource
- Name or id of the resource for this request.globalSetPolicyRequestResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
setIamPolicy
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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
setIamPolicyCallable
public final com.google.api.gax.rpc.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(); }
-
testIamPermissions
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:
project
- Project ID for this request.resource
- Name or id of the resource for this request.testPermissionsRequestResource
- The body resource for this request- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
testIamPermissions
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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
testIamPermissionsCallable
public final com.google.api.gax.rpc.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(); }
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNow
in interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
InterruptedException
-
-