agent_pools

Creates, updates, deletes, gets or lists an agent_pools resource.

Overview

Name	agent_pools
Type	Resource
Id	google.storagetransfer.agent_pools

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Required. Specifies a unique string that identifies the agent pool. Format: projects/{project_id}/agentPools/{agent_pool_id}
bandwidthLimit	object	Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'. (id: BandwidthLimit)
displayName	string	Specifies the client-specified AgentPool description.
state	string	Output only. Specifies the state of the AgentPool.

list

Successful response

Name	Datatype	Description
name	string	Required. Specifies a unique string that identifies the agent pool. Format: projects/{project_id}/agentPools/{agent_pool_id}
bandwidthLimit	object	Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'. (id: BandwidthLimit)
displayName	string	Specifies the client-specified AgentPool description.
state	string	Output only. Specifies the state of the AgentPool.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, agentPoolsId		Gets an agent pool.
list	select	projectsId	filter, pageSize, pageToken	Lists agent pools.
create	insert	projectsId	agentPoolId	Creates an agent pool resource.
patch	update	projectsId, agentPoolsId	updateMask	Updates an existing agent pool resource.
delete	delete	projectsId, agentPoolsId		Deletes an agent pool.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
agentPoolsId	string
projectsId	string
agentPoolId	string
filter	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets an agent pool.

SELECT
name,
bandwidthLimit,
displayName,
state
FROM google.storagetransfer.agent_pools
WHERE projectsId = '{{ projectsId }}' -- required
AND agentPoolsId = '{{ agentPoolsId }}' -- required;

list

Lists agent pools.

SELECT
name,
bandwidthLimit,
displayName,
state
FROM google.storagetransfer.agent_pools
WHERE projectsId = '{{ projectsId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

create

Creates an agent pool resource.

INSERT INTO google.storagetransfer.agent_pools (
data__name,
data__displayName,
data__bandwidthLimit,
projectsId,
agentPoolId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ bandwidthLimit }}',
'{{ projectsId }}',
'{{ agentPoolId }}'
RETURNING
name,
bandwidthLimit,
displayName,
state
;

Manifest

# Description fields are for documentation purposes
- name: agent_pools
  props:
    - name: projectsId
      value: string
      description: Required parameter for the agent_pools resource.
    - name: name
      value: string
      description: >
        Required. Specifies a unique string that identifies the agent pool. Format: `projects/{project_id}/agentPools/{agent_pool_id}`
        
    - name: displayName
      value: string
      description: >
        Specifies the client-specified AgentPool description.
        
    - name: bandwidthLimit
      value: object
      description: >
        Specifies the bandwidth limit details. If this field is unspecified, the default value is set as 'No Limit'.
        
    - name: agentPoolId
      value: string

UPDATE examples

patch

Updates an existing agent pool resource.

UPDATE google.storagetransfer.agent_pools
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__bandwidthLimit = '{{ bandwidthLimit }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND agentPoolsId = '{{ agentPoolsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
bandwidthLimit,
displayName,
state;

DELETE examples

delete

Deletes an agent pool.

DELETE FROM google.storagetransfer.agent_pools
WHERE projectsId = '{{ projectsId }}' --required
AND agentPoolsId = '{{ agentPoolsId }}' --required;