Class NotificationChannelName (3.1.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class NotificationChannelName : IResourceName, IEquatable<NotificationChannelName>

Resource name for the NotificationChannel resource.

Inheritance

Object > NotificationChannelName

Namespace

Google.Cloud.Monitoring.V3

Assembly

Google.Cloud.Monitoring.V3.dll

Constructors

NotificationChannelName(String, String)

public NotificationChannelName(string projectId, string notificationChannelId)

Constructs a new instance of a NotificationChannelName class from the component parts of pattern projects/{project}/notificationChannels/{notification_channel}

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

notificationChannelIdString

The NotificationChannel 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
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
Boolean

NotificationChannelId

public string NotificationChannelId { get; }

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

Property Value
TypeDescription
String

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

The NotificationChannelName.ResourceNameType of the contained resource name.

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

Formats the IDs into the string representation of this NotificationChannelName with pattern projects/{project}/notificationChannels/{notification_channel}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

notificationChannelIdString

The NotificationChannel ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this NotificationChannelName with pattern projects/{project}/notificationChannels/{notification_channel}.

FormatFolderNotificationChannel(String, String)

public static string FormatFolderNotificationChannel(string folderId, string notificationChannelId)

Formats the IDs into the string representation of this NotificationChannelName with pattern folders/{folder}/notificationChannels/{notification_channel}.

Parameters
NameDescription
folderIdString

The Folder ID. Must not be null or empty.

notificationChannelIdString

The NotificationChannel ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this NotificationChannelName with pattern folders/{folder}/notificationChannels/{notification_channel}.

FormatOrganizationNotificationChannel(String, String)

public static string FormatOrganizationNotificationChannel(string organizationId, string notificationChannelId)

Formats the IDs into the string representation of this NotificationChannelName with pattern organizations/{organization}/notificationChannels/{notification_channel}.

Parameters
NameDescription
organizationIdString

The Organization ID. Must not be null or empty.

notificationChannelIdString

The NotificationChannel ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this NotificationChannelName with pattern organizations/{organization}/notificationChannels/{notification_channel}.

FormatProjectNotificationChannel(String, String)

public static string FormatProjectNotificationChannel(string projectId, string notificationChannelId)

Formats the IDs into the string representation of this NotificationChannelName with pattern projects/{project}/notificationChannels/{notification_channel}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

notificationChannelIdString

The NotificationChannel ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this NotificationChannelName with pattern projects/{project}/notificationChannels/{notification_channel}.

FromFolderNotificationChannel(String, String)

public static NotificationChannelName FromFolderNotificationChannel(string folderId, string notificationChannelId)

Creates a NotificationChannelName with the pattern folders/{folder}/notificationChannels/{notification_channel}.

Parameters
NameDescription
folderIdString

The Folder ID. Must not be null or empty.

notificationChannelIdString

The NotificationChannel ID. Must not be null or empty.

Returns
TypeDescription
NotificationChannelName

A new instance of NotificationChannelName constructed from the provided ids.

FromOrganizationNotificationChannel(String, String)

public static NotificationChannelName FromOrganizationNotificationChannel(string organizationId, string notificationChannelId)

Creates a NotificationChannelName with the pattern organizations/{organization}/notificationChannels/{notification_channel}.

Parameters
NameDescription
organizationIdString

The Organization ID. Must not be null or empty.

notificationChannelIdString

The NotificationChannel ID. Must not be null or empty.

Returns
TypeDescription
NotificationChannelName

A new instance of NotificationChannelName constructed from the provided ids.

FromProjectNotificationChannel(String, String)

public static NotificationChannelName FromProjectNotificationChannel(string projectId, string notificationChannelId)

Creates a NotificationChannelName with the pattern projects/{project}/notificationChannels/{notification_channel}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

notificationChannelIdString

The NotificationChannel ID. Must not be null or empty.

Returns
TypeDescription
NotificationChannelName

A new instance of NotificationChannelName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static NotificationChannelName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a NotificationChannelName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
NotificationChannelName

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

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

Parameter
NameDescription
notificationChannelNameString

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

Returns
TypeDescription
NotificationChannelName

The parsed NotificationChannelName if successful.

Remarks

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

  • projects/{project}/notificationChannels/{notification_channel}
  • organizations/{organization}/notificationChannels/{notification_channel}
  • folders/{folder}/notificationChannels/{notification_channel}

Parse(String, Boolean)

public static NotificationChannelName Parse(string notificationChannelName, bool allowUnparsed)

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

Parameters
NameDescription
notificationChannelNameString

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
NotificationChannelName

The parsed NotificationChannelName if successful.

Remarks

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

  • projects/{project}/notificationChannels/{notification_channel}
  • organizations/{organization}/notificationChannels/{notification_channel}
  • folders/{folder}/notificationChannels/{notification_channel}
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 NotificationChannelName)

public static bool TryParse(string notificationChannelName, out NotificationChannelName result)

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

Parameters
NameDescription
notificationChannelNameString

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

resultNotificationChannelName

When this method returns, the parsed NotificationChannelName, 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}/notificationChannels/{notification_channel}
  • organizations/{organization}/notificationChannels/{notification_channel}
  • folders/{folder}/notificationChannels/{notification_channel}

TryParse(String, Boolean, out NotificationChannelName)

public static bool TryParse(string notificationChannelName, bool allowUnparsed, out NotificationChannelName result)

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

Parameters
NameDescription
notificationChannelNameString

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.

resultNotificationChannelName

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

Operators

Equality(NotificationChannelName, NotificationChannelName)

public static bool operator ==(NotificationChannelName a, NotificationChannelName b)
Parameters
NameDescription
aNotificationChannelName
bNotificationChannelName
Returns
TypeDescription
Boolean

Inequality(NotificationChannelName, NotificationChannelName)

public static bool operator !=(NotificationChannelName a, NotificationChannelName b)
Parameters
NameDescription
aNotificationChannelName
bNotificationChannelName
Returns
TypeDescription
Boolean