Cloud Document AI v1 API - Class EvaluationName (3.16.0)

public sealed class EvaluationName : IResourceName, IEquatable<EvaluationName>

Reference documentation and code samples for the Cloud Document AI v1 API class EvaluationName.

Resource name for the Evaluation resource.

Inheritance

object > EvaluationName

Implements

IResourceName, IEquatable EvaluationName

Inherited Members

object.GetType()

Namespace

Google.Cloud.DocumentAI.V1

Assembly

Google.Cloud.DocumentAI.V1.dll

Constructors

EvaluationName(string, string, string, string, string)

public EvaluationName(string projectId, string locationId, string processorId, string processorVersionId, string evaluationId)

Constructs a new instance of a EvaluationName class from the component parts of pattern projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`processorId`	`string` The `Processor` ID. Must not be `null` or empty.
`processorVersionId`	`string` The `ProcessorVersion` ID. Must not be `null` or empty.
`evaluationId`	`string` The `Evaluation` ID. Must not be `null` or empty.

Properties

EvaluationId

public string EvaluationId { get; }

The Evaluation 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`

LocationId

public string LocationId { get; }

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

Property Value
Type	Description
`string`

ProcessorId

public string ProcessorId { get; }

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

Property Value
Type	Description
`string`

ProcessorVersionId

public string ProcessorVersionId { get; }

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

Property Value
Type	Description
`string`

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

The EvaluationName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`EvaluationNameResourceNameType`

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, string, string, string)

public static string Format(string projectId, string locationId, string processorId, string processorVersionId, string evaluationId)

Formats the IDs into the string representation of this EvaluationName with pattern projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation} .

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`processorId`	`string` The `Processor` ID. Must not be `null` or empty.
`processorVersionId`	`string` The `ProcessorVersion` ID. Must not be `null` or empty.
`evaluationId`	`string` The `Evaluation` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this EvaluationName with pattern `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}` .

FormatProjectLocationProcessorProcessorVersionEvaluation(string, string, string, string, string)

public static string FormatProjectLocationProcessorProcessorVersionEvaluation(string projectId, string locationId, string processorId, string processorVersionId, string evaluationId)

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`processorId`	`string` The `Processor` ID. Must not be `null` or empty.
`processorVersionId`	`string` The `ProcessorVersion` ID. Must not be `null` or empty.
`evaluationId`	`string` The `Evaluation` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this EvaluationName with pattern `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}` .

FromProjectLocationProcessorProcessorVersionEvaluation(string, string, string, string, string)

public static EvaluationName FromProjectLocationProcessorProcessorVersionEvaluation(string projectId, string locationId, string processorId, string processorVersionId, string evaluationId)

Creates a EvaluationName with the pattern projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation} .

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`processorId`	`string` The `Processor` ID. Must not be `null` or empty.
`processorVersionId`	`string` The `ProcessorVersion` ID. Must not be `null` or empty.
`evaluationId`	`string` The `Evaluation` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static EvaluationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a EvaluationName containing an unparsed resource name.

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

Returns
Type	Description
`EvaluationName`	A new instance of EvaluationName 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 EvaluationName Parse(string evaluationName)

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

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

Returns
Type	Description
`EvaluationName`	The parsed EvaluationName if successful.

Remarks

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

projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}

Parse(string, bool)

public static EvaluationName Parse(string evaluationName, bool allowUnparsed)

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

Parameters
Name	Description
`evaluationName`	`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
`EvaluationName`	The parsed EvaluationName if successful.

Remarks

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

projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}

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

public static bool TryParse(string evaluationName, out EvaluationName result)

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

Parameters
Name	Description
`evaluationName`	`string` The resource name in string form. Must not be `null`.
`result`	`EvaluationName` When this method returns, the parsed EvaluationName, 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}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}

TryParse(string, bool, out EvaluationName)

public static bool TryParse(string evaluationName, bool allowUnparsed, out EvaluationName result)

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

Parameters
Name	Description
`evaluationName`	`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`	`EvaluationName` When this method returns, the parsed EvaluationName, 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}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(EvaluationName, EvaluationName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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