Class PipelineServiceStubSettings
- java.lang.Object
-
- com.google.api.gax.rpc.StubSettings<PipelineServiceStubSettings>
-
- com.google.cloud.aiplatform.v1.stub.PipelineServiceStubSettings
-
@Generated("by gapic-generator-java") public class PipelineServiceStubSettings extends com.google.api.gax.rpc.StubSettings<PipelineServiceStubSettings>
Settings class to configure an instance ofPipelineServiceStub
.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();
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PipelineServiceStubSettings.Builder
Builder for PipelineServiceStubSettings.
-
Constructor Summary
Constructors Modifier Constructor Description protected
PipelineServiceStubSettings(PipelineServiceStubSettings.Builder settingsBuilder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.google.api.gax.rpc.UnaryCallSettings<CancelPipelineJobRequest,com.google.protobuf.Empty>
cancelPipelineJobSettings()
Returns the object with the settings used for calls to cancelPipelineJob.com.google.api.gax.rpc.UnaryCallSettings<CancelTrainingPipelineRequest,com.google.protobuf.Empty>
cancelTrainingPipelineSettings()
Returns the object with the settings used for calls to cancelTrainingPipeline.com.google.api.gax.rpc.UnaryCallSettings<CreatePipelineJobRequest,PipelineJob>
createPipelineJobSettings()
Returns the object with the settings used for calls to createPipelineJob.PipelineServiceStub
createStub()
com.google.api.gax.rpc.UnaryCallSettings<CreateTrainingPipelineRequest,TrainingPipeline>
createTrainingPipelineSettings()
Returns the object with the settings used for calls to createTrainingPipeline.static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder
defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder
defaultCredentialsProviderBuilder()
Returns a builder for the default credentials for this service.static com.google.api.gax.core.InstantiatingExecutorProvider.Builder
defaultExecutorProviderBuilder()
Returns a builder for the default ExecutorProvider for this service.static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder
defaultGrpcTransportProviderBuilder()
Returns a builder for the default ChannelProvider for this service.static com.google.api.gax.rpc.TransportChannelProvider
defaultTransportChannelProvider()
com.google.api.gax.rpc.OperationCallSettings<DeletePipelineJobRequest,com.google.protobuf.Empty,DeleteOperationMetadata>
deletePipelineJobOperationSettings()
Returns the object with the settings used for calls to deletePipelineJob.com.google.api.gax.rpc.UnaryCallSettings<DeletePipelineJobRequest,com.google.longrunning.Operation>
deletePipelineJobSettings()
Returns the object with the settings used for calls to deletePipelineJob.com.google.api.gax.rpc.OperationCallSettings<DeleteTrainingPipelineRequest,com.google.protobuf.Empty,DeleteOperationMetadata>
deleteTrainingPipelineOperationSettings()
Returns the object with the settings used for calls to deleteTrainingPipeline.com.google.api.gax.rpc.UnaryCallSettings<DeleteTrainingPipelineRequest,com.google.longrunning.Operation>
deleteTrainingPipelineSettings()
Returns the object with the settings used for calls to deleteTrainingPipeline.static String
getDefaultEndpoint()
Returns the default service endpoint.static String
getDefaultMtlsEndpoint()
Returns the default mTLS service endpoint.static List<String>
getDefaultServiceScopes()
Returns the default service scopes.com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>
getIamPolicySettings()
Returns the object with the settings used for calls to getIamPolicy.com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>
getLocationSettings()
Returns the object with the settings used for calls to getLocation.com.google.api.gax.rpc.UnaryCallSettings<GetPipelineJobRequest,PipelineJob>
getPipelineJobSettings()
Returns the object with the settings used for calls to getPipelineJob.com.google.api.gax.rpc.UnaryCallSettings<GetTrainingPipelineRequest,TrainingPipeline>
getTrainingPipelineSettings()
Returns the object with the settings used for calls to getTrainingPipeline.com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,PipelineServiceClient.ListLocationsPagedResponse>
listLocationsSettings()
Returns the object with the settings used for calls to listLocations.com.google.api.gax.rpc.PagedCallSettings<ListPipelineJobsRequest,ListPipelineJobsResponse,PipelineServiceClient.ListPipelineJobsPagedResponse>
listPipelineJobsSettings()
Returns the object with the settings used for calls to listPipelineJobs.com.google.api.gax.rpc.PagedCallSettings<ListTrainingPipelinesRequest,ListTrainingPipelinesResponse,PipelineServiceClient.ListTrainingPipelinesPagedResponse>
listTrainingPipelinesSettings()
Returns the object with the settings used for calls to listTrainingPipelines.static PipelineServiceStubSettings.Builder
newBuilder()
Returns a new builder for this class.static PipelineServiceStubSettings.Builder
newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>
setIamPolicySettings()
Returns the object with the settings used for calls to setIamPolicy.com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>
testIamPermissionsSettings()
Returns the object with the settings used for calls to testIamPermissions.PipelineServiceStubSettings.Builder
toBuilder()
Returns a builder containing all the values of this settings class.-
Methods inherited from class com.google.api.gax.rpc.StubSettings
getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, toString
-
-
-
-
Constructor Detail
-
PipelineServiceStubSettings
protected PipelineServiceStubSettings(PipelineServiceStubSettings.Builder settingsBuilder) throws IOException
- Throws:
IOException
-
-
Method Detail
-
createTrainingPipelineSettings
public com.google.api.gax.rpc.UnaryCallSettings<CreateTrainingPipelineRequest,TrainingPipeline> createTrainingPipelineSettings()
Returns the object with the settings used for calls to createTrainingPipeline.
-
getTrainingPipelineSettings
public com.google.api.gax.rpc.UnaryCallSettings<GetTrainingPipelineRequest,TrainingPipeline> getTrainingPipelineSettings()
Returns the object with the settings used for calls to getTrainingPipeline.
-
listTrainingPipelinesSettings
public com.google.api.gax.rpc.PagedCallSettings<ListTrainingPipelinesRequest,ListTrainingPipelinesResponse,PipelineServiceClient.ListTrainingPipelinesPagedResponse> listTrainingPipelinesSettings()
Returns the object with the settings used for calls to listTrainingPipelines.
-
deleteTrainingPipelineSettings
public com.google.api.gax.rpc.UnaryCallSettings<DeleteTrainingPipelineRequest,com.google.longrunning.Operation> deleteTrainingPipelineSettings()
Returns the object with the settings used for calls to deleteTrainingPipeline.
-
deleteTrainingPipelineOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<DeleteTrainingPipelineRequest,com.google.protobuf.Empty,DeleteOperationMetadata> deleteTrainingPipelineOperationSettings()
Returns the object with the settings used for calls to deleteTrainingPipeline.
-
cancelTrainingPipelineSettings
public com.google.api.gax.rpc.UnaryCallSettings<CancelTrainingPipelineRequest,com.google.protobuf.Empty> cancelTrainingPipelineSettings()
Returns the object with the settings used for calls to cancelTrainingPipeline.
-
createPipelineJobSettings
public com.google.api.gax.rpc.UnaryCallSettings<CreatePipelineJobRequest,PipelineJob> createPipelineJobSettings()
Returns the object with the settings used for calls to createPipelineJob.
-
getPipelineJobSettings
public com.google.api.gax.rpc.UnaryCallSettings<GetPipelineJobRequest,PipelineJob> getPipelineJobSettings()
Returns the object with the settings used for calls to getPipelineJob.
-
listPipelineJobsSettings
public com.google.api.gax.rpc.PagedCallSettings<ListPipelineJobsRequest,ListPipelineJobsResponse,PipelineServiceClient.ListPipelineJobsPagedResponse> listPipelineJobsSettings()
Returns the object with the settings used for calls to listPipelineJobs.
-
deletePipelineJobSettings
public com.google.api.gax.rpc.UnaryCallSettings<DeletePipelineJobRequest,com.google.longrunning.Operation> deletePipelineJobSettings()
Returns the object with the settings used for calls to deletePipelineJob.
-
deletePipelineJobOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<DeletePipelineJobRequest,com.google.protobuf.Empty,DeleteOperationMetadata> deletePipelineJobOperationSettings()
Returns the object with the settings used for calls to deletePipelineJob.
-
cancelPipelineJobSettings
public com.google.api.gax.rpc.UnaryCallSettings<CancelPipelineJobRequest,com.google.protobuf.Empty> cancelPipelineJobSettings()
Returns the object with the settings used for calls to cancelPipelineJob.
-
listLocationsSettings
public com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,PipelineServiceClient.ListLocationsPagedResponse> listLocationsSettings()
Returns the object with the settings used for calls to listLocations.
-
getLocationSettings
public com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> getLocationSettings()
Returns the object with the settings used for calls to getLocation.
-
setIamPolicySettings
public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicySettings()
Returns the object with the settings used for calls to setIamPolicy.
-
getIamPolicySettings
public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicySettings()
Returns the object with the settings used for calls to getIamPolicy.
-
testIamPermissionsSettings
public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsSettings()
Returns the object with the settings used for calls to testIamPermissions.
-
createStub
public PipelineServiceStub createStub() throws IOException
- Throws:
IOException
-
defaultExecutorProviderBuilder
public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()
Returns a builder for the default ExecutorProvider for this service.
-
getDefaultEndpoint
public static String getDefaultEndpoint()
Returns the default service endpoint.
-
getDefaultMtlsEndpoint
public static String getDefaultMtlsEndpoint()
Returns the default mTLS service endpoint.
-
getDefaultServiceScopes
public static List<String> getDefaultServiceScopes()
Returns the default service scopes.
-
defaultCredentialsProviderBuilder
public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()
Returns a builder for the default credentials for this service.
-
defaultGrpcTransportProviderBuilder
public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()
Returns a builder for the default ChannelProvider for this service.
-
defaultTransportChannelProvider
public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()
-
defaultApiClientHeaderProviderBuilder
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.") public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
-
newBuilder
public static PipelineServiceStubSettings.Builder newBuilder()
Returns a new builder for this class.
-
newBuilder
public static PipelineServiceStubSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.
-
toBuilder
public PipelineServiceStubSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.- Specified by:
toBuilder
in classcom.google.api.gax.rpc.StubSettings<PipelineServiceStubSettings>
-
-