com.google.cloud.discoveryengine.v1beta

Interface DocumentInfoOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

DocumentInfo, DocumentInfo.Builder

public interface DocumentInfoOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
DocumentInfo.DocumentDescriptorCase	getDocumentDescriptorCase()
String	getId() Required.
com.google.protobuf.ByteString	getIdBytes() Required.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
String	getPromotionIds(int index) The promotion IDs associated with this Document.
com.google.protobuf.ByteString	getPromotionIdsBytes(int index) The promotion IDs associated with this Document.
int	getPromotionIdsCount() The promotion IDs associated with this Document.
List<String>	getPromotionIdsList() The promotion IDs associated with this Document.
int	getQuantity() Quantity of the Document associated with the user event.
boolean	hasId() Required.
boolean	hasName() Required.
boolean	hasQuantity() Quantity of the Document associated with the user event.

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

hasId

boolean hasId()

 Required. The Document resource ID.
 

string id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

Whether the id field is set.

getId

String getId()

 Required. The Document resource ID.
 

string id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

The id.

getIdBytes

com.google.protobuf.ByteString getIdBytes()

 Required. The Document resource ID.
 

string id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

The bytes for id.

hasName

boolean 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:

Whether the name field is set.

getName

String 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:

The name.

getNameBytes

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

The bytes for name.

hasQuantity

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:
 * `add-to-cart`
 * `purchase`
 

optional int32 quantity = 3;

Returns:

Whether the quantity field is set.

getQuantity

int 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:
 * `add-to-cart`
 * `purchase`
 

optional int32 quantity = 3;

Returns:

The quantity.

getPromotionIdsList

List<String> getPromotionIdsList()

 The promotion IDs associated with this Document.
 Currently, this field is restricted to at most one ID.
 

repeated string promotion_ids = 4;

Returns:

A list containing the promotionIds.

getPromotionIdsCount

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:

The count of promotionIds.

getPromotionIds

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;

Parameters:

index - The index of the element to return.

Returns:

The promotionIds at the given index.

getPromotionIdsBytes

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

Parameters:

index - The index of the value to return.

Returns:

The bytes of the promotionIds at the given index.

getDocumentDescriptorCase

DocumentInfo.DocumentDescriptorCase getDocumentDescriptorCase()