Class Secret (2.12.2)

Secret(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A Secret is a logical secret whose value and versions can be accessed.

A Secret is made up of zero or more SecretVersions that represent the secret data.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

NameDescription
name str
Output only. The resource name of the Secret in the format ``projects/*/secrets/*``.
replication google.cloud.secretmanager_v1.types.Replication
Required. Immutable. The replication policy of the secret data attached to the Secret. The replication policy cannot be changed after the Secret has been created.
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. The time at which the Secret was created.
labels Mapping[str, str]
The labels assigned to this Secret. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: ``[\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}`` Label values must be between 0 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: ``[\p{Ll}\p{Lo}\p{N}_-]{0,63}`` No more than 64 labels can be assigned to a given resource.
topics Sequence[google.cloud.secretmanager_v1.types.Topic]
Optional. A list of up to 10 Pub/Sub topics to which messages are published when control plane operations are called on the secret or its versions.
expire_time google.protobuf.timestamp_pb2.Timestamp
Optional. Timestamp in UTC when the Secret is scheduled to expire. This is always provided on output, regardless of what was sent on input. This field is a member of `oneof`_ ``expiration``.
ttl google.protobuf.duration_pb2.Duration
Input only. The TTL for the Secret. This field is a member of `oneof`_ ``expiration``.
etag str
Optional. Etag of the currently stored Secret.
rotation google.cloud.secretmanager_v1.types.Rotation
Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy.
version_aliases Mapping[str, int]
Optional. Mapping from version alias to version name. A version alias is a string with a maximum length of 63 characters and can contain uppercase and lowercase letters, numerals, and the hyphen (``-``) and underscore ('_') characters. An alias string must start with a letter and cannot be the string 'latest' or 'NEW'. No more than 50 aliases can be assigned to a given secret. Version-Alias pairs will be viewable via GetSecret and modifiable via UpdateSecret. At launch access by alias will only be supported on GetSecretVersion and AccessSecretVersion.

Inheritance

builtins.object > proto.message.Message > Secret

Classes

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
NameDescription
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, `.Message`]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

VersionAliasesEntry

VersionAliasesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
NameDescription
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, `.Message`]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.