Class ExampleName

Resource name for the Example resource.

Inheritance

System.Object

ExampleName

Implements

IResourceName

System.IEquatable<ExampleName>

Inherited Members

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Cloud.DataLabeling.V1Beta1

Assembly: Google.Cloud.DataLabeling.V1Beta1.dll

Syntax

public sealed class ExampleName : IResourceName, IEquatable<ExampleName>

Constructors

ExampleName(String, String, String, String)

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

Declaration

public ExampleName(string projectId, string datasetId, string annotatedDatasetId, string exampleId)

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.
System.String	exampleId	The Example 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

ExampleId

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

Declaration

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

Declaration

public ExampleName.ResourceNameType Type { get; }

Property Value

Type	Description
ExampleName.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, String)

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

Declaration

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

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.
System.String	exampleId	The Example ID. Must not be null or empty.

Returns

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

FormatProjectDatasetAnnotatedDatasetExample(String, String, String, String)

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

Declaration

public static string FormatProjectDatasetAnnotatedDatasetExample(string projectId, string datasetId, string annotatedDatasetId, string exampleId)

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.
System.String	exampleId	The Example ID. Must not be null or empty.

Returns

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

FromProjectDatasetAnnotatedDatasetExample(String, String, String, String)

Creates a ExampleName with the pattern projects/{project}/datasets/{dataset}/annotatedDatasets/{annotated_dataset}/examples/{example}.

Declaration

public static ExampleName FromProjectDatasetAnnotatedDatasetExample(string projectId, string datasetId, string annotatedDatasetId, string exampleId)

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.
System.String	exampleId	The Example ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a ExampleName containing an unparsed resource name.

Declaration

public static ExampleName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

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

Declaration

public static ExampleName Parse(string exampleName)

Parameters

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

Returns

Type	Description
ExampleName	The parsed ExampleName if successful.

Remarks

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

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

Parse(String, Boolean)

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

Declaration

public static ExampleName Parse(string exampleName, bool allowUnparsed)

Parameters

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

Remarks

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

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

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

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

Declaration

public static bool TryParse(string exampleName, out ExampleName result)

Parameters

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

TryParse(String, Boolean, out ExampleName)

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

Declaration

public static bool TryParse(string exampleName, bool allowUnparsed, out ExampleName result)

Parameters

Type	Name	Description
System.String	exampleName	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.
ExampleName	result	When this method returns, the parsed ExampleName, 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}/examples/{example}

Or may be in any format if allowUnparsed is true.

Operators

Equality(ExampleName, ExampleName)

Declaration

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

Parameters

Type	Name	Description
ExampleName	a
ExampleName	b

Returns

Type	Description
System.Boolean

Inequality(ExampleName, ExampleName)

Declaration

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

Parameters

Type	Name	Description
ExampleName	a
ExampleName	b

Returns

Type	Description
System.Boolean