Cloud AI Platform v1 API - Class ModelEvaluationSliceName (2.8.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, IEquatable<ModelEvaluationSliceName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

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
`Boolean`

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
`ModelEvaluationSliceName.ResourceNameType`

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
`Int32`

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, Boolean)

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`	`Boolean` 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
`Boolean`	`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, Boolean, 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`	`Boolean` 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
`Boolean`	`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

Equality(ModelEvaluationSliceName, ModelEvaluationSliceName)

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

Parameters
Name	Description
`a`	`ModelEvaluationSliceName`
`b`	`ModelEvaluationSliceName`

Returns
Type	Description
`Boolean`

Inequality(ModelEvaluationSliceName, ModelEvaluationSliceName)

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

Parameters
Name	Description
`a`	`ModelEvaluationSliceName`
`b`	`ModelEvaluationSliceName`

Returns
Type	Description
`Boolean`