Console
    Contact Us Start free

    Google Cloud Dataproc V1 Client - Class ListClustersRequest (2.2.3)

    Reference documentation and code samples for the Google Cloud Dataproc V1 Client class ListClustersRequest.

    A request to list the clusters in a project.

    Generated from protobuf message google.cloud.dataproc.v1.ListClustersRequest

    Namespace

    Google \ Cloud \ Dataproc \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ project_id
    string

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

    ↳ region
    string

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

    ↳ filter
    string

    Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax: field = value [AND [field = value]] ... where fieldis one of status.state , clusterName , or labels.[KEY] , and [KEY] is a label key. valuecan be * to match all values. status.state can be one of the following: ACTIVE , INACTIVE , CREATING , RUNNING , ERROR , DELETING , UPDATING , STOPPING , or STOPPED . ACTIVE contains the CREATING , UPDATING , and RUNNING states. INACTIVE contains the DELETING , ERROR , STOPPING , and STOPPED states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator. Example filter: status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *

    ↳ page_size
    int

    Optional. The standard List page size.

    ↳ page_token
    string

    Optional. The standard List page token.

    getProjectId

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

    Returns
    Type
    Description
    string

    setProjectId

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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getRegion

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

    Returns
    Type
    Description
    string

    setRegion

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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getFilter

    Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax: field = value [AND [field = value]] ... where fieldis one of status.state , clusterName , or labels.[KEY] , and [KEY] is a label key. valuecan be * to match all values.

    status.state can be one of the following: ACTIVE , INACTIVE , CREATING , RUNNING , ERROR , DELETING , UPDATING , STOPPING , or STOPPED . ACTIVE contains the CREATING , UPDATING , and RUNNING states. INACTIVE contains the DELETING , ERROR , STOPPING , and STOPPED states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator. Example filter: status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *

    Returns
    Type
    Description
    string

    setFilter

    Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax: field = value [AND [field = value]] ... where fieldis one of status.state , clusterName , or labels.[KEY] , and [KEY] is a label key. valuecan be * to match all values.

    status.state can be one of the following: ACTIVE , INACTIVE , CREATING , RUNNING , ERROR , DELETING , UPDATING , STOPPING , or STOPPED . ACTIVE contains the CREATING , UPDATING , and RUNNING states. INACTIVE contains the DELETING , ERROR , STOPPING , and STOPPED states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator. Example filter: status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getPageSize

    Optional. The standard List page size.

    Returns
    Type
    Description
    int

    setPageSize

    Optional. The standard List page size.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getPageToken

    Optional. The standard List page token.

    Returns
    Type
    Description
    string

    setPageToken

    Optional. The standard List page token.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    static::build

    Parameters
    Name
    Description
    projectId
    string

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

    region
    string

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

    Returns
    Type
    Description
    ListClustersRequest

    static::buildFromProjectIdRegionFilter

    Parameters
    Name
    Description
    projectId
    string

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

    region
    string

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

    filter
    string

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

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

    where fieldis one of status.state , clusterName , or labels.[KEY] , and [KEY] is a label key. valuecan be * to match all values. status.state can be one of the following: ACTIVE , INACTIVE , CREATING , RUNNING , ERROR , DELETING , UPDATING , STOPPING , or STOPPED . ACTIVE contains the CREATING , UPDATING , and RUNNING states. INACTIVE contains the DELETING , ERROR , STOPPING , and STOPPED states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.

    Example filter:

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

    Returns
    Type
    Description
    ListClustersRequest
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: