DocumentDialogflowV2beta1 class
Creates a new document. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata - response: Document Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.
Constructors
- DocumentDialogflowV2beta1(String name, {DocumentDialogflowV2beta1Args? args, CustomResourceOptions? options})
-
Creates a new DocumentDialogflowV2beta1.
nameThe Pulumi resource name.argsArguments used to configure this DocumentDialogflowV2beta1. The set of arguments for Document.optionsResource options controlling this resource's behavior.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
content
↔ Output<
String> -
The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types. Note: This field is in the process of being deprecated, please use raw_content instead.
latefinal
-
contentUri
↔ Output<
String> -
The URI where the file content is located. For documents stored in Google Cloud Storage, these URIs must have the form
gs:///. NOTE: External URLs must correspond to public webpages, i.e., they must be indexed by Google Search. In particular, URLs for showing documents in Google Cloud Storage (i.e. the URL in your browser) are not supported. Instead use thegs://format URI described above.latefinal -
displayName
↔ Output<
String> -
The display name of the document. The name must be 1024 bytes or less; otherwise, the creation request fails.
latefinal
-
enableAutoReload
↔ Output<
bool> -
Optional. If true, we try to automatically reload the document every day (at a time picked by the system). If false or unspecified, we don't try to automatically reload the document. Currently you can only enable automatic reload for documents sourced from a public url, see
sourcefield for the source types. Reload status can be tracked inlatest_reload_status. If a reload fails, we will keep the document unchanged. If a reload fails with internal errors, the system will try to reload the document on the next day. If a reload fails with non-retriable errors (e.g. PERMISSION_DENIED), the system will not try to reload the document anymore. You need to manually reload the document successfully by callingReloadDocumentand clear the errors.latefinal - hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
-
importGcsCustomMetadata
↔ Output<
bool?> -
Whether to import custom metadata from Google Cloud Storage. Only valid when the document source is Google Cloud Storage URI.
latefinal
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
knowledgeBaseId
↔ Output<
String> -
latefinal
-
knowledgeTypes
↔ Output<
List< String> > -
The knowledge type of document content.
latefinal
-
latestReloadStatus
↔ Output<
GoogleCloudDialogflowV2beta1DocumentReloadStatusResponse> -
The time and status of the latest reload. This reload may have been triggered automatically or manually and may not have succeeded.
latefinal
-
location
↔ Output<
String> -
latefinal
-
metadata
↔ Output<
Map< String, String> > -
Optional. Metadata for the document. The metadata supports arbitrary key-value pairs. Suggested use cases include storing a document's title, an external URL distinct from the document's content_uri, etc. The max size of a
keyor avalueof the metadata is 1024 bytes.latefinal -
mimeType
↔ Output<
String> -
The MIME type of this document.
latefinal
-
name
↔ Output<
String> -
Optional. The document resource name. The name must be empty when creating a document. Format:
projects//locations//knowledgeBases//documents/.latefinal -
project
↔ Output<
String> -
latefinal
-
rawContent
↔ Output<
String> -
The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
state
↔ Output<
String> -
The current state of the document.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
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