Class MonitoredResourceDescriptorName (3.0.0) 

public sealed class MonitoredResourceDescriptorName : IResourceName, IEquatable<MonitoredResourceDescriptorName>

Resource name for the MonitoredResourceDescriptor resource.

Inheritance

Object > MonitoredResourceDescriptorName

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
Boolean

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
MonitoredResourceDescriptorName.ResourceNameType

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

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

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 Boolean

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

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
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}/monitoredResourceDescriptors/{monitored_resource_descriptor}
  • organizations/{organization}/monitoredResourceDescriptors/{monitored_resource_descriptor}
  • folders/{folder}/monitoredResourceDescriptors/{monitored_resource_descriptor}

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

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

Equality(MonitoredResourceDescriptorName, MonitoredResourceDescriptorName)

public static bool operator ==(MonitoredResourceDescriptorName a, MonitoredResourceDescriptorName b)
Parameters
Name Description
a MonitoredResourceDescriptorName
b MonitoredResourceDescriptorName
Returns
Type Description
Boolean

Inequality(MonitoredResourceDescriptorName, MonitoredResourceDescriptorName)

public static bool operator !=(MonitoredResourceDescriptorName a, MonitoredResourceDescriptorName b)
Parameters
Name Description
a MonitoredResourceDescriptorName
b MonitoredResourceDescriptorName
Returns
Type Description
Boolean