Class NotificationConfigName (2.2.0)

public sealed class NotificationConfigName : IResourceName, IEquatable<NotificationConfigName>

Resource name for the NotificationConfig resource.

Inheritance

Object > NotificationConfigName

Implements

Google.Api.Gax.IResourceName, IEquatable<NotificationConfigName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.SecurityCenter.V1

Assembly

Google.Cloud.SecurityCenter.V1.dll

Constructors

NotificationConfigName(String, String)

public NotificationConfigName(string organizationId, string notificationConfigId)

Constructs a new instance of a NotificationConfigName class from the component parts of pattern organizations/{organization}/notificationConfigs/{notification_config}

Parameters
Name	Description
`organizationId`	`String` The `Organization` ID. Must not be `null` or empty.
`notificationConfigId`	`String` The `NotificationConfig` 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
`Boolean`

NotificationConfigId

public string NotificationConfigId { get; }

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

Property Value
Type	Description
`String`

OrganizationId

public string OrganizationId { get; }

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

Property Value
Type	Description
`String`

Type

public NotificationConfigName.ResourceNameType Type { get; }

The NotificationConfigName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`NotificationConfigName.ResourceNameType`

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained Google.Api.Gax.UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type	Description
`Google.Api.Gax.UnparsedResourceName`

Methods

Format(String, String)

public static string Format(string organizationId, string notificationConfigId)

Formats the IDs into the string representation of this NotificationConfigName with pattern organizations/{organization}/notificationConfigs/{notification_config}.

Parameters
Name	Description
`organizationId`	`String` The `Organization` ID. Must not be `null` or empty.
`notificationConfigId`	`String` The `NotificationConfig` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this NotificationConfigName with pattern `organizations/{organization}/notificationConfigs/{notification_config}`.

FormatOrganizationNotificationConfig(String, String)

public static string FormatOrganizationNotificationConfig(string organizationId, string notificationConfigId)

Formats the IDs into the string representation of this NotificationConfigName with pattern organizations/{organization}/notificationConfigs/{notification_config}.

Parameters
Name	Description
`organizationId`	`String` The `Organization` ID. Must not be `null` or empty.
`notificationConfigId`	`String` The `NotificationConfig` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this NotificationConfigName with pattern `organizations/{organization}/notificationConfigs/{notification_config}`.

FromOrganizationNotificationConfig(String, String)

public static NotificationConfigName FromOrganizationNotificationConfig(string organizationId, string notificationConfigId)

Creates a NotificationConfigName with the pattern organizations/{organization}/notificationConfigs/{notification_config}.

Parameters
Name	Description
`organizationId`	`String` The `Organization` ID. Must not be `null` or empty.
`notificationConfigId`	`String` The `NotificationConfig` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static NotificationConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a NotificationConfigName containing an unparsed resource name.

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

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

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`Int32`

Overrides

Object.GetHashCode()

Parse(String)

public static NotificationConfigName Parse(string notificationConfigName)

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

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

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

Remarks

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

organizations/{organization}/notificationConfigs/{notification_config}

Parse(String, Boolean)

public static NotificationConfigName Parse(string notificationConfigName, bool allowUnparsed)

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

Parameters
Name	Description
`notificationConfigName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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
`NotificationConfigName`	The parsed NotificationConfigName if successful.

Remarks

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

organizations/{organization}/notificationConfigs/{notification_config}

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

public static bool TryParse(string notificationConfigName, out NotificationConfigName result)

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

Parameters
Name	Description
`notificationConfigName`	`String` The resource name in string form. Must not be `null`.
`result`	`NotificationConfigName` When this method returns, the parsed NotificationConfigName, or `null` if parsing failed.

Returns
Type	Description
`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:

organizations/{organization}/notificationConfigs/{notification_config}

TryParse(String, Boolean, out NotificationConfigName)

public static bool TryParse(string notificationConfigName, bool allowUnparsed, out NotificationConfigName result)

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

Parameters
Name	Description
`notificationConfigName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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`	`NotificationConfigName` When this method returns, the parsed NotificationConfigName, or `null` if parsing failed.

Returns
Type	Description
`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:

organizations/{organization}/notificationConfigs/{notification_config}

Or may be in any format if allowUnparsed is true.

Operators

Equality(NotificationConfigName, NotificationConfigName)

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

Parameters
Name	Description
`a`	`NotificationConfigName`
`b`	`NotificationConfigName`

Returns
Type	Description
`Boolean`

Inequality(NotificationConfigName, NotificationConfigName)

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

Parameters
Name	Description
`a`	`NotificationConfigName`
`b`	`NotificationConfigName`

Returns
Type	Description
`Boolean`