com.google.cloud.aiplatform.v1

Class ModelServiceSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<ModelServiceSettings>

com.google.cloud.aiplatform.v1.ModelServiceSettings

@Generated(value="by gapic-generator-java")
public class ModelServiceSettings
extends com.google.api.gax.rpc.ClientSettings<ModelServiceSettings>

Settings class to configure an instance of ModelServiceClient.

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 total timeout of getModel 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
 ModelServiceSettings.Builder modelServiceSettingsBuilder = ModelServiceSettings.newBuilder();
 modelServiceSettingsBuilder
     .getModelSettings()
     .setRetrySettings(
         modelServiceSettingsBuilder
             .getModelSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ModelServiceSettings modelServiceSettings = modelServiceSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModelServiceSettings.Builder Builder for ModelServiceSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ModelServiceSettings(ModelServiceSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.UnaryCallSettings<BatchImportEvaluatedAnnotationsRequest,BatchImportEvaluatedAnnotationsResponse>	batchImportEvaluatedAnnotationsSettings() Returns the object with the settings used for calls to batchImportEvaluatedAnnotations.
com.google.api.gax.rpc.UnaryCallSettings<BatchImportModelEvaluationSlicesRequest,BatchImportModelEvaluationSlicesResponse>	batchImportModelEvaluationSlicesSettings() Returns the object with the settings used for calls to batchImportModelEvaluationSlices.
com.google.api.gax.rpc.OperationCallSettings<CopyModelRequest,CopyModelResponse,CopyModelOperationMetadata>	copyModelOperationSettings() Returns the object with the settings used for calls to copyModel.
com.google.api.gax.rpc.UnaryCallSettings<CopyModelRequest,com.google.longrunning.Operation>	copyModelSettings() Returns the object with the settings used for calls to copyModel.
static ModelServiceSettings	create(ModelServiceStubSettings 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 ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.OperationCallSettings<DeleteModelRequest,com.google.protobuf.Empty,DeleteOperationMetadata>	deleteModelOperationSettings() Returns the object with the settings used for calls to deleteModel.
com.google.api.gax.rpc.UnaryCallSettings<DeleteModelRequest,com.google.longrunning.Operation>	deleteModelSettings() Returns the object with the settings used for calls to deleteModel.
com.google.api.gax.rpc.OperationCallSettings<DeleteModelVersionRequest,com.google.protobuf.Empty,DeleteOperationMetadata>	deleteModelVersionOperationSettings() Returns the object with the settings used for calls to deleteModelVersion.
com.google.api.gax.rpc.UnaryCallSettings<DeleteModelVersionRequest,com.google.longrunning.Operation>	deleteModelVersionSettings() Returns the object with the settings used for calls to deleteModelVersion.
com.google.api.gax.rpc.OperationCallSettings<ExportModelRequest,ExportModelResponse,ExportModelOperationMetadata>	exportModelOperationSettings() Returns the object with the settings used for calls to exportModel.
com.google.api.gax.rpc.UnaryCallSettings<ExportModelRequest,com.google.longrunning.Operation>	exportModelSettings() Returns the object with the settings used for calls to exportModel.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>	getIamPolicySettings() Returns the object with the settings used for calls to getIamPolicy.
com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>	getLocationSettings() Returns the object with the settings used for calls to getLocation.
com.google.api.gax.rpc.UnaryCallSettings<GetModelEvaluationRequest,ModelEvaluation>	getModelEvaluationSettings() Returns the object with the settings used for calls to getModelEvaluation.
com.google.api.gax.rpc.UnaryCallSettings<GetModelEvaluationSliceRequest,ModelEvaluationSlice>	getModelEvaluationSliceSettings() Returns the object with the settings used for calls to getModelEvaluationSlice.
com.google.api.gax.rpc.UnaryCallSettings<GetModelRequest,Model>	getModelSettings() Returns the object with the settings used for calls to getModel.
com.google.api.gax.rpc.UnaryCallSettings<ImportModelEvaluationRequest,ModelEvaluation>	importModelEvaluationSettings() Returns the object with the settings used for calls to importModelEvaluation.
com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ModelServiceClient.ListLocationsPagedResponse>	listLocationsSettings() Returns the object with the settings used for calls to listLocations.
com.google.api.gax.rpc.PagedCallSettings<ListModelEvaluationSlicesRequest,ListModelEvaluationSlicesResponse,ModelServiceClient.ListModelEvaluationSlicesPagedResponse>	listModelEvaluationSlicesSettings() Returns the object with the settings used for calls to listModelEvaluationSlices.
com.google.api.gax.rpc.PagedCallSettings<ListModelEvaluationsRequest,ListModelEvaluationsResponse,ModelServiceClient.ListModelEvaluationsPagedResponse>	listModelEvaluationsSettings() Returns the object with the settings used for calls to listModelEvaluations.
com.google.api.gax.rpc.PagedCallSettings<ListModelsRequest,ListModelsResponse,ModelServiceClient.ListModelsPagedResponse>	listModelsSettings() Returns the object with the settings used for calls to listModels.
com.google.api.gax.rpc.PagedCallSettings<ListModelVersionsRequest,ListModelVersionsResponse,ModelServiceClient.ListModelVersionsPagedResponse>	listModelVersionsSettings() Returns the object with the settings used for calls to listModelVersions.
com.google.api.gax.rpc.UnaryCallSettings<MergeVersionAliasesRequest,Model>	mergeVersionAliasesSettings() Returns the object with the settings used for calls to mergeVersionAliases.
static ModelServiceSettings.Builder	newBuilder() Returns a new builder for this class.
static ModelServiceSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>	setIamPolicySettings() Returns the object with the settings used for calls to setIamPolicy.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissionsSettings() Returns the object with the settings used for calls to testIamPermissions.
ModelServiceSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.OperationCallSettings<UpdateExplanationDatasetRequest,UpdateExplanationDatasetResponse,UpdateExplanationDatasetOperationMetadata>	updateExplanationDatasetOperationSettings() Returns the object with the settings used for calls to updateExplanationDataset.
com.google.api.gax.rpc.UnaryCallSettings<UpdateExplanationDatasetRequest,com.google.longrunning.Operation>	updateExplanationDatasetSettings() Returns the object with the settings used for calls to updateExplanationDataset.
com.google.api.gax.rpc.UnaryCallSettings<UpdateModelRequest,Model>	updateModelSettings() Returns the object with the settings used for calls to updateModel.
com.google.api.gax.rpc.OperationCallSettings<UploadModelRequest,UploadModelResponse,UploadModelOperationMetadata>	uploadModelOperationSettings() Returns the object with the settings used for calls to uploadModel.
com.google.api.gax.rpc.UnaryCallSettings<UploadModelRequest,com.google.longrunning.Operation>	uploadModelSettings() Returns the object with the settings used for calls to uploadModel.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ModelServiceSettings

protected ModelServiceSettings(ModelServiceSettings.Builder settingsBuilder)
                        throws IOException

Throws:

IOException

Method Detail

uploadModelSettings

public com.google.api.gax.rpc.UnaryCallSettings<UploadModelRequest,com.google.longrunning.Operation> uploadModelSettings()

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

uploadModelOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UploadModelRequest,UploadModelResponse,UploadModelOperationMetadata> uploadModelOperationSettings()

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

getModelSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetModelRequest,Model> getModelSettings()

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

listModelsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListModelsRequest,ListModelsResponse,ModelServiceClient.ListModelsPagedResponse> listModelsSettings()

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

listModelVersionsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListModelVersionsRequest,ListModelVersionsResponse,ModelServiceClient.ListModelVersionsPagedResponse> listModelVersionsSettings()

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

updateModelSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateModelRequest,Model> updateModelSettings()

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

updateExplanationDatasetSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateExplanationDatasetRequest,com.google.longrunning.Operation> updateExplanationDatasetSettings()

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

updateExplanationDatasetOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateExplanationDatasetRequest,UpdateExplanationDatasetResponse,UpdateExplanationDatasetOperationMetadata> updateExplanationDatasetOperationSettings()

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

deleteModelSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteModelRequest,com.google.longrunning.Operation> deleteModelSettings()

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

deleteModelOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteModelRequest,com.google.protobuf.Empty,DeleteOperationMetadata> deleteModelOperationSettings()

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

deleteModelVersionSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteModelVersionRequest,com.google.longrunning.Operation> deleteModelVersionSettings()

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

deleteModelVersionOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteModelVersionRequest,com.google.protobuf.Empty,DeleteOperationMetadata> deleteModelVersionOperationSettings()

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

mergeVersionAliasesSettings

public com.google.api.gax.rpc.UnaryCallSettings<MergeVersionAliasesRequest,Model> mergeVersionAliasesSettings()

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

exportModelSettings

public com.google.api.gax.rpc.UnaryCallSettings<ExportModelRequest,com.google.longrunning.Operation> exportModelSettings()

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

exportModelOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<ExportModelRequest,ExportModelResponse,ExportModelOperationMetadata> exportModelOperationSettings()

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

copyModelSettings

public com.google.api.gax.rpc.UnaryCallSettings<CopyModelRequest,com.google.longrunning.Operation> copyModelSettings()

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

copyModelOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CopyModelRequest,CopyModelResponse,CopyModelOperationMetadata> copyModelOperationSettings()

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

importModelEvaluationSettings

public com.google.api.gax.rpc.UnaryCallSettings<ImportModelEvaluationRequest,ModelEvaluation> importModelEvaluationSettings()

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

batchImportModelEvaluationSlicesSettings

public com.google.api.gax.rpc.UnaryCallSettings<BatchImportModelEvaluationSlicesRequest,BatchImportModelEvaluationSlicesResponse> batchImportModelEvaluationSlicesSettings()

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

batchImportEvaluatedAnnotationsSettings

public com.google.api.gax.rpc.UnaryCallSettings<BatchImportEvaluatedAnnotationsRequest,BatchImportEvaluatedAnnotationsResponse> batchImportEvaluatedAnnotationsSettings()

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

getModelEvaluationSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetModelEvaluationRequest,ModelEvaluation> getModelEvaluationSettings()

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

listModelEvaluationsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListModelEvaluationsRequest,ListModelEvaluationsResponse,ModelServiceClient.ListModelEvaluationsPagedResponse> listModelEvaluationsSettings()

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

getModelEvaluationSliceSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetModelEvaluationSliceRequest,ModelEvaluationSlice> getModelEvaluationSliceSettings()

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

listModelEvaluationSlicesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListModelEvaluationSlicesRequest,ListModelEvaluationSlicesResponse,ModelServiceClient.ListModelEvaluationSlicesPagedResponse> listModelEvaluationSlicesSettings()

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

listLocationsSettings

public com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ModelServiceClient.ListLocationsPagedResponse> listLocationsSettings()

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

getLocationSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> getLocationSettings()

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

setIamPolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicySettings()

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

getIamPolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicySettings()

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

testIamPermissionsSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsSettings()

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

create

public static final ModelServiceSettings create(ModelServiceStubSettings 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 ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="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 ModelServiceSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static ModelServiceSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public ModelServiceSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<ModelServiceSettings>