google-native logo
Google Cloud Native v0.28.0, Feb 2 23

google-native.discoveryengine/v1beta.getDocument

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,
                 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,
                 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/v1beta:getDocument
  arguments:
    # arguments dictionary

The following arguments are supported:

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

getDocument Result

The following output properties are available:

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}/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.

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}/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.

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}/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.

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}/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.

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}/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.

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}/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.

Package Details

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