Package com.google.spanner.v1

Class ListSessionsRequest

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ListSessionsRequestOrBuilder, Serializable
    public final class ListSessionsRequest
extends com.google.protobuf.GeneratedMessageV3
implements ListSessionsRequestOrBuilder
     The request for [ListSessions][google.spanner.v1.Spanner.ListSessions].
    Protobuf type google.spanner.v1.ListSessionsRequest
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ListSessionsRequest.Builder
      The request for [ListSessions][google.spanner.v1.Spanner.ListSessions].

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int DATABASE_FIELD_NUMBER  
      static int FILTER_FIELD_NUMBER  
      static int PAGE_SIZE_FIELD_NUMBER  
      static int PAGE_TOKEN_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Method Detail

      • newInstance

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

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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

      • getDatabase

        public String getDatabase()
         Required. The database in which to list sessions.
        string database = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getDatabase in interface ListSessionsRequestOrBuilder
        Returns:
        The database.

      • getDatabaseBytes

        public com.google.protobuf.ByteString getDatabaseBytes()
         Required. The database in which to list sessions.
        string database = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getDatabaseBytes in interface ListSessionsRequestOrBuilder
        Returns:
        The bytes for database.

      • getPageSize

        public int getPageSize()
         Number of sessions to be returned in the response. If 0 or less, defaults
 to the server's maximum allowed page size.
        int32 page_size = 2;
        Specified by:
        getPageSize in interface ListSessionsRequestOrBuilder
        Returns:
        The pageSize.

      • getPageToken

        public String getPageToken()
         If non-empty, `page_token` should contain a
 [next_page_token][google.spanner.v1.ListSessionsResponse.next_page_token] from a previous
 [ListSessionsResponse][google.spanner.v1.ListSessionsResponse].
        string page_token = 3;
        Specified by:
        getPageToken in interface ListSessionsRequestOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         If non-empty, `page_token` should contain a
 [next_page_token][google.spanner.v1.ListSessionsResponse.next_page_token] from a previous
 [ListSessionsResponse][google.spanner.v1.ListSessionsResponse].
        string page_token = 3;
        Specified by:
        getPageTokenBytes in interface ListSessionsRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • getFilter

        public String getFilter()
         An expression for filtering the results of the request. Filter rules are
 case insensitive. The fields eligible for filtering are:
   * `labels.key` where key is the name of a label
 Some examples of using filters are:
   * `labels.env:*` --> The session has the label "env".
   * `labels.env:dev` --> The session has the label "env" and the value of
                        the label contains the string "dev".
        string filter = 4;
        Specified by:
        getFilter in interface ListSessionsRequestOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         An expression for filtering the results of the request. Filter rules are
 case insensitive. The fields eligible for filtering are:
   * `labels.key` where key is the name of a label
 Some examples of using filters are:
   * `labels.env:*` --> The session has the label "env".
   * `labels.env:dev` --> The session has the label "env" and the value of
                        the label contains the string "dev".
        string filter = 4;
        Specified by:
        getFilterBytes in interface ListSessionsRequestOrBuilder
        Returns:
        The bytes for filter.

      • 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 ListSessionsRequest parseFrom​(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<ListSessionsRequest> 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 ListSessionsRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder