Google Cloud Security Command Center v1 API - Class SecurityHealthAnalyticsCustomModuleName (3.11.0)

public sealed class SecurityHealthAnalyticsCustomModuleName : IResourceName, IEquatable<SecurityHealthAnalyticsCustomModuleName>

Reference documentation and code samples for the Google Cloud Security Command Center v1 API class SecurityHealthAnalyticsCustomModuleName.

Resource name for the SecurityHealthAnalyticsCustomModule resource.

Inheritance

object > SecurityHealthAnalyticsCustomModuleName

Implements

IResourceName, IEquatable SecurityHealthAnalyticsCustomModuleName

Inherited Members

object.GetType()

Namespace

Google.Cloud.SecurityCenter.V1

Assembly

Google.Cloud.SecurityCenter.V1.dll

Constructors

SecurityHealthAnalyticsCustomModuleName(string, string)

public SecurityHealthAnalyticsCustomModuleName(string organizationId, string customModuleId)

Constructs a new instance of a SecurityHealthAnalyticsCustomModuleName class from the component parts of pattern organizations/{organization}/securityHealthAnalyticsSettings/customModules/{custom_module}

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`customModuleId`	`string` The `CustomModule` ID. Must not be `null` or empty.

Properties

CustomModuleId

public string CustomModuleId { get; }

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

Property Value
Type	Description
`string`

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`

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

The SecurityHealthAnalyticsCustomModuleName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`SecurityHealthAnalyticsCustomModuleNameResourceNameType`

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

Formats the IDs into the string representation of this SecurityHealthAnalyticsCustomModuleName with pattern organizations/{organization}/securityHealthAnalyticsSettings/customModules/{custom_module} .

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`customModuleId`	`string` The `CustomModule` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SecurityHealthAnalyticsCustomModuleName with pattern `organizations/{organization}/securityHealthAnalyticsSettings/customModules/{custom_module}`.

FormatFolderCustomModule(string, string)

public static string FormatFolderCustomModule(string folderId, string customModuleId)

Formats the IDs into the string representation of this SecurityHealthAnalyticsCustomModuleName with pattern folders/{folder}/securityHealthAnalyticsSettings/customModules/{custom_module}.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`customModuleId`	`string` The `CustomModule` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SecurityHealthAnalyticsCustomModuleName with pattern `folders/{folder}/securityHealthAnalyticsSettings/customModules/{custom_module}`.

FormatOrganizationCustomModule(string, string)

public static string FormatOrganizationCustomModule(string organizationId, string customModuleId)

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`customModuleId`	`string` The `CustomModule` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SecurityHealthAnalyticsCustomModuleName with pattern `organizations/{organization}/securityHealthAnalyticsSettings/customModules/{custom_module}`.

FormatProjectCustomModule(string, string)

public static string FormatProjectCustomModule(string projectId, string customModuleId)

Formats the IDs into the string representation of this SecurityHealthAnalyticsCustomModuleName with pattern projects/{project}/securityHealthAnalyticsSettings/customModules/{custom_module}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`customModuleId`	`string` The `CustomModule` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SecurityHealthAnalyticsCustomModuleName with pattern `projects/{project}/securityHealthAnalyticsSettings/customModules/{custom_module}`.

FromFolderCustomModule(string, string)

public static SecurityHealthAnalyticsCustomModuleName FromFolderCustomModule(string folderId, string customModuleId)

Creates a SecurityHealthAnalyticsCustomModuleName with the pattern folders/{folder}/securityHealthAnalyticsSettings/customModules/{custom_module}.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`customModuleId`	`string` The `CustomModule` ID. Must not be `null` or empty.

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

FromOrganizationCustomModule(string, string)

public static SecurityHealthAnalyticsCustomModuleName FromOrganizationCustomModule(string organizationId, string customModuleId)

Creates a SecurityHealthAnalyticsCustomModuleName with the pattern organizations/{organization}/securityHealthAnalyticsSettings/customModules/{custom_module}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`customModuleId`	`string` The `CustomModule` ID. Must not be `null` or empty.

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

FromProjectCustomModule(string, string)

public static SecurityHealthAnalyticsCustomModuleName FromProjectCustomModule(string projectId, string customModuleId)

Creates a SecurityHealthAnalyticsCustomModuleName with the pattern projects/{project}/securityHealthAnalyticsSettings/customModules/{custom_module}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`customModuleId`	`string` The `CustomModule` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static SecurityHealthAnalyticsCustomModuleName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SecurityHealthAnalyticsCustomModuleName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

organizations/{organization}/securityHealthAnalyticsSettings/customModules/{custom_module}
folders/{folder}/securityHealthAnalyticsSettings/customModules/{custom_module}
projects/{project}/securityHealthAnalyticsSettings/customModules/{custom_module}

Parse(string, bool)

public static SecurityHealthAnalyticsCustomModuleName Parse(string securityHealthAnalyticsCustomModuleName, bool allowUnparsed)

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

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

Remarks

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

organizations/{organization}/securityHealthAnalyticsSettings/customModules/{custom_module}
folders/{folder}/securityHealthAnalyticsSettings/customModules/{custom_module}
projects/{project}/securityHealthAnalyticsSettings/customModules/{custom_module}

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

public static bool TryParse(string securityHealthAnalyticsCustomModuleName, out SecurityHealthAnalyticsCustomModuleName result)

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

Parameters
Name	Description
`securityHealthAnalyticsCustomModuleName`	`string` The resource name in string form. Must not be `null`.
`result`	`SecurityHealthAnalyticsCustomModuleName` When this method returns, the parsed SecurityHealthAnalyticsCustomModuleName, 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}/securityHealthAnalyticsSettings/customModules/{custom_module}
folders/{folder}/securityHealthAnalyticsSettings/customModules/{custom_module}
projects/{project}/securityHealthAnalyticsSettings/customModules/{custom_module}

TryParse(string, bool, out SecurityHealthAnalyticsCustomModuleName)

public static bool TryParse(string securityHealthAnalyticsCustomModuleName, bool allowUnparsed, out SecurityHealthAnalyticsCustomModuleName result)

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

Parameters
Name	Description
`securityHealthAnalyticsCustomModuleName`	`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`	`SecurityHealthAnalyticsCustomModuleName` When this method returns, the parsed SecurityHealthAnalyticsCustomModuleName, 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}/securityHealthAnalyticsSettings/customModules/{custom_module}
folders/{folder}/securityHealthAnalyticsSettings/customModules/{custom_module}
projects/{project}/securityHealthAnalyticsSettings/customModules/{custom_module}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(SecurityHealthAnalyticsCustomModuleName, SecurityHealthAnalyticsCustomModuleName)

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

Parameters
Name	Description
`a`	`SecurityHealthAnalyticsCustomModuleName`
`b`	`SecurityHealthAnalyticsCustomModuleName`

Returns
Type	Description
`bool`

operator !=(SecurityHealthAnalyticsCustomModuleName, SecurityHealthAnalyticsCustomModuleName)

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

Parameters
Name	Description
`a`	`SecurityHealthAnalyticsCustomModuleName`
`b`	`SecurityHealthAnalyticsCustomModuleName`

Returns
Type	Description
`bool`