Class PipelineServiceStubSettings (3.54.0)

Version 3.54.0

• 3.55.0 (latest)
• 3.54.0
• 3.53.0
• 3.52.0
• 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 PipelineServiceStubSettings extends StubSettings<PipelineServiceStubSettings>

Settings class to configure an instance of PipelineServiceStub.

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
 PipelineServiceStubSettings.Builder pipelineServiceSettingsBuilder =
     PipelineServiceStubSettings.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());
 PipelineServiceStubSettings 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
 PipelineServiceStubSettings.Builder pipelineServiceSettingsBuilder =
     PipelineServiceStubSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelay(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 pipelineServiceSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();
 

Inheritance

java.lang.Object > StubSettings > PipelineServiceStubSettings

Inherited Members

StubSettings.getApiKey()

StubSettings.getBackgroundExecutorProvider()

StubSettings.getClock()

StubSettings.getCredentialsProvider()

StubSettings.getEndpoint()

StubSettings.getExecutorProvider()

StubSettings.getGdchApiAudience()

StubSettings.getHeaderProvider()

StubSettings.getInternalHeaderProvider()

StubSettings.getMtlsEndpoint()

StubSettings.getQuotaProjectId()

StubSettings.getServiceName()

StubSettings.getStreamWatchdogCheckInterval()

StubSettings.getStreamWatchdogCheckIntervalDuration()

StubSettings.getStreamWatchdogProvider()

StubSettings.getTracerFactory()

StubSettings.getTransportChannelProvider()

StubSettings.getUniverseDomain()

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

Obsolete

Use getEndpoint() instead

This feature is stable for usage in this major version, but may be deprecated in a future release.

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

Returns a new builder for this class.

Returns
Type	Description
PipelineServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static PipelineServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
clientContext	ClientContext

Returns
Type	Description
PipelineServiceStubSettings.Builder

Constructors

PipelineServiceStubSettings(PipelineServiceStubSettings.Builder settingsBuilder)

protected PipelineServiceStubSettings(PipelineServiceStubSettings.Builder settingsBuilder)

Parameter
Name	Description
settingsBuilder	PipelineServiceStubSettings.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>

createStub()

public PipelineServiceStub createStub()

Returns
Type	Description
PipelineServiceStub

Exceptions
Type	Description
IOException

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>

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type	Description
String

Overrides

StubSettings<SettingsT>.getServiceName()

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

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

Returns
Type	Description
PipelineServiceStubSettings.Builder

Overrides

StubSettings<SettingsT>.toBuilder()