Secret Manager v1 API - Class SecretName (2.1.0)

public sealed class SecretName : IResourceName, IEquatable<SecretName>

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

Resource name for the Secret resource.

Inheritance

Object > SecretName

Implements

IResourceName, IEquatable<SecretName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.SecretManager.V1

Assembly

Google.Cloud.SecretManager.V1.dll

Constructors

SecretName(String, String)

public SecretName(string projectId, string secretId)

Constructs a new instance of a SecretName class from the component parts of pattern projects/{project}/secrets/{secret}

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`secretId`	`String` The `Secret` ID. Must not be `null` or empty.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
Type	Description
`Boolean`

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`String`

SecretId

public string SecretId { get; }

The Secret ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`String`

Type

public SecretName.ResourceNameType Type { get; }

The SecretName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`SecretName.ResourceNameType`

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type	Description
`UnparsedResourceName`

Methods

Format(String, String)

public static string Format(string projectId, string secretId)

Formats the IDs into the string representation of this SecretName with pattern projects/{project}/secrets/{secret}.

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`secretId`	`String` The `Secret` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this SecretName with pattern `projects/{project}/secrets/{secret}`.

FormatProjectSecret(String, String)

public static string FormatProjectSecret(string projectId, string secretId)

Formats the IDs into the string representation of this SecretName with pattern projects/{project}/secrets/{secret}.

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`secretId`	`String` The `Secret` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this SecretName with pattern `projects/{project}/secrets/{secret}`.

FromProjectSecret(String, String)

public static SecretName FromProjectSecret(string projectId, string secretId)

Creates a SecretName with the pattern projects/{project}/secrets/{secret}.

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`secretId`	`String` The `Secret` ID. Must not be `null` or empty.

Returns
Type	Description
`SecretName`	A new instance of SecretName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SecretName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SecretName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`SecretName`	A new instance of SecretName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`Int32`

Overrides

Object.GetHashCode()

Parse(String)

public static SecretName Parse(string secretName)

Parses the given resource name string into a new SecretName instance.

Parameter
Name	Description
`secretName`	`String` The resource name in string form. Must not be `null`.

Returns
Type	Description
`SecretName`	The parsed SecretName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

projects/{project}/secrets/{secret}

Parse(String, Boolean)

public static SecretName Parse(string secretName, bool allowUnparsed)

Parses the given resource name string into a new SecretName instance; optionally allowing an unparseable resource name.

Parameters
Name	Description
`secretName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` If `true` will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.

Returns
Type	Description
`SecretName`	The parsed SecretName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

projects/{project}/secrets/{secret}

Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
Type	Description
`String`	The string representation of the resource name.

Overrides

Object.ToString()

TryParse(String, out SecretName)

public static bool TryParse(string secretName, out SecretName result)

Tries to parse the given resource name string into a new SecretName instance.

Parameters
Name	Description
`secretName`	`String` The resource name in string form. Must not be `null`.
`result`	`SecretName` When this method returns, the parsed SecretName, or `null` if parsing failed.

Returns
Type	Description
`Boolean`	`true` if the name was parsed successfully; `false` otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

projects/{project}/secrets/{secret}

TryParse(String, Boolean, out SecretName)

public static bool TryParse(string secretName, bool allowUnparsed, out SecretName result)

Tries to parse the given resource name string into a new SecretName instance; optionally allowing an unparseable resource name.

Parameters
Name	Description
`secretName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` If `true` will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.
`result`	`SecretName` When this method returns, the parsed SecretName, or `null` if parsing failed.

Returns
Type	Description
`Boolean`	`true` if the name was parsed successfully; `false` otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

projects/{project}/secrets/{secret}

Or may be in any format if allowUnparsed is true.

Operators

Equality(SecretName, SecretName)

public static bool operator ==(SecretName a, SecretName b)

Parameters
Name	Description
`a`	`SecretName`
`b`	`SecretName`

Returns
Type	Description
`Boolean`

Inequality(SecretName, SecretName)

public static bool operator !=(SecretName a, SecretName b)

Parameters
Name	Description
`a`	`SecretName`
`b`	`SecretName`

Returns
Type	Description
`Boolean`