Workload Manager V1 API - Class Google::Cloud::WorkloadManager::V1::Rule (v0.1.0)

Reference documentation and code samples for the Workload Manager V1 API class Google::Cloud::WorkloadManager::V1::Rule.

A rule to be evaluated.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#asset_type

def asset_type() -> ::String
Returns
  • (::String) — The CAI asset type of the rule is evaluating, for joined asset types, it will be the corresponding primary asset types.

#asset_type=

def asset_type=(value) -> ::String
Parameter
  • value (::String) — The CAI asset type of the rule is evaluating, for joined asset types, it will be the corresponding primary asset types.
Returns
  • (::String) — The CAI asset type of the rule is evaluating, for joined asset types, it will be the corresponding primary asset types.

#description

def description() -> ::String
Returns
  • (::String) — Describe rule in plain language.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Describe rule in plain language.
Returns
  • (::String) — Describe rule in plain language.

#display_name

def display_name() -> ::String
Returns
  • (::String) — The name display in UI.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — The name display in UI.
Returns
  • (::String) — The name display in UI.

#error_message

def error_message() -> ::String
Returns
  • (::String) — The message template for rule.

#error_message=

def error_message=(value) -> ::String
Parameter
  • value (::String) — The message template for rule.
Returns
  • (::String) — The message template for rule.

#name

def name() -> ::String
Returns
  • (::String) — Rule name.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Rule name.
Returns
  • (::String) — Rule name.

#primary_category

def primary_category() -> ::String
Returns
  • (::String) — The primary category.

#primary_category=

def primary_category=(value) -> ::String
Parameter
  • value (::String) — The primary category.
Returns
  • (::String) — The primary category.

#remediation

def remediation() -> ::String
Returns
  • (::String) — The remediation for the rule.

#remediation=

def remediation=(value) -> ::String
Parameter
  • value (::String) — The remediation for the rule.
Returns
  • (::String) — The remediation for the rule.

#revision_id

def revision_id() -> ::String
Returns
  • (::String) — Output only. The version of the rule.

#rule_type

def rule_type() -> ::Google::Cloud::WorkloadManager::V1::Rule::RuleType
Returns

#rule_type=

def rule_type=(value) -> ::Google::Cloud::WorkloadManager::V1::Rule::RuleType
Parameter
Returns

#secondary_category

def secondary_category() -> ::String
Returns
  • (::String) — The secondary category.

#secondary_category=

def secondary_category=(value) -> ::String
Parameter
  • value (::String) — The secondary category.
Returns
  • (::String) — The secondary category.

#severity

def severity() -> ::String
Returns
  • (::String) — The severity of the rule.

#severity=

def severity=(value) -> ::String
Parameter
  • value (::String) — The severity of the rule.
Returns
  • (::String) — The severity of the rule.

#tags

def tags() -> ::Array<::String>
Returns
  • (::Array<::String>) — List of user-defined tags.

#tags=

def tags=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — List of user-defined tags.
Returns
  • (::Array<::String>) — List of user-defined tags.

#uri

def uri() -> ::String
Returns
  • (::String) — The document url for the rule.

#uri=

def uri=(value) -> ::String
Parameter
  • value (::String) — The document url for the rule.
Returns
  • (::String) — The document url for the rule.