Reference documentation and code samples for the Google Cloud Vm Migration V1 Client class ListGroupsRequest.
Request message for 'ListGroups' request.
Generated from protobuf message google.cloud.vmmigration.v1.ListGroupsRequest
Namespace
Google \ Cloud \ VMMigration \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent, which owns this collection of groups. |
↳ page_size |
int
Optional. The maximum number of groups to return. The service may return fewer than this value. If unspecified, at most 500 groups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
↳ page_token |
string
Required. A page token, received from a previous |
↳ filter |
string
Optional. The filter request. |
↳ order_by |
string
Optional. the order by fields for the result. |
getParent
Required. The parent, which owns this collection of groups.
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The parent, which owns this collection of groups.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
Optional. The maximum number of groups to return. The service may return fewer than this value. If unspecified, at most 500 groups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
Optional. The maximum number of groups to return. The service may return fewer than this value. If unspecified, at most 500 groups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
Required. A page token, received from a previous ListGroups call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListGroups must
match the call that provided the page token.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
Required. A page token, received from a previous ListGroups call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListGroups must
match the call that provided the page token.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilter
Optional. The filter request.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
Optional. The filter request.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOrderBy
Optional. the order by fields for the result.
| Returns | |
|---|---|
| Type | Description |
string |
|
setOrderBy
Optional. the order by fields for the result.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The parent, which owns this collection of groups. Please see Google\Cloud\VMMigration\V1\VmMigrationClient::locationName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\VMMigration\V1\ListGroupsRequest |
|