Class OrganizationSettingsName

public sealed class OrganizationSettingsName : IResourceName, IEquatable<OrganizationSettingsName>

Resource name for the OrganizationSettings resource.

Inheritance

Object > OrganizationSettingsName

Namespace

Google.Cloud.SecurityCenter.V1P1Beta1

Assembly

Google.Cloud.SecurityCenter.V1P1Beta1.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
NameDescription
organizationIdString

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
TypeDescription
Boolean

OrganizationId

public string OrganizationId { get; }

The Organization ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
String

Type

public OrganizationSettingsName.ResourceNameType Type { get; }

The OrganizationSettingsName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
OrganizationSettingsName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
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
NameDescription
organizationIdString

The Organization ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
organizationIdString

The Organization ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
organizationIdString

The Organization ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
OrganizationSettingsName

A new instance of OrganizationSettingsName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static OrganizationSettingsName Parse(string organizationSettingsName)

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

Parameter
NameDescription
organizationSettingsNameString

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

Returns
TypeDescription
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, Boolean)

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
NameDescription
organizationSettingsNameString

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

allowUnparsedBoolean

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
TypeDescription
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
TypeDescription
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
NameDescription
organizationSettingsNameString

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

resultOrganizationSettingsName

When this method returns, the parsed OrganizationSettingsName, or null if parsing failed.

Returns
TypeDescription
Boolean

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, Boolean, 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
NameDescription
organizationSettingsNameString

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

allowUnparsedBoolean

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.

resultOrganizationSettingsName

When this method returns, the parsed OrganizationSettingsName, or null if parsing failed.

Returns
TypeDescription
Boolean

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

Equality(OrganizationSettingsName, OrganizationSettingsName)

public static bool operator ==(OrganizationSettingsName a, OrganizationSettingsName b)
Parameters
NameDescription
aOrganizationSettingsName
bOrganizationSettingsName
Returns
TypeDescription
Boolean

Inequality(OrganizationSettingsName, OrganizationSettingsName)

public static bool operator !=(OrganizationSettingsName a, OrganizationSettingsName b)
Parameters
NameDescription
aOrganizationSettingsName
bOrganizationSettingsName
Returns
TypeDescription
Boolean