Google Cloud Monitoring v3 API - Class MonitoredResourceDescriptorName (3.3.0)

public sealed class MonitoredResourceDescriptorName : IResourceName, IEquatable<MonitoredResourceDescriptorName>

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

Resource name for the MonitoredResourceDescriptor resource.

Inheritance

object > MonitoredResourceDescriptorName

Implements

IResourceName, IEquatable MonitoredResourceDescriptorName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Monitoring.V3

Assembly

Google.Cloud.Monitoring.V3.dll

Constructors

MonitoredResourceDescriptorName(string, string)

public MonitoredResourceDescriptorName(string projectId, string monitoredResourceDescriptorId)

Constructs a new instance of a MonitoredResourceDescriptorName class from the component parts of pattern projects/{project}/monitoredResourceDescriptors/{monitored_resource_descriptor}

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

MonitoredResourceDescriptorId

public string MonitoredResourceDescriptorId { get; }

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

The MonitoredResourceDescriptorName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`MonitoredResourceDescriptorNameResourceNameType`

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

Formats the IDs into the string representation of this MonitoredResourceDescriptorName with pattern projects/{project}/monitoredResourceDescriptors/{monitored_resource_descriptor}.

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

Returns
Type	Description
`string`	The string representation of this MonitoredResourceDescriptorName with pattern `projects/{project}/monitoredResourceDescriptors/{monitored_resource_descriptor}`.

FormatFolderMonitoredResourceDescriptor(string, string)

public static string FormatFolderMonitoredResourceDescriptor(string folderId, string monitoredResourceDescriptorId)

Formats the IDs into the string representation of this MonitoredResourceDescriptorName with pattern folders/{folder}/monitoredResourceDescriptors/{monitored_resource_descriptor}.

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

Returns
Type	Description
`string`	The string representation of this MonitoredResourceDescriptorName with pattern `folders/{folder}/monitoredResourceDescriptors/{monitored_resource_descriptor}`.

FormatOrganizationMonitoredResourceDescriptor(string, string)

public static string FormatOrganizationMonitoredResourceDescriptor(string organizationId, string monitoredResourceDescriptorId)

Formats the IDs into the string representation of this MonitoredResourceDescriptorName with pattern organizations/{organization}/monitoredResourceDescriptors/{monitored_resource_descriptor}.

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

Returns
Type	Description
`string`	The string representation of this MonitoredResourceDescriptorName with pattern `organizations/{organization}/monitoredResourceDescriptors/{monitored_resource_descriptor}`.

FormatProjectMonitoredResourceDescriptor(string, string)

public static string FormatProjectMonitoredResourceDescriptor(string projectId, string monitoredResourceDescriptorId)

Formats the IDs into the string representation of this MonitoredResourceDescriptorName with pattern projects/{project}/monitoredResourceDescriptors/{monitored_resource_descriptor}.

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

Returns
Type	Description
`string`	The string representation of this MonitoredResourceDescriptorName with pattern `projects/{project}/monitoredResourceDescriptors/{monitored_resource_descriptor}`.

FromFolderMonitoredResourceDescriptor(string, string)

public static MonitoredResourceDescriptorName FromFolderMonitoredResourceDescriptor(string folderId, string monitoredResourceDescriptorId)

Creates a MonitoredResourceDescriptorName with the pattern folders/{folder}/monitoredResourceDescriptors/{monitored_resource_descriptor}.

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

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

FromOrganizationMonitoredResourceDescriptor(string, string)

public static MonitoredResourceDescriptorName FromOrganizationMonitoredResourceDescriptor(string organizationId, string monitoredResourceDescriptorId)

Creates a MonitoredResourceDescriptorName with the pattern organizations/{organization}/monitoredResourceDescriptors/{monitored_resource_descriptor}.

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

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

FromProjectMonitoredResourceDescriptor(string, string)

public static MonitoredResourceDescriptorName FromProjectMonitoredResourceDescriptor(string projectId, string monitoredResourceDescriptorId)

Creates a MonitoredResourceDescriptorName with the pattern projects/{project}/monitoredResourceDescriptors/{monitored_resource_descriptor}.

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

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

FromUnparsed(UnparsedResourceName)

public static MonitoredResourceDescriptorName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a MonitoredResourceDescriptorName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/monitoredResourceDescriptors/{monitored_resource_descriptor}
organizations/{organization}/monitoredResourceDescriptors/{monitored_resource_descriptor}
folders/{folder}/monitoredResourceDescriptors/{monitored_resource_descriptor}

Parse(string, bool)

public static MonitoredResourceDescriptorName Parse(string monitoredResourceDescriptorName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/monitoredResourceDescriptors/{monitored_resource_descriptor}
organizations/{organization}/monitoredResourceDescriptors/{monitored_resource_descriptor}
folders/{folder}/monitoredResourceDescriptors/{monitored_resource_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 MonitoredResourceDescriptorName)

public static bool TryParse(string monitoredResourceDescriptorName, out MonitoredResourceDescriptorName result)

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

Parameters
Name	Description
`monitoredResourceDescriptorName`	`string` The resource name in string form. Must not be `null`.
`result`	`MonitoredResourceDescriptorName` When this method returns, the parsed MonitoredResourceDescriptorName, 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}/monitoredResourceDescriptors/{monitored_resource_descriptor}
organizations/{organization}/monitoredResourceDescriptors/{monitored_resource_descriptor}
folders/{folder}/monitoredResourceDescriptors/{monitored_resource_descriptor}

TryParse(string, bool, out MonitoredResourceDescriptorName)

public static bool TryParse(string monitoredResourceDescriptorName, bool allowUnparsed, out MonitoredResourceDescriptorName result)

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

Parameters
Name	Description
`monitoredResourceDescriptorName`	`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`	`MonitoredResourceDescriptorName` When this method returns, the parsed MonitoredResourceDescriptorName, 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}/monitoredResourceDescriptors/{monitored_resource_descriptor}
organizations/{organization}/monitoredResourceDescriptors/{monitored_resource_descriptor}
folders/{folder}/monitoredResourceDescriptors/{monitored_resource_descriptor}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(MonitoredResourceDescriptorName, MonitoredResourceDescriptorName)

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

Parameters
Name	Description
`a`	`MonitoredResourceDescriptorName`
`b`	`MonitoredResourceDescriptorName`

Returns
Type	Description
`bool`

operator !=(MonitoredResourceDescriptorName, MonitoredResourceDescriptorName)

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

Parameters
Name	Description
`a`	`MonitoredResourceDescriptorName`
`b`	`MonitoredResourceDescriptorName`

Returns
Type	Description
`bool`