Class UserServiceClient (0.1.0)

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	API to retrieve a User object.	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()
ListUsers	API to retrieve a list of User objects.	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(NetworkName 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);

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

Returns
Type	Description
`UserServiceSettings`

getStub()

public UserServiceStub getStub()

Returns
Type	Description
`UserServiceStub`

getUser(GetUserRequest request)

public final User getUser(GetUserRequest request)

API to retrieve a User object.

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

public final User getUser(UserName name)

API to retrieve a User object.

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`	`UserName` Required. The resource name of the User. Format: `networks/{network_code}/users/{user_id}`

Returns
Type	Description
`User`

getUser(String name)

public final User getUser(String name)

API to retrieve a User object.

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

API to retrieve a User object.

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`

listUsers(ListUsersRequest request)

public final UserServiceClient.ListUsersPagedResponse listUsers(ListUsersRequest request)

API to retrieve a list of User objects.

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(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .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(NetworkName parent)

public final UserServiceClient.ListUsersPagedResponse listUsers(NetworkName parent)

API to retrieve a list of User objects.

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

Parameter
Name	Description
`parent`	`NetworkName` Required. The parent, which owns this collection of Users. Format: `networks/{network_code}`

Returns
Type	Description
`UserServiceClient.ListUsersPagedResponse`

listUsers(String parent)

public final UserServiceClient.ListUsersPagedResponse listUsers(String parent)

API to retrieve a list of User objects.

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 = NetworkName.of("[NETWORK_CODE]").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: `networks/{network_code}`

Returns
Type	Description
`UserServiceClient.ListUsersPagedResponse`

listUsersCallable()

public final UnaryCallable<ListUsersRequest,ListUsersResponse> listUsersCallable()

API to retrieve a list of User objects.

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(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .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()

API to retrieve a list of User objects.

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(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .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()