Class ModelServiceStubSettings (3.52.0)

Version latest

• 3.52.0 (latest)
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

public class ModelServiceStubSettings extends StubSettings<ModelServiceStubSettings>

Settings class to configure an instance of ModelServiceStub.

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 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
 ModelServiceStubSettings.Builder modelServiceSettingsBuilder =
     ModelServiceStubSettings.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());
 ModelServiceStubSettings modelServiceSettings = modelServiceSettingsBuilder.build();
 

Please refer to the Client Side Retry Guide 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 uploadModel:

 // 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
 ModelServiceStubSettings.Builder modelServiceSettingsBuilder =
     ModelServiceStubSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelay(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 modelServiceSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();
 

Inheritance

java.lang.Object > StubSettings > ModelServiceStubSettings

Inherited Members

StubSettings.getBackgroundExecutorProvider()

StubSettings.getClock()

StubSettings.getCredentialsProvider()

StubSettings.getEndpoint()

StubSettings.getExecutorProvider()

StubSettings.getGdchApiAudience()

StubSettings.getHeaderProvider()

StubSettings.getInternalHeaderProvider()

StubSettings.getMtlsEndpoint()

StubSettings.getQuotaProjectId()

StubSettings.getServiceName()

StubSettings.getStreamWatchdogCheckInterval()

StubSettings.getStreamWatchdogCheckIntervalDuration()

StubSettings.getStreamWatchdogProvider()

StubSettings.getTracerFactory()

StubSettings.getTransportChannelProvider()

StubSettings.getUniverseDomain()

StubSettings.toBuilder()

StubSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

Returns
Type	Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type	Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type	Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
Type	Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()

Returns
Type	Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Obsolete

Use getEndpoint() instead

This feature is stable for usage in this major version, but may be deprecated in a future release.

Returns the default service endpoint.

Returns
Type	Description
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
Type	Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type	Description
List<String>

newBuilder()

public static ModelServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type	Description
ModelServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static ModelServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
clientContext	ClientContext

Returns
Type	Description
ModelServiceStubSettings.Builder

Constructors

ModelServiceStubSettings(ModelServiceStubSettings.Builder settingsBuilder)

protected ModelServiceStubSettings(ModelServiceStubSettings.Builder settingsBuilder)

Parameter
Name	Description
settingsBuilder	ModelServiceStubSettings.Builder

Methods

batchImportEvaluatedAnnotationsSettings()

public UnaryCallSettings<BatchImportEvaluatedAnnotationsRequest,BatchImportEvaluatedAnnotationsResponse> batchImportEvaluatedAnnotationsSettings()

Returns the object with the settings used for calls to batchImportEvaluatedAnnotations.

Returns
Type	Description
UnaryCallSettings<BatchImportEvaluatedAnnotationsRequest,BatchImportEvaluatedAnnotationsResponse>

batchImportModelEvaluationSlicesSettings()

public UnaryCallSettings<BatchImportModelEvaluationSlicesRequest,BatchImportModelEvaluationSlicesResponse> batchImportModelEvaluationSlicesSettings()

Returns the object with the settings used for calls to batchImportModelEvaluationSlices.

Returns
Type	Description
UnaryCallSettings<BatchImportModelEvaluationSlicesRequest,BatchImportModelEvaluationSlicesResponse>

copyModelOperationSettings()

public OperationCallSettings<CopyModelRequest,CopyModelResponse,CopyModelOperationMetadata> copyModelOperationSettings()

Returns the object with the settings used for calls to copyModel.

Returns
Type	Description
OperationCallSettings<CopyModelRequest,CopyModelResponse,CopyModelOperationMetadata>

copyModelSettings()

public UnaryCallSettings<CopyModelRequest,Operation> copyModelSettings()

Returns the object with the settings used for calls to copyModel.

Returns
Type	Description
UnaryCallSettings<CopyModelRequest,Operation>

createStub()

public ModelServiceStub createStub()

Returns
Type	Description
ModelServiceStub

Exceptions
Type	Description
IOException

deleteModelOperationSettings()

public OperationCallSettings<DeleteModelRequest,Empty,DeleteOperationMetadata> deleteModelOperationSettings()

Returns the object with the settings used for calls to deleteModel.

Returns
Type	Description
OperationCallSettings<DeleteModelRequest,Empty,DeleteOperationMetadata>

deleteModelSettings()

public UnaryCallSettings<DeleteModelRequest,Operation> deleteModelSettings()

Returns the object with the settings used for calls to deleteModel.

Returns
Type	Description
UnaryCallSettings<DeleteModelRequest,Operation>

deleteModelVersionOperationSettings()

public OperationCallSettings<DeleteModelVersionRequest,Empty,DeleteOperationMetadata> deleteModelVersionOperationSettings()

Returns the object with the settings used for calls to deleteModelVersion.

Returns
Type	Description
OperationCallSettings<DeleteModelVersionRequest,Empty,DeleteOperationMetadata>

deleteModelVersionSettings()

public UnaryCallSettings<DeleteModelVersionRequest,Operation> deleteModelVersionSettings()

Returns the object with the settings used for calls to deleteModelVersion.

Returns
Type	Description
UnaryCallSettings<DeleteModelVersionRequest,Operation>

exportModelOperationSettings()

public OperationCallSettings<ExportModelRequest,ExportModelResponse,ExportModelOperationMetadata> exportModelOperationSettings()

Returns the object with the settings used for calls to exportModel.

Returns
Type	Description
OperationCallSettings<ExportModelRequest,ExportModelResponse,ExportModelOperationMetadata>

exportModelSettings()

public UnaryCallSettings<ExportModelRequest,Operation> exportModelSettings()

Returns the object with the settings used for calls to exportModel.

Returns
Type	Description
UnaryCallSettings<ExportModelRequest,Operation>

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

Returns the object with the settings used for calls to getIamPolicy.

Returns
Type	Description
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

Returns the object with the settings used for calls to getLocation.

Returns
Type	Description
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getModelEvaluationSettings()

public UnaryCallSettings<GetModelEvaluationRequest,ModelEvaluation> getModelEvaluationSettings()

Returns the object with the settings used for calls to getModelEvaluation.

Returns
Type	Description
UnaryCallSettings<GetModelEvaluationRequest,ModelEvaluation>

getModelEvaluationSliceSettings()

public UnaryCallSettings<GetModelEvaluationSliceRequest,ModelEvaluationSlice> getModelEvaluationSliceSettings()

Returns the object with the settings used for calls to getModelEvaluationSlice.

Returns
Type	Description
UnaryCallSettings<GetModelEvaluationSliceRequest,ModelEvaluationSlice>

getModelSettings()

public UnaryCallSettings<GetModelRequest,Model> getModelSettings()

Returns the object with the settings used for calls to getModel.

Returns
Type	Description
UnaryCallSettings<GetModelRequest,Model>

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type	Description
String

Overrides

StubSettings<SettingsT>.getServiceName()

importModelEvaluationSettings()

public UnaryCallSettings<ImportModelEvaluationRequest,ModelEvaluation> importModelEvaluationSettings()

Returns the object with the settings used for calls to importModelEvaluation.

Returns
Type	Description
UnaryCallSettings<ImportModelEvaluationRequest,ModelEvaluation>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,ModelServiceClient.ListLocationsPagedResponse> listLocationsSettings()

Returns the object with the settings used for calls to listLocations.

Returns
Type	Description
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

listModelEvaluationSlicesSettings()

public PagedCallSettings<ListModelEvaluationSlicesRequest,ListModelEvaluationSlicesResponse,ModelServiceClient.ListModelEvaluationSlicesPagedResponse> listModelEvaluationSlicesSettings()

Returns the object with the settings used for calls to listModelEvaluationSlices.

Returns
Type	Description
PagedCallSettings<ListModelEvaluationSlicesRequest,ListModelEvaluationSlicesResponse,ListModelEvaluationSlicesPagedResponse>

listModelEvaluationsSettings()

public PagedCallSettings<ListModelEvaluationsRequest,ListModelEvaluationsResponse,ModelServiceClient.ListModelEvaluationsPagedResponse> listModelEvaluationsSettings()

Returns the object with the settings used for calls to listModelEvaluations.

Returns
Type	Description
PagedCallSettings<ListModelEvaluationsRequest,ListModelEvaluationsResponse,ListModelEvaluationsPagedResponse>

listModelVersionsSettings()

public PagedCallSettings<ListModelVersionsRequest,ListModelVersionsResponse,ModelServiceClient.ListModelVersionsPagedResponse> listModelVersionsSettings()

Returns the object with the settings used for calls to listModelVersions.

Returns
Type	Description
PagedCallSettings<ListModelVersionsRequest,ListModelVersionsResponse,ListModelVersionsPagedResponse>

listModelsSettings()

public PagedCallSettings<ListModelsRequest,ListModelsResponse,ModelServiceClient.ListModelsPagedResponse> listModelsSettings()

Returns the object with the settings used for calls to listModels.

Returns
Type	Description
PagedCallSettings<ListModelsRequest,ListModelsResponse,ListModelsPagedResponse>

mergeVersionAliasesSettings()

public UnaryCallSettings<MergeVersionAliasesRequest,Model> mergeVersionAliasesSettings()

Returns the object with the settings used for calls to mergeVersionAliases.

Returns
Type	Description
UnaryCallSettings<MergeVersionAliasesRequest,Model>

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

Returns the object with the settings used for calls to setIamPolicy.

Returns
Type	Description
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

Returns the object with the settings used for calls to testIamPermissions.

Returns
Type	Description
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

toBuilder()

public ModelServiceStubSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
Type	Description
ModelServiceStubSettings.Builder

Overrides

StubSettings<SettingsT>.toBuilder()

updateExplanationDatasetOperationSettings()

public OperationCallSettings<UpdateExplanationDatasetRequest,UpdateExplanationDatasetResponse,UpdateExplanationDatasetOperationMetadata> updateExplanationDatasetOperationSettings()

Returns the object with the settings used for calls to updateExplanationDataset.

Returns
Type	Description
OperationCallSettings<UpdateExplanationDatasetRequest,UpdateExplanationDatasetResponse,UpdateExplanationDatasetOperationMetadata>

updateExplanationDatasetSettings()

public UnaryCallSettings<UpdateExplanationDatasetRequest,Operation> updateExplanationDatasetSettings()

Returns the object with the settings used for calls to updateExplanationDataset.

Returns
Type	Description
UnaryCallSettings<UpdateExplanationDatasetRequest,Operation>

updateModelSettings()

public UnaryCallSettings<UpdateModelRequest,Model> updateModelSettings()

Returns the object with the settings used for calls to updateModel.

Returns
Type	Description
UnaryCallSettings<UpdateModelRequest,Model>

uploadModelOperationSettings()

public OperationCallSettings<UploadModelRequest,UploadModelResponse,UploadModelOperationMetadata> uploadModelOperationSettings()

Returns the object with the settings used for calls to uploadModel.

Returns
Type	Description
OperationCallSettings<UploadModelRequest,UploadModelResponse,UploadModelOperationMetadata>

uploadModelSettings()

public UnaryCallSettings<UploadModelRequest,Operation> uploadModelSettings()

Returns the object with the settings used for calls to uploadModel.

Returns
Type	Description
UnaryCallSettings<UploadModelRequest,Operation>