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

public sealed class ResourceValueConfigName : IResourceName, IEquatable<ResourceValueConfigName>

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

Resource name for the ResourceValueConfig resource.

Inheritance

object > ResourceValueConfigName

Implements

IResourceName, IEquatable ResourceValueConfigName

Inherited Members

object.GetType()

Namespace

Google.Cloud.SecurityCenter.V2

Assembly

Google.Cloud.SecurityCenter.V2.dll

Constructors

ResourceValueConfigName(string, string)

public ResourceValueConfigName(string organizationId, string resourceValueConfigId)

Constructs a new instance of a ResourceValueConfigName class from the component parts of pattern organizations/{organization}/resourceValueConfigs/{resource_value_config}

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`resourceValueConfigId`	`string` The `ResourceValueConfig` 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. 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`

ResourceValueConfigId

public string ResourceValueConfigId { get; }

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

Property Value
Type	Description
`string`

Type

public ResourceValueConfigName.ResourceNameType Type { get; }

The ResourceValueConfigName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ResourceValueConfigNameResourceNameType`

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 resourceValueConfigId)

Formats the IDs into the string representation of this ResourceValueConfigName with pattern organizations/{organization}/resourceValueConfigs/{resource_value_config}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`resourceValueConfigId`	`string` The `ResourceValueConfig` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ResourceValueConfigName with pattern `organizations/{organization}/resourceValueConfigs/{resource_value_config}`.

FormatOrganizationLocationResourceValueConfig(string, string, string)

public static string FormatOrganizationLocationResourceValueConfig(string organizationId, string locationId, string resourceValueConfigId)

Formats the IDs into the string representation of this ResourceValueConfigName with pattern organizations/{organization}/locations/{location}/resourceValueConfigs/{resource_value_config}.

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.
`resourceValueConfigId`	`string` The `ResourceValueConfig` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ResourceValueConfigName with pattern `organizations/{organization}/locations/{location}/resourceValueConfigs/{resource_value_config}`.

FormatOrganizationResourceValueConfig(string, string)

public static string FormatOrganizationResourceValueConfig(string organizationId, string resourceValueConfigId)

Formats the IDs into the string representation of this ResourceValueConfigName with pattern organizations/{organization}/resourceValueConfigs/{resource_value_config}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`resourceValueConfigId`	`string` The `ResourceValueConfig` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ResourceValueConfigName with pattern `organizations/{organization}/resourceValueConfigs/{resource_value_config}`.

FromOrganizationLocationResourceValueConfig(string, string, string)

public static ResourceValueConfigName FromOrganizationLocationResourceValueConfig(string organizationId, string locationId, string resourceValueConfigId)

Creates a ResourceValueConfigName with the pattern organizations/{organization}/locations/{location}/resourceValueConfigs/{resource_value_config}.

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.
`resourceValueConfigId`	`string` The `ResourceValueConfig` ID. Must not be `null` or empty.

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

FromOrganizationResourceValueConfig(string, string)

public static ResourceValueConfigName FromOrganizationResourceValueConfig(string organizationId, string resourceValueConfigId)

Creates a ResourceValueConfigName with the pattern organizations/{organization}/resourceValueConfigs/{resource_value_config}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`resourceValueConfigId`	`string` The `ResourceValueConfig` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static ResourceValueConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ResourceValueConfigName containing an unparsed resource name.

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

Returns
Type	Description
`ResourceValueConfigName`	A new instance of ResourceValueConfigName 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 ResourceValueConfigName Parse(string resourceValueConfigName)

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

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

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

Remarks

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

organizations/{organization}/resourceValueConfigs/{resource_value_config}
organizations/{organization}/locations/{location}/resourceValueConfigs/{resource_value_config}

Parse(string, bool)

public static ResourceValueConfigName Parse(string resourceValueConfigName, bool allowUnparsed)

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

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

Remarks

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

organizations/{organization}/resourceValueConfigs/{resource_value_config}
organizations/{organization}/locations/{location}/resourceValueConfigs/{resource_value_config}

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 ResourceValueConfigName)

public static bool TryParse(string resourceValueConfigName, out ResourceValueConfigName result)

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

Parameters
Name	Description
`resourceValueConfigName`	`string` The resource name in string form. Must not be `null`.
`result`	`ResourceValueConfigName` When this method returns, the parsed ResourceValueConfigName, 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}/resourceValueConfigs/{resource_value_config}
organizations/{organization}/locations/{location}/resourceValueConfigs/{resource_value_config}

TryParse(string, bool, out ResourceValueConfigName)

public static bool TryParse(string resourceValueConfigName, bool allowUnparsed, out ResourceValueConfigName result)

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

Parameters
Name	Description
`resourceValueConfigName`	`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`	`ResourceValueConfigName` When this method returns, the parsed ResourceValueConfigName, 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}/resourceValueConfigs/{resource_value_config}
organizations/{organization}/locations/{location}/resourceValueConfigs/{resource_value_config}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ResourceValueConfigName, ResourceValueConfigName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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