Class SecretVersionName

public sealed class SecretVersionName : IResourceName, IEquatable<SecretVersionName>

Resource name for the SecretVersion resource.

Inheritance

Object > SecretVersionName

Namespace

Google.Cloud.SecretManager.V1

Assembly

Google.Cloud.SecretManager.V1.dll

Constructors

SecretVersionName(String, String, String)

public SecretVersionName(string projectId, string secretId, string secretVersionId)

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

Parameters
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringsecretId

The Secret ID. Must not be null or empty.

StringsecretVersionId

The SecretVersion 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
TypeDescription
Boolean

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

SecretId

public string SecretId { get; }

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

Property Value
TypeDescription
String

SecretVersionId

public string SecretVersionId { get; }

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

Property Value
TypeDescription
String

Type

public SecretVersionName.ResourceNameType Type { get; }

The SecretVersionName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
SecretVersionName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(String, String, String)

public static string Format(string projectId, string secretId, string secretVersionId)

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

Parameters
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringsecretId

The Secret ID. Must not be null or empty.

StringsecretVersionId

The SecretVersion ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this SecretVersionName with pattern projects/{project}/secrets/{secret}/versions/{secret_version}.

FormatProjectSecretSecretVersion(String, String, String)

public static string FormatProjectSecretSecretVersion(string projectId, string secretId, string secretVersionId)

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

Parameters
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringsecretId

The Secret ID. Must not be null or empty.

StringsecretVersionId

The SecretVersion ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this SecretVersionName with pattern projects/{project}/secrets/{secret}/versions/{secret_version}.

FromProjectSecretSecretVersion(String, String, String)

public static SecretVersionName FromProjectSecretSecretVersion(string projectId, string secretId, string secretVersionId)

Creates a SecretVersionName with the pattern projects/{project}/secrets/{secret}/versions/{secret_version}.

Parameters
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringsecretId

The Secret ID. Must not be null or empty.

StringsecretVersionId

The SecretVersion ID. Must not be null or empty.

Returns
TypeDescription
SecretVersionName

A new instance of SecretVersionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SecretVersionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SecretVersionName containing an unparsed resource name.

Parameter
TypeNameDescription
UnparsedResourceNameunparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
SecretVersionName

A new instance of SecretVersionName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static SecretVersionName Parse(string secretVersionName)

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

Parameter
TypeNameDescription
StringsecretVersionName

The resource name in string form. Must not be null.

Returns
TypeDescription
SecretVersionName

The parsed SecretVersionName if successful.

Remarks

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

  • projects/{project}/secrets/{secret}/versions/{secret_version}

Parse(String, Boolean)

public static SecretVersionName Parse(string secretVersionName, bool allowUnparsed)

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

Parameters
TypeNameDescription
StringsecretVersionName

The resource name in string form. Must not be null.

BooleanallowUnparsed

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
TypeDescription
SecretVersionName

The parsed SecretVersionName if successful.

Remarks

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

  • projects/{project}/secrets/{secret}/versions/{secret_version}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
String

The string representation of the resource name.

Overrides

TryParse(String, out SecretVersionName)

public static bool TryParse(string secretVersionName, out SecretVersionName result)

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

Parameters
TypeNameDescription
StringsecretVersionName

The resource name in string form. Must not be null.

SecretVersionNameresult

When this method returns, the parsed SecretVersionName, or null if parsing failed.

Returns
TypeDescription
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}/versions/{secret_version}

TryParse(String, Boolean, out SecretVersionName)

public static bool TryParse(string secretVersionName, bool allowUnparsed, out SecretVersionName result)

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

Parameters
TypeNameDescription
StringsecretVersionName

The resource name in string form. Must not be null.

BooleanallowUnparsed

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.

SecretVersionNameresult

When this method returns, the parsed SecretVersionName, or null if parsing failed.

Returns
TypeDescription
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}/versions/{secret_version}
Or may be in any format if allowUnparsed is true.

Operators

Equality(SecretVersionName, SecretVersionName)

public static bool operator ==(SecretVersionName a, SecretVersionName b)
Parameters
TypeNameDescription
SecretVersionNamea
SecretVersionNameb
Returns
TypeDescription
Boolean

Inequality(SecretVersionName, SecretVersionName)

public static bool operator !=(SecretVersionName a, SecretVersionName b)
Parameters
TypeNameDescription
SecretVersionNamea
SecretVersionNameb
Returns
TypeDescription
Boolean