Google Cloud Workload Manager V1 Client - Class Evaluation (0.2.0)

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 \ V1

Methods

__construct

Constructor.

Parameter
Name Description
data mixed

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\RepeatedField<string>

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 * * * # 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
Returns
Type Description
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
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