Class ProjectsResource.LocationsResource.BatchPredictionJobsResource

The "batchPredictionJobs" collection of methods.

Inheritance
object
ProjectsResource.LocationsResource.BatchPredictionJobsResource
Inherited Members
Namespace: Google.Apis.Aiplatform.v1beta1
Assembly: Google.Apis.Aiplatform.v1beta1.dll
Syntax
public class ProjectsResource.LocationsResource.BatchPredictionJobsResource

Constructors

BatchPredictionJobsResource(IClientService)

Constructs a new resource.

Declaration
public BatchPredictionJobsResource(IClientService service)
Parameters
Type Name Description
IClientService service

Methods

Cancel(GoogleCloudAiplatformV1beta1CancelBatchPredictionJobRequest, string)

Cancels a BatchPredictionJob. Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetBatchPredictionJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its BatchPredictionJob.state is set to CANCELLED. Any files already outputted by the job are not deleted.

Declaration
public virtual ProjectsResource.LocationsResource.BatchPredictionJobsResource.CancelRequest Cancel(GoogleCloudAiplatformV1beta1CancelBatchPredictionJobRequest body, string name)
Parameters
Type Name Description
GoogleCloudAiplatformV1beta1CancelBatchPredictionJobRequest body

The body of the request.
string name

Required. The name of the BatchPredictionJob to cancel. Format: projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}
Returns
Type Description
ProjectsResource.LocationsResource.BatchPredictionJobsResource.CancelRequest

Create(GoogleCloudAiplatformV1beta1BatchPredictionJob, string)

Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.

Declaration
public virtual ProjectsResource.LocationsResource.BatchPredictionJobsResource.CreateRequest Create(GoogleCloudAiplatformV1beta1BatchPredictionJob body, string parent)
Parameters
Type Name Description
GoogleCloudAiplatformV1beta1BatchPredictionJob body

The body of the request.
string parent

Required. The resource name of the Location to create the BatchPredictionJob in. Format: projects/{project}/locations/{location}
Returns
Type Description
ProjectsResource.LocationsResource.BatchPredictionJobsResource.CreateRequest

Delete(string)

Deletes a BatchPredictionJob. Can only be called on jobs that already finished.

Declaration
public virtual ProjectsResource.LocationsResource.BatchPredictionJobsResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

Required. The name of the BatchPredictionJob resource to be deleted. Format: projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}
Returns
Type Description
ProjectsResource.LocationsResource.BatchPredictionJobsResource.DeleteRequest

Get(string)

Gets a BatchPredictionJob

Declaration
public virtual ProjectsResource.LocationsResource.BatchPredictionJobsResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

Required. The name of the BatchPredictionJob resource. Format: projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}
Returns
Type Description
ProjectsResource.LocationsResource.BatchPredictionJobsResource.GetRequest

List(string)

Lists BatchPredictionJobs in a Location.

Declaration
public virtual ProjectsResource.LocationsResource.BatchPredictionJobsResource.ListRequest List(string parent)
Parameters
Type Name Description
string parent

Required. The resource name of the Location to list the BatchPredictionJobs from. Format: projects/{project}/locations/{location}
Returns
Type Description
ProjectsResource.LocationsResource.BatchPredictionJobsResource.ListRequest