Class ContentLabelServiceClient (0.39.0)

Service Description: Provides methods for handling ContentLabel 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 (ContentLabelServiceClient contentLabelServiceClient = ContentLabelServiceClient.create()) {
   ContentLabelName name = ContentLabelName.of("[NETWORK_CODE]", "[CONTENT_LABEL]");
   ContentLabel response = contentLabelServiceClient.getContentLabel(name);
 }

Note: close() needs to be called on the ContentLabelServiceClient 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
GetContentLabel	API to retrieve a `ContentLabel` object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getContentLabel(GetContentLabelRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getContentLabel(ContentLabelName name) getContentLabel(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. getContentLabelCallable()
ListContentLabels	API to retrieve a list of `ContentLabel` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listContentLabels(ListContentLabelsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listContentLabels(NetworkName parent) listContentLabels(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. listContentLabelsPagedCallable() listContentLabelsCallable()

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 ContentLabelServiceSettings 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
 ContentLabelServiceSettings contentLabelServiceSettings =
     ContentLabelServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ContentLabelServiceClient contentLabelServiceClient =
     ContentLabelServiceClient.create(contentLabelServiceSettings);

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
 ContentLabelServiceSettings contentLabelServiceSettings =
     ContentLabelServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ContentLabelServiceClient contentLabelServiceClient =
     ContentLabelServiceClient.create(contentLabelServiceSettings);

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

Inheritance

java.lang.Object > ContentLabelServiceClient

Static Methods

create()

public static final ContentLabelServiceClient create()

Constructs an instance of ContentLabelServiceClient with default settings.

Returns
Type	Description
`ContentLabelServiceClient`

Exceptions
Type	Description
`IOException`

create(ContentLabelServiceSettings settings)

public static final ContentLabelServiceClient create(ContentLabelServiceSettings settings)

Constructs an instance of ContentLabelServiceClient, 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`	`ContentLabelServiceSettings`

Returns
Type	Description
`ContentLabelServiceClient`

Exceptions
Type	Description
`IOException`

create(ContentLabelServiceStub stub)

public static final ContentLabelServiceClient create(ContentLabelServiceStub stub)

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

Parameter
Name	Description
`stub`	`ContentLabelServiceStub`

Returns
Type	Description
`ContentLabelServiceClient`

Constructors

ContentLabelServiceClient(ContentLabelServiceSettings settings)

protected ContentLabelServiceClient(ContentLabelServiceSettings settings)

Constructs an instance of ContentLabelServiceClient, 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`	`ContentLabelServiceSettings`

ContentLabelServiceClient(ContentLabelServiceStub stub)

protected ContentLabelServiceClient(ContentLabelServiceStub stub)

Parameter
Name	Description
`stub`	`ContentLabelServiceStub`

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

getContentLabel(ContentLabelName name)

public final ContentLabel getContentLabel(ContentLabelName name)

API to retrieve a ContentLabel 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 (ContentLabelServiceClient contentLabelServiceClient = ContentLabelServiceClient.create()) {
   ContentLabelName name = ContentLabelName.of("[NETWORK_CODE]", "[CONTENT_LABEL]");
   ContentLabel response = contentLabelServiceClient.getContentLabel(name);
 }

Parameter
Name	Description
`name`	`ContentLabelName` Required. The resource name of the ContentLabel. Format: `networks/{network_code}/contentLabels/{content_label_id}`

Returns
Type	Description
`ContentLabel`

getContentLabel(GetContentLabelRequest request)

public final ContentLabel getContentLabel(GetContentLabelRequest request)

API to retrieve a ContentLabel 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 (ContentLabelServiceClient contentLabelServiceClient = ContentLabelServiceClient.create()) {
   GetContentLabelRequest request =
       GetContentLabelRequest.newBuilder()
           .setName(ContentLabelName.of("[NETWORK_CODE]", "[CONTENT_LABEL]").toString())
           .build();
   ContentLabel response = contentLabelServiceClient.getContentLabel(request);
 }

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

Returns
Type	Description
`ContentLabel`

getContentLabel(String name)

public final ContentLabel getContentLabel(String name)

API to retrieve a ContentLabel 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 (ContentLabelServiceClient contentLabelServiceClient = ContentLabelServiceClient.create()) {
   String name = ContentLabelName.of("[NETWORK_CODE]", "[CONTENT_LABEL]").toString();
   ContentLabel response = contentLabelServiceClient.getContentLabel(name);
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the ContentLabel. Format: `networks/{network_code}/contentLabels/{content_label_id}`

Returns
Type	Description
`ContentLabel`

getContentLabelCallable()

public final UnaryCallable<GetContentLabelRequest,ContentLabel> getContentLabelCallable()

API to retrieve a ContentLabel 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 (ContentLabelServiceClient contentLabelServiceClient = ContentLabelServiceClient.create()) {
   GetContentLabelRequest request =
       GetContentLabelRequest.newBuilder()
           .setName(ContentLabelName.of("[NETWORK_CODE]", "[CONTENT_LABEL]").toString())
           .build();
   ApiFuture<ContentLabel> future =
       contentLabelServiceClient.getContentLabelCallable().futureCall(request);
   // Do something.
   ContentLabel response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetContentLabelRequest,ContentLabel>`

getSettings()

public final ContentLabelServiceSettings getSettings()

Returns
Type	Description
`ContentLabelServiceSettings`

getStub()

public ContentLabelServiceStub getStub()

Returns
Type	Description
`ContentLabelServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listContentLabels(ListContentLabelsRequest request)

public final ContentLabelServiceClient.ListContentLabelsPagedResponse listContentLabels(ListContentLabelsRequest request)

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

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

Returns
Type	Description
`ContentLabelServiceClient.ListContentLabelsPagedResponse`

listContentLabels(NetworkName parent)

public final ContentLabelServiceClient.ListContentLabelsPagedResponse listContentLabels(NetworkName parent)

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

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

Returns
Type	Description
`ContentLabelServiceClient.ListContentLabelsPagedResponse`

listContentLabels(String parent)

public final ContentLabelServiceClient.ListContentLabelsPagedResponse listContentLabels(String parent)

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

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

Returns
Type	Description
`ContentLabelServiceClient.ListContentLabelsPagedResponse`

listContentLabelsCallable()

public final UnaryCallable<ListContentLabelsRequest,ListContentLabelsResponse> listContentLabelsCallable()

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

Returns
Type	Description
`UnaryCallable<ListContentLabelsRequest,ListContentLabelsResponse>`

listContentLabelsPagedCallable()

public final UnaryCallable<ListContentLabelsRequest,ContentLabelServiceClient.ListContentLabelsPagedResponse> listContentLabelsPagedCallable()

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

Returns
Type	Description
`UnaryCallable<ListContentLabelsRequest,ListContentLabelsPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

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

Inheritance

Static Methods

create()

create(ContentLabelServiceSettings settings)

create(ContentLabelServiceStub stub)

Constructors

ContentLabelServiceClient(ContentLabelServiceSettings settings)

ContentLabelServiceClient(ContentLabelServiceStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

close()

getContentLabel(ContentLabelName name)

getContentLabel(GetContentLabelRequest request)

getContentLabel(String name)

getContentLabelCallable()

getSettings()

getStub()

isShutdown()

isTerminated()

listContentLabels(ListContentLabelsRequest request)

listContentLabels(NetworkName parent)

listContentLabels(String parent)

listContentLabelsCallable()

listContentLabelsPagedCallable()

shutdown()

shutdownNow()

Class ContentLabelServiceClient (0.39.0)