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.
Namespace
Google.Cloud.SecurityCenter.V2Assembly
Google.Cloud.SecurityCenter.V2.dll
Constructors
SimulationName(string, string)
public SimulationName(string organizationId, string simulationId)
Constructs a new instance of a SimulationName class from the component parts of pattern
organizations/{organization}/simulations/{simulation}
Parameters | |
---|---|
Name | Description |
organizationId |
string The |
simulationId |
string The |
Properties
IsKnownPattern
public bool IsKnownPattern { get; }
Whether this instance contains a resource name with a known pattern.
Property Value | |
---|---|
Type | Description |
bool |
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 |
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 |
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 |
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 |
string |
Type
public SimulationName.ResourceNameType Type { get; }
The SimulationName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
SimulationNameResourceNameType |
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 SimulationName with pattern
organizations/{organization}/simulations/{simulation}
.
Parameters | |
---|---|
Name | Description |
organizationId |
string The |
simulationId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this SimulationName with pattern
|
FormatOrganizationLocationSimluation(string, string, string)
public static string FormatOrganizationLocationSimluation(string organizationId, string locationId, string simluationId)
Formats the IDs into the string representation of this SimulationName with pattern
organizations/{organization}/locations/{location}/simulations/{simluation}
.
Parameters | |
---|---|
Name | Description |
organizationId |
string The |
locationId |
string The |
simluationId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this SimulationName with pattern
|
FormatOrganizationSimulation(string, string)
public static string FormatOrganizationSimulation(string organizationId, string simulationId)
Formats the IDs into the string representation of this SimulationName with pattern
organizations/{organization}/simulations/{simulation}
.
Parameters | |
---|---|
Name | Description |
organizationId |
string The |
simulationId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this SimulationName with pattern
|
FromOrganizationLocationSimluation(string, string, string)
public static SimulationName FromOrganizationLocationSimluation(string organizationId, string locationId, string simluationId)
Creates a SimulationName with the pattern
organizations/{organization}/locations/{location}/simulations/{simluation}
.
Parameters | |
---|---|
Name | Description |
organizationId |
string The |
locationId |
string The |
simluationId |
string The |
Returns | |
---|---|
Type | Description |
SimulationName |
A new instance of SimulationName constructed from the provided ids. |
FromOrganizationSimulation(string, string)
public static SimulationName FromOrganizationSimulation(string organizationId, string simulationId)
Creates a SimulationName with the pattern
organizations/{organization}/simulations/{simulation}
.
Parameters | |
---|---|
Name | Description |
organizationId |
string The |
simulationId |
string The |
Returns | |
---|---|
Type | Description |
SimulationName |
A new instance of SimulationName constructed from the provided ids. |
FromUnparsed(UnparsedResourceName)
public static SimulationName FromUnparsed(UnparsedResourceName unparsedResourceName)
Creates a SimulationName containing an unparsed resource name.
Parameter | |
---|---|
Name | Description |
unparsedResourceName |
UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
SimulationName |
A new instance of SimulationName containing the provided
|
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
Parse(string)
public static SimulationName Parse(string simulationName)
Parses the given resource name string into a new SimulationName instance.
Parameter | |
---|---|
Name | Description |
simulationName |
string The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
SimulationName |
The parsed SimulationName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
organizations/{organization}/simulations/{simulation}
organizations/{organization}/locations/{location}/simulations/{simluation}
Parse(string, bool)
public static SimulationName Parse(string simulationName, bool allowUnparsed)
Parses the given resource name string into a new SimulationName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
simulationName |
string The resource name in string form. Must not be |
allowUnparsed |
bool If |
Returns | |
---|---|
Type | Description |
SimulationName |
The parsed SimulationName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
organizations/{organization}/simulations/{simulation}
organizations/{organization}/locations/{location}/simulations/{simluation}
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. |
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 instance.
Parameters | |
---|---|
Name | Description |
simulationName |
string The resource name in string form. Must not be |
result |
SimulationName When this method returns, the parsed SimulationName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
organizations/{organization}/simulations/{simulation}
organizations/{organization}/locations/{location}/simulations/{simluation}
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 instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
simulationName |
string The resource name in string form. Must not be |
allowUnparsed |
bool If |
result |
SimulationName When this method returns, the parsed SimulationName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
organizations/{organization}/simulations/{simulation}
organizations/{organization}/locations/{location}/simulations/{simluation}
allowUnparsed
is true
.
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 |
SimulationName The first resource name to compare, or null. |
b |
SimulationName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |
operator !=(SimulationName, SimulationName)
public static bool operator !=(SimulationName a, SimulationName b)
Determines whether two specified resource names have different values.
Parameters | |
---|---|
Name | Description |
a |
SimulationName The first resource name to compare, or null. |
b |
SimulationName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |