Security Command Center v2 API - Class NotificationConfigName (1.3.0) 

public sealed class NotificationConfigName : IResourceName, IEquatable<NotificationConfigName>

Reference documentation and code samples for the Security Command Center v2 API class NotificationConfigName.

Resource name for the NotificationConfig resource.

Inheritance

object > NotificationConfigName

Namespace

Google.Cloud.SecurityCenter.V2

Assembly

Google.Cloud.SecurityCenter.V2.dll

Constructors

NotificationConfigName(string, string, string)

public NotificationConfigName(string organizationId, string locationId, string notificationConfigId)

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

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.
notificationConfigId string

The NotificationConfig ID. Must not be null or empty.

Properties

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

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

NotificationConfigId

public string NotificationConfigId { get; }

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

The NotificationConfigName.ResourceNameType of the contained resource name.

Property Value
Type Description
NotificationConfigNameResourceNameType

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

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

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.
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}/locations/{location}/notificationConfigs/{notification_config}.

FormatFolderLocationNotificationConfig(string, string, string)

public static string FormatFolderLocationNotificationConfig(string folderId, string locationId, string notificationConfigId)

Formats the IDs into the string representation of this NotificationConfigName with pattern folders/{folder}/locations/{location}/notificationConfigs/{notification_config}.

Parameters
Name Description
folderId string

The Folder ID. Must not be null or empty.
locationId string

The Location 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 folders/{folder}/locations/{location}/notificationConfigs/{notification_config}.

FormatOrganizationLocationNotificationConfig(string, string, string)

public static string FormatOrganizationLocationNotificationConfig(string organizationId, string locationId, string notificationConfigId)

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

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.
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}/locations/{location}/notificationConfigs/{notification_config}.

FormatProjectLocationNotificationConfig(string, string, string)

public static string FormatProjectLocationNotificationConfig(string projectId, string locationId, string notificationConfigId)

Formats the IDs into the string representation of this NotificationConfigName with pattern projects/{project}/locations/{location}/notificationConfigs/{notification_config}.

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.
notificationConfigId string

The NotificationConfig ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this NotificationConfigName with pattern projects/{project}/locations/{location}/notificationConfigs/{notification_config}.

FromFolderLocationNotificationConfig(string, string, string)

public static NotificationConfigName FromFolderLocationNotificationConfig(string folderId, string locationId, string notificationConfigId)

Creates a NotificationConfigName with the pattern folders/{folder}/locations/{location}/notificationConfigs/{notification_config}.

Parameters
Name Description
folderId string

The Folder ID. Must not be null or empty.
locationId string

The Location 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.

FromOrganizationLocationNotificationConfig(string, string, string)

public static NotificationConfigName FromOrganizationLocationNotificationConfig(string organizationId, string locationId, string notificationConfigId)

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

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.
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.

FromProjectLocationNotificationConfig(string, string, string)

public static NotificationConfigName FromProjectLocationNotificationConfig(string projectId, string locationId, string notificationConfigId)

Creates a NotificationConfigName with the pattern projects/{project}/locations/{location}/notificationConfigs/{notification_config}.

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.
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 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
int
Overrides

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}/locations/{location}/notificationConfigs/{notification_config}
  • folders/{folder}/locations/{location}/notificationConfigs/{notification_config}
  • projects/{project}/locations/{location}/notificationConfigs/{notification_config}

Parse(string, bool)

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

The parsed NotificationConfigName if successful.
Remarks

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

  • organizations/{organization}/locations/{location}/notificationConfigs/{notification_config}
  • folders/{folder}/locations/{location}/notificationConfigs/{notification_config}
  • projects/{project}/locations/{location}/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

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
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}/notificationConfigs/{notification_config}
  • folders/{folder}/locations/{location}/notificationConfigs/{notification_config}
  • projects/{project}/locations/{location}/notificationConfigs/{notification_config}

TryParse(string, bool, 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 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 NotificationConfigName

When this method returns, the parsed NotificationConfigName, 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}/notificationConfigs/{notification_config}
  • folders/{folder}/locations/{location}/notificationConfigs/{notification_config}
  • projects/{project}/locations/{location}/notificationConfigs/{notification_config}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(NotificationConfigName, NotificationConfigName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a NotificationConfigName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a NotificationConfigName

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

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.