public interface DocumentOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getDataCase()
public abstract Document.DataCase getDataCase()
Type | Description |
Document.DataCase |
getId()
public abstract String 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];
Type | Description |
String | The id. |
getIdBytes()
public abstract 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];
Type | Description |
ByteString | The bytes for id. |
getJsonData()
public abstract 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;
Type | Description |
String | The jsonData. |
getJsonDataBytes()
public abstract 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;
Type | Description |
ByteString | The bytes for jsonData. |
getName()
public abstract String 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];
Type | Description |
String | The name. |
getNameBytes()
public abstract 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];
Type | Description |
ByteString | The bytes for name. |
getParentDocumentId()
public abstract 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;
Type | Description |
String | The parentDocumentId. |
getParentDocumentIdBytes()
public abstract 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;
Type | Description |
ByteString | The bytes for parentDocumentId. |
getSchemaId()
public abstract String getSchemaId()
Required. The identifier of the schema located in the same data store.
string schema_id = 3 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
String | The schemaId. |
getSchemaIdBytes()
public abstract ByteString getSchemaIdBytes()
Required. The identifier of the schema located in the same data store.
string schema_id = 3 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
ByteString | The bytes for schemaId. |
getStructData()
public abstract 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;
Type | Description |
Struct | The structData. |
getStructDataOrBuilder()
public abstract 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;
Type | Description |
StructOrBuilder |
hasJsonData()
public abstract 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;
Type | Description |
boolean | Whether the jsonData field is set. |
hasStructData()
public abstract 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;
Type | Description |
boolean | Whether the structData field is set. |