Cloud Document AI v1beta3 API - Class ProcessorTypeName (2.0.0-beta13)

public sealed class ProcessorTypeName : IResourceName, IEquatable<ProcessorTypeName>

Reference documentation and code samples for the Cloud Document AI v1beta3 API class ProcessorTypeName.

Resource name for the ProcessorType resource.

Inheritance

object > ProcessorTypeName

Implements

IResourceName, IEquatable ProcessorTypeName

Inherited Members

object.GetType()

Namespace

Google.Cloud.DocumentAI.V1Beta3

Assembly

Google.Cloud.DocumentAI.V1Beta3.dll

Constructors

ProcessorTypeName(string, string, string)

public ProcessorTypeName(string projectId, string locationId, string processorTypeId)

Constructs a new instance of a ProcessorTypeName class from the component parts of pattern projects/{project}/locations/{location}/processorTypes/{processor_type}

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.
`processorTypeId`	`string` The `ProcessorType` 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`

ProcessorTypeId

public string ProcessorTypeId { get; }

The ProcessorType 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 ProcessorTypeName.ResourceNameType Type { get; }

The ProcessorTypeName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ProcessorTypeNameResourceNameType`

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

Formats the IDs into the string representation of this ProcessorTypeName with pattern projects/{project}/locations/{location}/processorTypes/{processor_type}.

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.
`processorTypeId`	`string` The `ProcessorType` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ProcessorTypeName with pattern `projects/{project}/locations/{location}/processorTypes/{processor_type}`.

FormatProjectLocationProcessorType(string, string, string)

public static string FormatProjectLocationProcessorType(string projectId, string locationId, string processorTypeId)

Formats the IDs into the string representation of this ProcessorTypeName with pattern projects/{project}/locations/{location}/processorTypes/{processor_type}.

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.
`processorTypeId`	`string` The `ProcessorType` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ProcessorTypeName with pattern `projects/{project}/locations/{location}/processorTypes/{processor_type}`.

FromProjectLocationProcessorType(string, string, string)

public static ProcessorTypeName FromProjectLocationProcessorType(string projectId, string locationId, string processorTypeId)

Creates a ProcessorTypeName with the pattern projects/{project}/locations/{location}/processorTypes/{processor_type}.

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.
`processorTypeId`	`string` The `ProcessorType` ID. Must not be `null` or empty.

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