Security Command Center v2 API - Class OrganizationValuedResourceName (1.0.0-beta04) 

public sealed class OrganizationValuedResourceName : IResourceName, IEquatable<OrganizationValuedResourceName>

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

Resource name for the OrganizationValuedResource resource.

Inheritance

object > OrganizationValuedResourceName

Namespace

Google.Cloud.SecurityCenter.V2

Assembly

Google.Cloud.SecurityCenter.V2.dll

Constructors

OrganizationValuedResourceName(string, string, string, string)

public OrganizationValuedResourceName(string organizationId, string locationId, string simulationId, string valuedResourceId)

Constructs a new instance of a OrganizationValuedResourceName class from the component parts of pattern organizations/{organization}/locations/{location}/simulations/{simulation}/valuedResources/{valued_resource}

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.

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. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

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

The OrganizationValuedResourceName.ResourceNameType of the contained resource name.

Property Value
Type Description
OrganizationValuedResourceNameResourceNameType

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. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

Methods

Format(string, string, string, string)

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

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

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.
Returns
Type Description
string

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

FormatOrganizationLocationSimulationValuedResource(string, string, string, string)

public static string FormatOrganizationLocationSimulationValuedResource(string organizationId, string locationId, string simulationId, string valuedResourceId)

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

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.
Returns
Type Description
string

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

FromOrganizationLocationSimulationValuedResource(string, string, string, string)

public static OrganizationValuedResourceName FromOrganizationLocationSimulationValuedResource(string organizationId, string locationId, string simulationId, string valuedResourceId)

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

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.
Returns
Type Description
OrganizationValuedResourceName

A new instance of OrganizationValuedResourceName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static OrganizationValuedResourceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a OrganizationValuedResourceName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
organizationValuedResourceName string

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

The parsed OrganizationValuedResourceName if successful.
Remarks

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

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

Parse(string, bool)

public static OrganizationValuedResourceName Parse(string organizationValuedResourceName, bool allowUnparsed)

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

Parameters
Name Description
organizationValuedResourceName 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
OrganizationValuedResourceName

The parsed OrganizationValuedResourceName if successful.
Remarks

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

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

public static bool TryParse(string organizationValuedResourceName, out OrganizationValuedResourceName result)

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

Parameters
Name Description
organizationValuedResourceName string

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

When this method returns, the parsed OrganizationValuedResourceName, 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}/locations/{location}/simulations/{simulation}/valuedResources/{valued_resource}

TryParse(string, bool, out OrganizationValuedResourceName)

public static bool TryParse(string organizationValuedResourceName, bool allowUnparsed, out OrganizationValuedResourceName result)

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

Parameters
Name Description
organizationValuedResourceName 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 OrganizationValuedResourceName

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

Operators

operator ==(OrganizationValuedResourceName, OrganizationValuedResourceName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a OrganizationValuedResourceName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a OrganizationValuedResourceName

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

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.