Cloud AI Platform v1 API - Class ModelEvaluationName (3.8.0) 

public sealed class ModelEvaluationName : IResourceName, IEquatable<ModelEvaluationName>

Reference documentation and code samples for the Cloud AI Platform v1 API class ModelEvaluationName.

Resource name for the ModelEvaluation resource.

Inheritance

object > ModelEvaluationName

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

ModelEvaluationName(string, string, string, string)

public ModelEvaluationName(string projectId, string locationId, string modelId, string evaluationId)

Constructs a new instance of a ModelEvaluationName class from the component parts of pattern projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}

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

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

The Evaluation ID. Must not be null or empty.

Properties

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

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

ModelId

public string ModelId { get; }

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

The ModelEvaluationName.ResourceNameType of the contained resource name.

Property Value
Type Description
ModelEvaluationNameResourceNameType

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

Formats the IDs into the string representation of this ModelEvaluationName with pattern projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}.

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

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

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

The string representation of this ModelEvaluationName with pattern projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}.

FormatProjectLocationModelEvaluation(string, string, string, string)

public static string FormatProjectLocationModelEvaluation(string projectId, string locationId, string modelId, string evaluationId)

Formats the IDs into the string representation of this ModelEvaluationName with pattern projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}.

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

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

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

The string representation of this ModelEvaluationName with pattern projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}.

FromProjectLocationModelEvaluation(string, string, string, string)

public static ModelEvaluationName FromProjectLocationModelEvaluation(string projectId, string locationId, string modelId, string evaluationId)

Creates a ModelEvaluationName with the pattern projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}.

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

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

The Evaluation ID. Must not be null or empty.
Returns
Type Description
ModelEvaluationName

A new instance of ModelEvaluationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ModelEvaluationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ModelEvaluationName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
modelEvaluationName string

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

The parsed ModelEvaluationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}

Parse(string, bool)

public static ModelEvaluationName Parse(string modelEvaluationName, bool allowUnparsed)

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

Parameters
Name Description
modelEvaluationName 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
ModelEvaluationName

The parsed ModelEvaluationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}
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 ModelEvaluationName)

public static bool TryParse(string modelEvaluationName, out ModelEvaluationName result)

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

Parameters
Name Description
modelEvaluationName string

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

When this method returns, the parsed ModelEvaluationName, 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}/models/{model}/evaluations/{evaluation}

TryParse(string, bool, out ModelEvaluationName)

public static bool TryParse(string modelEvaluationName, bool allowUnparsed, out ModelEvaluationName result)

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

Parameters
Name Description
modelEvaluationName 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 ModelEvaluationName

When this method returns, the parsed ModelEvaluationName, 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}/models/{model}/evaluations/{evaluation}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ModelEvaluationName, ModelEvaluationName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ModelEvaluationName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ModelEvaluationName

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

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.