REST Resource: projects.locations.instances.referenceLists

Resource: ReferenceList

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

JSON representation 
{
  "name": string,
  "display_name": string,
  "revision_create_time": string,
  "description": string,
  "entries": [
    {
      object (ReferenceListEntry)
    }
  ],
  "rules": [
    string
  ],
  "syntax_type": enum (ReferenceListSyntaxType),
  "rule_associations_count": integer
}
Fields
name

string

Output only. 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

string (Timestamp format)

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

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
description

string

Required. A user-provided description of the reference list.
entries[]

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

enum (ReferenceListSyntaxType)

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

integer

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

object (ScopeInfo)

Output only. List of all scopes assigned to the reference list. During reference list creation, if this field is not set, the reference list without scopes (an unscoped list) is 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.

ReferenceListEntry

An entry in a reference list.

JSON representation 
{
  "value": string
}
Fields
value

string

Required. The value of the entry. Maximum length is 512 characters.

ReferenceListSyntaxType

The syntax type indicating how list entries should be validated.

Enums
REFERENCE_LIST_SYNTAX_TYPE_UNSPECIFIED Defaults to REFERENCE_LIST_SYNTAX_TYPE_PLAIN_TEXT_STRING.
REFERENCE_LIST_SYNTAX_TYPE_PLAIN_TEXT_STRING List contains plain text patterns.
REFERENCE_LIST_SYNTAX_TYPE_REGEX List contains only Regular Expression patterns.
REFERENCE_LIST_SYNTAX_TYPE_CIDR List contains only CIDR patterns.

ScopeInfo

ScopeInfo specifies the scopes assigned to the reference list.

JSON representation 
{
  "reference_list_scope": {
    object (ReferenceListScope)
  }
}
Fields
reference_list_scope

object (ReferenceListScope)

Required. The list of scopes assigned to the reference list, if the list is empty the reference list is treated as unscoped.

ReferenceListScope

ReferenceListScope specifies the list of scopes assigned to the reference list.

JSON representation 
{
  "scope_names": [
    string
  ]
}
Fields
scope_names[]

string

Optional. The list of scopes assigned to the reference list. The scope names should be full resource names and should be of the format: "projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{scope_name}".

Methods

create

 Creates a new reference list.

get

 Gets a single reference list.

list

 Lists a collection of reference lists.

patch

 Updates an existing reference list.