Class LicensesClient
- java.lang.Object
-
- com.google.cloud.compute.v1.LicensesClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
@Generated("by gapic-generator-java") public class LicensesClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: The Licenses 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 (LicensesClient licensesClient = LicensesClient.create()) { String project = "project-309310695"; String license = "license166757441"; License response = licensesClient.get(project, license); }
Note: close() needs to be called on the LicensesClient 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 LicensesSettings 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 LicensesSettings licensesSettings = LicensesSettings.newBuilder() .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials)) .build(); LicensesClient licensesClient = LicensesClient.create(licensesSettings);
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 LicensesSettings licensesSettings = LicensesSettings.newBuilder().setEndpoint(myEndpoint).build(); LicensesClient licensesClient = LicensesClient.create(licensesSettings);
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
LicensesClient.ListFixedSizeCollection
static class
LicensesClient.ListPage
static class
LicensesClient.ListPagedResponse
-
Constructor Summary
Constructors Modifier Constructor Description protected
LicensesClient(LicensesSettings settings)
Constructs an instance of LicensesClient, using the given settings.protected
LicensesClient(LicensesStub 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 LicensesClient
create()
Constructs an instance of LicensesClient with default settings.static LicensesClient
create(LicensesSettings settings)
Constructs an instance of LicensesClient, using the given settings.static LicensesClient
create(LicensesStub stub)
Constructs an instance of LicensesClient, using the given stub for making calls.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
deleteAsync(DeleteLicenseRequest request)
Deletes the specified license.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
deleteAsync(String project, String license)
Deletes the specified license.com.google.api.gax.rpc.UnaryCallable<DeleteLicenseRequest,Operation>
deleteCallable()
Deletes the specified license.com.google.api.gax.rpc.OperationCallable<DeleteLicenseRequest,Operation,Operation>
deleteOperationCallable()
Deletes the specified license.License
get(GetLicenseRequest request)
Returns the specified License resource.License
get(String project, String license)
Returns the specified License resource.com.google.api.gax.rpc.UnaryCallable<GetLicenseRequest,License>
getCallable()
Returns the specified License resource.Policy
getIamPolicy(GetIamPolicyLicenseRequest 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<GetIamPolicyLicenseRequest,Policy>
getIamPolicyCallable()
Gets the access control policy for a resource.LicensesSettings
getSettings()
LicensesStub
getStub()
com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
insertAsync(InsertLicenseRequest request)
Create a License resource in the specified project.com.google.api.gax.longrunning.OperationFuture<Operation,Operation>
insertAsync(String project, License licenseResource)
Create a License resource in the specified project.com.google.api.gax.rpc.UnaryCallable<InsertLicenseRequest,Operation>
insertCallable()
Create a License resource in the specified project.com.google.api.gax.rpc.OperationCallable<InsertLicenseRequest,Operation,Operation>
insertOperationCallable()
Create a License resource in the specified project.boolean
isShutdown()
boolean
isTerminated()
LicensesClient.ListPagedResponse
list(ListLicensesRequest request)
Retrieves the list of licenses available in the specified project.LicensesClient.ListPagedResponse
list(String project)
Retrieves the list of licenses available in the specified project.com.google.api.gax.rpc.UnaryCallable<ListLicensesRequest,LicensesListResponse>
listCallable()
Retrieves the list of licenses available in the specified project.com.google.api.gax.rpc.UnaryCallable<ListLicensesRequest,LicensesClient.ListPagedResponse>
listPagedCallable()
Retrieves the list of licenses available in the specified project.Policy
setIamPolicy(SetIamPolicyLicenseRequest 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<SetIamPolicyLicenseRequest,Policy>
setIamPolicyCallable()
Sets the access control policy on the specified resource.void
shutdown()
void
shutdownNow()
TestPermissionsResponse
testIamPermissions(TestIamPermissionsLicenseRequest 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<TestIamPermissionsLicenseRequest,TestPermissionsResponse>
testIamPermissionsCallable()
Returns permissions that a caller has on the specified resource.
-
-
-
Constructor Detail
-
LicensesClient
protected LicensesClient(LicensesSettings settings) throws IOException
Constructs an instance of LicensesClient, 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
-
LicensesClient
protected LicensesClient(LicensesStub stub)
-
-
Method Detail
-
create
public static final LicensesClient create() throws IOException
Constructs an instance of LicensesClient with default settings.- Throws:
IOException
-
create
public static final LicensesClient create(LicensesSettings settings) throws IOException
Constructs an instance of LicensesClient, 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 LicensesClient create(LicensesStub stub)
Constructs an instance of LicensesClient, using the given stub for making calls. This is for advanced usage - prefer using create(LicensesSettings).
-
getSettings
public final LicensesSettings getSettings()
-
getStub
public LicensesStub getStub()
-
deleteAsync
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> deleteAsync(String project, String license)
Deletes the specified license. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.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 (LicensesClient licensesClient = LicensesClient.create()) { String project = "project-309310695"; String license = "license166757441"; Operation response = licensesClient.deleteAsync(project, license).get(); }
- Parameters:
project
- Project ID for this request.license
- Name of the license resource 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(DeleteLicenseRequest request)
Deletes the specified license. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.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 (LicensesClient licensesClient = LicensesClient.create()) { DeleteLicenseRequest request = DeleteLicenseRequest.newBuilder() .setLicense("license166757441") .setProject("project-309310695") .setRequestId("requestId693933066") .build(); Operation response = licensesClient.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<DeleteLicenseRequest,Operation,Operation> deleteOperationCallable()
Deletes the specified license. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.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 (LicensesClient licensesClient = LicensesClient.create()) { DeleteLicenseRequest request = DeleteLicenseRequest.newBuilder() .setLicense("license166757441") .setProject("project-309310695") .setRequestId("requestId693933066") .build(); OperationFuture<Operation, Operation> future = licensesClient.deleteOperationCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
deleteCallable
public final com.google.api.gax.rpc.UnaryCallable<DeleteLicenseRequest,Operation> deleteCallable()
Deletes the specified license. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.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 (LicensesClient licensesClient = LicensesClient.create()) { DeleteLicenseRequest request = DeleteLicenseRequest.newBuilder() .setLicense("license166757441") .setProject("project-309310695") .setRequestId("requestId693933066") .build(); ApiFuture<Operation> future = licensesClient.deleteCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
get
public final License get(String project, String license)
Returns the specified License resource. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.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 (LicensesClient licensesClient = LicensesClient.create()) { String project = "project-309310695"; String license = "license166757441"; License response = licensesClient.get(project, license); }
- Parameters:
project
- Project ID for this request.license
- Name of the License resource to return.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
get
public final License get(GetLicenseRequest request)
Returns the specified License resource. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.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 (LicensesClient licensesClient = LicensesClient.create()) { GetLicenseRequest request = GetLicenseRequest.newBuilder() .setLicense("license166757441") .setProject("project-309310695") .build(); License response = licensesClient.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<GetLicenseRequest,License> getCallable()
Returns the specified License resource. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.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 (LicensesClient licensesClient = LicensesClient.create()) { GetLicenseRequest request = GetLicenseRequest.newBuilder() .setLicense("license166757441") .setProject("project-309310695") .build(); ApiFuture<License> future = licensesClient.getCallable().futureCall(request); // Do something. License 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. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.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 (LicensesClient licensesClient = LicensesClient.create()) { String project = "project-309310695"; String resource = "resource-341064690"; Policy response = licensesClient.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(GetIamPolicyLicenseRequest request)
Gets the access control policy for a resource. May be empty if no such policy or resource exists. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.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 (LicensesClient licensesClient = LicensesClient.create()) { GetIamPolicyLicenseRequest request = GetIamPolicyLicenseRequest.newBuilder() .setOptionsRequestedPolicyVersion(-574521795) .setProject("project-309310695") .setResource("resource-341064690") .build(); Policy response = licensesClient.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<GetIamPolicyLicenseRequest,Policy> getIamPolicyCallable()
Gets the access control policy for a resource. May be empty if no such policy or resource exists. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.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 (LicensesClient licensesClient = LicensesClient.create()) { GetIamPolicyLicenseRequest request = GetIamPolicyLicenseRequest.newBuilder() .setOptionsRequestedPolicyVersion(-574521795) .setProject("project-309310695") .setResource("resource-341064690") .build(); ApiFuture<Policy> future = licensesClient.getIamPolicyCallable().futureCall(request); // Do something. Policy response = future.get(); }
-
insertAsync
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> insertAsync(String project, License licenseResource)
Create a License resource in the specified project. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.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 (LicensesClient licensesClient = LicensesClient.create()) { String project = "project-309310695"; License licenseResource = License.newBuilder().build(); Operation response = licensesClient.insertAsync(project, licenseResource).get(); }
- Parameters:
project
- Project ID for this request.licenseResource
- 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(InsertLicenseRequest request)
Create a License resource in the specified project. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.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 (LicensesClient licensesClient = LicensesClient.create()) { InsertLicenseRequest request = InsertLicenseRequest.newBuilder() .setLicenseResource(License.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .build(); Operation response = licensesClient.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<InsertLicenseRequest,Operation,Operation> insertOperationCallable()
Create a License resource in the specified project. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.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 (LicensesClient licensesClient = LicensesClient.create()) { InsertLicenseRequest request = InsertLicenseRequest.newBuilder() .setLicenseResource(License.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .build(); OperationFuture<Operation, Operation> future = licensesClient.insertOperationCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
insertCallable
public final com.google.api.gax.rpc.UnaryCallable<InsertLicenseRequest,Operation> insertCallable()
Create a License resource in the specified project. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.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 (LicensesClient licensesClient = LicensesClient.create()) { InsertLicenseRequest request = InsertLicenseRequest.newBuilder() .setLicenseResource(License.newBuilder().build()) .setProject("project-309310695") .setRequestId("requestId693933066") .build(); ApiFuture<Operation> future = licensesClient.insertCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
list
public final LicensesClient.ListPagedResponse list(String project)
Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.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 (LicensesClient licensesClient = LicensesClient.create()) { String project = "project-309310695"; for (License element : licensesClient.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 LicensesClient.ListPagedResponse list(ListLicensesRequest request)
Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.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 (LicensesClient licensesClient = LicensesClient.create()) { ListLicensesRequest request = ListLicensesRequest.newBuilder() .setFilter("filter-1274492040") .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setReturnPartialSuccess(true) .build(); for (License element : licensesClient.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<ListLicensesRequest,LicensesClient.ListPagedResponse> listPagedCallable()
Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.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 (LicensesClient licensesClient = LicensesClient.create()) { ListLicensesRequest request = ListLicensesRequest.newBuilder() .setFilter("filter-1274492040") .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setReturnPartialSuccess(true) .build(); ApiFuture<License> future = licensesClient.listPagedCallable().futureCall(request); // Do something. for (License element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listCallable
public final com.google.api.gax.rpc.UnaryCallable<ListLicensesRequest,LicensesListResponse> listCallable()
Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.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 (LicensesClient licensesClient = LicensesClient.create()) { ListLicensesRequest request = ListLicensesRequest.newBuilder() .setFilter("filter-1274492040") .setMaxResults(1128457243) .setOrderBy("orderBy-1207110587") .setPageToken("pageToken873572522") .setProject("project-309310695") .setReturnPartialSuccess(true) .build(); while (true) { LicensesListResponse response = licensesClient.listCallable().call(request); for (License 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. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.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 (LicensesClient licensesClient = LicensesClient.create()) { String project = "project-309310695"; String resource = "resource-341064690"; GlobalSetPolicyRequest globalSetPolicyRequestResource = GlobalSetPolicyRequest.newBuilder().build(); Policy response = licensesClient.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(SetIamPolicyLicenseRequest request)
Sets the access control policy on the specified resource. Replaces any existing policy. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.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 (LicensesClient licensesClient = LicensesClient.create()) { SetIamPolicyLicenseRequest request = SetIamPolicyLicenseRequest.newBuilder() .setGlobalSetPolicyRequestResource(GlobalSetPolicyRequest.newBuilder().build()) .setProject("project-309310695") .setResource("resource-341064690") .build(); Policy response = licensesClient.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<SetIamPolicyLicenseRequest,Policy> setIamPolicyCallable()
Sets the access control policy on the specified resource. Replaces any existing policy. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.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 (LicensesClient licensesClient = LicensesClient.create()) { SetIamPolicyLicenseRequest request = SetIamPolicyLicenseRequest.newBuilder() .setGlobalSetPolicyRequestResource(GlobalSetPolicyRequest.newBuilder().build()) .setProject("project-309310695") .setResource("resource-341064690") .build(); ApiFuture<Policy> future = licensesClient.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. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.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 (LicensesClient licensesClient = LicensesClient.create()) { String project = "project-309310695"; String resource = "resource-341064690"; TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build(); TestPermissionsResponse response = licensesClient.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(TestIamPermissionsLicenseRequest request)
Returns permissions that a caller has on the specified resource. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.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 (LicensesClient licensesClient = LicensesClient.create()) { TestIamPermissionsLicenseRequest request = TestIamPermissionsLicenseRequest.newBuilder() .setProject("project-309310695") .setResource("resource-341064690") .setTestPermissionsRequestResource(TestPermissionsRequest.newBuilder().build()) .build(); TestPermissionsResponse response = licensesClient.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<TestIamPermissionsLicenseRequest,TestPermissionsResponse> testIamPermissionsCallable()
Returns permissions that a caller has on the specified resource. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.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 (LicensesClient licensesClient = LicensesClient.create()) { TestIamPermissionsLicenseRequest request = TestIamPermissionsLicenseRequest.newBuilder() .setProject("project-309310695") .setResource("resource-341064690") .setTestPermissionsRequestResource(TestPermissionsRequest.newBuilder().build()) .build(); ApiFuture<TestPermissionsResponse> future = licensesClient.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
-
-