Reference documentation and code samples for the Google Cloud Storage Transfer V1 Client class CreateAgentPoolRequest.
Specifies the request passed to CreateAgentPool.
Generated from protobuf message google.storagetransfer.v1.CreateAgentPoolRequest
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 agent pool. |
↳ agent_pool |
Google\Cloud\StorageTransfer\V1\AgentPool
Required. The agent pool to create. |
↳ agent_pool_id |
string
Required. The ID of the agent pool to create. The |
getProjectId
Required. The ID of the Google Cloud project that owns the agent pool.
Returns | |
---|---|
Type | Description |
string |
setProjectId
Required. The ID of the Google Cloud project that owns the agent pool.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getAgentPool
Required. The agent pool to create.
Returns | |
---|---|
Type | Description |
Google\Cloud\StorageTransfer\V1\AgentPool|null |
hasAgentPool
clearAgentPool
setAgentPool
Required. The agent pool to create.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\StorageTransfer\V1\AgentPool
|
Returns | |
---|---|
Type | Description |
$this |
getAgentPoolId
Required. The ID of the agent pool to create.
The agent_pool_id
must meet the following requirements:
- Length of 128 characters or less.
- Not start with the string
goog
. - Start with a lowercase ASCII character, followed by:
- Zero or more: lowercase Latin alphabet characters, numerals,
hyphens (
-
), periods (.
), underscores (_
), or tildes (~
). - One or more numerals or lowercase ASCII characters.
As expressed by the regular expression:
^(?!goog)[a-z]([a-z0-9-._~]*[a-z0-9])?$
.
- Zero or more: lowercase Latin alphabet characters, numerals,
hyphens (
Returns | |
---|---|
Type | Description |
string |
setAgentPoolId
Required. The ID of the agent pool to create.
The agent_pool_id
must meet the following requirements:
- Length of 128 characters or less.
- Not start with the string
goog
. - Start with a lowercase ASCII character, followed by:
- Zero or more: lowercase Latin alphabet characters, numerals,
hyphens (
-
), periods (.
), underscores (_
), or tildes (~
). - One or more numerals or lowercase ASCII characters.
As expressed by the regular expression:
^(?!goog)[a-z]([a-z0-9-._~]*[a-z0-9])?$
.
- Zero or more: lowercase Latin alphabet characters, numerals,
hyphens (
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
static::build
Parameters | |
---|---|
Name | Description |
projectId |
string
Required. The ID of the Google Cloud project that owns the agent pool. |
agentPool |
Google\Cloud\StorageTransfer\V1\AgentPool
Required. The agent pool to create. |
agentPoolId |
string
Required. The ID of the agent pool to create. The
As expressed by the regular expression:
|
Returns | |
---|---|
Type | Description |
Google\Cloud\StorageTransfer\V1\CreateAgentPoolRequest |