Class ModelGardenServiceSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<ModelGardenServiceSettings>
com.google.cloud.aiplatform.v1beta1.ModelGardenServiceSettings
@BetaApi
@Generated("by gapic-generator-java")
public class ModelGardenServiceSettings
extends ClientSettings<ModelGardenServiceSettings>
Settings class to configure an instance of
ModelGardenServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (aiplatform.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 getPublisherModel:
// 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
ModelGardenServiceSettings.Builder modelGardenServiceSettingsBuilder =
ModelGardenServiceSettings.newBuilder();
modelGardenServiceSettingsBuilder
.getPublisherModelSettings()
.setRetrySettings(
modelGardenServiceSettingsBuilder
.getPublisherModelSettings()
.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());
ModelGardenServiceSettings modelGardenServiceSettings =
modelGardenServiceSettingsBuilder.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 deploy:
// 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
ModelGardenServiceSettings.Builder modelGardenServiceSettingsBuilder =
ModelGardenServiceSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
modelGardenServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for ModelGardenServiceSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedModelGardenServiceSettings(ModelGardenServiceSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to acceptPublisherModelEula.Returns the object with the settings used for calls to checkPublisherModelEulaAcceptance.static final ModelGardenServiceSettingsReturns 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 ChannelProvider for this service.static TransportChannelProviderReturns the object with the settings used for calls to deploy.OperationCallSettings<DeployPublisherModelRequest,DeployPublisherModelResponse, DeployPublisherModelOperationMetadata> Deprecated.This method is deprecated and will be removed in the next major version update.Deprecated.This method is deprecated and will be removed in the next major version update.Returns the object with the settings used for calls to deploy.OperationCallSettings<ExportPublisherModelRequest,ExportPublisherModelResponse, ExportPublisherModelOperationMetadata> Returns the object with the settings used for calls to exportPublisherModel.Returns the object with the settings used for calls to exportPublisherModel.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getIamPolicy.Returns the object with the settings used for calls to getLocation.Returns the object with the settings used for calls to getPublisherModel.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, ModelGardenServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.PagedCallSettings<ListPublisherModelsRequest,ListPublisherModelsResponse, ModelGardenServiceClient.ListPublisherModelsPagedResponse> Returns the object with the settings used for calls to listPublisherModels.Returns a new builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns the object with the settings used for calls to setIamPolicy.Returns the object with the settings used for calls to testIamPermissions.Returns a builder containing all the values of this settings class.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
-
ModelGardenServiceSettings
protected ModelGardenServiceSettings(ModelGardenServiceSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
getPublisherModelSettings
Returns the object with the settings used for calls to getPublisherModel. -
listPublisherModelsSettings
public PagedCallSettings<ListPublisherModelsRequest,ListPublisherModelsResponse, listPublisherModelsSettings()ModelGardenServiceClient.ListPublisherModelsPagedResponse> Returns the object with the settings used for calls to listPublisherModels. -
deploySettings
Returns the object with the settings used for calls to deploy. -
deployOperationSettings
public OperationCallSettings<DeployRequest,DeployResponse, deployOperationSettings()DeployOperationMetadata> Returns the object with the settings used for calls to deploy. -
deployPublisherModelSettings
@Deprecated public UnaryCallSettings<DeployPublisherModelRequest,Operation> deployPublisherModelSettings()Deprecated.This method is deprecated and will be removed in the next major version update.Returns the object with the settings used for calls to deployPublisherModel. -
deployPublisherModelOperationSettings
@Deprecated public OperationCallSettings<DeployPublisherModelRequest,DeployPublisherModelResponse, deployPublisherModelOperationSettings()DeployPublisherModelOperationMetadata> Deprecated.This method is deprecated and will be removed in the next major version update.Returns the object with the settings used for calls to deployPublisherModel. -
exportPublisherModelSettings
Returns the object with the settings used for calls to exportPublisherModel. -
exportPublisherModelOperationSettings
public OperationCallSettings<ExportPublisherModelRequest,ExportPublisherModelResponse, exportPublisherModelOperationSettings()ExportPublisherModelOperationMetadata> Returns the object with the settings used for calls to exportPublisherModel. -
checkPublisherModelEulaAcceptanceSettings
public UnaryCallSettings<CheckPublisherModelEulaAcceptanceRequest,PublisherModelEulaAcceptance> checkPublisherModelEulaAcceptanceSettings()Returns the object with the settings used for calls to checkPublisherModelEulaAcceptance. -
acceptPublisherModelEulaSettings
public UnaryCallSettings<AcceptPublisherModelEulaRequest,PublisherModelEulaAcceptance> acceptPublisherModelEulaSettings()Returns the object with the settings used for calls to acceptPublisherModelEula. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()ModelGardenServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
setIamPolicySettings
Returns the object with the settings used for calls to setIamPolicy. -
getIamPolicySettings
Returns the object with the settings used for calls to getIamPolicy. -
testIamPermissionsSettings
public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()Returns the object with the settings used for calls to testIamPermissions. -
create
public static final ModelGardenServiceSettings create(ModelGardenServiceStubSettings stub) throws IOException - 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 ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new 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<ModelGardenServiceSettings>
-