Class GoogleCloudContentwarehouseV1Document

Defines the structure for content warehouse document proto.

Inheritance

object

GoogleCloudContentwarehouseV1Document

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Contentwarehouse.v1.Data

Assembly: Google.Apis.Contentwarehouse.v1.dll

Syntax

public class GoogleCloudContentwarehouseV1Document : IDirectResponseSchema

Properties

CloudAiDocument

Document AI format to save the structured content, including OCR.

Declaration

[JsonProperty("cloudAiDocument")]
public virtual GoogleCloudDocumentaiV1Document CloudAiDocument { get; set; }

Property Value

Type	Description
GoogleCloudDocumentaiV1Document

ContentCategory

Indicates the category (image, audio, video etc.) of the original content.

Declaration

[JsonProperty("contentCategory")]
public virtual string ContentCategory { get; set; }

Property Value

Type	Description
string

CreateTime

object representation of CreateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }

Property Value

Type	Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

CreateTimeRaw

Output only. The time when the document is created.

Declaration

[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }

Property Value

Type	Description
string

Creator

The user who creates the document.

Declaration

[JsonProperty("creator")]
public virtual string Creator { get; set; }

Property Value

Type	Description
string

DisplayName

Required. Display name of the document given by the user. This name will be displayed in the UI. Customer can populate this field with the name of the document. This differs from the 'title' field as 'title' is optional and stores the top heading in the document.

Declaration

[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }

Property Value

Type	Description
string

DisplayUri

Uri to display the document, for example, in the UI.

Declaration

[JsonProperty("displayUri")]
public virtual string DisplayUri { get; set; }

Property Value

Type	Description
string

DispositionTime

object representation of DispositionTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use DispositionTimeDateTimeOffset instead.")]
public virtual object DispositionTime { get; set; }

Property Value

Type	Description
object

DispositionTimeDateTimeOffset

DateTimeOffset representation of DispositionTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? DispositionTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

DispositionTimeRaw

Output only. If linked to a Collection with RetentionPolicy, the date when the document becomes mutable.

Declaration

[JsonProperty("dispositionTime")]
public virtual string DispositionTimeRaw { get; set; }

Property Value

Type	Description
string

DocumentSchemaName

The Document schema name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.

Declaration

[JsonProperty("documentSchemaName")]
public virtual string DocumentSchemaName { get; set; }

Property Value

Type	Description
string

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

InlineRawDocument

Raw document content.

Declaration

[JsonProperty("inlineRawDocument")]
public virtual string InlineRawDocument { get; set; }

Property Value

Type	Description
string

LegalHold

Output only. Indicates if the document has a legal hold on it.

Declaration

[JsonProperty("legalHold")]
public virtual bool? LegalHold { get; set; }

Property Value

Type	Description
bool?

Name

The resource name of the document. Format: projects/{project_number}/locations/{location}/documents/{document_id}. The name is ignored when creating a document.

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

PlainText

Other document format, such as PPTX, XLXS

Declaration

[JsonProperty("plainText")]
public virtual string PlainText { get; set; }

Property Value

Type	Description
string

Properties

List of values that are user supplied metadata.

Declaration

[JsonProperty("properties")]
public virtual IList<GoogleCloudContentwarehouseV1Property> Properties { get; set; }

Property Value

Type	Description
IList<GoogleCloudContentwarehouseV1Property>

RawDocumentFileType

This is used when DocAI was not used to load the document and parsing/ extracting is needed for the inline_raw_document. For example, if inline_raw_document is the byte representation of a PDF file, then this should be set to: RAW_DOCUMENT_FILE_TYPE_PDF.

Declaration

[JsonProperty("rawDocumentFileType")]
public virtual string RawDocumentFileType { get; set; }

Property Value

Type	Description
string

RawDocumentPath

Raw document file in Cloud Storage path.

Declaration

[JsonProperty("rawDocumentPath")]
public virtual string RawDocumentPath { get; set; }

Property Value

Type	Description
string

ReferenceId

The reference ID set by customers. Must be unique per project and location.

Declaration

[JsonProperty("referenceId")]
public virtual string ReferenceId { get; set; }

Property Value

Type	Description
string

TextExtractionDisabled

If true, text extraction will not be performed.

Declaration

[JsonProperty("textExtractionDisabled")]
public virtual bool? TextExtractionDisabled { get; set; }

Property Value

Type	Description
bool?

TextExtractionEnabled

If true, text extraction will be performed.

Declaration

[JsonProperty("textExtractionEnabled")]
public virtual bool? TextExtractionEnabled { get; set; }

Property Value

Type	Description
bool?

Title

Title that describes the document. This can be the top heading or text that describes the document.

Declaration

[JsonProperty("title")]
public virtual string Title { get; set; }

Property Value

Type	Description
string

UpdateTime

object representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }

Property Value

Type	Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

UpdateTimeRaw

Output only. The time when the document is last updated.

Declaration

[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }

Property Value

Type	Description
string

Updater

The user who lastly updates the document.

Declaration

[JsonProperty("updater")]
public virtual string Updater { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema