Google Cloud reCAPTCHA Enterprise v1 API - Class KeyName (2.8.0)

public sealed class KeyName : IResourceName, IEquatable<KeyName>

Reference documentation and code samples for the Google Cloud reCAPTCHA Enterprise v1 API class KeyName.

Resource name for the Key resource.

Inheritance

object > KeyName

Implements

IResourceName, IEquatable KeyName

Inherited Members

object.GetType()

Namespace

Google.Cloud.RecaptchaEnterprise.V1

Assembly

Google.Cloud.RecaptchaEnterprise.V1.dll

Constructors

KeyName(string, string)

public KeyName(string projectId, string keyId)

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

Parameters
Name	Description
`projectId`	`string` The `Project` 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`

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)

public static string Format(string projectId, string keyId)

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

Parameters
Name	Description
`projectId`	`string` The `Project` 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}/keys/{key}`.

FormatProjectKey(string, string)

public static string FormatProjectKey(string projectId, string keyId)

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

Parameters
Name	Description
`projectId`	`string` The `Project` 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}/keys/{key}`.

FromProjectKey(string, string)

public static KeyName FromProjectKey(string projectId, string keyId)

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

Parameters
Name	Description
`projectId`	`string` The `Project` 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}/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}/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}/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}/keys/{key}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(KeyName, KeyName)

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

Parameters
Name	Description
`a`	`KeyName`
`b`	`KeyName`

Returns
Type	Description
`bool`

operator !=(KeyName, KeyName)

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

Parameters
Name	Description
`a`	`KeyName`
`b`	`KeyName`

Returns
Type	Description
`bool`