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

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

setParent

Required. Parent value for ListUsersRequest

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

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

Returns
TypeDescription
string

setPageToken

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

static::build

Parameter
NameDescription
parent string

Required. Parent value for ListUsersRequest Please see Google\Cloud\AlloyDb\V1\AlloyDBAdminClient::clusterName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\AlloyDb\V1\ListUsersRequest