Cloud AI Platform v1 API - Class NotificationChannelName (2.20.0)

Version 2.20.0

• 3.10.0 (latest)
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class NotificationChannelName : IResourceName, IEquatable<NotificationChannelName>

Reference documentation and code samples for the Cloud AI Platform v1 API class NotificationChannelName.

Resource name for the NotificationChannel resource.

Inheritance

object > NotificationChannelName

Implements

IResourceName, IEquatableNotificationChannelName

Inherited Members

object.GetType()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.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
Name	Description
projectId	string The Project ID. Must not be null or empty.
notificationChannelId	string The NotificationChannel 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
Type	Description
bool

NotificationChannelId

public string NotificationChannelId { get; }

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

Property Value
Type	Description
string

ProjectId

public string ProjectId { get; }

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

Property Value
Type	Description
string

Type

public NotificationChannelName.ResourceNameType Type { get; }

The NotificationChannelName.ResourceNameType of the contained resource name.

Property Value
Type	Description
NotificationChannelNameResourceNameType

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

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

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
notificationChannelId	string The NotificationChannel ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this NotificationChannelName with pattern projects/{project}/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
Name	Description
projectId	string The Project ID. Must not be null or empty.
notificationChannelId	string The NotificationChannel ID. Must not be null or empty.

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

FromProjectNotificationChannel(string, string)

public static NotificationChannelName FromProjectNotificationChannel(string projectId, string notificationChannelId)

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

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
notificationChannelId	string The NotificationChannel ID. Must not be null or empty.

Returns
Type	Description
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
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

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

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

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

Returns
Type	Description
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}

Parse(string, bool)

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
Name	Description
notificationChannelName	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
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}

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

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

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

Parameters
Name	Description
notificationChannelName	string The resource name in string form. Must not be null.
result	NotificationChannelName When this method returns, the parsed NotificationChannelName, 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}/notificationChannels/{notification_channel}

TryParse(string, bool, 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
Name	Description
notificationChannelName	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	NotificationChannelName When this method returns, the parsed NotificationChannelName, 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}/notificationChannels/{notification_channel}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(NotificationChannelName, NotificationChannelName)

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

Parameters
Name	Description
a	NotificationChannelName
b	NotificationChannelName

Returns
Type	Description
bool

operator !=(NotificationChannelName, NotificationChannelName)

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

Parameters
Name	Description
a	NotificationChannelName
b	NotificationChannelName

Returns
Type	Description
bool