Cloud Dataproc V1 API - Class Google::Cloud::Dataproc::V1::ListJobsRequest (v0.23.1)

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

A request to list jobs in a project.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#cluster_name

def cluster_name() -> ::String
Returns
  • (::String) — Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.

#cluster_name=

def cluster_name=(value) -> ::String
Parameter
  • value (::String) — Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.
Returns
  • (::String) — Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.

#filter

def filter() -> ::String
Returns
  • (::String) — 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 = *

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) — 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 = *

Returns
  • (::String) — 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 = *

#job_state_matcher

def job_state_matcher() -> ::Google::Cloud::Dataproc::V1::ListJobsRequest::JobStateMatcher
Returns

#job_state_matcher=

def job_state_matcher=(value) -> ::Google::Cloud::Dataproc::V1::ListJobsRequest::JobStateMatcher
Parameter
Returns

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — Optional. The number of results to return in each response.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. The number of results to return in each response.
Returns
  • (::Integer) — Optional. The number of results to return in each response.

#page_token

def page_token() -> ::String
Returns
  • (::String) — Optional. The page token, returned by a previous call, to request the next page of results.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — Optional. The page token, returned by a previous call, to request the next page of results.
Returns
  • (::String) — Optional. The page token, returned by a previous call, to request the next page of results.

#project_id

def project_id() -> ::String
Returns
  • (::String) — Required. The ID of the Google Cloud Platform project that the job belongs to.

#project_id=

def project_id=(value) -> ::String
Parameter
  • value (::String) — Required. The ID of the Google Cloud Platform project that the job belongs to.
Returns
  • (::String) — Required. The ID of the Google Cloud Platform project that the job belongs to.

#region

def region() -> ::String
Returns
  • (::String) — Required. The Dataproc region in which to handle the request.

#region=

def region=(value) -> ::String
Parameter
  • value (::String) — Required. The Dataproc region in which to handle the request.
Returns
  • (::String) — Required. The Dataproc region in which to handle the request.