# Security Command Center v2 API - Class SimulationName (1.4.0)

<button class="button button-with-icon cloud-select-dropdown__button " aria-haspopup="true">Version latest</button>

- [1.4.0 (latest)](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName)
- [1.3.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/1.3.0/Google.Cloud.SecurityCenter.V2.SimulationName)
- [1.2.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/1.2.0/Google.Cloud.SecurityCenter.V2.SimulationName)
- [1.1.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/1.1.0/Google.Cloud.SecurityCenter.V2.SimulationName)
- [1.0.0](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/1.0.0/Google.Cloud.SecurityCenter.V2.SimulationName)

    public sealed class SimulationName : IResourceName, IEquatable<SimulationName>

Reference documentation and code samples for the Security Command Center v2 API class SimulationName.

Resource name for the `Simulation` resource.

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> SimulationName

## Implements

[IResourceName](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.IResourceName.html), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[SimulationName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName)

## Inherited Members

[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype)

## Namespace

[Google.Cloud.SecurityCenter.V2](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2)

## Assembly

Google.Cloud.SecurityCenter.V2.dll

## Constructors

### SimulationName(string, string)

    public SimulationName(string organizationId, string simulationId)

Constructs a new instance of a [SimulationName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName) class from the component parts of pattern
`organizations/{organization}/simulations/{simulation}`

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `organizationId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Organization` ID. Must not be `null` or empty. |
| `simulationId` | `https://learn.microsoft.com/dotnet/api/system.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** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### LocationId

    public string LocationId { get; }

The `Location` ID. May be `null`, depending on which resource name is contained by this instance.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### 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** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### SimluationId

    public string SimluationId { get; }

The `Simluation` ID. May be `null`, depending on which resource name is contained by this
instance.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### SimulationId

    public string SimulationId { get; }

The `Simulation` ID. May be `null`, depending on which resource name is contained by this
instance.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### Type

    public SimulationName.ResourceNameType Type { get; }

The [SimulationName.ResourceNameType](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName.ResourceNameType) of the contained resource name.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationNamehttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName.ResourceNameType` |   |

### UnparsedResource

    public UnparsedResourceName UnparsedResource { get; }

The contained [UnparsedResourceName](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.UnparsedResourceName.html). Only non-`null` if this instance contains an
unparsed resource name.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.UnparsedResourceName.html` |   |

## Methods

### Format(string, string)

    public static string Format(string organizationId, string simulationId)

Formats the IDs into the string representation of this [SimulationName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName) with pattern
`organizations/{organization}/simulations/{simulation}`.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `organizationId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Organization` ID. Must not be `null` or empty. |
| `simulationId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Simulation` ID. Must not be `null` or empty. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` | The string representation of this [SimulationName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName) with pattern `organizations/{organization}/simulations/{simulation}`. |

### FormatOrganizationLocationSimluation(string, string, string)

    public static string FormatOrganizationLocationSimluation(string organizationId, string locationId, string simluationId)

Formats the IDs into the string representation of this [SimulationName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName) with pattern
`organizations/{organization}/locations/{location}/simulations/{simluation}`.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `organizationId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Organization` ID. Must not be `null` or empty. |
| `locationId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Location` ID. Must not be `null` or empty. |
| `simluationId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Simluation` ID. Must not be `null` or empty. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` | The string representation of this [SimulationName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName) with pattern `organizations/{organization}/locations/{location}/simulations/{simluation}`. |

### FormatOrganizationSimulation(string, string)

    public static string FormatOrganizationSimulation(string organizationId, string simulationId)

Formats the IDs into the string representation of this [SimulationName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName) with pattern
`organizations/{organization}/simulations/{simulation}`.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `organizationId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Organization` ID. Must not be `null` or empty. |
| `simulationId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Simulation` ID. Must not be `null` or empty. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` | The string representation of this [SimulationName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName) with pattern `organizations/{organization}/simulations/{simulation}`. |

### FromOrganizationLocationSimluation(string, string, string)

    public static SimulationName FromOrganizationLocationSimluation(string organizationId, string locationId, string simluationId)

Creates a [SimulationName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName) with the pattern
`organizations/{organization}/locations/{location}/simulations/{simluation}`.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `organizationId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Organization` ID. Must not be `null` or empty. |
| `locationId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Location` ID. Must not be `null` or empty. |
| `simluationId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Simluation` ID. Must not be `null` or empty. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName` | A new instance of [SimulationName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName) constructed from the provided ids. |

### FromOrganizationSimulation(string, string)

    public static SimulationName FromOrganizationSimulation(string organizationId, string simulationId)

Creates a [SimulationName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName) with the pattern
`organizations/{organization}/simulations/{simulation}`.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `organizationId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Organization` ID. Must not be `null` or empty. |
| `simulationId` | `https://learn.microsoft.com/dotnet/api/system.string` The `Simulation` ID. Must not be `null` or empty. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName` | A new instance of [SimulationName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName) constructed from the provided ids. |

### FromUnparsed(UnparsedResourceName)

    public static SimulationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a [SimulationName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName) containing an unparsed resource name.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `unparsedResourceName` | `https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.UnparsedResourceName.html` The unparsed resource name. Must not be `null`. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName` | A new instance of [SimulationName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName) containing the provided `unparsedResourceName`. |

### GetHashCode()

    public override int GetHashCode()

Returns a hash code for this resource name.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int32` |   |

**Overrides** [object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode)

### Parse(string)

    public static SimulationName Parse(string simulationName)

Parses the given resource name string into a new [SimulationName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName) instance.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `simulationName` | `https://learn.microsoft.com/dotnet/api/system.string` The resource name in string form. Must not be `null`. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName` | The parsed [SimulationName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName) if successful. |

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

- `organizations/{organization}/simulations/{simulation}`
- `organizations/{organization}/locations/{location}/simulations/{simluation}`

<br />

### Parse(string, bool)

    public static SimulationName Parse(string simulationName, bool allowUnparsed)

Parses the given resource name string into a new [SimulationName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName) instance; optionally allowing
an unparseable resource name.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `simulationName` | `https://learn.microsoft.com/dotnet/api/system.string` The resource name in string form. Must not be `null`. |
| `allowUnparsed` | `https://learn.microsoft.com/dotnet/api/system.boolean` If `true` will successfully store an unparseable resource name into the [UnparsedResource](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName#Google_Cloud_SecurityCenter_V2_SimulationName_UnparsedResource) property; otherwise will throw an [ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception) if an unparseable resource name is specified. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName` | The parsed [SimulationName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName) if successful. |

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

- `organizations/{organization}/simulations/{simulation}`
- `organizations/{organization}/locations/{location}/simulations/{simluation}`

Or may be in any format if `allowUnparsed` is `true`.

<br />

### ToString()

    public override string ToString()

The string representation of the resource name.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` | The string representation of the resource name. |

**Overrides** [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

### TryParse(string, out SimulationName)

    public static bool TryParse(string simulationName, out SimulationName result)

Tries to parse the given resource name string into a new [SimulationName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName) instance.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `simulationName` | `https://learn.microsoft.com/dotnet/api/system.string` The resource name in string form. Must not be `null`. |
| `result` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName` When this method returns, the parsed [SimulationName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName), or `null` if parsing failed. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.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}/simulations/{simulation}`
- `organizations/{organization}/locations/{location}/simulations/{simluation}`

<br />

### TryParse(string, bool, out SimulationName)

    public static bool TryParse(string simulationName, bool allowUnparsed, out SimulationName result)

Tries to parse the given resource name string into a new [SimulationName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName) instance; optionally
allowing an unparseable resource name.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `simulationName` | `https://learn.microsoft.com/dotnet/api/system.string` The resource name in string form. Must not be `null`. |
| `allowUnparsed` | `https://learn.microsoft.com/dotnet/api/system.boolean` If `true` will successfully store an unparseable resource name into the [UnparsedResource](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName#Google_Cloud_SecurityCenter_V2_SimulationName_UnparsedResource) property; otherwise will throw an [ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception) if an unparseable resource name is specified. |
| `result` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName` When this method returns, the parsed [SimulationName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName), or `null` if parsing failed. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.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}/simulations/{simulation}`
- `organizations/{organization}/locations/{location}/simulations/{simluation}`

Or may be in any format if `allowUnparsed` is `true`.

<br />

## Operators

### operator ==(SimulationName, SimulationName)

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

Determines whether two specified resource names have the same value.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `a` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName` The first resource name to compare, or null. |
| `b` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName` The second resource name to compare, or null. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` | true if the value of `a` is the same as the value of `b`; otherwise, false. |

### operator !=(SimulationName, SimulationName)

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

Determines whether two specified resource names have different values.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `a` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName` The first resource name to compare, or null. |
| `b` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.SecurityCenter.V2/latest/Google.Cloud.SecurityCenter.V2.SimulationName` The second resource name to compare, or null. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` | true if the value of `a` is different from the value of `b`; otherwise, false. |