Data Labeling v1beta1 API - Class InstructionName (2.0.0-beta02)

Version 2.0.0-beta02

• 2.0.0-beta05 (latest)
• 2.0.0-beta04
• 1.0.0-beta03

public sealed class InstructionName : IResourceName, IEquatable<InstructionName>

Reference documentation and code samples for the Data Labeling v1beta1 API class InstructionName.

Resource name for the Instruction resource.

Inheritance

object > InstructionName

Implements

IResourceName, IEquatableInstructionName

Inherited Members

object.GetType()

Namespace

Google.Cloud.DataLabeling.V1Beta1

Assembly

Google.Cloud.DataLabeling.V1Beta1.dll

Constructors

InstructionName(string, string)

public InstructionName(string projectId, string instructionId)

Constructs a new instance of a InstructionName class from the component parts of pattern projects/{project}/instructions/{instruction}

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
instructionId	string The Instruction ID. Must not be null or empty.

Properties

InstructionId

public string InstructionId { get; }

The Instruction 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

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

The InstructionName.ResourceNameType of the contained resource name.

Property Value
Type	Description
InstructionNameResourceNameType

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)

public static string Format(string projectId, string instructionId)

Formats the IDs into the string representation of this InstructionName with pattern projects/{project}/instructions/{instruction}.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
instructionId	string The Instruction ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this InstructionName with pattern projects/{project}/instructions/{instruction}.

FormatProjectInstruction(string, string)

public static string FormatProjectInstruction(string projectId, string instructionId)

Formats the IDs into the string representation of this InstructionName with pattern projects/{project}/instructions/{instruction}.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
instructionId	string The Instruction ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this InstructionName with pattern projects/{project}/instructions/{instruction}.

FromProjectInstruction(string, string)

public static InstructionName FromProjectInstruction(string projectId, string instructionId)

Creates a InstructionName with the pattern projects/{project}/instructions/{instruction} .

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
instructionId	string The Instruction ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static InstructionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a InstructionName containing an unparsed resource name.

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

Returns
Type	Description
InstructionName	A new instance of InstructionName 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 InstructionName Parse(string instructionName)

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

Parameter
Name	Description
instructionName	string The resource name in string form. Must not be null.

Returns
Type	Description
InstructionName	The parsed InstructionName if successful.

Remarks

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

• projects/{project}/instructions/{instruction}

Parse(string, bool)

public static InstructionName Parse(string instructionName, bool allowUnparsed)

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

Parameters
Name	Description
instructionName	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
InstructionName	The parsed InstructionName if successful.

Remarks

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

• projects/{project}/instructions/{instruction}

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

public static bool TryParse(string instructionName, out InstructionName result)

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

Parameters
Name	Description
instructionName	string The resource name in string form. Must not be null.
result	InstructionName When this method returns, the parsed InstructionName, 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}/instructions/{instruction}

TryParse(string, bool, out InstructionName)

public static bool TryParse(string instructionName, bool allowUnparsed, out InstructionName result)

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

Parameters
Name	Description
instructionName	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	InstructionName When this method returns, the parsed InstructionName, 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}/instructions/{instruction}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(InstructionName, InstructionName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
a	InstructionName The first resource name to compare, or null.
b	InstructionName 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 !=(InstructionName, InstructionName)

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

Determines whether two specified resource names have different values.

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