com.google.cloud.aiplatform.v1

Class PipelineServiceSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<PipelineServiceSettings>

com.google.cloud.aiplatform.v1.PipelineServiceSettings

@Generated(value="by gapic-generator-java")
public class PipelineServiceSettings
extends com.google.api.gax.rpc.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 total timeout of createTrainingPipeline to 30 seconds:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 PipelineServiceSettings.Builder pipelineServiceSettingsBuilder =
     PipelineServiceSettings.newBuilder();
 pipelineServiceSettingsBuilder
     .createTrainingPipelineSettings()
     .setRetrySettings(
         pipelineServiceSettingsBuilder
             .createTrainingPipelineSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 PipelineServiceSettings pipelineServiceSettings = pipelineServiceSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PipelineServiceSettings.Builder Builder for PipelineServiceSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PipelineServiceSettings(PipelineServiceSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and 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.
static PipelineServiceSettings	create(PipelineServiceStubSettings stub)
com.google.api.gax.rpc.UnaryCallSettings<CreatePipelineJobRequest,PipelineJob>	createPipelineJobSettings() Returns the object with the settings used for calls to createPipelineJob.
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 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 PipelineServiceSettings.Builder	newBuilder() Returns a new builder for this class.
static PipelineServiceSettings.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.
PipelineServiceSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PipelineServiceSettings

protected PipelineServiceSettings(PipelineServiceSettings.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.

create

public static final PipelineServiceSettings create(PipelineServiceStubSettings stub)
                                            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.

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

Returns a new builder for this class.

newBuilder

public static PipelineServiceSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public PipelineServiceSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<PipelineServiceSettings>