Google Cloud Monitoring v3 API - Class AlertPolicyConditionName (3.2.0)

public sealed class AlertPolicyConditionName : IResourceName, IEquatable<AlertPolicyConditionName>

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

Resource name for the AlertPolicyCondition resource.

Inheritance

Object > AlertPolicyConditionName

Namespace

Google.Cloud.Monitoring.V3

Assembly

Google.Cloud.Monitoring.V3.dll

Constructors

AlertPolicyConditionName(String, String, String)

public AlertPolicyConditionName(string projectId, string alertPolicyId, string conditionId)

Constructs a new instance of a AlertPolicyConditionName class from the component parts of pattern projects/{project}/alertPolicies/{alert_policy}/conditions/{condition}

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

alertPolicyIdString

The AlertPolicy ID. Must not be null or empty.

conditionIdString

The Condition ID. Must not be null or empty.

Properties

AlertPolicyId

public string AlertPolicyId { get; }

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

Property Value
TypeDescription
String

ConditionId

public string ConditionId { get; }

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

Property Value
TypeDescription
String

FolderId

public string FolderId { get; }

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

Property Value
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
Boolean

OrganizationId

public string OrganizationId { get; }

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

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

Type

public AlertPolicyConditionName.ResourceNameType Type { get; }

The AlertPolicyConditionName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
AlertPolicyConditionName.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, String)

public static string Format(string projectId, string alertPolicyId, string conditionId)

Formats the IDs into the string representation of this AlertPolicyConditionName with pattern projects/{project}/alertPolicies/{alert_policy}/conditions/{condition}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

alertPolicyIdString

The AlertPolicy ID. Must not be null or empty.

conditionIdString

The Condition ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this AlertPolicyConditionName with pattern projects/{project}/alertPolicies/{alert_policy}/conditions/{condition}.

FormatFolderAlertPolicyCondition(String, String, String)

public static string FormatFolderAlertPolicyCondition(string folderId, string alertPolicyId, string conditionId)

Formats the IDs into the string representation of this AlertPolicyConditionName with pattern folders/{folder}/alertPolicies/{alert_policy}/conditions/{condition}.

Parameters
NameDescription
folderIdString

The Folder ID. Must not be null or empty.

alertPolicyIdString

The AlertPolicy ID. Must not be null or empty.

conditionIdString

The Condition ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this AlertPolicyConditionName with pattern folders/{folder}/alertPolicies/{alert_policy}/conditions/{condition}.

FormatOrganizationAlertPolicyCondition(String, String, String)

public static string FormatOrganizationAlertPolicyCondition(string organizationId, string alertPolicyId, string conditionId)

Formats the IDs into the string representation of this AlertPolicyConditionName with pattern organizations/{organization}/alertPolicies/{alert_policy}/conditions/{condition}.

Parameters
NameDescription
organizationIdString

The Organization ID. Must not be null or empty.

alertPolicyIdString

The AlertPolicy ID. Must not be null or empty.

conditionIdString

The Condition ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this AlertPolicyConditionName with pattern organizations/{organization}/alertPolicies/{alert_policy}/conditions/{condition}.

FormatProjectAlertPolicyCondition(String, String, String)

public static string FormatProjectAlertPolicyCondition(string projectId, string alertPolicyId, string conditionId)

Formats the IDs into the string representation of this AlertPolicyConditionName with pattern projects/{project}/alertPolicies/{alert_policy}/conditions/{condition}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

alertPolicyIdString

The AlertPolicy ID. Must not be null or empty.

conditionIdString

The Condition ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this AlertPolicyConditionName with pattern projects/{project}/alertPolicies/{alert_policy}/conditions/{condition}.

FromFolderAlertPolicyCondition(String, String, String)

public static AlertPolicyConditionName FromFolderAlertPolicyCondition(string folderId, string alertPolicyId, string conditionId)

Creates a AlertPolicyConditionName with the pattern folders/{folder}/alertPolicies/{alert_policy}/conditions/{condition}.

Parameters
NameDescription
folderIdString

The Folder ID. Must not be null or empty.

alertPolicyIdString

The AlertPolicy ID. Must not be null or empty.

conditionIdString

The Condition ID. Must not be null or empty.

Returns
TypeDescription
AlertPolicyConditionName

A new instance of AlertPolicyConditionName constructed from the provided ids.

FromOrganizationAlertPolicyCondition(String, String, String)

public static AlertPolicyConditionName FromOrganizationAlertPolicyCondition(string organizationId, string alertPolicyId, string conditionId)

Creates a AlertPolicyConditionName with the pattern organizations/{organization}/alertPolicies/{alert_policy}/conditions/{condition}.

Parameters
NameDescription
organizationIdString

The Organization ID. Must not be null or empty.

alertPolicyIdString

The AlertPolicy ID. Must not be null or empty.

conditionIdString

The Condition ID. Must not be null or empty.

Returns
TypeDescription
AlertPolicyConditionName

A new instance of AlertPolicyConditionName constructed from the provided ids.

FromProjectAlertPolicyCondition(String, String, String)

public static AlertPolicyConditionName FromProjectAlertPolicyCondition(string projectId, string alertPolicyId, string conditionId)

Creates a AlertPolicyConditionName with the pattern projects/{project}/alertPolicies/{alert_policy}/conditions/{condition}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

alertPolicyIdString

The AlertPolicy ID. Must not be null or empty.

conditionIdString

The Condition ID. Must not be null or empty.

Returns
TypeDescription
AlertPolicyConditionName

A new instance of AlertPolicyConditionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AlertPolicyConditionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AlertPolicyConditionName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
AlertPolicyConditionName

A new instance of AlertPolicyConditionName 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 AlertPolicyConditionName Parse(string alertPolicyConditionName)

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

Parameter
NameDescription
alertPolicyConditionNameString

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

Returns
TypeDescription
AlertPolicyConditionName

The parsed AlertPolicyConditionName if successful.

Remarks

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

  • projects/{project}/alertPolicies/{alert_policy}/conditions/{condition}
  • organizations/{organization}/alertPolicies/{alert_policy}/conditions/{condition}
  • folders/{folder}/alertPolicies/{alert_policy}/conditions/{condition}

Parse(String, Boolean)

public static AlertPolicyConditionName Parse(string alertPolicyConditionName, bool allowUnparsed)

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

Parameters
NameDescription
alertPolicyConditionNameString

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
AlertPolicyConditionName

The parsed AlertPolicyConditionName if successful.

Remarks

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

  • projects/{project}/alertPolicies/{alert_policy}/conditions/{condition}
  • organizations/{organization}/alertPolicies/{alert_policy}/conditions/{condition}
  • folders/{folder}/alertPolicies/{alert_policy}/conditions/{condition}
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 AlertPolicyConditionName)

public static bool TryParse(string alertPolicyConditionName, out AlertPolicyConditionName result)

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

Parameters
NameDescription
alertPolicyConditionNameString

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

resultAlertPolicyConditionName

When this method returns, the parsed AlertPolicyConditionName, 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}/alertPolicies/{alert_policy}/conditions/{condition}
  • organizations/{organization}/alertPolicies/{alert_policy}/conditions/{condition}
  • folders/{folder}/alertPolicies/{alert_policy}/conditions/{condition}

TryParse(String, Boolean, out AlertPolicyConditionName)

public static bool TryParse(string alertPolicyConditionName, bool allowUnparsed, out AlertPolicyConditionName result)

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

Parameters
NameDescription
alertPolicyConditionNameString

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.

resultAlertPolicyConditionName

When this method returns, the parsed AlertPolicyConditionName, 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}/alertPolicies/{alert_policy}/conditions/{condition}
  • organizations/{organization}/alertPolicies/{alert_policy}/conditions/{condition}
  • folders/{folder}/alertPolicies/{alert_policy}/conditions/{condition}
Or may be in any format if allowUnparsed is true.

Operators

Equality(AlertPolicyConditionName, AlertPolicyConditionName)

public static bool operator ==(AlertPolicyConditionName a, AlertPolicyConditionName b)
Parameters
NameDescription
aAlertPolicyConditionName
bAlertPolicyConditionName
Returns
TypeDescription
Boolean

Inequality(AlertPolicyConditionName, AlertPolicyConditionName)

public static bool operator !=(AlertPolicyConditionName a, AlertPolicyConditionName b)
Parameters
NameDescription
aAlertPolicyConditionName
bAlertPolicyConditionName
Returns
TypeDescription
Boolean