Google Cloud Key Management Service v1 API - Class KeyHandleName (3.15.0)

public sealed class KeyHandleName : IResourceName, IEquatable<KeyHandleName>

Reference documentation and code samples for the Google Cloud Key Management Service v1 API class KeyHandleName.

Resource name for the KeyHandle resource.

Inheritance

object > KeyHandleName

Implements

IResourceName, IEquatable KeyHandleName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Kms.V1

Assembly

Google.Cloud.Kms.V1.dll

Constructors

KeyHandleName(string, string, string)

public KeyHandleName(string projectId, string locationId, string keyHandleId)

Constructs a new instance of a KeyHandleName class from the component parts of pattern projects/{project}/locations/{location}/keyHandles/{key_handle}

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.
`keyHandleId`	`string` The `KeyHandle` 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`

KeyHandleId

public string KeyHandleId { get; }

The KeyHandle 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 KeyHandleName.ResourceNameType Type { get; }

The KeyHandleName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`KeyHandleNameResourceNameType`

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

Formats the IDs into the string representation of this KeyHandleName with pattern projects/{project}/locations/{location}/keyHandles/{key_handle}.

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.
`keyHandleId`	`string` The `KeyHandle` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this KeyHandleName with pattern `projects/{project}/locations/{location}/keyHandles/{key_handle}`.

FormatProjectLocationKeyHandle(string, string, string)

public static string FormatProjectLocationKeyHandle(string projectId, string locationId, string keyHandleId)

Formats the IDs into the string representation of this KeyHandleName with pattern projects/{project}/locations/{location}/keyHandles/{key_handle}.

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.
`keyHandleId`	`string` The `KeyHandle` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this KeyHandleName with pattern `projects/{project}/locations/{location}/keyHandles/{key_handle}`.

FromProjectLocationKeyHandle(string, string, string)

public static KeyHandleName FromProjectLocationKeyHandle(string projectId, string locationId, string keyHandleId)

Creates a KeyHandleName with the pattern projects/{project}/locations/{location}/keyHandles/{key_handle}.

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.
`keyHandleId`	`string` The `KeyHandle` ID. Must not be `null` or empty.

Returns
Type	Description
`KeyHandleName`	A new instance of KeyHandleName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static KeyHandleName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a KeyHandleName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`KeyHandleName`	A new instance of KeyHandleName 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 KeyHandleName Parse(string keyHandleName)

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

Parameter
Name	Description
`keyHandleName`	`string` The resource name in string form. Must not be `null`.

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

Remarks

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

projects/{project}/locations/{location}/keyHandles/{key_handle}

Parse(string, bool)

public static KeyHandleName Parse(string keyHandleName, bool allowUnparsed)

Parses the given resource name string into a new KeyHandleName instance; optionally allowing an unparseable resource name.

Parameters
Name	Description
`keyHandleName`	`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
`KeyHandleName`	The parsed KeyHandleName if successful.

Remarks

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

projects/{project}/locations/{location}/keyHandles/{key_handle}

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

public static bool TryParse(string keyHandleName, out KeyHandleName result)

Tries to parse the given resource name string into a new KeyHandleName instance.

Parameters
Name	Description
`keyHandleName`	`string` The resource name in string form. Must not be `null`.
`result`	`KeyHandleName` When this method returns, the parsed KeyHandleName, 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}/keyHandles/{key_handle}

TryParse(string, bool, out KeyHandleName)

public static bool TryParse(string keyHandleName, bool allowUnparsed, out KeyHandleName result)

Tries to parse the given resource name string into a new KeyHandleName instance; optionally allowing an unparseable resource name.

Parameters
Name	Description
`keyHandleName`	`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`	`KeyHandleName` When this method returns, the parsed KeyHandleName, 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}/keyHandles/{key_handle}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(KeyHandleName, KeyHandleName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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