public sealed class KeyRingName : IResourceName, IEquatable<KeyRingName>
Reference documentation and code samples for the Google Cloud Key Management Service v1 API class KeyRingName.
Resource name for the KeyRing
resource.
Namespace
Google.Cloud.Kms.V1Assembly
Google.Cloud.Kms.V1.dll
Constructors
KeyRingName(String, String, String)
public KeyRingName(string projectId, string locationId, string keyRingId)
Constructs a new instance of a KeyRingName class from the component parts of pattern
projects/{project}/locations/{location}/keyRings/{key_ring}
Parameters | |
---|---|
Name | Description |
projectId | String The |
locationId | String The |
keyRingId | String The |
Properties
IsKnownPattern
public bool IsKnownPattern { get; }
Whether this instance contains a resource name with a known pattern.
Property Value | |
---|---|
Type | Description |
Boolean |
KeyRingId
public string KeyRingId { get; }
The KeyRing
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
String |
LocationId
public string LocationId { get; }
The Location
ID. Will not be null
, unless this instance contains an unparsed resource name.
Property Value | |
---|---|
Type | Description |
String |
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 |
Type
public KeyRingName.ResourceNameType Type { get; }
The KeyRingName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
KeyRingName.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, String)
public static string Format(string projectId, string locationId, string keyRingId)
Formats the IDs into the string representation of this KeyRingName with pattern
projects/{project}/locations/{location}/keyRings/{key_ring}
.
Parameters | |
---|---|
Name | Description |
projectId | String The |
locationId | String The |
keyRingId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this KeyRingName with pattern
|
FormatProjectLocationKeyRing(String, String, String)
public static string FormatProjectLocationKeyRing(string projectId, string locationId, string keyRingId)
Formats the IDs into the string representation of this KeyRingName with pattern
projects/{project}/locations/{location}/keyRings/{key_ring}
.
Parameters | |
---|---|
Name | Description |
projectId | String The |
locationId | String The |
keyRingId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this KeyRingName with pattern
|
FromProjectLocationKeyRing(String, String, String)
public static KeyRingName FromProjectLocationKeyRing(string projectId, string locationId, string keyRingId)
Creates a KeyRingName with the pattern
projects/{project}/locations/{location}/keyRings/{key_ring}
.
Parameters | |
---|---|
Name | Description |
projectId | String The |
locationId | String The |
keyRingId | String The |
Returns | |
---|---|
Type | Description |
KeyRingName | A new instance of KeyRingName constructed from the provided ids. |
FromUnparsed(UnparsedResourceName)
public static KeyRingName FromUnparsed(UnparsedResourceName unparsedResourceName)
Creates a KeyRingName containing an unparsed resource name.
Parameter | |
---|---|
Name | Description |
unparsedResourceName | UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
KeyRingName | A new instance of KeyRingName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
Int32 |
Parse(String)
public static KeyRingName Parse(string keyRingName)
Parses the given resource name string into a new KeyRingName instance.
Parameter | |
---|---|
Name | Description |
keyRingName | String The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
KeyRingName | The parsed KeyRingName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/keyRings/{key_ring}
Parse(String, Boolean)
public static KeyRingName Parse(string keyRingName, bool allowUnparsed)
Parses the given resource name string into a new KeyRingName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
keyRingName | String The resource name in string form. Must not be |
allowUnparsed | Boolean If |
Returns | |
---|---|
Type | Description |
KeyRingName | The parsed KeyRingName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/keyRings/{key_ring}
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 KeyRingName)
public static bool TryParse(string keyRingName, out KeyRingName result)
Tries to parse the given resource name string into a new KeyRingName instance.
Parameters | |
---|---|
Name | Description |
keyRingName | String The resource name in string form. Must not be |
result | KeyRingName When this method returns, the parsed KeyRingName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/keyRings/{key_ring}
TryParse(String, Boolean, out KeyRingName)
public static bool TryParse(string keyRingName, bool allowUnparsed, out KeyRingName result)
Tries to parse the given resource name string into a new KeyRingName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
keyRingName | String The resource name in string form. Must not be |
allowUnparsed | Boolean If |
result | KeyRingName When this method returns, the parsed KeyRingName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/keyRings/{key_ring}
allowUnparsed
is true
.
Operators
Equality(KeyRingName, KeyRingName)
public static bool operator ==(KeyRingName a, KeyRingName b)
Parameters | |
---|---|
Name | Description |
a | KeyRingName |
b | KeyRingName |
Returns | |
---|---|
Type | Description |
Boolean |
Inequality(KeyRingName, KeyRingName)
public static bool operator !=(KeyRingName a, KeyRingName b)
Parameters | |
---|---|
Name | Description |
a | KeyRingName |
b | KeyRingName |
Returns | |
---|---|
Type | Description |
Boolean |