Package com.google.cloud.retail.v2.stub
Class CatalogServiceStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<CatalogServiceStubSettings>
com.google.cloud.retail.v2.stub.CatalogServiceStubSettings
@Generated("by gapic-generator-java")
public class CatalogServiceStubSettings
extends StubSettings<CatalogServiceStubSettings>
Settings class to configure an instance of
CatalogServiceStub.
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 updateCatalog:
// 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
CatalogServiceStubSettings.Builder catalogServiceSettingsBuilder =
CatalogServiceStubSettings.newBuilder();
catalogServiceSettingsBuilder
.updateCatalogSettings()
.setRetrySettings(
catalogServiceSettingsBuilder
.updateCatalogSettings()
.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());
CatalogServiceStubSettings catalogServiceSettings = catalogServiceSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) for additional support in setting
retries.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for CatalogServiceStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCatalogServiceStubSettings(CatalogServiceStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to addCatalogAttribute.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 TransportChannelProviderReturns the object with the settings used for calls to getAttributesConfig.Returns the object with the settings used for calls to getCompletionConfig.Returns the object with the settings used for calls to getDefaultBranch.static StringReturns the default service endpoint.static StringReturns the default mTLS service endpoint.Returns the default service scopes.protected LibraryMetadataReturns the default service name.PagedCallSettings<ListCatalogsRequest,ListCatalogsResponse, CatalogServiceClient.ListCatalogsPagedResponse> Returns the object with the settings used for calls to listCatalogs.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 removeCatalogAttribute.Returns the object with the settings used for calls to replaceCatalogAttribute.UnaryCallSettings<SetDefaultBranchRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to setDefaultBranch.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateAttributesConfig.Returns the object with the settings used for calls to updateCatalog.Returns the object with the settings used for calls to updateCompletionConfig.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
-
CatalogServiceStubSettings
protected CatalogServiceStubSettings(CatalogServiceStubSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
listCatalogsSettings
public PagedCallSettings<ListCatalogsRequest,ListCatalogsResponse, listCatalogsSettings()CatalogServiceClient.ListCatalogsPagedResponse> Returns the object with the settings used for calls to listCatalogs. -
updateCatalogSettings
Returns the object with the settings used for calls to updateCatalog. -
setDefaultBranchSettings
public UnaryCallSettings<SetDefaultBranchRequest,com.google.protobuf.Empty> setDefaultBranchSettings()Returns the object with the settings used for calls to setDefaultBranch. -
getDefaultBranchSettings
public UnaryCallSettings<GetDefaultBranchRequest,GetDefaultBranchResponse> getDefaultBranchSettings()Returns the object with the settings used for calls to getDefaultBranch. -
getCompletionConfigSettings
Returns the object with the settings used for calls to getCompletionConfig. -
updateCompletionConfigSettings
public UnaryCallSettings<UpdateCompletionConfigRequest,CompletionConfig> updateCompletionConfigSettings()Returns the object with the settings used for calls to updateCompletionConfig. -
getAttributesConfigSettings
Returns the object with the settings used for calls to getAttributesConfig. -
updateAttributesConfigSettings
public UnaryCallSettings<UpdateAttributesConfigRequest,AttributesConfig> updateAttributesConfigSettings()Returns the object with the settings used for calls to updateAttributesConfig. -
addCatalogAttributeSettings
Returns the object with the settings used for calls to addCatalogAttribute. -
removeCatalogAttributeSettings
public UnaryCallSettings<RemoveCatalogAttributeRequest,AttributesConfig> removeCatalogAttributeSettings()Returns the object with the settings used for calls to removeCatalogAttribute. -
replaceCatalogAttributeSettings
public UnaryCallSettings<ReplaceCatalogAttributeRequest,AttributesConfig> replaceCatalogAttributeSettings()Returns the object with the settings used for calls to replaceCatalogAttribute. -
createStub
- Throws:
IOException
-
getServiceName
Returns the default service name.- Overrides:
getServiceNamein classStubSettings<CatalogServiceStubSettings>
-
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<CatalogServiceStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<CatalogServiceStubSettings>
-