Cloud Spanner Instance Admin V1 API - Class Google::Cloud::Spanner::Admin::Instance::V1::ListInstancesRequest (v2.3.0)

Reference documentation and code samples for the Cloud Spanner Instance Admin V1 API class Google::Cloud::Spanner::Admin::Instance::V1::ListInstancesRequest.

The request for ListInstances.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String

Returns

(::String) —
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".

#filter=

def filter=(value) -> ::String

Parameter

value (::String) —
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".

Returns

(::String) —
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".

#instance_deadline

def instance_deadline() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Deadline used while retrieving metadata for instances. Instances whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancesResponse.

#instance_deadline=

def instance_deadline=(value) -> ::Google::Protobuf::Timestamp

Parameter

value (::Google::Protobuf::Timestamp) — Deadline used while retrieving metadata for instances. Instances whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancesResponse.

Returns

(::Google::Protobuf::Timestamp) — Deadline used while retrieving metadata for instances. Instances whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancesResponse.

#page_size

def page_size() -> ::Integer

Returns

(::Integer) — Number of instances to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

#page_size=

def page_size=(value) -> ::Integer

Parameter

value (::Integer) — Number of instances to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

Returns

(::Integer) — Number of instances to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

#page_token

def page_token() -> ::String

Returns

(::String) — If non-empty, page_token should contain a next_page_token from a previous ListInstancesResponse.

#page_token=

def page_token=(value) -> ::String

Parameter

value (::String) — If non-empty, page_token should contain a next_page_token from a previous ListInstancesResponse.

Returns

(::String) — If non-empty, page_token should contain a next_page_token from a previous ListInstancesResponse.

#parent

def parent() -> ::String

Returns

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

#parent=

def parent=(value) -> ::String

Parameter

value (::String) — Required. The name of the project for which a list of instances is requested. Values are of the form projects/<project>.

Returns

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