Method: googleapis.storage.v1.objects.delete

Note: You should URL-encode object names to be path safe. You can use the url_encode function to return a string with percent-encoded reserved characters, including spaces. For more information, see Encoding URI path parts.

Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used.

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, permanently deletes 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.
userProject	string The project to be billed for this request. Required for Requester Pays buckets.

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 will be empty.

Subworkflow snippet

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

YAML

- delete:
    call: googleapis.storage.v1.objects.delete
    args:
        bucket: ...
        object: ...
        generation: ...
        ifGenerationMatch: ...
        ifGenerationNotMatch: ...
        ifMetagenerationMatch: ...
        ifMetagenerationNotMatch: ...
        userProject: ...
    result: deleteResult

JSON

[
  {
    "delete": {
      "call": "googleapis.storage.v1.objects.delete",
      "args": {
        "bucket": "...",
        "object": "...",
        "generation": "...",
        "ifGenerationMatch": "...",
        "ifGenerationNotMatch": "...",
        "ifMetagenerationMatch": "...",
        "ifMetagenerationNotMatch": "...",
        "userProject": "..."
      },
      "result": "deleteResult"
    }
  }
]