Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::DocumentInfo (v0.23.0)

Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::DocumentInfo.

Detailed document information associated with a user event.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#id

def id() -> ::String
Returns
  • (::String) — The Document resource ID.

    Note: The following fields are mutually exclusive: id, name, uri. If a field in that set is populated, all other fields in the set will automatically be cleared.

#id=

def id=(value) -> ::String
Parameter
  • value (::String) — The Document resource ID.

    Note: The following fields are mutually exclusive: id, name, uri. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — The Document resource ID.

    Note: The following fields are mutually exclusive: id, name, uri. If a field in that set is populated, all other fields in the set will automatically be cleared.

#joined

def joined() -> ::Boolean
Returns
  • (::Boolean) — Output only. Whether the referenced Document can be found in the data store.

#name

def name() -> ::String
Returns
  • (::String) — The Document resource full name, of the form: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}

    Note: The following fields are mutually exclusive: name, id, uri. If a field in that set is populated, all other fields in the set will automatically be cleared.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — The Document resource full name, of the form: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}

    Note: The following fields are mutually exclusive: name, id, uri. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — The Document resource full name, of the form: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}

    Note: The following fields are mutually exclusive: name, id, uri. If a field in that set is populated, all other fields in the set will automatically be cleared.

#promotion_ids

def promotion_ids() -> ::Array<::String>
Returns
  • (::Array<::String>) — The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.

#promotion_ids=

def promotion_ids=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.
Returns
  • (::Array<::String>) — The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.

#quantity

def quantity() -> ::Integer
Returns
  • (::Integer) —

    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

#quantity=

def quantity=(value) -> ::Integer
Parameter
  • value (::Integer) —

    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
Returns
  • (::Integer) —

    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

#uri

def uri() -> ::String
Returns
  • (::String) — The Document URI - only allowed for website data stores.

    Note: The following fields are mutually exclusive: uri, id, name. If a field in that set is populated, all other fields in the set will automatically be cleared.

#uri=

def uri=(value) -> ::String
Parameter
  • value (::String) — The Document URI - only allowed for website data stores.

    Note: The following fields are mutually exclusive: uri, id, name. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — The Document URI - only allowed for website data stores.

    Note: The following fields are mutually exclusive: uri, id, name. If a field in that set is populated, all other fields in the set will automatically be cleared.