Interface ReferenceListOrBuilder (0.1.0)

public interface ReferenceListOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDescription()

public abstract String getDescription()

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

string description = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

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

string description = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public abstract String getDisplayName()

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

string display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

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

string display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for displayName.

getEntries(int index)

public abstract ReferenceListEntry getEntries(int index)

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.

repeated .google.cloud.chronicle.v1.ReferenceListEntry entries = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
ReferenceListEntry

getEntriesCount()

public abstract int getEntriesCount()

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.

repeated .google.cloud.chronicle.v1.ReferenceListEntry entries = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getEntriesList()

public abstract List<ReferenceListEntry> getEntriesList()

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.

repeated .google.cloud.chronicle.v1.ReferenceListEntry entries = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<ReferenceListEntry>

getEntriesOrBuilder(int index)

public abstract ReferenceListEntryOrBuilder getEntriesOrBuilder(int index)

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.

repeated .google.cloud.chronicle.v1.ReferenceListEntry entries = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
ReferenceListEntryOrBuilder

getEntriesOrBuilderList()

public abstract List<? extends ReferenceListEntryOrBuilder> getEntriesOrBuilderList()

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.

repeated .google.cloud.chronicle.v1.ReferenceListEntry entries = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.cloud.chronicle.v1.ReferenceListEntryOrBuilder>

getName()

public abstract String getName()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getRevisionCreateTime()

public abstract Timestamp getRevisionCreateTime()

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

.google.protobuf.Timestamp revision_create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The revisionCreateTime.

getRevisionCreateTimeOrBuilder()

public abstract TimestampOrBuilder getRevisionCreateTimeOrBuilder()

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

.google.protobuf.Timestamp revision_create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getRuleAssociationsCount()

public abstract int getRuleAssociationsCount()

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

int32 rule_associations_count = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The ruleAssociationsCount.

getRules(int index)

public abstract String getRules(int index)

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.

repeated string rules = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The rules at the given index.

getRulesBytes(int index)

public abstract ByteString getRulesBytes(int index)

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.

repeated string rules = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the rules at the given index.

getRulesCount()

public abstract int getRulesCount()

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.

repeated string rules = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of rules.

getRulesList()

public abstract List<String> getRulesList()

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.

repeated string rules = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<String>

A list containing the rules.

getScopeInfo()

public abstract ScopeInfo 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.

.google.cloud.chronicle.v1.ScopeInfo scope_info = 11;

Returns
Type Description
ScopeInfo

The scopeInfo.

getScopeInfoOrBuilder()

public abstract ScopeInfoOrBuilder getScopeInfoOrBuilder()

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.

.google.cloud.chronicle.v1.ScopeInfo scope_info = 11;

Returns
Type Description
ScopeInfoOrBuilder

getSyntaxType()

public abstract ReferenceListSyntaxType getSyntaxType()

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

.google.cloud.chronicle.v1.ReferenceListSyntaxType syntax_type = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ReferenceListSyntaxType

The syntaxType.

getSyntaxTypeValue()

public abstract int getSyntaxTypeValue()

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

.google.cloud.chronicle.v1.ReferenceListSyntaxType syntax_type = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for syntaxType.

hasRevisionCreateTime()

public abstract boolean hasRevisionCreateTime()

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

.google.protobuf.Timestamp revision_create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the revisionCreateTime field is set.

hasScopeInfo()

public abstract boolean hasScopeInfo()

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.

.google.cloud.chronicle.v1.ScopeInfo scope_info = 11;

Returns
Type Description
boolean

Whether the scopeInfo field is set.