Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Chronicle v1 API - Class CuratedRuleSetName (1.0.0-beta07)

public sealed class CuratedRuleSetName : IResourceName, IEquatable<CuratedRuleSetName>

Reference documentation and code samples for the Chronicle v1 API class CuratedRuleSetName.

Resource name for the CuratedRuleSet resource.

Inheritance

object > CuratedRuleSetName

Implements

IResourceName, IEquatable CuratedRuleSetName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Constructors

CuratedRuleSetName(string, string, string, string, string)

public CuratedRuleSetName(string projectId, string locationId, string instanceId, string categoryId, string ruleSetId)

Constructs a new instance of a CuratedRuleSetName class from the component parts of pattern projects/{project}/locations/{location}/instances/{instance}/curatedRuleSetCategories/{category}/curatedRuleSets/{rule_set}

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.
`instanceId`	`string` The `Instance` ID. Must not be `null` or empty.
`categoryId`	`string` The `Category` ID. Must not be `null` or empty.
`ruleSetId`	`string` The `RuleSet` ID. Must not be `null` or empty.

Properties

CategoryId

public string CategoryId { get; }

The Category ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`string`

InstanceId

public string InstanceId { get; }

The Instance ID. Will not be null, unless this instance contains an unparsed resource name.

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

Property Value
Type	Description
`string`

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`string`

RuleSetId

public string RuleSetId { get; }

The RuleSet ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`string`

Type

public CuratedRuleSetName.ResourceNameType Type { get; }

The CuratedRuleSetName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`CuratedRuleSetNameResourceNameType`

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, string, string, string)

public static string Format(string projectId, string locationId, string instanceId, string categoryId, string ruleSetId)

Formats the IDs into the string representation of this CuratedRuleSetName with pattern projects/{project}/locations/{location}/instances/{instance}/curatedRuleSetCategories/{category}/curatedRuleSets/{rule_set} .

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.
`instanceId`	`string` The `Instance` ID. Must not be `null` or empty.
`categoryId`	`string` The `Category` ID. Must not be `null` or empty.
`ruleSetId`	`string` The `RuleSet` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this CuratedRuleSetName with pattern `projects/{project}/locations/{location}/instances/{instance}/curatedRuleSetCategories/{category}/curatedRuleSets/{rule_set}` .

FormatProjectLocationInstanceCategoryRuleSet(string, string, string, string, string)

public static string FormatProjectLocationInstanceCategoryRuleSet(string projectId, string locationId, string instanceId, string categoryId, string ruleSetId)

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.
`instanceId`	`string` The `Instance` ID. Must not be `null` or empty.
`categoryId`	`string` The `Category` ID. Must not be `null` or empty.
`ruleSetId`	`string` The `RuleSet` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this CuratedRuleSetName with pattern `projects/{project}/locations/{location}/instances/{instance}/curatedRuleSetCategories/{category}/curatedRuleSets/{rule_set}` .

FromProjectLocationInstanceCategoryRuleSet(string, string, string, string, string)

public static CuratedRuleSetName FromProjectLocationInstanceCategoryRuleSet(string projectId, string locationId, string instanceId, string categoryId, string ruleSetId)

Creates a CuratedRuleSetName with the pattern projects/{project}/locations/{location}/instances/{instance}/curatedRuleSetCategories/{category}/curatedRuleSets/{rule_set} .

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.
`instanceId`	`string` The `Instance` ID. Must not be `null` or empty.
`categoryId`	`string` The `Category` ID. Must not be `null` or empty.
`ruleSetId`	`string` The `RuleSet` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static CuratedRuleSetName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CuratedRuleSetName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/locations/{location}/instances/{instance}/curatedRuleSetCategories/{category}/curatedRuleSets/{rule_set}

Parse(string, bool)

public static CuratedRuleSetName Parse(string curatedRuleSetName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/instances/{instance}/curatedRuleSetCategories/{category}/curatedRuleSets/{rule_set}

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

public static bool TryParse(string curatedRuleSetName, out CuratedRuleSetName result)

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

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

projects/{project}/locations/{location}/instances/{instance}/curatedRuleSetCategories/{category}/curatedRuleSets/{rule_set}

TryParse(string, bool, out CuratedRuleSetName)

public static bool TryParse(string curatedRuleSetName, bool allowUnparsed, out CuratedRuleSetName result)

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

Parameters
Name	Description
`curatedRuleSetName`	`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`	`CuratedRuleSetName` When this method returns, the parsed CuratedRuleSetName, 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:

projects/{project}/locations/{location}/instances/{instance}/curatedRuleSetCategories/{category}/curatedRuleSets/{rule_set}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(CuratedRuleSetName, CuratedRuleSetName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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