Cloud Document AI v1 API - Class ProcessorName (3.16.0)

public sealed class ProcessorName : IResourceName, IEquatable<ProcessorName>

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

Resource name for the Processor resource.

Inheritance

object > ProcessorName

Implements

IResourceName, IEquatable ProcessorName

Inherited Members

object.GetType()

Namespace

Google.Cloud.DocumentAI.V1

Assembly

Google.Cloud.DocumentAI.V1.dll

Constructors

ProcessorName(string, string, string)

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

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

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

The ProcessorName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ProcessorNameResourceNameType`

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 ProcessorName with pattern projects/{project}/locations/{location}/processors/{processor}.

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 ProcessorName with pattern `projects/{project}/locations/{location}/processors/{processor}`.

FormatProjectLocationProcessor(string, string, string)

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

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

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 ProcessorName with pattern `projects/{project}/locations/{location}/processors/{processor}`.

FromProjectLocationProcessor(string, string, string)

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

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

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
`ProcessorName`	A new instance of ProcessorName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ProcessorName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ProcessorName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

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

Parse(string, bool)

public static ProcessorName Parse(string processorName, bool allowUnparsed)

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

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

Remarks

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

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

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

public static bool TryParse(string processorName, out ProcessorName result)

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

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

TryParse(string, bool, out ProcessorName)

public static bool TryParse(string processorName, bool allowUnparsed, out ProcessorName result)

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

Parameters
Name	Description
`processorName`	`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`	`ProcessorName` When this method returns, the parsed ProcessorName, 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}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ProcessorName, ProcessorName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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