# Secret Manager v1 API - Class Secret (2.7.0)

<button class="button button-with-icon cloud-select-dropdown__button " aria-haspopup="true">Version latest</button>

- [2.7.0 (latest)](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecretManager.V1/latest/Google.Cloud.SecretManager.V1.Secret)
- [2.6.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecretManager.V1/2.6.0/Google.Cloud.SecretManager.V1.Secret)
- [2.5.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecretManager.V1/2.5.0/Google.Cloud.SecretManager.V1.Secret)
- [2.4.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecretManager.V1/2.4.0/Google.Cloud.SecretManager.V1.Secret)
- [2.3.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecretManager.V1/2.3.0/Google.Cloud.SecretManager.V1.Secret)
- [2.2.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecretManager.V1/2.2.0/Google.Cloud.SecretManager.V1.Secret)
- [2.1.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecretManager.V1/2.1.0/Google.Cloud.SecretManager.V1.Secret)
- [2.0.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecretManager.V1/2.0.0/Google.Cloud.SecretManager.V1.Secret)
- [1.9.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecretManager.V1/1.9.0/Google.Cloud.SecretManager.V1.Secret)
- [1.8.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecretManager.V1/1.8.0/Google.Cloud.SecretManager.V1.Secret)
- [1.7.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecretManager.V1/1.7.0/Google.Cloud.SecretManager.V1.Secret)
- [1.6.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecretManager.V1/1.6.0/Google.Cloud.SecretManager.V1.Secret)
- [1.5.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecretManager.V1/1.5.0/Google.Cloud.SecretManager.V1.Secret)
- [1.4.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecretManager.V1/1.4.0/Google.Cloud.SecretManager.V1.Secret)
- [1.3.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecretManager.V1/1.3.0/Google.Cloud.SecretManager.V1.Secret)

    public sealed class Secret : IMessage<Secret>, IEquatable<Secret>, IDeepCloneable<Secret>, IBufferMessage, IMessage

Reference documentation and code samples for the Secret Manager v1 API class Secret.

A \[Secret\]\[google.cloud.secretmanager.v1.Secret\] is a logical secret whose
value and versions can be accessed.

A \[Secret\]\[google.cloud.secretmanager.v1.Secret\] is made up of zero or more
\[SecretVersions\]\[google.cloud.secretmanager.v1.SecretVersion\] that represent
the secret data.

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> Secret

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[Secret](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecretManager.V1/latest/Google.Cloud.SecretManager.V1.Secret), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[Secret](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecretManager.V1/latest/Google.Cloud.SecretManager.V1.Secret), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[Secret](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecretManager.V1/latest/Google.Cloud.SecretManager.V1.Secret), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html)

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.SecretManager.V1](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecretManager.V1/latest/Google.Cloud.SecretManager.V1)

## Assembly

Google.Cloud.SecretManager.V1.dll

## Constructors

### Secret()

    public Secret()

### Secret(Secret)

    public Secret(Secret other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecretManager.V1/latest/Google.Cloud.SecretManager.V1.Secret` |

## Properties

### Annotations

    public MapField<string, string> Annotations { get; }

Optional. Custom metadata about the secret.

Annotations are distinct from various forms of labels.
Annotations exist to allow client tools to store their own state
information without requiring a database.

Annotation keys must be between 1 and 63 characters long, have a UTF-8
encoding of maximum 128 bytes, begin and end with an alphanumeric character
(\[a-z0-9A-Z\]), and may have dashes (-), underscores (_), dots (.), and
alphanumerics in between these symbols.

The total size of annotation keys and values must be less than 16KiB.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.MapField-2.htmlhttps://learn.microsoft.com/dotnet/api/system.stringhttps://learn.microsoft.com/dotnet/api/system.string` |   |

### CreateTime

    public Timestamp CreateTime { get; set; }

Output only. The time at which the
\[Secret\]\[google.cloud.secretmanager.v1.Secret\] was created.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.Timestamp.html` |   |

### CustomerManagedEncryption

    public CustomerManagedEncryption CustomerManagedEncryption { get; set; }

Optional. The customer-managed encryption configuration of the regionalized
secrets. If no configuration is provided, Google-managed default encryption
is used.

Updates to the \[Secret\]\[google.cloud.secretmanager.v1.Secret\] encryption
configuration only apply to
\[SecretVersions\]\[google.cloud.secretmanager.v1.SecretVersion\] added
afterwards. They do not apply retroactively to existing
\[SecretVersions\]\[google.cloud.secretmanager.v1.SecretVersion\].

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecretManager.V1/latest/Google.Cloud.SecretManager.V1.CustomerManagedEncryption` |   |

### Etag

    public string Etag { get; set; }

Optional. Etag of the currently stored
\[Secret\]\[google.cloud.secretmanager.v1.Secret\].

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### ExpirationCase

    public Secret.ExpirationOneofCase ExpirationCase { get; }

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecretManager.V1/latest/Google.Cloud.SecretManager.V1.Secrethttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecretManager.V1/latest/Google.Cloud.SecretManager.V1.Secret.ExpirationOneofCase` |   |

### ExpireTime

    public Timestamp ExpireTime { get; set; }

Optional. Timestamp in UTC when the
\[Secret\]\[google.cloud.secretmanager.v1.Secret\] is scheduled to expire.
This is always provided on output, regardless of what was sent on input.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.Timestamp.html` |   |

### Labels

    public MapField<string, string> Labels { get; }

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.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.MapField-2.htmlhttps://learn.microsoft.com/dotnet/api/system.stringhttps://learn.microsoft.com/dotnet/api/system.string` |   |

### Name

    public string Name { get; set; }

Output only. The resource name of the
\[Secret\]\[google.cloud.secretmanager.v1.Secret\] in the format
`projects/*/secrets/*`.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### Replication

    public Replication Replication { get; set; }

Optional. Immutable. The replication policy of the secret data attached to
the \[Secret\]\[google.cloud.secretmanager.v1.Secret\].

The replication policy cannot be changed after the Secret has been created.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecretManager.V1/latest/Google.Cloud.SecretManager.V1.Replication` |   |

### Rotation

    public Rotation Rotation { get; set; }

Optional. Rotation policy attached to the
\[Secret\]\[google.cloud.secretmanager.v1.Secret\]. May be excluded if there is
no rotation policy.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecretManager.V1/latest/Google.Cloud.SecretManager.V1.Rotation` |   |

### SecretName

    public SecretName SecretName { get; set; }

[SecretName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecretManager.V1/latest/Google.Cloud.SecretManager.V1.SecretName)-typed view over the [Name](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecretManager.V1/latest/Google.Cloud.SecretManager.V1.Secret#Google_Cloud_SecretManager_V1_Secret_Name) resource name property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecretManager.V1/latest/Google.Cloud.SecretManager.V1.SecretName` |   |

### Tags

    public MapField<string, string> Tags { get; }

Optional. Input only. Immutable. Mapping of Tag keys/values directly bound
to this resource. For example:
"123/environment": "production",
"123/costCenter": "marketing"

Tags are used to organize and group resources.

Tags can be used to control policy evaluation for the resource.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.MapField-2.htmlhttps://learn.microsoft.com/dotnet/api/system.stringhttps://learn.microsoft.com/dotnet/api/system.string` |   |

### Topics

    public RepeatedField<Topic> Topics { get; }

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.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecretManager.V1/latest/Google.Cloud.SecretManager.V1.Topic` |   |

### Ttl

    public Duration Ttl { get; set; }

Input only. The TTL for the
\[Secret\]\[google.cloud.secretmanager.v1.Secret\].

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.Duration.html` |   |

### VersionAliases

    public MapField<string, long> VersionAliases { get; }

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. Access by alias is only be supported on
GetSecretVersion and AccessSecretVersion.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.MapField-2.htmlhttps://learn.microsoft.com/dotnet/api/system.stringhttps://learn.microsoft.com/dotnet/api/system.int64` |   |

### VersionDestroyTtl

    public Duration VersionDestroyTtl { get; set; }

Optional. Secret Version TTL after destruction request

This is a part of the Delayed secret version destroy feature.
For secret with TTL\>0, version destruction doesn't happen immediately
on calling destroy instead the version goes to a disabled state and
destruction happens after the TTL expires.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.Duration.html` |   |