Class RoleServiceClient (0.3.0)

Service Description: Provides methods for handling Role 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 (RoleServiceClient roleServiceClient = RoleServiceClient.create()) {
   RoleName name = RoleName.of("[NETWORK_CODE]", "[ROLE]");
   Role response = roleServiceClient.getRole(name);
 }

Note: close() needs to be called on the RoleServiceClient 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
GetRole	API to retrieve a Role object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getRole(GetRoleRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getRole(RoleName name) getRole(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. getRoleCallable()
ListRoles	API to retrieve a list of Role objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listRoles(ListRolesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listRoles(NetworkName parent) listRoles(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. listRolesPagedCallable() listRolesCallable()

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 RoleServiceSettings 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
 RoleServiceSettings roleServiceSettings =
     RoleServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RoleServiceClient roleServiceClient = RoleServiceClient.create(roleServiceSettings);

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
 RoleServiceSettings roleServiceSettings =
     RoleServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 RoleServiceClient roleServiceClient = RoleServiceClient.create(roleServiceSettings);

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

Inheritance

java.lang.Object > RoleServiceClient

Static Methods

create()

public static final RoleServiceClient create()

Constructs an instance of RoleServiceClient with default settings.

Returns
Type	Description
`RoleServiceClient`

Exceptions
Type	Description
`IOException`

create(RoleServiceSettings settings)

public static final RoleServiceClient create(RoleServiceSettings settings)

Constructs an instance of RoleServiceClient, 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`	`RoleServiceSettings`

Returns
Type	Description
`RoleServiceClient`

Exceptions
Type	Description
`IOException`

create(RoleServiceStub stub)

public static final RoleServiceClient create(RoleServiceStub stub)

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

Parameter
Name	Description
`stub`	`RoleServiceStub`

Returns
Type	Description
`RoleServiceClient`

Constructors

RoleServiceClient(RoleServiceSettings settings)

protected RoleServiceClient(RoleServiceSettings settings)

Constructs an instance of RoleServiceClient, 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`	`RoleServiceSettings`

RoleServiceClient(RoleServiceStub stub)

protected RoleServiceClient(RoleServiceStub stub)

Parameter
Name	Description
`stub`	`RoleServiceStub`

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

getRole(GetRoleRequest request)

public final Role getRole(GetRoleRequest request)

API to retrieve a Role 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 (RoleServiceClient roleServiceClient = RoleServiceClient.create()) {
   GetRoleRequest request =
       GetRoleRequest.newBuilder()
           .setName(RoleName.of("[NETWORK_CODE]", "[ROLE]").toString())
           .build();
   Role response = roleServiceClient.getRole(request);
 }

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

Returns
Type	Description
`Role`

getRole(RoleName name)

public final Role getRole(RoleName name)

API to retrieve a Role 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 (RoleServiceClient roleServiceClient = RoleServiceClient.create()) {
   RoleName name = RoleName.of("[NETWORK_CODE]", "[ROLE]");
   Role response = roleServiceClient.getRole(name);
 }

Parameter
Name	Description
`name`	`RoleName` Required. The resource name of the Role. Format: `networks/{network_code}/roles/{role_id}`

Returns
Type	Description
`Role`

getRole(String name)

public final Role getRole(String name)

API to retrieve a Role 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 (RoleServiceClient roleServiceClient = RoleServiceClient.create()) {
   String name = RoleName.of("[NETWORK_CODE]", "[ROLE]").toString();
   Role response = roleServiceClient.getRole(name);
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the Role. Format: `networks/{network_code}/roles/{role_id}`

Returns
Type	Description
`Role`

getRoleCallable()

public final UnaryCallable<GetRoleRequest,Role> getRoleCallable()

API to retrieve a Role 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 (RoleServiceClient roleServiceClient = RoleServiceClient.create()) {
   GetRoleRequest request =
       GetRoleRequest.newBuilder()
           .setName(RoleName.of("[NETWORK_CODE]", "[ROLE]").toString())
           .build();
   ApiFuture<Role> future = roleServiceClient.getRoleCallable().futureCall(request);
   // Do something.
   Role response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetRoleRequest,Role>`

getSettings()

public final RoleServiceSettings getSettings()

Returns
Type	Description
`RoleServiceSettings`

getStub()

public RoleServiceStub getStub()

Returns
Type	Description
`RoleServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listRoles(ListRolesRequest request)

public final RoleServiceClient.ListRolesPagedResponse listRoles(ListRolesRequest request)

API to retrieve a list of Role 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 (RoleServiceClient roleServiceClient = RoleServiceClient.create()) {
   ListRolesRequest request =
       ListRolesRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   for (Role element : roleServiceClient.listRoles(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

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

Returns
Type	Description
`RoleServiceClient.ListRolesPagedResponse`

listRoles(NetworkName parent)

public final RoleServiceClient.ListRolesPagedResponse listRoles(NetworkName parent)

API to retrieve a list of Role 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 (RoleServiceClient roleServiceClient = RoleServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   for (Role element : roleServiceClient.listRoles(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

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

Returns
Type	Description
`RoleServiceClient.ListRolesPagedResponse`

listRoles(String parent)

public final RoleServiceClient.ListRolesPagedResponse listRoles(String parent)

API to retrieve a list of Role 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 (RoleServiceClient roleServiceClient = RoleServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   for (Role element : roleServiceClient.listRoles(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

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

Returns
Type	Description
`RoleServiceClient.ListRolesPagedResponse`

listRolesCallable()

public final UnaryCallable<ListRolesRequest,ListRolesResponse> listRolesCallable()

API to retrieve a list of Role 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 (RoleServiceClient roleServiceClient = RoleServiceClient.create()) {
   ListRolesRequest request =
       ListRolesRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   while (true) {
     ListRolesResponse response = roleServiceClient.listRolesCallable().call(request);
     for (Role element : response.getRolesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListRolesRequest,ListRolesResponse>`

listRolesPagedCallable()

public final UnaryCallable<ListRolesRequest,RoleServiceClient.ListRolesPagedResponse> listRolesPagedCallable()

API to retrieve a list of Role 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 (RoleServiceClient roleServiceClient = RoleServiceClient.create()) {
   ListRolesRequest request =
       ListRolesRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   ApiFuture<Role> future = roleServiceClient.listRolesPagedCallable().futureCall(request);
   // Do something.
   for (Role element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListRolesRequest,ListRolesPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()