Class DeviceCapabilityServiceClient (0.39.0)

Service Description: Provides methods for handling DeviceCapability 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 (DeviceCapabilityServiceClient deviceCapabilityServiceClient =
     DeviceCapabilityServiceClient.create()) {
   DeviceCapabilityName name = DeviceCapabilityName.of("[NETWORK_CODE]", "[DEVICE_CAPABILITY]");
   DeviceCapability response = deviceCapabilityServiceClient.getDeviceCapability(name);
 }

Note: close() needs to be called on the DeviceCapabilityServiceClient 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
GetDeviceCapability	API to retrieve a `DeviceCapability` object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getDeviceCapability(GetDeviceCapabilityRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getDeviceCapability(DeviceCapabilityName name) getDeviceCapability(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. getDeviceCapabilityCallable()
ListDeviceCapabilities	API to retrieve a list of `DeviceCapability` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listDeviceCapabilities(ListDeviceCapabilitiesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listDeviceCapabilities(NetworkName parent) listDeviceCapabilities(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. listDeviceCapabilitiesPagedCallable() listDeviceCapabilitiesCallable()

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 DeviceCapabilityServiceSettings 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
 DeviceCapabilityServiceSettings deviceCapabilityServiceSettings =
     DeviceCapabilityServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DeviceCapabilityServiceClient deviceCapabilityServiceClient =
     DeviceCapabilityServiceClient.create(deviceCapabilityServiceSettings);

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
 DeviceCapabilityServiceSettings deviceCapabilityServiceSettings =
     DeviceCapabilityServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 DeviceCapabilityServiceClient deviceCapabilityServiceClient =
     DeviceCapabilityServiceClient.create(deviceCapabilityServiceSettings);

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

Inheritance

java.lang.Object > DeviceCapabilityServiceClient

Static Methods

create()

public static final DeviceCapabilityServiceClient create()

Constructs an instance of DeviceCapabilityServiceClient with default settings.

Returns
Type	Description
`DeviceCapabilityServiceClient`

Exceptions
Type	Description
`IOException`

create(DeviceCapabilityServiceSettings settings)

public static final DeviceCapabilityServiceClient create(DeviceCapabilityServiceSettings settings)

Constructs an instance of DeviceCapabilityServiceClient, 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`	`DeviceCapabilityServiceSettings`

Returns
Type	Description
`DeviceCapabilityServiceClient`

Exceptions
Type	Description
`IOException`

create(DeviceCapabilityServiceStub stub)

public static final DeviceCapabilityServiceClient create(DeviceCapabilityServiceStub stub)

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

Parameter
Name	Description
`stub`	`DeviceCapabilityServiceStub`

Returns
Type	Description
`DeviceCapabilityServiceClient`

Constructors

DeviceCapabilityServiceClient(DeviceCapabilityServiceSettings settings)

protected DeviceCapabilityServiceClient(DeviceCapabilityServiceSettings settings)

Constructs an instance of DeviceCapabilityServiceClient, 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`	`DeviceCapabilityServiceSettings`

DeviceCapabilityServiceClient(DeviceCapabilityServiceStub stub)

protected DeviceCapabilityServiceClient(DeviceCapabilityServiceStub stub)

Parameter
Name	Description
`stub`	`DeviceCapabilityServiceStub`

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

getDeviceCapability(DeviceCapabilityName name)

public final DeviceCapability getDeviceCapability(DeviceCapabilityName name)

API to retrieve a DeviceCapability 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 (DeviceCapabilityServiceClient deviceCapabilityServiceClient =
     DeviceCapabilityServiceClient.create()) {
   DeviceCapabilityName name = DeviceCapabilityName.of("[NETWORK_CODE]", "[DEVICE_CAPABILITY]");
   DeviceCapability response = deviceCapabilityServiceClient.getDeviceCapability(name);
 }

Parameter
Name	Description
`name`	`DeviceCapabilityName` Required. The resource name of the DeviceCapability. Format: `networks/{network_code}/deviceCapabilities/{device_capability_id}`

Returns
Type	Description
`DeviceCapability`

getDeviceCapability(GetDeviceCapabilityRequest request)

public final DeviceCapability getDeviceCapability(GetDeviceCapabilityRequest request)

API to retrieve a DeviceCapability 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 (DeviceCapabilityServiceClient deviceCapabilityServiceClient =
     DeviceCapabilityServiceClient.create()) {
   GetDeviceCapabilityRequest request =
       GetDeviceCapabilityRequest.newBuilder()
           .setName(DeviceCapabilityName.of("[NETWORK_CODE]", "[DEVICE_CAPABILITY]").toString())
           .build();
   DeviceCapability response = deviceCapabilityServiceClient.getDeviceCapability(request);
 }

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

Returns
Type	Description
`DeviceCapability`

getDeviceCapability(String name)

public final DeviceCapability getDeviceCapability(String name)

API to retrieve a DeviceCapability 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 (DeviceCapabilityServiceClient deviceCapabilityServiceClient =
     DeviceCapabilityServiceClient.create()) {
   String name = DeviceCapabilityName.of("[NETWORK_CODE]", "[DEVICE_CAPABILITY]").toString();
   DeviceCapability response = deviceCapabilityServiceClient.getDeviceCapability(name);
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the DeviceCapability. Format: `networks/{network_code}/deviceCapabilities/{device_capability_id}`

Returns
Type	Description
`DeviceCapability`

getDeviceCapabilityCallable()

public final UnaryCallable<GetDeviceCapabilityRequest,DeviceCapability> getDeviceCapabilityCallable()

API to retrieve a DeviceCapability 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 (DeviceCapabilityServiceClient deviceCapabilityServiceClient =
     DeviceCapabilityServiceClient.create()) {
   GetDeviceCapabilityRequest request =
       GetDeviceCapabilityRequest.newBuilder()
           .setName(DeviceCapabilityName.of("[NETWORK_CODE]", "[DEVICE_CAPABILITY]").toString())
           .build();
   ApiFuture<DeviceCapability> future =
       deviceCapabilityServiceClient.getDeviceCapabilityCallable().futureCall(request);
   // Do something.
   DeviceCapability response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetDeviceCapabilityRequest,DeviceCapability>`

getSettings()

public final DeviceCapabilityServiceSettings getSettings()

Returns
Type	Description
`DeviceCapabilityServiceSettings`

getStub()

public DeviceCapabilityServiceStub getStub()

Returns
Type	Description
`DeviceCapabilityServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listDeviceCapabilities(ListDeviceCapabilitiesRequest request)

public final DeviceCapabilityServiceClient.ListDeviceCapabilitiesPagedResponse listDeviceCapabilities(ListDeviceCapabilitiesRequest request)

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

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

Returns
Type	Description
`DeviceCapabilityServiceClient.ListDeviceCapabilitiesPagedResponse`

listDeviceCapabilities(NetworkName parent)

public final DeviceCapabilityServiceClient.ListDeviceCapabilitiesPagedResponse listDeviceCapabilities(NetworkName parent)

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

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

Returns
Type	Description
`DeviceCapabilityServiceClient.ListDeviceCapabilitiesPagedResponse`

listDeviceCapabilities(String parent)

public final DeviceCapabilityServiceClient.ListDeviceCapabilitiesPagedResponse listDeviceCapabilities(String parent)

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

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

Returns
Type	Description
`DeviceCapabilityServiceClient.ListDeviceCapabilitiesPagedResponse`

listDeviceCapabilitiesCallable()

public final UnaryCallable<ListDeviceCapabilitiesRequest,ListDeviceCapabilitiesResponse> listDeviceCapabilitiesCallable()

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

Returns
Type	Description
`UnaryCallable<ListDeviceCapabilitiesRequest,ListDeviceCapabilitiesResponse>`

listDeviceCapabilitiesPagedCallable()

public final UnaryCallable<ListDeviceCapabilitiesRequest,DeviceCapabilityServiceClient.ListDeviceCapabilitiesPagedResponse> listDeviceCapabilitiesPagedCallable()

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

Returns
Type	Description
`UnaryCallable<ListDeviceCapabilitiesRequest,ListDeviceCapabilitiesPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

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

Inheritance

Static Methods

create()

create(DeviceCapabilityServiceSettings settings)

create(DeviceCapabilityServiceStub stub)

Constructors

DeviceCapabilityServiceClient(DeviceCapabilityServiceSettings settings)

DeviceCapabilityServiceClient(DeviceCapabilityServiceStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

close()

getDeviceCapability(DeviceCapabilityName name)

getDeviceCapability(GetDeviceCapabilityRequest request)

getDeviceCapability(String name)

getDeviceCapabilityCallable()

getSettings()

getStub()

isShutdown()

isTerminated()

listDeviceCapabilities(ListDeviceCapabilitiesRequest request)

listDeviceCapabilities(NetworkName parent)

listDeviceCapabilities(String parent)

listDeviceCapabilitiesCallable()

listDeviceCapabilitiesPagedCallable()

shutdown()

shutdownNow()

Class DeviceCapabilityServiceClient (0.39.0)