Method: projects.agentPools.patch

Stay organized with collections Save and categorize content based on your preferences.

Updates an existing agent pool resource.

HTTP request

PATCH https://storagetransfer.googleapis.com/v1/{agentPool.name=projects/*/agentPools/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
agentPool.name

string

Required. Specifies a unique string that identifies the agent pool.

Format: projects/{projectId}/agentPools/{agentPoolId}

Query parameters

Parameters
updateMask

string (FieldMask format)

The field mask of the fields in agentPool to update in this request. The following agentPool fields can be updated:

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of AgentPool.

Response body

If successful, the response body contains an instance of AgentPool.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.