Class DeviceCategoryServiceClient (0.27.0)

Service Description: Provides methods for handling DeviceCategory 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 (DeviceCategoryServiceClient deviceCategoryServiceClient =
     DeviceCategoryServiceClient.create()) {
   DeviceCategoryName name = DeviceCategoryName.of("[NETWORK_CODE]", "[DEVICE_CATEGORY]");
   DeviceCategory response = deviceCategoryServiceClient.getDeviceCategory(name);
 }

Note: close() needs to be called on the DeviceCategoryServiceClient 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
GetDeviceCategory	API to retrieve a `DeviceCategory` object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getDeviceCategory(GetDeviceCategoryRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getDeviceCategory(DeviceCategoryName name) getDeviceCategory(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. getDeviceCategoryCallable()
ListDeviceCategories	API to retrieve a list of `DeviceCategory` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listDeviceCategories(ListDeviceCategoriesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listDeviceCategories(NetworkName parent) listDeviceCategories(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. listDeviceCategoriesPagedCallable() listDeviceCategoriesCallable()

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 DeviceCategoryServiceSettings 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
 DeviceCategoryServiceSettings deviceCategoryServiceSettings =
     DeviceCategoryServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DeviceCategoryServiceClient deviceCategoryServiceClient =
     DeviceCategoryServiceClient.create(deviceCategoryServiceSettings);

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
 DeviceCategoryServiceSettings deviceCategoryServiceSettings =
     DeviceCategoryServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 DeviceCategoryServiceClient deviceCategoryServiceClient =
     DeviceCategoryServiceClient.create(deviceCategoryServiceSettings);

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

Inheritance

java.lang.Object > DeviceCategoryServiceClient

Static Methods

create()

public static final DeviceCategoryServiceClient create()

Constructs an instance of DeviceCategoryServiceClient with default settings.

Returns
Type	Description
`DeviceCategoryServiceClient`

Exceptions
Type	Description
`IOException`

create(DeviceCategoryServiceSettings settings)

public static final DeviceCategoryServiceClient create(DeviceCategoryServiceSettings settings)

Constructs an instance of DeviceCategoryServiceClient, 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`	`DeviceCategoryServiceSettings`

Returns
Type	Description
`DeviceCategoryServiceClient`

Exceptions
Type	Description
`IOException`

create(DeviceCategoryServiceStub stub)

public static final DeviceCategoryServiceClient create(DeviceCategoryServiceStub stub)

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

Parameter
Name	Description
`stub`	`DeviceCategoryServiceStub`

Returns
Type	Description
`DeviceCategoryServiceClient`

Constructors

DeviceCategoryServiceClient(DeviceCategoryServiceSettings settings)

protected DeviceCategoryServiceClient(DeviceCategoryServiceSettings settings)

Constructs an instance of DeviceCategoryServiceClient, 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`	`DeviceCategoryServiceSettings`

DeviceCategoryServiceClient(DeviceCategoryServiceStub stub)

protected DeviceCategoryServiceClient(DeviceCategoryServiceStub stub)

Parameter
Name	Description
`stub`	`DeviceCategoryServiceStub`

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

getDeviceCategory(DeviceCategoryName name)

public final DeviceCategory getDeviceCategory(DeviceCategoryName name)

API to retrieve a DeviceCategory 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 (DeviceCategoryServiceClient deviceCategoryServiceClient =
     DeviceCategoryServiceClient.create()) {
   DeviceCategoryName name = DeviceCategoryName.of("[NETWORK_CODE]", "[DEVICE_CATEGORY]");
   DeviceCategory response = deviceCategoryServiceClient.getDeviceCategory(name);
 }

Parameter
Name	Description
`name`	`DeviceCategoryName` Required. The resource name of the DeviceCategory. Format: `networks/{network_code}/deviceCategories/{device_category_id}`

Returns
Type	Description
`DeviceCategory`

getDeviceCategory(GetDeviceCategoryRequest request)

public final DeviceCategory getDeviceCategory(GetDeviceCategoryRequest request)

API to retrieve a DeviceCategory 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 (DeviceCategoryServiceClient deviceCategoryServiceClient =
     DeviceCategoryServiceClient.create()) {
   GetDeviceCategoryRequest request =
       GetDeviceCategoryRequest.newBuilder()
           .setName(DeviceCategoryName.of("[NETWORK_CODE]", "[DEVICE_CATEGORY]").toString())
           .build();
   DeviceCategory response = deviceCategoryServiceClient.getDeviceCategory(request);
 }

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

Returns
Type	Description
`DeviceCategory`

getDeviceCategory(String name)

public final DeviceCategory getDeviceCategory(String name)

API to retrieve a DeviceCategory 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 (DeviceCategoryServiceClient deviceCategoryServiceClient =
     DeviceCategoryServiceClient.create()) {
   String name = DeviceCategoryName.of("[NETWORK_CODE]", "[DEVICE_CATEGORY]").toString();
   DeviceCategory response = deviceCategoryServiceClient.getDeviceCategory(name);
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the DeviceCategory. Format: `networks/{network_code}/deviceCategories/{device_category_id}`

Returns
Type	Description
`DeviceCategory`

getDeviceCategoryCallable()

public final UnaryCallable<GetDeviceCategoryRequest,DeviceCategory> getDeviceCategoryCallable()

API to retrieve a DeviceCategory 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 (DeviceCategoryServiceClient deviceCategoryServiceClient =
     DeviceCategoryServiceClient.create()) {
   GetDeviceCategoryRequest request =
       GetDeviceCategoryRequest.newBuilder()
           .setName(DeviceCategoryName.of("[NETWORK_CODE]", "[DEVICE_CATEGORY]").toString())
           .build();
   ApiFuture<DeviceCategory> future =
       deviceCategoryServiceClient.getDeviceCategoryCallable().futureCall(request);
   // Do something.
   DeviceCategory response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetDeviceCategoryRequest,DeviceCategory>`

getSettings()

public final DeviceCategoryServiceSettings getSettings()

Returns
Type	Description
`DeviceCategoryServiceSettings`

getStub()

public DeviceCategoryServiceStub getStub()

Returns
Type	Description
`DeviceCategoryServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listDeviceCategories(ListDeviceCategoriesRequest request)

public final DeviceCategoryServiceClient.ListDeviceCategoriesPagedResponse listDeviceCategories(ListDeviceCategoriesRequest request)

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

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

Returns
Type	Description
`DeviceCategoryServiceClient.ListDeviceCategoriesPagedResponse`

listDeviceCategories(NetworkName parent)

public final DeviceCategoryServiceClient.ListDeviceCategoriesPagedResponse listDeviceCategories(NetworkName parent)

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

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

Returns
Type	Description
`DeviceCategoryServiceClient.ListDeviceCategoriesPagedResponse`

listDeviceCategories(String parent)

public final DeviceCategoryServiceClient.ListDeviceCategoriesPagedResponse listDeviceCategories(String parent)

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

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

Returns
Type	Description
`DeviceCategoryServiceClient.ListDeviceCategoriesPagedResponse`

listDeviceCategoriesCallable()

public final UnaryCallable<ListDeviceCategoriesRequest,ListDeviceCategoriesResponse> listDeviceCategoriesCallable()

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

Returns
Type	Description
`UnaryCallable<ListDeviceCategoriesRequest,ListDeviceCategoriesResponse>`

listDeviceCategoriesPagedCallable()

public final UnaryCallable<ListDeviceCategoriesRequest,DeviceCategoryServiceClient.ListDeviceCategoriesPagedResponse> listDeviceCategoriesPagedCallable()

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

Returns
Type	Description
`UnaryCallable<ListDeviceCategoriesRequest,ListDeviceCategoriesPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

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

Inheritance

Static Methods

create()

create(DeviceCategoryServiceSettings settings)

create(DeviceCategoryServiceStub stub)

Constructors

DeviceCategoryServiceClient(DeviceCategoryServiceSettings settings)

DeviceCategoryServiceClient(DeviceCategoryServiceStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

close()

getDeviceCategory(DeviceCategoryName name)

getDeviceCategory(GetDeviceCategoryRequest request)

getDeviceCategory(String name)

getDeviceCategoryCallable()

getSettings()

getStub()

isShutdown()

isTerminated()

listDeviceCategories(ListDeviceCategoriesRequest request)

listDeviceCategories(NetworkName parent)

listDeviceCategories(String parent)

listDeviceCategoriesCallable()

listDeviceCategoriesPagedCallable()

shutdown()

shutdownNow()

Class DeviceCategoryServiceClient (0.27.0)