public sealed class SecretName : IResourceName, IEquatable<SecretName>
Resource name for the Secret
resource.
Namespace
Google.Cloud.SecretManager.V1Assembly
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 |
secretId | String The |
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 |
secretId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this SecretName with pattern
|
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 |
secretId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this SecretName with pattern
|
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 |
secretId | String The |
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 |
Returns | |
---|---|
Type | Description |
SecretName | A new instance of SecretName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
Int32 |
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 |
Returns | |
---|---|
Type | Description |
SecretName | The parsed SecretName if successful. |
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 |
allowUnparsed | Boolean If |
Returns | |
---|---|
Type | Description |
SecretName | The parsed SecretName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/secrets/{secret}
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. |
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 |
result | SecretName When this method returns, the parsed SecretName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
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 |
allowUnparsed | Boolean If |
result | SecretName When this method returns, the parsed SecretName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/secrets/{secret}
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 |