Class JobServiceStubSettings (2.7.4)

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

Inherited Members

StubSettings.getBackgroundExecutorProvider()

StubSettings.getClock()

StubSettings.getCredentialsProvider()

StubSettings.getEndpoint()

StubSettings.getExecutorProvider()

StubSettings.getHeaderProvider()

StubSettings.getInternalHeaderProvider()

StubSettings.getMtlsEndpoint()

StubSettings.getQuotaProjectId()

StubSettings.getStreamWatchdogCheckInterval()

StubSettings.getStreamWatchdogProvider()

StubSettings.getTracerFactory()

StubSettings.getTransportChannelProvider()

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

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 JobServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

Type	Description
JobServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static JobServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	`ClientContext`

Returns

Type	Description
JobServiceStubSettings.Builder

Constructors

JobServiceStubSettings(JobServiceStubSettings.Builder settingsBuilder)

protected JobServiceStubSettings(JobServiceStubSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	`JobServiceStubSettings.Builder`

Methods

cancelBatchPredictionJobSettings()

public UnaryCallSettings<CancelBatchPredictionJobRequest,Empty> cancelBatchPredictionJobSettings()

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

Returns

Type	Description
UnaryCallSettings<CancelBatchPredictionJobRequest,Empty>

cancelCustomJobSettings()

public UnaryCallSettings<CancelCustomJobRequest,Empty> cancelCustomJobSettings()

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

Returns

Type	Description
UnaryCallSettings<CancelCustomJobRequest,Empty>

cancelDataLabelingJobSettings()

public UnaryCallSettings<CancelDataLabelingJobRequest,Empty> cancelDataLabelingJobSettings()

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

Returns

Type	Description
UnaryCallSettings<CancelDataLabelingJobRequest,Empty>

cancelHyperparameterTuningJobSettings()

public UnaryCallSettings<CancelHyperparameterTuningJobRequest,Empty> cancelHyperparameterTuningJobSettings()

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

Returns

Type	Description
UnaryCallSettings<CancelHyperparameterTuningJobRequest,Empty>

createBatchPredictionJobSettings()

public UnaryCallSettings<CreateBatchPredictionJobRequest,BatchPredictionJob> createBatchPredictionJobSettings()

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

Returns

Type	Description
UnaryCallSettings<CreateBatchPredictionJobRequest,BatchPredictionJob>

createCustomJobSettings()

public UnaryCallSettings<CreateCustomJobRequest,CustomJob> createCustomJobSettings()

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

Returns

Type	Description
UnaryCallSettings<CreateCustomJobRequest,CustomJob>

createDataLabelingJobSettings()

public UnaryCallSettings<CreateDataLabelingJobRequest,DataLabelingJob> createDataLabelingJobSettings()

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

Returns

Type	Description
UnaryCallSettings<CreateDataLabelingJobRequest,DataLabelingJob>

createHyperparameterTuningJobSettings()

public UnaryCallSettings<CreateHyperparameterTuningJobRequest,HyperparameterTuningJob> createHyperparameterTuningJobSettings()

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

Returns

Type	Description
UnaryCallSettings<CreateHyperparameterTuningJobRequest,HyperparameterTuningJob>

createModelDeploymentMonitoringJobSettings()

public UnaryCallSettings<CreateModelDeploymentMonitoringJobRequest,ModelDeploymentMonitoringJob> createModelDeploymentMonitoringJobSettings()

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

Returns

Type	Description
UnaryCallSettings<CreateModelDeploymentMonitoringJobRequest,ModelDeploymentMonitoringJob>

createStub()

public JobServiceStub createStub()

Returns

Type	Description
JobServiceStub

Exceptions

Type	Description
IOException

deleteBatchPredictionJobOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<DeleteBatchPredictionJobRequest,Empty,DeleteOperationMetadata>

deleteBatchPredictionJobSettings()

public UnaryCallSettings<DeleteBatchPredictionJobRequest,Operation> deleteBatchPredictionJobSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteBatchPredictionJobRequest,Operation>

deleteCustomJobOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<DeleteCustomJobRequest,Empty,DeleteOperationMetadata>

deleteCustomJobSettings()

public UnaryCallSettings<DeleteCustomJobRequest,Operation> deleteCustomJobSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteCustomJobRequest,Operation>

deleteDataLabelingJobOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<DeleteDataLabelingJobRequest,Empty,DeleteOperationMetadata>

deleteDataLabelingJobSettings()

public UnaryCallSettings<DeleteDataLabelingJobRequest,Operation> deleteDataLabelingJobSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteDataLabelingJobRequest,Operation>

deleteHyperparameterTuningJobOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<DeleteHyperparameterTuningJobRequest,Empty,DeleteOperationMetadata>

deleteHyperparameterTuningJobSettings()

public UnaryCallSettings<DeleteHyperparameterTuningJobRequest,Operation> deleteHyperparameterTuningJobSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteHyperparameterTuningJobRequest,Operation>

deleteModelDeploymentMonitoringJobOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<DeleteModelDeploymentMonitoringJobRequest,Empty,DeleteOperationMetadata>

deleteModelDeploymentMonitoringJobSettings()

public UnaryCallSettings<DeleteModelDeploymentMonitoringJobRequest,Operation> deleteModelDeploymentMonitoringJobSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteModelDeploymentMonitoringJobRequest,Operation>

getBatchPredictionJobSettings()

public UnaryCallSettings<GetBatchPredictionJobRequest,BatchPredictionJob> getBatchPredictionJobSettings()

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

Returns

Type	Description
UnaryCallSettings<GetBatchPredictionJobRequest,BatchPredictionJob>

getCustomJobSettings()

public UnaryCallSettings<GetCustomJobRequest,CustomJob> getCustomJobSettings()

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

Returns

Type	Description
UnaryCallSettings<GetCustomJobRequest,CustomJob>

getDataLabelingJobSettings()

public UnaryCallSettings<GetDataLabelingJobRequest,DataLabelingJob> getDataLabelingJobSettings()

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

Returns

Type	Description
UnaryCallSettings<GetDataLabelingJobRequest,DataLabelingJob>

getHyperparameterTuningJobSettings()

public UnaryCallSettings<GetHyperparameterTuningJobRequest,HyperparameterTuningJob> getHyperparameterTuningJobSettings()

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

Returns

Type	Description
UnaryCallSettings<GetHyperparameterTuningJobRequest,HyperparameterTuningJob>

getModelDeploymentMonitoringJobSettings()

public UnaryCallSettings<GetModelDeploymentMonitoringJobRequest,ModelDeploymentMonitoringJob> getModelDeploymentMonitoringJobSettings()

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

Returns

Type	Description
UnaryCallSettings<GetModelDeploymentMonitoringJobRequest,ModelDeploymentMonitoringJob>

listBatchPredictionJobsSettings()

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

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

Returns

Type	Description
PagedCallSettings<ListBatchPredictionJobsRequest,ListBatchPredictionJobsResponse,ListBatchPredictionJobsPagedResponse>

listCustomJobsSettings()

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

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

Returns

Type	Description
PagedCallSettings<ListCustomJobsRequest,ListCustomJobsResponse,ListCustomJobsPagedResponse>

listDataLabelingJobsSettings()

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

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

Returns

Type	Description
PagedCallSettings<ListDataLabelingJobsRequest,ListDataLabelingJobsResponse,ListDataLabelingJobsPagedResponse>

listHyperparameterTuningJobsSettings()

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

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

Returns

Type	Description
PagedCallSettings<ListHyperparameterTuningJobsRequest,ListHyperparameterTuningJobsResponse,ListHyperparameterTuningJobsPagedResponse>

listModelDeploymentMonitoringJobsSettings()

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

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

Returns

Type	Description
PagedCallSettings<ListModelDeploymentMonitoringJobsRequest,ListModelDeploymentMonitoringJobsResponse,ListModelDeploymentMonitoringJobsPagedResponse>

pauseModelDeploymentMonitoringJobSettings()

public UnaryCallSettings<PauseModelDeploymentMonitoringJobRequest,Empty> pauseModelDeploymentMonitoringJobSettings()

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

Returns

Type	Description
UnaryCallSettings<PauseModelDeploymentMonitoringJobRequest,Empty>

resumeModelDeploymentMonitoringJobSettings()

public UnaryCallSettings<ResumeModelDeploymentMonitoringJobRequest,Empty> resumeModelDeploymentMonitoringJobSettings()

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

Returns

Type	Description
UnaryCallSettings<ResumeModelDeploymentMonitoringJobRequest,Empty>

searchModelDeploymentMonitoringStatsAnomaliesSettings()

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

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

Returns

Type	Description
PagedCallSettings<SearchModelDeploymentMonitoringStatsAnomaliesRequest,SearchModelDeploymentMonitoringStatsAnomaliesResponse,SearchModelDeploymentMonitoringStatsAnomaliesPagedResponse>

toBuilder()

public JobServiceStubSettings.Builder toBuilder()

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

Returns

Type	Description
JobServiceStubSettings.Builder

Overrides

StubSettings<SettingsT>.toBuilder()

updateModelDeploymentMonitoringJobOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<UpdateModelDeploymentMonitoringJobRequest,ModelDeploymentMonitoringJob,UpdateModelDeploymentMonitoringJobOperationMetadata>

updateModelDeploymentMonitoringJobSettings()

public UnaryCallSettings<UpdateModelDeploymentMonitoringJobRequest,Operation> updateModelDeploymentMonitoringJobSettings()

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

Returns

Type	Description
UnaryCallSettings<UpdateModelDeploymentMonitoringJobRequest,Operation>