Secret Manager v1 API - Class SecretName (2.6.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

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

Type

public SecretName.ResourceNameType Type { get; }

The SecretName.ResourceNameType of the contained resource name.

Property Value
Type Description
SecretNameResourceNameType

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}.

FormatProjectLocationSecret(string, string, string)

public static string FormatProjectLocationSecret(string projectId, string locationId, string secretId)

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

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.
Returns
Type Description
string

The string representation of this SecretName with pattern projects/{project}/locations/{location}/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}.

FromProjectLocationSecret(string, string, string)

public static SecretName FromProjectLocationSecret(string projectId, string locationId, string secretId)

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

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.
Returns
Type Description
SecretName

A new instance of SecretName constructed from the provided ids.

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
int
Overrides

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

Parse(string, bool)

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

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

TryParse(string, bool, 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 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 SecretName

When this method returns, the parsed SecretName, 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}
  • projects/{project}/locations/{location}/secrets/{secret}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(SecretName, SecretName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SecretName

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

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 !=(SecretName, SecretName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a SecretName

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

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.