Class ProcessorName (2.0.0-beta01)

public sealed class ProcessorName : IResourceName, IEquatable<ProcessorName>

Resource name for the Processor resource.

Inheritance

Object > ProcessorName

Namespace

Google.Cloud.DocumentAI.V1Beta3

Assembly

Google.Cloud.DocumentAI.V1Beta3.dll

Constructors

ProcessorName(String, String, String)

public ProcessorName(string projectId, string locationId, string processorId)

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

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

processorIdString

The Processor 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

ProcessorId

public string ProcessorId { get; }

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

The ProcessorName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ProcessorName.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 processorId)

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

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

processorIdString

The Processor ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this ProcessorName with pattern projects/{project}/locations/{location}/processors/{processor}.

FormatProjectLocationProcessor(String, String, String)

public static string FormatProjectLocationProcessor(string projectId, string locationId, string processorId)

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

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

processorIdString

The Processor ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this ProcessorName with pattern projects/{project}/locations/{location}/processors/{processor}.

FromProjectLocationProcessor(String, String, String)

public static ProcessorName FromProjectLocationProcessor(string projectId, string locationId, string processorId)

Creates a ProcessorName with the pattern projects/{project}/locations/{location}/processors/{processor}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

processorIdString

The Processor ID. Must not be null or empty.

Returns
TypeDescription
ProcessorName

A new instance of ProcessorName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ProcessorName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ProcessorName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ProcessorName

A new instance of ProcessorName 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 ProcessorName Parse(string processorName)

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

Parameter
NameDescription
processorNameString

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

Returns
TypeDescription
ProcessorName

The parsed ProcessorName if successful.

Remarks

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

  • projects/{project}/locations/{location}/processors/{processor}

Parse(String, Boolean)

public static ProcessorName Parse(string processorName, bool allowUnparsed)

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

Parameters
NameDescription
processorNameString

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

allowUnparsedBoolean

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
ProcessorName

The parsed ProcessorName if successful.

Remarks

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

  • projects/{project}/locations/{location}/processors/{processor}
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 ProcessorName)

public static bool TryParse(string processorName, out ProcessorName result)

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

Parameters
NameDescription
processorNameString

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

resultProcessorName

When this method returns, the parsed ProcessorName, 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}/processors/{processor}

TryParse(String, Boolean, out ProcessorName)

public static bool TryParse(string processorName, bool allowUnparsed, out ProcessorName result)

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

Parameters
NameDescription
processorNameString

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

allowUnparsedBoolean

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.

resultProcessorName

When this method returns, the parsed ProcessorName, 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}/processors/{processor}
Or may be in any format if allowUnparsed is true.

Operators

Equality(ProcessorName, ProcessorName)

public static bool operator ==(ProcessorName a, ProcessorName b)
Parameters
NameDescription
aProcessorName
bProcessorName
Returns
TypeDescription
Boolean

Inequality(ProcessorName, ProcessorName)

public static bool operator !=(ProcessorName a, ProcessorName b)
Parameters
NameDescription
aProcessorName
bProcessorName
Returns
TypeDescription
Boolean