Class ListInstancesRequest.Builder (6.80.1) 

public static final class ListInstancesRequest.Builder extends GeneratedMessageV3.Builder<ListInstancesRequest.Builder> implements ListInstancesRequestOrBuilder

The request for ListInstances.

Protobuf type google.spanner.admin.instance.v1.ListInstancesRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListInstancesRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListInstancesRequest build()
Returns
Type Description
ListInstancesRequest

buildPartial()

public ListInstancesRequest buildPartial()
Returns
Type Description
ListInstancesRequest

clear()

public ListInstancesRequest.Builder clear()
Returns
Type Description
ListInstancesRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListInstancesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListInstancesRequest.Builder
Overrides

clearFilter()

public ListInstancesRequest.Builder clearFilter()

An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

  • name
  • display_name

  • labels.key where key is the name of a label

    Some examples of using filters are:

  • name:* --> The instance has a name.

  • name:Howl --> The instance's name contains the string "howl".
  • name:HOWL --> Equivalent to above.
  • NAME:howl --> Equivalent to above.
  • labels.env:* --> The instance has the label "env".
  • labels.env:dev --> The instance has the label "env" and the value of the label contains the string "dev".
  • name:howl labels.env:dev --> The instance's name contains "howl" and it has the label "env" with its value containing "dev".

string filter = 4;

Returns
Type Description
ListInstancesRequest.Builder

This builder for chaining.

clearInstanceDeadline()

public ListInstancesRequest.Builder clearInstanceDeadline()

Deadline used while retrieving metadata for instances. Instances whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancesResponse.

.google.protobuf.Timestamp instance_deadline = 5;

Returns
Type Description
ListInstancesRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public ListInstancesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListInstancesRequest.Builder
Overrides

clearPageSize()

public ListInstancesRequest.Builder clearPageSize()

Number of instances 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
ListInstancesRequest.Builder

This builder for chaining.

clearPageToken()

public ListInstancesRequest.Builder clearPageToken()

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

string page_token = 3;

Returns
Type Description
ListInstancesRequest.Builder

This builder for chaining.

clearParent()

public ListInstancesRequest.Builder clearParent()

Required. The name of the project for which a list of instances is requested. Values are of the form projects/<project>.

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

Returns
Type Description
ListInstancesRequest.Builder

This builder for chaining.

clone()

public ListInstancesRequest.Builder clone()
Returns
Type Description
ListInstancesRequest.Builder
Overrides

getDefaultInstanceForType()

public ListInstancesRequest getDefaultInstanceForType()
Returns
Type Description
ListInstancesRequest

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:

  • name
  • display_name

  • labels.key where key is the name of a label

    Some examples of using filters are:

  • name:* --> The instance has a name.

  • name:Howl --> The instance's name contains the string "howl".
  • name:HOWL --> Equivalent to above.
  • NAME:howl --> Equivalent to above.
  • labels.env:* --> The instance has the label "env".
  • labels.env:dev --> The instance has the label "env" and the value of the label contains the string "dev".
  • name:howl labels.env:dev --> The instance's name contains "howl" and it has the label "env" with its value containing "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:

  • name
  • display_name

  • labels.key where key is the name of a label

    Some examples of using filters are:

  • name:* --> The instance has a name.

  • name:Howl --> The instance's name contains the string "howl".
  • name:HOWL --> Equivalent to above.
  • NAME:howl --> Equivalent to above.
  • labels.env:* --> The instance has the label "env".
  • labels.env:dev --> The instance has the label "env" and the value of the label contains the string "dev".
  • name:howl labels.env:dev --> The instance's name contains "howl" and it has the label "env" with its value containing "dev".

string filter = 4;

Returns
Type Description
ByteString

The bytes for filter.

getInstanceDeadline()

public Timestamp getInstanceDeadline()

Deadline used while retrieving metadata for instances. Instances whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancesResponse.

.google.protobuf.Timestamp instance_deadline = 5;

Returns
Type Description
Timestamp

The instanceDeadline.

getInstanceDeadlineBuilder()

public Timestamp.Builder getInstanceDeadlineBuilder()

Deadline used while retrieving metadata for instances. Instances whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancesResponse.

.google.protobuf.Timestamp instance_deadline = 5;

Returns
Type Description
Builder

getInstanceDeadlineOrBuilder()

public TimestampOrBuilder getInstanceDeadlineOrBuilder()

Deadline used while retrieving metadata for instances. Instances whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancesResponse.

.google.protobuf.Timestamp instance_deadline = 5;

Returns
Type Description
TimestampOrBuilder

getPageSize()

public int getPageSize()

Number of instances 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 ListInstancesResponse.

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

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The name of the project for which a list of instances is requested. Values are of the form projects/<project>.

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The name of the project for which a list of instances is requested. Values are of the form projects/<project>.

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

Returns
Type Description
ByteString

The bytes for parent.

hasInstanceDeadline()

public boolean hasInstanceDeadline()

Deadline used while retrieving metadata for instances. Instances whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancesResponse.

.google.protobuf.Timestamp instance_deadline = 5;

Returns
Type Description
boolean

Whether the instanceDeadline field is set.

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 ListInstancesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListInstancesRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

mergeFrom(ListInstancesRequest other)

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

mergeInstanceDeadline(Timestamp value)

public ListInstancesRequest.Builder mergeInstanceDeadline(Timestamp value)

Deadline used while retrieving metadata for instances. Instances whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancesResponse.

.google.protobuf.Timestamp instance_deadline = 5;

Parameter
Name Description
value Timestamp
Returns
Type Description
ListInstancesRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListInstancesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListInstancesRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListInstancesRequest.Builder setFilter(String value)

An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

  • name
  • display_name

  • labels.key where key is the name of a label

    Some examples of using filters are:

  • name:* --> The instance has a name.

  • name:Howl --> The instance's name contains the string "howl".
  • name:HOWL --> Equivalent to above.
  • NAME:howl --> Equivalent to above.
  • labels.env:* --> The instance has the label "env".
  • labels.env:dev --> The instance has the label "env" and the value of the label contains the string "dev".
  • name:howl labels.env:dev --> The instance's name contains "howl" and it has the label "env" with its value containing "dev".

string filter = 4;

Parameter
Name Description
value String

The filter to set.
Returns
Type Description
ListInstancesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListInstancesRequest.Builder setFilterBytes(ByteString value)

An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

  • name
  • display_name

  • labels.key where key is the name of a label

    Some examples of using filters are:

  • name:* --> The instance has a name.

  • name:Howl --> The instance's name contains the string "howl".
  • name:HOWL --> Equivalent to above.
  • NAME:howl --> Equivalent to above.
  • labels.env:* --> The instance has the label "env".
  • labels.env:dev --> The instance has the label "env" and the value of the label contains the string "dev".
  • name:howl labels.env:dev --> The instance's name contains "howl" and it has the label "env" with its value containing "dev".

string filter = 4;

Parameter
Name Description
value ByteString

The bytes for filter to set.
Returns
Type Description
ListInstancesRequest.Builder

This builder for chaining.

setInstanceDeadline(Timestamp value)

public ListInstancesRequest.Builder setInstanceDeadline(Timestamp value)

Deadline used while retrieving metadata for instances. Instances whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancesResponse.

.google.protobuf.Timestamp instance_deadline = 5;

Parameter
Name Description
value Timestamp
Returns
Type Description
ListInstancesRequest.Builder

setInstanceDeadline(Timestamp.Builder builderForValue)

public ListInstancesRequest.Builder setInstanceDeadline(Timestamp.Builder builderForValue)

Deadline used while retrieving metadata for instances. Instances whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancesResponse.

.google.protobuf.Timestamp instance_deadline = 5;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ListInstancesRequest.Builder

setPageSize(int value)

public ListInstancesRequest.Builder setPageSize(int value)

Number of instances 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
ListInstancesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListInstancesRequest.Builder setPageToken(String value)

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

string page_token = 3;

Parameter
Name Description
value String

The pageToken to set.
Returns
Type Description
ListInstancesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListInstancesRequest.Builder setPageTokenBytes(ByteString value)

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

string page_token = 3;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.
Returns
Type Description
ListInstancesRequest.Builder

This builder for chaining.

setParent(String value)

public ListInstancesRequest.Builder setParent(String value)

Required. The name of the project for which a list of instances is requested. Values are of the form projects/<project>.

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

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
ListInstancesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListInstancesRequest.Builder setParentBytes(ByteString value)

Required. The name of the project for which a list of instances is requested. Values are of the form projects/<project>.

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

Parameter
Name Description
value ByteString

The bytes for parent to set.
Returns
Type Description
ListInstancesRequest.Builder

This builder for chaining.

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

public ListInstancesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListInstancesRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

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