Class DataItemName (1.0.0-beta03)

public sealed class DataItemName : IResourceName, IEquatable<DataItemName>

Resource name for the DataItem resource.

Inheritance

Object > DataItemName

Implements

IResourceName, IEquatable<DataItemName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

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
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`datasetId`	`String` The `Dataset` ID. Must not be `null` or empty.
`dataItemId`	`String` 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
Type	Description
`String`

DatasetId

public string DatasetId { get; }

The Dataset 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
`Boolean`

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

The DataItemName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`DataItemName.ResourceNameType`

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 datasetId, string dataItemId)

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

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`datasetId`	`String` The `Dataset` ID. Must not be `null` or empty.
`dataItemId`	`String` The `DataItem` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`datasetId`	`String` The `Dataset` ID. Must not be `null` or empty.
`dataItemId`	`String` The `DataItem` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`datasetId`	`String` The `Dataset` ID. Must not be `null` or empty.
`dataItemId`	`String` 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)

public static DataItemName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DataItemName containing an unparsed resource name.

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

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`Int32`

Overrides

Object.GetHashCode()

Parse(String)

public static DataItemName Parse(string dataItemName)

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

Parameter
Name	Description
`dataItemName`	`String` 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)

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
Name	Description
`dataItemName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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
`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
Type	Description
`String`	The string representation of the resource name.

Overrides

Object.ToString()

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
Name	Description
`dataItemName`	`String` The resource name in string form. Must not be `null`.
`result`	`DataItemName` When this method returns, the parsed DataItemName, or `null` if parsing failed.

Returns
Type	Description
`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)

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
Name	Description
`dataItemName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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`	`DataItemName` When this method returns, the parsed DataItemName, or `null` if parsing failed.

Returns
Type	Description
`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)

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

Parameters
Name	Description
`a`	`DataItemName`
`b`	`DataItemName`

Returns
Type	Description
`Boolean`

Inequality(DataItemName, DataItemName)

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

Parameters
Name	Description
`a`	`DataItemName`
`b`	`DataItemName`

Returns
Type	Description
`Boolean`