Class CssProductsServiceClient (0.17.0)

GitHub RepositoryProduct Reference

Service Description: Service for doing get and list on Css Products(a.k.a Aggregate Offers internally).

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 (CssProductsServiceClient cssProductsServiceClient = CssProductsServiceClient.create()) {
   CssProductName name = CssProductName.of("[ACCOUNT]", "[CSS_PRODUCT]");
   CssProduct response = cssProductsServiceClient.getCssProduct(name);
 }

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

GetCssProduct

Retrieves the processed CSS Product from your CSS Center account. After inserting, updating, or deleting a product input, it may take several minutes before the updated final product can be retrieved.

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

  • getCssProduct(GetCssProductRequest request)

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

  • getCssProduct(CssProductName name)

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

  • getCssProductCallable()

ListCssProducts

Lists the processed CSS Products in your CSS Center account. The response might contain fewer items than specified by pageSize. Rely on pageToken to determine if there are more items to be requested.

After inserting, updating, or deleting a CSS product input, it may take several minutes before the updated processed CSS product can be retrieved.

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

  • listCssProducts(ListCssProductsRequest request)

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

  • listCssProducts(AccountName parent)

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

  • listCssProductsPagedCallable()

  • listCssProductsCallable()

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 CssProductsServiceSettings 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
 CssProductsServiceSettings cssProductsServiceSettings =
     CssProductsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CssProductsServiceClient cssProductsServiceClient =
     CssProductsServiceClient.create(cssProductsServiceSettings);

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
 CssProductsServiceSettings cssProductsServiceSettings =
     CssProductsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 CssProductsServiceClient cssProductsServiceClient =
     CssProductsServiceClient.create(cssProductsServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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
 CssProductsServiceSettings cssProductsServiceSettings =
     CssProductsServiceSettings.newHttpJsonBuilder().build();
 CssProductsServiceClient cssProductsServiceClient =
     CssProductsServiceClient.create(cssProductsServiceSettings);

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

Inheritance

java.lang.Object > CssProductsServiceClient

Static Methods

create()

public static final CssProductsServiceClient create()

Constructs an instance of CssProductsServiceClient with default settings.

Returns
Type Description
CssProductsServiceClient
Exceptions
Type Description
IOException

create(CssProductsServiceSettings settings)

public static final CssProductsServiceClient create(CssProductsServiceSettings settings)

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

create(CssProductsServiceStub stub)

public static final CssProductsServiceClient create(CssProductsServiceStub stub)

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

Parameter
Name Description
stub CssProductsServiceStub
Returns
Type Description
CssProductsServiceClient

Constructors

CssProductsServiceClient(CssProductsServiceSettings settings)

protected CssProductsServiceClient(CssProductsServiceSettings settings)

Constructs an instance of CssProductsServiceClient, 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 CssProductsServiceSettings

CssProductsServiceClient(CssProductsServiceStub stub)

protected CssProductsServiceClient(CssProductsServiceStub stub)
Parameter
Name Description
stub CssProductsServiceStub

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

getCssProduct(CssProductName name)

public final CssProduct getCssProduct(CssProductName name)

Retrieves the processed CSS Product from your CSS Center account. After inserting, updating, or deleting a product input, it may take several minutes before the updated final product can be retrieved.

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 (CssProductsServiceClient cssProductsServiceClient = CssProductsServiceClient.create()) {
   CssProductName name = CssProductName.of("[ACCOUNT]", "[CSS_PRODUCT]");
   CssProduct response = cssProductsServiceClient.getCssProduct(name);
 }
Parameter
Name Description
name CssProductName

Required. The name of the CSS product to retrieve.
Returns
Type Description
CssProduct

getCssProduct(GetCssProductRequest request)

public final CssProduct getCssProduct(GetCssProductRequest request)

Retrieves the processed CSS Product from your CSS Center account. After inserting, updating, or deleting a product input, it may take several minutes before the updated final product can be retrieved.

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 (CssProductsServiceClient cssProductsServiceClient = CssProductsServiceClient.create()) {
   GetCssProductRequest request =
       GetCssProductRequest.newBuilder()
           .setName(CssProductName.of("[ACCOUNT]", "[CSS_PRODUCT]").toString())
           .build();
   CssProduct response = cssProductsServiceClient.getCssProduct(request);
 }
Parameter
Name Description
request GetCssProductRequest

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

getCssProduct(String name)

public final CssProduct getCssProduct(String name)

Retrieves the processed CSS Product from your CSS Center account. After inserting, updating, or deleting a product input, it may take several minutes before the updated final product can be retrieved.

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 (CssProductsServiceClient cssProductsServiceClient = CssProductsServiceClient.create()) {
   String name = CssProductName.of("[ACCOUNT]", "[CSS_PRODUCT]").toString();
   CssProduct response = cssProductsServiceClient.getCssProduct(name);
 }
Parameter
Name Description
name String

Required. The name of the CSS product to retrieve.
Returns
Type Description
CssProduct

getCssProductCallable()

public final UnaryCallable<GetCssProductRequest,CssProduct> getCssProductCallable()

Retrieves the processed CSS Product from your CSS Center account. After inserting, updating, or deleting a product input, it may take several minutes before the updated final product can be retrieved.

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 (CssProductsServiceClient cssProductsServiceClient = CssProductsServiceClient.create()) {
   GetCssProductRequest request =
       GetCssProductRequest.newBuilder()
           .setName(CssProductName.of("[ACCOUNT]", "[CSS_PRODUCT]").toString())
           .build();
   ApiFuture<CssProduct> future =
       cssProductsServiceClient.getCssProductCallable().futureCall(request);
   // Do something.
   CssProduct response = future.get();
 }
Returns
Type Description
UnaryCallable<GetCssProductRequest,CssProduct>

getSettings()

public final CssProductsServiceSettings getSettings()
Returns
Type Description
CssProductsServiceSettings

getStub()

public CssProductsServiceStub getStub()
Returns
Type Description
CssProductsServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listCssProducts(AccountName parent)

public final CssProductsServiceClient.ListCssProductsPagedResponse listCssProducts(AccountName parent)

Lists the processed CSS Products in your CSS Center account. The response might contain fewer items than specified by pageSize. Rely on pageToken to determine if there are more items to be requested.

After inserting, updating, or deleting a CSS product input, it may take several minutes before the updated processed CSS product can be retrieved.

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 (CssProductsServiceClient cssProductsServiceClient = CssProductsServiceClient.create()) {
   AccountName parent = AccountName.of("[ACCOUNT]");
   for (CssProduct element : cssProductsServiceClient.listCssProducts(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent AccountName

Required. The account/domain to list processed CSS Products for. Format: accounts/{account}
Returns
Type Description
CssProductsServiceClient.ListCssProductsPagedResponse

listCssProducts(ListCssProductsRequest request)

public final CssProductsServiceClient.ListCssProductsPagedResponse listCssProducts(ListCssProductsRequest request)

Lists the processed CSS Products in your CSS Center account. The response might contain fewer items than specified by pageSize. Rely on pageToken to determine if there are more items to be requested.

After inserting, updating, or deleting a CSS product input, it may take several minutes before the updated processed CSS product can be retrieved.

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 (CssProductsServiceClient cssProductsServiceClient = CssProductsServiceClient.create()) {
   ListCssProductsRequest request =
       ListCssProductsRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (CssProduct element : cssProductsServiceClient.listCssProducts(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListCssProductsRequest

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

listCssProducts(String parent)

public final CssProductsServiceClient.ListCssProductsPagedResponse listCssProducts(String parent)

Lists the processed CSS Products in your CSS Center account. The response might contain fewer items than specified by pageSize. Rely on pageToken to determine if there are more items to be requested.

After inserting, updating, or deleting a CSS product input, it may take several minutes before the updated processed CSS product can be retrieved.

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 (CssProductsServiceClient cssProductsServiceClient = CssProductsServiceClient.create()) {
   String parent = AccountName.of("[ACCOUNT]").toString();
   for (CssProduct element : cssProductsServiceClient.listCssProducts(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The account/domain to list processed CSS Products for. Format: accounts/{account}
Returns
Type Description
CssProductsServiceClient.ListCssProductsPagedResponse

listCssProductsCallable()

public final UnaryCallable<ListCssProductsRequest,ListCssProductsResponse> listCssProductsCallable()

Lists the processed CSS Products in your CSS Center account. The response might contain fewer items than specified by pageSize. Rely on pageToken to determine if there are more items to be requested.

After inserting, updating, or deleting a CSS product input, it may take several minutes before the updated processed CSS product can be retrieved.

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 (CssProductsServiceClient cssProductsServiceClient = CssProductsServiceClient.create()) {
   ListCssProductsRequest request =
       ListCssProductsRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListCssProductsResponse response =
         cssProductsServiceClient.listCssProductsCallable().call(request);
     for (CssProduct element : response.getCssProductsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListCssProductsRequest,ListCssProductsResponse>

listCssProductsPagedCallable()

public final UnaryCallable<ListCssProductsRequest,CssProductsServiceClient.ListCssProductsPagedResponse> listCssProductsPagedCallable()

Lists the processed CSS Products in your CSS Center account. The response might contain fewer items than specified by pageSize. Rely on pageToken to determine if there are more items to be requested.

After inserting, updating, or deleting a CSS product input, it may take several minutes before the updated processed CSS product can be retrieved.

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 (CssProductsServiceClient cssProductsServiceClient = CssProductsServiceClient.create()) {
   ListCssProductsRequest request =
       ListCssProductsRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<CssProduct> future =
       cssProductsServiceClient.listCssProductsPagedCallable().futureCall(request);
   // Do something.
   for (CssProduct element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListCssProductsRequest,ListCssProductsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()