0.95.0 (latest) 0.91.0 0.90.0 0.89.0 0.87.0 0.84.0 0.83.0 0.81.0 0.79.0 0.78.0 0.77.0 0.76.0 0.74.0 0.72.0 0.71.0 0.70.0 0.69.0 0.68.0 0.66.0 0.64.0 0.63.0 0.60.0 0.59.0 0.58.0 0.56.0 0.55.0 0.54.0 0.53.0 0.52.0 0.51.0 0.50.0 0.49.0 0.48.0 0.47.0 0.45.0 0.44.0 0.43.0 0.42.0 0.41.0 0.40.0 0.39.0 0.38.0 0.37.0 0.36.0 0.35.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

    public interface DocumentInfoOrBuilder extends MessageOrBuilder

## Implements

[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)

## Methods

### getDocumentDescriptorCase()

    public abstract DocumentInfo.DocumentDescriptorCase getDocumentDescriptorCase()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1alpha.DocumentInfo.DocumentDescriptorCase` |   |

### getId()

    public abstract String getId()

The Document resource
ID.

`string id = 1;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The id. |

### getIdBytes()

    public abstract ByteString getIdBytes()

The Document resource
ID.

`string id = 1;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for id. |

### getJoined()

    public abstract boolean getJoined()

Output only. Whether the referenced Document can be found in the data
store.

`bool joined = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The joined. |

### 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | 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` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` The index of the element to return. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | 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` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` The index of the value to return. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<https://docs.oracle.com/javase/8/docs/api/java/lang/String.html>` | 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 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** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The quantity. |

### getUri()

    public abstract String getUri()

The Document URI - only
allowed for website data stores.

`string uri = 6;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The uri. |

### getUriBytes()

    public abstract ByteString getUriBytes()

The Document URI - only
allowed for website data stores.

`string uri = 6;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for uri. |

### hasId()

    public abstract boolean hasId()

The Document resource
ID.

`string id = 1;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | 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 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** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the uri field is set. |