Package com.google.cloud.chronicle.v1

Class ReferenceList

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.chronicle.v1.ReferenceList
All Implemented Interfaces:
ReferenceListOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ReferenceList extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • REVISION_CREATE_TIME_FIELD_NUMBER

      public static final int REVISION_CREATE_TIME_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • ENTRIES_FIELD_NUMBER

      public static final int ENTRIES_FIELD_NUMBER
      See Also:

    • RULES_FIELD_NUMBER

      public static final int RULES_FIELD_NUMBER
      See Also:

    • SYNTAX_TYPE_FIELD_NUMBER

      public static final int SYNTAX_TYPE_FIELD_NUMBER
      See Also:

    • RULE_ASSOCIATIONS_COUNT_FIELD_NUMBER

      public static final int RULE_ASSOCIATIONS_COUNT_FIELD_NUMBER
      See Also:

    • SCOPE_INFO_FIELD_NUMBER

      public static final int SCOPE_INFO_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getName

      public 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];
      Specified by:
      getName in interface ReferenceListOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.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];
      Specified by:
      getNameBytes in interface ReferenceListOrBuilder
      Returns:
      The bytes for name.

    • getDisplayName

      public String getDisplayName()
       Output only. The unique display name of the reference list.
      string display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDisplayName in interface ReferenceListOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Output only. The unique display name of the reference list.
      string display_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDisplayNameBytes in interface ReferenceListOrBuilder
      Returns:
      The bytes for displayName.

    • 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];
      Specified by:
      hasRevisionCreateTime in interface ReferenceListOrBuilder
      Returns:
      Whether the revisionCreateTime field is set.

    • getRevisionCreateTime

      public com.google.protobuf.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];
      Specified by:
      getRevisionCreateTime in interface ReferenceListOrBuilder
      Returns:
      The revisionCreateTime.

    • getRevisionCreateTimeOrBuilder

      public com.google.protobuf.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];
      Specified by:
      getRevisionCreateTimeOrBuilder in interface ReferenceListOrBuilder

    • getDescription

      public String getDescription()
       Required. A user-provided description of the reference list.
      string description = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDescription in interface ReferenceListOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Required. A user-provided description of the reference list.
      string description = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDescriptionBytes in interface ReferenceListOrBuilder
      Returns:
      The bytes for description.

    • 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];
      Specified by:
      getEntriesList in interface ReferenceListOrBuilder

    • 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];
      Specified by:
      getEntriesOrBuilderList in interface ReferenceListOrBuilder

    • 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];
      Specified by:
      getEntriesCount in interface ReferenceListOrBuilder

    • getEntries

      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];
      Specified by:
      getEntries in interface ReferenceListOrBuilder

    • getEntriesOrBuilder

      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];
      Specified by:
      getEntriesOrBuilder in interface ReferenceListOrBuilder

    • getRulesList

      public com.google.protobuf.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];
      Specified by:
      getRulesList in interface ReferenceListOrBuilder
      Returns:
      A list containing the rules.

    • 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];
      Specified by:
      getRulesCount in interface ReferenceListOrBuilder
      Returns:
      The count of rules.

    • getRules

      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];
      Specified by:
      getRules in interface ReferenceListOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The rules at the given index.

    • getRulesBytes

      public com.google.protobuf.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];
      Specified by:
      getRulesBytes in interface ReferenceListOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the rules at the given index.

    • 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];
      Specified by:
      getSyntaxTypeValue in interface ReferenceListOrBuilder
      Returns:
      The enum numeric value on the wire for syntaxType.

    • 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];
      Specified by:
      getSyntaxType in interface ReferenceListOrBuilder
      Returns:
      The syntaxType.

    • 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];
      Specified by:
      getRuleAssociationsCount in interface ReferenceListOrBuilder
      Returns:
      The ruleAssociationsCount.

    • 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;
      Specified by:
      hasScopeInfo in interface ReferenceListOrBuilder
      Returns:
      Whether the scopeInfo field is set.

    • 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;
      Specified by:
      getScopeInfo in interface ReferenceListOrBuilder
      Returns:
      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;
      Specified by:
      getScopeInfoOrBuilder in interface ReferenceListOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ReferenceList parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ReferenceList parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ReferenceList parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ReferenceList parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ReferenceList parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ReferenceList parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ReferenceList parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ReferenceList parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ReferenceList parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ReferenceList parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ReferenceList parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ReferenceList parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ReferenceList.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ReferenceList.Builder newBuilder()

    • newBuilder

      public static ReferenceList.Builder newBuilder(ReferenceList prototype)

    • toBuilder

      public ReferenceList.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ReferenceList.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ReferenceList getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ReferenceList> parser()

    • getParserForType

      public com.google.protobuf.Parser<ReferenceList> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public ReferenceList getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder