Class ProductServiceSettings (2.55.0)

Version latest

• 2.55.0 (latest)
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.1
• 2.4.0
• 2.3.0
• 2.2.3
• 2.1.0
• 2.0.19

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

public class ProductServiceSettings extends ClientSettings<ProductServiceSettings>

Settings class to configure an instance of ProductServiceClient.

The default instance has everything set to sensible defaults:

• The default service address (retail.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the RetrySettings of createProduct:

 // 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
 ProductServiceSettings.Builder productServiceSettingsBuilder =
     ProductServiceSettings.newBuilder();
 productServiceSettingsBuilder
     .createProductSettings()
     .setRetrySettings(
         productServiceSettingsBuilder
             .createProductSettings()
             .getRetrySettings()
             .toBuilder()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 ProductServiceSettings productServiceSettings = productServiceSettingsBuilder.build();
 

Please refer to the Client Side Retry Guide for additional support in setting retries.

To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for purgeProducts:

 // 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
 ProductServiceSettings.Builder productServiceSettingsBuilder =
     ProductServiceSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelay(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 productServiceSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();
 

Inheritance

java.lang.Object > ClientSettings > ProductServiceSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getApiKey()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getGdchApiAudience()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getUniverseDomain()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogCheckIntervalDuration()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(ProductServiceStubSettings stub)

public static final ProductServiceSettings create(ProductServiceStubSettings stub)

Parameter
Name	Description
stub	ProductServiceStubSettings

Returns
Type	Description
ProductServiceSettings

Exceptions
Type	Description
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

Returns
Type	Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type	Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type	Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
Type	Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Returns a builder for the default REST ChannelProvider for this service.

Returns
Type	Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()

Returns
Type	Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type	Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type	Description
List<String>

newBuilder()

public static ProductServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type	Description
ProductServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static ProductServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
clientContext	ClientContext

Returns
Type	Description
ProductServiceSettings.Builder

newHttpJsonBuilder()

public static ProductServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type	Description
ProductServiceSettings.Builder

Constructors

ProductServiceSettings(ProductServiceSettings.Builder settingsBuilder)

protected ProductServiceSettings(ProductServiceSettings.Builder settingsBuilder)

Parameter
Name	Description
settingsBuilder	ProductServiceSettings.Builder

Methods

addFulfillmentPlacesOperationSettings()

public OperationCallSettings<AddFulfillmentPlacesRequest,AddFulfillmentPlacesResponse,AddFulfillmentPlacesMetadata> addFulfillmentPlacesOperationSettings()

Returns the object with the settings used for calls to addFulfillmentPlaces.

Returns
Type	Description
OperationCallSettings<AddFulfillmentPlacesRequest,AddFulfillmentPlacesResponse,AddFulfillmentPlacesMetadata>

addFulfillmentPlacesSettings()

public UnaryCallSettings<AddFulfillmentPlacesRequest,Operation> addFulfillmentPlacesSettings()

Returns the object with the settings used for calls to addFulfillmentPlaces.

Returns
Type	Description
UnaryCallSettings<AddFulfillmentPlacesRequest,Operation>

addLocalInventoriesOperationSettings()

public OperationCallSettings<AddLocalInventoriesRequest,AddLocalInventoriesResponse,AddLocalInventoriesMetadata> addLocalInventoriesOperationSettings()

Returns the object with the settings used for calls to addLocalInventories.

Returns
Type	Description
OperationCallSettings<AddLocalInventoriesRequest,AddLocalInventoriesResponse,AddLocalInventoriesMetadata>

addLocalInventoriesSettings()

public UnaryCallSettings<AddLocalInventoriesRequest,Operation> addLocalInventoriesSettings()

Returns the object with the settings used for calls to addLocalInventories.

Returns
Type	Description
UnaryCallSettings<AddLocalInventoriesRequest,Operation>

createProductSettings()

public UnaryCallSettings<CreateProductRequest,Product> createProductSettings()

Returns the object with the settings used for calls to createProduct.

Returns
Type	Description
UnaryCallSettings<CreateProductRequest,Product>

deleteProductSettings()

public UnaryCallSettings<DeleteProductRequest,Empty> deleteProductSettings()

Returns the object with the settings used for calls to deleteProduct.

Returns
Type	Description
UnaryCallSettings<DeleteProductRequest,Empty>

exportProductsOperationSettings()

public OperationCallSettings<ExportProductsRequest,ExportProductsResponse,ExportMetadata> exportProductsOperationSettings()

Returns the object with the settings used for calls to exportProducts.

Returns
Type	Description
OperationCallSettings<ExportProductsRequest,ExportProductsResponse,ExportMetadata>

exportProductsSettings()

public UnaryCallSettings<ExportProductsRequest,Operation> exportProductsSettings()

Returns the object with the settings used for calls to exportProducts.

Returns
Type	Description
UnaryCallSettings<ExportProductsRequest,Operation>

getProductSettings()

public UnaryCallSettings<GetProductRequest,Product> getProductSettings()

Returns the object with the settings used for calls to getProduct.

Returns
Type	Description
UnaryCallSettings<GetProductRequest,Product>

importProductsOperationSettings()

public OperationCallSettings<ImportProductsRequest,ImportProductsResponse,ImportMetadata> importProductsOperationSettings()

Returns the object with the settings used for calls to importProducts.

Returns
Type	Description
OperationCallSettings<ImportProductsRequest,ImportProductsResponse,ImportMetadata>

importProductsSettings()

public UnaryCallSettings<ImportProductsRequest,Operation> importProductsSettings()

Returns the object with the settings used for calls to importProducts.

Returns
Type	Description
UnaryCallSettings<ImportProductsRequest,Operation>

listProductsSettings()

public PagedCallSettings<ListProductsRequest,ListProductsResponse,ProductServiceClient.ListProductsPagedResponse> listProductsSettings()

Returns the object with the settings used for calls to listProducts.

Returns
Type	Description
PagedCallSettings<ListProductsRequest,ListProductsResponse,ListProductsPagedResponse>

purgeProductsOperationSettings()

public OperationCallSettings<PurgeProductsRequest,PurgeProductsResponse,PurgeProductsMetadata> purgeProductsOperationSettings()

Returns the object with the settings used for calls to purgeProducts.

Returns
Type	Description
OperationCallSettings<PurgeProductsRequest,PurgeProductsResponse,PurgeProductsMetadata>

purgeProductsSettings()

public UnaryCallSettings<PurgeProductsRequest,Operation> purgeProductsSettings()

Returns the object with the settings used for calls to purgeProducts.

Returns
Type	Description
UnaryCallSettings<PurgeProductsRequest,Operation>

removeFulfillmentPlacesOperationSettings()

public OperationCallSettings<RemoveFulfillmentPlacesRequest,RemoveFulfillmentPlacesResponse,RemoveFulfillmentPlacesMetadata> removeFulfillmentPlacesOperationSettings()

Returns the object with the settings used for calls to removeFulfillmentPlaces.

Returns
Type	Description
OperationCallSettings<RemoveFulfillmentPlacesRequest,RemoveFulfillmentPlacesResponse,RemoveFulfillmentPlacesMetadata>

removeFulfillmentPlacesSettings()

public UnaryCallSettings<RemoveFulfillmentPlacesRequest,Operation> removeFulfillmentPlacesSettings()

Returns the object with the settings used for calls to removeFulfillmentPlaces.

Returns
Type	Description
UnaryCallSettings<RemoveFulfillmentPlacesRequest,Operation>

removeLocalInventoriesOperationSettings()

public OperationCallSettings<RemoveLocalInventoriesRequest,RemoveLocalInventoriesResponse,RemoveLocalInventoriesMetadata> removeLocalInventoriesOperationSettings()

Returns the object with the settings used for calls to removeLocalInventories.

Returns
Type	Description
OperationCallSettings<RemoveLocalInventoriesRequest,RemoveLocalInventoriesResponse,RemoveLocalInventoriesMetadata>

removeLocalInventoriesSettings()

public UnaryCallSettings<RemoveLocalInventoriesRequest,Operation> removeLocalInventoriesSettings()

Returns the object with the settings used for calls to removeLocalInventories.

Returns
Type	Description
UnaryCallSettings<RemoveLocalInventoriesRequest,Operation>

setInventoryOperationSettings()

public OperationCallSettings<SetInventoryRequest,SetInventoryResponse,SetInventoryMetadata> setInventoryOperationSettings()

Returns the object with the settings used for calls to setInventory.

Returns
Type	Description
OperationCallSettings<SetInventoryRequest,SetInventoryResponse,SetInventoryMetadata>

setInventorySettings()

public UnaryCallSettings<SetInventoryRequest,Operation> setInventorySettings()

Returns the object with the settings used for calls to setInventory.

Returns
Type	Description
UnaryCallSettings<SetInventoryRequest,Operation>

toBuilder()

public ProductServiceSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
Type	Description
ProductServiceSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateProductSettings()

public UnaryCallSettings<UpdateProductRequest,Product> updateProductSettings()

Returns the object with the settings used for calls to updateProduct.

Returns
Type	Description
UnaryCallSettings<UpdateProductRequest,Product>