- 0.60.0 (latest)
- 0.59.0
- 0.58.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
| GitHub Repository | Product Reference |
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().
| 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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Callable method variants take no parameters and return 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 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.
Static Methods
create()
public static final UserLicenseServiceClient create()Constructs an instance of UserLicenseServiceClient with default settings.
| Returns | |
|---|---|
| Type | Description |
UserLicenseServiceClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(UserLicenseServiceSettings settings)
public static final UserLicenseServiceClient create(UserLicenseServiceSettings settings)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.
| Parameter | |
|---|---|
| Name | Description |
settings |
UserLicenseServiceSettings |
| Returns | |
|---|---|
| Type | Description |
UserLicenseServiceClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(UserLicenseServiceStub stub)
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).
| Parameter | |
|---|---|
| Name | Description |
stub |
UserLicenseServiceStub |
| Returns | |
|---|---|
| Type | Description |
UserLicenseServiceClient |
|
Constructors
UserLicenseServiceClient(UserLicenseServiceSettings settings)
protected UserLicenseServiceClient(UserLicenseServiceSettings settings)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.
| Parameter | |
|---|---|
| Name | Description |
settings |
UserLicenseServiceSettings |
UserLicenseServiceClient(UserLicenseServiceStub stub)
protected UserLicenseServiceClient(UserLicenseServiceStub stub)| Parameter | |
|---|---|
| Name | Description |
stub |
UserLicenseServiceStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)| Parameters | |
|---|---|
| Name | Description |
duration |
long |
unit |
TimeUnit |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
| Exceptions | |
|---|---|
| Type | Description |
InterruptedException |
|
batchUpdateUserLicensesAsync(BatchUpdateUserLicensesRequest request)
public final 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();
}
| Parameter | |
|---|---|
| Name | Description |
request |
BatchUpdateUserLicensesRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
OperationFuture<BatchUpdateUserLicensesResponse,BatchUpdateUserLicensesMetadata> |
|
batchUpdateUserLicensesCallable()
public final UnaryCallable<BatchUpdateUserLicensesRequest,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();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<BatchUpdateUserLicensesRequest,Operation> |
|
batchUpdateUserLicensesOperationCallable()
public final 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();
}
| Returns | |
|---|---|
| Type | Description |
OperationCallable<BatchUpdateUserLicensesRequest,BatchUpdateUserLicensesResponse,BatchUpdateUserLicensesMetadata> |
|
close()
public final void close()getHttpJsonOperationsClient()
public final OperationsClient getHttpJsonOperationsClient()Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
| Returns | |
|---|---|
| Type | Description |
OperationsClient |
|
getOperationsClient()
public final OperationsClient getOperationsClient()Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
| Returns | |
|---|---|
| Type | Description |
OperationsClient |
|
getSettings()
public final UserLicenseServiceSettings getSettings()| Returns | |
|---|---|
| Type | Description |
UserLicenseServiceSettings |
|
getStub()
public UserLicenseServiceStub getStub()| Returns | |
|---|---|
| Type | Description |
UserLicenseServiceStub |
|
isShutdown()
public boolean isShutdown()| Returns | |
|---|---|
| Type | Description |
boolean |
|
isTerminated()
public boolean isTerminated()| Returns | |
|---|---|
| Type | Description |
boolean |
|
listUserLicenses(ListUserLicensesRequest request)
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);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
ListUserLicensesRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
UserLicenseServiceClient.ListUserLicensesPagedResponse |
|
listUserLicenses(UserStoreName parent)
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);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
UserStoreNameRequired. The parent [UserStore][] resource name, format:
|
| Returns | |
|---|---|
| Type | Description |
UserLicenseServiceClient.ListUserLicensesPagedResponse |
|
listUserLicenses(String parent)
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);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
StringRequired. The parent [UserStore][] resource name, format:
|
| Returns | |
|---|---|
| Type | Description |
UserLicenseServiceClient.ListUserLicensesPagedResponse |
|
listUserLicensesCallable()
public final 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;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListUserLicensesRequest,ListUserLicensesResponse> |
|
listUserLicensesPagedCallable()
public final 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);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListUserLicensesRequest,ListUserLicensesPagedResponse> |
|
shutdown()
public void shutdown()shutdownNow()
public void shutdownNow()