Class ProcessorTypeName

public sealed class ProcessorTypeName : IResourceName, IEquatable<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
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringlocationId

The Location ID. Must not be null or empty.

StringprocessorTypeId

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
Boolean

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

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
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringlocationId

The Location ID. Must not be null or empty.

StringprocessorTypeId

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
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringlocationId

The Location ID. Must not be null or empty.

StringprocessorTypeId

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
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringlocationId

The Location ID. Must not be null or empty.

StringprocessorTypeId

The ProcessorType ID. Must not be null or empty.

Returns
TypeDescription
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
TypeNameDescription
UnparsedResourceNameunparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ProcessorTypeName

A new instance of ProcessorTypeName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static ProcessorTypeName Parse(string processorTypeName)

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

Parameter
TypeNameDescription
StringprocessorTypeName

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

Returns
TypeDescription
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, Boolean)

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
TypeNameDescription
StringprocessorTypeName

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

BooleanallowUnparsed

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
TypeDescription
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
TypeDescription
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
TypeNameDescription
StringprocessorTypeName

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

ProcessorTypeNameresult

When this method returns, the parsed ProcessorTypeName, or null if parsing failed.

Returns
TypeDescription
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}/processorTypes/{processor_type}

TryParse(String, Boolean, 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
TypeNameDescription
StringprocessorTypeName

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

BooleanallowUnparsed

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.

ProcessorTypeNameresult

When this method returns, the parsed ProcessorTypeName, or null if parsing failed.

Returns
TypeDescription
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}/processorTypes/{processor_type}
Or may be in any format if allowUnparsed is true.

Operators

Equality(ProcessorTypeName, ProcessorTypeName)

public static bool operator ==(ProcessorTypeName a, ProcessorTypeName b)
Parameters
TypeNameDescription
ProcessorTypeNamea
ProcessorTypeNameb
Returns
TypeDescription
Boolean

Inequality(ProcessorTypeName, ProcessorTypeName)

public static bool operator !=(ProcessorTypeName a, ProcessorTypeName b)
Parameters
TypeNameDescription
ProcessorTypeNamea
ProcessorTypeNameb
Returns
TypeDescription
Boolean