Vertex AI v1 API - Class DataItemName (3.56.0)

Version latest

• 3.56.0 (latest)
• 3.55.0
• 3.54.0
• 3.53.0
• 3.52.0
• 3.51.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.39.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.27.0
• 3.26.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class DataItemName : IResourceName, IEquatable<DataItemName>

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

Resource name for the DataItem resource.

Inheritance

object > DataItemName

Implements

IResourceName, IEquatableDataItemName

Inherited Members

object.GetType()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

DataItemName(string, string, string, string)

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

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

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

The DataItemName.ResourceNameType of the contained resource name.

Property Value
Type	Description
DataItemNameResourceNameType

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

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

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

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.
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}/locations/{location}/datasets/{dataset}/dataItems/{data_item}.

FormatProjectLocationDatasetDataItem(string, string, string, string)

public static string FormatProjectLocationDatasetDataItem(string projectId, string locationId, string datasetId, string dataItemId)

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

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.
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}/locations/{location}/datasets/{dataset}/dataItems/{data_item}.

FromProjectLocationDatasetDataItem(string, string, string, string)

public static DataItemName FromProjectLocationDatasetDataItem(string projectId, string locationId, string datasetId, string dataItemId)

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

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.
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
int

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}/locations/{location}/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
Name	Description
dataItemName	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
DataItemName	The parsed DataItemName if successful.

Remarks

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

• projects/{project}/locations/{location}/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
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}/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
Name	Description
dataItemName	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	DataItemName When this method returns, the parsed DataItemName, 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}/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
Name	Description
a	DataItemName The first resource name to compare, or null.
b	DataItemName 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 !=(DataItemName, DataItemName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
a	DataItemName The first resource name to compare, or null.
b	DataItemName 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.