Google Cloud Monitoring v3 API - Class AlertPolicyName (3.9.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
Name Description
projectId string

The Project ID. Must not be null or empty.
alertPolicyId string

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
Type Description
string

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

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

The AlertPolicyName.ResourceNameType of the contained resource name.

Property Value
Type Description
AlertPolicyNameResourceNameType

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

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

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
alertPolicyId string

The AlertPolicy ID. Must not be null or empty.
Returns
Type Description
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
Name Description
folderId string

The Folder ID. Must not be null or empty.
alertPolicyId string

The AlertPolicy ID. Must not be null or empty.
Returns
Type Description
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
Name Description
organizationId string

The Organization ID. Must not be null or empty.
alertPolicyId string

The AlertPolicy ID. Must not be null or empty.
Returns
Type Description
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
Name Description
projectId string

The Project ID. Must not be null or empty.
alertPolicyId string

The AlertPolicy ID. Must not be null or empty.
Returns
Type Description
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
Name Description
folderId string

The Folder ID. Must not be null or empty.
alertPolicyId string

The AlertPolicy ID. Must not be null or empty.
Returns
Type Description
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
Name Description
organizationId string

The Organization ID. Must not be null or empty.
alertPolicyId string

The AlertPolicy ID. Must not be null or empty.
Returns
Type Description
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
Name Description
projectId string

The Project ID. Must not be null or empty.
alertPolicyId string

The AlertPolicy ID. Must not be null or empty.
Returns
Type Description
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
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
AlertPolicyName

A new instance of AlertPolicyName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static AlertPolicyName Parse(string alertPolicyName)

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

Parameter
Name Description
alertPolicyName string

The resource name in string form. Must not be null.
Returns
Type Description
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
Name Description
alertPolicyName 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
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
Type Description
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
Name Description
alertPolicyName string

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

When this method returns, the parsed AlertPolicyName, 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}/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
Name Description
alertPolicyName 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 AlertPolicyName

When this method returns, the parsed AlertPolicyName, 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}/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)

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AlertPolicyName

The first resource name to compare, or null.
b AlertPolicyName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(AlertPolicyName, AlertPolicyName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a AlertPolicyName

The first resource name to compare, or null.
b AlertPolicyName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is different from the value of b; otherwise, false.