Google Cloud AlloyDB for PostgreSQL V1 Client - Class ListUsersRequest (1.1.2)

Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class ListUsersRequest.

Message for requesting list of Users

Generated from protobuf message google.cloud.alloydb.v1.ListUsersRequest

Namespace

Google \ Cloud \ AlloyDb \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. Parent value for ListUsersRequest

↳ 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

Optional. 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. Parent value for ListUsersRequest

Returns
Type Description
string

setParent

Required. Parent value for ListUsersRequest

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

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

Returns
Type Description
int

setPageSize

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

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

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

Returns
Type Description
string

setPageToken

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

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. Filtering results

Returns
Type Description
string

setFilter

Optional. Filtering results

Parameter
Name Description
var string
Returns
Type Description
$this

getOrderBy

Optional. Hint for how to order the results

Returns
Type Description
string

setOrderBy

Optional. Hint for how to order the results

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. Parent value for ListUsersRequest Please see AlloyDBAdminClient::clusterName() for help formatting this field.

Returns
Type Description
ListUsersRequest