API Keys v2 API - Class KeyName (1.2.0)

Version 1.2.0

• 1.4.0 (latest)
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class KeyName : IResourceName, IEquatable<KeyName>

Reference documentation and code samples for the API Keys v2 API class KeyName.

Resource name for the Key resource.

Inheritance

object > KeyName

Implements

IResourceName, IEquatableKeyName

Inherited Members

object.GetType()

Namespace

Google.Cloud.ApiKeys.V2

Assembly

Google.Cloud.ApiKeys.V2.dll

Constructors

KeyName(string, string, string)

public KeyName(string projectId, string locationId, string keyId)

Constructs a new instance of a KeyName class from the component parts of pattern projects/{project}/locations/{location}/keys/{key}

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.
keyId	string The Key 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

KeyId

public string KeyId { get; }

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

The KeyName.ResourceNameType of the contained resource name.

Property Value
Type	Description
KeyNameResourceNameType

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

Formats the IDs into the string representation of this KeyName with pattern projects/{project}/locations/{location}/keys/{key}.

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.
keyId	string The Key ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this KeyName with pattern projects/{project}/locations/{location}/keys/{key}.

FormatProjectLocationKey(string, string, string)

public static string FormatProjectLocationKey(string projectId, string locationId, string keyId)

Formats the IDs into the string representation of this KeyName with pattern projects/{project}/locations/{location}/keys/{key}.

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.
keyId	string The Key ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this KeyName with pattern projects/{project}/locations/{location}/keys/{key}.

FromProjectLocationKey(string, string, string)

public static KeyName FromProjectLocationKey(string projectId, string locationId, string keyId)

Creates a KeyName with the pattern projects/{project}/locations/{location}/keys/{key}.

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.
keyId	string The Key ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static KeyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a KeyName containing an unparsed resource name.

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

Returns
Type	Description
KeyName	A new instance of KeyName 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 KeyName Parse(string keyName)

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

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

Returns
Type	Description
KeyName	The parsed KeyName if successful.

Remarks

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

• projects/{project}/locations/{location}/keys/{key}

Parse(string, bool)

public static KeyName Parse(string keyName, bool allowUnparsed)

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

Parameters
Name	Description
keyName	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
KeyName	The parsed KeyName if successful.

Remarks

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

• projects/{project}/locations/{location}/keys/{key}

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

public static bool TryParse(string keyName, out KeyName result)

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

Parameters
Name	Description
keyName	string The resource name in string form. Must not be null.
result	KeyName When this method returns, the parsed KeyName, 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}/keys/{key}

TryParse(string, bool, out KeyName)

public static bool TryParse(string keyName, bool allowUnparsed, out KeyName result)

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

Parameters
Name	Description
keyName	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	KeyName When this method returns, the parsed KeyName, 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}/keys/{key}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(KeyName, KeyName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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