Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. documentai
  5. documentai/v1beta3
  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/v1beta3.Processor

Explore with Pulumi AI

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/v1beta3:Processor
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. String
The unique name of the resource.
args This property is required. 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 google_nativeProcessorResource = new GoogleNative.DocumentAI.V1Beta3.Processor("google-nativeProcessorResource", new()
{
    CreateTime = "string",
    DefaultProcessorVersion = "string",
    DisplayName = "string",
    KmsKeyName = "string",
    Location = "string",
    Project = "string",
    Type = "string",
});
Copy
example, err := documentaiv1beta3.NewProcessor(ctx, "google-nativeProcessorResource", &documentaiv1beta3.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"),
})
Copy
var google_nativeProcessorResource = new Processor("google-nativeProcessorResource", ProcessorArgs.builder()
    .createTime("string")
    .defaultProcessorVersion("string")
    .displayName("string")
    .kmsKeyName("string")
    .location("string")
    .project("string")
    .type("string")
    .build());
Copy
google_native_processor_resource = google_native.documentai.v1beta3.Processor("google-nativeProcessorResource",
    create_time="string",
    default_processor_version="string",
    display_name="string",
    kms_key_name="string",
    location="string",
    project="string",
    type="string")
Copy
const google_nativeProcessorResource = new google_native.documentai.v1beta3.Processor("google-nativeProcessorResource", {
    createTime: "string",
    defaultProcessorVersion: "string",
    displayName: "string",
    kmsKeyName: "string",
    location: "string",
    project: "string",
    type: "string",
});
Copy
type: google-native:documentai/v1beta3:Processor
properties:
    createTime: string
    defaultProcessorVersion: string
    displayName: string
    kmsKeyName: string
    location: string
    project: string
    type: string
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

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 Changes to this property will trigger replacement. string
Project Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. string
Project Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. String
project Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. string
project Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. str
project Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. String
project Changes to this property will trigger replacement. 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.V1Beta3.Outputs.GoogleCloudDocumentaiV1beta3ProcessorVersionAliasResponse>
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 []GoogleCloudDocumentaiV1beta3ProcessorVersionAliasResponse
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<GoogleCloudDocumentaiV1beta3ProcessorVersionAliasResponse>
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 GoogleCloudDocumentaiV1beta3ProcessorVersionAliasResponse[]
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[GoogleCloudDocumentaiV1beta3ProcessorVersionAliasResponse]
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

GoogleCloudDocumentaiV1beta3ProcessorVersionAliasResponse
, GoogleCloudDocumentaiV1beta3ProcessorVersionAliasResponseArgs

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

Package Details

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

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