Package com.google.spanner.v1

Class ListSessionsRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ListSessionsRequest.Builder>
com.google.spanner.v1.ListSessionsRequest.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ListSessionsRequestOrBuilder, Cloneable
Enclosing class:
ListSessionsRequest
public static final class ListSessionsRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<ListSessionsRequest.Builder> implements ListSessionsRequestOrBuilder
 The request for [ListSessions][google.spanner.v1.Spanner.ListSessions].
Protobuf type google.spanner.v1.ListSessionsRequest

  • Method Summary

    Modifier and Type
    Method
    Description
    ListSessionsRequest
    build()
     
    ListSessionsRequest
    buildPartial()
     
    ListSessionsRequest.Builder
    clear()
     
    ListSessionsRequest.Builder
    clearDatabase()
    Required.
    ListSessionsRequest.Builder
    clearFilter()
    An expression for filtering the results of the request.
    ListSessionsRequest.Builder
    clearPageSize()
    Number of sessions to be returned in the response.
    ListSessionsRequest.Builder
    clearPageToken()
    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
    getDatabase()
    Required.
    com.google.protobuf.ByteString
    getDatabaseBytes()
    Required.
    ListSessionsRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    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].
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    ListSessionsRequest.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    ListSessionsRequest.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    ListSessionsRequest.Builder
    mergeFrom(ListSessionsRequest other)
     
    ListSessionsRequest.Builder
    setDatabase(String value)
    Required.
    ListSessionsRequest.Builder
    setDatabaseBytes(com.google.protobuf.ByteString value)
    Required.
    ListSessionsRequest.Builder
    setFilter(String value)
    An expression for filtering the results of the request.
    ListSessionsRequest.Builder
    setFilterBytes(com.google.protobuf.ByteString value)
    An expression for filtering the results of the request.
    ListSessionsRequest.Builder
    setPageSize(int value)
    Number of sessions to be returned in the response.
    ListSessionsRequest.Builder
    setPageToken(String value)
    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].
    ListSessionsRequest.Builder
    setPageTokenBytes(com.google.protobuf.ByteString value)
    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 class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ListSessionsRequest.Builder>

    • clear

      public ListSessionsRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<ListSessionsRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ListSessionsRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public ListSessionsRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListSessionsRequest.Builder>

    • mergeFrom

      public ListSessionsRequest.Builder mergeFrom(ListSessionsRequest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ListSessionsRequest.Builder>

    • mergeFrom

      public ListSessionsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListSessionsRequest.Builder>
      Throws:
      IOException

    • 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.

    • setDatabase

      public ListSessionsRequest.Builder setDatabase(String value)
       Required. The database in which to list sessions.
      string database = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The database to set.
      Returns:
      This builder for chaining.

    • clearDatabase

      public ListSessionsRequest.Builder clearDatabase()
       Required. The database in which to list sessions.
      string database = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setDatabaseBytes

      public ListSessionsRequest.Builder setDatabaseBytes(com.google.protobuf.ByteString value)
       Required. The database in which to list sessions.
      string database = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for database to set.
      Returns:
      This builder for chaining.

    • 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.

    • setPageSize

      public ListSessionsRequest.Builder setPageSize(int value)
       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;
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.

    • clearPageSize

      public ListSessionsRequest.Builder clearPageSize()
       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:
      This builder for chaining.

    • 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.

    • setPageToken

      public ListSessionsRequest.Builder setPageToken(String value)
       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;
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken

      public ListSessionsRequest.Builder clearPageToken()
       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:
      This builder for chaining.

    • setPageTokenBytes

      public ListSessionsRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.

    • 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.

    • setFilter

      public ListSessionsRequest.Builder setFilter(String value)
       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;
      Parameters:
      value - The filter to set.
      Returns:
      This builder for chaining.

    • clearFilter

      public ListSessionsRequest.Builder clearFilter()
       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:
      This builder for chaining.

    • setFilterBytes

      public ListSessionsRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for filter to set.
      Returns:
      This builder for chaining.