Security Command Center v2 API - Class AttackPathName (1.3.0) 

public sealed class AttackPathName : IResourceName, IEquatable<AttackPathName>

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

Resource name for the AttackPath resource.

Inheritance

object > AttackPathName

Namespace

Google.Cloud.SecurityCenter.V2

Assembly

Google.Cloud.SecurityCenter.V2.dll

Constructors

AttackPathName(string, string, string, string)

public AttackPathName(string organizationId, string simulationId, string valuedResourceId, string attackPathId)

Constructs a new instance of a AttackPathName class from the component parts of pattern organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}/attackPaths/{attack_path}

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.
valuedResourceId string

The ValuedResource ID. Must not be null or empty.
attackPathId string

The AttackPath ID. Must not be null or empty.

Properties

AttackPathId

public string AttackPathId { get; }

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

Property Value
Type Description
string

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

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

The AttackPathName.ResourceNameType of the contained resource name.

Property Value
Type Description
AttackPathNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type Description
UnparsedResourceName

ValuedResourceId

public string ValuedResourceId { get; }

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

Property Value
Type Description
string

Methods

Format(string, string, string, string)

public static string Format(string organizationId, string simulationId, string valuedResourceId, string attackPathId)

Formats the IDs into the string representation of this AttackPathName with pattern organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}/attackPaths/{attack_path} .

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.
valuedResourceId string

The ValuedResource ID. Must not be null or empty.
attackPathId string

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

The string representation of this AttackPathName with pattern organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}/attackPaths/{attack_path} .

FormatOrganizationLocationSimulationValuedResourceAttackPath(string, string, string, string, string)

public static string FormatOrganizationLocationSimulationValuedResourceAttackPath(string organizationId, string locationId, string simulationId, string valuedResourceId, string attackPathId)

Formats the IDs into the string representation of this AttackPathName with pattern organizations/{organization}/locations/{location}/simulations/{simulation}/valuedResources/{valued_resource}/attackPaths/{attack_path} .

Parameters
Name Description
organizationId string

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

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

The Simulation ID. Must not be null or empty.
valuedResourceId string

The ValuedResource ID. Must not be null or empty.
attackPathId string

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

The string representation of this AttackPathName with pattern organizations/{organization}/locations/{location}/simulations/{simulation}/valuedResources/{valued_resource}/attackPaths/{attack_path} .

FormatOrganizationSimulationValuedResourceAttackPath(string, string, string, string)

public static string FormatOrganizationSimulationValuedResourceAttackPath(string organizationId, string simulationId, string valuedResourceId, string attackPathId)

Formats the IDs into the string representation of this AttackPathName with pattern organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}/attackPaths/{attack_path} .

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.
valuedResourceId string

The ValuedResource ID. Must not be null or empty.
attackPathId string

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

The string representation of this AttackPathName with pattern organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}/attackPaths/{attack_path} .

FromOrganizationLocationSimulationValuedResourceAttackPath(string, string, string, string, string)

public static AttackPathName FromOrganizationLocationSimulationValuedResourceAttackPath(string organizationId, string locationId, string simulationId, string valuedResourceId, string attackPathId)

Creates a AttackPathName with the pattern organizations/{organization}/locations/{location}/simulations/{simulation}/valuedResources/{valued_resource}/attackPaths/{attack_path} .

Parameters
Name Description
organizationId string

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

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

The Simulation ID. Must not be null or empty.
valuedResourceId string

The ValuedResource ID. Must not be null or empty.
attackPathId string

The AttackPath ID. Must not be null or empty.
Returns
Type Description
AttackPathName

A new instance of AttackPathName constructed from the provided ids.

FromOrganizationSimulationValuedResourceAttackPath(string, string, string, string)

public static AttackPathName FromOrganizationSimulationValuedResourceAttackPath(string organizationId, string simulationId, string valuedResourceId, string attackPathId)

Creates a AttackPathName with the pattern organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}/attackPaths/{attack_path} .

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.
valuedResourceId string

The ValuedResource ID. Must not be null or empty.
attackPathId string

The AttackPath ID. Must not be null or empty.
Returns
Type Description
AttackPathName

A new instance of AttackPathName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AttackPathName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AttackPathName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
attackPathName string

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

The parsed AttackPathName if successful.
Remarks

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

  • organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}/attackPaths/{attack_path}
  • organizations/{organization}/locations/{location}/simulations/{simulation}/valuedResources/{valued_resource}/attackPaths/{attack_path}

Parse(string, bool)

public static AttackPathName Parse(string attackPathName, bool allowUnparsed)

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

Parameters
Name Description
attackPathName 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
AttackPathName

The parsed AttackPathName if successful.
Remarks

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

  • organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}/attackPaths/{attack_path}
  • organizations/{organization}/locations/{location}/simulations/{simulation}/valuedResources/{valued_resource}/attackPaths/{attack_path}
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 AttackPathName)

public static bool TryParse(string attackPathName, out AttackPathName result)

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

Parameters
Name Description
attackPathName string

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

When this method returns, the parsed AttackPathName, 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}/valuedResources/{valued_resource}/attackPaths/{attack_path}
  • organizations/{organization}/locations/{location}/simulations/{simulation}/valuedResources/{valued_resource}/attackPaths/{attack_path}

TryParse(string, bool, out AttackPathName)

public static bool TryParse(string attackPathName, bool allowUnparsed, out AttackPathName result)

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

Parameters
Name Description
attackPathName 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 AttackPathName

When this method returns, the parsed AttackPathName, 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}/valuedResources/{valued_resource}/attackPaths/{attack_path}
  • organizations/{organization}/locations/{location}/simulations/{simulation}/valuedResources/{valued_resource}/attackPaths/{attack_path}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(AttackPathName, AttackPathName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AttackPathName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a AttackPathName

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

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.