Class DocumentSchema (0.17.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
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

DOCUMENT_IS_FOLDER_FIELD_NUMBER

public static final int DOCUMENT_IS_FOLDER_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PROPERTY_DEFINITIONS_FIELD_NUMBER

public static final int PROPERTY_DEFINITIONS_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static DocumentSchema getDefaultInstance()
Returns
TypeDescription
DocumentSchema

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static DocumentSchema.Builder newBuilder()
Returns
TypeDescription
DocumentSchema.Builder

newBuilder(DocumentSchema prototype)

public static DocumentSchema.Builder newBuilder(DocumentSchema prototype)
Parameter
NameDescription
prototypeDocumentSchema
Returns
TypeDescription
DocumentSchema.Builder

parseDelimitedFrom(InputStream input)

public static DocumentSchema parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DocumentSchema
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentSchema
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static DocumentSchema parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
DocumentSchema
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentSchema
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DocumentSchema parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
DocumentSchema
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentSchema
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DocumentSchema parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
DocumentSchema
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentSchema
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static DocumentSchema parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DocumentSchema
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentSchema
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static DocumentSchema parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
DocumentSchema
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentSchema
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<DocumentSchema> parser()
Returns
TypeDescription
Parser<DocumentSchema>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public DocumentSchema getDefaultInstanceForType()
Returns
TypeDescription
DocumentSchema

getDescription()

public String getDescription()

Schema description.

string description = 7;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Schema description.

string description = 7;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<DocumentSchema> getParserForType()
Returns
TypeDescription
Parser<DocumentSchema>
Overrides

getPropertyDefinitions(int index)

public PropertyDefinition getPropertyDefinitions(int index)

Document details.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
PropertyDefinition

getPropertyDefinitionsCount()

public int getPropertyDefinitionsCount()

Document details.

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

Returns
TypeDescription
int

getPropertyDefinitionsList()

public List<PropertyDefinition> getPropertyDefinitionsList()

Document details.

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

Returns
TypeDescription
List<PropertyDefinition>

getPropertyDefinitionsOrBuilder(int index)

public PropertyDefinitionOrBuilder getPropertyDefinitionsOrBuilder(int index)

Document details.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
PropertyDefinitionOrBuilder

getPropertyDefinitionsOrBuilderList()

public List<? extends PropertyDefinitionOrBuilder> getPropertyDefinitionsOrBuilderList()

Document details.

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

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public DocumentSchema.Builder newBuilderForType()
Returns
TypeDescription
DocumentSchema.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DocumentSchema.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
DocumentSchema.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public DocumentSchema.Builder toBuilder()
Returns
TypeDescription
DocumentSchema.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException