1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Storagetransfer
  7. \
  8. Resource
  9. \
  10. ProjectsAgentPools

ProjectsAgentPools

class ProjectsAgentPools extends Resource (View source)

The "agentPools" collection of methods.

Typical usage is:

 $storagetransferService = new Google\Service\Storagetransfer(...);
 $agentPools = $storagetransferService->projects_agentPools;

Methods

AgentPool
create(string $projectId, AgentPool $postBody, array $optParams = [])

Creates an agent pool resource. (agentPools.create)

StoragetransferEmpty
delete(string $name, array $optParams = [])

Deletes an agent pool. (agentPools.delete)

AgentPool
get(string $name, array $optParams = [])

Gets an agent pool. (agentPools.get)

ListAgentPoolsResponse
listProjectsAgentPools(string $projectId, array $optParams = [])

Lists agent pools. (agentPools.listProjectsAgentPools)

AgentPool
patch(string $name, AgentPool $postBody, array $optParams = [])

Updates an existing agent pool resource. (agentPools.patch)

Details

at line 53
AgentPool create(string $projectId, AgentPool $postBody, array $optParams = [])

Creates an agent pool resource. (agentPools.create)

Parameters

string $projectId

Required. The ID of the Google Cloud project that owns the agent pool.
AgentPool $postBody
array $optParams

Optional parameters.

Return Value

AgentPool

Exceptions

Exception

at line 67
StoragetransferEmpty delete(string $name, array $optParams = [])

Deletes an agent pool. (agentPools.delete)

Parameters

string $name

Required. The name of the agent pool to delete.
array $optParams

Optional parameters.

Return Value

StoragetransferEmpty

Exceptions

Exception

at line 81
AgentPool get(string $name, array $optParams = [])

Gets an agent pool. (agentPools.get)

Parameters

string $name

Required. The name of the agent pool to get.
array $optParams

Optional parameters.

Return Value

AgentPool

Exceptions

Exception

at line 105
ListAgentPoolsResponse listProjectsAgentPools(string $projectId, array $optParams = [])

Lists agent pools. (agentPools.listProjectsAgentPools)

Parameters

string $projectId

Required. The ID of the Google Cloud project that owns the job.
array $optParams

Optional parameters.

Return Value

ListAgentPoolsResponse

Exceptions

Exception

at line 127
AgentPool patch(string $name, AgentPool $postBody, array $optParams = [])

Updates an existing agent pool resource. (agentPools.patch)

Parameters

string $name

Required. Specifies a unique string that identifies the agent pool. Format: projects/{project_id}/agentPools/{agent_pool_id}
AgentPool $postBody
array $optParams

Optional parameters.

Return Value

AgentPool

Exceptions

Exception