Chronicle v1 API - Class ReferenceList (1.0.0-beta02)

public sealed class ReferenceList : IMessage<ReferenceList>, IEquatable<ReferenceList>, IDeepCloneable<ReferenceList>, IBufferMessage, IMessage

Reference documentation and code samples for the Chronicle v1 API class ReferenceList.

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

Inheritance

object > ReferenceList

Namespace

Google.Cloud.Chronicle.V1

Assembly

Google.Cloud.Chronicle.V1.dll

Constructors

ReferenceList()

public ReferenceList()

ReferenceList(ReferenceList)

public ReferenceList(ReferenceList other)
Parameter
Name Description
other ReferenceList

Properties

Description

public string Description { get; set; }

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

Property Value
Type Description
string

DisplayName

public string DisplayName { get; set; }

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

Property Value
Type Description
string

Entries

public RepeatedField<ReferenceListEntry> Entries { get; }

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.

Property Value
Type Description
RepeatedFieldReferenceListEntry

Name

public string Name { get; set; }

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

Property Value
Type Description
string

ReferenceListName

public ReferenceListName ReferenceListName { get; set; }

ReferenceListName-typed view over the Name resource name property.

Property Value
Type Description
ReferenceListName

RevisionCreateTime

public Timestamp RevisionCreateTime { get; set; }

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

Property Value
Type Description
Timestamp

RuleAssociationsCount

public int RuleAssociationsCount { get; set; }

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

Property Value
Type Description
int

Rules

public RepeatedField<string> Rules { get; }

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.

Property Value
Type Description
RepeatedFieldstring

ScopeInfo

public ScopeInfo ScopeInfo { get; set; }

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.

Property Value
Type Description
ScopeInfo

SyntaxType

public ReferenceListSyntaxType SyntaxType { get; set; }

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

Property Value
Type Description
ReferenceListSyntaxType