Chronicle v1 API - Class RetrohuntName (1.0.0-beta02) 

public sealed class RetrohuntName : IResourceName, IEquatable<RetrohuntName>

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

Resource name for the Retrohunt resource.

Inheritance

object > RetrohuntName

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Constructors

RetrohuntName(string, string, string, string, string)

public RetrohuntName(string projectId, string locationId, string instanceId, string ruleId, string retrohuntId)

Constructs a new instance of a RetrohuntName class from the component parts of pattern projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/retrohunts/{retrohunt}

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

The Rule ID. Must not be null or empty.
retrohuntId string

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

RetrohuntId

public string RetrohuntId { get; }

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

Property Value
Type Description
string

RuleId

public string RuleId { get; }

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

Property Value
Type Description
string

Type

public RetrohuntName.ResourceNameType Type { get; }

The RetrohuntName.ResourceNameType of the contained resource name.

Property Value
Type Description
RetrohuntNameResourceNameType

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

Formats the IDs into the string representation of this RetrohuntName with pattern projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/retrohunts/{retrohunt}.

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

The Rule ID. Must not be null or empty.
retrohuntId string

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

The string representation of this RetrohuntName with pattern projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/retrohunts/{retrohunt}.

FormatProjectLocationInstanceRuleRetrohunt(string, string, string, string, string)

public static string FormatProjectLocationInstanceRuleRetrohunt(string projectId, string locationId, string instanceId, string ruleId, string retrohuntId)

Formats the IDs into the string representation of this RetrohuntName with pattern projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/retrohunts/{retrohunt}.

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

The Rule ID. Must not be null or empty.
retrohuntId string

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

The string representation of this RetrohuntName with pattern projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/retrohunts/{retrohunt}.

FromProjectLocationInstanceRuleRetrohunt(string, string, string, string, string)

public static RetrohuntName FromProjectLocationInstanceRuleRetrohunt(string projectId, string locationId, string instanceId, string ruleId, string retrohuntId)

Creates a RetrohuntName with the pattern projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/retrohunts/{retrohunt}.

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

The Rule ID. Must not be null or empty.
retrohuntId string

The Retrohunt ID. Must not be null or empty.
Returns
Type Description
RetrohuntName

A new instance of RetrohuntName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static RetrohuntName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RetrohuntName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
retrohuntName string

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

The parsed RetrohuntName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/retrohunts/{retrohunt}

Parse(string, bool)

public static RetrohuntName Parse(string retrohuntName, bool allowUnparsed)

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

Parameters
Name Description
retrohuntName 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
RetrohuntName

The parsed RetrohuntName if successful.
Remarks

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

  • projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/retrohunts/{retrohunt}
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 RetrohuntName)

public static bool TryParse(string retrohuntName, out RetrohuntName result)

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

Parameters
Name Description
retrohuntName string

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

When this method returns, the parsed RetrohuntName, 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}/rules/{rule}/retrohunts/{retrohunt}

TryParse(string, bool, out RetrohuntName)

public static bool TryParse(string retrohuntName, bool allowUnparsed, out RetrohuntName result)

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

Parameters
Name Description
retrohuntName 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 RetrohuntName

When this method returns, the parsed RetrohuntName, 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}/rules/{rule}/retrohunts/{retrohunt}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(RetrohuntName, RetrohuntName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a RetrohuntName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a RetrohuntName

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

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.