Method: googleapis.storage.v1.objects.patch

Patches an object's metadata.

Arguments

Parameters
bucket

string

Required. Name of the bucket in which the object resides.

object

string

Required. Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

generation

string (int64 format)

If present, selects a specific revision of this object (as opposed to the latest version, the default).

ifGenerationMatch

string (int64 format)

Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.

ifGenerationNotMatch

string (int64 format)

Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.

ifMetagenerationMatch

string (int64 format)

Makes the operation conditional on whether the object's current metageneration matches the given value.

ifMetagenerationNotMatch

string (int64 format)

Makes the operation conditional on whether the object's current metageneration does not match the given value.

predefinedAcl

enum

Apply a predefined set of access controls to this object.

Enum type. Can be one of the following:
authenticatedRead Object owner gets OWNER access, and allAuthenticatedUsers get READER access.
bucketOwnerFullControl Object owner gets OWNER access, and project team owners get OWNER access.
bucketOwnerRead Object owner gets OWNER access, and project team owners get READER access.
private Object owner gets OWNER access.
projectPrivate Object owner gets OWNER access, and project team members get access according to their roles.
publicRead Object owner gets OWNER access, and allUsers get READER access.
projection

enum

Set of properties to return. Defaults to full.

Enum type. Can be one of the following:
full Include all properties.
noAcl Omit the owner, acl property.
userProject

string

The project to be billed for this request, for Requester Pays buckets.

body

object (Object)

Required.

Raised exceptions

Exceptions
ConnectionError In case of a network problem (such as DNS failure or refused connection).
HttpError If the response status is >= 400 (excluding 429 and 503).
TimeoutError If a long-running operation takes longer to finish than the specified timeout limit.
TypeError If an operation or function receives an argument of the wrong type.
ValueError If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of Object.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- patch:
    call: googleapis.storage.v1.objects.patch
    args:
        bucket: ...
        object: ...
        generation: ...
        ifGenerationMatch: ...
        ifGenerationNotMatch: ...
        ifMetagenerationMatch: ...
        ifMetagenerationNotMatch: ...
        predefinedAcl: ...
        projection: ...
        userProject: ...
        body:
            acl: ...
            bucket: ...
            cacheControl: ...
            componentCount: ...
            contentDisposition: ...
            contentEncoding: ...
            contentLanguage: ...
            contentType: ...
            crc32c: ...
            customTime: ...
            customerEncryption:
                encryptionAlgorithm: ...
                keySha256: ...
            etag: ...
            eventBasedHold: ...
            generation: ...
            id: ...
            kind: ...
            kmsKeyName: ...
            md5Hash: ...
            mediaLink: ...
            metadata: ...
            metageneration: ...
            name: ...
            owner:
                entity: ...
                entityId: ...
            retentionExpirationTime: ...
            selfLink: ...
            size: ...
            storageClass: ...
            temporaryHold: ...
            timeCreated: ...
            timeDeleted: ...
            timeStorageClassUpdated: ...
            updated: ...
    result: patchResult

JSON

[
  {
    "patch": {
      "call": "googleapis.storage.v1.objects.patch",
      "args": {
        "bucket": "...",
        "object": "...",
        "generation": "...",
        "ifGenerationMatch": "...",
        "ifGenerationNotMatch": "...",
        "ifMetagenerationMatch": "...",
        "ifMetagenerationNotMatch": "...",
        "predefinedAcl": "...",
        "projection": "...",
        "userProject": "...",
        "body": {
          "acl": "...",
          "bucket": "...",
          "cacheControl": "...",
          "componentCount": "...",
          "contentDisposition": "...",
          "contentEncoding": "...",
          "contentLanguage": "...",
          "contentType": "...",
          "crc32c": "...",
          "customTime": "...",
          "customerEncryption": {
            "encryptionAlgorithm": "...",
            "keySha256": "..."
          },
          "etag": "...",
          "eventBasedHold": "...",
          "generation": "...",
          "id": "...",
          "kind": "...",
          "kmsKeyName": "...",
          "md5Hash": "...",
          "mediaLink": "...",
          "metadata": "...",
          "metageneration": "...",
          "name": "...",
          "owner": {
            "entity": "...",
            "entityId": "..."
          },
          "retentionExpirationTime": "...",
          "selfLink": "...",
          "size": "...",
          "storageClass": "...",
          "temporaryHold": "...",
          "timeCreated": "...",
          "timeDeleted": "...",
          "timeStorageClassUpdated": "...",
          "updated": "..."
        }
      },
      "result": "patchResult"
    }
  }
]