Class LicenseManagementServiceClient (0.51.0)

Service Description: Service for managing licenses.

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 (LicenseManagementServiceClient licenseManagementServiceClient =
     LicenseManagementServiceClient.create()) {
   String name = "name3373707";
   LicensePool response = licenseManagementServiceClient.getLicensePool(name);
 }
 

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

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 LicenseManagementServiceSettings 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
 LicenseManagementServiceSettings licenseManagementServiceSettings =
     LicenseManagementServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 LicenseManagementServiceClient licenseManagementServiceClient =
     LicenseManagementServiceClient.create(licenseManagementServiceSettings);
 

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
 LicenseManagementServiceSettings licenseManagementServiceSettings =
     LicenseManagementServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 LicenseManagementServiceClient licenseManagementServiceClient =
     LicenseManagementServiceClient.create(licenseManagementServiceSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:

 // 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
 LicenseManagementServiceSettings licenseManagementServiceSettings =
     LicenseManagementServiceSettings.newHttpJsonBuilder().build();
 LicenseManagementServiceClient licenseManagementServiceClient =
     LicenseManagementServiceClient.create(licenseManagementServiceSettings);
 

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

Constructs an instance of LicenseManagementServiceClient with default settings.

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

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

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

Assigns a license to a user.

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 (LicenseManagementServiceClient licenseManagementServiceClient =
     LicenseManagementServiceClient.create()) {
   AssignRequest request =
       AssignRequest.newBuilder()
           .setParent("parent-995424086")
           .addAllUsernames(new ArrayList<String>())
           .build();
   AssignResponse response = licenseManagementServiceClient.assign(request);
 }
 

Assigns a license to a user.

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 (LicenseManagementServiceClient licenseManagementServiceClient =
     LicenseManagementServiceClient.create()) {
   String parent = "parent-995424086";
   List<String> usernames = new ArrayList<>();
   AssignResponse response = licenseManagementServiceClient.assign(parent, usernames);
 }
 

Assigns a license to a user.

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 (LicenseManagementServiceClient licenseManagementServiceClient =
     LicenseManagementServiceClient.create()) {
   AssignRequest request =
       AssignRequest.newBuilder()
           .setParent("parent-995424086")
           .addAllUsernames(new ArrayList<String>())
           .build();
   ApiFuture<AssignResponse> future =
       licenseManagementServiceClient.assignCallable().futureCall(request);
   // Do something.
   AssignResponse response = future.get();
 }
 

Enumerates all users assigned a license.

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 (LicenseManagementServiceClient licenseManagementServiceClient =
     LicenseManagementServiceClient.create()) {
   EnumerateLicensedUsersRequest request =
       EnumerateLicensedUsersRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (LicensedUser element :
       licenseManagementServiceClient.enumerateLicensedUsers(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Enumerates all users assigned a license.

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 (LicenseManagementServiceClient licenseManagementServiceClient =
     LicenseManagementServiceClient.create()) {
   String parent = "parent-995424086";
   for (LicensedUser element :
       licenseManagementServiceClient.enumerateLicensedUsers(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Enumerates all users assigned a license.

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 (LicenseManagementServiceClient licenseManagementServiceClient =
     LicenseManagementServiceClient.create()) {
   EnumerateLicensedUsersRequest request =
       EnumerateLicensedUsersRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     EnumerateLicensedUsersResponse response =
         licenseManagementServiceClient.enumerateLicensedUsersCallable().call(request);
     for (LicensedUser element : response.getLicensedUsersList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Enumerates all users assigned a license.

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 (LicenseManagementServiceClient licenseManagementServiceClient =
     LicenseManagementServiceClient.create()) {
   EnumerateLicensedUsersRequest request =
       EnumerateLicensedUsersRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<LicensedUser> future =
       licenseManagementServiceClient.enumerateLicensedUsersPagedCallable().futureCall(request);
   // Do something.
   for (LicensedUser element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Gets the license pool.

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 (LicenseManagementServiceClient licenseManagementServiceClient =
     LicenseManagementServiceClient.create()) {
   GetLicensePoolRequest request =
       GetLicensePoolRequest.newBuilder().setName("name3373707").build();
   LicensePool response = licenseManagementServiceClient.getLicensePool(request);
 }
 

Gets the license pool.

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 (LicenseManagementServiceClient licenseManagementServiceClient =
     LicenseManagementServiceClient.create()) {
   String name = "name3373707";
   LicensePool response = licenseManagementServiceClient.getLicensePool(name);
 }
 

Gets the license pool.

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 (LicenseManagementServiceClient licenseManagementServiceClient =
     LicenseManagementServiceClient.create()) {
   GetLicensePoolRequest request =
       GetLicensePoolRequest.newBuilder().setName("name3373707").build();
   ApiFuture<LicensePool> future =
       licenseManagementServiceClient.getLicensePoolCallable().futureCall(request);
   // Do something.
   LicensePool response = future.get();
 }
 

Unassigns a license from a user.

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 (LicenseManagementServiceClient licenseManagementServiceClient =
     LicenseManagementServiceClient.create()) {
   UnassignRequest request =
       UnassignRequest.newBuilder()
           .setParent("parent-995424086")
           .addAllUsernames(new ArrayList<String>())
           .build();
   UnassignResponse response = licenseManagementServiceClient.unassign(request);
 }
 

Unassigns a license from a user.

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 (LicenseManagementServiceClient licenseManagementServiceClient =
     LicenseManagementServiceClient.create()) {
   String parent = "parent-995424086";
   List<String> usernames = new ArrayList<>();
   UnassignResponse response = licenseManagementServiceClient.unassign(parent, usernames);
 }
 

Unassigns a license from a user.

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 (LicenseManagementServiceClient licenseManagementServiceClient =
     LicenseManagementServiceClient.create()) {
   UnassignRequest request =
       UnassignRequest.newBuilder()
           .setParent("parent-995424086")
           .addAllUsernames(new ArrayList<String>())
           .build();
   ApiFuture<UnassignResponse> future =
       licenseManagementServiceClient.unassignCallable().futureCall(request);
   // Do something.
   UnassignResponse response = future.get();
 }
 

Updates the license pool if one exists for this Order.

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 (LicenseManagementServiceClient licenseManagementServiceClient =
     LicenseManagementServiceClient.create()) {
   LicensePool licensePool = LicensePool.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   LicensePool response =
       licenseManagementServiceClient.updateLicensePool(licensePool, updateMask);
 }
 

Updates the license pool if one exists for this Order.

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 (LicenseManagementServiceClient licenseManagementServiceClient =
     LicenseManagementServiceClient.create()) {
   UpdateLicensePoolRequest request =
       UpdateLicensePoolRequest.newBuilder()
           .setLicensePool(LicensePool.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   LicensePool response = licenseManagementServiceClient.updateLicensePool(request);
 }
 

Updates the license pool if one exists for this Order.

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 (LicenseManagementServiceClient licenseManagementServiceClient =
     LicenseManagementServiceClient.create()) {
   UpdateLicensePoolRequest request =
       UpdateLicensePoolRequest.newBuilder()
           .setLicensePool(LicensePool.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<LicensePool> future =
       licenseManagementServiceClient.updateLicensePoolCallable().futureCall(request);
   // Do something.
   LicensePool response = future.get();
 }