Package com.google.cloud.retail.v2.stub
Class ProductServiceStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<ProductServiceStubSettings>
com.google.cloud.retail.v2.stub.ProductServiceStubSettings
@Generated("by gapic-generator-java")
public class ProductServiceStubSettings
extends StubSettings<ProductServiceStubSettings>
Settings class to configure an instance of
ProductServiceStub.
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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.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
ProductServiceStubSettings.Builder productServiceSettingsBuilder =
ProductServiceStubSettings.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());
ProductServiceStubSettings productServiceSettings = productServiceSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) 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
ProductServiceStubSettings.Builder productServiceSettingsBuilder =
ProductServiceStubSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
productServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for ProductServiceStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedProductServiceStubSettings(ProductServiceStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionOperationCallSettings<AddFulfillmentPlacesRequest,AddFulfillmentPlacesResponse, AddFulfillmentPlacesMetadata> Returns the object with the settings used for calls to addFulfillmentPlaces.Returns the object with the settings used for calls to addFulfillmentPlaces.OperationCallSettings<AddLocalInventoriesRequest,AddLocalInventoriesResponse, AddLocalInventoriesMetadata> Returns the object with the settings used for calls to addLocalInventories.Returns the object with the settings used for calls to addLocalInventories.Returns the object with the settings used for calls to createProduct.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default gRPC ChannelProvider for this service.Returns a builder for the default REST ChannelProvider for this service.static TransportChannelProviderUnaryCallSettings<DeleteProductRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteProduct.static StringReturns the default service endpoint.static StringReturns the default mTLS service endpoint.Returns the default service scopes.protected LibraryMetadataReturns the object with the settings used for calls to getProduct.Returns the default service name.Returns the object with the settings used for calls to importProducts.Returns the object with the settings used for calls to importProducts.PagedCallSettings<ListProductsRequest,ListProductsResponse, ProductServiceClient.ListProductsPagedResponse> Returns the object with the settings used for calls to listProducts.Returns a new gRPC builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns a new REST builder for this class.Returns the object with the settings used for calls to purgeProducts.Returns the object with the settings used for calls to purgeProducts.OperationCallSettings<RemoveFulfillmentPlacesRequest,RemoveFulfillmentPlacesResponse, RemoveFulfillmentPlacesMetadata> Returns the object with the settings used for calls to removeFulfillmentPlaces.Returns the object with the settings used for calls to removeFulfillmentPlaces.OperationCallSettings<RemoveLocalInventoriesRequest,RemoveLocalInventoriesResponse, RemoveLocalInventoriesMetadata> Returns the object with the settings used for calls to removeLocalInventories.Returns the object with the settings used for calls to removeLocalInventories.Returns the object with the settings used for calls to setInventory.Returns the object with the settings used for calls to setInventory.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateProduct.Methods inherited from class com.google.api.gax.rpc.StubSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogCheckIntervalDuration, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toString
-
Constructor Details
-
ProductServiceStubSettings
protected ProductServiceStubSettings(ProductServiceStubSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
createProductSettings
Returns the object with the settings used for calls to createProduct. -
getProductSettings
Returns the object with the settings used for calls to getProduct. -
listProductsSettings
public PagedCallSettings<ListProductsRequest,ListProductsResponse, listProductsSettings()ProductServiceClient.ListProductsPagedResponse> Returns the object with the settings used for calls to listProducts. -
updateProductSettings
Returns the object with the settings used for calls to updateProduct. -
deleteProductSettings
Returns the object with the settings used for calls to deleteProduct. -
purgeProductsSettings
Returns the object with the settings used for calls to purgeProducts. -
purgeProductsOperationSettings
public OperationCallSettings<PurgeProductsRequest,PurgeProductsResponse, purgeProductsOperationSettings()PurgeProductsMetadata> Returns the object with the settings used for calls to purgeProducts. -
importProductsSettings
Returns the object with the settings used for calls to importProducts. -
importProductsOperationSettings
public OperationCallSettings<ImportProductsRequest,ImportProductsResponse, importProductsOperationSettings()ImportMetadata> Returns the object with the settings used for calls to importProducts. -
setInventorySettings
Returns the object with the settings used for calls to setInventory. -
setInventoryOperationSettings
public OperationCallSettings<SetInventoryRequest,SetInventoryResponse, setInventoryOperationSettings()SetInventoryMetadata> Returns the object with the settings used for calls to setInventory. -
addFulfillmentPlacesSettings
Returns the object with the settings used for calls to addFulfillmentPlaces. -
addFulfillmentPlacesOperationSettings
public OperationCallSettings<AddFulfillmentPlacesRequest,AddFulfillmentPlacesResponse, addFulfillmentPlacesOperationSettings()AddFulfillmentPlacesMetadata> Returns the object with the settings used for calls to addFulfillmentPlaces. -
removeFulfillmentPlacesSettings
public UnaryCallSettings<RemoveFulfillmentPlacesRequest,Operation> removeFulfillmentPlacesSettings()Returns the object with the settings used for calls to removeFulfillmentPlaces. -
removeFulfillmentPlacesOperationSettings
public OperationCallSettings<RemoveFulfillmentPlacesRequest,RemoveFulfillmentPlacesResponse, removeFulfillmentPlacesOperationSettings()RemoveFulfillmentPlacesMetadata> Returns the object with the settings used for calls to removeFulfillmentPlaces. -
addLocalInventoriesSettings
Returns the object with the settings used for calls to addLocalInventories. -
addLocalInventoriesOperationSettings
public OperationCallSettings<AddLocalInventoriesRequest,AddLocalInventoriesResponse, addLocalInventoriesOperationSettings()AddLocalInventoriesMetadata> Returns the object with the settings used for calls to addLocalInventories. -
removeLocalInventoriesSettings
Returns the object with the settings used for calls to removeLocalInventories. -
removeLocalInventoriesOperationSettings
public OperationCallSettings<RemoveLocalInventoriesRequest,RemoveLocalInventoriesResponse, removeLocalInventoriesOperationSettings()RemoveLocalInventoriesMetadata> Returns the object with the settings used for calls to removeLocalInventories. -
createStub
- Throws:
IOException
-
getServiceName
Returns the default service name.- Overrides:
getServiceNamein classStubSettings<ProductServiceStubSettings>
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultMtlsEndpoint
Returns the default mTLS service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default gRPC ChannelProvider for this service. -
defaultHttpJsonTransportProviderBuilder
@BetaApi public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultGrpcApiClientHeaderProviderBuilder
-
defaultHttpJsonApiClientHeaderProviderBuilder
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classStubSettings<ProductServiceStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<ProductServiceStubSettings>
-