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

public sealed class EvaluationRunName : IResourceName, IEquatable<EvaluationRunName>

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

Resource name for the EvaluationRun resource.

Inheritance

object > EvaluationRunName

Namespace

Google.Cloud.Ces.V1Beta

Assembly

Google.Cloud.Ces.V1Beta.dll

Constructors

EvaluationRunName(string, string, string, string)

public EvaluationRunName(string projectId, string locationId, string appId, string evaluationRunId)

Constructs a new instance of a EvaluationRunName class from the component parts of pattern projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluation_run}

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

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

EvaluationRunId

public string EvaluationRunId { get; }

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

The EvaluationRunName.ResourceNameType of the contained resource name.

Property Value
Type Description
EvaluationRunNameResourceNameType

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

Formats the IDs into the string representation of this EvaluationRunName with pattern projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluation_run}.

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

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

The string representation of this EvaluationRunName with pattern projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluation_run}.

FormatProjectLocationAppEvaluationRun(string, string, string, string)

public static string FormatProjectLocationAppEvaluationRun(string projectId, string locationId, string appId, string evaluationRunId)

Formats the IDs into the string representation of this EvaluationRunName with pattern projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluation_run}.

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

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

The string representation of this EvaluationRunName with pattern projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluation_run}.

FromProjectLocationAppEvaluationRun(string, string, string, string)

public static EvaluationRunName FromProjectLocationAppEvaluationRun(string projectId, string locationId, string appId, string evaluationRunId)

Creates a EvaluationRunName with the pattern projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluation_run}.

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

The EvaluationRun ID. Must not be null or empty.
Returns
Type Description
EvaluationRunName

A new instance of EvaluationRunName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static EvaluationRunName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a EvaluationRunName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
evaluationRunName string

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

The parsed EvaluationRunName if successful.
Remarks

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

  • projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluation_run}

Parse(string, bool)

public static EvaluationRunName Parse(string evaluationRunName, bool allowUnparsed)

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

Parameters
Name Description
evaluationRunName 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
EvaluationRunName

The parsed EvaluationRunName if successful.
Remarks

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

  • projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluation_run}

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

public static bool TryParse(string evaluationRunName, out EvaluationRunName result)

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

Parameters
Name Description
evaluationRunName string

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

When this method returns, the parsed EvaluationRunName, 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}/evaluationRuns/{evaluation_run}

TryParse(string, bool, out EvaluationRunName)

public static bool TryParse(string evaluationRunName, bool allowUnparsed, out EvaluationRunName result)

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

Parameters
Name Description
evaluationRunName 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 EvaluationRunName

When this method returns, the parsed EvaluationRunName, 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}/evaluationRuns/{evaluation_run}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(EvaluationRunName, EvaluationRunName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a EvaluationRunName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a EvaluationRunName

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

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.