Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. discoveryengine
  5. discoveryengine/v1alpha
  6. getDocument

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.discoveryengine/v1alpha.getDocument

Explore with Pulumi AI

google-native logo

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

    Using getDocument

    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 getDocument(args: GetDocumentArgs, opts?: InvokeOptions): Promise<GetDocumentResult>
function getDocumentOutput(args: GetDocumentOutputArgs, opts?: InvokeOptions): Output<GetDocumentResult>
    def get_document(branch_id: Optional[str] = None,
                 collection_id: Optional[str] = None,
                 data_store_id: Optional[str] = None,
                 document_id: Optional[str] = None,
                 location: Optional[str] = None,
                 project: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetDocumentResult
def get_document_output(branch_id: Optional[pulumi.Input[str]] = None,
                 collection_id: Optional[pulumi.Input[str]] = None,
                 data_store_id: Optional[pulumi.Input[str]] = None,
                 document_id: Optional[pulumi.Input[str]] = None,
                 location: Optional[pulumi.Input[str]] = None,
                 project: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetDocumentResult]
    func LookupDocument(ctx *Context, args *LookupDocumentArgs, opts ...InvokeOption) (*LookupDocumentResult, error)
func LookupDocumentOutput(ctx *Context, args *LookupDocumentOutputArgs, opts ...InvokeOption) LookupDocumentResultOutput

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

    public static class GetDocument 
{
    public static Task<GetDocumentResult> InvokeAsync(GetDocumentArgs args, InvokeOptions? opts = null)
    public static Output<GetDocumentResult> Invoke(GetDocumentInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDocumentResult> getDocument(GetDocumentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:discoveryengine/v1alpha:getDocument
  arguments:
    # arguments dictionary

    The following arguments are supported:

    BranchId string
    CollectionId string
    DataStoreId string
    DocumentId string
    Location string
    Project string
    BranchId string
    CollectionId string
    DataStoreId string
    DocumentId string
    Location string
    Project string
    branchId String
    collectionId String
    dataStoreId String
    documentId String
    location String
    project String
    branchId string
    collectionId string
    dataStoreId string
    documentId string
    location string
    project string
    branchId String
    collectionId String
    dataStoreId String
    documentId String
    location String
    project String

    getDocument Result

    The following output properties are available:

    Content Pulumi.GoogleNative.DiscoveryEngine.V1Alpha.Outputs.GoogleCloudDiscoveryengineV1alphaDocumentContentResponse
    The unstructured data linked to this document. Content must be set if this document is under a CONTENT_REQUIRED data store.
    DerivedStructData Dictionary<string, string>
    This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
    JsonData string
    The JSON string representation of the document. It should conform to the registered Schema or an INVALID_ARGUMENT error is thrown.
    Name 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.
    ParentDocumentId 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.
    SchemaId string
    The identifier of the schema located in the same data store.
    StructData Dictionary<string, string>
    The structured JSON data for the document. It should conform to the registered Schema or an INVALID_ARGUMENT error is thrown.
    Content GoogleCloudDiscoveryengineV1alphaDocumentContentResponse
    The unstructured data linked to this document. Content must be set if this document is under a CONTENT_REQUIRED data store.
    DerivedStructData map[string]string
    This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
    JsonData string
    The JSON string representation of the document. It should conform to the registered Schema or an INVALID_ARGUMENT error is thrown.
    Name 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.
    ParentDocumentId 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.
    SchemaId string
    The identifier of the schema located in the same data store.
    StructData map[string]string
    The structured JSON data for the document. It should conform to the registered Schema or an INVALID_ARGUMENT error is thrown.
    content GoogleCloudDiscoveryengineV1alphaDocumentContentResponse
    The unstructured data linked to this document. Content must be set if this document is under a CONTENT_REQUIRED data store.
    derivedStructData Map<String,String>
    This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
    jsonData String
    The JSON string representation of the document. It should conform to the registered Schema or an INVALID_ARGUMENT error is thrown.
    name 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.
    parentDocumentId 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.
    schemaId String
    The identifier of the schema located in the same data store.
    structData Map<String,String>
    The structured JSON data for the document. It should conform to the registered Schema or an INVALID_ARGUMENT error is thrown.
    content GoogleCloudDiscoveryengineV1alphaDocumentContentResponse
    The unstructured data linked to this document. Content must be set if this document is under a CONTENT_REQUIRED data store.
    derivedStructData {[key: string]: string}
    This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
    jsonData string
    The JSON string representation of the document. It should conform to the registered Schema or an INVALID_ARGUMENT error is thrown.
    name 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.
    parentDocumentId 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.
    schemaId string
    The identifier of the schema located in the same data store.
    structData {[key: string]: string}
    The structured JSON data for the document. It should conform to the registered Schema or an INVALID_ARGUMENT error is thrown.
    content GoogleCloudDiscoveryengineV1alphaDocumentContentResponse
    The unstructured data linked to this document. Content must be set if this document is under a CONTENT_REQUIRED data store.
    derived_struct_data Mapping[str, str]
    This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
    json_data str
    The JSON string representation of the document. It should conform to the registered Schema or an INVALID_ARGUMENT error is thrown.
    name str
    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.
    parent_document_id str
    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.
    schema_id str
    The identifier of the schema located in the same data store.
    struct_data Mapping[str, str]
    The structured JSON data for the document. It should conform to the registered Schema or an INVALID_ARGUMENT error is thrown.
    content Property Map
    The unstructured data linked to this document. Content must be set if this document is under a CONTENT_REQUIRED data store.
    derivedStructData Map<String>
    This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
    jsonData String
    The JSON string representation of the document. It should conform to the registered Schema or an INVALID_ARGUMENT error is thrown.
    name 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.
    parentDocumentId 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.
    schemaId String
    The identifier of the schema located in the same data store.
    structData Map<String>
    The structured JSON data for the document. It should conform to the registered Schema or an INVALID_ARGUMENT error is thrown.

    Supporting Types

    GoogleCloudDiscoveryengineV1alphaDocumentContentResponse

    MimeType string
    The MIME type of the content. Supported types: * application/pdf (PDF, only native PDFs are supported for now) * text/html (HTML) * application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX) * application/vnd.openxmlformats-officedocument.presentationml.presentation (PPTX) * text/plain (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml.
    RawBytes string
    The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all bytes fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, abc123!?$*&()'-=@~ should be represented as YWJjMTIzIT8kKiYoKSctPUB+ in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json.
    Uri string
    The URI of the content. Only Cloud Storage URIs (e.g. gs://bucket-name/path/to/file) are supported. The maximum file size is 100 MB.
    MimeType string
    The MIME type of the content. Supported types: * application/pdf (PDF, only native PDFs are supported for now) * text/html (HTML) * application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX) * application/vnd.openxmlformats-officedocument.presentationml.presentation (PPTX) * text/plain (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml.
    RawBytes string
    The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all bytes fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, abc123!?$*&()'-=@~ should be represented as YWJjMTIzIT8kKiYoKSctPUB+ in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json.
    Uri string
    The URI of the content. Only Cloud Storage URIs (e.g. gs://bucket-name/path/to/file) are supported. The maximum file size is 100 MB.
    mimeType String
    The MIME type of the content. Supported types: * application/pdf (PDF, only native PDFs are supported for now) * text/html (HTML) * application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX) * application/vnd.openxmlformats-officedocument.presentationml.presentation (PPTX) * text/plain (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml.
    rawBytes String
    The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all bytes fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, abc123!?$*&()'-=@~ should be represented as YWJjMTIzIT8kKiYoKSctPUB+ in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json.
    uri String
    The URI of the content. Only Cloud Storage URIs (e.g. gs://bucket-name/path/to/file) are supported. The maximum file size is 100 MB.
    mimeType string
    The MIME type of the content. Supported types: * application/pdf (PDF, only native PDFs are supported for now) * text/html (HTML) * application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX) * application/vnd.openxmlformats-officedocument.presentationml.presentation (PPTX) * text/plain (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml.
    rawBytes string
    The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all bytes fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, abc123!?$*&()'-=@~ should be represented as YWJjMTIzIT8kKiYoKSctPUB+ in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json.
    uri string
    The URI of the content. Only Cloud Storage URIs (e.g. gs://bucket-name/path/to/file) are supported. The maximum file size is 100 MB.
    mime_type str
    The MIME type of the content. Supported types: * application/pdf (PDF, only native PDFs are supported for now) * text/html (HTML) * application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX) * application/vnd.openxmlformats-officedocument.presentationml.presentation (PPTX) * text/plain (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml.
    raw_bytes str
    The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all bytes fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, abc123!?$*&()'-=@~ should be represented as YWJjMTIzIT8kKiYoKSctPUB+ in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json.
    uri str
    The URI of the content. Only Cloud Storage URIs (e.g. gs://bucket-name/path/to/file) are supported. The maximum file size is 100 MB.
    mimeType String
    The MIME type of the content. Supported types: * application/pdf (PDF, only native PDFs are supported for now) * text/html (HTML) * application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX) * application/vnd.openxmlformats-officedocument.presentationml.presentation (PPTX) * text/plain (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml.
    rawBytes String
    The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all bytes fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, abc123!?$*&()'-=@~ should be represented as YWJjMTIzIT8kKiYoKSctPUB+ in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json.
    uri String
    The URI of the content. Only Cloud Storage URIs (e.g. gs://bucket-name/path/to/file) are supported. The maximum file size is 100 MB.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    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