Reference documentation and code samples for the Google Cloud Workload Manager V1 Client class Rule.
A rule to be evaluated.
Generated from protobuf message google.cloud.workloadmanager.v1.Rule
Namespace
Google \ Cloud \ WorkloadManager \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Rule name. |
↳ revision_id |
string
Output only. The version of the rule. |
↳ display_name |
string
The name display in UI. |
↳ description |
string
Describe rule in plain language. |
↳ severity |
string
The severity of the rule. |
↳ primary_category |
string
The primary category. |
↳ secondary_category |
string
The secondary category. |
↳ error_message |
string
The message template for rule. |
↳ uri |
string
The document url for the rule. |
↳ remediation |
string
The remediation for the rule. |
↳ tags |
array
List of user-defined tags. |
↳ rule_type |
int
The type of the rule. |
↳ asset_type |
string
The CAI asset type of the rule is evaluating, for joined asset types, it will be the corresponding primary asset types. |
getName
Rule name.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Rule name.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRevisionId
Output only. The version of the rule.
| Returns | |
|---|---|
| Type | Description |
string |
|
setRevisionId
Output only. The version of the rule.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
The name display in UI.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
The name display in UI.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Describe rule in plain language.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Describe rule in plain language.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSeverity
The severity of the rule.
| Returns | |
|---|---|
| Type | Description |
string |
|
setSeverity
The severity of the rule.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPrimaryCategory
The primary category.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPrimaryCategory
The primary category.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSecondaryCategory
The secondary category.
| Returns | |
|---|---|
| Type | Description |
string |
|
setSecondaryCategory
The secondary category.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getErrorMessage
The message template for rule.
| Returns | |
|---|---|
| Type | Description |
string |
|
setErrorMessage
The message template for rule.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUri
The document url for the rule.
| Returns | |
|---|---|
| Type | Description |
string |
|
setUri
The document url for the rule.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRemediation
The remediation for the rule.
| Returns | |
|---|---|
| Type | Description |
string |
|
setRemediation
The remediation for the rule.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTags
List of user-defined tags.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setTags
List of user-defined tags.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRuleType
The type of the rule.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type RuleType. |
setRuleType
The type of the rule.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type RuleType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAssetType
The CAI asset type of the rule is evaluating, for joined asset types, it will be the corresponding primary asset types.
| Returns | |
|---|---|
| Type | Description |
string |
|
setAssetType
The CAI asset type of the rule is evaluating, for joined asset types, it will be the corresponding primary asset types.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|