Google Cloud Dataproc v1 API - Class ListJobsRequest (5.9.0)

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

Reference documentation and code samples for the Google Cloud Dataproc v1 API class ListJobsRequest.

A request to list jobs in a project.

Inheritance

object > ListJobsRequest

Implements

IPageRequest, IMessage ListJobsRequest, IEquatable ListJobsRequest, IDeepCloneable ListJobsRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Dataproc.V1

Assembly

Google.Cloud.Dataproc.V1.dll

Constructors

ListJobsRequest()

public ListJobsRequest()

ListJobsRequest(ListJobsRequest)

public ListJobsRequest(ListJobsRequest other)

Parameter
Name	Description
`other`	`ListJobsRequest`

Properties

ClusterName

public string ClusterName { get; set; }

Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.

Property Value
Type	Description
`string`

Filter

public string Filter { get; set; }

Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax:

[field = value] AND [field [= value]] ...

where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or NON_ACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.

Example filter:

status.state = ACTIVE AND labels.env = staging AND labels.starred = *

Property Value
Type	Description
`string`

JobStateMatcher

public ListJobsRequest.Types.JobStateMatcher JobStateMatcher { get; set; }

Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).

If filter is provided, jobStateMatcher will be ignored.

Property Value
Type	Description
`ListJobsRequestTypesJobStateMatcher`

PageSize

public int PageSize { get; set; }

Optional. The number of results to return in each response.

Property Value
Type	Description
`int`

PageToken

public string PageToken { get; set; }

Optional. The page token, returned by a previous call, to request the next page of results.

Property Value
Type	Description
`string`

ProjectId

public string ProjectId { get; set; }

Required. The ID of the Google Cloud Platform project that the job belongs to.

Property Value
Type	Description
`string`

Region

public string Region { get; set; }

Required. The Dataproc region in which to handle the request.

Property Value
Type	Description
`string`