Class UserServiceClient (0.54.0)

GitHub RepositoryProduct Reference

Service Description: Provides methods for handling User objects.

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("[NETWORK_CODE]", "[USER]");
   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 User object.

To get the current user, the resource name networks/{networkCode}/users/me can be used.

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

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

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

getSettings()

public final @Nullable UserServiceSettings getSettings()
Returns
Type Description
@org.jspecify.annotations.Nullable com.google.ads.admanager.v1.UserServiceSettings

getStub()

public UserServiceStub getStub()
Returns
Type Description
UserServiceStub

getUser(@Nullable UserName name)

public final User getUser(@Nullable UserName name)

Retrieves a User object.

To get the current user, the resource name networks/{networkCode}/users/me can be used.

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("[NETWORK_CODE]", "[USER]");
   User response = userServiceClient.getUser(name);
 }
Parameter
Name Description
name @org.jspecify.annotations.Nullable com.google.ads.admanager.v1.UserName

Required. The resource name of the User. Format: networks/{network_code}/users/{user_id}
Returns
Type Description
User

getUser(GetUserRequest request)

public final User getUser(GetUserRequest request)

Retrieves a User object.

To get the current user, the resource name networks/{networkCode}/users/me can be used.

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("[NETWORK_CODE]", "[USER]").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 User object.

To get the current user, the resource name networks/{networkCode}/users/me can be used.

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("[NETWORK_CODE]", "[USER]").toString();
   User response = userServiceClient.getUser(name);
 }
Parameter
Name Description
name String

Required. The resource name of the User. Format: networks/{network_code}/users/{user_id}
Returns
Type Description
User

getUserCallable()

public final UnaryCallable<GetUserRequest,User> getUserCallable()

Retrieves a User object.

To get the current user, the resource name networks/{networkCode}/users/me can be used.

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("[NETWORK_CODE]", "[USER]").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

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()