Cloud Document AI v1 API - Class ProcessorVersionName (3.6.0)

public sealed class ProcessorVersionName : IResourceName, IEquatable<ProcessorVersionName>

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

Resource name for the ProcessorVersion resource.

Inheritance

Object > ProcessorVersionName

Implements

IResourceName, IEquatable<ProcessorVersionName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.DocumentAI.V1

Assembly

Google.Cloud.DocumentAI.V1.dll

Constructors

ProcessorVersionName(String, String, String, String)

public ProcessorVersionName(string projectId, string locationId, string processorId, string processorVersionId)

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

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.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
Type	Description
`Boolean`

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

The ProcessorVersionName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ProcessorVersionName.ResourceNameType`

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)

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

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

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.

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

FormatProjectLocationProcessorProcessorVersion(String, String, String, String)

public static string FormatProjectLocationProcessorProcessorVersion(string projectId, string locationId, string processorId, string processorVersionId)

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

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.

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

FromProjectLocationProcessorProcessorVersion(String, String, String, String)

public static ProcessorVersionName FromProjectLocationProcessorProcessorVersion(string projectId, string locationId, string processorId, string processorVersionId)

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

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.

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

FromUnparsed(UnparsedResourceName)

public static ProcessorVersionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ProcessorVersionName containing an unparsed resource name.

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

Returns
Type	Description
`ProcessorVersionName`	A new instance of ProcessorVersionName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`Int32`

Overrides

Object.GetHashCode()

Parse(String)

public static ProcessorVersionName Parse(string processorVersionName)

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

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

Returns
Type	Description
`ProcessorVersionName`	The parsed ProcessorVersionName 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}

Parse(String, Boolean)

public static ProcessorVersionName Parse(string processorVersionName, bool allowUnparsed)

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

Parameters
Name	Description
`processorVersionName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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
`ProcessorVersionName`	The parsed ProcessorVersionName 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}

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

public static bool TryParse(string processorVersionName, out ProcessorVersionName result)

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

Parameters
Name	Description
`processorVersionName`	`String` The resource name in string form. Must not be `null`.
`result`	`ProcessorVersionName` When this method returns, the parsed ProcessorVersionName, or `null` if parsing failed.

Returns
Type	Description
`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}/locations/{location}/processors/{processor}/processorVersions/{processor_version}

TryParse(String, Boolean, out ProcessorVersionName)

public static bool TryParse(string processorVersionName, bool allowUnparsed, out ProcessorVersionName result)

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

Parameters
Name	Description
`processorVersionName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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`	`ProcessorVersionName` When this method returns, the parsed ProcessorVersionName, or `null` if parsing failed.

Returns
Type	Description
`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}/locations/{location}/processors/{processor}/processorVersions/{processor_version}

Or may be in any format if allowUnparsed is true.

Operators

Equality(ProcessorVersionName, ProcessorVersionName)

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

Parameters
Name	Description
`a`	`ProcessorVersionName`
`b`	`ProcessorVersionName`

Returns
Type	Description
`Boolean`

Inequality(ProcessorVersionName, ProcessorVersionName)

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

Parameters
Name	Description
`a`	`ProcessorVersionName`
`b`	`ProcessorVersionName`

Returns
Type	Description
`Boolean`