Class: Google::Cloud::SecurityCenter::V1p1beta1::OrganizationSettings

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/securitycenter/v1p1beta1/organization_settings.rb

Overview

User specified settings that are attached to the Security Command Center organization.

Defined Under Namespace

Classes: AssetDiscoveryConfig

Instance Attribute Summary collapse

Instance Attribute Details

#asset_discovery_config ⇒ ::Google::Cloud::SecurityCenter::V1p1beta1::OrganizationSettings::AssetDiscoveryConfig

Returns The configuration used for Asset Discovery runs.

Returns:



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'proto_docs/google/cloud/securitycenter/v1p1beta1/organization_settings.rb', line 41

class OrganizationSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The configuration used for Asset Discovery runs.
  # @!attribute [rw] project_ids
  #   @return [::Array<::String>]
  #     The project ids to use for filtering asset discovery.
  # @!attribute [rw] inclusion_mode
  #   @return [::Google::Cloud::SecurityCenter::V1p1beta1::OrganizationSettings::AssetDiscoveryConfig::InclusionMode]
  #     The mode to use for filtering asset discovery.
  # @!attribute [rw] folder_ids
  #   @return [::Array<::String>]
  #     The folder ids to use for filtering asset discovery.
  #     It consists of only digits, e.g., 756619654966.
  class AssetDiscoveryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The mode of inclusion when running Asset Discovery.
    # Asset discovery can be limited by explicitly identifying projects to be
    # included or excluded. If INCLUDE_ONLY is set, then only those projects
    # within the organization and their children are discovered during asset
    # discovery. If EXCLUDE is set, then projects that don't match those
    # projects are discovered during asset discovery. If neither are set, then
    # all projects within the organization are discovered during asset
    # discovery.
    module InclusionMode
      # Unspecified. Setting the mode with this value will disable
      # inclusion/exclusion filtering for Asset Discovery.
      INCLUSION_MODE_UNSPECIFIED = 0

      # Asset Discovery will capture only the resources within the projects
      # specified. All other resources will be ignored.
      INCLUDE_ONLY = 1

      # Asset Discovery will ignore all resources under the projects specified.
      # All other resources will be retrieved.
      EXCLUDE = 2
    end
  end
end

#enable_asset_discovery ⇒ ::Boolean

Returns A flag that indicates if Asset Discovery should be enabled. If the flag is set to true, then discovery of assets will occur. If it is set to `false, all historical assets will remain, but discovery of future assets will not occur.

Returns:

  • (::Boolean) —

    A flag that indicates if Asset Discovery should be enabled. If the flag is set to true, then discovery of assets will occur. If it is set to `false, all historical assets will remain, but discovery of future assets will not occur.



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'proto_docs/google/cloud/securitycenter/v1p1beta1/organization_settings.rb', line 41

class OrganizationSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The configuration used for Asset Discovery runs.
  # @!attribute [rw] project_ids
  #   @return [::Array<::String>]
  #     The project ids to use for filtering asset discovery.
  # @!attribute [rw] inclusion_mode
  #   @return [::Google::Cloud::SecurityCenter::V1p1beta1::OrganizationSettings::AssetDiscoveryConfig::InclusionMode]
  #     The mode to use for filtering asset discovery.
  # @!attribute [rw] folder_ids
  #   @return [::Array<::String>]
  #     The folder ids to use for filtering asset discovery.
  #     It consists of only digits, e.g., 756619654966.
  class AssetDiscoveryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The mode of inclusion when running Asset Discovery.
    # Asset discovery can be limited by explicitly identifying projects to be
    # included or excluded. If INCLUDE_ONLY is set, then only those projects
    # within the organization and their children are discovered during asset
    # discovery. If EXCLUDE is set, then projects that don't match those
    # projects are discovered during asset discovery. If neither are set, then
    # all projects within the organization are discovered during asset
    # discovery.
    module InclusionMode
      # Unspecified. Setting the mode with this value will disable
      # inclusion/exclusion filtering for Asset Discovery.
      INCLUSION_MODE_UNSPECIFIED = 0

      # Asset Discovery will capture only the resources within the projects
      # specified. All other resources will be ignored.
      INCLUDE_ONLY = 1

      # Asset Discovery will ignore all resources under the projects specified.
      # All other resources will be retrieved.
      EXCLUDE = 2
    end
  end
end

#name ⇒ ::String

Returns The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: “organizations/{organization_id}/organizationSettings”.

Returns:

  • (::String) —

    The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: “organizations/{organization_id}/organizationSettings”.



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'proto_docs/google/cloud/securitycenter/v1p1beta1/organization_settings.rb', line 41

class OrganizationSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The configuration used for Asset Discovery runs.
  # @!attribute [rw] project_ids
  #   @return [::Array<::String>]
  #     The project ids to use for filtering asset discovery.
  # @!attribute [rw] inclusion_mode
  #   @return [::Google::Cloud::SecurityCenter::V1p1beta1::OrganizationSettings::AssetDiscoveryConfig::InclusionMode]
  #     The mode to use for filtering asset discovery.
  # @!attribute [rw] folder_ids
  #   @return [::Array<::String>]
  #     The folder ids to use for filtering asset discovery.
  #     It consists of only digits, e.g., 756619654966.
  class AssetDiscoveryConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The mode of inclusion when running Asset Discovery.
    # Asset discovery can be limited by explicitly identifying projects to be
    # included or excluded. If INCLUDE_ONLY is set, then only those projects
    # within the organization and their children are discovered during asset
    # discovery. If EXCLUDE is set, then projects that don't match those
    # projects are discovered during asset discovery. If neither are set, then
    # all projects within the organization are discovered during asset
    # discovery.
    module InclusionMode
      # Unspecified. Setting the mode with this value will disable
      # inclusion/exclusion filtering for Asset Discovery.
      INCLUSION_MODE_UNSPECIFIED = 0

      # Asset Discovery will capture only the resources within the projects
      # specified. All other resources will be ignored.
      INCLUDE_ONLY = 1

      # Asset Discovery will ignore all resources under the projects specified.
      # All other resources will be retrieved.
      EXCLUDE = 2
    end
  end
end