Class InstructionName

Resource name for the Instruction resource.

Inheritance

System.Object

InstructionName

Implements

IResourceName

System.IEquatable<InstructionName>

Inherited Members

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Cloud.DataLabeling.V1Beta1

Assembly: Google.Cloud.DataLabeling.V1Beta1.dll

Syntax

public sealed class InstructionName : IResourceName, IEquatable<InstructionName>

Constructors

InstructionName(String, String)

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

Declaration

public InstructionName(string projectId, string instructionId)

Parameters

Type	Name	Description
System.String	projectId	The Project ID. Must not be null or empty.
System.String	instructionId	The Instruction ID. Must not be null or empty.

Properties

InstructionId

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

Declaration

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

Declaration

public InstructionName.ResourceNameType Type { get; }

Property Value

Type	Description
InstructionName.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 InstructionName with pattern projects/{project}/instructions/{instruction}.

Declaration

public static string Format(string projectId, string instructionId)

Parameters

Type	Name	Description
System.String	projectId	The Project ID. Must not be null or empty.
System.String	instructionId	The Instruction ID. Must not be null or empty.

Returns

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

FormatProjectInstruction(String, String)

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

Declaration

public static string FormatProjectInstruction(string projectId, string instructionId)

Parameters

Type	Name	Description
System.String	projectId	The Project ID. Must not be null or empty.
System.String	instructionId	The Instruction ID. Must not be null or empty.

Returns

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

FromProjectInstruction(String, String)

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

Declaration

public static InstructionName FromProjectInstruction(string projectId, string instructionId)

Parameters

Type	Name	Description
System.String	projectId	The Project ID. Must not be null or empty.
System.String	instructionId	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)

Creates a InstructionName containing an unparsed resource name.

Declaration

public static InstructionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

Type	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()

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 InstructionName instance.

Declaration

public static InstructionName Parse(string instructionName)

Parameters

Type	Name	Description
System.String	instructionName	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, Boolean)

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

Declaration

public static InstructionName Parse(string instructionName, bool allowUnparsed)

Parameters

Type	Name	Description
System.String	instructionName	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
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()

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

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

Declaration

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

Parameters

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

TryParse(String, Boolean, out InstructionName)

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

Declaration

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

Parameters

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

Or may be in any format if allowUnparsed is true.

Operators

Equality(InstructionName, InstructionName)

Declaration

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

Parameters

Type	Name	Description
InstructionName	a
InstructionName	b

Returns

Type	Description
System.Boolean

Inequality(InstructionName, InstructionName)

Declaration

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

Parameters

Type	Name	Description
InstructionName	a
InstructionName	b

Returns

Type	Description
System.Boolean