pulumi-google-native-kotlin/com.pulumi.googlenative.dialogflow.v2.kotlin.outputs/GetDocumentResult

GetDocumentResult

data class GetDocumentResult(val contentUri: String, val displayName: String, val enableAutoReload: Boolean, val knowledgeTypes: List<String>, val latestReloadStatus: GoogleCloudDialogflowV2DocumentReloadStatusResponse, val metadata: Map<String, String>, val mimeType: String, val name: String, val rawContent: String, val state: String)

Constructors

GetDocumentResult

fun GetDocumentResult(contentUri: String, displayName: String, enableAutoReload: Boolean, knowledgeTypes: List<String>, latestReloadStatus: GoogleCloudDialogflowV2DocumentReloadStatusResponse, metadata: Map<String, String>, mimeType: String, name: String, rawContent: String, state: String)

Types

Companion

object Companion

Properties

contentUri

val contentUri: 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 the gs:// format URI described above.

displayName

val displayName: String

The display name of the document. The name must be 1024 bytes or less; otherwise, the creation request fails.

enableAutoReload

val enableAutoReload: Boolean

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 source field for the source types. Reload status can be tracked in latest_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. PERMISION_DENIED), the system will not try to reload the document anymore. You need to manually reload the document successfully by calling ReloadDocument and clear the errors.

knowledgeTypes

val knowledgeTypes: List<String>

The knowledge type of document content.

latestReloadStatus

val latestReloadStatus: GoogleCloudDialogflowV2DocumentReloadStatusResponse

The time and status of the latest reload. This reload may have been triggered automatically or manually and may not have succeeded.

metadata

val metadata: 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 key or a value of the metadata is 1024 bytes.

mimeType

val mimeType: String

The MIME type of this document.

name

val name: String

Optional. The document resource name. The name must be empty when creating a document. Format: projects//locations//knowledgeBases//documents/.

rawContent

val rawContent: String

The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types.

state

val state: String

The current state of the document.