Class LicenseCodesClient (1.24.0) 

public class LicenseCodesClient implements BackgroundResource

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

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 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.

Inheritance

java.lang.Object > LicenseCodesClient

Implements

BackgroundResource

Static Methods

create()

public static final LicenseCodesClient create()

Constructs an instance of LicenseCodesClient with default settings.

Returns
TypeDescription
LicenseCodesClient
Exceptions
TypeDescription
IOException

create(LicenseCodesSettings 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.

Parameter
NameDescription
settingsLicenseCodesSettings
Returns
TypeDescription
LicenseCodesClient
Exceptions
TypeDescription
IOException

create(LicenseCodesStub stub)

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

Parameter
NameDescription
stubLicenseCodesStub
Returns
TypeDescription
LicenseCodesClient

Constructors

LicenseCodesClient(LicenseCodesSettings settings)

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.

Parameter
NameDescription
settingsLicenseCodesSettings

LicenseCodesClient(LicenseCodesStub stub)

protected LicenseCodesClient(LicenseCodesStub stub)
Parameter
NameDescription
stubLicenseCodesStub

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

get(GetLicenseCodeRequest request)

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);
 }
Parameter
NameDescription
requestGetLicenseCodeRequest

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

Returns
TypeDescription
LicenseCode

get(String project, String licenseCode)

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);
 }
Parameters
NameDescription
projectString

Project ID for this request.

licenseCodeString

Number corresponding to the License code resource to return.

Returns
TypeDescription
LicenseCode

getCallable()

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();
 }
Returns
TypeDescription
UnaryCallable<GetLicenseCodeRequest,LicenseCode>

getSettings()

public final LicenseCodesSettings getSettings()
Returns
TypeDescription
LicenseCodesSettings

getStub()

public LicenseCodesStub getStub()
Returns
TypeDescription
LicenseCodesStub

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

testIamPermissions(TestIamPermissionsLicenseCodeRequest request)

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);
 }
Parameter
NameDescription
requestTestIamPermissionsLicenseCodeRequest

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. *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);
 }
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<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();
 }
Returns
TypeDescription
UnaryCallable<TestIamPermissionsLicenseCodeRequest,TestPermissionsResponse>