public sealed class ProcessorName : IResourceName, IEquatable<ProcessorName>
Reference documentation and code samples for the Cloud Document AI v1 API class ProcessorName.
Resource name for the Processor
resource.
Namespace
Google.Cloud.DocumentAI.V1Assembly
Google.Cloud.DocumentAI.V1.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 | |
---|---|
Name | Description |
projectId | String The |
locationId | String The |
processorId | String The |
Properties
IsKnownPattern
public bool IsKnownPattern { get; }
Whether this instance contains a resource name with a known pattern.
Property Value | |
---|---|
Type | Description |
Boolean |
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 |
ProcessorId
public string ProcessorId { get; }
The Processor
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 ProcessorName.ResourceNameType Type { get; }
The ProcessorName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
ProcessorName.ResourceNameType |
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 processorId)
Formats the IDs into the string representation of this ProcessorName with pattern
projects/{project}/locations/{location}/processors/{processor}
.
Parameters | |
---|---|
Name | Description |
projectId | String The |
locationId | String The |
processorId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this ProcessorName with pattern
|
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 | |
---|---|
Name | Description |
projectId | String The |
locationId | String The |
processorId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this ProcessorName with pattern
|
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 | |
---|---|
Name | Description |
projectId | String The |
locationId | String The |
processorId | String The |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
unparsedResourceName | UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
ProcessorName | A new instance of ProcessorName containing the provided
|
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
Int32 |
Parse(String)
public static ProcessorName Parse(string processorName)
Parses the given resource name string into a new ProcessorName instance.
Parameter | |
---|---|
Name | Description |
processorName | String The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
ProcessorName | The parsed ProcessorName if successful. |
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 | |
---|---|
Name | Description |
processorName | String The resource name in string form. Must not be |
allowUnparsed | Boolean If |
Returns | |
---|---|
Type | Description |
ProcessorName | The parsed ProcessorName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/processors/{processor}
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. |
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 | |
---|---|
Name | Description |
processorName | String The resource name in string form. Must not be |
result | ProcessorName When this method returns, the parsed ProcessorName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
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 | |
---|---|
Name | Description |
processorName | String The resource name in string form. Must not be |
allowUnparsed | Boolean If |
result | ProcessorName When this method returns, the parsed ProcessorName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/processors/{processor}
allowUnparsed
is true
.
Operators
Equality(ProcessorName, ProcessorName)
public static bool operator ==(ProcessorName a, ProcessorName b)
Parameters | |
---|---|
Name | Description |
a | ProcessorName |
b | ProcessorName |
Returns | |
---|---|
Type | Description |
Boolean |
Inequality(ProcessorName, ProcessorName)
public static bool operator !=(ProcessorName a, ProcessorName b)
Parameters | |
---|---|
Name | Description |
a | ProcessorName |
b | ProcessorName |
Returns | |
---|---|
Type | Description |
Boolean |