AlloyDB V1 API - Class Google::Cloud::AlloyDB::V1::ListInstancesRequest (v0.9.1)

Reference documentation and code samples for the AlloyDB V1 API class Google::Cloud::AlloyDB::V1::ListInstancesRequest.

Message for requesting list of Instances

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns
  • (::String) — Optional. Filtering results

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) — Optional. Filtering results
Returns
  • (::String) — Optional. Filtering results

#order_by

def order_by() -> ::String
Returns
  • (::String) — Optional. Hint for how to order the results

#order_by=

def order_by=(value) -> ::String
Parameter
  • value (::String) — Optional. Hint for how to order the results
Returns
  • (::String) — Optional. Hint for how to order the results

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Returns
  • (::Integer) — Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

#page_token

def page_token() -> ::String
Returns
  • (::String) — A token identifying a page of results the server should return.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — A token identifying a page of results the server should return.
Returns
  • (::String) — A token identifying a page of results the server should return.

#parent

def parent() -> ::String
Returns
  • (::String) —

    Required. The name of the parent resource. For the required format, see the comment on the Instance.name field. Additionally, you can perform an aggregated list operation by specifying a value with one of the following formats:

    • projects/{project}/locations/-/clusters/-
    • projects/{project}/locations/{region}/clusters/-

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) —

    Required. The name of the parent resource. For the required format, see the comment on the Instance.name field. Additionally, you can perform an aggregated list operation by specifying a value with one of the following formats:

    • projects/{project}/locations/-/clusters/-
    • projects/{project}/locations/{region}/clusters/-
Returns
  • (::String) —

    Required. The name of the parent resource. For the required format, see the comment on the Instance.name field. Additionally, you can perform an aggregated list operation by specifying a value with one of the following formats:

    • projects/{project}/locations/-/clusters/-
    • projects/{project}/locations/{region}/clusters/-