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

branchId ↔ Output<String>

late, final

childResources → Set<Resource>

final, inherited

collectionId ↔ Output<String>

late, final

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

content ↔ Output<GoogleCloudDiscoveryengineV1alphaDocumentContentResponse>

The unstructured data linked to this document. Content must be set if this document is under a CONTENT_REQUIRED data store.

late, final

dataStoreId ↔ Output<String>

late, final

derivedStructData ↔ Output<Map<String, String>>

This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.

late, final

documentId ↔ Output<String>

Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all Documents with the same parent. Otherwise, an ALREADY_EXISTS error is returned. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

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

jsonData ↔ Output<String>

The JSON string representation of the document. It should conform to the registered Schema or an INVALID_ARGUMENT error is thrown.

late, final

location ↔ Output<String>

late, final

name ↔ Output<String>

Immutable. The full resource name of the document. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.

late, final

parentDocumentId ↔ Output<String>

The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to RFC-1034 standard with a length limit of 63 characters.

late, final

project ↔ Output<String>

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

schemaId ↔ Output<String>

The identifier of the schema located in the same data store.

late, final

structData ↔ Output<Map<String, String>>

The structured JSON data for the document. It should conform to the registered Schema or an INVALID_ARGUMENT error is thrown.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

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