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.
data
array
Optional. Data for populating the Message object.
↳ name
string
Name of resource that has the form projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}
.
↳ description
string
Description of the Evaluation.
↳ resource_filter
↳ rule_names
array
The names of the rules used for this evaluation.
↳ resource_status
↳ create_time
↳ update_time
↳ labels
↳ schedule
string
Crontab format schedule for scheduled evaluation, currently only supports the following fixed schedules: * * 0 */1 * * *
# Hourly * * 0 */6 * * *
# Every 6 hours * * 0 */12 * * *
# Every 12 hours * * 0 0 */1 * *
# Daily * * 0 0 */7 * *
# Weekly * * 0 0 */14 * *
# Every 14 days * * 0 0 1 */1 *
# Monthly
↳ 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}
.
string
setName
Name of resource that has the form projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}
.
var
string
$this
getDescription
Description of the Evaluation.
string
setDescription
Description of the Evaluation.
var
string
$this
getResourceFilter
Resource filter for an evaluation defining the scope of resources to be evaluated.
hasResourceFilter
clearResourceFilter
setResourceFilter
Resource filter for an evaluation defining the scope of resources to be evaluated.
$this
getRuleNames
The names of the rules used for this evaluation.
setRuleNames
The names of the rules used for this evaluation.
var
string[]
$this
getResourceStatus
Output only. [Output only] The current lifecycle state of the evaluation resource.
hasResourceStatus
clearResourceStatus
setResourceStatus
Output only. [Output only] The current lifecycle state of the evaluation resource.
$this
getCreateTime
Output only. [Output only] Create time stamp.
hasCreateTime
clearCreateTime
setCreateTime
Output only. [Output only] Create time stamp.
$this
getUpdateTime
Output only. [Output only] Update time stamp.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. [Output only] Update time stamp.
$this
getLabels
Labels as key value pairs.
setLabels
Labels as key value pairs.
$this
getSchedule
Crontab format schedule for scheduled evaluation, currently only supports the following fixed schedules:
-
0 */1 * * *# Hourly -
0 */6 * * *# Every 6 hours -
0 */12 * * *# Every 12 hours -
0 0 */1 * *# Daily -
0 0 */7 * *# Weekly -
0 0 */14 * *# Every 14 days -
0 0 1 */1 *# Monthly
string
hasSchedule
clearSchedule
setSchedule
Crontab format schedule for scheduled evaluation, currently only supports the following fixed schedules:
-
0 */1 * * *# Hourly -
0 */6 * * *# Every 6 hours -
0 */12 * * *# Every 12 hours -
0 0 */1 * *# Daily -
0 0 */7 * *# Weekly -
0 0 */14 * *# Every 14 days -
0 0 1 */1 *# Monthly
var
string
$this
getCustomRulesBucket
The Cloud Storage bucket name for custom rules.
string
setCustomRulesBucket
The Cloud Storage bucket name for custom rules.
var
string
$this
getEvaluationType
Evaluation type.
setEvaluationType
Evaluation type.
$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.
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.
$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.
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.
var
string
$this
