Google Cloud Security Command Center v1 API - Class EffectiveSecurityHealthAnalyticsCustomModuleName (3.24.0) 

public sealed class EffectiveSecurityHealthAnalyticsCustomModuleName : IResourceName, IEquatable<EffectiveSecurityHealthAnalyticsCustomModuleName>

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

Resource name for the EffectiveSecurityHealthAnalyticsCustomModule resource.

Inheritance

object > EffectiveSecurityHealthAnalyticsCustomModuleName

Namespace

Google.Cloud.SecurityCenter.V1

Assembly

Google.Cloud.SecurityCenter.V1.dll

Constructors

EffectiveSecurityHealthAnalyticsCustomModuleName(string, string)

public EffectiveSecurityHealthAnalyticsCustomModuleName(string organizationId, string effectiveCustomModuleId)

Constructs a new instance of a EffectiveSecurityHealthAnalyticsCustomModuleName class from the component parts of pattern organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{effective_custom_module}

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
effectiveCustomModuleId string

The EffectiveCustomModule ID. Must not be null or empty.

Properties

EffectiveCustomModuleId

public string EffectiveCustomModuleId { get; }

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

The EffectiveSecurityHealthAnalyticsCustomModuleName.ResourceNameType of the contained resource name.

Property Value
Type Description
EffectiveSecurityHealthAnalyticsCustomModuleNameResourceNameType

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

Formats the IDs into the string representation of this EffectiveSecurityHealthAnalyticsCustomModuleName with pattern organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{effective_custom_module} .

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
effectiveCustomModuleId string

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

The string representation of this EffectiveSecurityHealthAnalyticsCustomModuleName with pattern organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{effective_custom_module} .

FormatFolderEffectiveCustomModule(string, string)

public static string FormatFolderEffectiveCustomModule(string folderId, string effectiveCustomModuleId)

Formats the IDs into the string representation of this EffectiveSecurityHealthAnalyticsCustomModuleName with pattern folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{effective_custom_module}.

Parameters
Name Description
folderId string

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

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

The string representation of this EffectiveSecurityHealthAnalyticsCustomModuleName with pattern folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{effective_custom_module} .

FormatOrganizationEffectiveCustomModule(string, string)

public static string FormatOrganizationEffectiveCustomModule(string organizationId, string effectiveCustomModuleId)

Formats the IDs into the string representation of this EffectiveSecurityHealthAnalyticsCustomModuleName with pattern organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{effective_custom_module} .

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
effectiveCustomModuleId string

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

The string representation of this EffectiveSecurityHealthAnalyticsCustomModuleName with pattern organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{effective_custom_module} .

FormatProjectEffectiveCustomModule(string, string)

public static string FormatProjectEffectiveCustomModule(string projectId, string effectiveCustomModuleId)

Formats the IDs into the string representation of this EffectiveSecurityHealthAnalyticsCustomModuleName with pattern projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{effective_custom_module}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
effectiveCustomModuleId string

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

The string representation of this EffectiveSecurityHealthAnalyticsCustomModuleName with pattern projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{effective_custom_module}.

FromFolderEffectiveCustomModule(string, string)

public static EffectiveSecurityHealthAnalyticsCustomModuleName FromFolderEffectiveCustomModule(string folderId, string effectiveCustomModuleId)

Creates a EffectiveSecurityHealthAnalyticsCustomModuleName with the pattern folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{effective_custom_module}.

Parameters
Name Description
folderId string

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

The EffectiveCustomModule ID. Must not be null or empty.
Returns
Type Description
EffectiveSecurityHealthAnalyticsCustomModuleName

A new instance of EffectiveSecurityHealthAnalyticsCustomModuleName constructed from the provided ids.

FromOrganizationEffectiveCustomModule(string, string)

public static EffectiveSecurityHealthAnalyticsCustomModuleName FromOrganizationEffectiveCustomModule(string organizationId, string effectiveCustomModuleId)

Creates a EffectiveSecurityHealthAnalyticsCustomModuleName with the pattern organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{effective_custom_module} .

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
effectiveCustomModuleId string

The EffectiveCustomModule ID. Must not be null or empty.
Returns
Type Description
EffectiveSecurityHealthAnalyticsCustomModuleName

A new instance of EffectiveSecurityHealthAnalyticsCustomModuleName constructed from the provided ids.

FromProjectEffectiveCustomModule(string, string)

public static EffectiveSecurityHealthAnalyticsCustomModuleName FromProjectEffectiveCustomModule(string projectId, string effectiveCustomModuleId)

Creates a EffectiveSecurityHealthAnalyticsCustomModuleName with the pattern projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{effective_custom_module}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
effectiveCustomModuleId string

The EffectiveCustomModule ID. Must not be null or empty.
Returns
Type Description
EffectiveSecurityHealthAnalyticsCustomModuleName

A new instance of EffectiveSecurityHealthAnalyticsCustomModuleName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static EffectiveSecurityHealthAnalyticsCustomModuleName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a EffectiveSecurityHealthAnalyticsCustomModuleName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
EffectiveSecurityHealthAnalyticsCustomModuleName

A new instance of EffectiveSecurityHealthAnalyticsCustomModuleName 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 EffectiveSecurityHealthAnalyticsCustomModuleName Parse(string effectiveSecurityHealthAnalyticsCustomModuleName)

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

Parameter
Name Description
effectiveSecurityHealthAnalyticsCustomModuleName string

The resource name in string form. Must not be null.
Returns
Type Description
EffectiveSecurityHealthAnalyticsCustomModuleName

The parsed EffectiveSecurityHealthAnalyticsCustomModuleName if successful.
Remarks

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

  • organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{effective_custom_module}
  • folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{effective_custom_module}
  • projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{effective_custom_module}

Parse(string, bool)

public static EffectiveSecurityHealthAnalyticsCustomModuleName Parse(string effectiveSecurityHealthAnalyticsCustomModuleName, bool allowUnparsed)

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

Parameters
Name Description
effectiveSecurityHealthAnalyticsCustomModuleName 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
EffectiveSecurityHealthAnalyticsCustomModuleName

The parsed EffectiveSecurityHealthAnalyticsCustomModuleName if successful.
Remarks

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

  • organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{effective_custom_module}
  • folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{effective_custom_module}
  • projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{effective_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

TryParse(string, out EffectiveSecurityHealthAnalyticsCustomModuleName)

public static bool TryParse(string effectiveSecurityHealthAnalyticsCustomModuleName, out EffectiveSecurityHealthAnalyticsCustomModuleName result)

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

Parameters
Name Description
effectiveSecurityHealthAnalyticsCustomModuleName string

The resource name in string form. Must not be null.
result EffectiveSecurityHealthAnalyticsCustomModuleName

When this method returns, the parsed EffectiveSecurityHealthAnalyticsCustomModuleName, 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/effectiveCustomModules/{effective_custom_module}
  • folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{effective_custom_module}
  • projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{effective_custom_module}

TryParse(string, bool, out EffectiveSecurityHealthAnalyticsCustomModuleName)

public static bool TryParse(string effectiveSecurityHealthAnalyticsCustomModuleName, bool allowUnparsed, out EffectiveSecurityHealthAnalyticsCustomModuleName result)

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

Parameters
Name Description
effectiveSecurityHealthAnalyticsCustomModuleName 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 EffectiveSecurityHealthAnalyticsCustomModuleName

When this method returns, the parsed EffectiveSecurityHealthAnalyticsCustomModuleName, 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/effectiveCustomModules/{effective_custom_module}
  • folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{effective_custom_module}
  • projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{effective_custom_module}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(EffectiveSecurityHealthAnalyticsCustomModuleName, EffectiveSecurityHealthAnalyticsCustomModuleName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a EffectiveSecurityHealthAnalyticsCustomModuleName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a EffectiveSecurityHealthAnalyticsCustomModuleName

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

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.