Class DeviceManufacturerServiceClient (0.39.0)

GitHub RepositoryProduct Reference

Service Description: Provides methods for handling DeviceManufacturer 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 (DeviceManufacturerServiceClient deviceManufacturerServiceClient =
     DeviceManufacturerServiceClient.create()) {
   DeviceManufacturerName name =
       DeviceManufacturerName.of("[NETWORK_CODE]", "[DEVICE_MANUFACTURER]");
   DeviceManufacturer response = deviceManufacturerServiceClient.getDeviceManufacturer(name);
 }

Note: close() needs to be called on the DeviceManufacturerServiceClient 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

GetDeviceManufacturer

API to retrieve a DeviceManufacturer object.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getDeviceManufacturer(GetDeviceManufacturerRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getDeviceManufacturer(DeviceManufacturerName name)

  • getDeviceManufacturer(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.

  • getDeviceManufacturerCallable()

ListDeviceManufacturers

API to retrieve a list of DeviceManufacturer objects.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listDeviceManufacturers(ListDeviceManufacturersRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listDeviceManufacturers(NetworkName parent)

  • listDeviceManufacturers(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.

  • listDeviceManufacturersPagedCallable()

  • listDeviceManufacturersCallable()

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 DeviceManufacturerServiceSettings 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
 DeviceManufacturerServiceSettings deviceManufacturerServiceSettings =
     DeviceManufacturerServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DeviceManufacturerServiceClient deviceManufacturerServiceClient =
     DeviceManufacturerServiceClient.create(deviceManufacturerServiceSettings);

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
 DeviceManufacturerServiceSettings deviceManufacturerServiceSettings =
     DeviceManufacturerServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 DeviceManufacturerServiceClient deviceManufacturerServiceClient =
     DeviceManufacturerServiceClient.create(deviceManufacturerServiceSettings);

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

Inheritance

java.lang.Object > DeviceManufacturerServiceClient

Static Methods

create()

public static final DeviceManufacturerServiceClient create()

Constructs an instance of DeviceManufacturerServiceClient with default settings.

Returns
Type Description
DeviceManufacturerServiceClient
Exceptions
Type Description
IOException

create(DeviceManufacturerServiceSettings settings)

public static final DeviceManufacturerServiceClient create(DeviceManufacturerServiceSettings settings)

Constructs an instance of DeviceManufacturerServiceClient, 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 DeviceManufacturerServiceSettings
Returns
Type Description
DeviceManufacturerServiceClient
Exceptions
Type Description
IOException

create(DeviceManufacturerServiceStub stub)

public static final DeviceManufacturerServiceClient create(DeviceManufacturerServiceStub stub)

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

Parameter
Name Description
stub DeviceManufacturerServiceStub
Returns
Type Description
DeviceManufacturerServiceClient

Constructors

DeviceManufacturerServiceClient(DeviceManufacturerServiceSettings settings)

protected DeviceManufacturerServiceClient(DeviceManufacturerServiceSettings settings)

Constructs an instance of DeviceManufacturerServiceClient, 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 DeviceManufacturerServiceSettings

DeviceManufacturerServiceClient(DeviceManufacturerServiceStub stub)

protected DeviceManufacturerServiceClient(DeviceManufacturerServiceStub stub)
Parameter
Name Description
stub DeviceManufacturerServiceStub

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

getDeviceManufacturer(DeviceManufacturerName name)

public final DeviceManufacturer getDeviceManufacturer(DeviceManufacturerName name)

API to retrieve a DeviceManufacturer 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 (DeviceManufacturerServiceClient deviceManufacturerServiceClient =
     DeviceManufacturerServiceClient.create()) {
   DeviceManufacturerName name =
       DeviceManufacturerName.of("[NETWORK_CODE]", "[DEVICE_MANUFACTURER]");
   DeviceManufacturer response = deviceManufacturerServiceClient.getDeviceManufacturer(name);
 }
Parameter
Name Description
name DeviceManufacturerName

Required. The resource name of the DeviceManufacturer. Format: networks/{network_code}/deviceManufacturers/{device_manufacturer_id}
Returns
Type Description
DeviceManufacturer

getDeviceManufacturer(GetDeviceManufacturerRequest request)

public final DeviceManufacturer getDeviceManufacturer(GetDeviceManufacturerRequest request)

API to retrieve a DeviceManufacturer 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 (DeviceManufacturerServiceClient deviceManufacturerServiceClient =
     DeviceManufacturerServiceClient.create()) {
   GetDeviceManufacturerRequest request =
       GetDeviceManufacturerRequest.newBuilder()
           .setName(
               DeviceManufacturerName.of("[NETWORK_CODE]", "[DEVICE_MANUFACTURER]").toString())
           .build();
   DeviceManufacturer response = deviceManufacturerServiceClient.getDeviceManufacturer(request);
 }
Parameter
Name Description
request GetDeviceManufacturerRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DeviceManufacturer

getDeviceManufacturer(String name)

public final DeviceManufacturer getDeviceManufacturer(String name)

API to retrieve a DeviceManufacturer 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 (DeviceManufacturerServiceClient deviceManufacturerServiceClient =
     DeviceManufacturerServiceClient.create()) {
   String name = DeviceManufacturerName.of("[NETWORK_CODE]", "[DEVICE_MANUFACTURER]").toString();
   DeviceManufacturer response = deviceManufacturerServiceClient.getDeviceManufacturer(name);
 }
Parameter
Name Description
name String

Required. The resource name of the DeviceManufacturer. Format: networks/{network_code}/deviceManufacturers/{device_manufacturer_id}
Returns
Type Description
DeviceManufacturer

getDeviceManufacturerCallable()

public final UnaryCallable<GetDeviceManufacturerRequest,DeviceManufacturer> getDeviceManufacturerCallable()

API to retrieve a DeviceManufacturer 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 (DeviceManufacturerServiceClient deviceManufacturerServiceClient =
     DeviceManufacturerServiceClient.create()) {
   GetDeviceManufacturerRequest request =
       GetDeviceManufacturerRequest.newBuilder()
           .setName(
               DeviceManufacturerName.of("[NETWORK_CODE]", "[DEVICE_MANUFACTURER]").toString())
           .build();
   ApiFuture<DeviceManufacturer> future =
       deviceManufacturerServiceClient.getDeviceManufacturerCallable().futureCall(request);
   // Do something.
   DeviceManufacturer response = future.get();
 }
Returns
Type Description
UnaryCallable<GetDeviceManufacturerRequest,DeviceManufacturer>

getSettings()

public final DeviceManufacturerServiceSettings getSettings()
Returns
Type Description
DeviceManufacturerServiceSettings

getStub()

public DeviceManufacturerServiceStub getStub()
Returns
Type Description
DeviceManufacturerServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listDeviceManufacturers(ListDeviceManufacturersRequest request)

public final DeviceManufacturerServiceClient.ListDeviceManufacturersPagedResponse listDeviceManufacturers(ListDeviceManufacturersRequest request)

API to retrieve a list of DeviceManufacturer 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 (DeviceManufacturerServiceClient deviceManufacturerServiceClient =
     DeviceManufacturerServiceClient.create()) {
   ListDeviceManufacturersRequest request =
       ListDeviceManufacturersRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   for (DeviceManufacturer element :
       deviceManufacturerServiceClient.listDeviceManufacturers(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListDeviceManufacturersRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DeviceManufacturerServiceClient.ListDeviceManufacturersPagedResponse

listDeviceManufacturers(NetworkName parent)

public final DeviceManufacturerServiceClient.ListDeviceManufacturersPagedResponse listDeviceManufacturers(NetworkName parent)

API to retrieve a list of DeviceManufacturer 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 (DeviceManufacturerServiceClient deviceManufacturerServiceClient =
     DeviceManufacturerServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   for (DeviceManufacturer element :
       deviceManufacturerServiceClient.listDeviceManufacturers(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent NetworkName

Required. The parent, which owns this collection of DeviceManufacturers. Format: networks/{network_code}
Returns
Type Description
DeviceManufacturerServiceClient.ListDeviceManufacturersPagedResponse

listDeviceManufacturers(String parent)

public final DeviceManufacturerServiceClient.ListDeviceManufacturersPagedResponse listDeviceManufacturers(String parent)

API to retrieve a list of DeviceManufacturer 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 (DeviceManufacturerServiceClient deviceManufacturerServiceClient =
     DeviceManufacturerServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   for (DeviceManufacturer element :
       deviceManufacturerServiceClient.listDeviceManufacturers(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The parent, which owns this collection of DeviceManufacturers. Format: networks/{network_code}
Returns
Type Description
DeviceManufacturerServiceClient.ListDeviceManufacturersPagedResponse

listDeviceManufacturersCallable()

public final UnaryCallable<ListDeviceManufacturersRequest,ListDeviceManufacturersResponse> listDeviceManufacturersCallable()

API to retrieve a list of DeviceManufacturer 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 (DeviceManufacturerServiceClient deviceManufacturerServiceClient =
     DeviceManufacturerServiceClient.create()) {
   ListDeviceManufacturersRequest request =
       ListDeviceManufacturersRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   while (true) {
     ListDeviceManufacturersResponse response =
         deviceManufacturerServiceClient.listDeviceManufacturersCallable().call(request);
     for (DeviceManufacturer element : response.getDeviceManufacturersList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListDeviceManufacturersRequest,ListDeviceManufacturersResponse>

listDeviceManufacturersPagedCallable()

public final UnaryCallable<ListDeviceManufacturersRequest,DeviceManufacturerServiceClient.ListDeviceManufacturersPagedResponse> listDeviceManufacturersPagedCallable()

API to retrieve a list of DeviceManufacturer 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 (DeviceManufacturerServiceClient deviceManufacturerServiceClient =
     DeviceManufacturerServiceClient.create()) {
   ListDeviceManufacturersRequest request =
       ListDeviceManufacturersRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   ApiFuture<DeviceManufacturer> future =
       deviceManufacturerServiceClient
           .listDeviceManufacturersPagedCallable()
           .futureCall(request);
   // Do something.
   for (DeviceManufacturer element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListDeviceManufacturersRequest,ListDeviceManufacturersPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()