Class JobServiceStubSettings (2.9.5)

public class JobServiceStubSettings extends StubSettings<JobServiceStubSettings>

Settings class to configure an instance of JobServiceStub.

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 createCustomJob to 30 seconds:


 JobServiceStubSettings.Builder jobServiceSettingsBuilder = JobServiceStubSettings.newBuilder();
 jobServiceSettingsBuilder
     .createCustomJobSettings()
     .setRetrySettings(
         jobServiceSettingsBuilder
             .createCustomJobSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 JobServiceStubSettings jobServiceSettings = jobServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > StubSettings > JobServiceStubSettings

Static Methods

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

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static JobServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
JobServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static JobServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
JobServiceStubSettings.Builder

Constructors

JobServiceStubSettings(JobServiceStubSettings.Builder settingsBuilder)

protected JobServiceStubSettings(JobServiceStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderJobServiceStubSettings.Builder

Methods

cancelBatchPredictionJobSettings()

public UnaryCallSettings<CancelBatchPredictionJobRequest,Empty> cancelBatchPredictionJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<CancelBatchPredictionJobRequest,Empty>

cancelCustomJobSettings()

public UnaryCallSettings<CancelCustomJobRequest,Empty> cancelCustomJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<CancelCustomJobRequest,Empty>

cancelDataLabelingJobSettings()

public UnaryCallSettings<CancelDataLabelingJobRequest,Empty> cancelDataLabelingJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<CancelDataLabelingJobRequest,Empty>

cancelHyperparameterTuningJobSettings()

public UnaryCallSettings<CancelHyperparameterTuningJobRequest,Empty> cancelHyperparameterTuningJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<CancelHyperparameterTuningJobRequest,Empty>

createBatchPredictionJobSettings()

public UnaryCallSettings<CreateBatchPredictionJobRequest,BatchPredictionJob> createBatchPredictionJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateBatchPredictionJobRequest,BatchPredictionJob>

createCustomJobSettings()

public UnaryCallSettings<CreateCustomJobRequest,CustomJob> createCustomJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateCustomJobRequest,CustomJob>

createDataLabelingJobSettings()

public UnaryCallSettings<CreateDataLabelingJobRequest,DataLabelingJob> createDataLabelingJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateDataLabelingJobRequest,DataLabelingJob>

createHyperparameterTuningJobSettings()

public UnaryCallSettings<CreateHyperparameterTuningJobRequest,HyperparameterTuningJob> createHyperparameterTuningJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateHyperparameterTuningJobRequest,HyperparameterTuningJob>

createModelDeploymentMonitoringJobSettings()

public UnaryCallSettings<CreateModelDeploymentMonitoringJobRequest,ModelDeploymentMonitoringJob> createModelDeploymentMonitoringJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateModelDeploymentMonitoringJobRequest,ModelDeploymentMonitoringJob>

createStub()

public JobServiceStub createStub()
Returns
TypeDescription
JobServiceStub
Exceptions
TypeDescription
IOException

deleteBatchPredictionJobOperationSettings()

public OperationCallSettings<DeleteBatchPredictionJobRequest,Empty,DeleteOperationMetadata> deleteBatchPredictionJobOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<DeleteBatchPredictionJobRequest,Empty,DeleteOperationMetadata>

deleteBatchPredictionJobSettings()

public UnaryCallSettings<DeleteBatchPredictionJobRequest,Operation> deleteBatchPredictionJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteBatchPredictionJobRequest,Operation>

deleteCustomJobOperationSettings()

public OperationCallSettings<DeleteCustomJobRequest,Empty,DeleteOperationMetadata> deleteCustomJobOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<DeleteCustomJobRequest,Empty,DeleteOperationMetadata>

deleteCustomJobSettings()

public UnaryCallSettings<DeleteCustomJobRequest,Operation> deleteCustomJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteCustomJobRequest,Operation>

deleteDataLabelingJobOperationSettings()

public OperationCallSettings<DeleteDataLabelingJobRequest,Empty,DeleteOperationMetadata> deleteDataLabelingJobOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<DeleteDataLabelingJobRequest,Empty,DeleteOperationMetadata>

deleteDataLabelingJobSettings()

public UnaryCallSettings<DeleteDataLabelingJobRequest,Operation> deleteDataLabelingJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteDataLabelingJobRequest,Operation>

deleteHyperparameterTuningJobOperationSettings()

public OperationCallSettings<DeleteHyperparameterTuningJobRequest,Empty,DeleteOperationMetadata> deleteHyperparameterTuningJobOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<DeleteHyperparameterTuningJobRequest,Empty,DeleteOperationMetadata>

deleteHyperparameterTuningJobSettings()

public UnaryCallSettings<DeleteHyperparameterTuningJobRequest,Operation> deleteHyperparameterTuningJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteHyperparameterTuningJobRequest,Operation>

deleteModelDeploymentMonitoringJobOperationSettings()

public OperationCallSettings<DeleteModelDeploymentMonitoringJobRequest,Empty,DeleteOperationMetadata> deleteModelDeploymentMonitoringJobOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<DeleteModelDeploymentMonitoringJobRequest,Empty,DeleteOperationMetadata>

deleteModelDeploymentMonitoringJobSettings()

public UnaryCallSettings<DeleteModelDeploymentMonitoringJobRequest,Operation> deleteModelDeploymentMonitoringJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteModelDeploymentMonitoringJobRequest,Operation>

getBatchPredictionJobSettings()

public UnaryCallSettings<GetBatchPredictionJobRequest,BatchPredictionJob> getBatchPredictionJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetBatchPredictionJobRequest,BatchPredictionJob>

getCustomJobSettings()

public UnaryCallSettings<GetCustomJobRequest,CustomJob> getCustomJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetCustomJobRequest,CustomJob>

getDataLabelingJobSettings()

public UnaryCallSettings<GetDataLabelingJobRequest,DataLabelingJob> getDataLabelingJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetDataLabelingJobRequest,DataLabelingJob>

getHyperparameterTuningJobSettings()

public UnaryCallSettings<GetHyperparameterTuningJobRequest,HyperparameterTuningJob> getHyperparameterTuningJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetHyperparameterTuningJobRequest,HyperparameterTuningJob>

getModelDeploymentMonitoringJobSettings()

public UnaryCallSettings<GetModelDeploymentMonitoringJobRequest,ModelDeploymentMonitoringJob> getModelDeploymentMonitoringJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetModelDeploymentMonitoringJobRequest,ModelDeploymentMonitoringJob>

listBatchPredictionJobsSettings()

public PagedCallSettings<ListBatchPredictionJobsRequest,ListBatchPredictionJobsResponse,JobServiceClient.ListBatchPredictionJobsPagedResponse> listBatchPredictionJobsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListBatchPredictionJobsRequest,ListBatchPredictionJobsResponse,ListBatchPredictionJobsPagedResponse>

listCustomJobsSettings()

public PagedCallSettings<ListCustomJobsRequest,ListCustomJobsResponse,JobServiceClient.ListCustomJobsPagedResponse> listCustomJobsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListCustomJobsRequest,ListCustomJobsResponse,ListCustomJobsPagedResponse>

listDataLabelingJobsSettings()

public PagedCallSettings<ListDataLabelingJobsRequest,ListDataLabelingJobsResponse,JobServiceClient.ListDataLabelingJobsPagedResponse> listDataLabelingJobsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListDataLabelingJobsRequest,ListDataLabelingJobsResponse,ListDataLabelingJobsPagedResponse>

listHyperparameterTuningJobsSettings()

public PagedCallSettings<ListHyperparameterTuningJobsRequest,ListHyperparameterTuningJobsResponse,JobServiceClient.ListHyperparameterTuningJobsPagedResponse> listHyperparameterTuningJobsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListHyperparameterTuningJobsRequest,ListHyperparameterTuningJobsResponse,ListHyperparameterTuningJobsPagedResponse>

listModelDeploymentMonitoringJobsSettings()

public PagedCallSettings<ListModelDeploymentMonitoringJobsRequest,ListModelDeploymentMonitoringJobsResponse,JobServiceClient.ListModelDeploymentMonitoringJobsPagedResponse> listModelDeploymentMonitoringJobsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListModelDeploymentMonitoringJobsRequest,ListModelDeploymentMonitoringJobsResponse,ListModelDeploymentMonitoringJobsPagedResponse>

pauseModelDeploymentMonitoringJobSettings()

public UnaryCallSettings<PauseModelDeploymentMonitoringJobRequest,Empty> pauseModelDeploymentMonitoringJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<PauseModelDeploymentMonitoringJobRequest,Empty>

resumeModelDeploymentMonitoringJobSettings()

public UnaryCallSettings<ResumeModelDeploymentMonitoringJobRequest,Empty> resumeModelDeploymentMonitoringJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<ResumeModelDeploymentMonitoringJobRequest,Empty>

searchModelDeploymentMonitoringStatsAnomaliesSettings()

public PagedCallSettings<SearchModelDeploymentMonitoringStatsAnomaliesRequest,SearchModelDeploymentMonitoringStatsAnomaliesResponse,JobServiceClient.SearchModelDeploymentMonitoringStatsAnomaliesPagedResponse> searchModelDeploymentMonitoringStatsAnomaliesSettings()

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

Returns
TypeDescription
PagedCallSettings<SearchModelDeploymentMonitoringStatsAnomaliesRequest,SearchModelDeploymentMonitoringStatsAnomaliesResponse,SearchModelDeploymentMonitoringStatsAnomaliesPagedResponse>

toBuilder()

public JobServiceStubSettings.Builder toBuilder()

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

Returns
TypeDescription
JobServiceStubSettings.Builder
Overrides

updateModelDeploymentMonitoringJobOperationSettings()

public OperationCallSettings<UpdateModelDeploymentMonitoringJobRequest,ModelDeploymentMonitoringJob,UpdateModelDeploymentMonitoringJobOperationMetadata> updateModelDeploymentMonitoringJobOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<UpdateModelDeploymentMonitoringJobRequest,ModelDeploymentMonitoringJob,UpdateModelDeploymentMonitoringJobOperationMetadata>

updateModelDeploymentMonitoringJobSettings()

public UnaryCallSettings<UpdateModelDeploymentMonitoringJobRequest,Operation> updateModelDeploymentMonitoringJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateModelDeploymentMonitoringJobRequest,Operation>