Class LabelServiceClient (0.6.0)

GitHub RepositoryProduct Reference

Service Description: Provides methods for handling Label 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 (LabelServiceClient labelServiceClient = LabelServiceClient.create()) {
   LabelName name = LabelName.of("[NETWORK_CODE]", "[LABEL]");
   Label response = labelServiceClient.getLabel(name);
 }

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

GetLabel

API to retrieve a Label object.

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

  • getLabel(GetLabelRequest request)

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

  • getLabel(LabelName name)

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

  • getLabelCallable()

ListLabels

API to retrieve a list of Label objects.

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

  • listLabels(ListLabelsRequest request)

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

  • listLabels(NetworkName parent)

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

  • listLabelsPagedCallable()

  • listLabelsCallable()

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 LabelServiceSettings 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
 LabelServiceSettings labelServiceSettings =
     LabelServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 LabelServiceClient labelServiceClient = LabelServiceClient.create(labelServiceSettings);

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
 LabelServiceSettings labelServiceSettings =
     LabelServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 LabelServiceClient labelServiceClient = LabelServiceClient.create(labelServiceSettings);

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

Inheritance

java.lang.Object > LabelServiceClient

Static Methods

create()

public static final LabelServiceClient create()

Constructs an instance of LabelServiceClient with default settings.

Returns
Type Description
LabelServiceClient
Exceptions
Type Description
IOException

create(LabelServiceSettings settings)

public static final LabelServiceClient create(LabelServiceSettings settings)

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

create(LabelServiceStub stub)

public static final LabelServiceClient create(LabelServiceStub stub)

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

Parameter
Name Description
stub LabelServiceStub
Returns
Type Description
LabelServiceClient

Constructors

LabelServiceClient(LabelServiceSettings settings)

protected LabelServiceClient(LabelServiceSettings settings)

Constructs an instance of LabelServiceClient, 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 LabelServiceSettings

LabelServiceClient(LabelServiceStub stub)

protected LabelServiceClient(LabelServiceStub stub)
Parameter
Name Description
stub LabelServiceStub

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

getLabel(GetLabelRequest request)

public final Label getLabel(GetLabelRequest request)

API to retrieve a Label 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 (LabelServiceClient labelServiceClient = LabelServiceClient.create()) {
   GetLabelRequest request =
       GetLabelRequest.newBuilder()
           .setName(LabelName.of("[NETWORK_CODE]", "[LABEL]").toString())
           .build();
   Label response = labelServiceClient.getLabel(request);
 }
Parameter
Name Description
request GetLabelRequest

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

getLabel(LabelName name)

public final Label getLabel(LabelName name)

API to retrieve a Label 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 (LabelServiceClient labelServiceClient = LabelServiceClient.create()) {
   LabelName name = LabelName.of("[NETWORK_CODE]", "[LABEL]");
   Label response = labelServiceClient.getLabel(name);
 }
Parameter
Name Description
name LabelName

Required. The resource name of the Label. Format: networks/{network_code}/labels/{label_id}
Returns
Type Description
Label

getLabel(String name)

public final Label getLabel(String name)

API to retrieve a Label 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 (LabelServiceClient labelServiceClient = LabelServiceClient.create()) {
   String name = LabelName.of("[NETWORK_CODE]", "[LABEL]").toString();
   Label response = labelServiceClient.getLabel(name);
 }
Parameter
Name Description
name String

Required. The resource name of the Label. Format: networks/{network_code}/labels/{label_id}
Returns
Type Description
Label

getLabelCallable()

public final UnaryCallable<GetLabelRequest,Label> getLabelCallable()

API to retrieve a Label 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 (LabelServiceClient labelServiceClient = LabelServiceClient.create()) {
   GetLabelRequest request =
       GetLabelRequest.newBuilder()
           .setName(LabelName.of("[NETWORK_CODE]", "[LABEL]").toString())
           .build();
   ApiFuture<Label> future = labelServiceClient.getLabelCallable().futureCall(request);
   // Do something.
   Label response = future.get();
 }
Returns
Type Description
UnaryCallable<GetLabelRequest,Label>

getSettings()

public final LabelServiceSettings getSettings()
Returns
Type Description
LabelServiceSettings

getStub()

public LabelServiceStub getStub()
Returns
Type Description
LabelServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listLabels(ListLabelsRequest request)

public final LabelServiceClient.ListLabelsPagedResponse listLabels(ListLabelsRequest request)

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

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

listLabels(NetworkName parent)

public final LabelServiceClient.ListLabelsPagedResponse listLabels(NetworkName parent)

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

Required. The parent, which owns this collection of Labels. Format: networks/{network_code}
Returns
Type Description
LabelServiceClient.ListLabelsPagedResponse

listLabels(String parent)

public final LabelServiceClient.ListLabelsPagedResponse listLabels(String parent)

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

Required. The parent, which owns this collection of Labels. Format: networks/{network_code}
Returns
Type Description
LabelServiceClient.ListLabelsPagedResponse

listLabelsCallable()

public final UnaryCallable<ListLabelsRequest,ListLabelsResponse> listLabelsCallable()

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

listLabelsPagedCallable()

public final UnaryCallable<ListLabelsRequest,LabelServiceClient.ListLabelsPagedResponse> listLabelsPagedCallable()

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

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()