com.google.cloud.discoveryengine.v1alpha

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() The [Document][google.cloud.discoveryengine.v1alpha.Document] resource ID.
com.google.protobuf.ByteString	getIdBytes() The [Document][google.cloud.discoveryengine.v1alpha.Document] resource ID.
String	getName() The [Document][google.cloud.discoveryengine.v1alpha.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) = { ... }
com.google.protobuf.ByteString	getNameBytes() The [Document][google.cloud.discoveryengine.v1alpha.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) = { ... }
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.
String	getUri() The [Document][google.cloud.discoveryengine.v1alpha.Document] URI - only allowed for website data stores.
com.google.protobuf.ByteString	getUriBytes() The [Document][google.cloud.discoveryengine.v1alpha.Document] URI - only allowed for website data stores.
boolean	hasId() The [Document][google.cloud.discoveryengine.v1alpha.Document] resource ID.
boolean	hasName() The [Document][google.cloud.discoveryengine.v1alpha.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) = { ... }
boolean	hasQuantity() Quantity of the Document associated with the user event.
boolean	hasUri() The [Document][google.cloud.discoveryengine.v1alpha.Document] URI - only allowed for website data stores.

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()

 The [Document][google.cloud.discoveryengine.v1alpha.Document] resource
 ID.
 

string id = 1;

Returns:

Whether the id field is set.

getId

String getId()

 The [Document][google.cloud.discoveryengine.v1alpha.Document] resource
 ID.
 

string id = 1;

Returns:

The id.

getIdBytes

com.google.protobuf.ByteString getIdBytes()

 The [Document][google.cloud.discoveryengine.v1alpha.Document] resource
 ID.
 

string id = 1;

Returns:

The bytes for id.

hasName

boolean hasName()

 The [Document][google.cloud.discoveryengine.v1alpha.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:

Whether the name field is set.

getName

String getName()

 The [Document][google.cloud.discoveryengine.v1alpha.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:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 The [Document][google.cloud.discoveryengine.v1alpha.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:

The bytes for name.

hasUri

boolean hasUri()

 The [Document][google.cloud.discoveryengine.v1alpha.Document] URI - only
 allowed for website data stores.
 

string uri = 6;

Returns:

Whether the uri field is set.

getUri

String getUri()

 The [Document][google.cloud.discoveryengine.v1alpha.Document] URI - only
 allowed for website data stores.
 

string uri = 6;

Returns:

The uri.

getUriBytes

com.google.protobuf.ByteString getUriBytes()

 The [Document][google.cloud.discoveryengine.v1alpha.Document] URI - only
 allowed for website data stores.
 

string uri = 6;

Returns:

The bytes for uri.

hasQuantity

boolean hasQuantity()

 Quantity of the Document associated with the user event. Defaults to 1.

 For example, this field is 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 is 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()