Data Labeling v1beta1 API - Class EvaluationJobName (2.0.0-beta05)

public sealed class EvaluationJobName : IResourceName, IEquatable<EvaluationJobName>

Reference documentation and code samples for the Data Labeling v1beta1 API class EvaluationJobName.

Resource name for the EvaluationJob resource.

Inheritance

object > EvaluationJobName

Implements

IResourceName, IEquatable EvaluationJobName

Inherited Members

object.GetType()

Namespace

Google.Cloud.DataLabeling.V1Beta1

Assembly

Google.Cloud.DataLabeling.V1Beta1.dll

Constructors

EvaluationJobName(string, string)

public EvaluationJobName(string projectId, string evaluationJobId)

Constructs a new instance of a EvaluationJobName class from the component parts of pattern projects/{project}/evaluationJobs/{evaluation_job}

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`evaluationJobId`	`string` The `EvaluationJob` ID. Must not be `null` or empty.

Properties

EvaluationJobId

public string EvaluationJobId { get; }

The EvaluationJob 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`

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 EvaluationJobName.ResourceNameType Type { get; }

The EvaluationJobName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`EvaluationJobNameResourceNameType`

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)

public static string Format(string projectId, string evaluationJobId)

Formats the IDs into the string representation of this EvaluationJobName with pattern projects/{project}/evaluationJobs/{evaluation_job}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`evaluationJobId`	`string` The `EvaluationJob` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this EvaluationJobName with pattern `projects/{project}/evaluationJobs/{evaluation_job}`.

FormatProjectEvaluationJob(string, string)

public static string FormatProjectEvaluationJob(string projectId, string evaluationJobId)

Formats the IDs into the string representation of this EvaluationJobName with pattern projects/{project}/evaluationJobs/{evaluation_job}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`evaluationJobId`	`string` The `EvaluationJob` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this EvaluationJobName with pattern `projects/{project}/evaluationJobs/{evaluation_job}`.

FromProjectEvaluationJob(string, string)

public static EvaluationJobName FromProjectEvaluationJob(string projectId, string evaluationJobId)

Creates a EvaluationJobName with the pattern projects/{project}/evaluationJobs/{evaluation_job}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`evaluationJobId`	`string` The `EvaluationJob` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static EvaluationJobName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a EvaluationJobName containing an unparsed resource name.

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

Returns
Type	Description
`EvaluationJobName`	A new instance of EvaluationJobName 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 EvaluationJobName Parse(string evaluationJobName)

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

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

Returns
Type	Description
`EvaluationJobName`	The parsed EvaluationJobName if successful.

Remarks

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

projects/{project}/evaluationJobs/{evaluation_job}

Parse(string, bool)

public static EvaluationJobName Parse(string evaluationJobName, bool allowUnparsed)

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

Parameters
Name	Description
`evaluationJobName`	`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
`EvaluationJobName`	The parsed EvaluationJobName if successful.

Remarks

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

projects/{project}/evaluationJobs/{evaluation_job}

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

public static bool TryParse(string evaluationJobName, out EvaluationJobName result)

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

Parameters
Name	Description
`evaluationJobName`	`string` The resource name in string form. Must not be `null`.
`result`	`EvaluationJobName` When this method returns, the parsed EvaluationJobName, 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}/evaluationJobs/{evaluation_job}

TryParse(string, bool, out EvaluationJobName)

public static bool TryParse(string evaluationJobName, bool allowUnparsed, out EvaluationJobName result)

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

Parameters
Name	Description
`evaluationJobName`	`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`	`EvaluationJobName` When this method returns, the parsed EvaluationJobName, 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}/evaluationJobs/{evaluation_job}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(EvaluationJobName, EvaluationJobName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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