Send feedback
Class Document (0.5.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 0.5.0 keyboard_arrow_down
public final class Document extends GeneratedMessageV3 implements DocumentOrBuilder
Document captures all raw metadata information of items to be recommended or
searched.
Protobuf type google.cloud.discoveryengine.v1beta.Document
Static Fields
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
Field Value
JSON_DATA_FIELD_NUMBER
public static final int JSON_DATA_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
PARENT_DOCUMENT_ID_FIELD_NUMBER
public static final int PARENT_DOCUMENT_ID_FIELD_NUMBER
Field Value
SCHEMA_ID_FIELD_NUMBER
public static final int SCHEMA_ID_FIELD_NUMBER
Field Value
STRUCT_DATA_FIELD_NUMBER
public static final int STRUCT_DATA_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Document getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static Document . Builder newBuilder ()
Returns
newBuilder(Document prototype)
public static Document . Builder newBuilder ( Document prototype )
Parameter
Returns
public static Document parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static Document parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Document parseFrom ( byte [] data )
Parameter
Name Description databyte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Document parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Document parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Document parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Document parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static Document parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static Document parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static Document parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Document parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Document parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<Document> parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
Overrides
getDataCase()
public Document . DataCase getDataCase ()
Returns
getDefaultInstanceForType()
public Document getDefaultInstanceForType ()
Returns
getId()
Immutable. The identifier of the document.
Id should conform to RFC-1034
standard with a length limit of 63 characters.
string id = 2 [(.google.api.field_behavior) = IMMUTABLE];
Returns
getIdBytes()
public ByteString getIdBytes ()
Immutable. The identifier of the document.
Id should conform to RFC-1034
standard with a length limit of 63 characters.
string id = 2 [(.google.api.field_behavior) = IMMUTABLE];
Returns
getJsonData()
public String getJsonData ()
The JSON string representation of the document. It should conform to the
registered [schema][] or an INVALID_ARGUMENT error is thrown.
string json_data = 5;
Returns
Type Description String The jsonData.
getJsonDataBytes()
public ByteString getJsonDataBytes ()
The JSON string representation of the document. It should conform to the
registered [schema][] or an INVALID_ARGUMENT error is thrown.
string json_data = 5;
Returns
getName()
Immutable. The full resource name of the document.
Format:
projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document_id}.
This field must be a UTF-8 encoded string with a length limit of 1024
characters.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
Returns
Type Description String The name.
getNameBytes()
public ByteString getNameBytes ()
Immutable. The full resource name of the document.
Format:
projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document_id}.
This field must be a UTF-8 encoded string with a length limit of 1024
characters.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
Returns
getParentDocumentId()
public String getParentDocumentId ()
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.
string parent_document_id = 7;
Returns
Type Description String The parentDocumentId.
getParentDocumentIdBytes()
public ByteString getParentDocumentIdBytes ()
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.
string parent_document_id = 7;
Returns
Type Description ByteString The bytes for parentDocumentId.
getParserForType()
public Parser<Document> getParserForType ()
Returns
Overrides
getSchemaId()
public String getSchemaId ()
Required. The identifier of the schema located in the same data store.
string schema_id = 3 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description String The schemaId.
getSchemaIdBytes()
public ByteString getSchemaIdBytes ()
Required. The identifier of the schema located in the same data store.
string schema_id = 3 [(.google.api.field_behavior) = REQUIRED];
Returns
getSerializedSize()
public int getSerializedSize ()
Returns
Overrides
getStructData()
public Struct getStructData ()
The structured JSON data for the document. It should conform to the
registered [schema][] or an INVALID_ARGUMENT error is thrown.
.google.protobuf.Struct struct_data = 4;
Returns
Type Description Struct The structData.
getStructDataOrBuilder()
public StructOrBuilder getStructDataOrBuilder ()
The structured JSON data for the document. It should conform to the
registered [schema][] or an INVALID_ARGUMENT error is thrown.
.google.protobuf.Struct struct_data = 4;
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
hasJsonData()
public boolean hasJsonData ()
The JSON string representation of the document. It should conform to the
registered [schema][] or an INVALID_ARGUMENT error is thrown.
string json_data = 5;
Returns
Type Description boolean Whether the jsonData field is set.
hasStructData()
public boolean hasStructData ()
The structured JSON data for the document. It should conform to the
registered [schema][] or an INVALID_ARGUMENT error is thrown.
.google.protobuf.Struct struct_data = 4;
Returns
Type Description boolean Whether the structData field is set.
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public Document . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Document . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public Document . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-28 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-28 UTC."],[],[]]
