Class ListBatchPredictionJobsRequest (2.0.0)

public sealed class ListBatchPredictionJobsRequest : IMessage<ListBatchPredictionJobsRequest>, IEquatable<ListBatchPredictionJobsRequest>, IDeepCloneable<ListBatchPredictionJobsRequest>, IBufferMessage, IMessage, IPageRequest

Request message for [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs].

Inheritance

Object > ListBatchPredictionJobsRequest

Implements

IMessage<ListBatchPredictionJobsRequest>, IEquatable<ListBatchPredictionJobsRequest>, IDeepCloneable<ListBatchPredictionJobsRequest>, IBufferMessage, IMessage, IPageRequest

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

ListBatchPredictionJobsRequest()

public ListBatchPredictionJobsRequest()

ListBatchPredictionJobsRequest(ListBatchPredictionJobsRequest)

public ListBatchPredictionJobsRequest(ListBatchPredictionJobsRequest other)

Parameter
Name	Description
`other`	`ListBatchPredictionJobsRequest`

Properties

Filter

public string Filter { get; set; }

The standard list filter.

Supported fields:

display_name supports = and !=.
state supports = and !=.
model_display_name supports = and !=

Some examples of using the filter are:

state="JOB_STATE_SUCCEEDED" AND display_name="my_job"
state="JOB_STATE_RUNNING" OR display_name="my_job"
NOT display_name="my_job"
state="JOB_STATE_FAILED"

Property Value
Type	Description
`String`

PageSize

public int PageSize { get; set; }

The standard list page size.

Property Value
Type	Description
`Int32`

PageToken

public string PageToken { get; set; }

The standard list page token. Typically obtained via [ListBatchPredictionJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListBatchPredictionJobsResponse.next_page_token] of the previous [JobService.ListBatchPredictionJobs][google.cloud.aiplatform.v1.JobService.ListBatchPredictionJobs] call.

Property Value
Type	Description
`String`

Parent

public string Parent { get; set; }

Required. The resource name of the Location to list the BatchPredictionJobs from. Format: projects/{project}/locations/{location}

Property Value
Type	Description
`String`

ParentAsLocationName

public LocationName ParentAsLocationName { get; set; }

LocationName-typed view over the Parent resource name property.

Property Value
Type	Description
`LocationName`

ReadMask

public FieldMask ReadMask { get; set; }

Mask specifying which fields to read.

Property Value
Type	Description
`FieldMask`