Google Cloud reCAPTCHA Enterprise v1 API - Class MetricsName (2.3.0)

public sealed class MetricsName : IResourceName, IEquatable<MetricsName>

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

Resource name for the Metrics resource.

Inheritance

Object > MetricsName

Implements

IResourceName, IEquatable<MetricsName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.RecaptchaEnterprise.V1

Assembly

Google.Cloud.RecaptchaEnterprise.V1.dll

Constructors

MetricsName(String, String)

public MetricsName(string projectId, string keyId)

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

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

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 MetricsName.ResourceNameType Type { get; }

The MetricsName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`MetricsName.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)

public static string Format(string projectId, string keyId)

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

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 MetricsName with pattern `projects/{project}/keys/{key}/metrics`.

FormatProjectKey(String, String)

public static string FormatProjectKey(string projectId, string keyId)

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

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 MetricsName with pattern `projects/{project}/keys/{key}/metrics`.

FromProjectKey(String, String)

public static MetricsName FromProjectKey(string projectId, string keyId)

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

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
`MetricsName`	A new instance of MetricsName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static MetricsName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a MetricsName containing an unparsed resource name.

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

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

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`Int32`

Overrides

Object.GetHashCode()

Parse(String)

public static MetricsName Parse(string metricsName)

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

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

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

Remarks

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

projects/{project}/keys/{key}/metrics

Parse(String, Boolean)

public static MetricsName Parse(string metricsName, bool allowUnparsed)

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

Parameters
Name	Description
`metricsName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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
`MetricsName`	The parsed MetricsName if successful.

Remarks

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

projects/{project}/keys/{key}/metrics

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

public static bool TryParse(string metricsName, out MetricsName result)

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

Parameters
Name	Description
`metricsName`	`String` The resource name in string form. Must not be `null`.
`result`	`MetricsName` When this method returns, the parsed MetricsName, or `null` if parsing failed.

Returns
Type	Description
`Boolean`	`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}/metrics

TryParse(String, Boolean, out MetricsName)

public static bool TryParse(string metricsName, bool allowUnparsed, out MetricsName result)

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

Parameters
Name	Description
`metricsName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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`	`MetricsName` When this method returns, the parsed MetricsName, or `null` if parsing failed.

Returns
Type	Description
`Boolean`	`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}/metrics

Or may be in any format if allowUnparsed is true.

Operators

Equality(MetricsName, MetricsName)

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

Parameters
Name	Description
`a`	`MetricsName`
`b`	`MetricsName`

Returns
Type	Description
`Boolean`

Inequality(MetricsName, MetricsName)

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

Parameters
Name	Description
`a`	`MetricsName`
`b`	`MetricsName`

Returns
Type	Description
`Boolean`