Google Cloud Logging v2 API - Class LogMetricName (4.3.0)

public sealed class LogMetricName : IResourceName, IEquatable<LogMetricName>

Reference documentation and code samples for the Google Cloud Logging v2 API class LogMetricName.

Resource name for the LogMetric resource.

Inheritance

object > LogMetricName

Implements

IResourceName, IEquatable LogMetricName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Logging.V2

Assembly

Google.Cloud.Logging.V2.dll

Constructors

LogMetricName(string, string)

public LogMetricName(string projectId, string metricId)

Constructs a new instance of a LogMetricName class from the component parts of pattern projects/{project}/metrics/{metric}

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`metricId`	`string` The `Metric` 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`

MetricId

public string MetricId { get; }

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

The LogMetricName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`LogMetricNameResourceNameType`

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

Formats the IDs into the string representation of this LogMetricName with pattern projects/{project}/metrics/{metric}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`metricId`	`string` The `Metric` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this LogMetricName with pattern `projects/{project}/metrics/{metric}`.

FormatProjectMetric(string, string)

public static string FormatProjectMetric(string projectId, string metricId)

Formats the IDs into the string representation of this LogMetricName with pattern projects/{project}/metrics/{metric}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`metricId`	`string` The `Metric` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this LogMetricName with pattern `projects/{project}/metrics/{metric}`.

FromProjectMetric(string, string)

public static LogMetricName FromProjectMetric(string projectId, string metricId)

Creates a LogMetricName with the pattern projects/{project}/metrics/{metric}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`metricId`	`string` The `Metric` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static LogMetricName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a LogMetricName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/metrics/{metric}

Parse(string, bool)

public static LogMetricName Parse(string logMetricName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/metrics/{metric}

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

public static bool TryParse(string logMetricName, out LogMetricName result)

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

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

TryParse(string, bool, out LogMetricName)

public static bool TryParse(string logMetricName, bool allowUnparsed, out LogMetricName result)

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

Parameters
Name	Description
`logMetricName`	`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`	`LogMetricName` When this method returns, the parsed LogMetricName, 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}/metrics/{metric}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(LogMetricName, LogMetricName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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