Google Cloud Security Command Center v1 API - Class SecurityHealthAnalyticsSettingsName (3.21.0) 

public sealed class SecurityHealthAnalyticsSettingsName : IResourceName, IEquatable<SecurityHealthAnalyticsSettingsName>

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

Resource name for the SecurityHealthAnalyticsSettings resource.

Inheritance

object > SecurityHealthAnalyticsSettingsName

Namespace

Google.Cloud.SecurityCenter.V1

Assembly

Google.Cloud.SecurityCenter.V1.dll

Constructors

SecurityHealthAnalyticsSettingsName(string)

public SecurityHealthAnalyticsSettingsName(string organizationId)

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

Parameter
Name Description
organizationId string

The Organization 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

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

The SecurityHealthAnalyticsSettingsName.ResourceNameType of the contained resource name.

Property Value
Type Description
SecurityHealthAnalyticsSettingsNameResourceNameType

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)

public static string Format(string organizationId)

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

Parameter
Name Description
organizationId string

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

The string representation of this SecurityHealthAnalyticsSettingsName with pattern organizations/{organization}/securityHealthAnalyticsSettings.

FormatFolder(string)

public static string FormatFolder(string folderId)

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

Parameter
Name Description
folderId string

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

The string representation of this SecurityHealthAnalyticsSettingsName with pattern folders/{folder}/securityHealthAnalyticsSettings.

FormatOrganization(string)

public static string FormatOrganization(string organizationId)

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

Parameter
Name Description
organizationId string

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

The string representation of this SecurityHealthAnalyticsSettingsName with pattern organizations/{organization}/securityHealthAnalyticsSettings.

FormatProject(string)

public static string FormatProject(string projectId)

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

Parameter
Name Description
projectId string

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

The string representation of this SecurityHealthAnalyticsSettingsName with pattern projects/{project}/securityHealthAnalyticsSettings.

FromFolder(string)

public static SecurityHealthAnalyticsSettingsName FromFolder(string folderId)

Creates a SecurityHealthAnalyticsSettingsName with the pattern folders/{folder}/securityHealthAnalyticsSettings.

Parameter
Name Description
folderId string

The Folder ID. Must not be null or empty.
Returns
Type Description
SecurityHealthAnalyticsSettingsName

A new instance of SecurityHealthAnalyticsSettingsName constructed from the provided ids.

FromOrganization(string)

public static SecurityHealthAnalyticsSettingsName FromOrganization(string organizationId)

Creates a SecurityHealthAnalyticsSettingsName with the pattern organizations/{organization}/securityHealthAnalyticsSettings.

Parameter
Name Description
organizationId string

The Organization ID. Must not be null or empty.
Returns
Type Description
SecurityHealthAnalyticsSettingsName

A new instance of SecurityHealthAnalyticsSettingsName constructed from the provided ids.

FromProject(string)

public static SecurityHealthAnalyticsSettingsName FromProject(string projectId)

Creates a SecurityHealthAnalyticsSettingsName with the pattern projects/{project}/securityHealthAnalyticsSettings.

Parameter
Name Description
projectId string

The Project ID. Must not be null or empty.
Returns
Type Description
SecurityHealthAnalyticsSettingsName

A new instance of SecurityHealthAnalyticsSettingsName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SecurityHealthAnalyticsSettingsName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SecurityHealthAnalyticsSettingsName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
securityHealthAnalyticsSettingsName string

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

The parsed SecurityHealthAnalyticsSettingsName if successful.
Remarks

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

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

Parse(string, bool)

public static SecurityHealthAnalyticsSettingsName Parse(string securityHealthAnalyticsSettingsName, bool allowUnparsed)

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

Parameters
Name Description
securityHealthAnalyticsSettingsName 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
SecurityHealthAnalyticsSettingsName

The parsed SecurityHealthAnalyticsSettingsName if successful.
Remarks

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

  • organizations/{organization}/securityHealthAnalyticsSettings
  • folders/{folder}/securityHealthAnalyticsSettings
  • projects/{project}/securityHealthAnalyticsSettings
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 SecurityHealthAnalyticsSettingsName)

public static bool TryParse(string securityHealthAnalyticsSettingsName, out SecurityHealthAnalyticsSettingsName result)

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

Parameters
Name Description
securityHealthAnalyticsSettingsName string

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

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

TryParse(string, bool, out SecurityHealthAnalyticsSettingsName)

public static bool TryParse(string securityHealthAnalyticsSettingsName, bool allowUnparsed, out SecurityHealthAnalyticsSettingsName result)

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

Parameters
Name Description
securityHealthAnalyticsSettingsName 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 SecurityHealthAnalyticsSettingsName

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

Operators

operator ==(SecurityHealthAnalyticsSettingsName, SecurityHealthAnalyticsSettingsName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SecurityHealthAnalyticsSettingsName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a SecurityHealthAnalyticsSettingsName

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

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.