tagValues

PATCH /v3/tagValues/{tagValuesId}

Updates the attributes of the TagValue resource.

Request

  • Base URL
    https://cloudresourcemanager.googleapis.com
  • URL
    https://cloudresourcemanager.googleapis.com/v3/tagValues/{tagValuesId}
  • Auth
    OAuth 2 and OAuth 2
    Implicit: https://accounts.google.com/o/oauth2/auth
    Scopes: https://www.googleapis.com/auth/cloud-platform
    Authorization code: https://accounts.google.com/o/oauth2/auth
    Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform

Path parameters

tagValuesIdstring required

Query parameters

updateMaskstring google-fieldmask

Optional. Fields to be updated.

validateOnlyboolean

Optional. True to perform validations necessary for updating the resource, but not actually perform the action.

Request body

createTimestring google-datetime

Output only. Creation time.

descriptionstring

Optional. User-assigned description of the TagValue. Must not exceed 256 characters. Read-write.

etagstring

Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagValueRequest for details.

namestring

Immutable. Resource name for TagValue in the format tagValues/456.

namespacedNamestring

Output only. The namespaced name of the TagValue. Can be in the form {organization_id}/{tag_key_short_name}/{tag_value_short_name} or {project_id}/{tag_key_short_name}/{tag_value_short_name} or {project_number}/{tag_key_short_name}/{tag_value_short_name}.

parentstring

Immutable. The resource name of the new TagValue's parent TagKey. Must be of the form tagKeys/{tag_key_id}.

shortNamestring

Required. Immutable. User-assigned short name for TagValue. The short name should be unique for TagValues within the same parent TagKey. The short name must be 256 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.

updateTimestring google-datetime

Output only. Update time.

Response

Successful response

doneboolean

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

metadataobject

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

namestring

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

responseobject

The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

Changes

No recorded changes to this operation across all 7 revisions of this API.