- 3.52.0 (latest)
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public class JobServiceSettings extends ClientSettings<JobServiceSettings>
Settings class to configure an instance of JobServiceClient.
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 RetrySettings of createCustomJob:
// 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
JobServiceSettings.Builder jobServiceSettingsBuilder = JobServiceSettings.newBuilder();
jobServiceSettingsBuilder
.createCustomJobSettings()
.setRetrySettings(
jobServiceSettingsBuilder
.createCustomJobSettings()
.getRetrySettings()
.toBuilder()
.setInitialRetryDelayDuration(Duration.ofSeconds(1))
.setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
.setMaxAttempts(5)
.setMaxRetryDelayDuration(Duration.ofSeconds(30))
.setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
.setRetryDelayMultiplier(1.3)
.setRpcTimeoutMultiplier(1.5)
.setTotalTimeoutDuration(Duration.ofSeconds(300))
.build());
JobServiceSettings jobServiceSettings = jobServiceSettingsBuilder.build();
Please refer to the Client Side Retry Guide for additional support in setting retries.
To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for deleteCustomJob:
// 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
JobServiceSettings.Builder jobServiceSettingsBuilder = JobServiceSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelay(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
jobServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
Static Methods
create(JobServiceStubSettings stub)
public static final JobServiceSettings create(JobServiceStubSettings stub)
Parameter | |
---|---|
Name | Description |
stub |
JobServiceStubSettings |
Returns | |
---|---|
Type | Description |
JobServiceSettings |
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 JobServiceSettings.Builder newBuilder()
Returns a new builder for this class.
Returns | |
---|---|
Type | Description |
JobServiceSettings.Builder |
newBuilder(ClientContext clientContext)
public static JobServiceSettings.Builder newBuilder(ClientContext clientContext)
Returns a new builder for this class.
Parameter | |
---|---|
Name | Description |
clientContext |
ClientContext |
Returns | |
---|---|
Type | Description |
JobServiceSettings.Builder |
Constructors
JobServiceSettings(JobServiceSettings.Builder settingsBuilder)
protected JobServiceSettings(JobServiceSettings.Builder settingsBuilder)
Parameter | |
---|---|
Name | Description |
settingsBuilder |
JobServiceSettings.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> |
cancelNasJobSettings()
public UnaryCallSettings<CancelNasJobRequest,Empty> cancelNasJobSettings()
Returns the object with the settings used for calls to cancelNasJob.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<CancelNasJobRequest,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> |
createNasJobSettings()
public UnaryCallSettings<CreateNasJobRequest,NasJob> createNasJobSettings()
Returns the object with the settings used for calls to createNasJob.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<CreateNasJobRequest,NasJob> |
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> |
deleteNasJobOperationSettings()
public OperationCallSettings<DeleteNasJobRequest,Empty,DeleteOperationMetadata> deleteNasJobOperationSettings()
Returns the object with the settings used for calls to deleteNasJob.
Returns | |
---|---|
Type | Description |
OperationCallSettings<DeleteNasJobRequest,Empty,DeleteOperationMetadata> |
deleteNasJobSettings()
public UnaryCallSettings<DeleteNasJobRequest,Operation> deleteNasJobSettings()
Returns the object with the settings used for calls to deleteNasJob.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<DeleteNasJobRequest,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> |
getIamPolicySettings()
public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()
Returns the object with the settings used for calls to getIamPolicy.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> |
getLocationSettings()
public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()
Returns the object with the settings used for calls to getLocation.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
getModelDeploymentMonitoringJobSettings()
public UnaryCallSettings<GetModelDeploymentMonitoringJobRequest,ModelDeploymentMonitoringJob> getModelDeploymentMonitoringJobSettings()
Returns the object with the settings used for calls to getModelDeploymentMonitoringJob.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<GetModelDeploymentMonitoringJobRequest,ModelDeploymentMonitoringJob> |
getNasJobSettings()
public UnaryCallSettings<GetNasJobRequest,NasJob> getNasJobSettings()
Returns the object with the settings used for calls to getNasJob.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<GetNasJobRequest,NasJob> |
getNasTrialDetailSettings()
public UnaryCallSettings<GetNasTrialDetailRequest,NasTrialDetail> getNasTrialDetailSettings()
Returns the object with the settings used for calls to getNasTrialDetail.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<GetNasTrialDetailRequest,NasTrialDetail> |
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> |
listLocationsSettings()
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,JobServiceClient.ListLocationsPagedResponse> listLocationsSettings()
Returns the object with the settings used for calls to listLocations.
Returns | |
---|---|
Type | Description |
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse> |
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> |
listNasJobsSettings()
public PagedCallSettings<ListNasJobsRequest,ListNasJobsResponse,JobServiceClient.ListNasJobsPagedResponse> listNasJobsSettings()
Returns the object with the settings used for calls to listNasJobs.
Returns | |
---|---|
Type | Description |
PagedCallSettings<ListNasJobsRequest,ListNasJobsResponse,ListNasJobsPagedResponse> |
listNasTrialDetailsSettings()
public PagedCallSettings<ListNasTrialDetailsRequest,ListNasTrialDetailsResponse,JobServiceClient.ListNasTrialDetailsPagedResponse> listNasTrialDetailsSettings()
Returns the object with the settings used for calls to listNasTrialDetails.
Returns | |
---|---|
Type | Description |
PagedCallSettings<ListNasTrialDetailsRequest,ListNasTrialDetailsResponse,ListNasTrialDetailsPagedResponse> |
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.
setIamPolicySettings()
public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()
Returns the object with the settings used for calls to setIamPolicy.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> |
testIamPermissionsSettings()
public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()
Returns the object with the settings used for calls to testIamPermissions.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> |
toBuilder()
public JobServiceSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.
Returns | |
---|---|
Type | Description |
JobServiceSettings.Builder |
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> |