Class ContentBundleServiceClient (0.39.0)

Service Description: Provides methods for handling ContentBundle 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 (ContentBundleServiceClient contentBundleServiceClient =
     ContentBundleServiceClient.create()) {
   ContentBundleName name = ContentBundleName.of("[NETWORK_CODE]", "[CONTENT_BUNDLE]");
   ContentBundle response = contentBundleServiceClient.getContentBundle(name);
 }

Note: close() needs to be called on the ContentBundleServiceClient 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
GetContentBundle	API to retrieve a `ContentBundle` object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getContentBundle(GetContentBundleRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getContentBundle(ContentBundleName name) getContentBundle(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. getContentBundleCallable()
ListContentBundles	API to retrieve a list of `ContentBundle` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listContentBundles(ListContentBundlesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listContentBundles(NetworkName parent) listContentBundles(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. listContentBundlesPagedCallable() listContentBundlesCallable()

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 ContentBundleServiceSettings 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
 ContentBundleServiceSettings contentBundleServiceSettings =
     ContentBundleServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ContentBundleServiceClient contentBundleServiceClient =
     ContentBundleServiceClient.create(contentBundleServiceSettings);

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
 ContentBundleServiceSettings contentBundleServiceSettings =
     ContentBundleServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ContentBundleServiceClient contentBundleServiceClient =
     ContentBundleServiceClient.create(contentBundleServiceSettings);

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

Inheritance

java.lang.Object > ContentBundleServiceClient

Static Methods

create()

public static final ContentBundleServiceClient create()

Constructs an instance of ContentBundleServiceClient with default settings.

Returns
Type	Description
`ContentBundleServiceClient`

Exceptions
Type	Description
`IOException`

create(ContentBundleServiceSettings settings)

public static final ContentBundleServiceClient create(ContentBundleServiceSettings settings)

Constructs an instance of ContentBundleServiceClient, 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`	`ContentBundleServiceSettings`

Returns
Type	Description
`ContentBundleServiceClient`

Exceptions
Type	Description
`IOException`

create(ContentBundleServiceStub stub)

public static final ContentBundleServiceClient create(ContentBundleServiceStub stub)

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

Parameter
Name	Description
`stub`	`ContentBundleServiceStub`

Returns
Type	Description
`ContentBundleServiceClient`

Constructors

ContentBundleServiceClient(ContentBundleServiceSettings settings)

protected ContentBundleServiceClient(ContentBundleServiceSettings settings)

Constructs an instance of ContentBundleServiceClient, 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`	`ContentBundleServiceSettings`

ContentBundleServiceClient(ContentBundleServiceStub stub)

protected ContentBundleServiceClient(ContentBundleServiceStub stub)

Parameter
Name	Description
`stub`	`ContentBundleServiceStub`

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

getContentBundle(ContentBundleName name)

public final ContentBundle getContentBundle(ContentBundleName name)

API to retrieve a ContentBundle 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 (ContentBundleServiceClient contentBundleServiceClient =
     ContentBundleServiceClient.create()) {
   ContentBundleName name = ContentBundleName.of("[NETWORK_CODE]", "[CONTENT_BUNDLE]");
   ContentBundle response = contentBundleServiceClient.getContentBundle(name);
 }

Parameter
Name	Description
`name`	`ContentBundleName` Required. The resource name of the ContentBundle. Format: `networks/{network_code}/contentBundles/{content_bundle_id}`

Returns
Type	Description
`ContentBundle`

getContentBundle(GetContentBundleRequest request)

public final ContentBundle getContentBundle(GetContentBundleRequest request)

API to retrieve a ContentBundle 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 (ContentBundleServiceClient contentBundleServiceClient =
     ContentBundleServiceClient.create()) {
   GetContentBundleRequest request =
       GetContentBundleRequest.newBuilder()
           .setName(ContentBundleName.of("[NETWORK_CODE]", "[CONTENT_BUNDLE]").toString())
           .build();
   ContentBundle response = contentBundleServiceClient.getContentBundle(request);
 }

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

Returns
Type	Description
`ContentBundle`

getContentBundle(String name)

public final ContentBundle getContentBundle(String name)

API to retrieve a ContentBundle 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 (ContentBundleServiceClient contentBundleServiceClient =
     ContentBundleServiceClient.create()) {
   String name = ContentBundleName.of("[NETWORK_CODE]", "[CONTENT_BUNDLE]").toString();
   ContentBundle response = contentBundleServiceClient.getContentBundle(name);
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the ContentBundle. Format: `networks/{network_code}/contentBundles/{content_bundle_id}`

Returns
Type	Description
`ContentBundle`

getContentBundleCallable()

public final UnaryCallable<GetContentBundleRequest,ContentBundle> getContentBundleCallable()

API to retrieve a ContentBundle 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 (ContentBundleServiceClient contentBundleServiceClient =
     ContentBundleServiceClient.create()) {
   GetContentBundleRequest request =
       GetContentBundleRequest.newBuilder()
           .setName(ContentBundleName.of("[NETWORK_CODE]", "[CONTENT_BUNDLE]").toString())
           .build();
   ApiFuture<ContentBundle> future =
       contentBundleServiceClient.getContentBundleCallable().futureCall(request);
   // Do something.
   ContentBundle response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetContentBundleRequest,ContentBundle>`

getSettings()

public final ContentBundleServiceSettings getSettings()

Returns
Type	Description
`ContentBundleServiceSettings`

getStub()

public ContentBundleServiceStub getStub()

Returns
Type	Description
`ContentBundleServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listContentBundles(ListContentBundlesRequest request)

public final ContentBundleServiceClient.ListContentBundlesPagedResponse listContentBundles(ListContentBundlesRequest request)

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

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

Returns
Type	Description
`ContentBundleServiceClient.ListContentBundlesPagedResponse`

listContentBundles(NetworkName parent)

public final ContentBundleServiceClient.ListContentBundlesPagedResponse listContentBundles(NetworkName parent)

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

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

Returns
Type	Description
`ContentBundleServiceClient.ListContentBundlesPagedResponse`

listContentBundles(String parent)

public final ContentBundleServiceClient.ListContentBundlesPagedResponse listContentBundles(String parent)

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

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

Returns
Type	Description
`ContentBundleServiceClient.ListContentBundlesPagedResponse`

listContentBundlesCallable()

public final UnaryCallable<ListContentBundlesRequest,ListContentBundlesResponse> listContentBundlesCallable()

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

Returns
Type	Description
`UnaryCallable<ListContentBundlesRequest,ListContentBundlesResponse>`

listContentBundlesPagedCallable()

public final UnaryCallable<ListContentBundlesRequest,ContentBundleServiceClient.ListContentBundlesPagedResponse> listContentBundlesPagedCallable()

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

Returns
Type	Description
`UnaryCallable<ListContentBundlesRequest,ListContentBundlesPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

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

Inheritance

Static Methods

create()

create(ContentBundleServiceSettings settings)

create(ContentBundleServiceStub stub)

Constructors

ContentBundleServiceClient(ContentBundleServiceSettings settings)

ContentBundleServiceClient(ContentBundleServiceStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

close()

getContentBundle(ContentBundleName name)

getContentBundle(GetContentBundleRequest request)

getContentBundle(String name)

getContentBundleCallable()

getSettings()

getStub()

isShutdown()

isTerminated()

listContentBundles(ListContentBundlesRequest request)

listContentBundles(NetworkName parent)

listContentBundles(String parent)

listContentBundlesCallable()

listContentBundlesPagedCallable()

shutdown()

shutdownNow()

Class ContentBundleServiceClient (0.39.0)