Security Command Center v2 API - Class ValuedResourceName (1.0.0-beta01)

public sealed class ValuedResourceName : IResourceName, IEquatable<ValuedResourceName>

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

Resource name for the ValuedResource resource.

Inheritance

object > ValuedResourceName

Implements

IResourceName, IEquatable ValuedResourceName

Inherited Members

object.GetType()

Namespace

Google.Cloud.SecurityCenter.V2

Assembly

Google.Cloud.SecurityCenter.V2.dll

Constructors

ValuedResourceName(string, string, string)

public ValuedResourceName(string organizationId, string simulationId, string valuedResourceId)

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

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.

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

The ValuedResourceName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ValuedResourceNameResourceNameType`

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)

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

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

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.

Returns
Type	Description
`string`	The string representation of this ValuedResourceName with pattern `organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}`.

FormatOrganizationSimulationValuedResource(string, string, string)

public static string FormatOrganizationSimulationValuedResource(string organizationId, string simulationId, string valuedResourceId)

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

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.

Returns
Type	Description
`string`	The string representation of this ValuedResourceName with pattern `organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}`.

FromOrganizationSimulationValuedResource(string, string, string)

public static ValuedResourceName FromOrganizationSimulationValuedResource(string organizationId, string simulationId, string valuedResourceId)

Creates a ValuedResourceName with the pattern organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}.

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.

Returns
Type	Description
`ValuedResourceName`	A new instance of ValuedResourceName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ValuedResourceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ValuedResourceName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`ValuedResourceName`	A new instance of ValuedResourceName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static ValuedResourceName Parse(string valuedResourceName)

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

Parameter
Name	Description
`valuedResourceName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`ValuedResourceName`	The parsed ValuedResourceName if successful.

Remarks

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

organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}

Parse(string, bool)

public static ValuedResourceName Parse(string valuedResourceName, bool allowUnparsed)

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

Parameters
Name	Description
`valuedResourceName`	`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
`ValuedResourceName`	The parsed ValuedResourceName if successful.

Remarks

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

organizations/{organization}/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

object.ToString()

TryParse(string, out ValuedResourceName)

public static bool TryParse(string valuedResourceName, out ValuedResourceName result)

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

Parameters
Name	Description
`valuedResourceName`	`string` The resource name in string form. Must not be `null`.
`result`	`ValuedResourceName` When this method returns, the parsed ValuedResourceName, 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}

TryParse(string, bool, out ValuedResourceName)

public static bool TryParse(string valuedResourceName, bool allowUnparsed, out ValuedResourceName result)

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

Parameters
Name	Description
`valuedResourceName`	`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`	`ValuedResourceName` When this method returns, the parsed ValuedResourceName, 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}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ValuedResourceName, ValuedResourceName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`ValuedResourceName` The first resource name to compare, or null.
`b`	`ValuedResourceName` 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 !=(ValuedResourceName, ValuedResourceName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`ValuedResourceName` The first resource name to compare, or null.
`b`	`ValuedResourceName` 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.