- Resource: ReferenceList
- ReferenceListEntry
- ReferenceListSyntaxType
- ScopeInfo
- ReferenceListScope
- Methods
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 ( |
Fields | |
---|---|
name |
Output only. The resource name of the reference list. Format: projects/{project}/locations/{location}/instances/{instance}/referenceLists/{reference_list} |
display_ |
Output only. The unique display name of the reference list. |
revision_ |
Output only. The timestamp when the reference list was last updated. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted.Examples: |
description |
Required. A user-provided description of the reference list. |
entries[] |
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[] |
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_ |
Required. The syntax type indicating how list entries should be validated. |
rule_ |
Output only. The count of self-authored rules using the reference list. |
scope_ |
Output only. 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. |
ReferenceListEntry
An entry in a reference list.
JSON representation |
---|
{ "value": string } |
Fields | |
---|---|
value |
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 scope info of the reference list.
JSON representation |
---|
{
"reference_list_scope": {
object ( |
Fields | |
---|---|
reference_ |
Required. The list of scope names of the reference list, if the list is empty the reference list is treated as unscoped. |
ReferenceListScope
ReferenceListScope specifies the list of scope names of the reference list.
JSON representation |
---|
{ "scope_names": [ string ] } |
Fields | |
---|---|
scope_ |
Optional. The list of scope names of 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 |
|
---|---|
|
Creates a new reference list. |
|
Gets a single reference list. |
|
Lists a collection of reference lists. |
|
Updates an existing reference list. |