Method: googleapis.storage.v1.buckets.lockRetentionPolicy

Locks retention policy on a bucket.

Arguments

Parameters
bucket	string Required. Name of a bucket.
ifMetagenerationMatch	string (int64 format) Makes the operation conditional on whether bucket's current metageneration matches 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 contains an instance of Bucket.

Subworkflow snippet

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

YAML

- lockRetentionPolicy:
    call: googleapis.storage.v1.buckets.lockRetentionPolicy
    args:
        bucket: ...
        ifMetagenerationMatch: ...
        userProject: ...
    result: lockRetentionPolicyResult

JSON

[
  {
    "lockRetentionPolicy": {
      "call": "googleapis.storage.v1.buckets.lockRetentionPolicy",
      "args": {
        "bucket": "...",
        "ifMetagenerationMatch": "...",
        "userProject": "..."
      },
      "result": "lockRetentionPolicyResult"
    }
  }
]