Class Evaluation (0.1.0)

public final class Evaluation extends GeneratedMessage implements EvaluationOrBuilder

Represents a Workload Manager Evaluation configuration. An Evaluation defines a set of rules to be validated against a scope of Cloud resources.

Protobuf type google.cloud.workloadmanager.v1.Evaluation

Implements

EvaluationOrBuilder

Static Fields

BIG_QUERY_DESTINATION_FIELD_NUMBER

public static final int BIG_QUERY_DESTINATION_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

CUSTOM_RULES_BUCKET_FIELD_NUMBER

public static final int CUSTOM_RULES_BUCKET_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

EVALUATION_TYPE_FIELD_NUMBER

public static final int EVALUATION_TYPE_FIELD_NUMBER
Field Value
Type Description
int

KMS_KEY_FIELD_NUMBER

public static final int KMS_KEY_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_FILTER_FIELD_NUMBER

public static final int RESOURCE_FILTER_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_STATUS_FIELD_NUMBER

public static final int RESOURCE_STATUS_FIELD_NUMBER
Field Value
Type Description
int

RULE_NAMES_FIELD_NUMBER

public static final int RULE_NAMES_FIELD_NUMBER
Field Value
Type Description
int

SCHEDULE_FIELD_NUMBER

public static final int SCHEDULE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Evaluation getDefaultInstance()
Returns
Type Description
Evaluation

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Evaluation.Builder newBuilder()
Returns
Type Description
Evaluation.Builder

newBuilder(Evaluation prototype)

public static Evaluation.Builder newBuilder(Evaluation prototype)
Parameter
Name Description
prototype Evaluation
Returns
Type Description
Evaluation.Builder

parseDelimitedFrom(InputStream input)

public static Evaluation parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Evaluation
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Evaluation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Evaluation
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Evaluation parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Evaluation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Evaluation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Evaluation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Evaluation parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Evaluation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Evaluation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Evaluation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Evaluation parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Evaluation
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Evaluation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Evaluation
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Evaluation parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Evaluation
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Evaluation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Evaluation
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Evaluation parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Evaluation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Evaluation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Evaluation
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Evaluation> parser()
Returns
Type Description
Parser<Evaluation>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Labels as key value pairs.

map<string, string> labels = 9;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBigQueryDestination()

public BigQueryDestination getBigQueryDestination()

Optional. The BigQuery destination for detailed evaluation results. If this field is specified, the results of each evaluation execution are exported to BigQuery.

.google.cloud.workloadmanager.v1.BigQueryDestination big_query_destination = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BigQueryDestination

The bigQueryDestination.

getBigQueryDestinationOrBuilder()

public BigQueryDestinationOrBuilder getBigQueryDestinationOrBuilder()

Optional. The BigQuery destination for detailed evaluation results. If this field is specified, the results of each evaluation execution are exported to BigQuery.

.google.cloud.workloadmanager.v1.BigQueryDestination big_query_destination = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BigQueryDestinationOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. [Output only] Create time stamp.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. [Output only] Create time stamp.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getCustomRulesBucket()

public String getCustomRulesBucket()

The Cloud Storage bucket name for custom rules.

string custom_rules_bucket = 11;

Returns
Type Description
String

The customRulesBucket.

getCustomRulesBucketBytes()

public ByteString getCustomRulesBucketBytes()

The Cloud Storage bucket name for custom rules.

string custom_rules_bucket = 11;

Returns
Type Description
ByteString

The bytes for customRulesBucket.

getDefaultInstanceForType()

public Evaluation getDefaultInstanceForType()
Returns
Type Description
Evaluation

getDescription()

public String getDescription()

Description of the Evaluation.

string description = 2;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Description of the Evaluation.

string description = 2;

Returns
Type Description
ByteString

The bytes for description.

getEvaluationType()

public Evaluation.EvaluationType getEvaluationType()

Evaluation type.

.google.cloud.workloadmanager.v1.Evaluation.EvaluationType evaluation_type = 12;

Returns
Type Description
Evaluation.EvaluationType

The evaluationType.

getEvaluationTypeValue()

public int getEvaluationTypeValue()

Evaluation type.

.google.cloud.workloadmanager.v1.Evaluation.EvaluationType evaluation_type = 12;

Returns
Type Description
int

The enum numeric value on the wire for evaluationType.

getKmsKey()

public String 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 kms_key = 15 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The kmsKey.

getKmsKeyBytes()

public ByteString getKmsKeyBytes()

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 kms_key = 15 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for kmsKey.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels as key value pairs.

map<string, string> labels = 9;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels as key value pairs.

map<string, string> labels = 9;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels as key value pairs.

map<string, string> labels = 9;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels as key value pairs.

map<string, string> labels = 9;

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public String getName()

Name of resource that has the form projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Name of resource that has the form projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Evaluation> getParserForType()
Returns
Type Description
Parser<Evaluation>
Overrides

getResourceFilter()

public ResourceFilter getResourceFilter()

Resource filter for an evaluation defining the scope of resources to be evaluated.

.google.cloud.workloadmanager.v1.ResourceFilter resource_filter = 3;

Returns
Type Description
ResourceFilter

The resourceFilter.

getResourceFilterOrBuilder()

public ResourceFilterOrBuilder getResourceFilterOrBuilder()

Resource filter for an evaluation defining the scope of resources to be evaluated.

.google.cloud.workloadmanager.v1.ResourceFilter resource_filter = 3;

Returns
Type Description
ResourceFilterOrBuilder

getResourceStatus()

public ResourceStatus getResourceStatus()

Output only. [Output only] The current lifecycle state of the evaluation resource.

.google.cloud.workloadmanager.v1.ResourceStatus resource_status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ResourceStatus

The resourceStatus.

getResourceStatusOrBuilder()

public ResourceStatusOrBuilder getResourceStatusOrBuilder()

Output only. [Output only] The current lifecycle state of the evaluation resource.

.google.cloud.workloadmanager.v1.ResourceStatus resource_status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ResourceStatusOrBuilder

getRuleNames(int index)

public String getRuleNames(int index)

The names of the rules used for this evaluation.

repeated string rule_names = 4;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The ruleNames at the given index.

getRuleNamesBytes(int index)

public ByteString getRuleNamesBytes(int index)

The names of the rules used for this evaluation.

repeated string rule_names = 4;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the ruleNames at the given index.

getRuleNamesCount()

public int getRuleNamesCount()

The names of the rules used for this evaluation.

repeated string rule_names = 4;

Returns
Type Description
int

The count of ruleNames.

getRuleNamesList()

public ProtocolStringList getRuleNamesList()

The names of the rules used for this evaluation.

repeated string rule_names = 4;

Returns
Type Description
ProtocolStringList

A list containing the ruleNames.

getSchedule()

public String 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

optional string schedule = 10;

Returns
Type Description
String

The schedule.

getScheduleBytes()

public ByteString getScheduleBytes()

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

optional string schedule = 10;

Returns
Type Description
ByteString

The bytes for schedule.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. [Output only] Update time stamp.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. [Output only] Update time stamp.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasBigQueryDestination()

public boolean hasBigQueryDestination()

Optional. The BigQuery destination for detailed evaluation results. If this field is specified, the results of each evaluation execution are exported to BigQuery.

.google.cloud.workloadmanager.v1.BigQueryDestination big_query_destination = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the bigQueryDestination field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. [Output only] Create time stamp.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasResourceFilter()

public boolean hasResourceFilter()

Resource filter for an evaluation defining the scope of resources to be evaluated.

.google.cloud.workloadmanager.v1.ResourceFilter resource_filter = 3;

Returns
Type Description
boolean

Whether the resourceFilter field is set.

hasResourceStatus()

public boolean hasResourceStatus()

Output only. [Output only] The current lifecycle state of the evaluation resource.

.google.cloud.workloadmanager.v1.ResourceStatus resource_status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the resourceStatus field is set.

hasSchedule()

public boolean hasSchedule()

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

optional string schedule = 10;

Returns
Type Description
boolean

Whether the schedule field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. [Output only] Update time stamp.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Evaluation.Builder newBuilderForType()
Returns
Type Description
Evaluation.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Evaluation.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Evaluation.Builder
Overrides

toBuilder()

public Evaluation.Builder toBuilder()
Returns
Type Description
Evaluation.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException