Google Cloud reCAPTCHA Enterprise v1 API - Class MetricsName (2.13.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

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

The MetricsName.ResourceNameType of the contained resource name.

Property Value
Type Description
MetricsNameResourceNameType

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
int
Overrides

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, bool)

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

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
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}/metrics

TryParse(string, bool, 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 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 MetricsName

When this method returns, the parsed MetricsName, 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}/metrics
Or may be in any format if allowUnparsed is true.

Operators

operator ==(MetricsName, MetricsName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a MetricsName

The first resource name to compare, or null.
b MetricsName

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 !=(MetricsName, MetricsName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a MetricsName

The first resource name to compare, or null.
b MetricsName

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.