Class CmsMetadataKeyServiceClient (0.39.0)

Service Description: Provides methods for handling CmsMetadataKey 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 (CmsMetadataKeyServiceClient cmsMetadataKeyServiceClient =
     CmsMetadataKeyServiceClient.create()) {
   CmsMetadataKeyName name = CmsMetadataKeyName.of("[NETWORK_CODE]", "[CMS_METADATA_KEY]");
   CmsMetadataKey response = cmsMetadataKeyServiceClient.getCmsMetadataKey(name);
 }

Note: close() needs to be called on the CmsMetadataKeyServiceClient 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
GetCmsMetadataKey	API to retrieve a `CmsMetadataKey` object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getCmsMetadataKey(GetCmsMetadataKeyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getCmsMetadataKey(CmsMetadataKeyName name) getCmsMetadataKey(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. getCmsMetadataKeyCallable()
ListCmsMetadataKeys	API to retrieve a list of `CmsMetadataKey` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listCmsMetadataKeys(ListCmsMetadataKeysRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listCmsMetadataKeys(NetworkName parent) listCmsMetadataKeys(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. listCmsMetadataKeysPagedCallable() listCmsMetadataKeysCallable()

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 CmsMetadataKeyServiceSettings 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
 CmsMetadataKeyServiceSettings cmsMetadataKeyServiceSettings =
     CmsMetadataKeyServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CmsMetadataKeyServiceClient cmsMetadataKeyServiceClient =
     CmsMetadataKeyServiceClient.create(cmsMetadataKeyServiceSettings);

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
 CmsMetadataKeyServiceSettings cmsMetadataKeyServiceSettings =
     CmsMetadataKeyServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 CmsMetadataKeyServiceClient cmsMetadataKeyServiceClient =
     CmsMetadataKeyServiceClient.create(cmsMetadataKeyServiceSettings);

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

Inheritance

java.lang.Object > CmsMetadataKeyServiceClient

Static Methods

create()

public static final CmsMetadataKeyServiceClient create()

Constructs an instance of CmsMetadataKeyServiceClient with default settings.

Returns
Type	Description
`CmsMetadataKeyServiceClient`

Exceptions
Type	Description
`IOException`

create(CmsMetadataKeyServiceSettings settings)

public static final CmsMetadataKeyServiceClient create(CmsMetadataKeyServiceSettings settings)

Constructs an instance of CmsMetadataKeyServiceClient, 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`	`CmsMetadataKeyServiceSettings`

Returns
Type	Description
`CmsMetadataKeyServiceClient`

Exceptions
Type	Description
`IOException`

create(CmsMetadataKeyServiceStub stub)

public static final CmsMetadataKeyServiceClient create(CmsMetadataKeyServiceStub stub)

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

Parameter
Name	Description
`stub`	`CmsMetadataKeyServiceStub`

Returns
Type	Description
`CmsMetadataKeyServiceClient`

Constructors

CmsMetadataKeyServiceClient(CmsMetadataKeyServiceSettings settings)

protected CmsMetadataKeyServiceClient(CmsMetadataKeyServiceSettings settings)

Constructs an instance of CmsMetadataKeyServiceClient, 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`	`CmsMetadataKeyServiceSettings`

CmsMetadataKeyServiceClient(CmsMetadataKeyServiceStub stub)

protected CmsMetadataKeyServiceClient(CmsMetadataKeyServiceStub stub)

Parameter
Name	Description
`stub`	`CmsMetadataKeyServiceStub`

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

getCmsMetadataKey(CmsMetadataKeyName name)

public final CmsMetadataKey getCmsMetadataKey(CmsMetadataKeyName name)

API to retrieve a CmsMetadataKey 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 (CmsMetadataKeyServiceClient cmsMetadataKeyServiceClient =
     CmsMetadataKeyServiceClient.create()) {
   CmsMetadataKeyName name = CmsMetadataKeyName.of("[NETWORK_CODE]", "[CMS_METADATA_KEY]");
   CmsMetadataKey response = cmsMetadataKeyServiceClient.getCmsMetadataKey(name);
 }

Parameter
Name	Description
`name`	`CmsMetadataKeyName` Required. The resource name of the CmsMetadataKey. Format: `networks/{network_code}/cmsMetadataKeys/{cms_metadata_key_id}`

Returns
Type	Description
`CmsMetadataKey`

getCmsMetadataKey(GetCmsMetadataKeyRequest request)

public final CmsMetadataKey getCmsMetadataKey(GetCmsMetadataKeyRequest request)

API to retrieve a CmsMetadataKey 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 (CmsMetadataKeyServiceClient cmsMetadataKeyServiceClient =
     CmsMetadataKeyServiceClient.create()) {
   GetCmsMetadataKeyRequest request =
       GetCmsMetadataKeyRequest.newBuilder()
           .setName(CmsMetadataKeyName.of("[NETWORK_CODE]", "[CMS_METADATA_KEY]").toString())
           .build();
   CmsMetadataKey response = cmsMetadataKeyServiceClient.getCmsMetadataKey(request);
 }

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

Returns
Type	Description
`CmsMetadataKey`

getCmsMetadataKey(String name)

public final CmsMetadataKey getCmsMetadataKey(String name)

API to retrieve a CmsMetadataKey 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 (CmsMetadataKeyServiceClient cmsMetadataKeyServiceClient =
     CmsMetadataKeyServiceClient.create()) {
   String name = CmsMetadataKeyName.of("[NETWORK_CODE]", "[CMS_METADATA_KEY]").toString();
   CmsMetadataKey response = cmsMetadataKeyServiceClient.getCmsMetadataKey(name);
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the CmsMetadataKey. Format: `networks/{network_code}/cmsMetadataKeys/{cms_metadata_key_id}`

Returns
Type	Description
`CmsMetadataKey`

getCmsMetadataKeyCallable()

public final UnaryCallable<GetCmsMetadataKeyRequest,CmsMetadataKey> getCmsMetadataKeyCallable()

API to retrieve a CmsMetadataKey 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 (CmsMetadataKeyServiceClient cmsMetadataKeyServiceClient =
     CmsMetadataKeyServiceClient.create()) {
   GetCmsMetadataKeyRequest request =
       GetCmsMetadataKeyRequest.newBuilder()
           .setName(CmsMetadataKeyName.of("[NETWORK_CODE]", "[CMS_METADATA_KEY]").toString())
           .build();
   ApiFuture<CmsMetadataKey> future =
       cmsMetadataKeyServiceClient.getCmsMetadataKeyCallable().futureCall(request);
   // Do something.
   CmsMetadataKey response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetCmsMetadataKeyRequest,CmsMetadataKey>`

getSettings()

public final CmsMetadataKeyServiceSettings getSettings()

Returns
Type	Description
`CmsMetadataKeyServiceSettings`

getStub()

public CmsMetadataKeyServiceStub getStub()

Returns
Type	Description
`CmsMetadataKeyServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listCmsMetadataKeys(ListCmsMetadataKeysRequest request)

public final CmsMetadataKeyServiceClient.ListCmsMetadataKeysPagedResponse listCmsMetadataKeys(ListCmsMetadataKeysRequest request)

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

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

Returns
Type	Description
`CmsMetadataKeyServiceClient.ListCmsMetadataKeysPagedResponse`

listCmsMetadataKeys(NetworkName parent)

public final CmsMetadataKeyServiceClient.ListCmsMetadataKeysPagedResponse listCmsMetadataKeys(NetworkName parent)

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

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

Returns
Type	Description
`CmsMetadataKeyServiceClient.ListCmsMetadataKeysPagedResponse`

listCmsMetadataKeys(String parent)

public final CmsMetadataKeyServiceClient.ListCmsMetadataKeysPagedResponse listCmsMetadataKeys(String parent)

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

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

Returns
Type	Description
`CmsMetadataKeyServiceClient.ListCmsMetadataKeysPagedResponse`

listCmsMetadataKeysCallable()

public final UnaryCallable<ListCmsMetadataKeysRequest,ListCmsMetadataKeysResponse> listCmsMetadataKeysCallable()

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

Returns
Type	Description
`UnaryCallable<ListCmsMetadataKeysRequest,ListCmsMetadataKeysResponse>`

listCmsMetadataKeysPagedCallable()

public final UnaryCallable<ListCmsMetadataKeysRequest,CmsMetadataKeyServiceClient.ListCmsMetadataKeysPagedResponse> listCmsMetadataKeysPagedCallable()

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

Returns
Type	Description
`UnaryCallable<ListCmsMetadataKeysRequest,ListCmsMetadataKeysPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

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

Inheritance

Static Methods

create()

create(CmsMetadataKeyServiceSettings settings)

create(CmsMetadataKeyServiceStub stub)

Constructors

CmsMetadataKeyServiceClient(CmsMetadataKeyServiceSettings settings)

CmsMetadataKeyServiceClient(CmsMetadataKeyServiceStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

close()

getCmsMetadataKey(CmsMetadataKeyName name)

getCmsMetadataKey(GetCmsMetadataKeyRequest request)

getCmsMetadataKey(String name)

getCmsMetadataKeyCallable()

getSettings()

getStub()

isShutdown()

isTerminated()

listCmsMetadataKeys(ListCmsMetadataKeysRequest request)

listCmsMetadataKeys(NetworkName parent)

listCmsMetadataKeys(String parent)

listCmsMetadataKeysCallable()

listCmsMetadataKeysPagedCallable()

shutdown()

shutdownNow()

Class CmsMetadataKeyServiceClient (0.39.0)