Package com.google.cloud.aiplatform.v1beta1

Class ModelEvaluationSlice.Builder

  • All Implemented Interfaces:
    ModelEvaluationSliceOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    ModelEvaluationSlice
    public static final class ModelEvaluationSlice.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ModelEvaluationSlice.Builder>
implements ModelEvaluationSliceOrBuilder
     A collection of metrics calculated by comparing Model's predictions on a
 slice of the test data against ground truth annotations.
    Protobuf type google.cloud.aiplatform.v1beta1.ModelEvaluationSlice

    • Method Detail

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ModelEvaluationSlice.Builder>

      • clear

        public ModelEvaluationSlice.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<ModelEvaluationSlice.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ModelEvaluationSlice.Builder>

      • getDefaultInstanceForType

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

      • build

        public ModelEvaluationSlice build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public ModelEvaluationSlice buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public ModelEvaluationSlice.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<ModelEvaluationSlice.Builder>

      • setField

        public ModelEvaluationSlice.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<ModelEvaluationSlice.Builder>

      • clearField

        public ModelEvaluationSlice.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ModelEvaluationSlice.Builder>

      • clearOneof

        public ModelEvaluationSlice.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ModelEvaluationSlice.Builder>

      • setRepeatedField

        public ModelEvaluationSlice.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     int index,
                                                     Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ModelEvaluationSlice.Builder>

      • addRepeatedField

        public ModelEvaluationSlice.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ModelEvaluationSlice.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ModelEvaluationSlice.Builder>

      • mergeFrom

        public ModelEvaluationSlice.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ModelEvaluationSlice.Builder>
        Throws:
        IOException

      • getName

        public String getName()
         Output only. The resource name of the ModelEvaluationSlice.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface ModelEvaluationSliceOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The resource name of the ModelEvaluationSlice.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface ModelEvaluationSliceOrBuilder
        Returns:
        The bytes for name.

      • setName

        public ModelEvaluationSlice.Builder setName​(String value)
         Output only. The resource name of the ModelEvaluationSlice.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • clearName

        public ModelEvaluationSlice.Builder clearName()
         Output only. The resource name of the ModelEvaluationSlice.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.

      • setNameBytes

        public ModelEvaluationSlice.Builder setNameBytes​(com.google.protobuf.ByteString value)
         Output only. The resource name of the ModelEvaluationSlice.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

      • hasSlice

        public boolean hasSlice()
         Output only. The slice of the test data that is used to evaluate the Model.
        .google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.Slice slice = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasSlice in interface ModelEvaluationSliceOrBuilder
        Returns:
        Whether the slice field is set.

      • getSlice

        public ModelEvaluationSlice.Slice getSlice()
         Output only. The slice of the test data that is used to evaluate the Model.
        .google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.Slice slice = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getSlice in interface ModelEvaluationSliceOrBuilder
        Returns:
        The slice.

      • setSlice

        public ModelEvaluationSlice.Builder setSlice​(ModelEvaluationSlice.Slice value)
         Output only. The slice of the test data that is used to evaluate the Model.
        .google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.Slice slice = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • mergeSlice

        public ModelEvaluationSlice.Builder mergeSlice​(ModelEvaluationSlice.Slice value)
         Output only. The slice of the test data that is used to evaluate the Model.
        .google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.Slice slice = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • clearSlice

        public ModelEvaluationSlice.Builder clearSlice()
         Output only. The slice of the test data that is used to evaluate the Model.
        .google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.Slice slice = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getSliceBuilder

        public ModelEvaluationSlice.Slice.Builder getSliceBuilder()
         Output only. The slice of the test data that is used to evaluate the Model.
        .google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.Slice slice = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getMetricsSchemaUri

        public String getMetricsSchemaUri()
         Output only. Points to a YAML file stored on Google Cloud Storage
 describing the
 [metrics][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.metrics] of
 this ModelEvaluationSlice. The schema is defined as an OpenAPI 3.0.2
 [Schema
 Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
        string metrics_schema_uri = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMetricsSchemaUri in interface ModelEvaluationSliceOrBuilder
        Returns:
        The metricsSchemaUri.

      • getMetricsSchemaUriBytes

        public com.google.protobuf.ByteString getMetricsSchemaUriBytes()
         Output only. Points to a YAML file stored on Google Cloud Storage
 describing the
 [metrics][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.metrics] of
 this ModelEvaluationSlice. The schema is defined as an OpenAPI 3.0.2
 [Schema
 Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
        string metrics_schema_uri = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMetricsSchemaUriBytes in interface ModelEvaluationSliceOrBuilder
        Returns:
        The bytes for metricsSchemaUri.

      • setMetricsSchemaUri

        public ModelEvaluationSlice.Builder setMetricsSchemaUri​(String value)
         Output only. Points to a YAML file stored on Google Cloud Storage
 describing the
 [metrics][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.metrics] of
 this ModelEvaluationSlice. The schema is defined as an OpenAPI 3.0.2
 [Schema
 Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
        string metrics_schema_uri = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The metricsSchemaUri to set.
        Returns:
        This builder for chaining.

      • clearMetricsSchemaUri

        public ModelEvaluationSlice.Builder clearMetricsSchemaUri()
         Output only. Points to a YAML file stored on Google Cloud Storage
 describing the
 [metrics][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.metrics] of
 this ModelEvaluationSlice. The schema is defined as an OpenAPI 3.0.2
 [Schema
 Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
        string metrics_schema_uri = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.

      • setMetricsSchemaUriBytes

        public ModelEvaluationSlice.Builder setMetricsSchemaUriBytes​(com.google.protobuf.ByteString value)
         Output only. Points to a YAML file stored on Google Cloud Storage
 describing the
 [metrics][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.metrics] of
 this ModelEvaluationSlice. The schema is defined as an OpenAPI 3.0.2
 [Schema
 Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
        string metrics_schema_uri = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The bytes for metricsSchemaUri to set.
        Returns:
        This builder for chaining.

      • hasMetrics

        public boolean hasMetrics()
         Output only. Sliced evaluation metrics of the Model. The schema of the
 metrics is stored in
 [metrics_schema_uri][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.metrics_schema_uri]
        .google.protobuf.Value metrics = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasMetrics in interface ModelEvaluationSliceOrBuilder
        Returns:
        Whether the metrics field is set.

      • getMetrics

        public com.google.protobuf.Value getMetrics()
         Output only. Sliced evaluation metrics of the Model. The schema of the
 metrics is stored in
 [metrics_schema_uri][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.metrics_schema_uri]
        .google.protobuf.Value metrics = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMetrics in interface ModelEvaluationSliceOrBuilder
        Returns:
        The metrics.

      • setMetrics

        public ModelEvaluationSlice.Builder setMetrics​(com.google.protobuf.Value value)
         Output only. Sliced evaluation metrics of the Model. The schema of the
 metrics is stored in
 [metrics_schema_uri][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.metrics_schema_uri]
        .google.protobuf.Value metrics = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • setMetrics

        public ModelEvaluationSlice.Builder setMetrics​(com.google.protobuf.Value.Builder builderForValue)
         Output only. Sliced evaluation metrics of the Model. The schema of the
 metrics is stored in
 [metrics_schema_uri][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.metrics_schema_uri]
        .google.protobuf.Value metrics = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • mergeMetrics

        public ModelEvaluationSlice.Builder mergeMetrics​(com.google.protobuf.Value value)
         Output only. Sliced evaluation metrics of the Model. The schema of the
 metrics is stored in
 [metrics_schema_uri][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.metrics_schema_uri]
        .google.protobuf.Value metrics = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • clearMetrics

        public ModelEvaluationSlice.Builder clearMetrics()
         Output only. Sliced evaluation metrics of the Model. The schema of the
 metrics is stored in
 [metrics_schema_uri][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.metrics_schema_uri]
        .google.protobuf.Value metrics = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getMetricsBuilder

        public com.google.protobuf.Value.Builder getMetricsBuilder()
         Output only. Sliced evaluation metrics of the Model. The schema of the
 metrics is stored in
 [metrics_schema_uri][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.metrics_schema_uri]
        .google.protobuf.Value metrics = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getMetricsOrBuilder

        public com.google.protobuf.ValueOrBuilder getMetricsOrBuilder()
         Output only. Sliced evaluation metrics of the Model. The schema of the
 metrics is stored in
 [metrics_schema_uri][google.cloud.aiplatform.v1beta1.ModelEvaluationSlice.metrics_schema_uri]
        .google.protobuf.Value metrics = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getMetricsOrBuilder in interface ModelEvaluationSliceOrBuilder

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. Timestamp when this ModelEvaluationSlice was created.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface ModelEvaluationSliceOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. Timestamp when this ModelEvaluationSlice was created.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface ModelEvaluationSliceOrBuilder
        Returns:
        The createTime.

      • setCreateTime

        public ModelEvaluationSlice.Builder setCreateTime​(com.google.protobuf.Timestamp value)
         Output only. Timestamp when this ModelEvaluationSlice was created.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • setCreateTime

        public ModelEvaluationSlice.Builder setCreateTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         Output only. Timestamp when this ModelEvaluationSlice was created.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • mergeCreateTime

        public ModelEvaluationSlice.Builder mergeCreateTime​(com.google.protobuf.Timestamp value)
         Output only. Timestamp when this ModelEvaluationSlice was created.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • clearCreateTime

        public ModelEvaluationSlice.Builder clearCreateTime()
         Output only. Timestamp when this ModelEvaluationSlice was created.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getCreateTimeBuilder

        public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder()
         Output only. Timestamp when this ModelEvaluationSlice was created.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Timestamp when this ModelEvaluationSlice was created.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface ModelEvaluationSliceOrBuilder

      • hasModelExplanation

        public boolean hasModelExplanation()
         Output only. Aggregated explanation metrics for the Model's prediction
 output over the data this ModelEvaluation uses. This field is populated
 only if the Model is evaluated with explanations, and only for tabular
 Models.
        .google.cloud.aiplatform.v1beta1.ModelExplanation model_explanation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasModelExplanation in interface ModelEvaluationSliceOrBuilder
        Returns:
        Whether the modelExplanation field is set.

      • getModelExplanation

        public ModelExplanation getModelExplanation()
         Output only. Aggregated explanation metrics for the Model's prediction
 output over the data this ModelEvaluation uses. This field is populated
 only if the Model is evaluated with explanations, and only for tabular
 Models.
        .google.cloud.aiplatform.v1beta1.ModelExplanation model_explanation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getModelExplanation in interface ModelEvaluationSliceOrBuilder
        Returns:
        The modelExplanation.

      • setModelExplanation

        public ModelEvaluationSlice.Builder setModelExplanation​(ModelExplanation value)
         Output only. Aggregated explanation metrics for the Model's prediction
 output over the data this ModelEvaluation uses. This field is populated
 only if the Model is evaluated with explanations, and only for tabular
 Models.
        .google.cloud.aiplatform.v1beta1.ModelExplanation model_explanation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • setModelExplanation

        public ModelEvaluationSlice.Builder setModelExplanation​(ModelExplanation.Builder builderForValue)
         Output only. Aggregated explanation metrics for the Model's prediction
 output over the data this ModelEvaluation uses. This field is populated
 only if the Model is evaluated with explanations, and only for tabular
 Models.
        .google.cloud.aiplatform.v1beta1.ModelExplanation model_explanation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • mergeModelExplanation

        public ModelEvaluationSlice.Builder mergeModelExplanation​(ModelExplanation value)
         Output only. Aggregated explanation metrics for the Model's prediction
 output over the data this ModelEvaluation uses. This field is populated
 only if the Model is evaluated with explanations, and only for tabular
 Models.
        .google.cloud.aiplatform.v1beta1.ModelExplanation model_explanation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • clearModelExplanation

        public ModelEvaluationSlice.Builder clearModelExplanation()
         Output only. Aggregated explanation metrics for the Model's prediction
 output over the data this ModelEvaluation uses. This field is populated
 only if the Model is evaluated with explanations, and only for tabular
 Models.
        .google.cloud.aiplatform.v1beta1.ModelExplanation model_explanation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getModelExplanationBuilder

        public ModelExplanation.Builder getModelExplanationBuilder()
         Output only. Aggregated explanation metrics for the Model's prediction
 output over the data this ModelEvaluation uses. This field is populated
 only if the Model is evaluated with explanations, and only for tabular
 Models.
        .google.cloud.aiplatform.v1beta1.ModelExplanation model_explanation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getModelExplanationOrBuilder

        public ModelExplanationOrBuilder getModelExplanationOrBuilder()
         Output only. Aggregated explanation metrics for the Model's prediction
 output over the data this ModelEvaluation uses. This field is populated
 only if the Model is evaluated with explanations, and only for tabular
 Models.
        .google.cloud.aiplatform.v1beta1.ModelExplanation model_explanation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getModelExplanationOrBuilder in interface ModelEvaluationSliceOrBuilder

      • setUnknownFields

        public final ModelEvaluationSlice.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ModelEvaluationSlice.Builder>

      • mergeUnknownFields

        public final ModelEvaluationSlice.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ModelEvaluationSlice.Builder>