Class LogMetricName (4.0.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class LogMetricName : IResourceName, IEquatable<LogMetricName>

Resource name for the LogMetric resource.

Inheritance

Object > LogMetricName

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

The Project ID. Must not be null or empty.

metricIdString

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

MetricId

public string MetricId { get; }

The Metric ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
String

Type

public LogMetricName.ResourceNameType Type { get; }

The LogMetricName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
LogMetricName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

metricIdString

The Metric ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

metricIdString

The Metric ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

metricIdString

The Metric ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
LogMetricName

A new instance of LogMetricName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static LogMetricName Parse(string logMetricName)

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

Parameter
NameDescription
logMetricNameString

The resource name in string form. Must not be null.

Returns
TypeDescription
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, Boolean)

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

The resource name in string form. Must not be null.

allowUnparsedBoolean

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

The string representation of the resource name.

Overrides

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

The resource name in string form. Must not be null.

resultLogMetricName

When this method returns, the parsed LogMetricName, or null if parsing failed.

Returns
TypeDescription
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}/metrics/{metric}

TryParse(String, Boolean, 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
NameDescription
logMetricNameString

The resource name in string form. Must not be null.

allowUnparsedBoolean

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.

resultLogMetricName

When this method returns, the parsed LogMetricName, or null if parsing failed.

Returns
TypeDescription
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}/metrics/{metric}
Or may be in any format if allowUnparsed is true.

Operators

Equality(LogMetricName, LogMetricName)

public static bool operator ==(LogMetricName a, LogMetricName b)
Parameters
NameDescription
aLogMetricName
bLogMetricName
Returns
TypeDescription
Boolean

Inequality(LogMetricName, LogMetricName)

public static bool operator !=(LogMetricName a, LogMetricName b)
Parameters
NameDescription
aLogMetricName
bLogMetricName
Returns
TypeDescription
Boolean