com.google.cloud.discoveryengine.v1beta

Interface DocumentOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Document, Document.Builder

public interface DocumentOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Document.DataCase	getDataCase()
String	getId() Immutable.
com.google.protobuf.ByteString	getIdBytes() Immutable.
String	getJsonData() The JSON string representation of the document.
com.google.protobuf.ByteString	getJsonDataBytes() The JSON string representation of the document.
String	getName() Immutable.
com.google.protobuf.ByteString	getNameBytes() Immutable.
String	getParentDocumentId() The identifier of the parent document.
com.google.protobuf.ByteString	getParentDocumentIdBytes() The identifier of the parent document.
String	getSchemaId() Required.
com.google.protobuf.ByteString	getSchemaIdBytes() Required.
com.google.protobuf.Struct	getStructData() The structured JSON data for the document.
com.google.protobuf.StructOrBuilder	getStructDataOrBuilder() The structured JSON data for the document.
boolean	hasJsonData() The JSON string representation of the document.
boolean	hasStructData() The structured JSON data for the document.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasStructData

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:

Whether the structData field is set.

getStructData

com.google.protobuf.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:

The structData.

getStructDataOrBuilder

com.google.protobuf.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;

hasJsonData

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:

Whether the jsonData field is set.

getJsonData

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:

The jsonData.

getJsonDataBytes

com.google.protobuf.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:

The bytes for jsonData.

getName

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];

Returns:

The name.

getNameBytes

com.google.protobuf.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:

The bytes for name.

getId

String getId()

 Immutable. The identifier of the document.
 Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
 standard with a length limit of 63 characters.
 

string id = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns:

The id.

getIdBytes

com.google.protobuf.ByteString getIdBytes()

 Immutable. The identifier of the document.
 Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
 standard with a length limit of 63 characters.
 

string id = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns:

The bytes for id.

getSchemaId

String getSchemaId()

 Required. The identifier of the schema located in the same data store.
 

string schema_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns:

The schemaId.

getSchemaIdBytes

com.google.protobuf.ByteString getSchemaIdBytes()

 Required. The identifier of the schema located in the same data store.
 

string schema_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns:

The bytes for schemaId.

getParentDocumentId

String getParentDocumentId()

 The identifier of the parent document. Currently supports at most two level
 document hierarchy.
 Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
 standard with a length limit of 63 characters.
 

string parent_document_id = 7;

Returns:

The parentDocumentId.

getParentDocumentIdBytes

com.google.protobuf.ByteString getParentDocumentIdBytes()

 The identifier of the parent document. Currently supports at most two level
 document hierarchy.
 Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
 standard with a length limit of 63 characters.
 

string parent_document_id = 7;

Returns:

The bytes for parentDocumentId.

getDataCase

Document.DataCase getDataCase()