Package com.google.spanner.v1

Interface ListSessionsRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ListSessionsRequest, ListSessionsRequest.Builder
    public interface ListSessionsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getDatabase()
      Required.
      com.google.protobuf.ByteString getDatabaseBytes()
      Required.
      String getFilter()
      An expression for filtering the results of the request.
      com.google.protobuf.ByteString getFilterBytes()
      An expression for filtering the results of the request.
      int getPageSize()
      Number of sessions to be returned in the response.
      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].
      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].

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getDatabase

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

      • getDatabaseBytes

        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) = { ... }
        Returns:
        The bytes for database.

      • getPageSize

        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;
        Returns:
        The pageSize.

      • getPageToken

        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;
        Returns:
        The pageToken.

      • getPageTokenBytes

        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;
        Returns:
        The bytes for pageToken.

      • getFilter

        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;
        Returns:
        The filter.

      • getFilterBytes

        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;
        Returns:
        The bytes for filter.