Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.discoveryengine/v1beta.Document
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Creates a Document.
Create Document Resource
new Document(name: string, args: DocumentArgs, opts?: CustomResourceOptions);
@overload
def Document(resource_name: str,
opts: Optional[ResourceOptions] = None,
branch_id: Optional[str] = None,
collection_id: Optional[str] = None,
data_store_id: Optional[str] = None,
document_id: Optional[str] = None,
id: Optional[str] = None,
json_data: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = None,
parent_document_id: Optional[str] = None,
project: Optional[str] = None,
schema_id: Optional[str] = None,
struct_data: Optional[Mapping[str, str]] = None)
@overload
def Document(resource_name: str,
args: DocumentArgs,
opts: Optional[ResourceOptions] = None)
func NewDocument(ctx *Context, name string, args DocumentArgs, opts ...ResourceOption) (*Document, error)
public Document(string name, DocumentArgs args, CustomResourceOptions? opts = null)
public Document(String name, DocumentArgs args)
public Document(String name, DocumentArgs args, CustomResourceOptions options)
type: google-native:discoveryengine/v1beta:Document
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DocumentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DocumentArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DocumentArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DocumentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DocumentArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Document Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Document resource accepts the following input properties:
- Branch
Id string - Collection
Id string - Data
Store stringId - Document
Id 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, anALREADY_EXISTS
error is returned. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, anINVALID_ARGUMENT
error is returned.- Id string
Immutable. The identifier of the document. Id should conform to RFC-1034 standard with a length limit of 63 characters.
- Json
Data string The JSON string representation of the document. It should conform to the registered Schema.schema or an
INVALID_ARGUMENT
error is thrown.- Location string
- 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.- Parent
Document stringId 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.
- Project string
- Schema
Id string The identifier of the schema located in the same data store.
- Struct
Data Dictionary<string, string> The structured JSON data for the document. It should conform to the registered Schema.schema or an
INVALID_ARGUMENT
error is thrown.
- Branch
Id string - Collection
Id string - Data
Store stringId - Document
Id 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, anALREADY_EXISTS
error is returned. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, anINVALID_ARGUMENT
error is returned.- Id string
Immutable. The identifier of the document. Id should conform to RFC-1034 standard with a length limit of 63 characters.
- Json
Data string The JSON string representation of the document. It should conform to the registered Schema.schema or an
INVALID_ARGUMENT
error is thrown.- Location string
- 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.- Parent
Document stringId 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.
- Project string
- Schema
Id string The identifier of the schema located in the same data store.
- Struct
Data map[string]string The structured JSON data for the document. It should conform to the registered Schema.schema or an
INVALID_ARGUMENT
error is thrown.
- branch
Id String - collection
Id String - data
Store StringId - document
Id 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, anALREADY_EXISTS
error is returned. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, anINVALID_ARGUMENT
error is returned.- id String
Immutable. The identifier of the document. Id should conform to RFC-1034 standard with a length limit of 63 characters.
- json
Data String The JSON string representation of the document. It should conform to the registered Schema.schema or an
INVALID_ARGUMENT
error is thrown.- location String
- 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.- parent
Document StringId 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.
- project String
- schema
Id String The identifier of the schema located in the same data store.
- struct
Data Map<String,String> The structured JSON data for the document. It should conform to the registered Schema.schema or an
INVALID_ARGUMENT
error is thrown.
- branch
Id string - collection
Id string - data
Store stringId - document
Id 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, anALREADY_EXISTS
error is returned. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, anINVALID_ARGUMENT
error is returned.- id string
Immutable. The identifier of the document. Id should conform to RFC-1034 standard with a length limit of 63 characters.
- json
Data string The JSON string representation of the document. It should conform to the registered Schema.schema or an
INVALID_ARGUMENT
error is thrown.- location string
- 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.- parent
Document stringId 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.
- project string
- schema
Id string The identifier of the schema located in the same data store.
- struct
Data {[key: string]: string} The structured JSON data for the document. It should conform to the registered Schema.schema or an
INVALID_ARGUMENT
error is thrown.
- branch_
id str - collection_
id str - data_
store_ strid - document_
id str 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, anALREADY_EXISTS
error is returned. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, anINVALID_ARGUMENT
error is returned.- id str
Immutable. The identifier of the document. Id should conform to RFC-1034 standard with a length limit of 63 characters.
- json_
data str The JSON string representation of the document. It should conform to the registered Schema.schema or an
INVALID_ARGUMENT
error is thrown.- location str
- 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_ strid 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.
- project str
- 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.schema or an
INVALID_ARGUMENT
error is thrown.
- branch
Id String - collection
Id String - data
Store StringId - document
Id 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, anALREADY_EXISTS
error is returned. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, anINVALID_ARGUMENT
error is returned.- id String
Immutable. The identifier of the document. Id should conform to RFC-1034 standard with a length limit of 63 characters.
- json
Data String The JSON string representation of the document. It should conform to the registered Schema.schema or an
INVALID_ARGUMENT
error is thrown.- location String
- 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.- parent
Document StringId 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.
- project String
- schema
Id String The identifier of the schema located in the same data store.
- struct
Data Map<String> The structured JSON data for the document. It should conform to the registered Schema.schema or an
INVALID_ARGUMENT
error is thrown.
Outputs
All input properties are implicitly available as output properties. Additionally, the Document resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Id string
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
- id string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.