Google Cloud Security Command Center Settings v1beta1 API - Class ComponentSettingsName (2.0.0-beta04)

public sealed class ComponentSettingsName : IResourceName, IEquatable<ComponentSettingsName>

Reference documentation and code samples for the Google Cloud Security Command Center Settings v1beta1 API class ComponentSettingsName.

Resource name for the ComponentSettings resource.

Inheritance

object > ComponentSettingsName

Implements

IResourceName, IEquatable ComponentSettingsName

Inherited Members

object.GetType()

Namespace

Google.Cloud.SecurityCenter.Settings.V1Beta1

Assembly

Google.Cloud.SecurityCenter.Settings.V1Beta1.dll

Constructors

ComponentSettingsName(string, string)

public ComponentSettingsName(string organizationId, string componentId)

Constructs a new instance of a ComponentSettingsName class from the component parts of pattern organizations/{organization}/components/{component}/settings

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

Properties

ClusterId

public string ClusterId { get; }

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

Property Value
Type	Description
`string`

ComponentId

public string ComponentId { get; }

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

Property Value
Type	Description
`string`

FolderId

public string FolderId { get; }

The Folder 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`

ProjectId

public string ProjectId { get; }

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

Property Value
Type	Description
`string`

RegionId

public string RegionId { get; }

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

Property Value
Type	Description
`string`

Type

public ComponentSettingsName.ResourceNameType Type { get; }

The ComponentSettingsName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ComponentSettingsNameResourceNameType`

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type	Description
`UnparsedResourceName`

ZoneId

public string ZoneId { get; }

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

Property Value
Type	Description
`string`

Methods

Format(string, string)

public static string Format(string organizationId, string componentId)

Formats the IDs into the string representation of this ComponentSettingsName with pattern organizations/{organization}/components/{component}/settings.

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

Returns
Type	Description
`string`	The string representation of this ComponentSettingsName with pattern `organizations/{organization}/components/{component}/settings`.

FormatFolderComponent(string, string)

public static string FormatFolderComponent(string folderId, string componentId)

Formats the IDs into the string representation of this ComponentSettingsName with pattern folders/{folder}/components/{component}/settings.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`componentId`	`string` The `Component` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ComponentSettingsName with pattern `folders/{folder}/components/{component}/settings`.

FormatOrganizationComponent(string, string)

public static string FormatOrganizationComponent(string organizationId, string componentId)

Formats the IDs into the string representation of this ComponentSettingsName with pattern organizations/{organization}/components/{component}/settings.

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

Returns
Type	Description
`string`	The string representation of this ComponentSettingsName with pattern `organizations/{organization}/components/{component}/settings`.

FormatProjectComponent(string, string)

public static string FormatProjectComponent(string projectId, string componentId)

Formats the IDs into the string representation of this ComponentSettingsName with pattern projects/{project}/components/{component}/settings.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`componentId`	`string` The `Component` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ComponentSettingsName with pattern `projects/{project}/components/{component}/settings`.

FormatProjectLocationClusterComponent(string, string, string, string)

public static string FormatProjectLocationClusterComponent(string projectId, string locationId, string clusterId, string componentId)

Formats the IDs into the string representation of this ComponentSettingsName with pattern projects/{project}/locations/{location}/clusters/{cluster}/components/{component}/settings.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`clusterId`	`string` The `Cluster` ID. Must not be `null` or empty.
`componentId`	`string` The `Component` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ComponentSettingsName with pattern `projects/{project}/locations/{location}/clusters/{cluster}/components/{component}/settings`.

FormatProjectRegionClusterComponent(string, string, string, string)

public static string FormatProjectRegionClusterComponent(string projectId, string regionId, string clusterId, string componentId)

Formats the IDs into the string representation of this ComponentSettingsName with pattern projects/{project}/regions/{region}/clusters/{cluster}/components/{component}/settings.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`regionId`	`string` The `Region` ID. Must not be `null` or empty.
`clusterId`	`string` The `Cluster` ID. Must not be `null` or empty.
`componentId`	`string` The `Component` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ComponentSettingsName with pattern `projects/{project}/regions/{region}/clusters/{cluster}/components/{component}/settings`.

FormatProjectZoneClusterComponent(string, string, string, string)

public static string FormatProjectZoneClusterComponent(string projectId, string zoneId, string clusterId, string componentId)

Formats the IDs into the string representation of this ComponentSettingsName with pattern projects/{project}/zones/{zone}/clusters/{cluster}/components/{component}/settings.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`zoneId`	`string` The `Zone` ID. Must not be `null` or empty.
`clusterId`	`string` The `Cluster` ID. Must not be `null` or empty.
`componentId`	`string` The `Component` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ComponentSettingsName with pattern `projects/{project}/zones/{zone}/clusters/{cluster}/components/{component}/settings`.

FromFolderComponent(string, string)

public static ComponentSettingsName FromFolderComponent(string folderId, string componentId)

Creates a ComponentSettingsName with the pattern folders/{folder}/components/{component}/settings.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`componentId`	`string` The `Component` ID. Must not be `null` or empty.

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

FromOrganizationComponent(string, string)

public static ComponentSettingsName FromOrganizationComponent(string organizationId, string componentId)

Creates a ComponentSettingsName with the pattern organizations/{organization}/components/{component}/settings.

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

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

FromProjectComponent(string, string)

public static ComponentSettingsName FromProjectComponent(string projectId, string componentId)

Creates a ComponentSettingsName with the pattern projects/{project}/components/{component}/settings.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`componentId`	`string` The `Component` ID. Must not be `null` or empty.

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

FromProjectLocationClusterComponent(string, string, string, string)

public static ComponentSettingsName FromProjectLocationClusterComponent(string projectId, string locationId, string clusterId, string componentId)

Creates a ComponentSettingsName with the pattern projects/{project}/locations/{location}/clusters/{cluster}/components/{component}/settings.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`clusterId`	`string` The `Cluster` ID. Must not be `null` or empty.
`componentId`	`string` The `Component` ID. Must not be `null` or empty.

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

FromProjectRegionClusterComponent(string, string, string, string)

public static ComponentSettingsName FromProjectRegionClusterComponent(string projectId, string regionId, string clusterId, string componentId)

Creates a ComponentSettingsName with the pattern projects/{project}/regions/{region}/clusters/{cluster}/components/{component}/settings.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`regionId`	`string` The `Region` ID. Must not be `null` or empty.
`clusterId`	`string` The `Cluster` ID. Must not be `null` or empty.
`componentId`	`string` The `Component` ID. Must not be `null` or empty.

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

FromProjectZoneClusterComponent(string, string, string, string)

public static ComponentSettingsName FromProjectZoneClusterComponent(string projectId, string zoneId, string clusterId, string componentId)

Creates a ComponentSettingsName with the pattern projects/{project}/zones/{zone}/clusters/{cluster}/components/{component}/settings.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`zoneId`	`string` The `Zone` ID. Must not be `null` or empty.
`clusterId`	`string` The `Cluster` ID. Must not be `null` or empty.
`componentId`	`string` The `Component` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static ComponentSettingsName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ComponentSettingsName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

organizations/{organization}/components/{component}/settings
folders/{folder}/components/{component}/settings
projects/{project}/components/{component}/settings
projects/{project}/locations/{location}/clusters/{cluster}/components/{component}/settings
projects/{project}/regions/{region}/clusters/{cluster}/components/{component}/settings
projects/{project}/zones/{zone}/clusters/{cluster}/components/{component}/settings

Parse(string, bool)

public static ComponentSettingsName Parse(string componentSettingsName, bool allowUnparsed)

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

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

Remarks

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

organizations/{organization}/components/{component}/settings
folders/{folder}/components/{component}/settings
projects/{project}/components/{component}/settings
projects/{project}/locations/{location}/clusters/{cluster}/components/{component}/settings
projects/{project}/regions/{region}/clusters/{cluster}/components/{component}/settings
projects/{project}/zones/{zone}/clusters/{cluster}/components/{component}/settings

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

public static bool TryParse(string componentSettingsName, out ComponentSettingsName result)

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

Parameters
Name	Description
`componentSettingsName`	`string` The resource name in string form. Must not be `null`.
`result`	`ComponentSettingsName` When this method returns, the parsed ComponentSettingsName, 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}/components/{component}/settings
folders/{folder}/components/{component}/settings
projects/{project}/components/{component}/settings
projects/{project}/locations/{location}/clusters/{cluster}/components/{component}/settings
projects/{project}/regions/{region}/clusters/{cluster}/components/{component}/settings
projects/{project}/zones/{zone}/clusters/{cluster}/components/{component}/settings

TryParse(string, bool, out ComponentSettingsName)

public static bool TryParse(string componentSettingsName, bool allowUnparsed, out ComponentSettingsName result)

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

Parameters
Name	Description
`componentSettingsName`	`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`	`ComponentSettingsName` When this method returns, the parsed ComponentSettingsName, 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}/components/{component}/settings
folders/{folder}/components/{component}/settings
projects/{project}/components/{component}/settings
projects/{project}/locations/{location}/clusters/{cluster}/components/{component}/settings
projects/{project}/regions/{region}/clusters/{cluster}/components/{component}/settings
projects/{project}/zones/{zone}/clusters/{cluster}/components/{component}/settings

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ComponentSettingsName, ComponentSettingsName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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