Package com.google.cloud.chronicle.v1

Interface DataAccessScopeOrBuilder

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

  • Method Details

    • getName

      String getName()
       Required. The unique full name of the data access scope.
 The name should comply with https://google.aip.dev/122 standards.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Required. The unique full name of the data access scope.
 The name should comply with https://google.aip.dev/122 standards.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for name.

    • getAllowedDataAccessLabelsList

      List<DataAccessLabelReference> getAllowedDataAccessLabelsList()
       Optional. The allowed labels for the scope.
 Either allow_all or allowed_data_access_labels needs to be provided.
 When provided, there has to be at least one label allowed for the scope to
 be valid.
 The logical operator for evaluation of the allowed labels is OR.
 E.g.: A customer with scope with allowed labels A and B will be able
 to see data with labeled with A or B or (A and B).
      repeated .google.cloud.chronicle.v1.DataAccessLabelReference allowed_data_access_labels = 2 [(.google.api.field_behavior) = OPTIONAL];

    • getAllowedDataAccessLabels

      DataAccessLabelReference getAllowedDataAccessLabels(int index)
       Optional. The allowed labels for the scope.
 Either allow_all or allowed_data_access_labels needs to be provided.
 When provided, there has to be at least one label allowed for the scope to
 be valid.
 The logical operator for evaluation of the allowed labels is OR.
 E.g.: A customer with scope with allowed labels A and B will be able
 to see data with labeled with A or B or (A and B).
      repeated .google.cloud.chronicle.v1.DataAccessLabelReference allowed_data_access_labels = 2 [(.google.api.field_behavior) = OPTIONAL];

    • getAllowedDataAccessLabelsCount

      int getAllowedDataAccessLabelsCount()
       Optional. The allowed labels for the scope.
 Either allow_all or allowed_data_access_labels needs to be provided.
 When provided, there has to be at least one label allowed for the scope to
 be valid.
 The logical operator for evaluation of the allowed labels is OR.
 E.g.: A customer with scope with allowed labels A and B will be able
 to see data with labeled with A or B or (A and B).
      repeated .google.cloud.chronicle.v1.DataAccessLabelReference allowed_data_access_labels = 2 [(.google.api.field_behavior) = OPTIONAL];

    • getAllowedDataAccessLabelsOrBuilderList

      List<? extends DataAccessLabelReferenceOrBuilder> getAllowedDataAccessLabelsOrBuilderList()
       Optional. The allowed labels for the scope.
 Either allow_all or allowed_data_access_labels needs to be provided.
 When provided, there has to be at least one label allowed for the scope to
 be valid.
 The logical operator for evaluation of the allowed labels is OR.
 E.g.: A customer with scope with allowed labels A and B will be able
 to see data with labeled with A or B or (A and B).
      repeated .google.cloud.chronicle.v1.DataAccessLabelReference allowed_data_access_labels = 2 [(.google.api.field_behavior) = OPTIONAL];

    • getAllowedDataAccessLabelsOrBuilder

      DataAccessLabelReferenceOrBuilder getAllowedDataAccessLabelsOrBuilder(int index)
       Optional. The allowed labels for the scope.
 Either allow_all or allowed_data_access_labels needs to be provided.
 When provided, there has to be at least one label allowed for the scope to
 be valid.
 The logical operator for evaluation of the allowed labels is OR.
 E.g.: A customer with scope with allowed labels A and B will be able
 to see data with labeled with A or B or (A and B).
      repeated .google.cloud.chronicle.v1.DataAccessLabelReference allowed_data_access_labels = 2 [(.google.api.field_behavior) = OPTIONAL];

    • getDeniedDataAccessLabelsList

      List<DataAccessLabelReference> getDeniedDataAccessLabelsList()
       Optional. The denied labels for the scope.
 The logical operator for evaluation of the denied labels is AND.
 E.g.: A customer with scope with denied labels A and B won't be able
 to see data labeled with A and data labeled with B
 and data with labels A and B.
      repeated .google.cloud.chronicle.v1.DataAccessLabelReference denied_data_access_labels = 3 [(.google.api.field_behavior) = OPTIONAL];

    • getDeniedDataAccessLabels

      DataAccessLabelReference getDeniedDataAccessLabels(int index)
       Optional. The denied labels for the scope.
 The logical operator for evaluation of the denied labels is AND.
 E.g.: A customer with scope with denied labels A and B won't be able
 to see data labeled with A and data labeled with B
 and data with labels A and B.
      repeated .google.cloud.chronicle.v1.DataAccessLabelReference denied_data_access_labels = 3 [(.google.api.field_behavior) = OPTIONAL];

    • getDeniedDataAccessLabelsCount

      int getDeniedDataAccessLabelsCount()
       Optional. The denied labels for the scope.
 The logical operator for evaluation of the denied labels is AND.
 E.g.: A customer with scope with denied labels A and B won't be able
 to see data labeled with A and data labeled with B
 and data with labels A and B.
      repeated .google.cloud.chronicle.v1.DataAccessLabelReference denied_data_access_labels = 3 [(.google.api.field_behavior) = OPTIONAL];

    • getDeniedDataAccessLabelsOrBuilderList

      List<? extends DataAccessLabelReferenceOrBuilder> getDeniedDataAccessLabelsOrBuilderList()
       Optional. The denied labels for the scope.
 The logical operator for evaluation of the denied labels is AND.
 E.g.: A customer with scope with denied labels A and B won't be able
 to see data labeled with A and data labeled with B
 and data with labels A and B.
      repeated .google.cloud.chronicle.v1.DataAccessLabelReference denied_data_access_labels = 3 [(.google.api.field_behavior) = OPTIONAL];

    • getDeniedDataAccessLabelsOrBuilder

      DataAccessLabelReferenceOrBuilder getDeniedDataAccessLabelsOrBuilder(int index)
       Optional. The denied labels for the scope.
 The logical operator for evaluation of the denied labels is AND.
 E.g.: A customer with scope with denied labels A and B won't be able
 to see data labeled with A and data labeled with B
 and data with labels A and B.
      repeated .google.cloud.chronicle.v1.DataAccessLabelReference denied_data_access_labels = 3 [(.google.api.field_behavior) = OPTIONAL];

    • getDisplayName

      String getDisplayName()
       Output only. The name to be used for display to customers of the data
 access scope.
      string display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       Output only. The name to be used for display to customers of the data
 access scope.
      string display_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for displayName.

    • hasCreateTime

      boolean hasCreateTime()
       Output only. The time at which the data access scope was created.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Output only. The time at which the data access scope was created.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The time at which the data access scope was created.
      .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasUpdateTime

      boolean hasUpdateTime()
       Output only. The time at which the data access scope was last updated.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      com.google.protobuf.Timestamp getUpdateTime()
       Output only. The time at which the data access scope was last updated.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. The time at which the data access scope was last updated.
      .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getAuthor

      String getAuthor()
       Output only. The user who created the data access scope.
      string author = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The author.

    • getAuthorBytes

      com.google.protobuf.ByteString getAuthorBytes()
       Output only. The user who created the data access scope.
      string author = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for author.

    • getLastEditor

      String getLastEditor()
       Output only. The user who last updated the data access scope.
      string last_editor = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The lastEditor.

    • getLastEditorBytes

      com.google.protobuf.ByteString getLastEditorBytes()
       Output only. The user who last updated the data access scope.
      string last_editor = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for lastEditor.

    • getDescription

      String getDescription()
       Optional. A description of the data access scope for a human reader.
      string description = 9 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Optional. A description of the data access scope for a human reader.
      string description = 9 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for description.

    • getAllowAll

      boolean getAllowAll()
       Optional. Whether or not the scope allows all labels, allow_all and
 allowed_data_access_labels are mutually exclusive and one of them must be
 present. denied_data_access_labels can still be used along with allow_all.
 When combined with denied_data_access_labels, access will be granted to all
 data that doesn't have labels mentioned in denied_data_access_labels. E.g.:
 A customer with scope with denied labels A and B and allow_all will be able
 to see all data except data labeled with A and data labeled with B and data
 with labels A and B.
      bool allow_all = 10 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The allowAll.