Class PipelineServiceStubSettings (3.28.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 total timeout of createTrainingPipeline to 30 seconds:


 // 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()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 PipelineServiceStubSettings pipelineServiceSettings = pipelineServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > StubSettings > PipelineServiceStubSettings

Static Methods

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static PipelineServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
PipelineServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static PipelineServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
PipelineServiceStubSettings.Builder

Constructors

PipelineServiceStubSettings(PipelineServiceStubSettings.Builder settingsBuilder)

protected PipelineServiceStubSettings(PipelineServiceStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderPipelineServiceStubSettings.Builder

Methods

cancelPipelineJobSettings()

public UnaryCallSettings<CancelPipelineJobRequest,Empty> cancelPipelineJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<CancelPipelineJobRequest,Empty>

cancelTrainingPipelineSettings()

public UnaryCallSettings<CancelTrainingPipelineRequest,Empty> cancelTrainingPipelineSettings()

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

Returns
TypeDescription
UnaryCallSettings<CancelTrainingPipelineRequest,Empty>

createPipelineJobSettings()

public UnaryCallSettings<CreatePipelineJobRequest,PipelineJob> createPipelineJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreatePipelineJobRequest,PipelineJob>

createStub()

public PipelineServiceStub createStub()
Returns
TypeDescription
PipelineServiceStub
Exceptions
TypeDescription
IOException

createTrainingPipelineSettings()

public UnaryCallSettings<CreateTrainingPipelineRequest,TrainingPipeline> createTrainingPipelineSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateTrainingPipelineRequest,TrainingPipeline>

deletePipelineJobOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeletePipelineJobRequest,Empty,DeleteOperationMetadata>

deletePipelineJobSettings()

public UnaryCallSettings<DeletePipelineJobRequest,Operation> deletePipelineJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeletePipelineJobRequest,Operation>

deleteTrainingPipelineOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteTrainingPipelineRequest,Empty,DeleteOperationMetadata>

deleteTrainingPipelineSettings()

public UnaryCallSettings<DeleteTrainingPipelineRequest,Operation> deleteTrainingPipelineSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteTrainingPipelineRequest,Operation>

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
UnaryCallSettings<GetPipelineJobRequest,PipelineJob>

getTrainingPipelineSettings()

public UnaryCallSettings<GetTrainingPipelineRequest,TrainingPipeline> getTrainingPipelineSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetTrainingPipelineRequest,TrainingPipeline>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,PipelineServiceClient.ListLocationsPagedResponse> listLocationsSettings()

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

Returns
TypeDescription
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
TypeDescription
PagedCallSettings<ListPipelineJobsRequest,ListPipelineJobsResponse,ListPipelineJobsPagedResponse>

listTrainingPipelinesSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListTrainingPipelinesRequest,ListTrainingPipelinesResponse,ListTrainingPipelinesPagedResponse>

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
PipelineServiceStubSettings.Builder
Overrides