Gemini Enterprise for Customer Experience v1beta API - Class EvaluationResultName (1.0.0-beta01) 

public sealed class EvaluationResultName : IResourceName, IEquatable<EvaluationResultName>

Reference documentation and code samples for the Gemini Enterprise for Customer Experience v1beta API class EvaluationResultName.

Resource name for the EvaluationResult resource.

Inheritance

object > EvaluationResultName

Namespace

Google.Cloud.Ces.V1Beta

Assembly

Google.Cloud.Ces.V1Beta.dll

Constructors

EvaluationResultName(string, string, string, string, string)

public EvaluationResultName(string projectId, string locationId, string appId, string evaluationId, string evaluationResultId)

Constructs a new instance of a EvaluationResultName class from the component parts of pattern projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{evaluation_result}

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

The App ID. Must not be null or empty.
evaluationId string

The Evaluation ID. Must not be null or empty.
evaluationResultId string

The EvaluationResult ID. Must not be null or empty.

Properties

AppId

public string AppId { get; }

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

Property Value
Type Description
string

EvaluationId

public string EvaluationId { get; }

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

Property Value
Type Description
string

EvaluationResultId

public string EvaluationResultId { get; }

The EvaluationResult 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 EvaluationResultName.ResourceNameType Type { get; }

The EvaluationResultName.ResourceNameType of the contained resource name.

Property Value
Type Description
EvaluationResultNameResourceNameType

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 appId, string evaluationId, string evaluationResultId)

Formats the IDs into the string representation of this EvaluationResultName with pattern projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{evaluation_result} .

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

The App ID. Must not be null or empty.
evaluationId string

The Evaluation ID. Must not be null or empty.
evaluationResultId string

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

The string representation of this EvaluationResultName with pattern projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{evaluation_result} .

FormatProjectLocationAppEvaluationEvaluationResult(string, string, string, string, string)

public static string FormatProjectLocationAppEvaluationEvaluationResult(string projectId, string locationId, string appId, string evaluationId, string evaluationResultId)

Formats the IDs into the string representation of this EvaluationResultName with pattern projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{evaluation_result} .

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

The App ID. Must not be null or empty.
evaluationId string

The Evaluation ID. Must not be null or empty.
evaluationResultId string

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

The string representation of this EvaluationResultName with pattern projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{evaluation_result} .

FromProjectLocationAppEvaluationEvaluationResult(string, string, string, string, string)

public static EvaluationResultName FromProjectLocationAppEvaluationEvaluationResult(string projectId, string locationId, string appId, string evaluationId, string evaluationResultId)

Creates a EvaluationResultName with the pattern projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{evaluation_result} .

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

The App ID. Must not be null or empty.
evaluationId string

The Evaluation ID. Must not be null or empty.
evaluationResultId string

The EvaluationResult ID. Must not be null or empty.
Returns
Type Description
EvaluationResultName

A new instance of EvaluationResultName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static EvaluationResultName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a EvaluationResultName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
evaluationResultName string

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

The parsed EvaluationResultName if successful.
Remarks

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

  • projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{evaluation_result}

Parse(string, bool)

public static EvaluationResultName Parse(string evaluationResultName, bool allowUnparsed)

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

Parameters
Name Description
evaluationResultName 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
EvaluationResultName

The parsed EvaluationResultName if successful.
Remarks

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

  • projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{evaluation_result}

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

public static bool TryParse(string evaluationResultName, out EvaluationResultName result)

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

Parameters
Name Description
evaluationResultName string

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

When this method returns, the parsed EvaluationResultName, 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}/apps/{app}/evaluations/{evaluation}/results/{evaluation_result}

TryParse(string, bool, out EvaluationResultName)

public static bool TryParse(string evaluationResultName, bool allowUnparsed, out EvaluationResultName result)

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

Parameters
Name Description
evaluationResultName 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 EvaluationResultName

When this method returns, the parsed EvaluationResultName, 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}/apps/{app}/evaluations/{evaluation}/results/{evaluation_result}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(EvaluationResultName, EvaluationResultName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a EvaluationResultName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a EvaluationResultName

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

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.