Class DataItemName

Resource name for the DataItem resource.

Inheritance

System.Object

DataItemName

Implements

IResourceName

System.IEquatable<DataItemName>

Inherited Members

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Cloud.DataLabeling.V1Beta1

Assembly: Google.Cloud.DataLabeling.V1Beta1.dll

Syntax

public sealed class DataItemName : IResourceName, IEquatable<DataItemName>

Constructors

DataItemName(String, String, String)

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

Declaration

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

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	dataItemId	The `DataItem` ID. Must not be `null` or empty.

Properties

DataItemId

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

Declaration

public string DataItemId { get; }

Property Value

Type	Description
System.String

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

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 DataItemName.ResourceNameType of the contained resource name.

Declaration

public DataItemName.ResourceNameType Type { get; }

Property Value

Type	Description
DataItemName.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 DataItemName with pattern projects/{project}/datasets/{dataset}/dataItems/{data_item}.

Declaration

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

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	dataItemId	The `DataItem` ID. Must not be `null` or empty.

Returns

Type	Description
System.String	The string representation of this DataItemName with pattern `projects/{project}/datasets/{dataset}/dataItems/{data_item}`.

FormatProjectDatasetDataItem(String, String, String)

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

Declaration

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

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	dataItemId	The `DataItem` ID. Must not be `null` or empty.

Returns

Type	Description
System.String	The string representation of this DataItemName with pattern `projects/{project}/datasets/{dataset}/dataItems/{data_item}`.

FromProjectDatasetDataItem(String, String, String)

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

Declaration

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

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	dataItemId	The `DataItem` ID. Must not be `null` or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a DataItemName containing an unparsed resource name.

Declaration

public static DataItemName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

Type	Description
DataItemName	A new instance of DataItemName 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 DataItemName instance.

Declaration

public static DataItemName Parse(string dataItemName)

Parameters

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

Returns

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

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

Declaration

public static DataItemName Parse(string dataItemName, bool allowUnparsed)

Parameters

Type	Name	Description
System.String	dataItemName	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
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()

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

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

Declaration

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

Parameters

Type	Name	Description
System.String	dataItemName	The resource name in string form. Must not be `null`.
DataItemName	result	When this method returns, the parsed DataItemName, 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}/dataItems/{data_item}

TryParse(String, Boolean, out DataItemName)

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

Declaration

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

Parameters

Type	Name	Description
System.String	dataItemName	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.
DataItemName	result	When this method returns, the parsed DataItemName, 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}/dataItems/{data_item}

Or may be in any format if allowUnparsed is true.

Operators

Equality(DataItemName, DataItemName)

Declaration

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

Parameters

Type	Name	Description
DataItemName	a
DataItemName	b

Returns

Type	Description
System.Boolean

Inequality(DataItemName, DataItemName)

Declaration

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

Parameters

Type	Name	Description
DataItemName	a
DataItemName	b

Returns

Type	Description
System.Boolean