com.google.cloud.compute.v1

Class LicenseCodeClient

java.lang.Object

com.google.cloud.compute.v1.LicenseCodeClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
public class LicenseCodeClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Creates and runs virtual machines on Google Cloud Platform.

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:

 
 try (LicenseCodeClient licenseCodeClient = LicenseCodeClient.create()) {
   ProjectGlobalLicenseCodeName licenseCode = ProjectGlobalLicenseCodeName.of("[PROJECT]", "[LICENSE_CODE]");
   LicenseCode response = licenseCodeClient.getLicenseCode(licenseCode);
 }
 
 

Note: close() needs to be called on the licenseCodeClient 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 LicenseCodeSettings to create(). For example:

To customize credentials:

 
 LicenseCodeSettings licenseCodeSettings =
     LicenseCodeSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 LicenseCodeClient licenseCodeClient =
     LicenseCodeClient.create(licenseCodeSettings);
 
 

To customize the endpoint:

 
 LicenseCodeSettings licenseCodeSettings =
     LicenseCodeSettings.newBuilder().setEndpoint(myEndpoint).build();
 LicenseCodeClient licenseCodeClient =
     LicenseCodeClient.create(licenseCodeSettings);
 
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LicenseCodeClient(LicenseCodeSettings settings) Constructs an instance of LicenseCodeClient, using the given settings.
protected	LicenseCodeClient(LicenseCodeStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static LicenseCodeClient	create() Constructs an instance of LicenseCodeClient with default settings.
static LicenseCodeClient	create(LicenseCodeSettings settings) Constructs an instance of LicenseCodeClient, using the given settings.
static LicenseCodeClient	create(LicenseCodeStub stub) Constructs an instance of LicenseCodeClient, using the given stub for making calls.
LicenseCode	getLicenseCode(GetLicenseCodeHttpRequest request) Return a specified license code.
LicenseCode	getLicenseCode(ProjectGlobalLicenseCodeName licenseCode) Return a specified license code.
LicenseCode	getLicenseCode(String licenseCode) Return a specified license code.
com.google.api.gax.rpc.UnaryCallable<GetLicenseCodeHttpRequest,LicenseCode>	getLicenseCodeCallable() Return a specified license code.
LicenseCodeSettings	getSettings()
LicenseCodeStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
void	shutdown()
void	shutdownNow()
TestPermissionsResponse	testIamPermissionsLicenseCode(ProjectGlobalLicenseCodeResourceName resource, TestPermissionsRequest testPermissionsRequestResource) Returns permissions that a caller has on the specified resource.
TestPermissionsResponse	testIamPermissionsLicenseCode(String resource, TestPermissionsRequest testPermissionsRequestResource) Returns permissions that a caller has on the specified resource.
TestPermissionsResponse	testIamPermissionsLicenseCode(TestIamPermissionsLicenseCodeHttpRequest request) Returns permissions that a caller has on the specified resource.
com.google.api.gax.rpc.UnaryCallable<TestIamPermissionsLicenseCodeHttpRequest,TestPermissionsResponse>	testIamPermissionsLicenseCodeCallable() Returns permissions that a caller has on the specified resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LicenseCodeClient

protected LicenseCodeClient(LicenseCodeSettings settings)
                     throws IOException

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

LicenseCodeClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected LicenseCodeClient(LicenseCodeStub stub)

Method Detail

create

public static final LicenseCodeClient create()
                                      throws IOException

Constructs an instance of LicenseCodeClient with default settings.

Throws:

IOException

create

public static final LicenseCodeClient create(LicenseCodeSettings settings)
                                      throws IOException

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

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final LicenseCodeClient create(LicenseCodeStub stub)

Constructs an instance of LicenseCodeClient, using the given stub for making calls. This is for advanced usage - prefer to use LicenseCodeSettings}.

getSettings

public final LicenseCodeSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public LicenseCodeStub getStub()

getLicenseCode

@BetaApi
public final LicenseCode getLicenseCode(ProjectGlobalLicenseCodeName licenseCode)

Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code.

Sample code:

 try (LicenseCodeClient licenseCodeClient = LicenseCodeClient.create()) {
   ProjectGlobalLicenseCodeName licenseCode = ProjectGlobalLicenseCodeName.of("[PROJECT]", "[LICENSE_CODE]");
   LicenseCode response = licenseCodeClient.getLicenseCode(licenseCode);
 }
 

Parameters:

licenseCode - Number corresponding to the License code resource to return.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getLicenseCode

@BetaApi
public final LicenseCode getLicenseCode(String licenseCode)

Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code.

Sample code:

 try (LicenseCodeClient licenseCodeClient = LicenseCodeClient.create()) {
   ProjectGlobalLicenseCodeName licenseCode = ProjectGlobalLicenseCodeName.of("[PROJECT]", "[LICENSE_CODE]");
   LicenseCode response = licenseCodeClient.getLicenseCode(licenseCode.toString());
 }
 

Parameters:

licenseCode - Number corresponding to the License code resource to return.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getLicenseCode

@BetaApi
public final LicenseCode getLicenseCode(GetLicenseCodeHttpRequest request)

Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code.

Sample code:

 try (LicenseCodeClient licenseCodeClient = LicenseCodeClient.create()) {
   String formattedLicenseCode = ProjectGlobalLicenseCodeName.format("[PROJECT]", "[LICENSE_CODE]");
   GetLicenseCodeHttpRequest request = GetLicenseCodeHttpRequest.newBuilder()
     .setLicenseCode(formattedLicenseCode)
     .build();
   LicenseCode response = licenseCodeClient.getLicenseCode(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

getLicenseCodeCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetLicenseCodeHttpRequest,LicenseCode> getLicenseCodeCallable()

Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code.

Sample code:

 try (LicenseCodeClient licenseCodeClient = LicenseCodeClient.create()) {
   String formattedLicenseCode = ProjectGlobalLicenseCodeName.format("[PROJECT]", "[LICENSE_CODE]");
   GetLicenseCodeHttpRequest request = GetLicenseCodeHttpRequest.newBuilder()
     .setLicenseCode(formattedLicenseCode)
     .build();
   ApiFuture<LicenseCode> future = licenseCodeClient.getLicenseCodeCallable().futureCall(request);
   // Do something
   LicenseCode response = future.get();
 }
 

testIamPermissionsLicenseCode

@BetaApi
public final TestPermissionsResponse testIamPermissionsLicenseCode(ProjectGlobalLicenseCodeResourceName resource,
                                                                            TestPermissionsRequest testPermissionsRequestResource)

Returns permissions that a caller has on the specified resource.

Sample code:

 try (LicenseCodeClient licenseCodeClient = LicenseCodeClient.create()) {
   ProjectGlobalLicenseCodeResourceName resource = ProjectGlobalLicenseCodeResourceName.of("[PROJECT]", "[RESOURCE]");
   TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build();
   TestPermissionsResponse response = licenseCodeClient.testIamPermissionsLicenseCode(resource, testPermissionsRequestResource);
 }
 

Parameters:

resource - Name or id of the resource for this request.

testPermissionsRequestResource -

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

testIamPermissionsLicenseCode

@BetaApi
public final TestPermissionsResponse testIamPermissionsLicenseCode(String resource,
                                                                            TestPermissionsRequest testPermissionsRequestResource)

Returns permissions that a caller has on the specified resource.

Sample code:

 try (LicenseCodeClient licenseCodeClient = LicenseCodeClient.create()) {
   ProjectGlobalLicenseCodeResourceName resource = ProjectGlobalLicenseCodeResourceName.of("[PROJECT]", "[RESOURCE]");
   TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build();
   TestPermissionsResponse response = licenseCodeClient.testIamPermissionsLicenseCode(resource.toString(), testPermissionsRequestResource);
 }
 

Parameters:

resource - Name or id of the resource for this request.

testPermissionsRequestResource -

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

testIamPermissionsLicenseCode

@BetaApi
public final TestPermissionsResponse testIamPermissionsLicenseCode(TestIamPermissionsLicenseCodeHttpRequest request)

Returns permissions that a caller has on the specified resource.

Sample code:

 try (LicenseCodeClient licenseCodeClient = LicenseCodeClient.create()) {
   String formattedResource = ProjectGlobalLicenseCodeResourceName.format("[PROJECT]", "[RESOURCE]");
   TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build();
   TestIamPermissionsLicenseCodeHttpRequest request = TestIamPermissionsLicenseCodeHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setTestPermissionsRequestResource(testPermissionsRequestResource)
     .build();
   TestPermissionsResponse response = licenseCodeClient.testIamPermissionsLicenseCode(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

testIamPermissionsLicenseCodeCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<TestIamPermissionsLicenseCodeHttpRequest,TestPermissionsResponse> testIamPermissionsLicenseCodeCallable()

Returns permissions that a caller has on the specified resource.

Sample code:

 try (LicenseCodeClient licenseCodeClient = LicenseCodeClient.create()) {
   String formattedResource = ProjectGlobalLicenseCodeResourceName.format("[PROJECT]", "[RESOURCE]");
   TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build();
   TestIamPermissionsLicenseCodeHttpRequest request = TestIamPermissionsLicenseCodeHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setTestPermissionsRequestResource(testPermissionsRequestResource)
     .build();
   ApiFuture<TestPermissionsResponse> future = licenseCodeClient.testIamPermissionsLicenseCodeCallable().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