Class DocumentInfo (0.37.0)
Version 0.37.0keyboard_arrow_down
public final class DocumentInfo extends GeneratedMessageV3 implements DocumentInfoOrBuilder
Detailed document information associated with a user event.
Protobuf type google.cloud.discoveryengine.v1.DocumentInfo
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
Field Value
Type Description
int
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int
public static final int PROMOTION_IDS_FIELD_NUMBER
Field Value
Type Description
int
QUANTITY_FIELD_NUMBER
public static final int QUANTITY_FIELD_NUMBER
Field Value
Type Description
int
URI_FIELD_NUMBER
public static final int URI_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static DocumentInfo getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static DocumentInfo . Builder newBuilder ()
newBuilder(DocumentInfo prototype)
public static DocumentInfo . Builder newBuilder ( DocumentInfo prototype )
public static DocumentInfo parseDelimitedFrom ( InputStream input )
public static DocumentInfo parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static DocumentInfo parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DocumentInfo parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static DocumentInfo parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DocumentInfo parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static DocumentInfo parseFrom ( CodedInputStream input )
public static DocumentInfo parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static DocumentInfo parseFrom ( InputStream input )
public static DocumentInfo parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static DocumentInfo parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DocumentInfo parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<DocumentInfo> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public DocumentInfo getDefaultInstanceForType ()
getDocumentDescriptorCase()
public DocumentInfo . DocumentDescriptorCase getDocumentDescriptorCase ()
getId()
The Document resource ID.
string id = 1;
Returns
Type Description
String The id.
getIdBytes()
public ByteString getIdBytes ()
The Document resource ID.
string id = 1;
Returns
Type Description
ByteString The bytes for id.
getName()
The Document resource full
name, of the form:
projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}
string name = 2 [(.google.api.resource_reference) = { ... }
Returns
Type Description
String The name.
getNameBytes()
public ByteString getNameBytes ()
The Document resource full
name, of the form:
projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}
string name = 2 [(.google.api.resource_reference) = { ... }
Returns
Type Description
ByteString The bytes for name.
getParserForType()
public Parser<DocumentInfo> getParserForType ()
Overrides
public String getPromotionIds ( int index )
The promotion IDs associated with this Document.
Currently, this field is restricted to at most one ID.
repeated string promotion_ids = 4;
Parameter
Name Description
indexint The index of the element to return.
Returns
Type Description
String The promotionIds at the given index.
public ByteString getPromotionIdsBytes ( int index )
The promotion IDs associated with this Document.
Currently, this field is restricted to at most one ID.
repeated string promotion_ids = 4;
Parameter
Name Description
indexint The index of the value to return.
Returns
Type Description
ByteString The bytes of the promotionIds at the given index.
public int getPromotionIdsCount ()
The promotion IDs associated with this Document.
Currently, this field is restricted to at most one ID.
repeated string promotion_ids = 4;
Returns
Type Description
int The count of promotionIds.
public ProtocolStringList getPromotionIdsList ()
The promotion IDs associated with this Document.
Currently, this field is restricted to at most one ID.
repeated string promotion_ids = 4;
getQuantity()
Quantity of the Document associated with the user event. Defaults to 1.
For example, this field will be 2 if two quantities of the same Document
are involved in a add-to-cart event.
Required for events of the following event types:
optional int32 quantity = 3;
Returns
Type Description
int The quantity.
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getUri()
The Document URI - only
allowed for website data stores.
string uri = 6;
Returns
Type Description
String The uri.
getUriBytes()
public ByteString getUriBytes ()
The Document URI - only
allowed for website data stores.
string uri = 6;
Returns
Type Description
ByteString The bytes for uri.
hasId()
The Document resource ID.
string id = 1;
Returns
Type Description
boolean Whether the id field is set.
hasName()
The Document resource full
name, of the form:
projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}
string name = 2 [(.google.api.resource_reference) = { ... }
Returns
Type Description
boolean Whether the name field is set.
hasQuantity()
public boolean hasQuantity ()
Quantity of the Document associated with the user event. Defaults to 1.
For example, this field will be 2 if two quantities of the same Document
are involved in a add-to-cart event.
Required for events of the following event types:
optional int32 quantity = 3;
Returns
Type Description
boolean Whether the quantity field is set.
hasUri()
The Document URI - only
allowed for website data stores.
string uri = 6;
Returns
Type Description
boolean Whether the uri field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public DocumentInfo . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DocumentInfo . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public DocumentInfo . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
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-10-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
