Reference documentation and code samples for the Google Cloud Ftp V1 Client class ListUsersRequest.
Message for requesting list of Users
Generated from protobuf message google.cloud.ftp.v1.ListUsersRequest
Namespace
Google \ Cloud \ Ftp \ V1Methods
__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. User may return fewer items than requested. The maximum value is 1000; The default value is 50 if the field is omitted (or set to 0). |
↳ page_token |
string
Optional. A token identifying a page of results the user should return. |
↳ filter |
string
Optional. Filtering results |
↳ order_by |
string
Optional. Hint for how to order the results |
↳ view |
int
Optional. The view of the User resource to return. |
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. User may return fewer items than requested.
The maximum value is 1000; The default value is 50 if the field is omitted (or set to 0).
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
Optional. Requested page size. User may return fewer items than requested.
The maximum value is 1000; The default value is 50 if the field is omitted (or set to 0).
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
Optional. A token identifying a page of results the user should return.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
Optional. A token identifying a page of results the user 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 |
|
getView
Optional. The view of the User resource to return.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type UserView. |
setView
Optional. The view of the User resource to return.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type UserView. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. Parent value for ListUsersRequest Please see CloudFtpClient::serverName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
ListUsersRequest |
|