# Google Cloud Chronicle V1 Client - Class ReferenceList (0.4.0)

0.4.0 (latest) 0.3.0 0.2.3 0.1.2 Reference documentation and code samples for the Google Cloud Chronicle V1 Client class ReferenceList.

A reference list.

Reference lists are user-defined lists of values which users can
use in multiple Rules.

Generated from protobuf message `google.cloud.chronicle.v1.ReferenceList`

## Namespace

Google \\ Cloud \\ Chronicle \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ name` | `string` Identifier. The resource name of the reference list. Format: `projects/{project}/locations/{location}/instances/{instance}/referenceLists/{reference_list}` |
| `↳ display_name` | `string` Output only. The unique display name of the reference list. |
| `↳ revision_create_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` Output only. The timestamp when the reference list was last updated. |
| `↳ description` | `string` Required. A user-provided description of the reference list. |
| `↳ entries` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-chronicle/latest/V1.ReferenceListEntry>` Required. The entries of the reference list. When listed, they are returned in the order that was specified at creation or update. The combined size of the values of the reference list may not exceed 6MB. This is returned only when the view is REFERENCE_LIST_VIEW_FULL. |
| `↳ rules` | `string[]` Output only. The resource names for the associated self-authored Rules that use this reference list. This is returned only when the view is REFERENCE_LIST_VIEW_FULL. |
| `↳ syntax_type` | `int` Required. The syntax type indicating how list entries should be validated. |
| `↳ rule_associations_count` | `int` Output only. The count of self-authored rules using the reference list. |
| `↳ scope_info` | `https://docs.cloud.google.com/php/docs/reference/cloud-chronicle/latest/V1.ScopeInfo` The scope info of the reference list. During reference list creation, if this field is not set, the reference list without scopes (an unscoped list) will be created for an unscoped user. For a scoped user, this field must be set. During reference list update, if scope_info is requested to be updated, this field must be set. |

### getName

Identifier. The resource name of the reference list.

Format:
`projects/{project}/locations/{location}/instances/{instance}/referenceLists/{reference_list}`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setName

Identifier. The resource name of the reference list.

Format:
`projects/{project}/locations/{location}/instances/{instance}/referenceLists/{reference_list}`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getDisplayName

Output only. The unique display name of the reference list.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setDisplayName

Output only. The unique display name of the reference list.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getRevisionCreateTime

Output only. The timestamp when the reference list was last updated.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp|null` |   |

### hasRevisionCreateTime

### clearRevisionCreateTime

### setRevisionCreateTime

Output only. The timestamp when the reference list was last updated.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getDescription

Required. A user-provided description of the reference list.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setDescription

Required. A user-provided description of the reference list.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getEntries

Required. The entries of the reference list.

When listed, they are returned in the order that was specified at creation
or update. The combined size of the values of the reference list may not
exceed 6MB.
This is returned only when the view is REFERENCE_LIST_VIEW_FULL.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<https://docs.cloud.google.com/php/docs/reference/cloud-chronicle/latest/V1.ReferenceListEntry>` |   |

### setEntries

Required. The entries of the reference list.

When listed, they are returned in the order that was specified at creation
or update. The combined size of the values of the reference list may not
exceed 6MB.
This is returned only when the view is REFERENCE_LIST_VIEW_FULL.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-chronicle/latest/V1.ReferenceListEntry>` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getRules

Output only. The resource names for the associated self-authored Rules that
use this reference list. This is returned only when the view is
REFERENCE_LIST_VIEW_FULL.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<string>` |   |

### setRules

Output only. The resource names for the associated self-authored Rules that
use this reference list. This is returned only when the view is
REFERENCE_LIST_VIEW_FULL.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string[]` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getSyntaxType

Required. The syntax type indicating how list entries should be validated.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [ReferenceListSyntaxType](https://docs.cloud.google.com/php/docs/reference/cloud-chronicle/latest/V1.ReferenceListSyntaxType). |

### setSyntaxType

Required. The syntax type indicating how list entries should be validated.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [ReferenceListSyntaxType](https://docs.cloud.google.com/php/docs/reference/cloud-chronicle/latest/V1.ReferenceListSyntaxType). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getRuleAssociationsCount

Output only. The count of self-authored rules using the reference list.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` |   |

### setRuleAssociationsCount

Output only. The count of self-authored rules using the reference list.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getScopeInfo

The scope info of the reference list.

During reference list creation, if this field is not set, the reference
list without scopes (an unscoped list) will be created for an unscoped
user. For a scoped user, this field must be set. During reference list
update, if scope_info is requested to be updated, this field must be set.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-chronicle/latest/V1.ScopeInfo|null` |   |

### hasScopeInfo

### clearScopeInfo

### setScopeInfo

The scope info of the reference list.

During reference list creation, if this field is not set, the reference
list without scopes (an unscoped list) will be created for an unscoped
user. For a scoped user, this field must be set. During reference list
update, if scope_info is requested to be updated, this field must be set.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-chronicle/latest/V1.ScopeInfo` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |