0.9.0 (latest) 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.1 0.2.0 0.1.0 Reference documentation and code samples for the Chronicle V1 API class Google::Cloud::Chronicle::V1::ReferenceList.

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

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #description

    def description() -> ::String

**Returns**

- (::String) --- Required. A user-provided description of the reference list.

### #description=

    def description=(value) -> ::String

**Parameter**

- **value** (::String) --- Required. A user-provided description of the reference list.
**Returns**

- (::String) --- Required. A user-provided description of the reference list.

### #display_name

    def display_name() -> ::String

**Returns**

- (::String) --- Output only. The unique display name of the reference list.

### #entries

    def entries() -> ::Array<::Google::Cloud::Chronicle::V1::ReferenceListEntry>

**Returns**

- (::Array\<[::Google::Cloud::Chronicle::V1::ReferenceListEntry](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-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.

### #entries=

    def entries=(value) -> ::Array<::Google::Cloud::Chronicle::V1::ReferenceListEntry>

**Parameter**

- **value** (::Array\<[::Google::Cloud::Chronicle::V1::ReferenceListEntry](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-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.
**Returns**

- (::Array\<[::Google::Cloud::Chronicle::V1::ReferenceListEntry](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-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.

### #name

    def name() -> ::String

**Returns**

- (::String) --- Identifier. The resource name of the reference list. Format: `projects/{project}/locations/{location}/instances/{instance}/referenceLists/{reference_list}`

### #name=

    def name=(value) -> ::String

**Parameter**

- **value** (::String) --- Identifier. The resource name of the reference list. Format: `projects/{project}/locations/{location}/instances/{instance}/referenceLists/{reference_list}`
**Returns**

- (::String) --- Identifier. The resource name of the reference list. Format: `projects/{project}/locations/{location}/instances/{instance}/referenceLists/{reference_list}`

### #revision_create_time

    def revision_create_time() -> ::Google::Protobuf::Timestamp

**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Protobuf-Timestamp)) --- Output only. The timestamp when the reference list was last updated.

### #rule_associations_count

    def rule_associations_count() -> ::Integer

**Returns**

- (::Integer) --- Output only. The count of self-authored rules using the reference list.

### #rules

    def rules() -> ::Array<::String>

**Returns**

- (::Array\<::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.

### #scope_info

    def scope_info() -> ::Google::Cloud::Chronicle::V1::ScopeInfo

**Returns**

- ([::Google::Cloud::Chronicle::V1::ScopeInfo](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-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.

### #scope_info=

    def scope_info=(value) -> ::Google::Cloud::Chronicle::V1::ScopeInfo

**Parameter**

- **value** ([::Google::Cloud::Chronicle::V1::ScopeInfo](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-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.
**Returns**

- ([::Google::Cloud::Chronicle::V1::ScopeInfo](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-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.

### #syntax_type

    def syntax_type() -> ::Google::Cloud::Chronicle::V1::ReferenceListSyntaxType

**Returns**

- ([::Google::Cloud::Chronicle::V1::ReferenceListSyntaxType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-ReferenceListSyntaxType)) --- Required. The syntax type indicating how list entries should be validated.

### #syntax_type=

    def syntax_type=(value) -> ::Google::Cloud::Chronicle::V1::ReferenceListSyntaxType

**Parameter**

- **value** ([::Google::Cloud::Chronicle::V1::ReferenceListSyntaxType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-ReferenceListSyntaxType)) --- Required. The syntax type indicating how list entries should be validated.
**Returns**

- ([::Google::Cloud::Chronicle::V1::ReferenceListSyntaxType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-ReferenceListSyntaxType)) --- Required. The syntax type indicating how list entries should be validated.