Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. documentai
  5. documentai/v1
  6. Processor

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.documentai/v1.Processor

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Creates a processor from the ProcessorType provided. The processor will be at ENABLED state by default after its creation. Auto-naming is currently not supported for this resource.

    Create Processor Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Processor(name: string, args?: ProcessorArgs, opts?: CustomResourceOptions);
    @overload
def Processor(resource_name: str,
              args: Optional[ProcessorArgs] = None,
              opts: Optional[ResourceOptions] = None)

@overload
def Processor(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              create_time: Optional[str] = None,
              default_processor_version: Optional[str] = None,
              display_name: Optional[str] = None,
              kms_key_name: Optional[str] = None,
              location: Optional[str] = None,
              project: Optional[str] = None,
              type: Optional[str] = None)
    func NewProcessor(ctx *Context, name string, args *ProcessorArgs, opts ...ResourceOption) (*Processor, error)
    public Processor(string name, ProcessorArgs? args = null, CustomResourceOptions? opts = null)
    public Processor(String name, ProcessorArgs args)
public Processor(String name, ProcessorArgs args, CustomResourceOptions options)

    type: google-native:documentai/v1:Processor
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ProcessorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ProcessorArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ProcessorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProcessorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProcessorArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var processorResource = new GoogleNative.DocumentAI.V1.Processor("processorResource", new()
{
    CreateTime = "string",
    DefaultProcessorVersion = "string",
    DisplayName = "string",
    KmsKeyName = "string",
    Location = "string",
    Project = "string",
    Type = "string",
});

    example, err := documentai.NewProcessor(ctx, "processorResource", &documentai.ProcessorArgs{
CreateTime: pulumi.String("string"),
DefaultProcessorVersion: pulumi.String("string"),
DisplayName: pulumi.String("string"),
KmsKeyName: pulumi.String("string"),
Location: pulumi.String("string"),
Project: pulumi.String("string"),
Type: pulumi.String("string"),
})

    var processorResource = new Processor("processorResource", ProcessorArgs.builder()
    .createTime("string")
    .defaultProcessorVersion("string")
    .displayName("string")
    .kmsKeyName("string")
    .location("string")
    .project("string")
    .type("string")
    .build());

    processor_resource = google_native.documentai.v1.Processor("processorResource",
    create_time="string",
    default_processor_version="string",
    display_name="string",
    kms_key_name="string",
    location="string",
    project="string",
    type="string")

    const processorResource = new google_native.documentai.v1.Processor("processorResource", {
    createTime: "string",
    defaultProcessorVersion: "string",
    displayName: "string",
    kmsKeyName: "string",
    location: "string",
    project: "string",
    type: "string",
});

    type: google-native:documentai/v1:Processor
properties:
    createTime: string
    defaultProcessorVersion: string
    displayName: string
    kmsKeyName: string
    location: string
    project: string
    type: string

    Processor Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Processor resource accepts the following input properties:

    CreateTime string
    The time the processor was created.
    DefaultProcessorVersion string
    The default processor version.
    DisplayName string
    The display name of the processor.
    KmsKeyName string
    The KMS key used for encryption and decryption in CMEK scenarios.
    Location string
    Project string
    Type string
    The processor type, such as: OCR_PROCESSOR, INVOICE_PROCESSOR. To get a list of processor types, see FetchProcessorTypes.
    CreateTime string
    The time the processor was created.
    DefaultProcessorVersion string
    The default processor version.
    DisplayName string
    The display name of the processor.
    KmsKeyName string
    The KMS key used for encryption and decryption in CMEK scenarios.
    Location string
    Project string
    Type string
    The processor type, such as: OCR_PROCESSOR, INVOICE_PROCESSOR. To get a list of processor types, see FetchProcessorTypes.
    createTime String
    The time the processor was created.
    defaultProcessorVersion String
    The default processor version.
    displayName String
    The display name of the processor.
    kmsKeyName String
    The KMS key used for encryption and decryption in CMEK scenarios.
    location String
    project String
    type String
    The processor type, such as: OCR_PROCESSOR, INVOICE_PROCESSOR. To get a list of processor types, see FetchProcessorTypes.
    createTime string
    The time the processor was created.
    defaultProcessorVersion string
    The default processor version.
    displayName string
    The display name of the processor.
    kmsKeyName string
    The KMS key used for encryption and decryption in CMEK scenarios.
    location string
    project string
    type string
    The processor type, such as: OCR_PROCESSOR, INVOICE_PROCESSOR. To get a list of processor types, see FetchProcessorTypes.
    create_time str
    The time the processor was created.
    default_processor_version str
    The default processor version.
    display_name str
    The display name of the processor.
    kms_key_name str
    The KMS key used for encryption and decryption in CMEK scenarios.
    location str
    project str
    type str
    The processor type, such as: OCR_PROCESSOR, INVOICE_PROCESSOR. To get a list of processor types, see FetchProcessorTypes.
    createTime String
    The time the processor was created.
    defaultProcessorVersion String
    The default processor version.
    displayName String
    The display name of the processor.
    kmsKeyName String
    The KMS key used for encryption and decryption in CMEK scenarios.
    location String
    project String
    type String
    The processor type, such as: OCR_PROCESSOR, INVOICE_PROCESSOR. To get a list of processor types, see FetchProcessorTypes.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Processor resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Immutable. The resource name of the processor. Format: projects/{project}/locations/{location}/processors/{processor}
    ProcessEndpoint string
    Immutable. The http endpoint that can be called to invoke processing.
    ProcessorVersionAliases List<Pulumi.GoogleNative.DocumentAI.V1.Outputs.GoogleCloudDocumentaiV1ProcessorVersionAliasResponse>
    The processor version aliases.
    State string
    The state of the processor.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Immutable. The resource name of the processor. Format: projects/{project}/locations/{location}/processors/{processor}
    ProcessEndpoint string
    Immutable. The http endpoint that can be called to invoke processing.
    ProcessorVersionAliases []GoogleCloudDocumentaiV1ProcessorVersionAliasResponse
    The processor version aliases.
    State string
    The state of the processor.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Immutable. The resource name of the processor. Format: projects/{project}/locations/{location}/processors/{processor}
    processEndpoint String
    Immutable. The http endpoint that can be called to invoke processing.
    processorVersionAliases List<GoogleCloudDocumentaiV1ProcessorVersionAliasResponse>
    The processor version aliases.
    state String
    The state of the processor.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Immutable. The resource name of the processor. Format: projects/{project}/locations/{location}/processors/{processor}
    processEndpoint string
    Immutable. The http endpoint that can be called to invoke processing.
    processorVersionAliases GoogleCloudDocumentaiV1ProcessorVersionAliasResponse[]
    The processor version aliases.
    state string
    The state of the processor.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Immutable. The resource name of the processor. Format: projects/{project}/locations/{location}/processors/{processor}
    process_endpoint str
    Immutable. The http endpoint that can be called to invoke processing.
    processor_version_aliases Sequence[GoogleCloudDocumentaiV1ProcessorVersionAliasResponse]
    The processor version aliases.
    state str
    The state of the processor.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Immutable. The resource name of the processor. Format: projects/{project}/locations/{location}/processors/{processor}
    processEndpoint String
    Immutable. The http endpoint that can be called to invoke processing.
    processorVersionAliases List<Property Map>
    The processor version aliases.
    state String
    The state of the processor.

    Supporting Types

    GoogleCloudDocumentaiV1ProcessorVersionAliasResponse, GoogleCloudDocumentaiV1ProcessorVersionAliasResponseArgs

    Alias string
    The alias in the form of processor_version resource name.
    ProcessorVersion string
    The resource name of aliased processor version.
    Alias string
    The alias in the form of processor_version resource name.
    ProcessorVersion string
    The resource name of aliased processor version.
    alias String
    The alias in the form of processor_version resource name.
    processorVersion String
    The resource name of aliased processor version.
    alias string
    The alias in the form of processor_version resource name.
    processorVersion string
    The resource name of aliased processor version.
    alias str
    The alias in the form of processor_version resource name.
    processor_version str
    The resource name of aliased processor version.
    alias String
    The alias in the form of processor_version resource name.
    processorVersion String
    The resource name of aliased processor version.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native