Class DocumentSchema (0.50.0)

public final class DocumentSchema extends GeneratedMessageV3 implements DocumentSchemaOrBuilder

A document schema used to define document structure.

Protobuf type google.cloud.contentwarehouse.v1.DocumentSchema

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

DOCUMENT_IS_FOLDER_FIELD_NUMBER

public static final int DOCUMENT_IS_FOLDER_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PROPERTY_DEFINITIONS_FIELD_NUMBER

public static final int PROPERTY_DEFINITIONS_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DocumentSchema getDefaultInstance()
Returns
Type Description
DocumentSchema

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static DocumentSchema.Builder newBuilder()
Returns
Type Description
DocumentSchema.Builder

newBuilder(DocumentSchema prototype)

public static DocumentSchema.Builder newBuilder(DocumentSchema prototype)
Parameter
Name Description
prototype DocumentSchema
Returns
Type Description
DocumentSchema.Builder

parseDelimitedFrom(InputStream input)

public static DocumentSchema parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DocumentSchema
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentSchema
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DocumentSchema parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DocumentSchema
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentSchema
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DocumentSchema parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DocumentSchema
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentSchema
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DocumentSchema parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DocumentSchema
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentSchema
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DocumentSchema parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DocumentSchema
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentSchema
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DocumentSchema parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DocumentSchema
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentSchema
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DocumentSchema> parser()
Returns
Type Description
Parser<DocumentSchema>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. The time when the document schema is created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the document schema is created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public DocumentSchema getDefaultInstanceForType()
Returns
Type Description
DocumentSchema

getDescription()

public String getDescription()

Schema description.

string description = 7;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Schema description.

string description = 7;

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

Required. Name of the schema given by the user. Must be unique per project.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. Name of the schema given by the user. Must be unique per project.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getDocumentIsFolder()

public boolean getDocumentIsFolder()

Document Type, true refers the document is a folder, otherwise it is a typical document.

bool document_is_folder = 4;

Returns
Type Description
boolean

The documentIsFolder.

getName()

public String getName()

The resource name of the document schema. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.

The name is ignored when creating a document schema.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The resource name of the document schema. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.

The name is ignored when creating a document schema.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<DocumentSchema> getParserForType()
Returns
Type Description
Parser<DocumentSchema>
Overrides

getPropertyDefinitions(int index)

public PropertyDefinition getPropertyDefinitions(int index)

Document details.

repeated .google.cloud.contentwarehouse.v1.PropertyDefinition property_definitions = 3;

Parameter
Name Description
index int
Returns
Type Description
PropertyDefinition

getPropertyDefinitionsCount()

public int getPropertyDefinitionsCount()

Document details.

repeated .google.cloud.contentwarehouse.v1.PropertyDefinition property_definitions = 3;

Returns
Type Description
int

getPropertyDefinitionsList()

public List<PropertyDefinition> getPropertyDefinitionsList()

Document details.

repeated .google.cloud.contentwarehouse.v1.PropertyDefinition property_definitions = 3;

Returns
Type Description
List<PropertyDefinition>

getPropertyDefinitionsOrBuilder(int index)

public PropertyDefinitionOrBuilder getPropertyDefinitionsOrBuilder(int index)

Document details.

repeated .google.cloud.contentwarehouse.v1.PropertyDefinition property_definitions = 3;

Parameter
Name Description
index int
Returns
Type Description
PropertyDefinitionOrBuilder

getPropertyDefinitionsOrBuilderList()

public List<? extends PropertyDefinitionOrBuilder> getPropertyDefinitionsOrBuilderList()

Document details.

repeated .google.cloud.contentwarehouse.v1.PropertyDefinition property_definitions = 3;

Returns
Type Description
List<? extends com.google.cloud.contentwarehouse.v1.PropertyDefinitionOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

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

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

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

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The time when the document schema is created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

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

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DocumentSchema.Builder newBuilderForType()
Returns
Type Description
DocumentSchema.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DocumentSchema.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DocumentSchema.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public DocumentSchema.Builder toBuilder()
Returns
Type Description
DocumentSchema.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException