Google Cloud Monitoring v3 API - Class MetricDescriptorName (3.3.0)

public sealed class MetricDescriptorName : IResourceName, IEquatable<MetricDescriptorName>

Reference documentation and code samples for the Google Cloud Monitoring v3 API class MetricDescriptorName.

Resource name for the MetricDescriptor resource.

Inheritance

object > MetricDescriptorName

Implements

IResourceName, IEquatable MetricDescriptorName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Monitoring.V3

Assembly

Google.Cloud.Monitoring.V3.dll

Constructors

MetricDescriptorName(string, string)

public MetricDescriptorName(string projectId, string metricDescriptorId)

Constructs a new instance of a MetricDescriptorName class from the component parts of pattern projects/{project}/metricDescriptors/{metric_descriptor=**}

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

Properties

FolderId

public string FolderId { get; }

The Folder ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
Type	Description
`bool`

MetricDescriptorId

public string MetricDescriptorId { get; }

The MetricDescriptor ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

OrganizationId

public string OrganizationId { get; }

The Organization ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

Type

public MetricDescriptorName.ResourceNameType Type { get; }

The MetricDescriptorName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`MetricDescriptorNameResourceNameType`

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

Formats the IDs into the string representation of this MetricDescriptorName with pattern projects/{project}/metricDescriptors/{metric_descriptor=**}.

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

Returns
Type	Description
`string`	The string representation of this MetricDescriptorName with pattern `projects/{project}/metricDescriptors/{metric_descriptor=**}`.

FormatFolderMetricDescriptor(string, string)

public static string FormatFolderMetricDescriptor(string folderId, string metricDescriptorId)

Formats the IDs into the string representation of this MetricDescriptorName with pattern folders/{folder}/metricDescriptors/{metric_descriptor=**}.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`metricDescriptorId`	`string` The `MetricDescriptor` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this MetricDescriptorName with pattern `folders/{folder}/metricDescriptors/{metric_descriptor=**}`.

FormatOrganizationMetricDescriptor(string, string)

public static string FormatOrganizationMetricDescriptor(string organizationId, string metricDescriptorId)

Formats the IDs into the string representation of this MetricDescriptorName with pattern organizations/{organization}/metricDescriptors/{metric_descriptor=**}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`metricDescriptorId`	`string` The `MetricDescriptor` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this MetricDescriptorName with pattern `organizations/{organization}/metricDescriptors/{metric_descriptor=**}`.

FormatProjectMetricDescriptor(string, string)

public static string FormatProjectMetricDescriptor(string projectId, string metricDescriptorId)

Formats the IDs into the string representation of this MetricDescriptorName with pattern projects/{project}/metricDescriptors/{metric_descriptor=**}.

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

Returns
Type	Description
`string`	The string representation of this MetricDescriptorName with pattern `projects/{project}/metricDescriptors/{metric_descriptor=**}`.

FromFolderMetricDescriptor(string, string)

public static MetricDescriptorName FromFolderMetricDescriptor(string folderId, string metricDescriptorId)

Creates a MetricDescriptorName with the pattern folders/{folder}/metricDescriptors/{metric_descriptor=**}.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`metricDescriptorId`	`string` The `MetricDescriptor` ID. Must not be `null` or empty.

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

FromOrganizationMetricDescriptor(string, string)

public static MetricDescriptorName FromOrganizationMetricDescriptor(string organizationId, string metricDescriptorId)

Creates a MetricDescriptorName with the pattern organizations/{organization}/metricDescriptors/{metric_descriptor=**}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`metricDescriptorId`	`string` The `MetricDescriptor` ID. Must not be `null` or empty.

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

FromProjectMetricDescriptor(string, string)

public static MetricDescriptorName FromProjectMetricDescriptor(string projectId, string metricDescriptorId)

Creates a MetricDescriptorName with the pattern projects/{project}/metricDescriptors/{metric_descriptor=**}.

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

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

FromUnparsed(UnparsedResourceName)

public static MetricDescriptorName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a MetricDescriptorName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/metricDescriptors/{metric_descriptor=}
organizations/{organization}/metricDescriptors/{metric_descriptor=}
folders/{folder}/metricDescriptors/{metric_descriptor=**}

Parse(string, bool)

public static MetricDescriptorName Parse(string metricDescriptorName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/metricDescriptors/{metric_descriptor=}
organizations/{organization}/metricDescriptors/{metric_descriptor=}
folders/{folder}/metricDescriptors/{metric_descriptor=**}

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

public static bool TryParse(string metricDescriptorName, out MetricDescriptorName result)

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

Parameters
Name	Description
`metricDescriptorName`	`string` The resource name in string form. Must not be `null`.
`result`	`MetricDescriptorName` When this method returns, the parsed MetricDescriptorName, 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}/metricDescriptors/{metric_descriptor=}
organizations/{organization}/metricDescriptors/{metric_descriptor=}
folders/{folder}/metricDescriptors/{metric_descriptor=**}

TryParse(string, bool, out MetricDescriptorName)

public static bool TryParse(string metricDescriptorName, bool allowUnparsed, out MetricDescriptorName result)

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

Parameters
Name	Description
`metricDescriptorName`	`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`	`MetricDescriptorName` When this method returns, the parsed MetricDescriptorName, 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}/metricDescriptors/{metric_descriptor=}
organizations/{organization}/metricDescriptors/{metric_descriptor=}
folders/{folder}/metricDescriptors/{metric_descriptor=**}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(MetricDescriptorName, MetricDescriptorName)

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

Parameters
Name	Description
`a`	`MetricDescriptorName`
`b`	`MetricDescriptorName`

Returns
Type	Description
`bool`

operator !=(MetricDescriptorName, MetricDescriptorName)

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

Parameters
Name	Description
`a`	`MetricDescriptorName`
`b`	`MetricDescriptorName`

Returns
Type	Description
`bool`