public sealed class ProcessorTypeName : IResourceName, IEquatable<ProcessorTypeName>
Resource name for the ProcessorType
resource.
Namespace
Google.Cloud.DocumentAI.V1Assembly
Google.Cloud.DocumentAI.V1.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 |
locationId | String The |
processorTypeId | 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 |
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 |
ProcessorTypeName.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 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 |
locationId | String The |
processorTypeId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this ProcessorTypeName with pattern
|
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 |
locationId | String The |
processorTypeId | String The |
Returns | |
---|---|
Type | Description |
String | The string representation of this ProcessorTypeName with pattern
|
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 |
locationId | String The |
processorTypeId | String The |
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 |
Returns | |
---|---|
Type | Description |
ProcessorTypeName | A new instance of ProcessorTypeName containing the provided
|
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
Int32 |
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 |
Returns | |
---|---|
Type | Description |
ProcessorTypeName | The parsed ProcessorTypeName if successful. |
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 | |
---|---|
Name | Description |
processorTypeName | String The resource name in string form. Must not be |
allowUnparsed | Boolean If |
Returns | |
---|---|
Type | Description |
ProcessorTypeName | The parsed ProcessorTypeName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/processorTypes/{processor_type}
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 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 |
result | ProcessorTypeName When this method returns, the parsed ProcessorTypeName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
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 | |
---|---|
Name | Description |
processorTypeName | String The resource name in string form. Must not be |
allowUnparsed | Boolean If |
result | ProcessorTypeName When this method returns, the parsed ProcessorTypeName, or |
Returns | |
---|---|
Type | Description |
Boolean |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/processorTypes/{processor_type}
allowUnparsed
is true
.
Operators
Equality(ProcessorTypeName, ProcessorTypeName)
public static bool operator ==(ProcessorTypeName a, ProcessorTypeName b)
Parameters | |
---|---|
Name | Description |
a | ProcessorTypeName |
b | ProcessorTypeName |
Returns | |
---|---|
Type | Description |
Boolean |
Inequality(ProcessorTypeName, ProcessorTypeName)
public static bool operator !=(ProcessorTypeName a, ProcessorTypeName b)
Parameters | |
---|---|
Name | Description |
a | ProcessorTypeName |
b | ProcessorTypeName |
Returns | |
---|---|
Type | Description |
Boolean |