Class JobServiceStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<JobServiceStubSettings>
com.google.cloud.aiplatform.v1beta1.stub.JobServiceStubSettings
@BetaApi
@Generated("by gapic-generator-java")
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 [RetrySettings](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.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
JobServiceStubSettings.Builder jobServiceSettingsBuilder = JobServiceStubSettings.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());
JobServiceStubSettings jobServiceSettings = jobServiceSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) 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
JobServiceStubSettings.Builder jobServiceSettingsBuilder = JobServiceStubSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
jobServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for JobServiceStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedJobServiceStubSettings(JobServiceStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionUnaryCallSettings<CancelBatchPredictionJobRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to cancelBatchPredictionJob.UnaryCallSettings<CancelCustomJobRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to cancelCustomJob.UnaryCallSettings<CancelDataLabelingJobRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to cancelDataLabelingJob.UnaryCallSettings<CancelHyperparameterTuningJobRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to cancelHyperparameterTuningJob.UnaryCallSettings<CancelNasJobRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to cancelNasJob.Returns the object with the settings used for calls to createBatchPredictionJob.Returns the object with the settings used for calls to createCustomJob.Returns the object with the settings used for calls to createDataLabelingJob.Returns the object with the settings used for calls to createHyperparameterTuningJob.Returns the object with the settings used for calls to createModelDeploymentMonitoringJob.Returns the object with the settings used for calls to createNasJob.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default ChannelProvider for this service.static TransportChannelProviderOperationCallSettings<DeleteBatchPredictionJobRequest,com.google.protobuf.Empty, DeleteOperationMetadata> Returns the object with the settings used for calls to deleteBatchPredictionJob.Returns the object with the settings used for calls to deleteBatchPredictionJob.OperationCallSettings<DeleteCustomJobRequest,com.google.protobuf.Empty, DeleteOperationMetadata> Returns the object with the settings used for calls to deleteCustomJob.Returns the object with the settings used for calls to deleteCustomJob.OperationCallSettings<DeleteDataLabelingJobRequest,com.google.protobuf.Empty, DeleteOperationMetadata> Returns the object with the settings used for calls to deleteDataLabelingJob.Returns the object with the settings used for calls to deleteDataLabelingJob.OperationCallSettings<DeleteHyperparameterTuningJobRequest,com.google.protobuf.Empty, DeleteOperationMetadata> Returns the object with the settings used for calls to deleteHyperparameterTuningJob.Returns the object with the settings used for calls to deleteHyperparameterTuningJob.OperationCallSettings<DeleteModelDeploymentMonitoringJobRequest,com.google.protobuf.Empty, DeleteOperationMetadata> Returns the object with the settings used for calls to deleteModelDeploymentMonitoringJob.Returns the object with the settings used for calls to deleteModelDeploymentMonitoringJob.OperationCallSettings<DeleteNasJobRequest,com.google.protobuf.Empty, DeleteOperationMetadata> Returns the object with the settings used for calls to deleteNasJob.Returns the object with the settings used for calls to deleteNasJob.Returns the object with the settings used for calls to getBatchPredictionJob.Returns the object with the settings used for calls to getCustomJob.Returns the object with the settings used for calls to getDataLabelingJob.static StringReturns the default service endpoint.static StringReturns the default mTLS service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getHyperparameterTuningJob.Returns the object with the settings used for calls to getIamPolicy.protected LibraryMetadataReturns the object with the settings used for calls to getLocation.Returns the object with the settings used for calls to getModelDeploymentMonitoringJob.Returns the object with the settings used for calls to getNasJob.Returns the object with the settings used for calls to getNasTrialDetail.Returns the default service name.PagedCallSettings<ListBatchPredictionJobsRequest,ListBatchPredictionJobsResponse, JobServiceClient.ListBatchPredictionJobsPagedResponse> Returns the object with the settings used for calls to listBatchPredictionJobs.PagedCallSettings<ListCustomJobsRequest,ListCustomJobsResponse, JobServiceClient.ListCustomJobsPagedResponse> Returns the object with the settings used for calls to listCustomJobs.PagedCallSettings<ListDataLabelingJobsRequest,ListDataLabelingJobsResponse, JobServiceClient.ListDataLabelingJobsPagedResponse> Returns the object with the settings used for calls to listDataLabelingJobs.PagedCallSettings<ListHyperparameterTuningJobsRequest,ListHyperparameterTuningJobsResponse, JobServiceClient.ListHyperparameterTuningJobsPagedResponse> Returns the object with the settings used for calls to listHyperparameterTuningJobs.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, JobServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.PagedCallSettings<ListModelDeploymentMonitoringJobsRequest,ListModelDeploymentMonitoringJobsResponse, JobServiceClient.ListModelDeploymentMonitoringJobsPagedResponse> Returns the object with the settings used for calls to listModelDeploymentMonitoringJobs.Returns the object with the settings used for calls to listNasJobs.PagedCallSettings<ListNasTrialDetailsRequest,ListNasTrialDetailsResponse, JobServiceClient.ListNasTrialDetailsPagedResponse> Returns the object with the settings used for calls to listNasTrialDetails.Returns a new builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.UnaryCallSettings<PauseModelDeploymentMonitoringJobRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to pauseModelDeploymentMonitoringJob.UnaryCallSettings<ResumeModelDeploymentMonitoringJobRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to resumeModelDeploymentMonitoringJob.PagedCallSettings<SearchModelDeploymentMonitoringStatsAnomaliesRequest,SearchModelDeploymentMonitoringStatsAnomaliesResponse, JobServiceClient.SearchModelDeploymentMonitoringStatsAnomaliesPagedResponse> Returns the object with the settings used for calls to searchModelDeploymentMonitoringStatsAnomalies.Returns the object with the settings used for calls to setIamPolicy.Returns the object with the settings used for calls to testIamPermissions.Returns a builder containing all the values of this settings class.OperationCallSettings<UpdateModelDeploymentMonitoringJobRequest,ModelDeploymentMonitoringJob, UpdateModelDeploymentMonitoringJobOperationMetadata> Returns the object with the settings used for calls to updateModelDeploymentMonitoringJob.Returns the object with the settings used for calls to updateModelDeploymentMonitoringJob.Methods inherited from class com.google.api.gax.rpc.StubSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogCheckIntervalDuration, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toString
-
Constructor Details
-
JobServiceStubSettings
- Throws:
IOException
-
-
Method Details
-
createCustomJobSettings
Returns the object with the settings used for calls to createCustomJob. -
getCustomJobSettings
Returns the object with the settings used for calls to getCustomJob. -
listCustomJobsSettings
public PagedCallSettings<ListCustomJobsRequest,ListCustomJobsResponse, listCustomJobsSettings()JobServiceClient.ListCustomJobsPagedResponse> Returns the object with the settings used for calls to listCustomJobs. -
deleteCustomJobSettings
Returns the object with the settings used for calls to deleteCustomJob. -
deleteCustomJobOperationSettings
public OperationCallSettings<DeleteCustomJobRequest,com.google.protobuf.Empty, deleteCustomJobOperationSettings()DeleteOperationMetadata> Returns the object with the settings used for calls to deleteCustomJob. -
cancelCustomJobSettings
public UnaryCallSettings<CancelCustomJobRequest,com.google.protobuf.Empty> cancelCustomJobSettings()Returns the object with the settings used for calls to cancelCustomJob. -
createDataLabelingJobSettings
public UnaryCallSettings<CreateDataLabelingJobRequest,DataLabelingJob> createDataLabelingJobSettings()Returns the object with the settings used for calls to createDataLabelingJob. -
getDataLabelingJobSettings
Returns the object with the settings used for calls to getDataLabelingJob. -
listDataLabelingJobsSettings
public PagedCallSettings<ListDataLabelingJobsRequest,ListDataLabelingJobsResponse, listDataLabelingJobsSettings()JobServiceClient.ListDataLabelingJobsPagedResponse> Returns the object with the settings used for calls to listDataLabelingJobs. -
deleteDataLabelingJobSettings
Returns the object with the settings used for calls to deleteDataLabelingJob. -
deleteDataLabelingJobOperationSettings
public OperationCallSettings<DeleteDataLabelingJobRequest,com.google.protobuf.Empty, deleteDataLabelingJobOperationSettings()DeleteOperationMetadata> Returns the object with the settings used for calls to deleteDataLabelingJob. -
cancelDataLabelingJobSettings
public UnaryCallSettings<CancelDataLabelingJobRequest,com.google.protobuf.Empty> cancelDataLabelingJobSettings()Returns the object with the settings used for calls to cancelDataLabelingJob. -
createHyperparameterTuningJobSettings
public UnaryCallSettings<CreateHyperparameterTuningJobRequest,HyperparameterTuningJob> createHyperparameterTuningJobSettings()Returns the object with the settings used for calls to createHyperparameterTuningJob. -
getHyperparameterTuningJobSettings
public UnaryCallSettings<GetHyperparameterTuningJobRequest,HyperparameterTuningJob> getHyperparameterTuningJobSettings()Returns the object with the settings used for calls to getHyperparameterTuningJob. -
listHyperparameterTuningJobsSettings
public PagedCallSettings<ListHyperparameterTuningJobsRequest,ListHyperparameterTuningJobsResponse, listHyperparameterTuningJobsSettings()JobServiceClient.ListHyperparameterTuningJobsPagedResponse> Returns the object with the settings used for calls to listHyperparameterTuningJobs. -
deleteHyperparameterTuningJobSettings
public UnaryCallSettings<DeleteHyperparameterTuningJobRequest,Operation> deleteHyperparameterTuningJobSettings()Returns the object with the settings used for calls to deleteHyperparameterTuningJob. -
deleteHyperparameterTuningJobOperationSettings
public OperationCallSettings<DeleteHyperparameterTuningJobRequest,com.google.protobuf.Empty, deleteHyperparameterTuningJobOperationSettings()DeleteOperationMetadata> Returns the object with the settings used for calls to deleteHyperparameterTuningJob. -
cancelHyperparameterTuningJobSettings
public UnaryCallSettings<CancelHyperparameterTuningJobRequest,com.google.protobuf.Empty> cancelHyperparameterTuningJobSettings()Returns the object with the settings used for calls to cancelHyperparameterTuningJob. -
createNasJobSettings
Returns the object with the settings used for calls to createNasJob. -
getNasJobSettings
Returns the object with the settings used for calls to getNasJob. -
listNasJobsSettings
public PagedCallSettings<ListNasJobsRequest,ListNasJobsResponse, listNasJobsSettings()JobServiceClient.ListNasJobsPagedResponse> Returns the object with the settings used for calls to listNasJobs. -
deleteNasJobSettings
Returns the object with the settings used for calls to deleteNasJob. -
deleteNasJobOperationSettings
public OperationCallSettings<DeleteNasJobRequest,com.google.protobuf.Empty, deleteNasJobOperationSettings()DeleteOperationMetadata> Returns the object with the settings used for calls to deleteNasJob. -
cancelNasJobSettings
Returns the object with the settings used for calls to cancelNasJob. -
getNasTrialDetailSettings
Returns the object with the settings used for calls to getNasTrialDetail. -
listNasTrialDetailsSettings
public PagedCallSettings<ListNasTrialDetailsRequest,ListNasTrialDetailsResponse, listNasTrialDetailsSettings()JobServiceClient.ListNasTrialDetailsPagedResponse> Returns the object with the settings used for calls to listNasTrialDetails. -
createBatchPredictionJobSettings
public UnaryCallSettings<CreateBatchPredictionJobRequest,BatchPredictionJob> createBatchPredictionJobSettings()Returns the object with the settings used for calls to createBatchPredictionJob. -
getBatchPredictionJobSettings
public UnaryCallSettings<GetBatchPredictionJobRequest,BatchPredictionJob> getBatchPredictionJobSettings()Returns the object with the settings used for calls to getBatchPredictionJob. -
listBatchPredictionJobsSettings
public PagedCallSettings<ListBatchPredictionJobsRequest,ListBatchPredictionJobsResponse, listBatchPredictionJobsSettings()JobServiceClient.ListBatchPredictionJobsPagedResponse> Returns the object with the settings used for calls to listBatchPredictionJobs. -
deleteBatchPredictionJobSettings
public UnaryCallSettings<DeleteBatchPredictionJobRequest,Operation> deleteBatchPredictionJobSettings()Returns the object with the settings used for calls to deleteBatchPredictionJob. -
deleteBatchPredictionJobOperationSettings
public OperationCallSettings<DeleteBatchPredictionJobRequest,com.google.protobuf.Empty, deleteBatchPredictionJobOperationSettings()DeleteOperationMetadata> Returns the object with the settings used for calls to deleteBatchPredictionJob. -
cancelBatchPredictionJobSettings
public UnaryCallSettings<CancelBatchPredictionJobRequest,com.google.protobuf.Empty> cancelBatchPredictionJobSettings()Returns the object with the settings used for calls to cancelBatchPredictionJob. -
createModelDeploymentMonitoringJobSettings
public UnaryCallSettings<CreateModelDeploymentMonitoringJobRequest,ModelDeploymentMonitoringJob> createModelDeploymentMonitoringJobSettings()Returns the object with the settings used for calls to createModelDeploymentMonitoringJob. -
searchModelDeploymentMonitoringStatsAnomaliesSettings
public PagedCallSettings<SearchModelDeploymentMonitoringStatsAnomaliesRequest,SearchModelDeploymentMonitoringStatsAnomaliesResponse, searchModelDeploymentMonitoringStatsAnomaliesSettings()JobServiceClient.SearchModelDeploymentMonitoringStatsAnomaliesPagedResponse> Returns the object with the settings used for calls to searchModelDeploymentMonitoringStatsAnomalies. -
getModelDeploymentMonitoringJobSettings
public UnaryCallSettings<GetModelDeploymentMonitoringJobRequest,ModelDeploymentMonitoringJob> getModelDeploymentMonitoringJobSettings()Returns the object with the settings used for calls to getModelDeploymentMonitoringJob. -
listModelDeploymentMonitoringJobsSettings
public PagedCallSettings<ListModelDeploymentMonitoringJobsRequest,ListModelDeploymentMonitoringJobsResponse, listModelDeploymentMonitoringJobsSettings()JobServiceClient.ListModelDeploymentMonitoringJobsPagedResponse> Returns the object with the settings used for calls to listModelDeploymentMonitoringJobs. -
updateModelDeploymentMonitoringJobSettings
public UnaryCallSettings<UpdateModelDeploymentMonitoringJobRequest,Operation> updateModelDeploymentMonitoringJobSettings()Returns the object with the settings used for calls to updateModelDeploymentMonitoringJob. -
updateModelDeploymentMonitoringJobOperationSettings
public OperationCallSettings<UpdateModelDeploymentMonitoringJobRequest,ModelDeploymentMonitoringJob, updateModelDeploymentMonitoringJobOperationSettings()UpdateModelDeploymentMonitoringJobOperationMetadata> Returns the object with the settings used for calls to updateModelDeploymentMonitoringJob. -
deleteModelDeploymentMonitoringJobSettings
public UnaryCallSettings<DeleteModelDeploymentMonitoringJobRequest,Operation> deleteModelDeploymentMonitoringJobSettings()Returns the object with the settings used for calls to deleteModelDeploymentMonitoringJob. -
deleteModelDeploymentMonitoringJobOperationSettings
public OperationCallSettings<DeleteModelDeploymentMonitoringJobRequest,com.google.protobuf.Empty, deleteModelDeploymentMonitoringJobOperationSettings()DeleteOperationMetadata> Returns the object with the settings used for calls to deleteModelDeploymentMonitoringJob. -
pauseModelDeploymentMonitoringJobSettings
public UnaryCallSettings<PauseModelDeploymentMonitoringJobRequest,com.google.protobuf.Empty> pauseModelDeploymentMonitoringJobSettings()Returns the object with the settings used for calls to pauseModelDeploymentMonitoringJob. -
resumeModelDeploymentMonitoringJobSettings
public UnaryCallSettings<ResumeModelDeploymentMonitoringJobRequest,com.google.protobuf.Empty> resumeModelDeploymentMonitoringJobSettings()Returns the object with the settings used for calls to resumeModelDeploymentMonitoringJob. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()JobServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
setIamPolicySettings
Returns the object with the settings used for calls to setIamPolicy. -
getIamPolicySettings
Returns the object with the settings used for calls to getIamPolicy. -
testIamPermissionsSettings
public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()Returns the object with the settings used for calls to testIamPermissions. -
createStub
- Throws:
IOException
-
getServiceName
Returns the default service name.- Overrides:
getServiceNamein classStubSettings<JobServiceStubSettings>
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultMtlsEndpoint
Returns the default mTLS service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classStubSettings<JobServiceStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<JobServiceStubSettings>
-