Class DocumentInfo (0.7.0)
Version 0.7.0keyboard_arrow_down
public final class DocumentInfo extends GeneratedMessageV3 implements DocumentInfoOrBuilder
Detailed document information associated with a user event.
Protobuf type google.cloud.discoveryengine.v1beta.DocumentInfo
Static Fields
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
public static final int PROMOTION_IDS_FIELD_NUMBER
Field Value
QUANTITY_FIELD_NUMBER
public static final int QUANTITY_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static DocumentInfo getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static DocumentInfo . Builder newBuilder ()
Returns
newBuilder(DocumentInfo prototype)
public static DocumentInfo . Builder newBuilder ( DocumentInfo prototype )
Parameter
Returns
public static DocumentInfo parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static DocumentInfo parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static DocumentInfo parseFrom ( byte [] data )
Parameter
Name Description
databyte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DocumentInfo parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static DocumentInfo parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DocumentInfo parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static DocumentInfo parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static DocumentInfo parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static DocumentInfo parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static DocumentInfo parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static DocumentInfo parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DocumentInfo parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<DocumentInfo> parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
Overrides
getDefaultInstanceForType()
public DocumentInfo getDefaultInstanceForType ()
Returns
getDocumentDescriptorCase()
public DocumentInfo . DocumentDescriptorCase getDocumentDescriptorCase ()
Returns
getId()
Required. The Document resource ID.
string id = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
String The id.
getIdBytes()
public ByteString getIdBytes ()
Required. The Document resource ID.
string id = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
getName()
Required. The Document resource full name, of the form:
projects/<project_id>/locations/<location>/dataStores/<data_store_id>/branches/<branch_id>/documents/<document_id>
string name = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns
Type Description
String The name.
getNameBytes()
public ByteString getNameBytes ()
Required. The Document resource full name, of the form:
projects/<project_id>/locations/<location>/dataStores/<data_store_id>/branches/<branch_id>/documents/<document_id>
string name = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns
getParserForType()
public Parser<DocumentInfo> getParserForType ()
Returns
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;
Returns
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
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
hasId()
Required. The Document resource ID.
string id = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
boolean Whether the id field is set.
hasName()
Required. The Document resource full name, of the form:
projects/<project_id>/locations/<location>/dataStores/<data_store_id>/branches/<branch_id>/documents/<document_id>
string name = 2 [(.google.api.field_behavior) = REQUIRED, (.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.
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public DocumentInfo . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DocumentInfo . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public DocumentInfo . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
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."],[],[]]
