Package com.google.cloud.retail.v2
Class CatalogServiceSettings
- java.lang.Object
-
- com.google.api.gax.rpc.ClientSettings<CatalogServiceSettings>
-
- com.google.cloud.retail.v2.CatalogServiceSettings
-
@Generated("by gapic-generator-java") public class CatalogServiceSettings extends com.google.api.gax.rpc.ClientSettings<CatalogServiceSettings>
Settings class to configure an instance ofCatalogServiceClient
.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 total timeout of updateCatalog to 30 seconds:
// 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 CatalogServiceSettings.Builder catalogServiceSettingsBuilder = CatalogServiceSettings.newBuilder(); catalogServiceSettingsBuilder .updateCatalogSettings() .setRetrySettings( catalogServiceSettingsBuilder .updateCatalogSettings() .getRetrySettings() .toBuilder() .setTotalTimeout(Duration.ofSeconds(30)) .build()); CatalogServiceSettings catalogServiceSettings = catalogServiceSettingsBuilder.build();
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CatalogServiceSettings.Builder
Builder for CatalogServiceSettings.
-
Constructor Summary
Constructors Modifier Constructor Description protected
CatalogServiceSettings(CatalogServiceSettings.Builder settingsBuilder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.google.api.gax.rpc.UnaryCallSettings<AddCatalogAttributeRequest,AttributesConfig>
addCatalogAttributeSettings()
Returns the object with the settings used for calls to addCatalogAttribute.static CatalogServiceSettings
create(CatalogServiceStubSettings stub)
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder
defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder
defaultCredentialsProviderBuilder()
Returns a builder for the default credentials for this service.static com.google.api.gax.core.InstantiatingExecutorProvider.Builder
defaultExecutorProviderBuilder()
Returns a builder for the default ExecutorProvider for this service.static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder
defaultGrpcTransportProviderBuilder()
Returns a builder for the default gRPC ChannelProvider for this service.static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder
defaultHttpJsonTransportProviderBuilder()
Returns a builder for the default REST ChannelProvider for this service.static com.google.api.gax.rpc.TransportChannelProvider
defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<GetAttributesConfigRequest,AttributesConfig>
getAttributesConfigSettings()
Returns the object with the settings used for calls to getAttributesConfig.com.google.api.gax.rpc.UnaryCallSettings<GetCompletionConfigRequest,CompletionConfig>
getCompletionConfigSettings()
Returns the object with the settings used for calls to getCompletionConfig.com.google.api.gax.rpc.UnaryCallSettings<GetDefaultBranchRequest,GetDefaultBranchResponse>
getDefaultBranchSettings()
Returns the object with the settings used for calls to getDefaultBranch.static String
getDefaultEndpoint()
Returns the default service endpoint.static List<String>
getDefaultServiceScopes()
Returns the default service scopes.com.google.api.gax.rpc.PagedCallSettings<ListCatalogsRequest,ListCatalogsResponse,CatalogServiceClient.ListCatalogsPagedResponse>
listCatalogsSettings()
Returns the object with the settings used for calls to listCatalogs.static CatalogServiceSettings.Builder
newBuilder()
Returns a new gRPC builder for this class.static CatalogServiceSettings.Builder
newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.static CatalogServiceSettings.Builder
newHttpJsonBuilder()
Returns a new REST builder for this class.com.google.api.gax.rpc.UnaryCallSettings<RemoveCatalogAttributeRequest,AttributesConfig>
removeCatalogAttributeSettings()
Returns the object with the settings used for calls to removeCatalogAttribute.com.google.api.gax.rpc.UnaryCallSettings<ReplaceCatalogAttributeRequest,AttributesConfig>
replaceCatalogAttributeSettings()
Returns the object with the settings used for calls to replaceCatalogAttribute.com.google.api.gax.rpc.UnaryCallSettings<SetDefaultBranchRequest,com.google.protobuf.Empty>
setDefaultBranchSettings()
Returns the object with the settings used for calls to setDefaultBranch.CatalogServiceSettings.Builder
toBuilder()
Returns a builder containing all the values of this settings class.com.google.api.gax.rpc.UnaryCallSettings<UpdateAttributesConfigRequest,AttributesConfig>
updateAttributesConfigSettings()
Returns the object with the settings used for calls to updateAttributesConfig.com.google.api.gax.rpc.UnaryCallSettings<UpdateCatalogRequest,Catalog>
updateCatalogSettings()
Returns the object with the settings used for calls to updateCatalog.com.google.api.gax.rpc.UnaryCallSettings<UpdateCompletionConfigRequest,CompletionConfig>
updateCompletionConfigSettings()
Returns the object with the settings used for calls to updateCompletionConfig.-
Methods inherited from class com.google.api.gax.rpc.ClientSettings
getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString
-
-
-
-
Constructor Detail
-
CatalogServiceSettings
protected CatalogServiceSettings(CatalogServiceSettings.Builder settingsBuilder) throws IOException
- Throws:
IOException
-
-
Method Detail
-
listCatalogsSettings
public com.google.api.gax.rpc.PagedCallSettings<ListCatalogsRequest,ListCatalogsResponse,CatalogServiceClient.ListCatalogsPagedResponse> listCatalogsSettings()
Returns the object with the settings used for calls to listCatalogs.
-
updateCatalogSettings
public com.google.api.gax.rpc.UnaryCallSettings<UpdateCatalogRequest,Catalog> updateCatalogSettings()
Returns the object with the settings used for calls to updateCatalog.
-
setDefaultBranchSettings
public com.google.api.gax.rpc.UnaryCallSettings<SetDefaultBranchRequest,com.google.protobuf.Empty> setDefaultBranchSettings()
Returns the object with the settings used for calls to setDefaultBranch.
-
getDefaultBranchSettings
public com.google.api.gax.rpc.UnaryCallSettings<GetDefaultBranchRequest,GetDefaultBranchResponse> getDefaultBranchSettings()
Returns the object with the settings used for calls to getDefaultBranch.
-
getCompletionConfigSettings
public com.google.api.gax.rpc.UnaryCallSettings<GetCompletionConfigRequest,CompletionConfig> getCompletionConfigSettings()
Returns the object with the settings used for calls to getCompletionConfig.
-
updateCompletionConfigSettings
public com.google.api.gax.rpc.UnaryCallSettings<UpdateCompletionConfigRequest,CompletionConfig> updateCompletionConfigSettings()
Returns the object with the settings used for calls to updateCompletionConfig.
-
getAttributesConfigSettings
public com.google.api.gax.rpc.UnaryCallSettings<GetAttributesConfigRequest,AttributesConfig> getAttributesConfigSettings()
Returns the object with the settings used for calls to getAttributesConfig.
-
updateAttributesConfigSettings
public com.google.api.gax.rpc.UnaryCallSettings<UpdateAttributesConfigRequest,AttributesConfig> updateAttributesConfigSettings()
Returns the object with the settings used for calls to updateAttributesConfig.
-
addCatalogAttributeSettings
public com.google.api.gax.rpc.UnaryCallSettings<AddCatalogAttributeRequest,AttributesConfig> addCatalogAttributeSettings()
Returns the object with the settings used for calls to addCatalogAttribute.
-
removeCatalogAttributeSettings
public com.google.api.gax.rpc.UnaryCallSettings<RemoveCatalogAttributeRequest,AttributesConfig> removeCatalogAttributeSettings()
Returns the object with the settings used for calls to removeCatalogAttribute.
-
replaceCatalogAttributeSettings
public com.google.api.gax.rpc.UnaryCallSettings<ReplaceCatalogAttributeRequest,AttributesConfig> replaceCatalogAttributeSettings()
Returns the object with the settings used for calls to replaceCatalogAttribute.
-
create
public static final CatalogServiceSettings create(CatalogServiceStubSettings stub) throws IOException
- Throws:
IOException
-
defaultExecutorProviderBuilder
public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()
Returns a builder for the default ExecutorProvider for this service.
-
getDefaultEndpoint
public static String getDefaultEndpoint()
Returns the default service endpoint.
-
getDefaultServiceScopes
public static List<String> getDefaultServiceScopes()
Returns the default service scopes.
-
defaultCredentialsProviderBuilder
public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()
Returns a builder for the default credentials for this service.
-
defaultGrpcTransportProviderBuilder
public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()
Returns a builder for the default gRPC ChannelProvider for this service.
-
defaultHttpJsonTransportProviderBuilder
@BetaApi public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()
Returns a builder for the default REST ChannelProvider for this service.
-
defaultTransportChannelProvider
public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()
-
defaultApiClientHeaderProviderBuilder
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.") public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
-
newBuilder
public static CatalogServiceSettings.Builder newBuilder()
Returns a new gRPC builder for this class.
-
newHttpJsonBuilder
@BetaApi public static CatalogServiceSettings.Builder newHttpJsonBuilder()
Returns a new REST builder for this class.
-
newBuilder
public static CatalogServiceSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.
-
toBuilder
public CatalogServiceSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.- Specified by:
toBuilder
in classcom.google.api.gax.rpc.ClientSettings<CatalogServiceSettings>
-
-