Class ListSessionsRequest.Builder (6.66.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
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListSessionsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListSessionsRequest.Builder
Overrides

build()

public ListSessionsRequest build()
Returns
Type Description
ListSessionsRequest

buildPartial()

public ListSessionsRequest buildPartial()
Returns
Type Description
ListSessionsRequest

clear()

public ListSessionsRequest.Builder clear()
Returns
Type Description
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
Type Description
ListSessionsRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ListSessionsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
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
Type Description
ListSessionsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListSessionsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
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
Type Description
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
Type Description
ListSessionsRequest.Builder

This builder for chaining.

clone()

public ListSessionsRequest.Builder clone()
Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for database.

getDefaultInstanceForType()

public ListSessionsRequest getDefaultInstanceForType()
Returns
Type Description
ListSessionsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for pageToken.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListSessionsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSessionsRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListSessionsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListSessionsRequest.Builder
Overrides

mergeFrom(ListSessionsRequest other)

public ListSessionsRequest.Builder mergeFrom(ListSessionsRequest other)
Parameter
Name Description
other ListSessionsRequest
Returns
Type Description
ListSessionsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListSessionsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
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
Name Description
value String

The database to set.

Returns
Type Description
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
Name Description
value ByteString

The bytes for database to set.

Returns
Type Description
ListSessionsRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ListSessionsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
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
Name Description
value String

The filter to set.

Returns
Type Description
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
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
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
Name Description
value int

The pageSize to set.

Returns
Type Description
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
Name Description
value String

The pageToken to set.

Returns
Type Description
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
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
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
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListSessionsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListSessionsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListSessionsRequest.Builder
Overrides