Package com.google.cloud.dataproc.v1

Class ListClustersRequest

  • All Implemented Interfaces:
    ListClustersRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ListClustersRequest
extends com.google.protobuf.GeneratedMessageV3
implements ListClustersRequestOrBuilder
     A request to list the clusters in a project.
    Protobuf type google.cloud.dataproc.v1.ListClustersRequest
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getProjectId

        public String getProjectId()
         Required. The ID of the Google Cloud Platform project that the cluster
 belongs to.
        string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getProjectId in interface ListClustersRequestOrBuilder
        Returns:
        The projectId.

      • getProjectIdBytes

        public com.google.protobuf.ByteString getProjectIdBytes()
         Required. The ID of the Google Cloud Platform project that the cluster
 belongs to.
        string project_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getProjectIdBytes in interface ListClustersRequestOrBuilder
        Returns:
        The bytes for projectId.

      • getRegion

        public String getRegion()
         Required. The Dataproc region in which to handle the request.
        string region = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getRegion in interface ListClustersRequestOrBuilder
        Returns:
        The region.

      • getRegionBytes

        public com.google.protobuf.ByteString getRegionBytes()
         Required. The Dataproc region in which to handle the request.
        string region = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getRegionBytes in interface ListClustersRequestOrBuilder
        Returns:
        The bytes for region.

      • getFilter

        public String getFilter()
         Optional. A filter constraining the clusters to list. Filters are
 case-sensitive and have the following syntax:

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

 where **field** is one of `status.state`, `clusterName`, or `labels.[KEY]`,
 and `[KEY]` is a label key. **value** can be `*` to match all values.
 `status.state` can be one of the following: `ACTIVE`, `INACTIVE`,
 `CREATING`, `RUNNING`, `ERROR`, `DELETING`, or `UPDATING`. `ACTIVE`
 contains the `CREATING`, `UPDATING`, and `RUNNING` states. `INACTIVE`
 contains the `DELETING` and `ERROR` 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 = *
        string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFilter in interface ListClustersRequestOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         Optional. A filter constraining the clusters to list. Filters are
 case-sensitive and have the following syntax:

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

 where **field** is one of `status.state`, `clusterName`, or `labels.[KEY]`,
 and `[KEY]` is a label key. **value** can be `*` to match all values.
 `status.state` can be one of the following: `ACTIVE`, `INACTIVE`,
 `CREATING`, `RUNNING`, `ERROR`, `DELETING`, or `UPDATING`. `ACTIVE`
 contains the `CREATING`, `UPDATING`, and `RUNNING` states. `INACTIVE`
 contains the `DELETING` and `ERROR` 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 = *
        string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFilterBytes in interface ListClustersRequestOrBuilder
        Returns:
        The bytes for filter.

      • getPageSize

        public int getPageSize()
         Optional. The standard List page size.
        int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageSize in interface ListClustersRequestOrBuilder
        Returns:
        The pageSize.

      • getPageToken

        public String getPageToken()
         Optional. The standard List page token.
        string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageToken in interface ListClustersRequestOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         Optional. The standard List page token.
        string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageTokenBytes in interface ListClustersRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static ListClustersRequest parseFrom​(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListClustersRequest parseFrom​(ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListClustersRequest parseFrom​(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListClustersRequest parseFrom​(com.google.protobuf.ByteString data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListClustersRequest parseFrom​(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListClustersRequest parseFrom​(byte[] data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListClustersRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException
        Throws:
        IOException

      • newBuilderForType

        public ListClustersRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ListClustersRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ListClustersRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<ListClustersRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public ListClustersRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder