Google Cloud Monitoring v3 API - Class SnoozeName (3.2.0)

public sealed class SnoozeName : IResourceName, IEquatable<SnoozeName>

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

Resource name for the Snooze resource.

Inheritance

Object > SnoozeName

Namespace

Google.Cloud.Monitoring.V3

Assembly

Google.Cloud.Monitoring.V3.dll

Constructors

SnoozeName(String, String)

public SnoozeName(string projectId, string snoozeId)

Constructs a new instance of a SnoozeName class from the component parts of pattern projects/{project}/snoozes/{snooze}

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

snoozeIdString

The Snooze ID. Must not be null or empty.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
Boolean

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
String

SnoozeId

public string SnoozeId { get; }

The Snooze ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
String

Type

public SnoozeName.ResourceNameType Type { get; }

The SnoozeName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
SnoozeName.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)

public static string Format(string projectId, string snoozeId)

Formats the IDs into the string representation of this SnoozeName with pattern projects/{project}/snoozes/{snooze}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

snoozeIdString

The Snooze ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this SnoozeName with pattern projects/{project}/snoozes/{snooze}.

FormatProjectSnooze(String, String)

public static string FormatProjectSnooze(string projectId, string snoozeId)

Formats the IDs into the string representation of this SnoozeName with pattern projects/{project}/snoozes/{snooze}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

snoozeIdString

The Snooze ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this SnoozeName with pattern projects/{project}/snoozes/{snooze}.

FromProjectSnooze(String, String)

public static SnoozeName FromProjectSnooze(string projectId, string snoozeId)

Creates a SnoozeName with the pattern projects/{project}/snoozes/{snooze}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

snoozeIdString

The Snooze ID. Must not be null or empty.

Returns
TypeDescription
SnoozeName

A new instance of SnoozeName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SnoozeName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SnoozeName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
SnoozeName

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

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

Parameter
NameDescription
snoozeNameString

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

Returns
TypeDescription
SnoozeName

The parsed SnoozeName if successful.

Remarks

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

  • projects/{project}/snoozes/{snooze}

Parse(String, Boolean)

public static SnoozeName Parse(string snoozeName, bool allowUnparsed)

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

Parameters
NameDescription
snoozeNameString

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
SnoozeName

The parsed SnoozeName if successful.

Remarks

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

  • projects/{project}/snoozes/{snooze}
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 SnoozeName)

public static bool TryParse(string snoozeName, out SnoozeName result)

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

Parameters
NameDescription
snoozeNameString

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

resultSnoozeName

When this method returns, the parsed SnoozeName, 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}/snoozes/{snooze}

TryParse(String, Boolean, out SnoozeName)

public static bool TryParse(string snoozeName, bool allowUnparsed, out SnoozeName result)

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

Parameters
NameDescription
snoozeNameString

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.

resultSnoozeName

When this method returns, the parsed SnoozeName, 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}/snoozes/{snooze}
Or may be in any format if allowUnparsed is true.

Operators

Equality(SnoozeName, SnoozeName)

public static bool operator ==(SnoozeName a, SnoozeName b)
Parameters
NameDescription
aSnoozeName
bSnoozeName
Returns
TypeDescription
Boolean

Inequality(SnoozeName, SnoozeName)

public static bool operator !=(SnoozeName a, SnoozeName b)
Parameters
NameDescription
aSnoozeName
bSnoozeName
Returns
TypeDescription
Boolean