Class ModelServiceSettings (2.5.3)

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

Constructors

ModelServiceSettings(ModelServiceSettings.Builder settingsBuilder)

protected ModelServiceSettings(ModelServiceSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderModelServiceSettings.Builder

Methods

create(ModelServiceStubSettings stub)

public static final ModelServiceSettings create(ModelServiceStubSettings stub)
Parameter
NameDescription
stubModelServiceStubSettings
Returns
TypeDescription
ModelServiceSettings
Exceptions
TypeDescription
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

deleteModelOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteModelRequest,Empty,DeleteOperationMetadata>

deleteModelSettings()

public UnaryCallSettings<DeleteModelRequest,Operation> deleteModelSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteModelRequest,Operation>

exportModelOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<ExportModelRequest,ExportModelResponse,ExportModelOperationMetadata>

exportModelSettings()

public UnaryCallSettings<ExportModelRequest,Operation> exportModelSettings()

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

Returns
TypeDescription
UnaryCallSettings<ExportModelRequest,Operation>

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

getModelEvaluationSettings()

public UnaryCallSettings<GetModelEvaluationRequest,ModelEvaluation> getModelEvaluationSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetModelEvaluationRequest,ModelEvaluation>

getModelEvaluationSliceSettings()

public UnaryCallSettings<GetModelEvaluationSliceRequest,ModelEvaluationSlice> getModelEvaluationSliceSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetModelEvaluationSliceRequest,ModelEvaluationSlice>

getModelSettings()

public UnaryCallSettings<GetModelRequest,Model> getModelSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetModelRequest,Model>

listModelEvaluationSlicesSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListModelEvaluationSlicesRequest,ListModelEvaluationSlicesResponse,ListModelEvaluationSlicesPagedResponse>

listModelEvaluationsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListModelEvaluationsRequest,ListModelEvaluationsResponse,ListModelEvaluationsPagedResponse>

listModelsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListModelsRequest,ListModelsResponse,ListModelsPagedResponse>

newBuilder()

public static ModelServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
ModelServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static ModelServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
ModelServiceSettings.Builder

toBuilder()

public ModelServiceSettings.Builder toBuilder()

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

Returns
TypeDescription
ModelServiceSettings.Builder
Overrides

updateModelSettings()

public UnaryCallSettings<UpdateModelRequest,Model> updateModelSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateModelRequest,Model>

uploadModelOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UploadModelRequest,UploadModelResponse,UploadModelOperationMetadata>

uploadModelSettings()

public UnaryCallSettings<UploadModelRequest,Operation> uploadModelSettings()

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

Returns
TypeDescription
UnaryCallSettings<UploadModelRequest,Operation>