Reference documentation and code samples for the Google Cloud Eventarc V1 Client class ListChannelsRequest.
The request message for the ListChannels method.
Generated from protobuf message google.cloud.eventarc.v1.ListChannelsRequest
Namespace
Google \ Cloud \ Eventarc \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent collection to list channels on. |
↳ page_size |
int
The maximum number of channels to return on each page. Note: The service may send fewer. |
↳ page_token |
string
The page token; provide the value from the |
↳ order_by |
string
The sorting order of the resources returned. Value should be a comma-separated list of fields. The default sorting order is ascending. To specify descending order for a field, append a |
getParent
Required. The parent collection to list channels on.
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The parent collection to list channels on.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageSize
The maximum number of channels to return on each page.
Note: The service may send fewer.
| Returns | |
|---|---|
| Type | Description |
int | |
setPageSize
The maximum number of channels to return on each page.
Note: The service may send fewer.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageToken
The page token; provide the value from the next_page_token field in a
previous ListChannels call to retrieve the subsequent page.
When paginating, all other parameters provided to ListChannels must
match the call that provided the page token.
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
The page token; provide the value from the next_page_token field in a
previous ListChannels call to retrieve the subsequent page.
When paginating, all other parameters provided to ListChannels must
match the call that provided the page token.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOrderBy
The sorting order of the resources returned. Value should be a
comma-separated list of fields. The default sorting order is ascending. To
specify descending order for a field, append a desc suffix; for example:
name desc, channel_id.
| Returns | |
|---|---|
| Type | Description |
string | |
setOrderBy
The sorting order of the resources returned. Value should be a
comma-separated list of fields. The default sorting order is ascending. To
specify descending order for a field, append a desc suffix; for example:
name desc, channel_id.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The parent collection to list channels on. Please see Google\Cloud\Eventarc\V1\EventarcClient::locationName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Eventarc\V1\ListChannelsRequest | |