Class PipelineServiceSettings (3.56.0)

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

Inheritance

java.lang.Object > ClientSettings > PipelineServiceSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getApiKey()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getGdchApiAudience()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getUniverseDomain()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogCheckIntervalDuration()

ClientSettings.getWatchdogProvider()

ClientSettings.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

create(PipelineServiceStubSettings stub)

public static final PipelineServiceSettings create(PipelineServiceStubSettings stub)

Parameter
Name	Description
`stub`	`PipelineServiceStubSettings`

Returns
Type	Description
`PipelineServiceSettings`

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

Returns a new builder for this class.

Returns
Type	Description
`PipelineServiceSettings.Builder`

newBuilder(ClientContext clientContext)

public static PipelineServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
`clientContext`	`ClientContext`

Returns
Type	Description
`PipelineServiceSettings.Builder`

Constructors

PipelineServiceSettings(PipelineServiceSettings.Builder settingsBuilder)

protected PipelineServiceSettings(PipelineServiceSettings.Builder settingsBuilder)

Parameter
Name	Description
`settingsBuilder`	`PipelineServiceSettings.Builder`

Methods

batchCancelPipelineJobsOperationSettings()

public OperationCallSettings<BatchCancelPipelineJobsRequest,BatchCancelPipelineJobsResponse,BatchCancelPipelineJobsOperationMetadata> batchCancelPipelineJobsOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<BatchCancelPipelineJobsRequest,BatchCancelPipelineJobsResponse,BatchCancelPipelineJobsOperationMetadata>`

batchCancelPipelineJobsSettings()

public UnaryCallSettings<BatchCancelPipelineJobsRequest,Operation> batchCancelPipelineJobsSettings()

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

Returns
Type	Description
`UnaryCallSettings<BatchCancelPipelineJobsRequest,Operation>`

batchDeletePipelineJobsOperationSettings()

public OperationCallSettings<BatchDeletePipelineJobsRequest,BatchDeletePipelineJobsResponse,DeleteOperationMetadata> batchDeletePipelineJobsOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<BatchDeletePipelineJobsRequest,BatchDeletePipelineJobsResponse,DeleteOperationMetadata>`

batchDeletePipelineJobsSettings()

public UnaryCallSettings<BatchDeletePipelineJobsRequest,Operation> batchDeletePipelineJobsSettings()

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

Returns
Type	Description
`UnaryCallSettings<BatchDeletePipelineJobsRequest,Operation>`

cancelPipelineJobSettings()

public UnaryCallSettings<CancelPipelineJobRequest,Empty> cancelPipelineJobSettings()

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

Returns
Type	Description
`UnaryCallSettings<CancelPipelineJobRequest,Empty>`

cancelTrainingPipelineSettings()

public UnaryCallSettings<CancelTrainingPipelineRequest,Empty> cancelTrainingPipelineSettings()

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

Returns
Type	Description
`UnaryCallSettings<CancelTrainingPipelineRequest,Empty>`

createPipelineJobSettings()

public UnaryCallSettings<CreatePipelineJobRequest,PipelineJob> createPipelineJobSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreatePipelineJobRequest,PipelineJob>`

createTrainingPipelineSettings()

public UnaryCallSettings<CreateTrainingPipelineRequest,TrainingPipeline> createTrainingPipelineSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateTrainingPipelineRequest,TrainingPipeline>`

deletePipelineJobOperationSettings()

public OperationCallSettings<DeletePipelineJobRequest,Empty,DeleteOperationMetadata> deletePipelineJobOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<DeletePipelineJobRequest,Empty,DeleteOperationMetadata>`

deletePipelineJobSettings()

public UnaryCallSettings<DeletePipelineJobRequest,Operation> deletePipelineJobSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeletePipelineJobRequest,Operation>`

deleteTrainingPipelineOperationSettings()

public OperationCallSettings<DeleteTrainingPipelineRequest,Empty,DeleteOperationMetadata> deleteTrainingPipelineOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<DeleteTrainingPipelineRequest,Empty,DeleteOperationMetadata>`

deleteTrainingPipelineSettings()

public UnaryCallSettings<DeleteTrainingPipelineRequest,Operation> deleteTrainingPipelineSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteTrainingPipelineRequest,Operation>`

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>`

getPipelineJobSettings()

public UnaryCallSettings<GetPipelineJobRequest,PipelineJob> getPipelineJobSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetPipelineJobRequest,PipelineJob>`

getTrainingPipelineSettings()

public UnaryCallSettings<GetTrainingPipelineRequest,TrainingPipeline> getTrainingPipelineSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetTrainingPipelineRequest,TrainingPipeline>`

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,PipelineServiceClient.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>`

listPipelineJobsSettings()

public PagedCallSettings<ListPipelineJobsRequest,ListPipelineJobsResponse,PipelineServiceClient.ListPipelineJobsPagedResponse> listPipelineJobsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListPipelineJobsRequest,ListPipelineJobsResponse,ListPipelineJobsPagedResponse>`

listTrainingPipelinesSettings()

public PagedCallSettings<ListTrainingPipelinesRequest,ListTrainingPipelinesResponse,PipelineServiceClient.ListTrainingPipelinesPagedResponse> listTrainingPipelinesSettings()

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

Returns
Type	Description
`PagedCallSettings<ListTrainingPipelinesRequest,ListTrainingPipelinesResponse,ListTrainingPipelinesPagedResponse>`

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 PipelineServiceSettings.Builder toBuilder()

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

Returns
Type	Description
`PipelineServiceSettings.Builder`

Overrides

ClientSettings<SettingsT>.<B>toBuilder()