Data Labeling v1beta1 API - Class DataItemName (2.0.0-beta02)

public sealed class DataItemName : IResourceName, IEquatable<DataItemName>

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

Resource name for the DataItem resource.

Inheritance

object > DataItemName

Namespace

Google.Cloud.DataLabeling.V1Beta1

Assembly

Google.Cloud.DataLabeling.V1Beta1.dll

Constructors

DataItemName(string, string, string)

public DataItemName(string projectId, string datasetId, string dataItemId)

Constructs a new instance of a DataItemName class from the component parts of pattern projects/{project}/datasets/{dataset}/dataItems/{data_item}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

datasetIdstring

The Dataset ID. Must not be null or empty.

dataItemIdstring

The DataItem ID. Must not be null or empty.

Properties

DataItemId

public string DataItemId { get; }

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

Property Value
TypeDescription
string

DatasetId

public string DatasetId { get; }

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

Property Value
TypeDescription
string

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
bool

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
string

Type

public DataItemName.ResourceNameType Type { get; }

The DataItemName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
DataItemNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(string, string, string)

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

Formats the IDs into the string representation of this DataItemName with pattern projects/{project}/datasets/{dataset}/dataItems/{data_item}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

datasetIdstring

The Dataset ID. Must not be null or empty.

dataItemIdstring

The DataItem ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this DataItemName with pattern projects/{project}/datasets/{dataset}/dataItems/{data_item}.

FormatProjectDatasetDataItem(string, string, string)

public static string FormatProjectDatasetDataItem(string projectId, string datasetId, string dataItemId)

Formats the IDs into the string representation of this DataItemName with pattern projects/{project}/datasets/{dataset}/dataItems/{data_item}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

datasetIdstring

The Dataset ID. Must not be null or empty.

dataItemIdstring

The DataItem ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this DataItemName with pattern projects/{project}/datasets/{dataset}/dataItems/{data_item}.

FromProjectDatasetDataItem(string, string, string)

public static DataItemName FromProjectDatasetDataItem(string projectId, string datasetId, string dataItemId)

Creates a DataItemName with the pattern projects/{project}/datasets/{dataset}/dataItems/{data_item}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

datasetIdstring

The Dataset ID. Must not be null or empty.

dataItemIdstring

The DataItem ID. Must not be null or empty.

Returns
TypeDescription
DataItemName

A new instance of DataItemName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DataItemName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DataItemName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
DataItemName

A new instance of DataItemName containing the provided unparsedResourceName .

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static DataItemName Parse(string dataItemName)

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

Parameter
NameDescription
dataItemNamestring

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

Returns
TypeDescription
DataItemName

The parsed DataItemName if successful.

Remarks

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

  • projects/{project}/datasets/{dataset}/dataItems/{data_item}

Parse(string, bool)

public static DataItemName Parse(string dataItemName, bool allowUnparsed)

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

Parameters
NameDescription
dataItemNamestring

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

allowUnparsedbool

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
TypeDescription
DataItemName

The parsed DataItemName if successful.

Remarks

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

  • projects/{project}/datasets/{dataset}/dataItems/{data_item}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
string

The string representation of the resource name.

Overrides

TryParse(string, out DataItemName)

public static bool TryParse(string dataItemName, out DataItemName result)

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

Parameters
NameDescription
dataItemNamestring

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

resultDataItemName

When this method returns, the parsed DataItemName, or null if parsing failed.

Returns
TypeDescription
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}/datasets/{dataset}/dataItems/{data_item}

TryParse(string, bool, out DataItemName)

public static bool TryParse(string dataItemName, bool allowUnparsed, out DataItemName result)

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

Parameters
NameDescription
dataItemNamestring

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

allowUnparsedbool

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.

resultDataItemName

When this method returns, the parsed DataItemName, or null if parsing failed.

Returns
TypeDescription
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}/datasets/{dataset}/dataItems/{data_item}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(DataItemName, DataItemName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aDataItemName

The first resource name to compare, or null.

bDataItemName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(DataItemName, DataItemName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aDataItemName

The first resource name to compare, or null.

bDataItemName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.