Reference documentation and code samples for the Google Cloud Workload Manager V1 Client class Evaluation.
Represents a Workload Manager Evaluation configuration.
An Evaluation defines a set of rules to be validated against a scope of Cloud resources.
Generated from protobuf message google.cloud.workloadmanager.v1.Evaluation
Namespace
Google \ Cloud \ WorkloadManager \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Name of resource that has the form |
↳ description |
string
Description of the Evaluation. |
↳ resource_filter |
ResourceFilter
Resource filter for an evaluation defining the scope of resources to be evaluated. |
↳ rule_names |
array
The names of the rules used for this evaluation. |
↳ resource_status |
ResourceStatus
Output only. [Output only] The current lifecycle state of the evaluation resource. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. [Output only] Create time stamp. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. [Output only] Update time stamp. |
↳ labels |
array|Google\Protobuf\Internal\MapField
Labels as key value pairs. |
↳ schedule |
string
Crontab format schedule for scheduled evaluation, currently only supports the following fixed schedules: * * |
↳ custom_rules_bucket |
string
The Cloud Storage bucket name for custom rules. |
↳ evaluation_type |
int
Evaluation type. |
↳ big_query_destination |
BigQueryDestination
Optional. The BigQuery destination for detailed evaluation results. If this field is specified, the results of each evaluation execution are exported to BigQuery. |
↳ kms_key |
string
Optional. Immutable. Customer-managed encryption key name, in the format projects//locations//keyRings//cryptoKeys/. The key will be used for CMEK encryption of the evaluation resource. |
getName
Name of resource that has the form
projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Name of resource that has the form
projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Description of the Evaluation.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Description of the Evaluation.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getResourceFilter
Resource filter for an evaluation defining the scope of resources to be evaluated.
| Returns | |
|---|---|
| Type | Description |
ResourceFilter|null |
|
hasResourceFilter
clearResourceFilter
setResourceFilter
Resource filter for an evaluation defining the scope of resources to be evaluated.
| Parameter | |
|---|---|
| Name | Description |
var |
ResourceFilter
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRuleNames
The names of the rules used for this evaluation.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setRuleNames
The names of the rules used for this evaluation.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getResourceStatus
Output only. [Output only] The current lifecycle state of the evaluation resource.
| Returns | |
|---|---|
| Type | Description |
ResourceStatus|null |
|
hasResourceStatus
clearResourceStatus
setResourceStatus
Output only. [Output only] The current lifecycle state of the evaluation resource.
| Parameter | |
|---|---|
| Name | Description |
var |
ResourceStatus
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. [Output only] Create time stamp.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. [Output only] Create time stamp.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. [Output only] Update time stamp.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. [Output only] Update time stamp.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
Labels as key value pairs.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
Labels as key value pairs.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSchedule
Crontab format schedule for scheduled evaluation, currently only supports the following fixed schedules:
0 */1 * * *# Hourly0 */6 * * *# Every 6 hours0 */12 * * *# Every 12 hours0 0 */1 * *# Daily0 0 */7 * *# Weekly0 0 */14 * *# Every 14 days0 0 1 */1 *# Monthly
| Returns | |
|---|---|
| Type | Description |
string |
|
hasSchedule
clearSchedule
setSchedule
Crontab format schedule for scheduled evaluation, currently only supports the following fixed schedules:
0 */1 * * *# Hourly0 */6 * * *# Every 6 hours0 */12 * * *# Every 12 hours0 0 */1 * *# Daily0 0 */7 * *# Weekly0 0 */14 * *# Every 14 days0 0 1 */1 *# Monthly
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCustomRulesBucket
The Cloud Storage bucket name for custom rules.
| Returns | |
|---|---|
| Type | Description |
string |
|
setCustomRulesBucket
The Cloud Storage bucket name for custom rules.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEvaluationType
Evaluation type.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type EvaluationType. |
setEvaluationType
Evaluation type.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type EvaluationType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBigQueryDestination
Optional. The BigQuery destination for detailed evaluation results.
If this field is specified, the results of each evaluation execution are exported to BigQuery.
| Returns | |
|---|---|
| Type | Description |
BigQueryDestination|null |
|
hasBigQueryDestination
clearBigQueryDestination
setBigQueryDestination
Optional. The BigQuery destination for detailed evaluation results.
If this field is specified, the results of each evaluation execution are exported to BigQuery.
| Parameter | |
|---|---|
| Name | Description |
var |
BigQueryDestination
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKmsKey
Optional. Immutable. Customer-managed encryption key name, in the format projects//locations//keyRings//cryptoKeys/.
The key will be used for CMEK encryption of the evaluation resource.
| Returns | |
|---|---|
| Type | Description |
string |
|
setKmsKey
Optional. Immutable. Customer-managed encryption key name, in the format projects//locations//keyRings//cryptoKeys/.
The key will be used for CMEK encryption of the evaluation resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|