Class UserServiceClient (1.23.0)

Service Description: Service to support user API.

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 (UserServiceClient userServiceClient = UserServiceClient.create()) {
   UserName name = UserName.of("[ACCOUNT]", "[EMAIL]");
   User response = userServiceClient.getUser(name);
 }

Note: close() needs to be called on the UserServiceClient 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
GetUser	Retrieves a Merchant Center account user.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getUser(GetUserRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getUser(UserName name) getUser(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. getUserCallable()
CreateUser	Creates a Merchant Center account user. Executing this method requires admin access.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createUser(CreateUserRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createUser(AccountName parent, User user) createUser(String parent, User user) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createUserCallable()
DeleteUser	Deletes a Merchant Center account user. Executing this method requires admin access.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteUser(DeleteUserRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteUser(UserName name) deleteUser(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. deleteUserCallable()
UpdateUser	Updates a Merchant Center account user. Executing this method requires admin access.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateUser(UpdateUserRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateUser(User user, 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. updateUserCallable()
ListUsers	Lists all users of a Merchant Center account.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listUsers(ListUsersRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listUsers(AccountName parent) listUsers(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. listUsersPagedCallable() listUsersCallable()

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 UserServiceSettings 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
 UserServiceSettings userServiceSettings =
     UserServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 UserServiceClient userServiceClient = UserServiceClient.create(userServiceSettings);

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
 UserServiceSettings userServiceSettings =
     UserServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 UserServiceClient userServiceClient = UserServiceClient.create(userServiceSettings);

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
 UserServiceSettings userServiceSettings = UserServiceSettings.newHttpJsonBuilder().build();
 UserServiceClient userServiceClient = UserServiceClient.create(userServiceSettings);

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

Inheritance

java.lang.Object > UserServiceClient

Static Methods

create()

public static final UserServiceClient create()

Constructs an instance of UserServiceClient with default settings.

Returns
Type	Description
`UserServiceClient`

Exceptions
Type	Description
`IOException`

create(UserServiceSettings settings)

public static final UserServiceClient create(UserServiceSettings settings)

Constructs an instance of UserServiceClient, 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`	`UserServiceSettings`

Returns
Type	Description
`UserServiceClient`

Exceptions
Type	Description
`IOException`

create(UserServiceStub stub)

public static final UserServiceClient create(UserServiceStub stub)

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

Parameter
Name	Description
`stub`	`UserServiceStub`

Returns
Type	Description
`UserServiceClient`

Constructors

UserServiceClient(UserServiceSettings settings)

protected UserServiceClient(UserServiceSettings settings)

Constructs an instance of UserServiceClient, 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`	`UserServiceSettings`

UserServiceClient(UserServiceStub stub)

protected UserServiceClient(UserServiceStub stub)

Parameter
Name	Description
`stub`	`UserServiceStub`

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()

createUser(@Nullable AccountName parent, User user)

public final User createUser(@Nullable AccountName parent, User user)

Creates a Merchant Center account user. Executing this method requires admin access.

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 (UserServiceClient userServiceClient = UserServiceClient.create()) {
   AccountName parent = AccountName.of("[ACCOUNT]");
   User user = User.newBuilder().build();
   User response = userServiceClient.createUser(parent, user);
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.shopping.merchant.accounts.v1beta.AccountName` Required. The resource name of the account for which a user will be created. Format: `accounts/{account}`
`user`	`User` Required. The user to create.

Returns
Type	Description
`User`

createUser(CreateUserRequest request)

public final User createUser(CreateUserRequest request)

Creates a Merchant Center account user. Executing this method requires admin access.

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 (UserServiceClient userServiceClient = UserServiceClient.create()) {
   CreateUserRequest request =
       CreateUserRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setUserId("userId-836030906")
           .setUser(User.newBuilder().build())
           .build();
   User response = userServiceClient.createUser(request);
 }

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

Returns
Type	Description
`User`

createUser(String parent, User user)

public final User createUser(String parent, User user)

Creates a Merchant Center account user. Executing this method requires admin access.

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 (UserServiceClient userServiceClient = UserServiceClient.create()) {
   String parent = AccountName.of("[ACCOUNT]").toString();
   User user = User.newBuilder().build();
   User response = userServiceClient.createUser(parent, user);
 }

Parameters
Name	Description
`parent`	`String` Required. The resource name of the account for which a user will be created. Format: `accounts/{account}`
`user`	`User` Required. The user to create.

Returns
Type	Description
`User`

createUserCallable()

public final UnaryCallable<CreateUserRequest,User> createUserCallable()

Creates a Merchant Center account user. Executing this method requires admin access.

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 (UserServiceClient userServiceClient = UserServiceClient.create()) {
   CreateUserRequest request =
       CreateUserRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setUserId("userId-836030906")
           .setUser(User.newBuilder().build())
           .build();
   ApiFuture<User> future = userServiceClient.createUserCallable().futureCall(request);
   // Do something.
   User response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateUserRequest,User>`

deleteUser(@Nullable UserName name)

public final void deleteUser(@Nullable UserName name)

Deletes a Merchant Center account user. Executing this method requires admin access.

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 (UserServiceClient userServiceClient = UserServiceClient.create()) {
   UserName name = UserName.of("[ACCOUNT]", "[EMAIL]");
   userServiceClient.deleteUser(name);
 }

Parameter

Name Description

name

@org.jspecify.annotations.Nullable com.google.shopping.merchant.accounts.v1beta.UserName

Required. The name of the user to delete. Format: accounts/{account}/users/{email}

It is also possible to delete the user corresponding to the caller by using me rather than an email address as in accounts/{account}/users/me.

deleteUser(DeleteUserRequest request)

public final void deleteUser(DeleteUserRequest request)

Deletes a Merchant Center account user. Executing this method requires admin access.

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 (UserServiceClient userServiceClient = UserServiceClient.create()) {
   DeleteUserRequest request =
       DeleteUserRequest.newBuilder()
           .setName(UserName.of("[ACCOUNT]", "[EMAIL]").toString())
           .build();
   userServiceClient.deleteUser(request);
 }

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

deleteUser(String name)

public final void deleteUser(String name)

Deletes a Merchant Center account user. Executing this method requires admin access.

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 (UserServiceClient userServiceClient = UserServiceClient.create()) {
   String name = UserName.of("[ACCOUNT]", "[EMAIL]").toString();
   userServiceClient.deleteUser(name);
 }

Parameter

Name Description

name

String

Required. The name of the user to delete. Format: accounts/{account}/users/{email}

It is also possible to delete the user corresponding to the caller by using me rather than an email address as in accounts/{account}/users/me.

deleteUserCallable()

public final UnaryCallable<DeleteUserRequest,Empty> deleteUserCallable()

Deletes a Merchant Center account user. Executing this method requires admin access.

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 (UserServiceClient userServiceClient = UserServiceClient.create()) {
   DeleteUserRequest request =
       DeleteUserRequest.newBuilder()
           .setName(UserName.of("[ACCOUNT]", "[EMAIL]").toString())
           .build();
   ApiFuture<Empty> future = userServiceClient.deleteUserCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteUserRequest,Empty>`

getSettings()

public final @Nullable UserServiceSettings getSettings()

Returns
Type	Description
`@org.jspecify.annotations.Nullable com.google.shopping.merchant.accounts.v1beta.UserServiceSettings`

getStub()

public UserServiceStub getStub()

Returns
Type	Description
`UserServiceStub`

getUser(@Nullable UserName name)

public final User getUser(@Nullable UserName name)

Retrieves a Merchant Center account 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 (UserServiceClient userServiceClient = UserServiceClient.create()) {
   UserName name = UserName.of("[ACCOUNT]", "[EMAIL]");
   User response = userServiceClient.getUser(name);
 }

Parameter

Name Description

name

@org.jspecify.annotations.Nullable com.google.shopping.merchant.accounts.v1beta.UserName

Required. The name of the user to retrieve. Format: accounts/{account}/users/{email}

It is also possible to retrieve the user corresponding to the caller by using me rather than an email address as in accounts/{account}/users/me.

Returns
Type	Description
`User`

getUser(GetUserRequest request)

public final User getUser(GetUserRequest request)

Retrieves a Merchant Center account 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 (UserServiceClient userServiceClient = UserServiceClient.create()) {
   GetUserRequest request =
       GetUserRequest.newBuilder()
           .setName(UserName.of("[ACCOUNT]", "[EMAIL]").toString())
           .build();
   User response = userServiceClient.getUser(request);
 }

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

Returns
Type	Description
`User`

getUser(String name)

public final User getUser(String name)

Retrieves a Merchant Center account 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 (UserServiceClient userServiceClient = UserServiceClient.create()) {
   String name = UserName.of("[ACCOUNT]", "[EMAIL]").toString();
   User response = userServiceClient.getUser(name);
 }

Parameter

Name Description

name

String

Required. The name of the user to retrieve. Format: accounts/{account}/users/{email}

It is also possible to retrieve the user corresponding to the caller by using me rather than an email address as in accounts/{account}/users/me.

Returns
Type	Description
`User`

getUserCallable()

public final UnaryCallable<GetUserRequest,User> getUserCallable()

Retrieves a Merchant Center account 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 (UserServiceClient userServiceClient = UserServiceClient.create()) {
   GetUserRequest request =
       GetUserRequest.newBuilder()
           .setName(UserName.of("[ACCOUNT]", "[EMAIL]").toString())
           .build();
   ApiFuture<User> future = userServiceClient.getUserCallable().futureCall(request);
   // Do something.
   User response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetUserRequest,User>`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listUsers(@Nullable AccountName parent)

public final UserServiceClient.ListUsersPagedResponse listUsers(@Nullable AccountName parent)

Lists all users of a Merchant Center account.

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 (UserServiceClient userServiceClient = UserServiceClient.create()) {
   AccountName parent = AccountName.of("[ACCOUNT]");
   for (User element : userServiceClient.listUsers(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.shopping.merchant.accounts.v1beta.AccountName` Required. The parent, which owns this collection of users. Format: `accounts/{account}`

Returns
Type	Description
`UserServiceClient.ListUsersPagedResponse`

listUsers(ListUsersRequest request)

public final UserServiceClient.ListUsersPagedResponse listUsers(ListUsersRequest request)

Lists all users of a Merchant Center account.

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 (UserServiceClient userServiceClient = UserServiceClient.create()) {
   ListUsersRequest request =
       ListUsersRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (User element : userServiceClient.listUsers(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

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

Returns
Type	Description
`UserServiceClient.ListUsersPagedResponse`

listUsers(String parent)

public final UserServiceClient.ListUsersPagedResponse listUsers(String parent)

Lists all users of a Merchant Center account.

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 (UserServiceClient userServiceClient = UserServiceClient.create()) {
   String parent = AccountName.of("[ACCOUNT]").toString();
   for (User element : userServiceClient.listUsers(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The parent, which owns this collection of users. Format: `accounts/{account}`

Returns
Type	Description
`UserServiceClient.ListUsersPagedResponse`

listUsersCallable()

public final UnaryCallable<ListUsersRequest,ListUsersResponse> listUsersCallable()

Lists all users of a Merchant Center account.

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 (UserServiceClient userServiceClient = UserServiceClient.create()) {
   ListUsersRequest request =
       ListUsersRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListUsersResponse response = userServiceClient.listUsersCallable().call(request);
     for (User element : response.getUsersList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListUsersRequest,ListUsersResponse>`

listUsersPagedCallable()

public final UnaryCallable<ListUsersRequest,UserServiceClient.ListUsersPagedResponse> listUsersPagedCallable()

Lists all users of a Merchant Center account.

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 (UserServiceClient userServiceClient = UserServiceClient.create()) {
   ListUsersRequest request =
       ListUsersRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<User> future = userServiceClient.listUsersPagedCallable().futureCall(request);
   // Do something.
   for (User element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListUsersRequest,ListUsersPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateUser(UpdateUserRequest request)

public final User updateUser(UpdateUserRequest request)

Updates a Merchant Center account user. Executing this method requires admin access.

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 (UserServiceClient userServiceClient = UserServiceClient.create()) {
   UpdateUserRequest request =
       UpdateUserRequest.newBuilder()
           .setUser(User.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   User response = userServiceClient.updateUser(request);
 }

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

Returns
Type	Description
`User`

updateUser(User user, FieldMask updateMask)

public final User updateUser(User user, FieldMask updateMask)

Updates a Merchant Center account user. Executing this method requires admin access.

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 (UserServiceClient userServiceClient = UserServiceClient.create()) {
   User user = User.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   User response = userServiceClient.updateUser(user, updateMask);
 }

Parameters

Name Description

user

User

Required. The new version of the user.

Use me to refer to your own email address, for example accounts/{account}/users/me.

updateMask

FieldMask

Required. List of fields being updated.

Returns
Type	Description
`User`

updateUserCallable()

public final UnaryCallable<UpdateUserRequest,User> updateUserCallable()

Updates a Merchant Center account user. Executing this method requires admin access.

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 (UserServiceClient userServiceClient = UserServiceClient.create()) {
   UpdateUserRequest request =
       UpdateUserRequest.newBuilder()
           .setUser(User.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<User> future = userServiceClient.updateUserCallable().futureCall(request);
   // Do something.
   User response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateUserRequest,User>`

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

Inheritance

Static Methods

create()

create(UserServiceSettings settings)

create(UserServiceStub stub)

Constructors

UserServiceClient(UserServiceSettings settings)

UserServiceClient(UserServiceStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

close()

createUser(@Nullable AccountName parent, User user)

createUser(CreateUserRequest request)

createUser(String parent, User user)

createUserCallable()

deleteUser(@Nullable UserName name)

deleteUser(DeleteUserRequest request)

deleteUser(String name)

deleteUserCallable()

getSettings()

getStub()

getUser(@Nullable UserName name)

getUser(GetUserRequest request)

getUser(String name)

getUserCallable()

isShutdown()

isTerminated()

listUsers(@Nullable AccountName parent)

listUsers(ListUsersRequest request)

listUsers(String parent)

listUsersCallable()

listUsersPagedCallable()

shutdown()

shutdownNow()

updateUser(UpdateUserRequest request)

updateUser(User user, FieldMask updateMask)

updateUserCallable()

Class UserServiceClient (1.23.0)