Vertex AI v1 API - Class DataLabelingJobName (3.50.0) 

public sealed class DataLabelingJobName : IResourceName, IEquatable<DataLabelingJobName>

Reference documentation and code samples for the Vertex AI v1 API class DataLabelingJobName.

Resource name for the DataLabelingJob resource.

Inheritance

object > DataLabelingJobName

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

DataLabelingJobName(string, string, string)

public DataLabelingJobName(string projectId, string locationId, string dataLabelingJobId)

Constructs a new instance of a DataLabelingJobName class from the component parts of pattern projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}

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.
dataLabelingJobId string

The DataLabelingJob ID. Must not be null or empty.

Properties

DataLabelingJobId

public string DataLabelingJobId { get; }

The DataLabelingJob 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

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

The DataLabelingJobName.ResourceNameType of the contained resource name.

Property Value
Type Description
DataLabelingJobNameResourceNameType

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)

public static string Format(string projectId, string locationId, string dataLabelingJobId)

Formats the IDs into the string representation of this DataLabelingJobName with pattern projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}.

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.
dataLabelingJobId string

The DataLabelingJob ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this DataLabelingJobName with pattern projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}.

FormatProjectLocationDataLabelingJob(string, string, string)

public static string FormatProjectLocationDataLabelingJob(string projectId, string locationId, string dataLabelingJobId)

Formats the IDs into the string representation of this DataLabelingJobName with pattern projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}.

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.
dataLabelingJobId string

The DataLabelingJob ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this DataLabelingJobName with pattern projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}.

FromProjectLocationDataLabelingJob(string, string, string)

public static DataLabelingJobName FromProjectLocationDataLabelingJob(string projectId, string locationId, string dataLabelingJobId)

Creates a DataLabelingJobName with the pattern projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}.

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.
dataLabelingJobId string

The DataLabelingJob ID. Must not be null or empty.
Returns
Type Description
DataLabelingJobName

A new instance of DataLabelingJobName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DataLabelingJobName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DataLabelingJobName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
DataLabelingJobName

A new instance of DataLabelingJobName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static DataLabelingJobName Parse(string dataLabelingJobName)

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

Parameter
Name Description
dataLabelingJobName string

The resource name in string form. Must not be null.
Returns
Type Description
DataLabelingJobName

The parsed DataLabelingJobName if successful.
Remarks

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

  • projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}

Parse(string, bool)

public static DataLabelingJobName Parse(string dataLabelingJobName, bool allowUnparsed)

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

Parameters
Name Description
dataLabelingJobName 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
DataLabelingJobName

The parsed DataLabelingJobName if successful.
Remarks

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

  • projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_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

TryParse(string, out DataLabelingJobName)

public static bool TryParse(string dataLabelingJobName, out DataLabelingJobName result)

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

Parameters
Name Description
dataLabelingJobName string

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

When this method returns, the parsed DataLabelingJobName, 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}/dataLabelingJobs/{data_labeling_job}

TryParse(string, bool, out DataLabelingJobName)

public static bool TryParse(string dataLabelingJobName, bool allowUnparsed, out DataLabelingJobName result)

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

Parameters
Name Description
dataLabelingJobName 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 DataLabelingJobName

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

Operators

operator ==(DataLabelingJobName, DataLabelingJobName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DataLabelingJobName

The first resource name to compare, or null.
b DataLabelingJobName

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 !=(DataLabelingJobName, DataLabelingJobName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DataLabelingJobName

The first resource name to compare, or null.
b DataLabelingJobName

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.