public final class ReferenceList extends GeneratedMessageV3 implements ReferenceListOrBuilder
A reference list.
Reference lists are user-defined lists of values which users can
use in multiple Rules.
Protobuf type google.cloud.chronicle.v1.ReferenceList
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ENTRIES_FIELD_NUMBER
public static final int ENTRIES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REVISION_CREATE_TIME_FIELD_NUMBER
public static final int REVISION_CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RULES_FIELD_NUMBER
public static final int RULES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RULE_ASSOCIATIONS_COUNT_FIELD_NUMBER
public static final int RULE_ASSOCIATIONS_COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SCOPE_INFO_FIELD_NUMBER
public static final int SCOPE_INFO_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SYNTAX_TYPE_FIELD_NUMBER
public static final int SYNTAX_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static ReferenceList getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ReferenceList.Builder newBuilder()
newBuilder(ReferenceList prototype)
public static ReferenceList.Builder newBuilder(ReferenceList prototype)
public static ReferenceList parseDelimitedFrom(InputStream input)
public static ReferenceList parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ReferenceList parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ReferenceList parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ReferenceList parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ReferenceList parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ReferenceList parseFrom(CodedInputStream input)
public static ReferenceList parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ReferenceList parseFrom(InputStream input)
public static ReferenceList parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ReferenceList parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ReferenceList parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ReferenceList> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public ReferenceList getDefaultInstanceForType()
getDescription()
public 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 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 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 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 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
|
getEntriesCount()
public 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 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];
getEntriesOrBuilder(int index)
public 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
|
getEntriesOrBuilderList()
public 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()
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 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.
|
getParserForType()
public Parser<ReferenceList> getParserForType()
Overrides
getRevisionCreateTime()
public 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 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];
getRuleAssociationsCount()
public 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 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 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 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 ProtocolStringList 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];
getScopeInfo()
public 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 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;
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getSyntaxType()
public 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];
getSyntaxTypeValue()
public 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 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 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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ReferenceList.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ReferenceList.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public ReferenceList.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
