Show / Hide Table of Contents

Class EvaluationJobName

Resource name for the EvaluationJob resource.

Inheritance
System.Object
EvaluationJobName
Implements
IResourceName
System.IEquatable<EvaluationJobName>
Inherited Members
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Google.Cloud.DataLabeling.V1Beta1
Assembly: Google.Cloud.DataLabeling.V1Beta1.dll
Syntax
public sealed class EvaluationJobName : IResourceName, IEquatable<EvaluationJobName>

Constructors

EvaluationJobName(String, String)

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

Declaration
public EvaluationJobName(string projectId, string evaluationJobId)
Parameters
Type Name Description
System.String projectId

The Project ID. Must not be null or empty.

System.String evaluationJobId

The EvaluationJob ID. Must not be null or empty.

Properties

EvaluationJobId

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

Declaration
public string EvaluationJobId { 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 EvaluationJobName.ResourceNameType of the contained resource name.

Declaration
public EvaluationJobName.ResourceNameType Type { get; }
Property Value
Type Description
EvaluationJobName.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)

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

Declaration
public static string Format(string projectId, string evaluationJobId)
Parameters
Type Name Description
System.String projectId

The Project ID. Must not be null or empty.

System.String evaluationJobId

The EvaluationJob ID. Must not be null or empty.

Returns
Type Description
System.String

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

FormatProjectEvaluationJob(String, String)

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

Declaration
public static string FormatProjectEvaluationJob(string projectId, string evaluationJobId)
Parameters
Type Name Description
System.String projectId

The Project ID. Must not be null or empty.

System.String evaluationJobId

The EvaluationJob ID. Must not be null or empty.

Returns
Type Description
System.String

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

FromProjectEvaluationJob(String, String)

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

Declaration
public static EvaluationJobName FromProjectEvaluationJob(string projectId, string evaluationJobId)
Parameters
Type Name Description
System.String projectId

The Project ID. Must not be null or empty.

System.String evaluationJobId

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)

Creates a EvaluationJobName containing an unparsed resource name.

Declaration
public static EvaluationJobName FromUnparsed(UnparsedResourceName unparsedResourceName)
Parameters
Type 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()

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 EvaluationJobName instance.

Declaration
public static EvaluationJobName Parse(string evaluationJobName)
Parameters
Type Name Description
System.String evaluationJobName

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

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

Declaration
public static EvaluationJobName Parse(string evaluationJobName, bool allowUnparsed)
Parameters
Type Name Description
System.String evaluationJobName

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

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

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

Declaration
public static bool TryParse(string evaluationJobName, out EvaluationJobName result)
Parameters
Type Name Description
System.String evaluationJobName

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

EvaluationJobName result

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

TryParse(String, Boolean, out EvaluationJobName)

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

Declaration
public static bool TryParse(string evaluationJobName, bool allowUnparsed, out EvaluationJobName result)
Parameters
Type Name Description
System.String evaluationJobName

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.

EvaluationJobName result

When this method returns, the parsed EvaluationJobName, 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}/evaluationJobs/{evaluation_job}
Or may be in any format if allowUnparsed is true.

Operators

Equality(EvaluationJobName, EvaluationJobName)

Declaration
public static bool operator ==(EvaluationJobName a, EvaluationJobName b)
Parameters
Type Name Description
EvaluationJobName a
EvaluationJobName b
Returns
Type Description
System.Boolean

Inequality(EvaluationJobName, EvaluationJobName)

Declaration
public static bool operator !=(EvaluationJobName a, EvaluationJobName b)
Parameters
Type Name Description
EvaluationJobName a
EvaluationJobName b
Returns
Type Description
System.Boolean
Back to top