Package org.mlflow.api.proto

Class Assessments.Expectation.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable, Assessments.ExpectationOrBuilder
    Enclosing class:
    Assessments.Expectation
    public static final class Assessments.Expectation.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Assessments.Expectation.Builder>
implements Assessments.ExpectationOrBuilder
     An expectation for the values or guidelines for the outputs that a model or agent should produce
 from the inputs contained in the trace.
    Protobuf type mlflow.assessments.Expectation

    • 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<Assessments.Expectation.Builder>

      • clear

        public Assessments.Expectation.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<Assessments.Expectation.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<Assessments.Expectation.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public Assessments.Expectation.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<Assessments.Expectation.Builder>

      • setField

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

      • clearField

        public Assessments.Expectation.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<Assessments.Expectation.Builder>

      • clearOneof

        public Assessments.Expectation.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<Assessments.Expectation.Builder>

      • setRepeatedField

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

      • addRepeatedField

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

      • isInitialized

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

      • mergeFrom

        public Assessments.Expectation.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws java.io.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<Assessments.Expectation.Builder>
        Throws:
        java.io.IOException

      • hasValue

        public boolean hasValue()
         The value of the expectation-based assessment. This uses ``google.protobuf.Value`` under the hood to support a
 flexible schema of expectation values but is validated to constrain it to specific types. This means the value must
 be JSON conforming to one of the following supported types:
 * Numeric values like integers or floats
 * Boolean values
 * Text value (can contain JSON text the user wishes to store, but it will only be searchable as text)
 * List values containing only strings (empty lists allowed).
 Other values like null, structs, non-string lists etc. will be rejected. However, they can instead be serialized as
 a string and stored in the ``serialized_value`` field instead. Only one of either ``serialized_value`` or ``value``
 may be defined. We do not support these other formats directly despite using google.protobuf.Value due to security
 risks around their serialization and deserialization.
        optional .google.protobuf.Value value = 2;
        Specified by:
        hasValue in interface Assessments.ExpectationOrBuilder
        Returns:
        Whether the value field is set.

      • getValue

        public com.google.protobuf.Value getValue()
         The value of the expectation-based assessment. This uses ``google.protobuf.Value`` under the hood to support a
 flexible schema of expectation values but is validated to constrain it to specific types. This means the value must
 be JSON conforming to one of the following supported types:
 * Numeric values like integers or floats
 * Boolean values
 * Text value (can contain JSON text the user wishes to store, but it will only be searchable as text)
 * List values containing only strings (empty lists allowed).
 Other values like null, structs, non-string lists etc. will be rejected. However, they can instead be serialized as
 a string and stored in the ``serialized_value`` field instead. Only one of either ``serialized_value`` or ``value``
 may be defined. We do not support these other formats directly despite using google.protobuf.Value due to security
 risks around their serialization and deserialization.
        optional .google.protobuf.Value value = 2;
        Specified by:
        getValue in interface Assessments.ExpectationOrBuilder
        Returns:
        The value.

      • setValue

        public Assessments.Expectation.Builder setValue​(com.google.protobuf.Value value)
         The value of the expectation-based assessment. This uses ``google.protobuf.Value`` under the hood to support a
 flexible schema of expectation values but is validated to constrain it to specific types. This means the value must
 be JSON conforming to one of the following supported types:
 * Numeric values like integers or floats
 * Boolean values
 * Text value (can contain JSON text the user wishes to store, but it will only be searchable as text)
 * List values containing only strings (empty lists allowed).
 Other values like null, structs, non-string lists etc. will be rejected. However, they can instead be serialized as
 a string and stored in the ``serialized_value`` field instead. Only one of either ``serialized_value`` or ``value``
 may be defined. We do not support these other formats directly despite using google.protobuf.Value due to security
 risks around their serialization and deserialization.
        optional .google.protobuf.Value value = 2;

      • setValue

        public Assessments.Expectation.Builder setValue​(com.google.protobuf.Value.Builder builderForValue)
         The value of the expectation-based assessment. This uses ``google.protobuf.Value`` under the hood to support a
 flexible schema of expectation values but is validated to constrain it to specific types. This means the value must
 be JSON conforming to one of the following supported types:
 * Numeric values like integers or floats
 * Boolean values
 * Text value (can contain JSON text the user wishes to store, but it will only be searchable as text)
 * List values containing only strings (empty lists allowed).
 Other values like null, structs, non-string lists etc. will be rejected. However, they can instead be serialized as
 a string and stored in the ``serialized_value`` field instead. Only one of either ``serialized_value`` or ``value``
 may be defined. We do not support these other formats directly despite using google.protobuf.Value due to security
 risks around their serialization and deserialization.
        optional .google.protobuf.Value value = 2;

      • mergeValue

        public Assessments.Expectation.Builder mergeValue​(com.google.protobuf.Value value)
         The value of the expectation-based assessment. This uses ``google.protobuf.Value`` under the hood to support a
 flexible schema of expectation values but is validated to constrain it to specific types. This means the value must
 be JSON conforming to one of the following supported types:
 * Numeric values like integers or floats
 * Boolean values
 * Text value (can contain JSON text the user wishes to store, but it will only be searchable as text)
 * List values containing only strings (empty lists allowed).
 Other values like null, structs, non-string lists etc. will be rejected. However, they can instead be serialized as
 a string and stored in the ``serialized_value`` field instead. Only one of either ``serialized_value`` or ``value``
 may be defined. We do not support these other formats directly despite using google.protobuf.Value due to security
 risks around their serialization and deserialization.
        optional .google.protobuf.Value value = 2;

      • clearValue

        public Assessments.Expectation.Builder clearValue()
         The value of the expectation-based assessment. This uses ``google.protobuf.Value`` under the hood to support a
 flexible schema of expectation values but is validated to constrain it to specific types. This means the value must
 be JSON conforming to one of the following supported types:
 * Numeric values like integers or floats
 * Boolean values
 * Text value (can contain JSON text the user wishes to store, but it will only be searchable as text)
 * List values containing only strings (empty lists allowed).
 Other values like null, structs, non-string lists etc. will be rejected. However, they can instead be serialized as
 a string and stored in the ``serialized_value`` field instead. Only one of either ``serialized_value`` or ``value``
 may be defined. We do not support these other formats directly despite using google.protobuf.Value due to security
 risks around their serialization and deserialization.
        optional .google.protobuf.Value value = 2;

      • getValueBuilder

        public com.google.protobuf.Value.Builder getValueBuilder()
         The value of the expectation-based assessment. This uses ``google.protobuf.Value`` under the hood to support a
 flexible schema of expectation values but is validated to constrain it to specific types. This means the value must
 be JSON conforming to one of the following supported types:
 * Numeric values like integers or floats
 * Boolean values
 * Text value (can contain JSON text the user wishes to store, but it will only be searchable as text)
 * List values containing only strings (empty lists allowed).
 Other values like null, structs, non-string lists etc. will be rejected. However, they can instead be serialized as
 a string and stored in the ``serialized_value`` field instead. Only one of either ``serialized_value`` or ``value``
 may be defined. We do not support these other formats directly despite using google.protobuf.Value due to security
 risks around their serialization and deserialization.
        optional .google.protobuf.Value value = 2;

      • getValueOrBuilder

        public com.google.protobuf.ValueOrBuilder getValueOrBuilder()
         The value of the expectation-based assessment. This uses ``google.protobuf.Value`` under the hood to support a
 flexible schema of expectation values but is validated to constrain it to specific types. This means the value must
 be JSON conforming to one of the following supported types:
 * Numeric values like integers or floats
 * Boolean values
 * Text value (can contain JSON text the user wishes to store, but it will only be searchable as text)
 * List values containing only strings (empty lists allowed).
 Other values like null, structs, non-string lists etc. will be rejected. However, they can instead be serialized as
 a string and stored in the ``serialized_value`` field instead. Only one of either ``serialized_value`` or ``value``
 may be defined. We do not support these other formats directly despite using google.protobuf.Value due to security
 risks around their serialization and deserialization.
        optional .google.protobuf.Value value = 2;
        Specified by:
        getValueOrBuilder in interface Assessments.ExpectationOrBuilder

      • hasSerializedValue

        public boolean hasSerializedValue()
         The value of the expecation-based assessment serialized as a string in a specified format. Only one of either 
 ``serialized_value`` or ``value`` may be defined.
        optional .mlflow.assessments.Expectation.SerializedValue serialized_value = 3;
        Specified by:
        hasSerializedValue in interface Assessments.ExpectationOrBuilder
        Returns:
        Whether the serializedValue field is set.

      • setSerializedValue

        public Assessments.Expectation.Builder setSerializedValue​(Assessments.Expectation.SerializedValue value)
         The value of the expecation-based assessment serialized as a string in a specified format. Only one of either 
 ``serialized_value`` or ``value`` may be defined.
        optional .mlflow.assessments.Expectation.SerializedValue serialized_value = 3;

      • mergeSerializedValue

        public Assessments.Expectation.Builder mergeSerializedValue​(Assessments.Expectation.SerializedValue value)
         The value of the expecation-based assessment serialized as a string in a specified format. Only one of either 
 ``serialized_value`` or ``value`` may be defined.
        optional .mlflow.assessments.Expectation.SerializedValue serialized_value = 3;

      • clearSerializedValue

        public Assessments.Expectation.Builder clearSerializedValue()
         The value of the expecation-based assessment serialized as a string in a specified format. Only one of either 
 ``serialized_value`` or ``value`` may be defined.
        optional .mlflow.assessments.Expectation.SerializedValue serialized_value = 3;

      • getSerializedValueBuilder

        public Assessments.Expectation.SerializedValue.Builder getSerializedValueBuilder()
         The value of the expecation-based assessment serialized as a string in a specified format. Only one of either 
 ``serialized_value`` or ``value`` may be defined.
        optional .mlflow.assessments.Expectation.SerializedValue serialized_value = 3;

      • setUnknownFields

        public final Assessments.Expectation.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<Assessments.Expectation.Builder>

      • mergeUnknownFields

        public final Assessments.Expectation.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<Assessments.Expectation.Builder>