Reference documentation and code samples for the Google Cloud Storage Transfer V1 Client class ListAgentPoolsRequest.
The request passed to ListAgentPools.
Generated from protobuf message google.storagetransfer.v1.ListAgentPoolsRequest
Namespace
Google \ Cloud \ StorageTransfer \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ project_id |
string
Required. The ID of the Google Cloud project that owns the job. |
↳ filter |
string
An optional list of query parameters specified as JSON text in the form of: |
↳ page_size |
int
The list page size. The max allowed value is |
↳ page_token |
string
The list page token. |
getProjectId
Required. The ID of the Google Cloud project that owns the job.
| Returns | |
|---|---|
| Type | Description |
string | |
setProjectId
Required. The ID of the Google Cloud project that owns the job.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFilter
An optional list of query parameters specified as JSON text in the
form of:
{"agentPoolNames":["agentpool1","agentpool2",...]}
Since agentPoolNames support multiple values, its values must be
specified with array notation. When the filter is either empty or not
provided, the list returns all agent pools for the project.
| Returns | |
|---|---|
| Type | Description |
string | |
setFilter
An optional list of query parameters specified as JSON text in the
form of:
{"agentPoolNames":["agentpool1","agentpool2",...]}
Since agentPoolNames support multiple values, its values must be
specified with array notation. When the filter is either empty or not
provided, the list returns all agent pools for the project.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageSize
The list page size. The max allowed value is 256.
| Returns | |
|---|---|
| Type | Description |
int | |
setPageSize
The list page size. The max allowed value is 256.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageToken
The list page token.
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
The list page token.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameter | |
|---|---|
| Name | Description |
projectId |
string
Required. The ID of the Google Cloud project that owns the job. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\StorageTransfer\V1\ListAgentPoolsRequest | |