Class ProjectsResource.LocationsResource.ProcessorsResource
The "processors" collection of methods.
Inherited Members
Namespace: Google.Apis.Document.v1beta3
Assembly: Google.Apis.Document.v1beta3.dll
Syntax
public class ProjectsResource.LocationsResource.ProcessorsResource
Constructors
ProcessorsResource(IClientService)
Constructs a new resource.
Declaration
public ProcessorsResource(IClientService service)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service |
Properties
Dataset
Gets the Dataset resource.
Declaration
public virtual ProjectsResource.LocationsResource.ProcessorsResource.DatasetResource Dataset { get; }
Property Value
Type | Description |
---|---|
ProjectsResource.LocationsResource.ProcessorsResource.DatasetResource |
HumanReviewConfig
Gets the HumanReviewConfig resource.
Declaration
public virtual ProjectsResource.LocationsResource.ProcessorsResource.HumanReviewConfigResource HumanReviewConfig { get; }
Property Value
Type | Description |
---|---|
ProjectsResource.LocationsResource.ProcessorsResource.HumanReviewConfigResource |
ProcessorVersions
Gets the ProcessorVersions resource.
Declaration
public virtual ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource ProcessorVersions { get; }
Property Value
Type | Description |
---|---|
ProjectsResource.LocationsResource.ProcessorsResource.ProcessorVersionsResource |
Methods
BatchProcess(GoogleCloudDocumentaiV1beta3BatchProcessRequest, string)
LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.
Declaration
public virtual ProjectsResource.LocationsResource.ProcessorsResource.BatchProcessRequest BatchProcess(GoogleCloudDocumentaiV1beta3BatchProcessRequest body, string name)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudDocumentaiV1beta3BatchProcessRequest | body | The body of the request. |
string | name | Required. The resource name of Processor or ProcessorVersion. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.ProcessorsResource.BatchProcessRequest |
Create(GoogleCloudDocumentaiV1beta3Processor, string)
Creates a processor from the ProcessorType provided. The processor will be at ENABLED
state by
default after its creation.
Declaration
public virtual ProjectsResource.LocationsResource.ProcessorsResource.CreateRequest Create(GoogleCloudDocumentaiV1beta3Processor body, string parent)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudDocumentaiV1beta3Processor | body | The body of the request. |
string | parent | Required. The parent (project and location) under which to create the processor. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.ProcessorsResource.CreateRequest |
Delete(string)
Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor.
Declaration
public virtual ProjectsResource.LocationsResource.ProcessorsResource.DeleteRequest Delete(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name | Required. The processor resource name to be deleted. |
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.ProcessorsResource.DeleteRequest |
Disable(GoogleCloudDocumentaiV1beta3DisableProcessorRequest, string)
Disables a processor
Declaration
public virtual ProjectsResource.LocationsResource.ProcessorsResource.DisableRequest Disable(GoogleCloudDocumentaiV1beta3DisableProcessorRequest body, string name)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudDocumentaiV1beta3DisableProcessorRequest | body | The body of the request. |
string | name | Required. The processor resource name to be disabled. |
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.ProcessorsResource.DisableRequest |
Enable(GoogleCloudDocumentaiV1beta3EnableProcessorRequest, string)
Enables a processor
Declaration
public virtual ProjectsResource.LocationsResource.ProcessorsResource.EnableRequest Enable(GoogleCloudDocumentaiV1beta3EnableProcessorRequest body, string name)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudDocumentaiV1beta3EnableProcessorRequest | body | The body of the request. |
string | name | Required. The processor resource name to be enabled. |
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.ProcessorsResource.EnableRequest |
Get(string)
Gets a processor detail.
Declaration
public virtual ProjectsResource.LocationsResource.ProcessorsResource.GetRequest Get(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name | Required. The processor resource name. |
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.ProcessorsResource.GetRequest |
List(string)
Lists all processors which belong to this project.
Declaration
public virtual ProjectsResource.LocationsResource.ProcessorsResource.ListRequest List(string parent)
Parameters
Type | Name | Description |
---|---|---|
string | parent | Required. The parent (project and location) which owns this collection of Processors. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.ProcessorsResource.ListRequest |
Process(GoogleCloudDocumentaiV1beta3ProcessRequest, string)
Processes a single document.
Declaration
public virtual ProjectsResource.LocationsResource.ProcessorsResource.ProcessRequest Process(GoogleCloudDocumentaiV1beta3ProcessRequest body, string name)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudDocumentaiV1beta3ProcessRequest | body | The body of the request. |
string | name | Required. The resource name of the Processor or ProcessorVersion to use for processing. If a
Processor is specified, the server will use its default version. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.ProcessorsResource.ProcessRequest |
SetDefaultProcessorVersion(GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionRequest, string)
Set the default (active) version of a Processor that will be used in ProcessDocument and BatchProcessDocuments.
Declaration
public virtual ProjectsResource.LocationsResource.ProcessorsResource.SetDefaultProcessorVersionRequest SetDefaultProcessorVersion(GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionRequest body, string processor)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionRequest | body | The body of the request. |
string | processor | Required. The resource name of the Processor to change default version. |
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.ProcessorsResource.SetDefaultProcessorVersionRequest |
UpdateDataset(GoogleCloudDocumentaiV1beta3Dataset, string)
Updates metadata associated with a dataset.
Declaration
public virtual ProjectsResource.LocationsResource.ProcessorsResource.UpdateDatasetRequest UpdateDataset(GoogleCloudDocumentaiV1beta3Dataset body, string name)
Parameters
Type | Name | Description |
---|---|---|
GoogleCloudDocumentaiV1beta3Dataset | body | The body of the request. |
string | name | Dataset resource name. Format:
|
Returns
Type | Description |
---|---|
ProjectsResource.LocationsResource.ProcessorsResource.UpdateDatasetRequest |