Method: googleapis.secretmanager.v1.projects.secrets.

Updates metadata of an existing Secret.

Arguments

Parameters
name

string

Required. Output only. The resource name of the Secret in the format projects/*/secrets/*.

updateMask

string (FieldMask format)

Required. Specifies the fields to be updated.

body

object (Secret)

Required.

Raised exceptions

Exceptions
ConnectionErrorIn case of a network problem (such as DNS failure or refused connection).
HttpErrorIf the response status is >= 400 (excluding 429 and 503).
TimeoutErrorIf a long-running operation takes longer to finish than the specified timeout limit.
TypeErrorIf an operation or function receives an argument of the wrong type.
ValueErrorIf 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 Secret.

Subworkflow snippet

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

YAML

- :
    call: googleapis.secretmanager.v1.projects.secrets.
    args:
        name: ...
        updateMask: ...
        body:
            etag: ...
            expireTime: ...
            labels: ...
            replication:
                automatic:
                    customerManagedEncryption:
                        kmsKeyName: ...
                userManaged:
                    replicas: ...
            rotation:
                nextRotationTime: ...
                rotationPeriod: ...
            topics: ...
            ttl: ...
    result: Result

JSON

[
  {
    "": {
      "call": "googleapis.secretmanager.v1.projects.secrets.",
      "args": {
        "name": "...",
        "updateMask": "...",
        "body": {
          "etag": "...",
          "expireTime": "...",
          "labels": "...",
          "replication": {
            "automatic": {
              "customerManagedEncryption": {
                "kmsKeyName": "..."
              }
            },
            "userManaged": {
              "replicas": "..."
            }
          },
          "rotation": {
            "nextRotationTime": "...",
            "rotationPeriod": "..."
          },
          "topics": "...",
          "ttl": "..."
        }
      },
      "result": "Result"
    }
  }
]