Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.discoveryengine/v1alpha.Document
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Creates a Document.
Create Document Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Document(name: string, args: DocumentArgs, opts?: CustomResourceOptions);
@overload
def Document(resource_name: str,
args: DocumentArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Document(resource_name: str,
opts: Optional[ResourceOptions] = None,
document_id: Optional[str] = None,
collection_id: Optional[str] = None,
branch_id: Optional[str] = None,
data_store_id: Optional[str] = None,
json_data: Optional[str] = None,
id: Optional[str] = None,
content: Optional[GoogleCloudDiscoveryengineV1alphaDocumentContentArgs] = 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)
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/v1alpha:Document
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var exampledocumentResourceResourceFromDiscoveryenginev1alpha = new GoogleNative.DiscoveryEngine.V1Alpha.Document("exampledocumentResourceResourceFromDiscoveryenginev1alpha", new()
{
DocumentId = "string",
CollectionId = "string",
BranchId = "string",
DataStoreId = "string",
JsonData = "string",
Id = "string",
Content = new GoogleNative.DiscoveryEngine.V1Alpha.Inputs.GoogleCloudDiscoveryengineV1alphaDocumentContentArgs
{
MimeType = "string",
RawBytes = "string",
Uri = "string",
},
Location = "string",
Name = "string",
ParentDocumentId = "string",
Project = "string",
SchemaId = "string",
StructData =
{
{ "string", "string" },
},
});
example, err := discoveryengine.NewDocument(ctx, "exampledocumentResourceResourceFromDiscoveryenginev1alpha", &discoveryengine.DocumentArgs{
DocumentId: pulumi.String("string"),
CollectionId: pulumi.String("string"),
BranchId: pulumi.String("string"),
DataStoreId: pulumi.String("string"),
JsonData: pulumi.String("string"),
Id: pulumi.String("string"),
Content: &discoveryengine.GoogleCloudDiscoveryengineV1alphaDocumentContentArgs{
MimeType: pulumi.String("string"),
RawBytes: pulumi.String("string"),
Uri: pulumi.String("string"),
},
Location: pulumi.String("string"),
Name: pulumi.String("string"),
ParentDocumentId: pulumi.String("string"),
Project: pulumi.String("string"),
SchemaId: pulumi.String("string"),
StructData: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var exampledocumentResourceResourceFromDiscoveryenginev1alpha = new Document("exampledocumentResourceResourceFromDiscoveryenginev1alpha", DocumentArgs.builder()
.documentId("string")
.collectionId("string")
.branchId("string")
.dataStoreId("string")
.jsonData("string")
.id("string")
.content(GoogleCloudDiscoveryengineV1alphaDocumentContentArgs.builder()
.mimeType("string")
.rawBytes("string")
.uri("string")
.build())
.location("string")
.name("string")
.parentDocumentId("string")
.project("string")
.schemaId("string")
.structData(Map.of("string", "string"))
.build());
exampledocument_resource_resource_from_discoveryenginev1alpha = google_native.discoveryengine.v1alpha.Document("exampledocumentResourceResourceFromDiscoveryenginev1alpha",
document_id="string",
collection_id="string",
branch_id="string",
data_store_id="string",
json_data="string",
id="string",
content={
"mime_type": "string",
"raw_bytes": "string",
"uri": "string",
},
location="string",
name="string",
parent_document_id="string",
project="string",
schema_id="string",
struct_data={
"string": "string",
})
const exampledocumentResourceResourceFromDiscoveryenginev1alpha = new google_native.discoveryengine.v1alpha.Document("exampledocumentResourceResourceFromDiscoveryenginev1alpha", {
documentId: "string",
collectionId: "string",
branchId: "string",
dataStoreId: "string",
jsonData: "string",
id: "string",
content: {
mimeType: "string",
rawBytes: "string",
uri: "string",
},
location: "string",
name: "string",
parentDocumentId: "string",
project: "string",
schemaId: "string",
structData: {
string: "string",
},
});
type: google-native:discoveryengine/v1alpha:Document
properties:
branchId: string
collectionId: string
content:
mimeType: string
rawBytes: string
uri: string
dataStoreId: string
documentId: string
id: string
jsonData: string
location: string
name: string
parentDocumentId: string
project: string
schemaId: string
structData:
string: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
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. - Content
Pulumi.
Google Native. Discovery Engine. V1Alpha. Inputs. Google Cloud Discoveryengine V1alpha Document Content - The unstructured data linked to this document. Content must be set if this document is under a
CONTENT_REQUIRED
data store. - 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 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 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. - Content
Google
Cloud Discoveryengine V1alpha Document Content Args - The unstructured data linked to this document. Content must be set if this document is under a
CONTENT_REQUIRED
data store. - 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 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 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. - content
Google
Cloud Discoveryengine V1alpha Document Content - The unstructured data linked to this document. Content must be set if this document is under a
CONTENT_REQUIRED
data store. - 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 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 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. - content
Google
Cloud Discoveryengine V1alpha Document Content - The unstructured data linked to this document. Content must be set if this document is under a
CONTENT_REQUIRED
data store. - 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 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 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. - content
Google
Cloud Discoveryengine V1alpha Document Content Args - The unstructured data linked to this document. Content must be set if this document is under a
CONTENT_REQUIRED
data store. - 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 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 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. - content Property Map
- The unstructured data linked to this document. Content must be set if this document is under a
CONTENT_REQUIRED
data store. - 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 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 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:
- Derived
Struct Dictionary<string, string>Data - This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
- Id string
- The provider-assigned unique ID for this managed resource.
- Derived
Struct map[string]stringData - This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
- Id string
- The provider-assigned unique ID for this managed resource.
- derived
Struct Map<String,String>Data - This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
- id String
- The provider-assigned unique ID for this managed resource.
- derived
Struct {[key: string]: string}Data - This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
- id string
- The provider-assigned unique ID for this managed resource.
- derived_
struct_ Mapping[str, str]data - This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
- id str
- The provider-assigned unique ID for this managed resource.
- derived
Struct Map<String>Data - This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
- id String
- The provider-assigned unique ID for this managed resource.
Supporting Types
GoogleCloudDiscoveryengineV1alphaDocumentContent, GoogleCloudDiscoveryengineV1alphaDocumentContentArgs
- Mime
Type 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. - Raw
Bytes 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 asYWJjMTIzIT8kKiYoKSctPUB+
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 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. - Raw
Bytes 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 asYWJjMTIzIT8kKiYoKSctPUB+
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 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. - raw
Bytes 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 asYWJjMTIzIT8kKiYoKSctPUB+
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 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. - raw
Bytes 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 asYWJjMTIzIT8kKiYoKSctPUB+
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 asYWJjMTIzIT8kKiYoKSctPUB+
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.
- mime
Type 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. - raw
Bytes 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 asYWJjMTIzIT8kKiYoKSctPUB+
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.
GoogleCloudDiscoveryengineV1alphaDocumentContentResponse, GoogleCloudDiscoveryengineV1alphaDocumentContentResponseArgs
- Mime
Type 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. - Raw
Bytes 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 asYWJjMTIzIT8kKiYoKSctPUB+
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 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. - Raw
Bytes 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 asYWJjMTIzIT8kKiYoKSctPUB+
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 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. - raw
Bytes 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 asYWJjMTIzIT8kKiYoKSctPUB+
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 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. - raw
Bytes 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 asYWJjMTIzIT8kKiYoKSctPUB+
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 asYWJjMTIzIT8kKiYoKSctPUB+
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.
- mime
Type 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. - raw
Bytes 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 asYWJjMTIzIT8kKiYoKSctPUB+
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 Cloud Native is in preview. Google Cloud Classic is fully supported.