Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. documentai
  5. documentai/v1beta3
  6. getProcessor

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.getProcessor

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

Gets a processor detail.

Using getProcessor

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getProcessor(args: GetProcessorArgs, opts?: InvokeOptions): Promise<GetProcessorResult>
function getProcessorOutput(args: GetProcessorOutputArgs, opts?: InvokeOptions): Output<GetProcessorResult>
Copy
def get_processor(location: Optional[str] = None,
                  processor_id: Optional[str] = None,
                  project: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetProcessorResult
def get_processor_output(location: Optional[pulumi.Input[str]] = None,
                  processor_id: Optional[pulumi.Input[str]] = None,
                  project: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetProcessorResult]
Copy
func LookupProcessor(ctx *Context, args *LookupProcessorArgs, opts ...InvokeOption) (*LookupProcessorResult, error)
func LookupProcessorOutput(ctx *Context, args *LookupProcessorOutputArgs, opts ...InvokeOption) LookupProcessorResultOutput
Copy

> Note: This function is named LookupProcessor in the Go SDK.

public static class GetProcessor 
{
    public static Task<GetProcessorResult> InvokeAsync(GetProcessorArgs args, InvokeOptions? opts = null)
    public static Output<GetProcessorResult> Invoke(GetProcessorInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetProcessorResult> getProcessor(GetProcessorArgs args, InvokeOptions options)
public static Output<GetProcessorResult> getProcessor(GetProcessorArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:documentai/v1beta3:getProcessor
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Location This property is required. string
ProcessorId This property is required. string
Project string
Location This property is required. string
ProcessorId This property is required. string
Project string
location This property is required. String
processorId This property is required. String
project String
location This property is required. string
processorId This property is required. string
project string
location This property is required. str
processor_id This property is required. str
project str
location This property is required. String
processorId This property is required. String
project String

getProcessor Result

The following output properties are available:

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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
type String
The processor type, such as: OCR_PROCESSOR, INVOICE_PROCESSOR. To get a list of processor types, see FetchProcessorTypes.

Supporting Types

GoogleCloudDocumentaiV1beta3ProcessorVersionAliasResponse

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