Package com.google.cloud.retail.v2alpha
Class ModelServiceSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<ModelServiceSettings>
com.google.cloud.retail.v2alpha.ModelServiceSettings
@BetaApi
@Generated("by gapic-generator-java")
public class ModelServiceSettings
extends ClientSettings<ModelServiceSettings>
Settings class to configure an instance of
ModelServiceClient.
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 getModel:
// 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
ModelServiceSettings.Builder modelServiceSettingsBuilder = ModelServiceSettings.newBuilder();
modelServiceSettingsBuilder
.getModelSettings()
.setRetrySettings(
modelServiceSettingsBuilder
.getModelSettings()
.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());
ModelServiceSettings modelServiceSettings = modelServiceSettingsBuilder.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 createModel:
// 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
ModelServiceSettings.Builder modelServiceSettingsBuilder = ModelServiceSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
modelServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for ModelServiceSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedModelServiceSettings(ModelServiceSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionstatic final ModelServiceSettingsReturns the object with the settings used for calls to createModel.Returns the object with the settings used for calls to createModel.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<DeleteModelRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteModel.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getModel.Returns the object with the settings used for calls to listModels.static ModelServiceSettings.BuilderReturns a new gRPC builder for this class.static ModelServiceSettings.BuildernewBuilder(ClientContext clientContext) Returns a new builder for this class.static ModelServiceSettings.BuilderReturns a new REST builder for this class.Returns the object with the settings used for calls to pauseModel.Returns the object with the settings used for calls to resumeModel.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to tuneModel.Returns the object with the settings used for calls to tuneModel.Returns the object with the settings used for calls to updateModel.Methods inherited from class com.google.api.gax.rpc.ClientSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString
-
Constructor Details
-
ModelServiceSettings
- Throws:
IOException
-
-
Method Details
-
createModelSettings
Returns the object with the settings used for calls to createModel. -
createModelOperationSettings
public OperationCallSettings<CreateModelRequest,Model, createModelOperationSettings()CreateModelMetadata> Returns the object with the settings used for calls to createModel. -
getModelSettings
Returns the object with the settings used for calls to getModel. -
pauseModelSettings
Returns the object with the settings used for calls to pauseModel. -
resumeModelSettings
Returns the object with the settings used for calls to resumeModel. -
deleteModelSettings
Returns the object with the settings used for calls to deleteModel. -
listModelsSettings
public PagedCallSettings<ListModelsRequest,ListModelsResponse, listModelsSettings()ModelServiceClient.ListModelsPagedResponse> Returns the object with the settings used for calls to listModels. -
updateModelSettings
Returns the object with the settings used for calls to updateModel. -
tuneModelSettings
Returns the object with the settings used for calls to tuneModel. -
tuneModelOperationSettings
public OperationCallSettings<TuneModelRequest,TuneModelResponse, tuneModelOperationSettings()TuneModelMetadata> Returns the object with the settings used for calls to tuneModel. -
create
- Throws:
IOException
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default 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
-
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 classClientSettings<ModelServiceSettings>
-