Class: Google::Cloud::Asset::V1::AnalyzerOrgPolicyConstraint::Constraint

Inherits:

Object

• Object
• Google::Cloud::Asset::V1::AnalyzerOrgPolicyConstraint::Constraint

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/asset/v1/asset_service.rb

Overview

The definition of a constraint.

Defined Under Namespace

Modules: ConstraintDefault Classes: BooleanConstraint, ListConstraint

Instance Attribute Summary

• #boolean_constraint ⇒ ::Google::Cloud::Asset::V1::AnalyzerOrgPolicyConstraint::Constraint::BooleanConstraint

  Defines this constraint as being a BooleanConstraint.

• #constraint_default ⇒ ::Google::Cloud::Asset::V1::AnalyzerOrgPolicyConstraint::Constraint::ConstraintDefault

  The evaluation behavior of this constraint in the absence of 'Policy'.

• #description ⇒ ::String

  Detailed description of what this Constraint controls as well as how and where it is enforced.

• #display_name ⇒ ::String

  The human readable name of the constraint.

• #list_constraint ⇒ ::Google::Cloud::Asset::V1::AnalyzerOrgPolicyConstraint::Constraint::ListConstraint

  Defines this constraint as being a ListConstraint.

• #name ⇒ ::String

  The unique name of the constraint.

Instance Attribute Details

#boolean_constraint ⇒ ::Google::Cloud::Asset::V1::AnalyzerOrgPolicyConstraint::Constraint::BooleanConstraint

Returns Defines this constraint as being a BooleanConstraint.

Note: The following fields are mutually exclusive: boolean_constraint, list_constraint. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

• (::Google::Cloud::Asset::V1::AnalyzerOrgPolicyConstraint::Constraint::BooleanConstraint) —

  Defines this constraint as being a BooleanConstraint.

  Note: The following fields are mutually exclusive: boolean_constraint, list_constraint. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 2095

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

  # A `Constraint` that allows or disallows a list of string values, which
  # are configured by an organization's policy administrator with a `Policy`.
  # @!attribute [rw] supports_in
  #   @return [::Boolean]
  #     Indicates whether values grouped into categories can be used in
  #     `Policy.allowed_values` and `Policy.denied_values`. For example,
  #     `"in:Python"` would match any value in the 'Python' group.
  # @!attribute [rw] supports_under
  #   @return [::Boolean]
  #     Indicates whether subtrees of Cloud Resource Manager resource hierarchy
  #     can be used in `Policy.allowed_values` and `Policy.denied_values`. For
  #     example, `"under:folders/123"` would match any resource under the
  #     'folders/123' folder.
  class ListConstraint
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A `Constraint` that is either enforced or not.
  #
  # For example a constraint `constraints/compute.disableSerialPortAccess`.
  # If it is enforced on a VM instance, serial port connections will not be
  # opened to that instance.
  class BooleanConstraint
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the default behavior in the absence of any `Policy` for the
  # `Constraint`. This must not be `CONSTRAINT_DEFAULT_UNSPECIFIED`.
  module ConstraintDefault
    # This is only used for distinguishing unset values and should never be
    # used.
    CONSTRAINT_DEFAULT_UNSPECIFIED = 0

    # Indicate that all values are allowed for list constraints.
    # Indicate that enforcement is off for boolean constraints.
    ALLOW = 1

    # Indicate that all values are denied for list constraints.
    # Indicate that enforcement is on for boolean constraints.
    DENY = 2
  end
end

#constraint_default ⇒ ::Google::Cloud::Asset::V1::AnalyzerOrgPolicyConstraint::Constraint::ConstraintDefault

Returns The evaluation behavior of this constraint in the absence of 'Policy'.

Returns:

• (::Google::Cloud::Asset::V1::AnalyzerOrgPolicyConstraint::Constraint::ConstraintDefault) —

  The evaluation behavior of this constraint in the absence of 'Policy'.

# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 2095

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

  # A `Constraint` that allows or disallows a list of string values, which
  # are configured by an organization's policy administrator with a `Policy`.
  # @!attribute [rw] supports_in
  #   @return [::Boolean]
  #     Indicates whether values grouped into categories can be used in
  #     `Policy.allowed_values` and `Policy.denied_values`. For example,
  #     `"in:Python"` would match any value in the 'Python' group.
  # @!attribute [rw] supports_under
  #   @return [::Boolean]
  #     Indicates whether subtrees of Cloud Resource Manager resource hierarchy
  #     can be used in `Policy.allowed_values` and `Policy.denied_values`. For
  #     example, `"under:folders/123"` would match any resource under the
  #     'folders/123' folder.
  class ListConstraint
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A `Constraint` that is either enforced or not.
  #
  # For example a constraint `constraints/compute.disableSerialPortAccess`.
  # If it is enforced on a VM instance, serial port connections will not be
  # opened to that instance.
  class BooleanConstraint
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the default behavior in the absence of any `Policy` for the
  # `Constraint`. This must not be `CONSTRAINT_DEFAULT_UNSPECIFIED`.
  module ConstraintDefault
    # This is only used for distinguishing unset values and should never be
    # used.
    CONSTRAINT_DEFAULT_UNSPECIFIED = 0

    # Indicate that all values are allowed for list constraints.
    # Indicate that enforcement is off for boolean constraints.
    ALLOW = 1

    # Indicate that all values are denied for list constraints.
    # Indicate that enforcement is on for boolean constraints.
    DENY = 2
  end
end

#description ⇒ ::String

Returns Detailed description of what this Constraint controls as well as how and where it is enforced.

Returns:

• (::String) —

  Detailed description of what this Constraint controls as well as how and where it is enforced.

# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 2095

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

  # A `Constraint` that allows or disallows a list of string values, which
  # are configured by an organization's policy administrator with a `Policy`.
  # @!attribute [rw] supports_in
  #   @return [::Boolean]
  #     Indicates whether values grouped into categories can be used in
  #     `Policy.allowed_values` and `Policy.denied_values`. For example,
  #     `"in:Python"` would match any value in the 'Python' group.
  # @!attribute [rw] supports_under
  #   @return [::Boolean]
  #     Indicates whether subtrees of Cloud Resource Manager resource hierarchy
  #     can be used in `Policy.allowed_values` and `Policy.denied_values`. For
  #     example, `"under:folders/123"` would match any resource under the
  #     'folders/123' folder.
  class ListConstraint
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A `Constraint` that is either enforced or not.
  #
  # For example a constraint `constraints/compute.disableSerialPortAccess`.
  # If it is enforced on a VM instance, serial port connections will not be
  # opened to that instance.
  class BooleanConstraint
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the default behavior in the absence of any `Policy` for the
  # `Constraint`. This must not be `CONSTRAINT_DEFAULT_UNSPECIFIED`.
  module ConstraintDefault
    # This is only used for distinguishing unset values and should never be
    # used.
    CONSTRAINT_DEFAULT_UNSPECIFIED = 0

    # Indicate that all values are allowed for list constraints.
    # Indicate that enforcement is off for boolean constraints.
    ALLOW = 1

    # Indicate that all values are denied for list constraints.
    # Indicate that enforcement is on for boolean constraints.
    DENY = 2
  end
end

#display_name ⇒ ::String

Returns The human readable name of the constraint.

Returns:

• (::String) —

  The human readable name of the constraint.

# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 2095

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

  # A `Constraint` that allows or disallows a list of string values, which
  # are configured by an organization's policy administrator with a `Policy`.
  # @!attribute [rw] supports_in
  #   @return [::Boolean]
  #     Indicates whether values grouped into categories can be used in
  #     `Policy.allowed_values` and `Policy.denied_values`. For example,
  #     `"in:Python"` would match any value in the 'Python' group.
  # @!attribute [rw] supports_under
  #   @return [::Boolean]
  #     Indicates whether subtrees of Cloud Resource Manager resource hierarchy
  #     can be used in `Policy.allowed_values` and `Policy.denied_values`. For
  #     example, `"under:folders/123"` would match any resource under the
  #     'folders/123' folder.
  class ListConstraint
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A `Constraint` that is either enforced or not.
  #
  # For example a constraint `constraints/compute.disableSerialPortAccess`.
  # If it is enforced on a VM instance, serial port connections will not be
  # opened to that instance.
  class BooleanConstraint
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the default behavior in the absence of any `Policy` for the
  # `Constraint`. This must not be `CONSTRAINT_DEFAULT_UNSPECIFIED`.
  module ConstraintDefault
    # This is only used for distinguishing unset values and should never be
    # used.
    CONSTRAINT_DEFAULT_UNSPECIFIED = 0

    # Indicate that all values are allowed for list constraints.
    # Indicate that enforcement is off for boolean constraints.
    ALLOW = 1

    # Indicate that all values are denied for list constraints.
    # Indicate that enforcement is on for boolean constraints.
    DENY = 2
  end
end

#list_constraint ⇒ ::Google::Cloud::Asset::V1::AnalyzerOrgPolicyConstraint::Constraint::ListConstraint

Returns Defines this constraint as being a ListConstraint.

Note: The following fields are mutually exclusive: list_constraint, boolean_constraint. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

• (::Google::Cloud::Asset::V1::AnalyzerOrgPolicyConstraint::Constraint::ListConstraint) —

  Defines this constraint as being a ListConstraint.

  Note: The following fields are mutually exclusive: list_constraint, boolean_constraint. If a field in that set is populated, all other fields in the set will automatically be cleared.

# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 2095

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

  # A `Constraint` that allows or disallows a list of string values, which
  # are configured by an organization's policy administrator with a `Policy`.
  # @!attribute [rw] supports_in
  #   @return [::Boolean]
  #     Indicates whether values grouped into categories can be used in
  #     `Policy.allowed_values` and `Policy.denied_values`. For example,
  #     `"in:Python"` would match any value in the 'Python' group.
  # @!attribute [rw] supports_under
  #   @return [::Boolean]
  #     Indicates whether subtrees of Cloud Resource Manager resource hierarchy
  #     can be used in `Policy.allowed_values` and `Policy.denied_values`. For
  #     example, `"under:folders/123"` would match any resource under the
  #     'folders/123' folder.
  class ListConstraint
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A `Constraint` that is either enforced or not.
  #
  # For example a constraint `constraints/compute.disableSerialPortAccess`.
  # If it is enforced on a VM instance, serial port connections will not be
  # opened to that instance.
  class BooleanConstraint
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the default behavior in the absence of any `Policy` for the
  # `Constraint`. This must not be `CONSTRAINT_DEFAULT_UNSPECIFIED`.
  module ConstraintDefault
    # This is only used for distinguishing unset values and should never be
    # used.
    CONSTRAINT_DEFAULT_UNSPECIFIED = 0

    # Indicate that all values are allowed for list constraints.
    # Indicate that enforcement is off for boolean constraints.
    ALLOW = 1

    # Indicate that all values are denied for list constraints.
    # Indicate that enforcement is on for boolean constraints.
    DENY = 2
  end
end

#name ⇒ ::String

Returns The unique name of the constraint. Format of the name should be

• constraints/{constraint_name}

For example, constraints/compute.disableSerialPortAccess.

Returns:

• (::String) —

  The unique name of the constraint. Format of the name should be

  • constraints/{constraint_name}

  For example, constraints/compute.disableSerialPortAccess.

# File 'proto_docs/google/cloud/asset/v1/asset_service.rb', line 2095

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

  # A `Constraint` that allows or disallows a list of string values, which
  # are configured by an organization's policy administrator with a `Policy`.
  # @!attribute [rw] supports_in
  #   @return [::Boolean]
  #     Indicates whether values grouped into categories can be used in
  #     `Policy.allowed_values` and `Policy.denied_values`. For example,
  #     `"in:Python"` would match any value in the 'Python' group.
  # @!attribute [rw] supports_under
  #   @return [::Boolean]
  #     Indicates whether subtrees of Cloud Resource Manager resource hierarchy
  #     can be used in `Policy.allowed_values` and `Policy.denied_values`. For
  #     example, `"under:folders/123"` would match any resource under the
  #     'folders/123' folder.
  class ListConstraint
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A `Constraint` that is either enforced or not.
  #
  # For example a constraint `constraints/compute.disableSerialPortAccess`.
  # If it is enforced on a VM instance, serial port connections will not be
  # opened to that instance.
  class BooleanConstraint
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specifies the default behavior in the absence of any `Policy` for the
  # `Constraint`. This must not be `CONSTRAINT_DEFAULT_UNSPECIFIED`.
  module ConstraintDefault
    # This is only used for distinguishing unset values and should never be
    # used.
    CONSTRAINT_DEFAULT_UNSPECIFIED = 0

    # Indicate that all values are allowed for list constraints.
    # Indicate that enforcement is off for boolean constraints.
    ALLOW = 1

    # Indicate that all values are denied for list constraints.
    # Indicate that enforcement is on for boolean constraints.
    DENY = 2
  end
end