Package com.google.cloud.chronicle.v1

Class DataAccessScope

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.chronicle.v1.DataAccessScope
All Implemented Interfaces:
DataAccessScopeOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class DataAccessScope extends com.google.protobuf.GeneratedMessage implements DataAccessScopeOrBuilder
 A DataAccessScope is a boolean expression of data access labels used
 to restrict access to data for users.
Protobuf type google.cloud.chronicle.v1.DataAccessScope
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • ALLOWED_DATA_ACCESS_LABELS_FIELD_NUMBER

      public static final int ALLOWED_DATA_ACCESS_LABELS_FIELD_NUMBER
      See Also:

    • DENIED_DATA_ACCESS_LABELS_FIELD_NUMBER

      public static final int DENIED_DATA_ACCESS_LABELS_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • AUTHOR_FIELD_NUMBER

      public static final int AUTHOR_FIELD_NUMBER
      See Also:

    • LAST_EDITOR_FIELD_NUMBER

      public static final int LAST_EDITOR_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • ALLOW_ALL_FIELD_NUMBER

      public static final int ALLOW_ALL_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()
       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) = { ... }
      Specified by:
      getName in interface DataAccessScopeOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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) = { ... }
      Specified by:
      getNameBytes in interface DataAccessScopeOrBuilder
      Returns:
      The bytes for name.

    • getAllowedDataAccessLabelsList

      public 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];
      Specified by:
      getAllowedDataAccessLabelsList in interface DataAccessScopeOrBuilder

    • getAllowedDataAccessLabelsOrBuilderList

      public 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];
      Specified by:
      getAllowedDataAccessLabelsOrBuilderList in interface DataAccessScopeOrBuilder

    • getAllowedDataAccessLabelsCount

      public 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];
      Specified by:
      getAllowedDataAccessLabelsCount in interface DataAccessScopeOrBuilder

    • getAllowedDataAccessLabels

      public 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];
      Specified by:
      getAllowedDataAccessLabels in interface DataAccessScopeOrBuilder

    • getAllowedDataAccessLabelsOrBuilder

      public 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];
      Specified by:
      getAllowedDataAccessLabelsOrBuilder in interface DataAccessScopeOrBuilder

    • getDeniedDataAccessLabelsList

      public 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];
      Specified by:
      getDeniedDataAccessLabelsList in interface DataAccessScopeOrBuilder

    • getDeniedDataAccessLabelsOrBuilderList

      public 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];
      Specified by:
      getDeniedDataAccessLabelsOrBuilderList in interface DataAccessScopeOrBuilder

    • getDeniedDataAccessLabelsCount

      public 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];
      Specified by:
      getDeniedDataAccessLabelsCount in interface DataAccessScopeOrBuilder

    • getDeniedDataAccessLabels

      public 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];
      Specified by:
      getDeniedDataAccessLabels in interface DataAccessScopeOrBuilder

    • getDeniedDataAccessLabelsOrBuilder

      public 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];
      Specified by:
      getDeniedDataAccessLabelsOrBuilder in interface DataAccessScopeOrBuilder

    • getDisplayName

      public 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];
      Specified by:
      getDisplayName in interface DataAccessScopeOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public 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];
      Specified by:
      getDisplayNameBytes in interface DataAccessScopeOrBuilder
      Returns:
      The bytes for displayName.

    • hasCreateTime

      public 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];
      Specified by:
      hasCreateTime in interface DataAccessScopeOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public 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];
      Specified by:
      getCreateTime in interface DataAccessScopeOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public 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];
      Specified by:
      getCreateTimeOrBuilder in interface DataAccessScopeOrBuilder

    • hasUpdateTime

      public 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];
      Specified by:
      hasUpdateTime in interface DataAccessScopeOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public 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];
      Specified by:
      getUpdateTime in interface DataAccessScopeOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public 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];
      Specified by:
      getUpdateTimeOrBuilder in interface DataAccessScopeOrBuilder

    • getAuthor

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

    • getAuthorBytes

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

    • getLastEditor

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

    • getLastEditorBytes

      public 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];
      Specified by:
      getLastEditorBytes in interface DataAccessScopeOrBuilder
      Returns:
      The bytes for lastEditor.

    • getDescription

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

    • getDescriptionBytes

      public 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];
      Specified by:
      getDescriptionBytes in interface DataAccessScopeOrBuilder
      Returns:
      The bytes for description.

    • getAllowAll

      public 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];
      Specified by:
      getAllowAll in interface DataAccessScopeOrBuilder
      Returns:
      The allowAll.

    • 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 DataAccessScope parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static DataAccessScope.Builder newBuilder()

    • newBuilder

      public static DataAccessScope.Builder newBuilder(DataAccessScope prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static DataAccessScope getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<DataAccessScope> 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 DataAccessScope getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder