public interface DocumentInfoOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getDocumentDescriptorCase()
public abstract DocumentInfo.DocumentDescriptorCase getDocumentDescriptorCase()
Returns | |
---|---|
Type | Description |
DocumentInfo.DocumentDescriptorCase |
getId()
public abstract String getId()
The Document resource ID.
string id = 1;
Returns | |
---|---|
Type | Description |
String | The id. |
getIdBytes()
public abstract ByteString getIdBytes()
The Document resource ID.
string id = 1;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for id. |
getName()
public abstract String 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 abstract 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. |
getPromotionIds(int index)
public abstract 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. |
getPromotionIdsBytes(int index)
public abstract 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. |
getPromotionIdsCount()
public abstract 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. |
getPromotionIdsList()
public abstract 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 | |
---|---|
Type | Description |
List<String> | A list containing the promotionIds. |
getQuantity()
public abstract 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 | |
---|---|
Type | Description |
int | The quantity. |
getUri()
public abstract String getUri()
The Document URI - only allowed for website data stores.
string uri = 6;
Returns | |
---|---|
Type | Description |
String | The uri. |
getUriBytes()
public abstract ByteString getUriBytes()
The Document URI - only allowed for website data stores.
string uri = 6;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for uri. |
hasId()
public abstract boolean hasId()
The Document resource ID.
string id = 1;
Returns | |
---|---|
Type | Description |
boolean | Whether the id field is set. |
hasName()
public abstract boolean 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 abstract 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 | |
---|---|
Type | Description |
boolean | Whether the quantity field is set. |
hasUri()
public abstract boolean hasUri()
The Document URI - only allowed for website data stores.
string uri = 6;
Returns | |
---|---|
Type | Description |
boolean | Whether the uri field is set. |