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

public sealed class OrganizationSimulationName : IResourceName, IEquatable<OrganizationSimulationName>

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

Resource name for the OrganizationSimulation resource.

Inheritance

object > OrganizationSimulationName

Namespace

Google.Cloud.SecurityCenter.V1

Assembly

Google.Cloud.SecurityCenter.V1.dll

Constructors

OrganizationSimulationName(string, string)

public OrganizationSimulationName(string organizationId, string simulationId)

Constructs a new instance of a OrganizationSimulationName class from the component parts of pattern organizations/{organization}/simulations/{simulation}

Parameters
Name Description
organizationId string

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

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

SimulationId

public string SimulationId { get; }

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

Property Value
Type Description
string

Type

public OrganizationSimulationName.ResourceNameType Type { get; }

The OrganizationSimulationName.ResourceNameType of the contained resource name.

Property Value
Type Description
OrganizationSimulationNameResourceNameType

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

Formats the IDs into the string representation of this OrganizationSimulationName with pattern organizations/{organization}/simulations/{simulation}.

Parameters
Name Description
organizationId string

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

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

The string representation of this OrganizationSimulationName with pattern organizations/{organization}/simulations/{simulation}.

FormatOrganizationSimulation(string, string)

public static string FormatOrganizationSimulation(string organizationId, string simulationId)

Formats the IDs into the string representation of this OrganizationSimulationName with pattern organizations/{organization}/simulations/{simulation}.

Parameters
Name Description
organizationId string

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

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

The string representation of this OrganizationSimulationName with pattern organizations/{organization}/simulations/{simulation}.

FromOrganizationSimulation(string, string)

public static OrganizationSimulationName FromOrganizationSimulation(string organizationId, string simulationId)

Creates a OrganizationSimulationName with the pattern organizations/{organization}/simulations/{simulation}.

Parameters
Name Description
organizationId string

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

The Simulation ID. Must not be null or empty.
Returns
Type Description
OrganizationSimulationName

A new instance of OrganizationSimulationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static OrganizationSimulationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a OrganizationSimulationName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
organizationSimulationName string

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

The parsed OrganizationSimulationName if successful.
Remarks

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

  • organizations/{organization}/simulations/{simulation}

Parse(string, bool)

public static OrganizationSimulationName Parse(string organizationSimulationName, bool allowUnparsed)

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

Parameters
Name Description
organizationSimulationName 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
OrganizationSimulationName

The parsed OrganizationSimulationName if successful.
Remarks

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

  • organizations/{organization}/simulations/{simulation}
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 OrganizationSimulationName)

public static bool TryParse(string organizationSimulationName, out OrganizationSimulationName result)

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

Parameters
Name Description
organizationSimulationName string

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

When this method returns, the parsed OrganizationSimulationName, 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}/simulations/{simulation}

TryParse(string, bool, out OrganizationSimulationName)

public static bool TryParse(string organizationSimulationName, bool allowUnparsed, out OrganizationSimulationName result)

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

Parameters
Name Description
organizationSimulationName 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 OrganizationSimulationName

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

Operators

operator ==(OrganizationSimulationName, OrganizationSimulationName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a OrganizationSimulationName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a OrganizationSimulationName

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

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.