UserLicenseServiceClient (Google Discovery Engine API 0.84.0 API)

java.lang.Object
- com.google.cloud.discoveryengine.v1.UserLicenseServiceClient

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

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

Service Description: Service for managing User 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 (UserLicenseServiceClient userLicenseServiceClient = UserLicenseServiceClient.create()) {
   UserStoreName parent = UserStoreName.of("[PROJECT]", "[LOCATION]", "[USER_STORE]");
   for (UserLicense element : userLicenseServiceClient.listUserLicenses(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Note: close() needs to be called on the UserLicenseServiceClient 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
ListUserLicenses	Lists the User Licenses.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listUserLicenses(ListUserLicensesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listUserLicenses(UserStoreName parent) listUserLicenses(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listUserLicensesPagedCallable() listUserLicensesCallable()
BatchUpdateUserLicenses	Updates the User License. This method is used for batch assign/unassign licenses to users.	Request object method variants only take one parameter, a request object, which must be constructed before the call. batchUpdateUserLicensesAsync(BatchUpdateUserLicensesRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. batchUpdateUserLicensesOperationCallable() batchUpdateUserLicensesCallable()

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 UserLicenseServiceSettings 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
 UserLicenseServiceSettings userLicenseServiceSettings =
     UserLicenseServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 UserLicenseServiceClient userLicenseServiceClient =
     UserLicenseServiceClient.create(userLicenseServiceSettings);

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
 UserLicenseServiceSettings userLicenseServiceSettings =
     UserLicenseServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 UserLicenseServiceClient userLicenseServiceClient =
     UserLicenseServiceClient.create(userLicenseServiceSettings);

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
 UserLicenseServiceSettings userLicenseServiceSettings =
     UserLicenseServiceSettings.newHttpJsonBuilder().build();
 UserLicenseServiceClient userLicenseServiceClient =
     UserLicenseServiceClient.create(userLicenseServiceSettings);

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`UserLicenseServiceClient.ListUserLicensesFixedSizeCollection`
`static class`	`UserLicenseServiceClient.ListUserLicensesPage`
`static class`	`UserLicenseServiceClient.ListUserLicensesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`UserLicenseServiceClient(UserLicenseServiceSettings settings)` Constructs an instance of UserLicenseServiceClient, using the given settings.
`protected`	`UserLicenseServiceClient(UserLicenseServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`com.google.api.gax.longrunning.OperationFuture<BatchUpdateUserLicensesResponse,BatchUpdateUserLicensesMetadata>`	`batchUpdateUserLicensesAsync(BatchUpdateUserLicensesRequest request)` Updates the User License.
`com.google.api.gax.rpc.UnaryCallable<BatchUpdateUserLicensesRequest,com.google.longrunning.Operation>`	`batchUpdateUserLicensesCallable()` Updates the User License.
`com.google.api.gax.rpc.OperationCallable<BatchUpdateUserLicensesRequest,BatchUpdateUserLicensesResponse,BatchUpdateUserLicensesMetadata>`	`batchUpdateUserLicensesOperationCallable()` Updates the User License.
`void`	`close()`
`static UserLicenseServiceClient`	`create()` Constructs an instance of UserLicenseServiceClient with default settings.
`static UserLicenseServiceClient`	`create(UserLicenseServiceSettings settings)` Constructs an instance of UserLicenseServiceClient, using the given settings.
`static UserLicenseServiceClient`	`create(UserLicenseServiceStub stub)` Constructs an instance of UserLicenseServiceClient, using the given stub for making calls.
`com.google.api.gax.httpjson.longrunning.OperationsClient`	`getHttpJsonOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`com.google.longrunning.OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`UserLicenseServiceSettings`	`getSettings()`
`UserLicenseServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`UserLicenseServiceClient.ListUserLicensesPagedResponse`	`listUserLicenses(ListUserLicensesRequest request)` Lists the User Licenses.
`UserLicenseServiceClient.ListUserLicensesPagedResponse`	`listUserLicenses(String parent)` Lists the User Licenses.
`UserLicenseServiceClient.ListUserLicensesPagedResponse`	`listUserLicenses(UserStoreName parent)` Lists the User Licenses.
`com.google.api.gax.rpc.UnaryCallable<ListUserLicensesRequest,ListUserLicensesResponse>`	`listUserLicensesCallable()` Lists the User Licenses.
`com.google.api.gax.rpc.UnaryCallable<ListUserLicensesRequest,UserLicenseServiceClient.ListUserLicensesPagedResponse>`	`listUserLicensesPagedCallable()` Lists the User Licenses.
`void`	`shutdown()`
`void`	`shutdownNow()`

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

Constructor Detail
- UserLicenseServiceClient
```
protected UserLicenseServiceClient(UserLicenseServiceSettings settings)
                            throws IOException
```
  Constructs an instance of UserLicenseServiceClient, 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
- UserLicenseServiceClient
```
protected UserLicenseServiceClient(UserLicenseServiceStub stub)
```

Method Detail

create

public static final UserLicenseServiceClient create()
                                             throws IOException

Constructs an instance of UserLicenseServiceClient with default settings.

Throws:: IOException

create
```
public static final UserLicenseServiceClient create(UserLicenseServiceSettings settings)
                                             throws IOException
```
Constructs an instance of UserLicenseServiceClient, 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 UserLicenseServiceClient create(UserLicenseServiceStub stub)
```
Constructs an instance of UserLicenseServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(UserLicenseServiceSettings).

getSettings

public final UserLicenseServiceSettings getSettings()

getStub

public UserLicenseServiceStub getStub()

getOperationsClient
```
public final com.google.longrunning.OperationsClient getOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

getHttpJsonOperationsClient
```
@BetaApi
public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

listUserLicenses

public final UserLicenseServiceClient.ListUserLicensesPagedResponse listUserLicenses(UserStoreName parent)

Lists the User Licenses.

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 (UserLicenseServiceClient userLicenseServiceClient = UserLicenseServiceClient.create()) {
   UserStoreName parent = UserStoreName.of("[PROJECT]", "[LOCATION]", "[USER_STORE]");
   for (UserLicense element : userLicenseServiceClient.listUserLicenses(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. The parent [UserStore][] resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listUserLicenses

public final UserLicenseServiceClient.ListUserLicensesPagedResponse listUserLicenses(String parent)

Lists the User Licenses.

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 (UserLicenseServiceClient userLicenseServiceClient = UserLicenseServiceClient.create()) {
   String parent = UserStoreName.of("[PROJECT]", "[LOCATION]", "[USER_STORE]").toString();
   for (UserLicense element : userLicenseServiceClient.listUserLicenses(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. The parent [UserStore][] resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listUserLicenses

public final UserLicenseServiceClient.ListUserLicensesPagedResponse listUserLicenses(ListUserLicensesRequest request)

Lists the User Licenses.

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 (UserLicenseServiceClient userLicenseServiceClient = UserLicenseServiceClient.create()) {
   ListUserLicensesRequest request =
       ListUserLicensesRequest.newBuilder()
           .setParent(UserStoreName.of("[PROJECT]", "[LOCATION]", "[USER_STORE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   for (UserLicense element : userLicenseServiceClient.listUserLicenses(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

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

listUserLicensesPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListUserLicensesRequest,UserLicenseServiceClient.ListUserLicensesPagedResponse> listUserLicensesPagedCallable()

Lists the User Licenses.

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 (UserLicenseServiceClient userLicenseServiceClient = UserLicenseServiceClient.create()) {
   ListUserLicensesRequest request =
       ListUserLicensesRequest.newBuilder()
           .setParent(UserStoreName.of("[PROJECT]", "[LOCATION]", "[USER_STORE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<UserLicense> future =
       userLicenseServiceClient.listUserLicensesPagedCallable().futureCall(request);
   // Do something.
   for (UserLicense element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listUserLicensesCallable

public final com.google.api.gax.rpc.UnaryCallable<ListUserLicensesRequest,ListUserLicensesResponse> listUserLicensesCallable()

Lists the User Licenses.

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 (UserLicenseServiceClient userLicenseServiceClient = UserLicenseServiceClient.create()) {
   ListUserLicensesRequest request =
       ListUserLicensesRequest.newBuilder()
           .setParent(UserStoreName.of("[PROJECT]", "[LOCATION]", "[USER_STORE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListUserLicensesResponse response =
         userLicenseServiceClient.listUserLicensesCallable().call(request);
     for (UserLicense element : response.getUserLicensesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

batchUpdateUserLicensesAsync

public final com.google.api.gax.longrunning.OperationFuture<BatchUpdateUserLicensesResponse,BatchUpdateUserLicensesMetadata> batchUpdateUserLicensesAsync(BatchUpdateUserLicensesRequest request)

Updates the User License. This method is used for batch assign/unassign licenses to users.

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 (UserLicenseServiceClient userLicenseServiceClient = UserLicenseServiceClient.create()) {
   BatchUpdateUserLicensesRequest request =
       BatchUpdateUserLicensesRequest.newBuilder()
           .setParent(UserStoreName.of("[PROJECT]", "[LOCATION]", "[USER_STORE]").toString())
           .setDeleteUnassignedUserLicenses(true)
           .build();
   BatchUpdateUserLicensesResponse response =
       userLicenseServiceClient.batchUpdateUserLicensesAsync(request).get();
 }

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

batchUpdateUserLicensesOperationCallable

public final com.google.api.gax.rpc.OperationCallable<BatchUpdateUserLicensesRequest,BatchUpdateUserLicensesResponse,BatchUpdateUserLicensesMetadata> batchUpdateUserLicensesOperationCallable()

Updates the User License. This method is used for batch assign/unassign licenses to users.

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 (UserLicenseServiceClient userLicenseServiceClient = UserLicenseServiceClient.create()) {
   BatchUpdateUserLicensesRequest request =
       BatchUpdateUserLicensesRequest.newBuilder()
           .setParent(UserStoreName.of("[PROJECT]", "[LOCATION]", "[USER_STORE]").toString())
           .setDeleteUnassignedUserLicenses(true)
           .build();
   OperationFuture<BatchUpdateUserLicensesResponse, BatchUpdateUserLicensesMetadata> future =
       userLicenseServiceClient.batchUpdateUserLicensesOperationCallable().futureCall(request);
   // Do something.
   BatchUpdateUserLicensesResponse response = future.get();
 }

batchUpdateUserLicensesCallable

public final com.google.api.gax.rpc.UnaryCallable<BatchUpdateUserLicensesRequest,com.google.longrunning.Operation> batchUpdateUserLicensesCallable()

Updates the User License. This method is used for batch assign/unassign licenses to users.

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 (UserLicenseServiceClient userLicenseServiceClient = UserLicenseServiceClient.create()) {
   BatchUpdateUserLicensesRequest request =
       BatchUpdateUserLicensesRequest.newBuilder()
           .setParent(UserStoreName.of("[PROJECT]", "[LOCATION]", "[USER_STORE]").toString())
           .setDeleteUnassignedUserLicenses(true)
           .build();
   ApiFuture<Operation> future =
       userLicenseServiceClient.batchUpdateUserLicensesCallable().futureCall(request);
   // Do something.
   Operation 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 UserLicenseServiceClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserLicenseServiceClient

UserLicenseServiceClient

Method Detail

create

create

create

getSettings

getStub

getOperationsClient

getHttpJsonOperationsClient

listUserLicenses

listUserLicenses

listUserLicenses

listUserLicensesPagedCallable

listUserLicensesCallable

batchUpdateUserLicensesAsync

batchUpdateUserLicensesOperationCallable

batchUpdateUserLicensesCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination