agent_pools

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

Overview

Name	agent_pools
Type	Resource
Id	google.storagetransfer.agent_pools

Fields

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 a bandwidth limit for an agent pool.
displayName	string	Specifies the client-specified AgentPool description.
state	string	Output only. Specifies the state of the AgentPool.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	agentPoolsId, projectsId	Gets an agent pool.
list	SELECT	projectsId	Lists agent pools.
create	INSERT	projectsId	Creates an agent pool resource.
delete	DELETE	agentPoolsId, projectsId	Deletes an agent pool.
patch	UPDATE	agentPoolsId, projectsId	Updates an existing agent pool resource.

SELECT examples

Lists agent pools.

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

INSERT example

Use the following StackQL query and manifest file to create a new agent_pools resource.

All Properties

/*+ create */
INSERT INTO google.storagetransfer.agent_pools (
projectsId,
name,
displayName,
bandwidthLimit
)
SELECT 
'{{ projectsId }}',
'{{ name }}',
'{{ displayName }}',
'{{ bandwidthLimit }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: displayName
      value: string
    - name: state
      value: string
    - name: bandwidthLimit
      value:
        - name: limitMbps
          value: string

UPDATE example

Updates a agent_pools resource.

/*+ update */
UPDATE google.storagetransfer.agent_pools
SET 
name = '{{ name }}',
displayName = '{{ displayName }}',
bandwidthLimit = '{{ bandwidthLimit }}'
WHERE 
agentPoolsId = '{{ agentPoolsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified agent_pools resource.

/*+ delete */
DELETE FROM google.storagetransfer.agent_pools
WHERE agentPoolsId = '{{ agentPoolsId }}'
AND projectsId = '{{ projectsId }}';