Class DatasetName

Resource name for the Dataset resource.

Inheritance

System.Object

DatasetName

Implements

IResourceName

System.IEquatable<DatasetName>

Inherited Members

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Cloud.DataLabeling.V1Beta1

Assembly: Google.Cloud.DataLabeling.V1Beta1.dll

Syntax

public sealed class DatasetName : IResourceName, IEquatable<DatasetName>

Constructors

DatasetName(String, String)

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

Declaration

public DatasetName(string projectId, string datasetId)

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.

Properties

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

Declaration

public DatasetName.ResourceNameType Type { get; }

Property Value

Type	Description
DatasetName.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)

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

Declaration

public static string Format(string projectId, string datasetId)

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.

Returns

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

FormatProjectDataset(String, String)

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

Declaration

public static string FormatProjectDataset(string projectId, string datasetId)

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.

Returns

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

FromProjectDataset(String, String)

Creates a DatasetName with the pattern projects/{project}/datasets/{dataset}.

Declaration

public static DatasetName FromProjectDataset(string projectId, string datasetId)

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.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a DatasetName containing an unparsed resource name.

Declaration

public static DatasetName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static DatasetName Parse(string datasetName)

Parameters

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

Returns

Type	Description
DatasetName	The parsed DatasetName if successful.

Remarks

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

projects/{project}/datasets/{dataset}

Parse(String, Boolean)

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

Declaration

public static DatasetName Parse(string datasetName, bool allowUnparsed)

Parameters

Type	Name	Description
System.String	datasetName	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
DatasetName	The parsed DatasetName if successful.

Remarks

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

projects/{project}/datasets/{dataset}

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

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

Declaration

public static bool TryParse(string datasetName, out DatasetName result)

Parameters

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

TryParse(String, Boolean, out DatasetName)

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

Declaration

public static bool TryParse(string datasetName, bool allowUnparsed, out DatasetName result)

Parameters

Type	Name	Description
System.String	datasetName	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.
DatasetName	result	When this method returns, the parsed DatasetName, 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}

Or may be in any format if allowUnparsed is true.

Operators

Equality(DatasetName, DatasetName)

Declaration

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

Parameters

Type	Name	Description
DatasetName	a
DatasetName	b

Returns

Type	Description
System.Boolean

Inequality(DatasetName, DatasetName)

Declaration

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

Parameters

Type	Name	Description
DatasetName	a
DatasetName	b

Returns

Type	Description
System.Boolean