Cloud Document AI v1 API - Class HumanReviewConfigName (3.13.0)

Version 3.13.0

• 3.19.0 (latest)
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.0.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class HumanReviewConfigName : IResourceName, IEquatable<HumanReviewConfigName>

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

Resource name for the HumanReviewConfig resource.

Inheritance

object > HumanReviewConfigName

Implements

IResourceName, IEquatableHumanReviewConfigName

Inherited Members

object.GetType()

Namespace

Google.Cloud.DocumentAI.V1

Assembly

Google.Cloud.DocumentAI.V1.dll

Constructors

HumanReviewConfigName(string, string, string)

public HumanReviewConfigName(string projectId, string locationId, string processorId)

Constructs a new instance of a HumanReviewConfigName class from the component parts of pattern projects/{project}/locations/{location}/processors/{processor}/humanReviewConfig

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.

Properties

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

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

The HumanReviewConfigName.ResourceNameType of the contained resource name.

Property Value
Type	Description
HumanReviewConfigNameResourceNameType

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)

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

Formats the IDs into the string representation of this HumanReviewConfigName with pattern projects/{project}/locations/{location}/processors/{processor}/humanReviewConfig.

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.

Returns
Type	Description
string	The string representation of this HumanReviewConfigName with pattern projects/{project}/locations/{location}/processors/{processor}/humanReviewConfig.

FormatProjectLocationProcessor(string, string, string)

public static string FormatProjectLocationProcessor(string projectId, string locationId, string processorId)

Formats the IDs into the string representation of this HumanReviewConfigName with pattern projects/{project}/locations/{location}/processors/{processor}/humanReviewConfig.

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.

Returns
Type	Description
string	The string representation of this HumanReviewConfigName with pattern projects/{project}/locations/{location}/processors/{processor}/humanReviewConfig.

FromProjectLocationProcessor(string, string, string)

public static HumanReviewConfigName FromProjectLocationProcessor(string projectId, string locationId, string processorId)

Creates a HumanReviewConfigName with the pattern projects/{project}/locations/{location}/processors/{processor}/humanReviewConfig.

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.

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

FromUnparsed(UnparsedResourceName)

public static HumanReviewConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a HumanReviewConfigName containing an unparsed resource name.

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

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

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

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

Returns
Type	Description
HumanReviewConfigName	The parsed HumanReviewConfigName if successful.

Remarks

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

• projects/{project}/locations/{location}/processors/{processor}/humanReviewConfig

Parse(string, bool)

public static HumanReviewConfigName Parse(string humanReviewConfigName, bool allowUnparsed)

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

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

Remarks

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

• projects/{project}/locations/{location}/processors/{processor}/humanReviewConfig

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

public static bool TryParse(string humanReviewConfigName, out HumanReviewConfigName result)

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

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

TryParse(string, bool, out HumanReviewConfigName)

public static bool TryParse(string humanReviewConfigName, bool allowUnparsed, out HumanReviewConfigName result)

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

Parameters
Name	Description
humanReviewConfigName	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	HumanReviewConfigName When this method returns, the parsed HumanReviewConfigName, 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}/humanReviewConfig

Or may be in any format if allowUnparsed is true.

Operators

operator ==(HumanReviewConfigName, HumanReviewConfigName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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