LicenseCodesClient (Google Compute Engine 1.59.0 API)

java.lang.Object
- com.google.cloud.compute.v1.LicenseCodesClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class LicenseCodesClient
extends Object
implements com.google.api.gax.core.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().

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.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`LicenseCodesClient(LicenseCodesSettings settings)` Constructs an instance of LicenseCodesClient, using the given settings.
`protected`	`LicenseCodesClient(LicenseCodesStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static LicenseCodesClient`	`create()` Constructs an instance of LicenseCodesClient with default settings.
`static LicenseCodesClient`	`create(LicenseCodesSettings settings)` Constructs an instance of LicenseCodesClient, using the given settings.
`static LicenseCodesClient`	`create(LicenseCodesStub stub)` Constructs an instance of LicenseCodesClient, using the given stub for making calls.
`LicenseCode`	`get(GetLicenseCodeRequest request)` Return a specified license code.
`LicenseCode`	`get(String project, String licenseCode)` Return a specified license code.
`com.google.api.gax.rpc.UnaryCallable<GetLicenseCodeRequest,LicenseCode>`	`getCallable()` Return a specified license code.
`LicenseCodesSettings`	`getSettings()`
`LicenseCodesStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`void`	`shutdown()`
`void`	`shutdownNow()`
`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.
`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.
`com.google.api.gax.rpc.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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- LicenseCodesClient
```
protected LicenseCodesClient(LicenseCodesSettings settings)
                      throws IOException
```
  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.
  
  Throws:
  
  IOException
- LicenseCodesClient
```
protected LicenseCodesClient(LicenseCodesStub stub)
```

Method Detail

create

public static final LicenseCodesClient create()
                                       throws IOException

Constructs an instance of LicenseCodesClient with default settings.

Throws:: IOException

create
```
public static final LicenseCodesClient create(LicenseCodesSettings settings)
                                       throws IOException
```
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.

Throws:

IOException

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

getSettings

public final LicenseCodesSettings getSettings()

getStub
```
public LicenseCodesStub getStub()
```

get

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:: project - Project ID for this request.; licenseCode - Number corresponding to the License code resource to return.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

get

public final LicenseCode get(GetLicenseCodeRequest request)

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);
 }

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<GetLicenseCodeRequest,LicenseCode> getCallable()

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

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 (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:: 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(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);
 }

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

close
```
public final void close()
```
Specified by:

close in interface AutoCloseable

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:: awaitTermination in interface com.google.api.gax.core.BackgroundResource
Throws:: InterruptedException

Class LicenseCodesClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LicenseCodesClient

LicenseCodesClient

Method Detail

create

create

create

getSettings

getStub

get

get

getCallable

testIamPermissions

testIamPermissions

testIamPermissionsCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination