Vertex AI v1beta1 API - Class NotificationChannelName (1.0.0-beta61) 

public sealed class NotificationChannelName : IResourceName, IEquatable<NotificationChannelName>

Reference documentation and code samples for the Vertex AI v1beta1 API class NotificationChannelName.

Resource name for the NotificationChannel resource.

Inheritance

object > NotificationChannelName

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.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

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

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)

Determines whether two specified resource names have the same value.

Parameters
Name Description
a NotificationChannelName

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

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 !=(NotificationChannelName, NotificationChannelName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a NotificationChannelName

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

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.