Class UserListGlobalLicenseServiceClient (0.8.0)

Service Description: Service for managing user list global licenses. Delete is not a supported operation for UserListGlobalLicenses. Callers should update the license status to DISABLED to instead to deactivate a license.

This feature is only available to data partners.

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 (UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient =
     UserListGlobalLicenseServiceClient.create()) {
   AccountName parent = AccountName.of("[ACCOUNT_TYPE]", "[ACCOUNT]");
   UserListGlobalLicense userListGlobalLicense = UserListGlobalLicense.newBuilder().build();
   UserListGlobalLicense response =
       userListGlobalLicenseServiceClient.createUserListGlobalLicense(
           parent, userListGlobalLicense);
 }

Note: close() needs to be called on the UserListGlobalLicenseServiceClient 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
CreateUserListGlobalLicense	Creates a user list global license. This feature is only available to data partners.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createUserListGlobalLicense(CreateUserListGlobalLicenseRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createUserListGlobalLicense(AccountName parent, UserListGlobalLicense userListGlobalLicense) createUserListGlobalLicense(String parent, UserListGlobalLicense userListGlobalLicense) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createUserListGlobalLicenseCallable()
UpdateUserListGlobalLicense	Updates a user list global license. This feature is only available to data partners.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateUserListGlobalLicense(UpdateUserListGlobalLicenseRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateUserListGlobalLicense(UserListGlobalLicense userListGlobalLicense, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateUserListGlobalLicenseCallable()
GetUserListGlobalLicense	Retrieves a user list global license. This feature is only available to data partners.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getUserListGlobalLicense(GetUserListGlobalLicenseRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getUserListGlobalLicense(UserListGlobalLicenseName name) getUserListGlobalLicense(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getUserListGlobalLicenseCallable()
ListUserListGlobalLicenses	Lists all user list global licenses owned by the parent account. This feature is only available to data partners.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listUserListGlobalLicenses(ListUserListGlobalLicensesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listUserListGlobalLicenses(AccountName parent) listUserListGlobalLicenses(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. listUserListGlobalLicensesPagedCallable() listUserListGlobalLicensesCallable()
ListUserListGlobalLicenseCustomerInfos	Lists all customer info for a user list global license. This feature is only available to data partners.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listUserListGlobalLicenseCustomerInfos(ListUserListGlobalLicenseCustomerInfosRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listUserListGlobalLicenseCustomerInfos(UserListGlobalLicenseName parent) listUserListGlobalLicenseCustomerInfos(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. listUserListGlobalLicenseCustomerInfosPagedCallable() listUserListGlobalLicenseCustomerInfosCallable()

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 UserListGlobalLicenseServiceSettings 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
 UserListGlobalLicenseServiceSettings userListGlobalLicenseServiceSettings =
     UserListGlobalLicenseServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient =
     UserListGlobalLicenseServiceClient.create(userListGlobalLicenseServiceSettings);

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
 UserListGlobalLicenseServiceSettings userListGlobalLicenseServiceSettings =
     UserListGlobalLicenseServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient =
     UserListGlobalLicenseServiceClient.create(userListGlobalLicenseServiceSettings);

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
 UserListGlobalLicenseServiceSettings userListGlobalLicenseServiceSettings =
     UserListGlobalLicenseServiceSettings.newHttpJsonBuilder().build();
 UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient =
     UserListGlobalLicenseServiceClient.create(userListGlobalLicenseServiceSettings);

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

Inheritance

java.lang.Object > UserListGlobalLicenseServiceClient

Static Methods

create()

public static final UserListGlobalLicenseServiceClient create()

Constructs an instance of UserListGlobalLicenseServiceClient with default settings.

Returns
Type	Description
`UserListGlobalLicenseServiceClient`

Exceptions
Type	Description
`IOException`

create(UserListGlobalLicenseServiceSettings settings)

public static final UserListGlobalLicenseServiceClient create(UserListGlobalLicenseServiceSettings settings)

Constructs an instance of UserListGlobalLicenseServiceClient, 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`	`UserListGlobalLicenseServiceSettings`

Returns
Type	Description
`UserListGlobalLicenseServiceClient`

Exceptions
Type	Description
`IOException`

create(UserListGlobalLicenseServiceStub stub)

public static final UserListGlobalLicenseServiceClient create(UserListGlobalLicenseServiceStub stub)

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

Parameter
Name	Description
`stub`	`UserListGlobalLicenseServiceStub`

Returns
Type	Description
`UserListGlobalLicenseServiceClient`

Constructors

UserListGlobalLicenseServiceClient(UserListGlobalLicenseServiceSettings settings)

protected UserListGlobalLicenseServiceClient(UserListGlobalLicenseServiceSettings settings)

Constructs an instance of UserListGlobalLicenseServiceClient, 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`	`UserListGlobalLicenseServiceSettings`

UserListGlobalLicenseServiceClient(UserListGlobalLicenseServiceStub stub)

protected UserListGlobalLicenseServiceClient(UserListGlobalLicenseServiceStub stub)

Parameter
Name	Description
`stub`	`UserListGlobalLicenseServiceStub`

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`

close()

public final void close()

createUserListGlobalLicense(AccountName parent, UserListGlobalLicense userListGlobalLicense)

public final UserListGlobalLicense createUserListGlobalLicense(AccountName parent, UserListGlobalLicense userListGlobalLicense)

Creates a user list global license.

This feature is only available to data partners.

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 (UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient =
     UserListGlobalLicenseServiceClient.create()) {
   AccountName parent = AccountName.of("[ACCOUNT_TYPE]", "[ACCOUNT]");
   UserListGlobalLicense userListGlobalLicense = UserListGlobalLicense.newBuilder().build();
   UserListGlobalLicense response =
       userListGlobalLicenseServiceClient.createUserListGlobalLicense(
           parent, userListGlobalLicense);
 }

Parameters
Name	Description
`parent`	`AccountName` Required. The account that owns the user list being licensed. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}
`userListGlobalLicense`	`UserListGlobalLicense` Required. The user list global license to create.

Returns
Type	Description
`UserListGlobalLicense`

createUserListGlobalLicense(CreateUserListGlobalLicenseRequest request)

public final UserListGlobalLicense createUserListGlobalLicense(CreateUserListGlobalLicenseRequest request)

Creates a user list global license.

This feature is only available to data partners.

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 (UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient =
     UserListGlobalLicenseServiceClient.create()) {
   CreateUserListGlobalLicenseRequest request =
       CreateUserListGlobalLicenseRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT_TYPE]", "[ACCOUNT]").toString())
           .setUserListGlobalLicense(UserListGlobalLicense.newBuilder().build())
           .build();
   UserListGlobalLicense response =
       userListGlobalLicenseServiceClient.createUserListGlobalLicense(request);
 }

Parameter
Name	Description
`request`	`CreateUserListGlobalLicenseRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`UserListGlobalLicense`

createUserListGlobalLicense(String parent, UserListGlobalLicense userListGlobalLicense)

public final UserListGlobalLicense createUserListGlobalLicense(String parent, UserListGlobalLicense userListGlobalLicense)

Creates a user list global license.

This feature is only available to data partners.

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 (UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient =
     UserListGlobalLicenseServiceClient.create()) {
   String parent = AccountName.of("[ACCOUNT_TYPE]", "[ACCOUNT]").toString();
   UserListGlobalLicense userListGlobalLicense = UserListGlobalLicense.newBuilder().build();
   UserListGlobalLicense response =
       userListGlobalLicenseServiceClient.createUserListGlobalLicense(
           parent, userListGlobalLicense);
 }

Parameters
Name	Description
`parent`	`String` Required. The account that owns the user list being licensed. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}
`userListGlobalLicense`	`UserListGlobalLicense` Required. The user list global license to create.

Returns
Type	Description
`UserListGlobalLicense`

createUserListGlobalLicenseCallable()

public final UnaryCallable<CreateUserListGlobalLicenseRequest,UserListGlobalLicense> createUserListGlobalLicenseCallable()

Creates a user list global license.

This feature is only available to data partners.

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 (UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient =
     UserListGlobalLicenseServiceClient.create()) {
   CreateUserListGlobalLicenseRequest request =
       CreateUserListGlobalLicenseRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT_TYPE]", "[ACCOUNT]").toString())
           .setUserListGlobalLicense(UserListGlobalLicense.newBuilder().build())
           .build();
   ApiFuture<UserListGlobalLicense> future =
       userListGlobalLicenseServiceClient
           .createUserListGlobalLicenseCallable()
           .futureCall(request);
   // Do something.
   UserListGlobalLicense response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateUserListGlobalLicenseRequest,UserListGlobalLicense>`

getSettings()

public final UserListGlobalLicenseServiceSettings getSettings()

Returns
Type	Description
`UserListGlobalLicenseServiceSettings`

getStub()

public UserListGlobalLicenseServiceStub getStub()

Returns
Type	Description
`UserListGlobalLicenseServiceStub`

getUserListGlobalLicense(GetUserListGlobalLicenseRequest request)

public final UserListGlobalLicense getUserListGlobalLicense(GetUserListGlobalLicenseRequest request)

Retrieves a user list global license.

This feature is only available to data partners.

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 (UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient =
     UserListGlobalLicenseServiceClient.create()) {
   GetUserListGlobalLicenseRequest request =
       GetUserListGlobalLicenseRequest.newBuilder()
           .setName(
               UserListGlobalLicenseName.of(
                       "[ACCOUNT_TYPE]", "[ACCOUNT]", "[USER_LIST_GLOBAL_LICENSE]")
                   .toString())
           .build();
   UserListGlobalLicense response =
       userListGlobalLicenseServiceClient.getUserListGlobalLicense(request);
 }

Parameter
Name	Description
`request`	`GetUserListGlobalLicenseRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`UserListGlobalLicense`

getUserListGlobalLicense(UserListGlobalLicenseName name)

public final UserListGlobalLicense getUserListGlobalLicense(UserListGlobalLicenseName name)

Retrieves a user list global license.

This feature is only available to data partners.

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 (UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient =
     UserListGlobalLicenseServiceClient.create()) {
   UserListGlobalLicenseName name =
       UserListGlobalLicenseName.of("[ACCOUNT_TYPE]", "[ACCOUNT]", "[USER_LIST_GLOBAL_LICENSE]");
   UserListGlobalLicense response =
       userListGlobalLicenseServiceClient.getUserListGlobalLicense(name);
 }

Parameter
Name	Description
`name`	`UserListGlobalLicenseName` Required. The resource name of the user list global license.

Returns
Type	Description
`UserListGlobalLicense`

getUserListGlobalLicense(String name)

public final UserListGlobalLicense getUserListGlobalLicense(String name)

Retrieves a user list global license.

This feature is only available to data partners.

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 (UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient =
     UserListGlobalLicenseServiceClient.create()) {
   String name =
       UserListGlobalLicenseName.of("[ACCOUNT_TYPE]", "[ACCOUNT]", "[USER_LIST_GLOBAL_LICENSE]")
           .toString();
   UserListGlobalLicense response =
       userListGlobalLicenseServiceClient.getUserListGlobalLicense(name);
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the user list global license.

Returns
Type	Description
`UserListGlobalLicense`

getUserListGlobalLicenseCallable()

public final UnaryCallable<GetUserListGlobalLicenseRequest,UserListGlobalLicense> getUserListGlobalLicenseCallable()

Retrieves a user list global license.

This feature is only available to data partners.

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 (UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient =
     UserListGlobalLicenseServiceClient.create()) {
   GetUserListGlobalLicenseRequest request =
       GetUserListGlobalLicenseRequest.newBuilder()
           .setName(
               UserListGlobalLicenseName.of(
                       "[ACCOUNT_TYPE]", "[ACCOUNT]", "[USER_LIST_GLOBAL_LICENSE]")
                   .toString())
           .build();
   ApiFuture<UserListGlobalLicense> future =
       userListGlobalLicenseServiceClient.getUserListGlobalLicenseCallable().futureCall(request);
   // Do something.
   UserListGlobalLicense response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetUserListGlobalLicenseRequest,UserListGlobalLicense>`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listUserListGlobalLicenseCustomerInfos(ListUserListGlobalLicenseCustomerInfosRequest request)

public final UserListGlobalLicenseServiceClient.ListUserListGlobalLicenseCustomerInfosPagedResponse listUserListGlobalLicenseCustomerInfos(ListUserListGlobalLicenseCustomerInfosRequest request)

Lists all customer info for a user list global license.

This feature is only available to data partners.

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 (UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient =
     UserListGlobalLicenseServiceClient.create()) {
   ListUserListGlobalLicenseCustomerInfosRequest request =
       ListUserListGlobalLicenseCustomerInfosRequest.newBuilder()
           .setParent(
               UserListGlobalLicenseName.of(
                       "[ACCOUNT_TYPE]", "[ACCOUNT]", "[USER_LIST_GLOBAL_LICENSE]")
                   .toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (UserListGlobalLicenseCustomerInfo element :
       userListGlobalLicenseServiceClient
           .listUserListGlobalLicenseCustomerInfos(request)
           .iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListUserListGlobalLicenseCustomerInfosRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`UserListGlobalLicenseServiceClient.ListUserListGlobalLicenseCustomerInfosPagedResponse`

listUserListGlobalLicenseCustomerInfos(UserListGlobalLicenseName parent)

public final UserListGlobalLicenseServiceClient.ListUserListGlobalLicenseCustomerInfosPagedResponse listUserListGlobalLicenseCustomerInfos(UserListGlobalLicenseName parent)

Lists all customer info for a user list global license.

This feature is only available to data partners.

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 (UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient =
     UserListGlobalLicenseServiceClient.create()) {
   UserListGlobalLicenseName parent =
       UserListGlobalLicenseName.of("[ACCOUNT_TYPE]", "[ACCOUNT]", "[USER_LIST_GLOBAL_LICENSE]");
   for (UserListGlobalLicenseCustomerInfo element :
       userListGlobalLicenseServiceClient
           .listUserListGlobalLicenseCustomerInfos(parent)
           .iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name Description

parent

UserListGlobalLicenseName

Required. The global license whose customer info are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}/userListGlobalLicenses/{USER_LIST_GLOBAL_LICENSE_ID}. To list all global license customer info under an account, replace the user list global license id with a '-' (for example, accountTypes/DATA_PARTNER/accounts/123/userListGlobalLicenses/-)

Returns
Type	Description
`UserListGlobalLicenseServiceClient.ListUserListGlobalLicenseCustomerInfosPagedResponse`

listUserListGlobalLicenseCustomerInfos(String parent)

public final UserListGlobalLicenseServiceClient.ListUserListGlobalLicenseCustomerInfosPagedResponse listUserListGlobalLicenseCustomerInfos(String parent)

Lists all customer info for a user list global license.

This feature is only available to data partners.

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 (UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient =
     UserListGlobalLicenseServiceClient.create()) {
   String parent =
       UserListGlobalLicenseName.of("[ACCOUNT_TYPE]", "[ACCOUNT]", "[USER_LIST_GLOBAL_LICENSE]")
           .toString();
   for (UserListGlobalLicenseCustomerInfo element :
       userListGlobalLicenseServiceClient
           .listUserListGlobalLicenseCustomerInfos(parent)
           .iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The global license whose customer info are being queried. Should be in the format `accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}/userListGlobalLicenses/{USER_LIST_GLOBAL_LICENSE_ID}`. To list all global license customer info under an account, replace the user list global license id with a '-' (for example, `accountTypes/DATA_PARTNER/accounts/123/userListGlobalLicenses/-`)

Returns
Type	Description
`UserListGlobalLicenseServiceClient.ListUserListGlobalLicenseCustomerInfosPagedResponse`

listUserListGlobalLicenseCustomerInfosCallable()

public final UnaryCallable<ListUserListGlobalLicenseCustomerInfosRequest,ListUserListGlobalLicenseCustomerInfosResponse> listUserListGlobalLicenseCustomerInfosCallable()

Lists all customer info for a user list global license.

This feature is only available to data partners.

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 (UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient =
     UserListGlobalLicenseServiceClient.create()) {
   ListUserListGlobalLicenseCustomerInfosRequest request =
       ListUserListGlobalLicenseCustomerInfosRequest.newBuilder()
           .setParent(
               UserListGlobalLicenseName.of(
                       "[ACCOUNT_TYPE]", "[ACCOUNT]", "[USER_LIST_GLOBAL_LICENSE]")
                   .toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListUserListGlobalLicenseCustomerInfosResponse response =
         userListGlobalLicenseServiceClient
             .listUserListGlobalLicenseCustomerInfosCallable()
             .call(request);
     for (UserListGlobalLicenseCustomerInfo element :
         response.getUserListGlobalLicenseCustomerInfosList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListUserListGlobalLicenseCustomerInfosRequest,ListUserListGlobalLicenseCustomerInfosResponse>`

listUserListGlobalLicenseCustomerInfosPagedCallable()

public final UnaryCallable<ListUserListGlobalLicenseCustomerInfosRequest,UserListGlobalLicenseServiceClient.ListUserListGlobalLicenseCustomerInfosPagedResponse> listUserListGlobalLicenseCustomerInfosPagedCallable()

Lists all customer info for a user list global license.

This feature is only available to data partners.

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 (UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient =
     UserListGlobalLicenseServiceClient.create()) {
   ListUserListGlobalLicenseCustomerInfosRequest request =
       ListUserListGlobalLicenseCustomerInfosRequest.newBuilder()
           .setParent(
               UserListGlobalLicenseName.of(
                       "[ACCOUNT_TYPE]", "[ACCOUNT]", "[USER_LIST_GLOBAL_LICENSE]")
                   .toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<UserListGlobalLicenseCustomerInfo> future =
       userListGlobalLicenseServiceClient
           .listUserListGlobalLicenseCustomerInfosPagedCallable()
           .futureCall(request);
   // Do something.
   for (UserListGlobalLicenseCustomerInfo element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListUserListGlobalLicenseCustomerInfosRequest,ListUserListGlobalLicenseCustomerInfosPagedResponse>`

listUserListGlobalLicenses(AccountName parent)

public final UserListGlobalLicenseServiceClient.ListUserListGlobalLicensesPagedResponse listUserListGlobalLicenses(AccountName parent)

Lists all user list global licenses owned by the parent account.

This feature is only available to data partners.

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 (UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient =
     UserListGlobalLicenseServiceClient.create()) {
   AccountName parent = AccountName.of("[ACCOUNT_TYPE]", "[ACCOUNT]");
   for (UserListGlobalLicense element :
       userListGlobalLicenseServiceClient.listUserListGlobalLicenses(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`AccountName` Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}

Returns
Type	Description
`UserListGlobalLicenseServiceClient.ListUserListGlobalLicensesPagedResponse`

listUserListGlobalLicenses(ListUserListGlobalLicensesRequest request)

public final UserListGlobalLicenseServiceClient.ListUserListGlobalLicensesPagedResponse listUserListGlobalLicenses(ListUserListGlobalLicensesRequest request)

Lists all user list global licenses owned by the parent account.

This feature is only available to data partners.

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 (UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient =
     UserListGlobalLicenseServiceClient.create()) {
   ListUserListGlobalLicensesRequest request =
       ListUserListGlobalLicensesRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT_TYPE]", "[ACCOUNT]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (UserListGlobalLicense element :
       userListGlobalLicenseServiceClient.listUserListGlobalLicenses(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListUserListGlobalLicensesRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`UserListGlobalLicenseServiceClient.ListUserListGlobalLicensesPagedResponse`

listUserListGlobalLicenses(String parent)

public final UserListGlobalLicenseServiceClient.ListUserListGlobalLicensesPagedResponse listUserListGlobalLicenses(String parent)

Lists all user list global licenses owned by the parent account.

This feature is only available to data partners.

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 (UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient =
     UserListGlobalLicenseServiceClient.create()) {
   String parent = AccountName.of("[ACCOUNT_TYPE]", "[ACCOUNT]").toString();
   for (UserListGlobalLicense element :
       userListGlobalLicenseServiceClient.listUserListGlobalLicenses(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}

Returns
Type	Description
`UserListGlobalLicenseServiceClient.ListUserListGlobalLicensesPagedResponse`

listUserListGlobalLicensesCallable()

public final UnaryCallable<ListUserListGlobalLicensesRequest,ListUserListGlobalLicensesResponse> listUserListGlobalLicensesCallable()

Lists all user list global licenses owned by the parent account.

This feature is only available to data partners.

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 (UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient =
     UserListGlobalLicenseServiceClient.create()) {
   ListUserListGlobalLicensesRequest request =
       ListUserListGlobalLicensesRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT_TYPE]", "[ACCOUNT]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListUserListGlobalLicensesResponse response =
         userListGlobalLicenseServiceClient.listUserListGlobalLicensesCallable().call(request);
     for (UserListGlobalLicense element : response.getUserListGlobalLicensesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListUserListGlobalLicensesRequest,ListUserListGlobalLicensesResponse>`

listUserListGlobalLicensesPagedCallable()

public final UnaryCallable<ListUserListGlobalLicensesRequest,UserListGlobalLicenseServiceClient.ListUserListGlobalLicensesPagedResponse> listUserListGlobalLicensesPagedCallable()

Lists all user list global licenses owned by the parent account.

This feature is only available to data partners.

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 (UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient =
     UserListGlobalLicenseServiceClient.create()) {
   ListUserListGlobalLicensesRequest request =
       ListUserListGlobalLicensesRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT_TYPE]", "[ACCOUNT]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<UserListGlobalLicense> future =
       userListGlobalLicenseServiceClient
           .listUserListGlobalLicensesPagedCallable()
           .futureCall(request);
   // Do something.
   for (UserListGlobalLicense element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListUserListGlobalLicensesRequest,ListUserListGlobalLicensesPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateUserListGlobalLicense(UpdateUserListGlobalLicenseRequest request)

public final UserListGlobalLicense updateUserListGlobalLicense(UpdateUserListGlobalLicenseRequest request)

Updates a user list global license.

This feature is only available to data partners.

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 (UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient =
     UserListGlobalLicenseServiceClient.create()) {
   UpdateUserListGlobalLicenseRequest request =
       UpdateUserListGlobalLicenseRequest.newBuilder()
           .setUserListGlobalLicense(UserListGlobalLicense.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   UserListGlobalLicense response =
       userListGlobalLicenseServiceClient.updateUserListGlobalLicense(request);
 }

Parameter
Name	Description
`request`	`UpdateUserListGlobalLicenseRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`UserListGlobalLicense`

updateUserListGlobalLicense(UserListGlobalLicense userListGlobalLicense, FieldMask updateMask)

public final UserListGlobalLicense updateUserListGlobalLicense(UserListGlobalLicense userListGlobalLicense, FieldMask updateMask)

Updates a user list global license.

This feature is only available to data partners.

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 (UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient =
     UserListGlobalLicenseServiceClient.create()) {
   UserListGlobalLicense userListGlobalLicense = UserListGlobalLicense.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   UserListGlobalLicense response =
       userListGlobalLicenseServiceClient.updateUserListGlobalLicense(
           userListGlobalLicense, updateMask);
 }

Parameters
Name	Description
`userListGlobalLicense`	`UserListGlobalLicense` Required. The licenses' `name` field is used to identify the license to update.
`updateMask`	`FieldMask` Optional. The list of fields to update. The special character `*` is not supported and an `INVALID_UPDATE_MASK` error will be thrown if used.

Returns
Type	Description
`UserListGlobalLicense`

updateUserListGlobalLicenseCallable()

public final UnaryCallable<UpdateUserListGlobalLicenseRequest,UserListGlobalLicense> updateUserListGlobalLicenseCallable()

Updates a user list global license.

This feature is only available to data partners.

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 (UserListGlobalLicenseServiceClient userListGlobalLicenseServiceClient =
     UserListGlobalLicenseServiceClient.create()) {
   UpdateUserListGlobalLicenseRequest request =
       UpdateUserListGlobalLicenseRequest.newBuilder()
           .setUserListGlobalLicense(UserListGlobalLicense.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<UserListGlobalLicense> future =
       userListGlobalLicenseServiceClient
           .updateUserListGlobalLicenseCallable()
           .futureCall(request);
   // Do something.
   UserListGlobalLicense response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateUserListGlobalLicenseRequest,UserListGlobalLicense>`

Class UserListGlobalLicenseServiceClient (0.8.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Static Methods

create()

create(UserListGlobalLicenseServiceSettings settings)

create(UserListGlobalLicenseServiceStub stub)

Constructors

UserListGlobalLicenseServiceClient(UserListGlobalLicenseServiceSettings settings)

UserListGlobalLicenseServiceClient(UserListGlobalLicenseServiceStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

close()

createUserListGlobalLicense(AccountName parent, UserListGlobalLicense userListGlobalLicense)

createUserListGlobalLicense(CreateUserListGlobalLicenseRequest request)

createUserListGlobalLicense(String parent, UserListGlobalLicense userListGlobalLicense)

createUserListGlobalLicenseCallable()

getSettings()

getStub()

getUserListGlobalLicense(GetUserListGlobalLicenseRequest request)

getUserListGlobalLicense(UserListGlobalLicenseName name)

getUserListGlobalLicense(String name)

getUserListGlobalLicenseCallable()

isShutdown()

isTerminated()

listUserListGlobalLicenseCustomerInfos(ListUserListGlobalLicenseCustomerInfosRequest request)

listUserListGlobalLicenseCustomerInfos(UserListGlobalLicenseName parent)

listUserListGlobalLicenseCustomerInfos(String parent)

listUserListGlobalLicenseCustomerInfosCallable()

listUserListGlobalLicenseCustomerInfosPagedCallable()

listUserListGlobalLicenses(AccountName parent)

listUserListGlobalLicenses(ListUserListGlobalLicensesRequest request)

listUserListGlobalLicenses(String parent)

listUserListGlobalLicensesCallable()

listUserListGlobalLicensesPagedCallable()

shutdown()

shutdownNow()

updateUserListGlobalLicense(UpdateUserListGlobalLicenseRequest request)

updateUserListGlobalLicense(UserListGlobalLicense userListGlobalLicense, FieldMask updateMask)

updateUserListGlobalLicenseCallable()

Class UserListGlobalLicenseServiceClient (0.8.0)