Chronicle v1 API - Class CuratedRuleName (1.0.0-beta06) 

public sealed class CuratedRuleName : IResourceName, IEquatable<CuratedRuleName>

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

Resource name for the CuratedRule resource.

Inheritance

object > CuratedRuleName

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Constructors

CuratedRuleName(string, string, string, string)

public CuratedRuleName(string projectId, string locationId, string instanceId, string curatedRuleId)

Constructs a new instance of a CuratedRuleName class from the component parts of pattern projects/{project}/locations/{location}/instances/{instance}/curatedRules/{curatedRule}

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.
curatedRuleId string

The CuratedRule ID. Must not be null or empty.

Properties

CuratedRuleId

public string CuratedRuleId { get; }

The CuratedRule 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

Type

public CuratedRuleName.ResourceNameType Type { get; }

The CuratedRuleName.ResourceNameType of the contained resource name.

Property Value
Type Description
CuratedRuleNameResourceNameType

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)

public static string Format(string projectId, string locationId, string instanceId, string curatedRuleId)

Formats the IDs into the string representation of this CuratedRuleName with pattern projects/{project}/locations/{location}/instances/{instance}/curatedRules/{curatedRule}.

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.
curatedRuleId string

The CuratedRule ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this CuratedRuleName with pattern projects/{project}/locations/{location}/instances/{instance}/curatedRules/{curatedRule}.

FormatProjectLocationInstanceCuratedRule(string, string, string, string)

public static string FormatProjectLocationInstanceCuratedRule(string projectId, string locationId, string instanceId, string curatedRuleId)

Formats the IDs into the string representation of this CuratedRuleName with pattern projects/{project}/locations/{location}/instances/{instance}/curatedRules/{curatedRule}.

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.
curatedRuleId string

The CuratedRule ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this CuratedRuleName with pattern projects/{project}/locations/{location}/instances/{instance}/curatedRules/{curatedRule}.

FromProjectLocationInstanceCuratedRule(string, string, string, string)

public static CuratedRuleName FromProjectLocationInstanceCuratedRule(string projectId, string locationId, string instanceId, string curatedRuleId)

Creates a CuratedRuleName with the pattern projects/{project}/locations/{location}/instances/{instance}/curatedRules/{curatedRule}.

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.
curatedRuleId string

The CuratedRule ID. Must not be null or empty.
Returns
Type Description
CuratedRuleName

A new instance of CuratedRuleName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CuratedRuleName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CuratedRuleName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
curatedRuleName string

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

The parsed CuratedRuleName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/curatedRules/{curatedRule}

Parse(string, bool)

public static CuratedRuleName Parse(string curatedRuleName, bool allowUnparsed)

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

Parameters
Name Description
curatedRuleName 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
CuratedRuleName

The parsed CuratedRuleName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/curatedRules/{curatedRule}

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

public static bool TryParse(string curatedRuleName, out CuratedRuleName result)

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

Parameters
Name Description
curatedRuleName string

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

When this method returns, the parsed CuratedRuleName, 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}/curatedRules/{curatedRule}

TryParse(string, bool, out CuratedRuleName)

public static bool TryParse(string curatedRuleName, bool allowUnparsed, out CuratedRuleName result)

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

Parameters
Name Description
curatedRuleName 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 CuratedRuleName

When this method returns, the parsed CuratedRuleName, 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}/curatedRules/{curatedRule}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(CuratedRuleName, CuratedRuleName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a CuratedRuleName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a CuratedRuleName

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

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.