Google Cloud Monitoring v3 API - Class AlertPolicyName (3.3.0)

public sealed class AlertPolicyName : IResourceName, IEquatable<AlertPolicyName>

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

Resource name for the AlertPolicy resource.

Inheritance

object > AlertPolicyName

Namespace

Google.Cloud.Monitoring.V3

Assembly

Google.Cloud.Monitoring.V3.dll

Constructors

AlertPolicyName(string, string)

public AlertPolicyName(string projectId, string alertPolicyId)

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

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

alertPolicyIdstring

The AlertPolicy 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

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
bool

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 AlertPolicyName.ResourceNameType Type { get; }

The AlertPolicyName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
AlertPolicyNameResourceNameType

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

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

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

alertPolicyIdstring

The AlertPolicy ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this AlertPolicyName with pattern projects/{project}/alertPolicies/{alert_policy}.

FormatFolderAlertPolicy(string, string)

public static string FormatFolderAlertPolicy(string folderId, string alertPolicyId)

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

Parameters
NameDescription
folderIdstring

The Folder ID. Must not be null or empty.

alertPolicyIdstring

The AlertPolicy ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this AlertPolicyName with pattern folders/{folder}/alertPolicies/{alert_policy}.

FormatOrganizationAlertPolicy(string, string)

public static string FormatOrganizationAlertPolicy(string organizationId, string alertPolicyId)

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

Parameters
NameDescription
organizationIdstring

The Organization ID. Must not be null or empty.

alertPolicyIdstring

The AlertPolicy ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this AlertPolicyName with pattern organizations/{organization}/alertPolicies/{alert_policy}.

FormatProjectAlertPolicy(string, string)

public static string FormatProjectAlertPolicy(string projectId, string alertPolicyId)

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

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

alertPolicyIdstring

The AlertPolicy ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this AlertPolicyName with pattern projects/{project}/alertPolicies/{alert_policy}.

FromFolderAlertPolicy(string, string)

public static AlertPolicyName FromFolderAlertPolicy(string folderId, string alertPolicyId)

Creates a AlertPolicyName with the pattern folders/{folder}/alertPolicies/{alert_policy} .

Parameters
NameDescription
folderIdstring

The Folder ID. Must not be null or empty.

alertPolicyIdstring

The AlertPolicy ID. Must not be null or empty.

Returns
TypeDescription
AlertPolicyName

A new instance of AlertPolicyName constructed from the provided ids.

FromOrganizationAlertPolicy(string, string)

public static AlertPolicyName FromOrganizationAlertPolicy(string organizationId, string alertPolicyId)

Creates a AlertPolicyName with the pattern organizations/{organization}/alertPolicies/{alert_policy}.

Parameters
NameDescription
organizationIdstring

The Organization ID. Must not be null or empty.

alertPolicyIdstring

The AlertPolicy ID. Must not be null or empty.

Returns
TypeDescription
AlertPolicyName

A new instance of AlertPolicyName constructed from the provided ids.

FromProjectAlertPolicy(string, string)

public static AlertPolicyName FromProjectAlertPolicy(string projectId, string alertPolicyId)

Creates a AlertPolicyName with the pattern projects/{project}/alertPolicies/{alert_policy} .

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

alertPolicyIdstring

The AlertPolicy ID. Must not be null or empty.

Returns
TypeDescription
AlertPolicyName

A new instance of AlertPolicyName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AlertPolicyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AlertPolicyName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
AlertPolicyName

A new instance of AlertPolicyName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static AlertPolicyName Parse(string alertPolicyName)

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

Parameter
NameDescription
alertPolicyNamestring

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

Returns
TypeDescription
AlertPolicyName

The parsed AlertPolicyName if successful.

Remarks

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

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

Parse(string, bool)

public static AlertPolicyName Parse(string alertPolicyName, bool allowUnparsed)

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

Parameters
NameDescription
alertPolicyNamestring

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

allowUnparsedbool

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
AlertPolicyName

The parsed AlertPolicyName if successful.

Remarks

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

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

public static bool TryParse(string alertPolicyName, out AlertPolicyName result)

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

Parameters
NameDescription
alertPolicyNamestring

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

resultAlertPolicyName

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

Returns
TypeDescription
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}/alertPolicies/{alert_policy}
  • organizations/{organization}/alertPolicies/{alert_policy}
  • folders/{folder}/alertPolicies/{alert_policy}

TryParse(string, bool, out AlertPolicyName)

public static bool TryParse(string alertPolicyName, bool allowUnparsed, out AlertPolicyName result)

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

Parameters
NameDescription
alertPolicyNamestring

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

allowUnparsedbool

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.

resultAlertPolicyName

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

Returns
TypeDescription
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}/alertPolicies/{alert_policy}
  • organizations/{organization}/alertPolicies/{alert_policy}
  • folders/{folder}/alertPolicies/{alert_policy}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(AlertPolicyName, AlertPolicyName)

public static bool operator ==(AlertPolicyName a, AlertPolicyName b)
Parameters
NameDescription
aAlertPolicyName
bAlertPolicyName
Returns
TypeDescription
bool

operator !=(AlertPolicyName, AlertPolicyName)

public static bool operator !=(AlertPolicyName a, AlertPolicyName b)
Parameters
NameDescription
aAlertPolicyName
bAlertPolicyName
Returns
TypeDescription
bool