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

public sealed class EvaluationDatasetName : IResourceName, IEquatable<EvaluationDatasetName>

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

Resource name for the EvaluationDataset resource.

Inheritance

object > EvaluationDatasetName

Namespace

Google.Cloud.Ces.V1Beta

Assembly

Google.Cloud.Ces.V1Beta.dll

Constructors

EvaluationDatasetName(string, string, string, string)

public EvaluationDatasetName(string projectId, string locationId, string appId, string evaluationDatasetId)

Constructs a new instance of a EvaluationDatasetName class from the component parts of pattern projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluation_dataset}

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

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

EvaluationDatasetId

public string EvaluationDatasetId { get; }

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

The EvaluationDatasetName.ResourceNameType of the contained resource name.

Property Value
Type Description
EvaluationDatasetNameResourceNameType

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

Formats the IDs into the string representation of this EvaluationDatasetName with pattern projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluation_dataset}.

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

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

The string representation of this EvaluationDatasetName with pattern projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluation_dataset}.

FormatProjectLocationAppEvaluationDataset(string, string, string, string)

public static string FormatProjectLocationAppEvaluationDataset(string projectId, string locationId, string appId, string evaluationDatasetId)

Formats the IDs into the string representation of this EvaluationDatasetName with pattern projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluation_dataset}.

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

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

The string representation of this EvaluationDatasetName with pattern projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluation_dataset}.

FromProjectLocationAppEvaluationDataset(string, string, string, string)

public static EvaluationDatasetName FromProjectLocationAppEvaluationDataset(string projectId, string locationId, string appId, string evaluationDatasetId)

Creates a EvaluationDatasetName with the pattern projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluation_dataset}.

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

The EvaluationDataset ID. Must not be null or empty.
Returns
Type Description
EvaluationDatasetName

A new instance of EvaluationDatasetName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static EvaluationDatasetName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a EvaluationDatasetName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
evaluationDatasetName string

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

The parsed EvaluationDatasetName if successful.
Remarks

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

  • projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluation_dataset}

Parse(string, bool)

public static EvaluationDatasetName Parse(string evaluationDatasetName, bool allowUnparsed)

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

Parameters
Name Description
evaluationDatasetName 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
EvaluationDatasetName

The parsed EvaluationDatasetName if successful.
Remarks

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

  • projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluation_dataset}

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

public static bool TryParse(string evaluationDatasetName, out EvaluationDatasetName result)

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

Parameters
Name Description
evaluationDatasetName string

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

When this method returns, the parsed EvaluationDatasetName, 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}/evaluationDatasets/{evaluation_dataset}

TryParse(string, bool, out EvaluationDatasetName)

public static bool TryParse(string evaluationDatasetName, bool allowUnparsed, out EvaluationDatasetName result)

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

Parameters
Name Description
evaluationDatasetName 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 EvaluationDatasetName

When this method returns, the parsed EvaluationDatasetName, 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}/evaluationDatasets/{evaluation_dataset}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(EvaluationDatasetName, EvaluationDatasetName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a EvaluationDatasetName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a EvaluationDatasetName

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

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.