Class AnnotatedDatasetName

Resource name for the AnnotatedDataset resource.

Inheritance

System.Object

AnnotatedDatasetName

Implements

IResourceName

System.IEquatable<AnnotatedDatasetName>

Inherited Members

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Cloud.DataLabeling.V1Beta1

Assembly: Google.Cloud.DataLabeling.V1Beta1.dll

Syntax

public sealed class AnnotatedDatasetName : IResourceName, IEquatable<AnnotatedDatasetName>

Constructors

AnnotatedDatasetName(String, String, String)

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

Declaration

public AnnotatedDatasetName(string projectId, string datasetId, string annotatedDatasetId)

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	annotatedDatasetId	The AnnotatedDataset ID. Must not be null or empty.

Properties

AnnotatedDatasetId

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

Declaration

public string AnnotatedDatasetId { 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 AnnotatedDatasetName.ResourceNameType of the contained resource name.

Declaration

public AnnotatedDatasetName.ResourceNameType Type { get; }

Property Value

Type	Description
AnnotatedDatasetName.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 AnnotatedDatasetName with pattern projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}.

Declaration

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

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	annotatedDatasetId	The AnnotatedDataset ID. Must not be null or empty.

Returns

Type	Description
System.String	The string representation of this AnnotatedDatasetName with pattern projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}.

FormatProjectDatasetAnnotatedDataset(String, String, String)

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

Declaration

public static string FormatProjectDatasetAnnotatedDataset(string projectId, string datasetId, string annotatedDatasetId)

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	annotatedDatasetId	The AnnotatedDataset ID. Must not be null or empty.

Returns

Type	Description
System.String	The string representation of this AnnotatedDatasetName with pattern projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}.

FromProjectDatasetAnnotatedDataset(String, String, String)

Creates a AnnotatedDatasetName with the pattern projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}.

Declaration

public static AnnotatedDatasetName FromProjectDatasetAnnotatedDataset(string projectId, string datasetId, string annotatedDatasetId)

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	annotatedDatasetId	The AnnotatedDataset ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a AnnotatedDatasetName containing an unparsed resource name.

Declaration

public static AnnotatedDatasetName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static AnnotatedDatasetName Parse(string annotatedDatasetName)

Parameters

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

Returns

Type	Description
AnnotatedDatasetName	The parsed AnnotatedDatasetName if successful.

Remarks

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

• projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}

Parse(String, Boolean)

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

Declaration

public static AnnotatedDatasetName Parse(string annotatedDatasetName, bool allowUnparsed)

Parameters

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

Remarks

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

• projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_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 AnnotatedDatasetName)

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

Declaration

public static bool TryParse(string annotatedDatasetName, out AnnotatedDatasetName result)

Parameters

Type	Name	Description
System.String	annotatedDatasetName	The resource name in string form. Must not be null.
AnnotatedDatasetName	result	When this method returns, the parsed AnnotatedDatasetName, 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}/annotatedDatasets/{annotated_dataset}

TryParse(String, Boolean, out AnnotatedDatasetName)

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

Declaration

public static bool TryParse(string annotatedDatasetName, bool allowUnparsed, out AnnotatedDatasetName result)

Parameters

Type	Name	Description
System.String	annotatedDatasetName	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.
AnnotatedDatasetName	result	When this method returns, the parsed AnnotatedDatasetName, 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}/annotatedDatasets/{annotated_dataset}

Or may be in any format if allowUnparsed is true.

Operators

Equality(AnnotatedDatasetName, AnnotatedDatasetName)

Declaration

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

Parameters

Type	Name	Description
AnnotatedDatasetName	a
AnnotatedDatasetName	b

Returns

Type	Description
System.Boolean

Inequality(AnnotatedDatasetName, AnnotatedDatasetName)

Declaration

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

Parameters

Type	Name	Description
AnnotatedDatasetName	a
AnnotatedDatasetName	b

Returns

Type	Description
System.Boolean