Package com.google.cloud.workloadmanager.v1

Class Evaluation

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.workloadmanager.v1.Evaluation
All Implemented Interfaces:
EvaluationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Evaluation extends com.google.protobuf.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
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • RESOURCE_FILTER_FIELD_NUMBER

      public static final int RESOURCE_FILTER_FIELD_NUMBER
      See Also:

    • RULE_NAMES_FIELD_NUMBER

      public static final int RULE_NAMES_FIELD_NUMBER
      See Also:

    • RESOURCE_STATUS_FIELD_NUMBER

      public static final int RESOURCE_STATUS_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • LABELS_FIELD_NUMBER

      public static final int LABELS_FIELD_NUMBER
      See Also:

    • SCHEDULE_FIELD_NUMBER

      public static final int SCHEDULE_FIELD_NUMBER
      See Also:

    • CUSTOM_RULES_BUCKET_FIELD_NUMBER

      public static final int CUSTOM_RULES_BUCKET_FIELD_NUMBER
      See Also:

    • EVALUATION_TYPE_FIELD_NUMBER

      public static final int EVALUATION_TYPE_FIELD_NUMBER
      See Also:

    • BIG_QUERY_DESTINATION_FIELD_NUMBER

      public static final int BIG_QUERY_DESTINATION_FIELD_NUMBER
      See Also:

    • KMS_KEY_FIELD_NUMBER

      public static final int KMS_KEY_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getName

      public String getName()
       Name of resource that has the form
 `projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}`.
      string name = 1;
      Specified by:
      getName in interface EvaluationOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Name of resource that has the form
 `projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}`.
      string name = 1;
      Specified by:
      getNameBytes in interface EvaluationOrBuilder
      Returns:
      The bytes for name.

    • getDescription

      public String getDescription()
       Description of the Evaluation.
      string description = 2;
      Specified by:
      getDescription in interface EvaluationOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Description of the Evaluation.
      string description = 2;
      Specified by:
      getDescriptionBytes in interface EvaluationOrBuilder
      Returns:
      The bytes for description.

    • 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;
      Specified by:
      hasResourceFilter in interface EvaluationOrBuilder
      Returns:
      Whether the resourceFilter field is set.

    • 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;
      Specified by:
      getResourceFilter in interface EvaluationOrBuilder
      Returns:
      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;
      Specified by:
      getResourceFilterOrBuilder in interface EvaluationOrBuilder

    • getRuleNamesList

      public com.google.protobuf.ProtocolStringList getRuleNamesList()
       The names of the rules used for this evaluation.
      repeated string rule_names = 4;
      Specified by:
      getRuleNamesList in interface EvaluationOrBuilder
      Returns:
      A list containing the ruleNames.

    • getRuleNamesCount

      public int getRuleNamesCount()
       The names of the rules used for this evaluation.
      repeated string rule_names = 4;
      Specified by:
      getRuleNamesCount in interface EvaluationOrBuilder
      Returns:
      The count of ruleNames.

    • getRuleNames

      public String getRuleNames(int index)
       The names of the rules used for this evaluation.
      repeated string rule_names = 4;
      Specified by:
      getRuleNames in interface EvaluationOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The ruleNames at the given index.

    • getRuleNamesBytes

      public com.google.protobuf.ByteString getRuleNamesBytes(int index)
       The names of the rules used for this evaluation.
      repeated string rule_names = 4;
      Specified by:
      getRuleNamesBytes in interface EvaluationOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the ruleNames at the given index.

    • 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];
      Specified by:
      hasResourceStatus in interface EvaluationOrBuilder
      Returns:
      Whether the resourceStatus field is set.

    • 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];
      Specified by:
      getResourceStatus in interface EvaluationOrBuilder
      Returns:
      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];
      Specified by:
      getResourceStatusOrBuilder in interface EvaluationOrBuilder

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. [Output only] Create time stamp.
      .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface EvaluationOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. [Output only] Create time stamp.
      .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface EvaluationOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. [Output only] Create time stamp.
      .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface EvaluationOrBuilder

    • hasUpdateTime

      public boolean hasUpdateTime()
       Output only. [Output only] Update time stamp.
      .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasUpdateTime in interface EvaluationOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public com.google.protobuf.Timestamp getUpdateTime()
       Output only. [Output only] Update time stamp.
      .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTime in interface EvaluationOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. [Output only] Update time stamp.
      .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface EvaluationOrBuilder

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: EvaluationOrBuilder
       Labels as key value pairs.
      map<string, string> labels = 9;
      Specified by:
      getLabelsCount in interface EvaluationOrBuilder

    • containsLabels

      public boolean containsLabels(String key)
       Labels as key value pairs.
      map<string, string> labels = 9;
      Specified by:
      containsLabels in interface EvaluationOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface EvaluationOrBuilder

    • getLabelsMap

      public Map<String,String> getLabelsMap()
       Labels as key value pairs.
      map<string, string> labels = 9;
      Specified by:
      getLabelsMap in interface EvaluationOrBuilder

    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       Labels as key value pairs.
      map<string, string> labels = 9;
      Specified by:
      getLabelsOrDefault in interface EvaluationOrBuilder

    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       Labels as key value pairs.
      map<string, string> labels = 9;
      Specified by:
      getLabelsOrThrow in interface EvaluationOrBuilder

    • 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;
      Specified by:
      hasSchedule in interface EvaluationOrBuilder
      Returns:
      Whether the schedule field is set.

    • 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;
      Specified by:
      getSchedule in interface EvaluationOrBuilder
      Returns:
      The schedule.

    • getScheduleBytes

      public com.google.protobuf.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;
      Specified by:
      getScheduleBytes in interface EvaluationOrBuilder
      Returns:
      The bytes for schedule.

    • getCustomRulesBucket

      public String getCustomRulesBucket()
       The Cloud Storage bucket name for custom rules.
      string custom_rules_bucket = 11;
      Specified by:
      getCustomRulesBucket in interface EvaluationOrBuilder
      Returns:
      The customRulesBucket.

    • getCustomRulesBucketBytes

      public com.google.protobuf.ByteString getCustomRulesBucketBytes()
       The Cloud Storage bucket name for custom rules.
      string custom_rules_bucket = 11;
      Specified by:
      getCustomRulesBucketBytes in interface EvaluationOrBuilder
      Returns:
      The bytes for customRulesBucket.

    • getEvaluationTypeValue

      public int getEvaluationTypeValue()
       Evaluation type.
      .google.cloud.workloadmanager.v1.Evaluation.EvaluationType evaluation_type = 12;
      Specified by:
      getEvaluationTypeValue in interface EvaluationOrBuilder
      Returns:
      The enum numeric value on the wire for evaluationType.

    • getEvaluationType

      public Evaluation.EvaluationType getEvaluationType()
       Evaluation type.
      .google.cloud.workloadmanager.v1.Evaluation.EvaluationType evaluation_type = 12;
      Specified by:
      getEvaluationType in interface EvaluationOrBuilder
      Returns:
      The evaluationType.

    • 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];
      Specified by:
      hasBigQueryDestination in interface EvaluationOrBuilder
      Returns:
      Whether the bigQueryDestination field is set.

    • 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];
      Specified by:
      getBigQueryDestination in interface EvaluationOrBuilder
      Returns:
      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];
      Specified by:
      getBigQueryDestinationOrBuilder in interface EvaluationOrBuilder

    • 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) = { ... }
      Specified by:
      getKmsKey in interface EvaluationOrBuilder
      Returns:
      The kmsKey.

    • getKmsKeyBytes

      public com.google.protobuf.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) = { ... }
      Specified by:
      getKmsKeyBytes in interface EvaluationOrBuilder
      Returns:
      The bytes for kmsKey.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Evaluation parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Evaluation parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Evaluation parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Evaluation parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Evaluation parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Evaluation parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Evaluation parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Evaluation parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Evaluation parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Evaluation parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Evaluation parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Evaluation parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Evaluation.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Evaluation.Builder newBuilder()

    • newBuilder

      public static Evaluation.Builder newBuilder(Evaluation prototype)

    • toBuilder

      public Evaluation.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Evaluation.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Evaluation getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Evaluation> parser()

    • getParserForType

      public com.google.protobuf.Parser<Evaluation> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Evaluation getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder