Chronicle v1 API - Class RuleExecutionErrorName (1.0.0-beta06) 

public sealed class RuleExecutionErrorName : IResourceName, IEquatable<RuleExecutionErrorName>

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

Resource name for the RuleExecutionError resource.

Inheritance

object > RuleExecutionErrorName

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Constructors

RuleExecutionErrorName(string, string, string, string)

public RuleExecutionErrorName(string projectId, string locationId, string instanceId, string ruleExecutionErrorId)

Constructs a new instance of a RuleExecutionErrorName class from the component parts of pattern projects/{project}/locations/{location}/instances/{instance}/ruleExecutionErrors/{rule_execution_error}

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

The RuleExecutionError ID. Must not be null or empty.

Properties

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

RuleExecutionErrorId

public string RuleExecutionErrorId { get; }

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

Property Value
Type Description
string

Type

public RuleExecutionErrorName.ResourceNameType Type { get; }

The RuleExecutionErrorName.ResourceNameType of the contained resource name.

Property Value
Type Description
RuleExecutionErrorNameResourceNameType

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

Formats the IDs into the string representation of this RuleExecutionErrorName with pattern projects/{project}/locations/{location}/instances/{instance}/ruleExecutionErrors/{rule_execution_error} .

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

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

The string representation of this RuleExecutionErrorName with pattern projects/{project}/locations/{location}/instances/{instance}/ruleExecutionErrors/{rule_execution_error} .

FormatProjectLocationInstanceRuleExecutionError(string, string, string, string)

public static string FormatProjectLocationInstanceRuleExecutionError(string projectId, string locationId, string instanceId, string ruleExecutionErrorId)

Formats the IDs into the string representation of this RuleExecutionErrorName with pattern projects/{project}/locations/{location}/instances/{instance}/ruleExecutionErrors/{rule_execution_error} .

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

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

The string representation of this RuleExecutionErrorName with pattern projects/{project}/locations/{location}/instances/{instance}/ruleExecutionErrors/{rule_execution_error} .

FromProjectLocationInstanceRuleExecutionError(string, string, string, string)

public static RuleExecutionErrorName FromProjectLocationInstanceRuleExecutionError(string projectId, string locationId, string instanceId, string ruleExecutionErrorId)

Creates a RuleExecutionErrorName with the pattern projects/{project}/locations/{location}/instances/{instance}/ruleExecutionErrors/{rule_execution_error} .

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

The RuleExecutionError ID. Must not be null or empty.
Returns
Type Description
RuleExecutionErrorName

A new instance of RuleExecutionErrorName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static RuleExecutionErrorName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RuleExecutionErrorName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
ruleExecutionErrorName string

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

The parsed RuleExecutionErrorName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/ruleExecutionErrors/{rule_execution_error}

Parse(string, bool)

public static RuleExecutionErrorName Parse(string ruleExecutionErrorName, bool allowUnparsed)

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

Parameters
Name Description
ruleExecutionErrorName 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
RuleExecutionErrorName

The parsed RuleExecutionErrorName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/ruleExecutionErrors/{rule_execution_error}

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

public static bool TryParse(string ruleExecutionErrorName, out RuleExecutionErrorName result)

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

Parameters
Name Description
ruleExecutionErrorName string

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

When this method returns, the parsed RuleExecutionErrorName, 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}/ruleExecutionErrors/{rule_execution_error}

TryParse(string, bool, out RuleExecutionErrorName)

public static bool TryParse(string ruleExecutionErrorName, bool allowUnparsed, out RuleExecutionErrorName result)

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

Parameters
Name Description
ruleExecutionErrorName 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 RuleExecutionErrorName

When this method returns, the parsed RuleExecutionErrorName, 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}/ruleExecutionErrors/{rule_execution_error}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(RuleExecutionErrorName, RuleExecutionErrorName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a RuleExecutionErrorName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a RuleExecutionErrorName

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

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.