Chronicle V1 API - Class Google::Cloud::Chronicle::V1::DataAccessScope (v0.1.0)

Reference documentation and code samples for the Chronicle V1 API class Google::Cloud::Chronicle::V1::DataAccessScope.

A DataAccessScope is a boolean expression of data access labels used to restrict access to data for users.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#allow_all

def allow_all() -> ::Boolean
Returns
  • (::Boolean) — 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.

#allow_all=

def allow_all=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.
Returns
  • (::Boolean) — 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.

#allowed_data_access_labels

def allowed_data_access_labels() -> ::Array<::Google::Cloud::Chronicle::V1::DataAccessLabelReference>
Returns
  • (::Array<::Google::Cloud::Chronicle::V1::DataAccessLabelReference>) — 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).

#allowed_data_access_labels=

def allowed_data_access_labels=(value) -> ::Array<::Google::Cloud::Chronicle::V1::DataAccessLabelReference>
Parameter
  • value (::Array<::Google::Cloud::Chronicle::V1::DataAccessLabelReference>) — 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).
Returns
  • (::Array<::Google::Cloud::Chronicle::V1::DataAccessLabelReference>) — 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).

#author

def author() -> ::String
Returns
  • (::String) — Output only. The user who created the data access scope.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#denied_data_access_labels

def denied_data_access_labels() -> ::Array<::Google::Cloud::Chronicle::V1::DataAccessLabelReference>
Returns
  • (::Array<::Google::Cloud::Chronicle::V1::DataAccessLabelReference>) — 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.

#denied_data_access_labels=

def denied_data_access_labels=(value) -> ::Array<::Google::Cloud::Chronicle::V1::DataAccessLabelReference>
Parameter
  • value (::Array<::Google::Cloud::Chronicle::V1::DataAccessLabelReference>) — 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.
Returns
  • (::Array<::Google::Cloud::Chronicle::V1::DataAccessLabelReference>) — 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.

#description

def description() -> ::String
Returns
  • (::String) — Optional. A description of the data access scope for a human reader.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. A description of the data access scope for a human reader.
Returns
  • (::String) — Optional. A description of the data access scope for a human reader.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Output only. The name to be used for display to customers of the data access scope.

#last_editor

def last_editor() -> ::String
Returns
  • (::String) — Output only. The user who last updated the data access scope.

#name

def name() -> ::String
Returns
  • (::String) — Required. The unique full name of the data access scope. The name should comply with https://google.aip.dev/122 standards.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Required. The unique full name of the data access scope. The name should comply with https://google.aip.dev/122 standards.
Returns
  • (::String) — Required. The unique full name of the data access scope. The name should comply with https://google.aip.dev/122 standards.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns