Google Cloud AlloyDB for PostgreSQL V1alpha Client - Class ListInstancesRequest (0.1.3)

Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1alpha Client class ListInstancesRequest.

Message for requesting list of Instances

Generated from protobuf message google.cloud.alloydb.v1alpha.ListInstancesRequest

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent 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/-

↳ page_size int

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

↳ page_token string

A token identifying a page of results the server should return.

↳ filter string

Optional. Filtering results

↳ order_by string

Optional. Hint for how to order the results

getParent

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
TypeDescription
string

setParent

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/-
Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

Returns
TypeDescription
int

setPageSize

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

A token identifying a page of results the server should return.

Returns
TypeDescription
string

setPageToken

A token identifying a page of results the server should return.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFilter

Optional. Filtering results

Returns
TypeDescription
string

setFilter

Optional. Filtering results

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOrderBy

Optional. Hint for how to order the results

Returns
TypeDescription
string

setOrderBy

Optional. Hint for how to order the results

Parameter
NameDescription
var string
Returns
TypeDescription
$this