Secret Manager v1beta2 API - Class SecretVersionName (1.0.0-beta02) 

public sealed class SecretVersionName : IResourceName, IEquatable<SecretVersionName>

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

Resource name for the SecretVersion resource.

Inheritance

object > SecretVersionName

Namespace

Google.Cloud.SecretManager.V1Beta2

Assembly

Google.Cloud.SecretManager.V1Beta2.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
Name Description
projectId string

The Project ID. Must not be null or empty.
secretId string

The Secret ID. Must not be null or empty.
secretVersionId string

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
Type Description
bool

LocationId

public string LocationId { get; }

The Location ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

SecretId

public string SecretId { get; }

The Secret ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

SecretVersionId

public string SecretVersionId { get; }

The SecretVersion ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

Type

public SecretVersionName.ResourceNameType Type { get; }

The SecretVersionName.ResourceNameType of the contained resource name.

Property Value
Type Description
SecretVersionNameResourceNameType

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, 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
Name Description
projectId string

The Project ID. Must not be null or empty.
secretId string

The Secret ID. Must not be null or empty.
secretVersionId string

The SecretVersion ID. Must not be null or empty.
Returns
Type Description
string

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

FormatProjectLocationSecretSecretVersion(string, string, string, string)

public static string FormatProjectLocationSecretSecretVersion(string projectId, string locationId, string secretId, string secretVersionId)

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

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
secretId string

The Secret ID. Must not be null or empty.
secretVersionId string

The SecretVersion ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this SecretVersionName with pattern projects/{project}/locations/{location}/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
Name Description
projectId string

The Project ID. Must not be null or empty.
secretId string

The Secret ID. Must not be null or empty.
secretVersionId string

The SecretVersion ID. Must not be null or empty.
Returns
Type Description
string

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

FromProjectLocationSecretSecretVersion(string, string, string, string)

public static SecretVersionName FromProjectLocationSecretSecretVersion(string projectId, string locationId, string secretId, string secretVersionId)

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

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
secretId string

The Secret ID. Must not be null or empty.
secretVersionId string

The SecretVersion ID. Must not be null or empty.
Returns
Type Description
SecretVersionName

A new instance of SecretVersionName constructed from the provided ids.

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
Name Description
projectId string

The Project ID. Must not be null or empty.
secretId string

The Secret ID. Must not be null or empty.
secretVersionId string

The SecretVersion ID. Must not be null or empty.
Returns
Type Description
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
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
SecretVersionName

A new instance of SecretVersionName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static SecretVersionName Parse(string secretVersionName)

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

Parameter
Name Description
secretVersionName string

The resource name in string form. Must not be null.
Returns
Type Description
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}
  • projects/{project}/locations/{location}/secrets/{secret}/versions/{secret_version}

Parse(string, bool)

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
Name Description
secretVersionName string

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

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
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}
  • projects/{project}/locations/{location}/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
Type Description
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
Name Description
secretVersionName string

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

When this method returns, the parsed SecretVersionName, or null if parsing failed.
Returns
Type Description
bool

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}
  • projects/{project}/locations/{location}/secrets/{secret}/versions/{secret_version}

TryParse(string, bool, 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
Name Description
secretVersionName string

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

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 SecretVersionName

When this method returns, the parsed SecretVersionName, or null if parsing failed.
Returns
Type Description
bool

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}
  • projects/{project}/locations/{location}/secrets/{secret}/versions/{secret_version}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(SecretVersionName, SecretVersionName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SecretVersionName

The first resource name to compare, or null.
b SecretVersionName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(SecretVersionName, SecretVersionName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a SecretVersionName

The first resource name to compare, or null.
b SecretVersionName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is different from the value of b; otherwise, false.