Class PipelineServiceSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<PipelineServiceSettings>
com.google.cloud.aiplatform.v1beta1.PipelineServiceSettings
@BetaApi
@Generated("by gapic-generator-java")
public class PipelineServiceSettings
extends ClientSettings<PipelineServiceSettings>
Settings class to configure an instance of
PipelineServiceClient.
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 createTrainingPipeline:
// 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
PipelineServiceSettings.Builder pipelineServiceSettingsBuilder =
PipelineServiceSettings.newBuilder();
pipelineServiceSettingsBuilder
.createTrainingPipelineSettings()
.setRetrySettings(
pipelineServiceSettingsBuilder
.createTrainingPipelineSettings()
.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());
PipelineServiceSettings pipelineServiceSettings = pipelineServiceSettingsBuilder.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 deleteTrainingPipeline:
// 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
PipelineServiceSettings.Builder pipelineServiceSettingsBuilder =
PipelineServiceSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
pipelineServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for PipelineServiceSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedPipelineServiceSettings(PipelineServiceSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionOperationCallSettings<BatchCancelPipelineJobsRequest,BatchCancelPipelineJobsResponse, BatchCancelPipelineJobsOperationMetadata> Returns the object with the settings used for calls to batchCancelPipelineJobs.Returns the object with the settings used for calls to batchCancelPipelineJobs.OperationCallSettings<BatchDeletePipelineJobsRequest,BatchDeletePipelineJobsResponse, DeleteOperationMetadata> Returns the object with the settings used for calls to batchDeletePipelineJobs.Returns the object with the settings used for calls to batchDeletePipelineJobs.UnaryCallSettings<CancelPipelineJobRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to cancelPipelineJob.UnaryCallSettings<CancelTrainingPipelineRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to cancelTrainingPipeline.static final PipelineServiceSettingsReturns the object with the settings used for calls to createPipelineJob.Returns the object with the settings used for calls to createTrainingPipeline.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<DeletePipelineJobRequest,com.google.protobuf.Empty, DeleteOperationMetadata> Returns the object with the settings used for calls to deletePipelineJob.Returns the object with the settings used for calls to deletePipelineJob.OperationCallSettings<DeleteTrainingPipelineRequest,com.google.protobuf.Empty, DeleteOperationMetadata> Returns the object with the settings used for calls to deleteTrainingPipeline.Returns the object with the settings used for calls to deleteTrainingPipeline.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getIamPolicy.Returns the object with the settings used for calls to getLocation.Returns the object with the settings used for calls to getPipelineJob.Returns the object with the settings used for calls to getTrainingPipeline.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, PipelineServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.PagedCallSettings<ListPipelineJobsRequest,ListPipelineJobsResponse, PipelineServiceClient.ListPipelineJobsPagedResponse> Returns the object with the settings used for calls to listPipelineJobs.PagedCallSettings<ListTrainingPipelinesRequest,ListTrainingPipelinesResponse, PipelineServiceClient.ListTrainingPipelinesPagedResponse> Returns the object with the settings used for calls to listTrainingPipelines.Returns a new builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.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.Methods inherited from class com.google.api.gax.rpc.ClientSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString
-
Constructor Details
-
PipelineServiceSettings
protected PipelineServiceSettings(PipelineServiceSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
createTrainingPipelineSettings
public UnaryCallSettings<CreateTrainingPipelineRequest,TrainingPipeline> createTrainingPipelineSettings()Returns the object with the settings used for calls to createTrainingPipeline. -
getTrainingPipelineSettings
Returns the object with the settings used for calls to getTrainingPipeline. -
listTrainingPipelinesSettings
public PagedCallSettings<ListTrainingPipelinesRequest,ListTrainingPipelinesResponse, listTrainingPipelinesSettings()PipelineServiceClient.ListTrainingPipelinesPagedResponse> Returns the object with the settings used for calls to listTrainingPipelines. -
deleteTrainingPipelineSettings
Returns the object with the settings used for calls to deleteTrainingPipeline. -
deleteTrainingPipelineOperationSettings
public OperationCallSettings<DeleteTrainingPipelineRequest,com.google.protobuf.Empty, deleteTrainingPipelineOperationSettings()DeleteOperationMetadata> Returns the object with the settings used for calls to deleteTrainingPipeline. -
cancelTrainingPipelineSettings
public UnaryCallSettings<CancelTrainingPipelineRequest,com.google.protobuf.Empty> cancelTrainingPipelineSettings()Returns the object with the settings used for calls to cancelTrainingPipeline. -
createPipelineJobSettings
Returns the object with the settings used for calls to createPipelineJob. -
getPipelineJobSettings
Returns the object with the settings used for calls to getPipelineJob. -
listPipelineJobsSettings
public PagedCallSettings<ListPipelineJobsRequest,ListPipelineJobsResponse, listPipelineJobsSettings()PipelineServiceClient.ListPipelineJobsPagedResponse> Returns the object with the settings used for calls to listPipelineJobs. -
deletePipelineJobSettings
Returns the object with the settings used for calls to deletePipelineJob. -
deletePipelineJobOperationSettings
public OperationCallSettings<DeletePipelineJobRequest,com.google.protobuf.Empty, deletePipelineJobOperationSettings()DeleteOperationMetadata> Returns the object with the settings used for calls to deletePipelineJob. -
batchDeletePipelineJobsSettings
public UnaryCallSettings<BatchDeletePipelineJobsRequest,Operation> batchDeletePipelineJobsSettings()Returns the object with the settings used for calls to batchDeletePipelineJobs. -
batchDeletePipelineJobsOperationSettings
public OperationCallSettings<BatchDeletePipelineJobsRequest,BatchDeletePipelineJobsResponse, batchDeletePipelineJobsOperationSettings()DeleteOperationMetadata> Returns the object with the settings used for calls to batchDeletePipelineJobs. -
cancelPipelineJobSettings
public UnaryCallSettings<CancelPipelineJobRequest,com.google.protobuf.Empty> cancelPipelineJobSettings()Returns the object with the settings used for calls to cancelPipelineJob. -
batchCancelPipelineJobsSettings
public UnaryCallSettings<BatchCancelPipelineJobsRequest,Operation> batchCancelPipelineJobsSettings()Returns the object with the settings used for calls to batchCancelPipelineJobs. -
batchCancelPipelineJobsOperationSettings
public OperationCallSettings<BatchCancelPipelineJobsRequest,BatchCancelPipelineJobsResponse, batchCancelPipelineJobsOperationSettings()BatchCancelPipelineJobsOperationMetadata> Returns the object with the settings used for calls to batchCancelPipelineJobs. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()PipelineServiceClient.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. -
create
public static final PipelineServiceSettings create(PipelineServiceStubSettings stub) throws IOException - Throws:
IOException
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default 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 classClientSettings<PipelineServiceSettings>
-