Some or all of the information on this page might not apply to Trusted Cloud by S3NS. See Differences from Google Cloud for more details.

Google Cloud Key Management Service v1 API - Class KeyRingName (3.18.0)

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.

Inheritance

object > KeyRingName

Implements

IResourceName, IEquatable KeyRingName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Kms.V1

Assembly

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 `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`keyRingId`	`string` The `KeyRing` 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`

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

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 `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`keyRingId`	`string` The `KeyRing` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this KeyRingName with pattern `projects/{project}/locations/{location}/keyRings/{key_ring}`.

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 `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`keyRingId`	`string` The `KeyRing` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this KeyRingName with pattern `projects/{project}/locations/{location}/keyRings/{key_ring}`.

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 `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`keyRingId`	`string` The `KeyRing` ID. Must not be `null` or empty.

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 `null`.

Returns
Type	Description
`KeyRingName`	A new instance of KeyRingName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

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 `null`.

Returns
Type	Description
`KeyRingName`	The parsed KeyRingName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

projects/{project}/locations/{location}/keyRings/{key_ring}

Parse(string, bool)

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 `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
`KeyRingName`	The parsed KeyRingName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

projects/{project}/locations/{location}/keyRings/{key_ring}

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

object.ToString()

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 `null`.
`result`	`KeyRingName` When this method returns, the parsed KeyRingName, 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}/locations/{location}/keyRings/{key_ring}

TryParse(string, bool, 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 `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`	`KeyRingName` When this method returns, the parsed KeyRingName, 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}/locations/{location}/keyRings/{key_ring}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(KeyRingName, KeyRingName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`KeyRingName` The first resource name to compare, or null.
`b`	`KeyRingName` 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 !=(KeyRingName, KeyRingName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`KeyRingName` The first resource name to compare, or null.
`b`	`KeyRingName` 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.