Advisory Notifications v1 API - Class NotificationName (1.3.0)

public sealed class NotificationName : IResourceName, IEquatable<NotificationName>

Reference documentation and code samples for the Advisory Notifications v1 API class NotificationName.

Resource name for the Notification resource.

Inheritance

object > NotificationName

Implements

IResourceName, IEquatable NotificationName

Inherited Members

object.GetType()

Namespace

Google.Cloud.AdvisoryNotifications.V1

Assembly

Google.Cloud.AdvisoryNotifications.V1.dll

Constructors

NotificationName(string, string, string)

public NotificationName(string organizationId, string locationId, string notificationId)

Constructs a new instance of a NotificationName class from the component parts of pattern organizations/{organization}/locations/{location}/notifications/{notification}

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`notificationId`	`string` The `Notification` 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`

LocationId

public string LocationId { get; }

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

Property Value
Type	Description
`string`

NotificationId

public string NotificationId { get; }

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

Property Value
Type	Description
`string`

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

The NotificationName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`NotificationNameResourceNameType`

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, string)

public static string Format(string organizationId, string locationId, string notificationId)

Formats the IDs into the string representation of this NotificationName with pattern organizations/{organization}/locations/{location}/notifications/{notification}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`notificationId`	`string` The `Notification` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this NotificationName with pattern `organizations/{organization}/locations/{location}/notifications/{notification}`.

FormatOrganizationLocationNotification(string, string, string)

public static string FormatOrganizationLocationNotification(string organizationId, string locationId, string notificationId)

Formats the IDs into the string representation of this NotificationName with pattern organizations/{organization}/locations/{location}/notifications/{notification}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`notificationId`	`string` The `Notification` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this NotificationName with pattern `organizations/{organization}/locations/{location}/notifications/{notification}`.

FormatProjectLocationNotification(string, string, string)

public static string FormatProjectLocationNotification(string projectId, string locationId, string notificationId)

Formats the IDs into the string representation of this NotificationName with pattern projects/{project}/locations/{location}/notifications/{notification}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`notificationId`	`string` The `Notification` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this NotificationName with pattern `projects/{project}/locations/{location}/notifications/{notification}`.

FromOrganizationLocationNotification(string, string, string)

public static NotificationName FromOrganizationLocationNotification(string organizationId, string locationId, string notificationId)

Creates a NotificationName with the pattern organizations/{organization}/locations/{location}/notifications/{notification}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`notificationId`	`string` The `Notification` ID. Must not be `null` or empty.

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

FromProjectLocationNotification(string, string, string)

public static NotificationName FromProjectLocationNotification(string projectId, string locationId, string notificationId)

Creates a NotificationName with the pattern projects/{project}/locations/{location}/notifications/{notification}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`notificationId`	`string` The `Notification` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static NotificationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a NotificationName containing an unparsed resource name.

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

Returns
Type	Description
`NotificationName`	A new instance of NotificationName 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 NotificationName Parse(string notificationName)

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

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

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

Remarks

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

organizations/{organization}/locations/{location}/notifications/{notification}
projects/{project}/locations/{location}/notifications/{notification}

Parse(string, bool)

public static NotificationName Parse(string notificationName, bool allowUnparsed)

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

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

Remarks

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

organizations/{organization}/locations/{location}/notifications/{notification}
projects/{project}/locations/{location}/notifications/{notification}

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

public static bool TryParse(string notificationName, out NotificationName result)

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

Parameters
Name	Description
`notificationName`	`string` The resource name in string form. Must not be `null`.
`result`	`NotificationName` When this method returns, the parsed NotificationName, 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:

organizations/{organization}/locations/{location}/notifications/{notification}
projects/{project}/locations/{location}/notifications/{notification}

TryParse(string, bool, out NotificationName)

public static bool TryParse(string notificationName, bool allowUnparsed, out NotificationName result)

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

Parameters
Name	Description
`notificationName`	`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`	`NotificationName` When this method returns, the parsed NotificationName, 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:

organizations/{organization}/locations/{location}/notifications/{notification}
projects/{project}/locations/{location}/notifications/{notification}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(NotificationName, NotificationName)

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

Parameters
Name	Description
`a`	`NotificationName`
`b`	`NotificationName`

Returns
Type	Description
`bool`

operator !=(NotificationName, NotificationName)

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

Parameters
Name	Description
`a`	`NotificationName`
`b`	`NotificationName`

Returns
Type	Description
`bool`