Class MobileDeviceSubmodelServiceClient (0.39.0)

GitHub RepositoryProduct Reference

Service Description: Provides methods for handling MobileDeviceSubmodel 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 (MobileDeviceSubmodelServiceClient mobileDeviceSubmodelServiceClient =
     MobileDeviceSubmodelServiceClient.create()) {
   MobileDeviceSubmodelName name =
       MobileDeviceSubmodelName.of("[NETWORK_CODE]", "[MOBILE_DEVICE_SUBMODEL]");
   MobileDeviceSubmodel response =
       mobileDeviceSubmodelServiceClient.getMobileDeviceSubmodel(name);
 }

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

GetMobileDeviceSubmodel

API to retrieve a MobileDeviceSubmodel object.

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

  • getMobileDeviceSubmodel(GetMobileDeviceSubmodelRequest request)

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

  • getMobileDeviceSubmodel(MobileDeviceSubmodelName name)

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

  • getMobileDeviceSubmodelCallable()

ListMobileDeviceSubmodels

API to retrieve a list of MobileDeviceSubmodel objects.

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

  • listMobileDeviceSubmodels(ListMobileDeviceSubmodelsRequest request)

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

  • listMobileDeviceSubmodels(NetworkName parent)

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

  • listMobileDeviceSubmodelsPagedCallable()

  • listMobileDeviceSubmodelsCallable()

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 MobileDeviceSubmodelServiceSettings 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
 MobileDeviceSubmodelServiceSettings mobileDeviceSubmodelServiceSettings =
     MobileDeviceSubmodelServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 MobileDeviceSubmodelServiceClient mobileDeviceSubmodelServiceClient =
     MobileDeviceSubmodelServiceClient.create(mobileDeviceSubmodelServiceSettings);

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
 MobileDeviceSubmodelServiceSettings mobileDeviceSubmodelServiceSettings =
     MobileDeviceSubmodelServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 MobileDeviceSubmodelServiceClient mobileDeviceSubmodelServiceClient =
     MobileDeviceSubmodelServiceClient.create(mobileDeviceSubmodelServiceSettings);

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

Inheritance

java.lang.Object > MobileDeviceSubmodelServiceClient

Static Methods

create()

public static final MobileDeviceSubmodelServiceClient create()

Constructs an instance of MobileDeviceSubmodelServiceClient with default settings.

Returns
Type Description
MobileDeviceSubmodelServiceClient
Exceptions
Type Description
IOException

create(MobileDeviceSubmodelServiceSettings settings)

public static final MobileDeviceSubmodelServiceClient create(MobileDeviceSubmodelServiceSettings settings)

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

create(MobileDeviceSubmodelServiceStub stub)

public static final MobileDeviceSubmodelServiceClient create(MobileDeviceSubmodelServiceStub stub)

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

Parameter
Name Description
stub MobileDeviceSubmodelServiceStub
Returns
Type Description
MobileDeviceSubmodelServiceClient

Constructors

MobileDeviceSubmodelServiceClient(MobileDeviceSubmodelServiceSettings settings)

protected MobileDeviceSubmodelServiceClient(MobileDeviceSubmodelServiceSettings settings)

Constructs an instance of MobileDeviceSubmodelServiceClient, 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 MobileDeviceSubmodelServiceSettings

MobileDeviceSubmodelServiceClient(MobileDeviceSubmodelServiceStub stub)

protected MobileDeviceSubmodelServiceClient(MobileDeviceSubmodelServiceStub stub)
Parameter
Name Description
stub MobileDeviceSubmodelServiceStub

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

getMobileDeviceSubmodel(GetMobileDeviceSubmodelRequest request)

public final MobileDeviceSubmodel getMobileDeviceSubmodel(GetMobileDeviceSubmodelRequest request)

API to retrieve a MobileDeviceSubmodel 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 (MobileDeviceSubmodelServiceClient mobileDeviceSubmodelServiceClient =
     MobileDeviceSubmodelServiceClient.create()) {
   GetMobileDeviceSubmodelRequest request =
       GetMobileDeviceSubmodelRequest.newBuilder()
           .setName(
               MobileDeviceSubmodelName.of("[NETWORK_CODE]", "[MOBILE_DEVICE_SUBMODEL]")
                   .toString())
           .build();
   MobileDeviceSubmodel response =
       mobileDeviceSubmodelServiceClient.getMobileDeviceSubmodel(request);
 }
Parameter
Name Description
request GetMobileDeviceSubmodelRequest

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

getMobileDeviceSubmodel(MobileDeviceSubmodelName name)

public final MobileDeviceSubmodel getMobileDeviceSubmodel(MobileDeviceSubmodelName name)

API to retrieve a MobileDeviceSubmodel 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 (MobileDeviceSubmodelServiceClient mobileDeviceSubmodelServiceClient =
     MobileDeviceSubmodelServiceClient.create()) {
   MobileDeviceSubmodelName name =
       MobileDeviceSubmodelName.of("[NETWORK_CODE]", "[MOBILE_DEVICE_SUBMODEL]");
   MobileDeviceSubmodel response =
       mobileDeviceSubmodelServiceClient.getMobileDeviceSubmodel(name);
 }
Parameter
Name Description
name MobileDeviceSubmodelName

Required. The resource name of the MobileDeviceSubmodel. Format: networks/{network_code}/mobileDeviceSubmodels/{mobile_device_submodel_id}
Returns
Type Description
MobileDeviceSubmodel

getMobileDeviceSubmodel(String name)

public final MobileDeviceSubmodel getMobileDeviceSubmodel(String name)

API to retrieve a MobileDeviceSubmodel 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 (MobileDeviceSubmodelServiceClient mobileDeviceSubmodelServiceClient =
     MobileDeviceSubmodelServiceClient.create()) {
   String name =
       MobileDeviceSubmodelName.of("[NETWORK_CODE]", "[MOBILE_DEVICE_SUBMODEL]").toString();
   MobileDeviceSubmodel response =
       mobileDeviceSubmodelServiceClient.getMobileDeviceSubmodel(name);
 }
Parameter
Name Description
name String

Required. The resource name of the MobileDeviceSubmodel. Format: networks/{network_code}/mobileDeviceSubmodels/{mobile_device_submodel_id}
Returns
Type Description
MobileDeviceSubmodel

getMobileDeviceSubmodelCallable()

public final UnaryCallable<GetMobileDeviceSubmodelRequest,MobileDeviceSubmodel> getMobileDeviceSubmodelCallable()

API to retrieve a MobileDeviceSubmodel 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 (MobileDeviceSubmodelServiceClient mobileDeviceSubmodelServiceClient =
     MobileDeviceSubmodelServiceClient.create()) {
   GetMobileDeviceSubmodelRequest request =
       GetMobileDeviceSubmodelRequest.newBuilder()
           .setName(
               MobileDeviceSubmodelName.of("[NETWORK_CODE]", "[MOBILE_DEVICE_SUBMODEL]")
                   .toString())
           .build();
   ApiFuture<MobileDeviceSubmodel> future =
       mobileDeviceSubmodelServiceClient.getMobileDeviceSubmodelCallable().futureCall(request);
   // Do something.
   MobileDeviceSubmodel response = future.get();
 }
Returns
Type Description
UnaryCallable<GetMobileDeviceSubmodelRequest,MobileDeviceSubmodel>

getSettings()

public final MobileDeviceSubmodelServiceSettings getSettings()
Returns
Type Description
MobileDeviceSubmodelServiceSettings

getStub()

public MobileDeviceSubmodelServiceStub getStub()
Returns
Type Description
MobileDeviceSubmodelServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listMobileDeviceSubmodels(ListMobileDeviceSubmodelsRequest request)

public final MobileDeviceSubmodelServiceClient.ListMobileDeviceSubmodelsPagedResponse listMobileDeviceSubmodels(ListMobileDeviceSubmodelsRequest request)

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

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

listMobileDeviceSubmodels(NetworkName parent)

public final MobileDeviceSubmodelServiceClient.ListMobileDeviceSubmodelsPagedResponse listMobileDeviceSubmodels(NetworkName parent)

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

Required. The parent, which owns this collection of MobileDeviceSubmodels. Format: networks/{network_code}
Returns
Type Description
MobileDeviceSubmodelServiceClient.ListMobileDeviceSubmodelsPagedResponse

listMobileDeviceSubmodels(String parent)

public final MobileDeviceSubmodelServiceClient.ListMobileDeviceSubmodelsPagedResponse listMobileDeviceSubmodels(String parent)

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

Required. The parent, which owns this collection of MobileDeviceSubmodels. Format: networks/{network_code}
Returns
Type Description
MobileDeviceSubmodelServiceClient.ListMobileDeviceSubmodelsPagedResponse

listMobileDeviceSubmodelsCallable()

public final UnaryCallable<ListMobileDeviceSubmodelsRequest,ListMobileDeviceSubmodelsResponse> listMobileDeviceSubmodelsCallable()

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

listMobileDeviceSubmodelsPagedCallable()

public final UnaryCallable<ListMobileDeviceSubmodelsRequest,MobileDeviceSubmodelServiceClient.ListMobileDeviceSubmodelsPagedResponse> listMobileDeviceSubmodelsPagedCallable()

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

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()