Package com.google.cloud.chronicle.v1

Interface ReferenceListOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ReferenceList, ReferenceList.Builder
@Generated public interface ReferenceListOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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:
      The name.

    • getNameBytes

      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];
      Returns:
      The bytes for name.

    • getDisplayName

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

    • getDisplayNameBytes

      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];
      Returns:
      The bytes for displayName.

    • hasRevisionCreateTime

      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:
      Whether the revisionCreateTime field is set.

    • getRevisionCreateTime

      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];
      Returns:
      The revisionCreateTime.

    • getRevisionCreateTimeOrBuilder

      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];

    • getDescription

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

    • getDescriptionBytes

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

    • getEntriesList

      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];

    • getEntries

      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];

    • getEntriesCount

      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];

    • getEntriesOrBuilderList

      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];

    • getEntriesOrBuilder

      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];

    • getRulesList

      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:
      A list containing the rules.

    • getRulesCount

      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:
      The count of rules.

    • getRules

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

    • getRulesBytes

      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];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the rules at the given index.

    • getSyntaxTypeValue

      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:
      The enum numeric value on the wire for syntaxType.

    • getSyntaxType

      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:
      The syntaxType.

    • getRuleAssociationsCount

      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:
      The ruleAssociationsCount.

    • hasScopeInfo

      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:
      Whether the scopeInfo field is set.

    • getScopeInfo

      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:
      The scopeInfo.

    • getScopeInfoOrBuilder

      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;