Cloud AI Platform v1 API - Class ModelEvaluationSliceName (2.27.0)

Version latest

• 2.27.0 (latest)
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class ModelEvaluationSliceName : IResourceName, IEquatable<ModelEvaluationSliceName>

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

Resource name for the ModelEvaluationSlice resource.

Inheritance

object > ModelEvaluationSliceName

Implements

IResourceName, IEquatableModelEvaluationSliceName

Inherited Members

object.GetType()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

ModelEvaluationSliceName(string, string, string, string, string)

public ModelEvaluationSliceName(string projectId, string locationId, string modelId, string evaluationId, string sliceId)

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

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.
sliceId	string The Slice 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

SliceId

public string SliceId { get; }

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

Property Value
Type	Description
string

Type

public ModelEvaluationSliceName.ResourceNameType Type { get; }

The ModelEvaluationSliceName.ResourceNameType of the contained resource name.

Property Value
Type	Description
ModelEvaluationSliceNameResourceNameType

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

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

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.
sliceId	string The Slice ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this ModelEvaluationSliceName with pattern projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}.

FormatProjectLocationModelEvaluationSlice(string, string, string, string, string)

public static string FormatProjectLocationModelEvaluationSlice(string projectId, string locationId, string modelId, string evaluationId, string sliceId)

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

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.
sliceId	string The Slice ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this ModelEvaluationSliceName with pattern projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}.

FromProjectLocationModelEvaluationSlice(string, string, string, string, string)

public static ModelEvaluationSliceName FromProjectLocationModelEvaluationSlice(string projectId, string locationId, string modelId, string evaluationId, string sliceId)

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

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.
sliceId	string The Slice ID. Must not be null or empty.

Returns
Type	Description
ModelEvaluationSliceName	A new instance of ModelEvaluationSliceName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ModelEvaluationSliceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ModelEvaluationSliceName containing an unparsed resource name.

Parameter
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

Returns
Type	Description
ModelEvaluationSliceName	A new instance of ModelEvaluationSliceName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

public static ModelEvaluationSliceName Parse(string modelEvaluationSliceName)

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

Parameter
Name	Description
modelEvaluationSliceName	string The resource name in string form. Must not be null.

Returns
Type	Description
ModelEvaluationSliceName	The parsed ModelEvaluationSliceName 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}/slices/{slice}

Parse(string, bool)

public static ModelEvaluationSliceName Parse(string modelEvaluationSliceName, bool allowUnparsed)

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

Parameters
Name	Description
modelEvaluationSliceName	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
ModelEvaluationSliceName	The parsed ModelEvaluationSliceName 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}/slices/{slice}

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

object.ToString()

TryParse(string, out ModelEvaluationSliceName)

public static bool TryParse(string modelEvaluationSliceName, out ModelEvaluationSliceName result)

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

Parameters
Name	Description
modelEvaluationSliceName	string The resource name in string form. Must not be null.
result	ModelEvaluationSliceName When this method returns, the parsed ModelEvaluationSliceName, 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}/slices/{slice}

TryParse(string, bool, out ModelEvaluationSliceName)

public static bool TryParse(string modelEvaluationSliceName, bool allowUnparsed, out ModelEvaluationSliceName result)

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

Parameters
Name	Description
modelEvaluationSliceName	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	ModelEvaluationSliceName When this method returns, the parsed ModelEvaluationSliceName, 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}/slices/{slice}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ModelEvaluationSliceName, ModelEvaluationSliceName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
a	ModelEvaluationSliceName The first resource name to compare, or null.
b	ModelEvaluationSliceName 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 !=(ModelEvaluationSliceName, ModelEvaluationSliceName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
a	ModelEvaluationSliceName The first resource name to compare, or null.
b	ModelEvaluationSliceName 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.