Class SecretVersionName (1.3.0)

public sealed class SecretVersionName : IResourceName, IEquatable<SecretVersionName>

Resource name for the SecretVersion resource.

Inheritance

System.Object > SecretVersionName

Implements

Google.Api.Gax.IResourceName, System.IEquatable<SecretVersionName>

Inherited Members

System.Object.GetType()

System.Object.MemberwiseClone()

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
Name	Description
`projectId`	`System.String` The `Project` ID. Must not be `null` or empty.
`secretId`	`System.String` The `Secret` ID. Must not be `null` or empty.
`secretVersionId`	`System.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
`System.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
`System.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
`System.String`

SecretVersionId

public string SecretVersionId { get; }

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

Property Value
Type	Description
`System.String`

Type

public SecretVersionName.ResourceNameType Type { get; }

The SecretVersionName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`SecretVersionName.ResourceNameType`

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type	Description
`Google.Api.Gax.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`	`System.String` The `Project` ID. Must not be `null` or empty.
`secretId`	`System.String` The `Secret` ID. Must not be `null` or empty.
`secretVersionId`	`System.String` The `SecretVersion` ID. Must not be `null` or empty.

Returns
Type	Description
`System.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
Name	Description
`projectId`	`System.String` The `Project` ID. Must not be `null` or empty.
`secretId`	`System.String` The `Secret` ID. Must not be `null` or empty.
`secretVersionId`	`System.String` The `SecretVersion` ID. Must not be `null` or empty.

Returns
Type	Description
`System.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
Name	Description
`projectId`	`System.String` The `Project` ID. Must not be `null` or empty.
`secretId`	`System.String` The `Secret` ID. Must not be `null` or empty.
`secretVersionId`	`System.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`	`Google.Api.Gax.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
`System.Int32`

Overrides

System.Object.GetHashCode()

Parse(String)

public static SecretVersionName Parse(string secretVersionName)

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

Parameter
Name	Description
`secretVersionName`	`System.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}

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
Name	Description
`secretVersionName`	`System.String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`System.Boolean` If `true` will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.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}

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
`System.String`	The string representation of the resource name.

Overrides

System.Object.ToString()

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`	`System.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
`System.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
Name	Description
`secretVersionName`	`System.String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`System.Boolean` If `true` will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.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
`System.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
Name	Description
`a`	`SecretVersionName`
`b`	`SecretVersionName`

Returns
Type	Description
`System.Boolean`

Inequality(SecretVersionName, SecretVersionName)

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

Parameters
Name	Description
`a`	`SecretVersionName`
`b`	`SecretVersionName`

Returns
Type	Description
`System.Boolean`