Class ListSessionsRequest.Builder (6.54.0)

public static final class ListSessionsRequest.Builder extends GeneratedMessageV3.Builder<ListSessionsRequest.Builder> implements ListSessionsRequestOrBuilder

The request for ListSessions.

Protobuf type google.spanner.v1.ListSessionsRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListSessionsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListSessionsRequest.Builder
Overrides

build()

public ListSessionsRequest build()
Returns
TypeDescription
ListSessionsRequest

buildPartial()

public ListSessionsRequest buildPartial()
Returns
TypeDescription
ListSessionsRequest

clear()

public ListSessionsRequest.Builder clear()
Returns
TypeDescription
ListSessionsRequest.Builder
Overrides

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
TypeDescription
ListSessionsRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ListSessionsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListSessionsRequest.Builder
Overrides

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
TypeDescription
ListSessionsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListSessionsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListSessionsRequest.Builder
Overrides

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
TypeDescription
ListSessionsRequest.Builder

This builder for chaining.

clearPageToken()

public ListSessionsRequest.Builder clearPageToken()

If non-empty, page_token should contain a next_page_token from a previous ListSessionsResponse.

string page_token = 3;

Returns
TypeDescription
ListSessionsRequest.Builder

This builder for chaining.

clone()

public ListSessionsRequest.Builder clone()
Returns
TypeDescription
ListSessionsRequest.Builder
Overrides

getDatabase()

public String getDatabase()

Required. The database in which to list sessions.

string database = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The database.

getDatabaseBytes()

public ByteString getDatabaseBytes()

Required. The database in which to list sessions.

string database = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for database.

getDefaultInstanceForType()

public ListSessionsRequest getDefaultInstanceForType()
Returns
TypeDescription
ListSessionsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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;

Returns
TypeDescription
String

The filter.

getFilterBytes()

public 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
TypeDescription
ByteString

The bytes for filter.

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;

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

If non-empty, page_token should contain a next_page_token from a previous ListSessionsResponse.

string page_token = 3;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

If non-empty, page_token should contain a next_page_token from a previous ListSessionsResponse.

string page_token = 3;

Returns
TypeDescription
ByteString

The bytes for pageToken.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListSessionsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListSessionsRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListSessionsRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListSessionsRequest.Builder
Overrides

mergeFrom(ListSessionsRequest other)

public ListSessionsRequest.Builder mergeFrom(ListSessionsRequest other)
Parameter
NameDescription
otherListSessionsRequest
Returns
TypeDescription
ListSessionsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListSessionsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListSessionsRequest.Builder
Overrides

setDatabase(String value)

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) = { ... }

Parameter
NameDescription
valueString

The database to set.

Returns
TypeDescription
ListSessionsRequest.Builder

This builder for chaining.

setDatabaseBytes(ByteString value)

public ListSessionsRequest.Builder setDatabaseBytes(ByteString value)

Required. The database in which to list sessions.

string database = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueByteString

The bytes for database to set.

Returns
TypeDescription
ListSessionsRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ListSessionsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListSessionsRequest.Builder
Overrides

setFilter(String value)

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;

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
ListSessionsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListSessionsRequest.Builder setFilterBytes(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;

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
ListSessionsRequest.Builder

This builder for chaining.

setPageSize(int value)

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;

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListSessionsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListSessionsRequest.Builder setPageToken(String value)

If non-empty, page_token should contain a next_page_token from a previous ListSessionsResponse.

string page_token = 3;

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListSessionsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListSessionsRequest.Builder setPageTokenBytes(ByteString value)

If non-empty, page_token should contain a next_page_token from a previous ListSessionsResponse.

string page_token = 3;

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListSessionsRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListSessionsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListSessionsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListSessionsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListSessionsRequest.Builder
Overrides