- 3.12.0 (latest)
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.0
- 3.3.0
- 3.2.0
- 3.1.0
- 3.0.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.0
- 2.2.0
- 2.1.0
- 2.0.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
public class PipelineService.PipelineServiceClient : ClientBase<PipelineService.PipelineServiceClient>
Reference documentation and code samples for the Cloud AI Platform v1 API class PipelineService.PipelineServiceClient.
Client for PipelineService
Inheritance
object > ClientBase > ClientBasePipelineServicePipelineServiceClient > PipelineService.PipelineServiceClientNamespace
GoogleCloudGoogle.Cloud.AIPlatformV1Assembly
Google.Cloud.AIPlatform.V1.dll
Constructors
PipelineServiceClient()
protected PipelineServiceClient()
Protected parameterless constructor to allow creation of test doubles.
PipelineServiceClient(CallInvoker)
public PipelineServiceClient(CallInvoker callInvoker)
Creates a new client for PipelineService that uses a custom CallInvoker
.
Parameter | |
---|---|
Name | Description |
callInvoker | CallInvoker The callInvoker to use to make remote calls. |
PipelineServiceClient(ChannelBase)
public PipelineServiceClient(ChannelBase channel)
Creates a new client for PipelineService
Parameter | |
---|---|
Name | Description |
channel | ChannelBase The channel to use to make remote calls. |
PipelineServiceClient(ClientBaseConfiguration)
protected PipelineServiceClient(ClientBase.ClientBaseConfiguration configuration)
Protected constructor to allow creation of configured clients.
Parameter | |
---|---|
Name | Description |
configuration | ClientBaseClientBaseConfiguration The client configuration. |
Methods
CancelPipelineJob(CancelPipelineJobRequest, CallOptions)
public virtual Empty CancelPipelineJob(CancelPipelineJobRequest request, CallOptions options)
Cancels a PipelineJob.
Starts asynchronous cancellation on the PipelineJob. The server
makes a best effort to cancel the pipeline, but success is not
guaranteed. Clients can use
[PipelineService.GetPipelineJob][google.cloud.aiplatform.v1.PipelineService.GetPipelineJob]
or other methods to check whether the cancellation succeeded or whether the
pipeline completed despite cancellation. On successful cancellation,
the PipelineJob is not deleted; instead it becomes a pipeline with
a [PipelineJob.error][google.cloud.aiplatform.v1.PipelineJob.error] value
with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding
to Code.CANCELLED
, and
[PipelineJob.state][google.cloud.aiplatform.v1.PipelineJob.state] is set to
CANCELLED
.
Parameters | |
---|---|
Name | Description |
request | CancelPipelineJobRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Empty | The response received from the server. |
CancelPipelineJob(CancelPipelineJobRequest, Metadata, DateTime?, CancellationToken)
public virtual Empty CancelPipelineJob(CancelPipelineJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Cancels a PipelineJob.
Starts asynchronous cancellation on the PipelineJob. The server
makes a best effort to cancel the pipeline, but success is not
guaranteed. Clients can use
[PipelineService.GetPipelineJob][google.cloud.aiplatform.v1.PipelineService.GetPipelineJob]
or other methods to check whether the cancellation succeeded or whether the
pipeline completed despite cancellation. On successful cancellation,
the PipelineJob is not deleted; instead it becomes a pipeline with
a [PipelineJob.error][google.cloud.aiplatform.v1.PipelineJob.error] value
with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding
to Code.CANCELLED
, and
[PipelineJob.state][google.cloud.aiplatform.v1.PipelineJob.state] is set to
CANCELLED
.
Parameters | |
---|---|
Name | Description |
request | CancelPipelineJobRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Empty | The response received from the server. |
CancelPipelineJobAsync(CancelPipelineJobRequest, CallOptions)
public virtual AsyncUnaryCall<Empty> CancelPipelineJobAsync(CancelPipelineJobRequest request, CallOptions options)
Cancels a PipelineJob.
Starts asynchronous cancellation on the PipelineJob. The server
makes a best effort to cancel the pipeline, but success is not
guaranteed. Clients can use
[PipelineService.GetPipelineJob][google.cloud.aiplatform.v1.PipelineService.GetPipelineJob]
or other methods to check whether the cancellation succeeded or whether the
pipeline completed despite cancellation. On successful cancellation,
the PipelineJob is not deleted; instead it becomes a pipeline with
a [PipelineJob.error][google.cloud.aiplatform.v1.PipelineJob.error] value
with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding
to Code.CANCELLED
, and
[PipelineJob.state][google.cloud.aiplatform.v1.PipelineJob.state] is set to
CANCELLED
.
Parameters | |
---|---|
Name | Description |
request | CancelPipelineJobRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallEmpty | The call object. |
CancelPipelineJobAsync(CancelPipelineJobRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Empty> CancelPipelineJobAsync(CancelPipelineJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Cancels a PipelineJob.
Starts asynchronous cancellation on the PipelineJob. The server
makes a best effort to cancel the pipeline, but success is not
guaranteed. Clients can use
[PipelineService.GetPipelineJob][google.cloud.aiplatform.v1.PipelineService.GetPipelineJob]
or other methods to check whether the cancellation succeeded or whether the
pipeline completed despite cancellation. On successful cancellation,
the PipelineJob is not deleted; instead it becomes a pipeline with
a [PipelineJob.error][google.cloud.aiplatform.v1.PipelineJob.error] value
with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding
to Code.CANCELLED
, and
[PipelineJob.state][google.cloud.aiplatform.v1.PipelineJob.state] is set to
CANCELLED
.
Parameters | |
---|---|
Name | Description |
request | CancelPipelineJobRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallEmpty | The call object. |
CancelTrainingPipeline(CancelTrainingPipelineRequest, CallOptions)
public virtual Empty CancelTrainingPipeline(CancelTrainingPipelineRequest request, CallOptions options)
Cancels a TrainingPipeline.
Starts asynchronous cancellation on the TrainingPipeline. The server
makes a best effort to cancel the pipeline, but success is not
guaranteed. Clients can use
[PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline]
or other methods to check whether the cancellation succeeded or whether the
pipeline completed despite cancellation. On successful cancellation,
the TrainingPipeline is not deleted; instead it becomes a pipeline with
a
[TrainingPipeline.error][google.cloud.aiplatform.v1.TrainingPipeline.error]
value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
corresponding to Code.CANCELLED
, and
[TrainingPipeline.state][google.cloud.aiplatform.v1.TrainingPipeline.state]
is set to CANCELLED
.
Parameters | |
---|---|
Name | Description |
request | CancelTrainingPipelineRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Empty | The response received from the server. |
CancelTrainingPipeline(CancelTrainingPipelineRequest, Metadata, DateTime?, CancellationToken)
public virtual Empty CancelTrainingPipeline(CancelTrainingPipelineRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Cancels a TrainingPipeline.
Starts asynchronous cancellation on the TrainingPipeline. The server
makes a best effort to cancel the pipeline, but success is not
guaranteed. Clients can use
[PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline]
or other methods to check whether the cancellation succeeded or whether the
pipeline completed despite cancellation. On successful cancellation,
the TrainingPipeline is not deleted; instead it becomes a pipeline with
a
[TrainingPipeline.error][google.cloud.aiplatform.v1.TrainingPipeline.error]
value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
corresponding to Code.CANCELLED
, and
[TrainingPipeline.state][google.cloud.aiplatform.v1.TrainingPipeline.state]
is set to CANCELLED
.
Parameters | |
---|---|
Name | Description |
request | CancelTrainingPipelineRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Empty | The response received from the server. |
CancelTrainingPipelineAsync(CancelTrainingPipelineRequest, CallOptions)
public virtual AsyncUnaryCall<Empty> CancelTrainingPipelineAsync(CancelTrainingPipelineRequest request, CallOptions options)
Cancels a TrainingPipeline.
Starts asynchronous cancellation on the TrainingPipeline. The server
makes a best effort to cancel the pipeline, but success is not
guaranteed. Clients can use
[PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline]
or other methods to check whether the cancellation succeeded or whether the
pipeline completed despite cancellation. On successful cancellation,
the TrainingPipeline is not deleted; instead it becomes a pipeline with
a
[TrainingPipeline.error][google.cloud.aiplatform.v1.TrainingPipeline.error]
value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
corresponding to Code.CANCELLED
, and
[TrainingPipeline.state][google.cloud.aiplatform.v1.TrainingPipeline.state]
is set to CANCELLED
.
Parameters | |
---|---|
Name | Description |
request | CancelTrainingPipelineRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallEmpty | The call object. |
CancelTrainingPipelineAsync(CancelTrainingPipelineRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Empty> CancelTrainingPipelineAsync(CancelTrainingPipelineRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Cancels a TrainingPipeline.
Starts asynchronous cancellation on the TrainingPipeline. The server
makes a best effort to cancel the pipeline, but success is not
guaranteed. Clients can use
[PipelineService.GetTrainingPipeline][google.cloud.aiplatform.v1.PipelineService.GetTrainingPipeline]
or other methods to check whether the cancellation succeeded or whether the
pipeline completed despite cancellation. On successful cancellation,
the TrainingPipeline is not deleted; instead it becomes a pipeline with
a
[TrainingPipeline.error][google.cloud.aiplatform.v1.TrainingPipeline.error]
value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
corresponding to Code.CANCELLED
, and
[TrainingPipeline.state][google.cloud.aiplatform.v1.TrainingPipeline.state]
is set to CANCELLED
.
Parameters | |
---|---|
Name | Description |
request | CancelTrainingPipelineRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallEmpty | The call object. |
CreateIAMPolicyClient()
public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()
Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.
Returns | |
---|---|
Type | Description |
IAMPolicyIAMPolicyClient | A new IAMPolicy.IAMPolicyClient for the same target as this client. |
CreateLocationsClient()
public virtual Locations.LocationsClient CreateLocationsClient()
Creates a new instance of Locations.LocationsClient using the same call invoker as this client.
Returns | |
---|---|
Type | Description |
LocationsLocationsClient | A new Locations.LocationsClient for the same target as this client. |
CreateOperationsClient()
public virtual Operations.OperationsClient CreateOperationsClient()
Creates a new instance of Operations.OperationsClient using the same call invoker as this client.
Returns | |
---|---|
Type | Description |
OperationsOperationsClient | A new Operations client for the same target as this client. |
CreatePipelineJob(CreatePipelineJobRequest, CallOptions)
public virtual PipelineJob CreatePipelineJob(CreatePipelineJobRequest request, CallOptions options)
Creates a PipelineJob. A PipelineJob will run immediately when created.
Parameters | |
---|---|
Name | Description |
request | CreatePipelineJobRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
PipelineJob | The response received from the server. |
CreatePipelineJob(CreatePipelineJobRequest, Metadata, DateTime?, CancellationToken)
public virtual PipelineJob CreatePipelineJob(CreatePipelineJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Creates a PipelineJob. A PipelineJob will run immediately when created.
Parameters | |
---|---|
Name | Description |
request | CreatePipelineJobRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
PipelineJob | The response received from the server. |
CreatePipelineJobAsync(CreatePipelineJobRequest, CallOptions)
public virtual AsyncUnaryCall<PipelineJob> CreatePipelineJobAsync(CreatePipelineJobRequest request, CallOptions options)
Creates a PipelineJob. A PipelineJob will run immediately when created.
Parameters | |
---|---|
Name | Description |
request | CreatePipelineJobRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallPipelineJob | The call object. |
CreatePipelineJobAsync(CreatePipelineJobRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<PipelineJob> CreatePipelineJobAsync(CreatePipelineJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Creates a PipelineJob. A PipelineJob will run immediately when created.
Parameters | |
---|---|
Name | Description |
request | CreatePipelineJobRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
|