Google Cloud Monitoring v3 API - Class NotificationChannelDescriptorName (3.4.0)

public sealed class NotificationChannelDescriptorName : IResourceName, IEquatable<NotificationChannelDescriptorName>

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

Resource name for the NotificationChannelDescriptor resource.

Inheritance

object > NotificationChannelDescriptorName

Implements

IResourceName, IEquatable NotificationChannelDescriptorName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Monitoring.V3

Assembly

Google.Cloud.Monitoring.V3.dll

Constructors

NotificationChannelDescriptorName(string, string)

public NotificationChannelDescriptorName(string projectId, string channelDescriptorId)

Constructs a new instance of a NotificationChannelDescriptorName class from the component parts of pattern projects/{project}/notificationChannelDescriptors/{channel_descriptor}

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`channelDescriptorId`	`string` The `ChannelDescriptor` ID. Must not be `null` or empty.

Properties

ChannelDescriptorId

public string ChannelDescriptorId { get; }

The ChannelDescriptor 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 NotificationChannelDescriptorName.ResourceNameType Type { get; }

The NotificationChannelDescriptorName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`NotificationChannelDescriptorNameResourceNameType`

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

Formats the IDs into the string representation of this NotificationChannelDescriptorName with pattern projects/{project}/notificationChannelDescriptors/{channel_descriptor}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`channelDescriptorId`	`string` The `ChannelDescriptor` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this NotificationChannelDescriptorName with pattern `projects/{project}/notificationChannelDescriptors/{channel_descriptor}`.

FormatFolderChannelDescriptor(string, string)

public static string FormatFolderChannelDescriptor(string folderId, string channelDescriptorId)

Formats the IDs into the string representation of this NotificationChannelDescriptorName with pattern folders/{folder}/notificationChannelDescriptors/{channel_descriptor}.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`channelDescriptorId`	`string` The `ChannelDescriptor` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this NotificationChannelDescriptorName with pattern `folders/{folder}/notificationChannelDescriptors/{channel_descriptor}`.

FormatOrganizationChannelDescriptor(string, string)

public static string FormatOrganizationChannelDescriptor(string organizationId, string channelDescriptorId)

Formats the IDs into the string representation of this NotificationChannelDescriptorName with pattern organizations/{organization}/notificationChannelDescriptors/{channel_descriptor}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`channelDescriptorId`	`string` The `ChannelDescriptor` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this NotificationChannelDescriptorName with pattern `organizations/{organization}/notificationChannelDescriptors/{channel_descriptor}`.

FormatProjectChannelDescriptor(string, string)

public static string FormatProjectChannelDescriptor(string projectId, string channelDescriptorId)

Formats the IDs into the string representation of this NotificationChannelDescriptorName with pattern projects/{project}/notificationChannelDescriptors/{channel_descriptor}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`channelDescriptorId`	`string` The `ChannelDescriptor` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this NotificationChannelDescriptorName with pattern `projects/{project}/notificationChannelDescriptors/{channel_descriptor}`.

FromFolderChannelDescriptor(string, string)

public static NotificationChannelDescriptorName FromFolderChannelDescriptor(string folderId, string channelDescriptorId)

Creates a NotificationChannelDescriptorName with the pattern folders/{folder}/notificationChannelDescriptors/{channel_descriptor}.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`channelDescriptorId`	`string` The `ChannelDescriptor` ID. Must not be `null` or empty.

Returns
Type	Description
`NotificationChannelDescriptorName`	A new instance of NotificationChannelDescriptorName constructed from the provided ids.

FromOrganizationChannelDescriptor(string, string)

public static NotificationChannelDescriptorName FromOrganizationChannelDescriptor(string organizationId, string channelDescriptorId)

Creates a NotificationChannelDescriptorName with the pattern organizations/{organization}/notificationChannelDescriptors/{channel_descriptor}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`channelDescriptorId`	`string` The `ChannelDescriptor` ID. Must not be `null` or empty.

Returns
Type	Description
`NotificationChannelDescriptorName`	A new instance of NotificationChannelDescriptorName constructed from the provided ids.

FromProjectChannelDescriptor(string, string)

public static NotificationChannelDescriptorName FromProjectChannelDescriptor(string projectId, string channelDescriptorId)

Creates a NotificationChannelDescriptorName with the pattern projects/{project}/notificationChannelDescriptors/{channel_descriptor}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`channelDescriptorId`	`string` The `ChannelDescriptor` ID. Must not be `null` or empty.

Returns
Type	Description
`NotificationChannelDescriptorName`	A new instance of NotificationChannelDescriptorName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static NotificationChannelDescriptorName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a NotificationChannelDescriptorName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`NotificationChannelDescriptorName`	A new instance of NotificationChannelDescriptorName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static NotificationChannelDescriptorName Parse(string notificationChannelDescriptorName)

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

Parameter
Name	Description
`notificationChannelDescriptorName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`NotificationChannelDescriptorName`	The parsed NotificationChannelDescriptorName if successful.

Remarks

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

projects/{project}/notificationChannelDescriptors/{channel_descriptor}
organizations/{organization}/notificationChannelDescriptors/{channel_descriptor}
folders/{folder}/notificationChannelDescriptors/{channel_descriptor}

Parse(string, bool)

public static NotificationChannelDescriptorName Parse(string notificationChannelDescriptorName, bool allowUnparsed)

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

Parameters
Name	Description
`notificationChannelDescriptorName`	`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
`NotificationChannelDescriptorName`	The parsed NotificationChannelDescriptorName if successful.

Remarks

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

projects/{project}/notificationChannelDescriptors/{channel_descriptor}
organizations/{organization}/notificationChannelDescriptors/{channel_descriptor}
folders/{folder}/notificationChannelDescriptors/{channel_descriptor}

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

object.ToString()

TryParse(string, out NotificationChannelDescriptorName)

public static bool TryParse(string notificationChannelDescriptorName, out NotificationChannelDescriptorName result)

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

Parameters
Name	Description
`notificationChannelDescriptorName`	`string` The resource name in string form. Must not be `null`.
`result`	`NotificationChannelDescriptorName` When this method returns, the parsed NotificationChannelDescriptorName, 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}/notificationChannelDescriptors/{channel_descriptor}
organizations/{organization}/notificationChannelDescriptors/{channel_descriptor}
folders/{folder}/notificationChannelDescriptors/{channel_descriptor}

TryParse(string, bool, out NotificationChannelDescriptorName)

public static bool TryParse(string notificationChannelDescriptorName, bool allowUnparsed, out NotificationChannelDescriptorName result)

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

Parameters
Name	Description
`notificationChannelDescriptorName`	`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`	`NotificationChannelDescriptorName` When this method returns, the parsed NotificationChannelDescriptorName, 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}/notificationChannelDescriptors/{channel_descriptor}
organizations/{organization}/notificationChannelDescriptors/{channel_descriptor}
folders/{folder}/notificationChannelDescriptors/{channel_descriptor}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(NotificationChannelDescriptorName, NotificationChannelDescriptorName)

public static bool operator ==(NotificationChannelDescriptorName a, NotificationChannelDescriptorName b)

Parameters
Name	Description
`a`	`NotificationChannelDescriptorName`
`b`	`NotificationChannelDescriptorName`

Returns
Type	Description
`bool`

operator !=(NotificationChannelDescriptorName, NotificationChannelDescriptorName)

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

Parameters
Name	Description
`a`	`NotificationChannelDescriptorName`
`b`	`NotificationChannelDescriptorName`

Returns
Type	Description
`bool`