Document class

Creates a document.

Constructors

Document(String name, {DocumentArgs? args, CustomResourceOptions? options})

Creates a new Document. name The Pulumi resource name. args Arguments used to configure this Document. The set of arguments for Document. options Resource options controlling this resource's behavior.

Properties

childResources → Set<Resource>

final, inherited

cloudAiDocument ↔ Output<GoogleCloudDocumentaiV1DocumentResponse>

Document AI format to save the structured content, including OCR.

late, final

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

contentCategory ↔ Output<String>

Indicates the category (image, audio, video etc.) of the original content.

late, final

createTime ↔ Output<String>

The time when the document is created.

late, final

creator ↔ Output<String>

The user who creates the document.

late, final

displayName ↔ Output<String>

Display name of the document given by the user. This name will be displayed in the UI. Customer can populate this field with the name of the document. This differs from the 'title' field as 'title' is optional and stores the top heading in the document.

late, final

displayUri ↔ Output<String>

Uri to display the document, for example, in the UI.

late, final

dispositionTime ↔ Output<String>

If linked to a Collection with RetentionPolicy, the date when the document becomes mutable.

late, final

documentSchemaName ↔ Output<String>

The Document schema name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

inlineRawDocument ↔ Output<String>

Raw document content.

late, final

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

legalHold ↔ Output<bool>

Indicates if the document has a legal hold on it.

late, final

location ↔ Output<String>

late, final

name ↔ Output<String>

The resource name of the document. Format: projects/{project_number}/locations/{location}/documents/{document_id}. The name is ignored when creating a document.

late, final

plainText ↔ Output<String>

Other document format, such as PPTX, XLXS

late, final

project ↔ Output<String>

late, final

properties ↔ Output<List<Map<String, dynamic>>>

List of values that are user supplied metadata.

late, final

rawDocumentFileType ↔ Output<String>

This is used when DocAI was not used to load the document and parsing/ extracting is needed for the inline_raw_document. For example, if inline_raw_document is the byte representation of a PDF file, then this should be set to: RAW_DOCUMENT_FILE_TYPE_PDF.

late, final

rawDocumentPath ↔ Output<String>

Raw document file in Cloud Storage path.

late, final

referenceId ↔ Output<String>

The reference ID set by customers. Must be unique per project and location.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

textExtractionDisabled ↔ Output<bool>

If true, text extraction will not be performed.

late, final

textExtractionEnabled ↔ Output<bool>

If true, text extraction will be performed.

late, final

title ↔ Output<String>

Title that describes the document. This can be the top heading or text that describes the document.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

updater ↔ Output<String>

The user who lastly updates the document.

late, final

updateTime ↔ Output<String>

The time when the document is last updated.

late, final

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited