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 |
|---|
| 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 | |
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 |
data | byte[]
|
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 |
obj | Object
|
Overrides
getDefaultInstanceForType()
public DocumentInfo getDefaultInstanceForType()
getDocumentDescriptorCase()
public DocumentInfo.DocumentDescriptorCase getDocumentDescriptorCase()
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];
getName()
Required. 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.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}/collections/{collection\_id}/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 |
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 |
index | int
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 |
index | int
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
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
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}/collections/{collection\_id}/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 |
|---|
| 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)
Overrides
toBuilder()
public DocumentInfo.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
