Class ModelServiceSettings (2.9.8)

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 (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:


 ModelServiceSettings.Builder modelServiceSettingsBuilder = ModelServiceSettings.newBuilder();
 modelServiceSettingsBuilder
     .getModelSettings()
     .setRetrySettings(
         modelServiceSettingsBuilder
             .getModelSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ModelServiceSettings modelServiceSettings = modelServiceSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > ModelServiceSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.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

create(ModelServiceStubSettings stub)

public static final ModelServiceSettings create(ModelServiceStubSettings stub)

Parameter

Name	Description
stub	`ModelServiceStubSettings`

Returns

Type	Description
ModelServiceSettings

Exceptions

Type	Description
IOException

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()

Returns the default 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 ModelServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

Type	Description
ModelServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static ModelServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	`ClientContext`

Returns

Type	Description
ModelServiceSettings.Builder

Constructors

ModelServiceSettings(ModelServiceSettings.Builder settingsBuilder)

protected ModelServiceSettings(ModelServiceSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	`ModelServiceSettings.Builder`

Methods

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>

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>

importModelEvaluationSettings()

public UnaryCallSettings<ImportModelEvaluationRequest,ModelEvaluation> importModelEvaluationSettings()

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

Returns

Type	Description
UnaryCallSettings<ImportModelEvaluationRequest,ModelEvaluation>

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>

toBuilder()

public ModelServiceSettings.Builder toBuilder()

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

Returns

Type	Description
ModelServiceSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

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>