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

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
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.

FromUnparsed(UnparsedResourceName)

public static ProcessorTypeName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ProcessorTypeName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
ProcessorTypeName

A new instance of ProcessorTypeName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static ProcessorTypeName Parse(string processorTypeName)

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

Parameter
Name Description
processorTypeName string

The resource name in string form. Must not be null.
Returns
Type Description
ProcessorTypeName

The parsed ProcessorTypeName if successful.
Remarks

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

  • projects/{project}/locations/{location}/processorTypes/{processor_type}

Parse(string, bool)

public static ProcessorTypeName Parse(string processorTypeName, bool allowUnparsed)

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

Parameters
Name Description
processorTypeName 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
ProcessorTypeName

The parsed ProcessorTypeName if successful.
Remarks

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

  • projects/{project}/locations/{location}/processorTypes/{processor_type}

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

TryParse(string, out ProcessorTypeName)

public static bool TryParse(string processorTypeName, out ProcessorTypeName result)

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

Parameters
Name Description
processorTypeName string

The resource name in string form. Must not be null.
result ProcessorTypeName

When this method returns, the parsed ProcessorTypeName, 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}/processorTypes/{processor_type}

TryParse(string, bool, out ProcessorTypeName)

public static bool TryParse(string processorTypeName, bool allowUnparsed, out ProcessorTypeName result)

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

Parameters
Name Description
processorTypeName 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 ProcessorTypeName

When this method returns, the parsed ProcessorTypeName, 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}/processorTypes/{processor_type}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ProcessorTypeName, ProcessorTypeName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ProcessorTypeName

The first resource name to compare, or null.
b ProcessorTypeName

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 !=(ProcessorTypeName, ProcessorTypeName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ProcessorTypeName

The first resource name to compare, or null.
b ProcessorTypeName

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.