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

public sealed class OrganizationSettingsName : IResourceName, IEquatable<OrganizationSettingsName>

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

Resource name for the OrganizationSettings resource.

Inheritance

object > OrganizationSettingsName

Namespace

Google.Cloud.SecurityCenter.V1

Assembly

Google.Cloud.SecurityCenter.V1.dll

Constructors

OrganizationSettingsName(string)

public OrganizationSettingsName(string organizationId)

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

Parameter
Name Description
organizationId string

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

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

The OrganizationSettingsName.ResourceNameType of the contained resource name.

Property Value
Type Description
OrganizationSettingsNameResourceNameType

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 OrganizationSettingsName with pattern organizations/{organization}/organizationSettings.

Parameter
Name Description
organizationId string

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

The string representation of this OrganizationSettingsName with pattern organizations/{organization}/organizationSettings.

FormatOrganization(string)

public static string FormatOrganization(string organizationId)

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

Parameter
Name Description
organizationId string

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

The string representation of this OrganizationSettingsName with pattern organizations/{organization}/organizationSettings.

FromOrganization(string)

public static OrganizationSettingsName FromOrganization(string organizationId)

Creates a OrganizationSettingsName with the pattern organizations/{organization}/organizationSettings.

Parameter
Name Description
organizationId string

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

A new instance of OrganizationSettingsName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static OrganizationSettingsName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a OrganizationSettingsName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
organizationSettingsName string

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

The parsed OrganizationSettingsName if successful.
Remarks

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

  • organizations/{organization}/organizationSettings

Parse(string, bool)

public static OrganizationSettingsName Parse(string organizationSettingsName, bool allowUnparsed)

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

Parameters
Name Description
organizationSettingsName 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
OrganizationSettingsName

The parsed OrganizationSettingsName if successful.
Remarks

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

  • organizations/{organization}/organizationSettings
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 OrganizationSettingsName)

public static bool TryParse(string organizationSettingsName, out OrganizationSettingsName result)

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

Parameters
Name Description
organizationSettingsName string

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

When this method returns, the parsed OrganizationSettingsName, 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}/organizationSettings

TryParse(string, bool, out OrganizationSettingsName)

public static bool TryParse(string organizationSettingsName, bool allowUnparsed, out OrganizationSettingsName result)

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

Parameters
Name Description
organizationSettingsName 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 OrganizationSettingsName

When this method returns, the parsed OrganizationSettingsName, 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}/organizationSettings
Or may be in any format if allowUnparsed is true.

Operators

operator ==(OrganizationSettingsName, OrganizationSettingsName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a OrganizationSettingsName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a OrganizationSettingsName

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

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.