Class EvaluationName

Resource name for the Evaluation resource.

Inheritance

System.Object

EvaluationName

Implements

IResourceName

System.IEquatable<EvaluationName>

Inherited Members

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Cloud.DataLabeling.V1Beta1

Assembly: Google.Cloud.DataLabeling.V1Beta1.dll

Syntax

public sealed class EvaluationName : IResourceName, IEquatable<EvaluationName>

Constructors

EvaluationName(String, String, String)

Constructs a new instance of a EvaluationName class from the component parts of pattern projects/{project}/datasets/{dataset}/evaluations/{evaluation}

Declaration

public EvaluationName(string projectId, string datasetId, string evaluationId)

Parameters

Type	Name	Description
System.String	projectId	The `Project` ID. Must not be `null` or empty.
System.String	datasetId	The `Dataset` ID. Must not be `null` or empty.
System.String	evaluationId	The `Evaluation` ID. Must not be `null` or empty.

Properties

DatasetId

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

Declaration

public string DatasetId { get; }

Property Value

Type	Description
System.String

EvaluationId

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

Declaration

public string EvaluationId { get; }

Property Value

Type	Description
System.String

IsKnownPattern

Whether this instance contains a resource name with a known pattern.

Declaration

public bool IsKnownPattern { get; }

Property Value

Type	Description
System.Boolean

Implements

IResourceName.IsKnownPattern

ProjectId

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

Declaration

public string ProjectId { get; }

Property Value

Type	Description
System.String

Type

The EvaluationName.ResourceNameType of the contained resource name.

Declaration

public EvaluationName.ResourceNameType Type { get; }

Property Value

Type	Description
EvaluationName.ResourceNameType

UnparsedResource

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Declaration

public UnparsedResourceName UnparsedResource { get; }

Property Value

Type	Description
UnparsedResourceName

Methods

Format(String, String, String)

Formats the IDs into the string representation of this EvaluationName with pattern projects/{project}/datasets/{dataset}/evaluations/{evaluation}.

Declaration

public static string Format(string projectId, string datasetId, string evaluationId)

Parameters

Type	Name	Description
System.String	projectId	The `Project` ID. Must not be `null` or empty.
System.String	datasetId	The `Dataset` ID. Must not be `null` or empty.
System.String	evaluationId	The `Evaluation` ID. Must not be `null` or empty.

Returns

Type	Description
System.String	The string representation of this EvaluationName with pattern `projects/{project}/datasets/{dataset}/evaluations/{evaluation}`.

FormatProjectDatasetEvaluation(String, String, String)

Formats the IDs into the string representation of this EvaluationName with pattern projects/{project}/datasets/{dataset}/evaluations/{evaluation}.

Declaration

public static string FormatProjectDatasetEvaluation(string projectId, string datasetId, string evaluationId)

Parameters

Type	Name	Description
System.String	projectId	The `Project` ID. Must not be `null` or empty.
System.String	datasetId	The `Dataset` ID. Must not be `null` or empty.
System.String	evaluationId	The `Evaluation` ID. Must not be `null` or empty.

Returns

Type	Description
System.String	The string representation of this EvaluationName with pattern `projects/{project}/datasets/{dataset}/evaluations/{evaluation}`.

FromProjectDatasetEvaluation(String, String, String)

Creates a EvaluationName with the pattern projects/{project}/datasets/{dataset}/evaluations/{evaluation}.

Declaration

public static EvaluationName FromProjectDatasetEvaluation(string projectId, string datasetId, string evaluationId)

Parameters

Type	Name	Description
System.String	projectId	The `Project` ID. Must not be `null` or empty.
System.String	datasetId	The `Dataset` ID. Must not be `null` or empty.
System.String	evaluationId	The `Evaluation` ID. Must not be `null` or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a EvaluationName containing an unparsed resource name.

Declaration

public static EvaluationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

Type	Description
EvaluationName	A new instance of EvaluationName containing the provided `unparsedResourceName`.

GetHashCode()

Returns a hash code for this resource name.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.Object.GetHashCode()

Parse(String)

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

Declaration

public static EvaluationName Parse(string evaluationName)

Parameters

Type	Name	Description
System.String	evaluationName	The resource name in string form. Must not be `null`.

Returns

Type	Description
EvaluationName	The parsed EvaluationName if successful.

Remarks

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

projects/{project}/datasets/{dataset}/evaluations/{evaluation}

Parse(String, Boolean)

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

Declaration

public static EvaluationName Parse(string evaluationName, bool allowUnparsed)

Parameters

Type	Name	Description
System.String	evaluationName	The resource name in string form. Must not be `null`.
System.Boolean	allowUnparsed	If `true` will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.ArgumentException if an unparseable resource name is specified.

Returns

Type	Description
EvaluationName	The parsed EvaluationName if successful.

Remarks

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

projects/{project}/datasets/{dataset}/evaluations/{evaluation}

Or may be in any format if allowUnparsed is true.

ToString()

The string representation of the resource name.

Declaration

public override string ToString()

Returns

Type	Description
System.String	The string representation of the resource name.

Overrides

System.Object.ToString()

Implements

IResourceName.ToString()

TryParse(String, out EvaluationName)

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

Declaration

public static bool TryParse(string evaluationName, out EvaluationName result)

Parameters

Type	Name	Description
System.String	evaluationName	The resource name in string form. Must not be `null`.
EvaluationName	result	When this method returns, the parsed EvaluationName, or `null` if parsing failed.

Returns

Type	Description
System.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}/datasets/{dataset}/evaluations/{evaluation}

TryParse(String, Boolean, out EvaluationName)

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

Declaration

public static bool TryParse(string evaluationName, bool allowUnparsed, out EvaluationName result)

Parameters

Type	Name	Description
System.String	evaluationName	The resource name in string form. Must not be `null`.
System.Boolean	allowUnparsed	If `true` will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.ArgumentException if an unparseable resource name is specified.
EvaluationName	result	When this method returns, the parsed EvaluationName, or `null` if parsing failed.

Returns

Type	Description
System.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}/datasets/{dataset}/evaluations/{evaluation}

Or may be in any format if allowUnparsed is true.

Operators

Equality(EvaluationName, EvaluationName)

Declaration

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

Parameters

Type	Name	Description
EvaluationName	a
EvaluationName	b

Returns

Type	Description
System.Boolean

Inequality(EvaluationName, EvaluationName)

Declaration

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

Parameters

Type	Name	Description
EvaluationName	a
EvaluationName	b

Returns

Type	Description
System.Boolean