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

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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

processorTypeIdstring

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
TypeDescription
bool

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
string

ProcessorTypeId

public string ProcessorTypeId { get; }

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

Property Value
TypeDescription
string

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
string

Type

public ProcessorTypeName.ResourceNameType Type { get; }

The ProcessorTypeName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ProcessorTypeNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

processorTypeIdstring

The ProcessorType ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

processorTypeIdstring

The ProcessorType ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

processorTypeIdstring

The ProcessorType ID. Must not be null or empty.

Returns
TypeDescription
ProcessorTypeName

A new instance of ProcessorTypeName constructed from the provided ids.