Class LicenseCodesClient (1.50.0)

GitHub Repository

Product Reference

Service Description: The LicenseCodes 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 (LicenseCodesClient licenseCodesClient = LicenseCodesClient.create()) {
   String project = "project-309310695";
   String licenseCode = "licenseCode-641557042";
   LicenseCode response = licenseCodesClient.get(project, licenseCode);
 }
 

Note: close() needs to be called on the LicenseCodesClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods

Method	Description	Method Variants
Get	Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.	Request object method variants only take one parameter, a request object, which must be constructed before the call. get(GetLicenseCodeRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. get(String project, String licenseCode) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getCallable()
TestIamPermissions	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.	Request object method variants only take one parameter, a request object, which must be constructed before the call. testIamPermissions(TestIamPermissionsLicenseCodeRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. testIamPermissions(String project, String resource, TestPermissionsRequest testPermissionsRequestResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. testIamPermissionsCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of LicenseCodesSettings 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
 LicenseCodesSettings licenseCodesSettings =
     LicenseCodesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 LicenseCodesClient licenseCodesClient = LicenseCodesClient.create(licenseCodesSettings);
 

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
 LicenseCodesSettings licenseCodesSettings =
     LicenseCodesSettings.newBuilder().setEndpoint(myEndpoint).build();
 LicenseCodesClient licenseCodesClient = LicenseCodesClient.create(licenseCodesSettings);
 

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

public static final LicenseCodesClient create()

Constructs an instance of LicenseCodesClient with default settings.

public static final LicenseCodesClient create(LicenseCodesSettings settings)

Constructs an instance of LicenseCodesClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

public static final LicenseCodesClient create(LicenseCodesStub stub)

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

protected LicenseCodesClient(LicenseCodesSettings settings)

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

protected LicenseCodesClient(LicenseCodesStub stub)

public boolean awaitTermination(long duration, TimeUnit unit)

public final void close()

public final LicenseCode get(GetLicenseCodeRequest request)

Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code. *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 (LicenseCodesClient licenseCodesClient = LicenseCodesClient.create()) {
   GetLicenseCodeRequest request =
       GetLicenseCodeRequest.newBuilder()
           .setLicenseCode("licenseCode-641557042")
           .setProject("project-309310695")
           .build();
   LicenseCode response = licenseCodesClient.get(request);
 }
 

public final LicenseCode get(String project, String licenseCode)

Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code. *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 (LicenseCodesClient licenseCodesClient = LicenseCodesClient.create()) {
   String project = "project-309310695";
   String licenseCode = "licenseCode-641557042";
   LicenseCode response = licenseCodesClient.get(project, licenseCode);
 }
 

public final UnaryCallable<GetLicenseCodeRequest,LicenseCode> getCallable()

Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code. *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 (LicenseCodesClient licenseCodesClient = LicenseCodesClient.create()) {
   GetLicenseCodeRequest request =
       GetLicenseCodeRequest.newBuilder()
           .setLicenseCode("licenseCode-641557042")
           .setProject("project-309310695")
           .build();
   ApiFuture<LicenseCode> future = licenseCodesClient.getCallable().futureCall(request);
   // Do something.
   LicenseCode response = future.get();
 }
 

public final LicenseCodesSettings getSettings()

public LicenseCodesStub getStub()

public boolean isShutdown()

public boolean isTerminated()

public void shutdown()

public void shutdownNow()

public final TestPermissionsResponse testIamPermissions(TestIamPermissionsLicenseCodeRequest 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 (LicenseCodesClient licenseCodesClient = LicenseCodesClient.create()) {
   TestIamPermissionsLicenseCodeRequest request =
       TestIamPermissionsLicenseCodeRequest.newBuilder()
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .setTestPermissionsRequestResource(TestPermissionsRequest.newBuilder().build())
           .build();
   TestPermissionsResponse response = licenseCodesClient.testIamPermissions(request);
 }
 

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

public final UnaryCallable<TestIamPermissionsLicenseCodeRequest,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 (LicenseCodesClient licenseCodesClient = LicenseCodesClient.create()) {
   TestIamPermissionsLicenseCodeRequest request =
       TestIamPermissionsLicenseCodeRequest.newBuilder()
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .setTestPermissionsRequestResource(TestPermissionsRequest.newBuilder().build())
           .build();
   ApiFuture<TestPermissionsResponse> future =
       licenseCodesClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestPermissionsResponse response = future.get();
 }