Package com.google.cloud.aiplatform.v1

Class PredictSchemata.Builder

  • All Implemented Interfaces:
    PredictSchemataOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    PredictSchemata
    public static final class PredictSchemata.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<PredictSchemata.Builder>
implements PredictSchemataOrBuilder
     Contains the schemata used in Model's predictions and explanations via
 [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict],
 [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]
 and [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob].
    Protobuf type google.cloud.aiplatform.v1.PredictSchemata

    • 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<PredictSchemata.Builder>

      • clear

        public PredictSchemata.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<PredictSchemata.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<PredictSchemata.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public PredictSchemata.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<PredictSchemata.Builder>

      • setField

        public PredictSchemata.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<PredictSchemata.Builder>

      • clearField

        public PredictSchemata.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<PredictSchemata.Builder>

      • clearOneof

        public PredictSchemata.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<PredictSchemata.Builder>

      • setRepeatedField

        public PredictSchemata.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<PredictSchemata.Builder>

      • addRepeatedField

        public PredictSchemata.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<PredictSchemata.Builder>

      • mergeFrom

        public PredictSchemata.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PredictSchemata.Builder>

      • isInitialized

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

      • mergeFrom

        public PredictSchemata.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<PredictSchemata.Builder>
        Throws:
        IOException

      • getInstanceSchemaUri

        public String getInstanceSchemaUri()
         Immutable. Points to a YAML file stored on Google Cloud Storage describing
 the format of a single instance, which are used in
 [PredictRequest.instances][google.cloud.aiplatform.v1.PredictRequest.instances],
 [ExplainRequest.instances][google.cloud.aiplatform.v1.ExplainRequest.instances]
 and
 [BatchPredictionJob.input_config][google.cloud.aiplatform.v1.BatchPredictionJob.input_config].
 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).
 AutoML Models always have this field populated by Vertex AI.
 Note: The URI given on output will be immutable and probably different,
 including the URI scheme, than the one given on input. The output URI will
 point to a location where the user only has a read access.
        string instance_schema_uri = 1 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getInstanceSchemaUri in interface PredictSchemataOrBuilder
        Returns:
        The instanceSchemaUri.

      • getInstanceSchemaUriBytes

        public com.google.protobuf.ByteString getInstanceSchemaUriBytes()
         Immutable. Points to a YAML file stored on Google Cloud Storage describing
 the format of a single instance, which are used in
 [PredictRequest.instances][google.cloud.aiplatform.v1.PredictRequest.instances],
 [ExplainRequest.instances][google.cloud.aiplatform.v1.ExplainRequest.instances]
 and
 [BatchPredictionJob.input_config][google.cloud.aiplatform.v1.BatchPredictionJob.input_config].
 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).
 AutoML Models always have this field populated by Vertex AI.
 Note: The URI given on output will be immutable and probably different,
 including the URI scheme, than the one given on input. The output URI will
 point to a location where the user only has a read access.
        string instance_schema_uri = 1 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getInstanceSchemaUriBytes in interface PredictSchemataOrBuilder
        Returns:
        The bytes for instanceSchemaUri.

      • setInstanceSchemaUri

        public PredictSchemata.Builder setInstanceSchemaUri​(String value)
         Immutable. Points to a YAML file stored on Google Cloud Storage describing
 the format of a single instance, which are used in
 [PredictRequest.instances][google.cloud.aiplatform.v1.PredictRequest.instances],
 [ExplainRequest.instances][google.cloud.aiplatform.v1.ExplainRequest.instances]
 and
 [BatchPredictionJob.input_config][google.cloud.aiplatform.v1.BatchPredictionJob.input_config].
 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).
 AutoML Models always have this field populated by Vertex AI.
 Note: The URI given on output will be immutable and probably different,
 including the URI scheme, than the one given on input. The output URI will
 point to a location where the user only has a read access.
        string instance_schema_uri = 1 [(.google.api.field_behavior) = IMMUTABLE];
        Parameters:
        value - The instanceSchemaUri to set.
        Returns:
        This builder for chaining.

      • clearInstanceSchemaUri

        public PredictSchemata.Builder clearInstanceSchemaUri()
         Immutable. Points to a YAML file stored on Google Cloud Storage describing
 the format of a single instance, which are used in
 [PredictRequest.instances][google.cloud.aiplatform.v1.PredictRequest.instances],
 [ExplainRequest.instances][google.cloud.aiplatform.v1.ExplainRequest.instances]
 and
 [BatchPredictionJob.input_config][google.cloud.aiplatform.v1.BatchPredictionJob.input_config].
 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).
 AutoML Models always have this field populated by Vertex AI.
 Note: The URI given on output will be immutable and probably different,
 including the URI scheme, than the one given on input. The output URI will
 point to a location where the user only has a read access.
        string instance_schema_uri = 1 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        This builder for chaining.

      • setInstanceSchemaUriBytes

        public PredictSchemata.Builder setInstanceSchemaUriBytes​(com.google.protobuf.ByteString value)
         Immutable. Points to a YAML file stored on Google Cloud Storage describing
 the format of a single instance, which are used in
 [PredictRequest.instances][google.cloud.aiplatform.v1.PredictRequest.instances],
 [ExplainRequest.instances][google.cloud.aiplatform.v1.ExplainRequest.instances]
 and
 [BatchPredictionJob.input_config][google.cloud.aiplatform.v1.BatchPredictionJob.input_config].
 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).
 AutoML Models always have this field populated by Vertex AI.
 Note: The URI given on output will be immutable and probably different,
 including the URI scheme, than the one given on input. The output URI will
 point to a location where the user only has a read access.
        string instance_schema_uri = 1 [(.google.api.field_behavior) = IMMUTABLE];
        Parameters:
        value - The bytes for instanceSchemaUri to set.
        Returns:
        This builder for chaining.

      • getParametersSchemaUri

        public String getParametersSchemaUri()
         Immutable. Points to a YAML file stored on Google Cloud Storage describing
 the parameters of prediction and explanation via
 [PredictRequest.parameters][google.cloud.aiplatform.v1.PredictRequest.parameters],
 [ExplainRequest.parameters][google.cloud.aiplatform.v1.ExplainRequest.parameters]
 and
 [BatchPredictionJob.model_parameters][google.cloud.aiplatform.v1.BatchPredictionJob.model_parameters].
 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).
 AutoML Models always have this field populated by Vertex AI, if no
 parameters are supported, then it is set to an empty string.
 Note: The URI given on output will be immutable and probably different,
 including the URI scheme, than the one given on input. The output URI will
 point to a location where the user only has a read access.
        string parameters_schema_uri = 2 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getParametersSchemaUri in interface PredictSchemataOrBuilder
        Returns:
        The parametersSchemaUri.

      • getParametersSchemaUriBytes

        public com.google.protobuf.ByteString getParametersSchemaUriBytes()
         Immutable. Points to a YAML file stored on Google Cloud Storage describing
 the parameters of prediction and explanation via
 [PredictRequest.parameters][google.cloud.aiplatform.v1.PredictRequest.parameters],
 [ExplainRequest.parameters][google.cloud.aiplatform.v1.ExplainRequest.parameters]
 and
 [BatchPredictionJob.model_parameters][google.cloud.aiplatform.v1.BatchPredictionJob.model_parameters].
 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).
 AutoML Models always have this field populated by Vertex AI, if no
 parameters are supported, then it is set to an empty string.
 Note: The URI given on output will be immutable and probably different,
 including the URI scheme, than the one given on input. The output URI will
 point to a location where the user only has a read access.
        string parameters_schema_uri = 2 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getParametersSchemaUriBytes in interface PredictSchemataOrBuilder
        Returns:
        The bytes for parametersSchemaUri.

      • setParametersSchemaUri

        public PredictSchemata.Builder setParametersSchemaUri​(String value)
         Immutable. Points to a YAML file stored on Google Cloud Storage describing
 the parameters of prediction and explanation via
 [PredictRequest.parameters][google.cloud.aiplatform.v1.PredictRequest.parameters],
 [ExplainRequest.parameters][google.cloud.aiplatform.v1.ExplainRequest.parameters]
 and
 [BatchPredictionJob.model_parameters][google.cloud.aiplatform.v1.BatchPredictionJob.model_parameters].
 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).
 AutoML Models always have this field populated by Vertex AI, if no
 parameters are supported, then it is set to an empty string.
 Note: The URI given on output will be immutable and probably different,
 including the URI scheme, than the one given on input. The output URI will
 point to a location where the user only has a read access.
        string parameters_schema_uri = 2 [(.google.api.field_behavior) = IMMUTABLE];
        Parameters:
        value - The parametersSchemaUri to set.
        Returns:
        This builder for chaining.

      • clearParametersSchemaUri

        public PredictSchemata.Builder clearParametersSchemaUri()
         Immutable. Points to a YAML file stored on Google Cloud Storage describing
 the parameters of prediction and explanation via
 [PredictRequest.parameters][google.cloud.aiplatform.v1.PredictRequest.parameters],
 [ExplainRequest.parameters][google.cloud.aiplatform.v1.ExplainRequest.parameters]
 and
 [BatchPredictionJob.model_parameters][google.cloud.aiplatform.v1.BatchPredictionJob.model_parameters].
 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).
 AutoML Models always have this field populated by Vertex AI, if no
 parameters are supported, then it is set to an empty string.
 Note: The URI given on output will be immutable and probably different,
 including the URI scheme, than the one given on input. The output URI will
 point to a location where the user only has a read access.
        string parameters_schema_uri = 2 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        This builder for chaining.

      • setParametersSchemaUriBytes

        public PredictSchemata.Builder setParametersSchemaUriBytes​(com.google.protobuf.ByteString value)
         Immutable. Points to a YAML file stored on Google Cloud Storage describing
 the parameters of prediction and explanation via
 [PredictRequest.parameters][google.cloud.aiplatform.v1.PredictRequest.parameters],
 [ExplainRequest.parameters][google.cloud.aiplatform.v1.ExplainRequest.parameters]
 and
 [BatchPredictionJob.model_parameters][google.cloud.aiplatform.v1.BatchPredictionJob.model_parameters].
 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).
 AutoML Models always have this field populated by Vertex AI, if no
 parameters are supported, then it is set to an empty string.
 Note: The URI given on output will be immutable and probably different,
 including the URI scheme, than the one given on input. The output URI will
 point to a location where the user only has a read access.
        string parameters_schema_uri = 2 [(.google.api.field_behavior) = IMMUTABLE];
        Parameters:
        value - The bytes for parametersSchemaUri to set.
        Returns:
        This builder for chaining.

      • getPredictionSchemaUri

        public String getPredictionSchemaUri()
         Immutable. Points to a YAML file stored on Google Cloud Storage describing
 the format of a single prediction produced by this Model, which are
 returned via
 [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions],
 [ExplainResponse.explanations][google.cloud.aiplatform.v1.ExplainResponse.explanations],
 and
 [BatchPredictionJob.output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config].
 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).
 AutoML Models always have this field populated by Vertex AI.
 Note: The URI given on output will be immutable and probably different,
 including the URI scheme, than the one given on input. The output URI will
 point to a location where the user only has a read access.
        string prediction_schema_uri = 3 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getPredictionSchemaUri in interface PredictSchemataOrBuilder
        Returns:
        The predictionSchemaUri.

      • getPredictionSchemaUriBytes

        public com.google.protobuf.ByteString getPredictionSchemaUriBytes()
         Immutable. Points to a YAML file stored on Google Cloud Storage describing
 the format of a single prediction produced by this Model, which are
 returned via
 [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions],
 [ExplainResponse.explanations][google.cloud.aiplatform.v1.ExplainResponse.explanations],
 and
 [BatchPredictionJob.output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config].
 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).
 AutoML Models always have this field populated by Vertex AI.
 Note: The URI given on output will be immutable and probably different,
 including the URI scheme, than the one given on input. The output URI will
 point to a location where the user only has a read access.
        string prediction_schema_uri = 3 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getPredictionSchemaUriBytes in interface PredictSchemataOrBuilder
        Returns:
        The bytes for predictionSchemaUri.

      • setPredictionSchemaUri

        public PredictSchemata.Builder setPredictionSchemaUri​(String value)
         Immutable. Points to a YAML file stored on Google Cloud Storage describing
 the format of a single prediction produced by this Model, which are
 returned via
 [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions],
 [ExplainResponse.explanations][google.cloud.aiplatform.v1.ExplainResponse.explanations],
 and
 [BatchPredictionJob.output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config].
 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).
 AutoML Models always have this field populated by Vertex AI.
 Note: The URI given on output will be immutable and probably different,
 including the URI scheme, than the one given on input. The output URI will
 point to a location where the user only has a read access.
        string prediction_schema_uri = 3 [(.google.api.field_behavior) = IMMUTABLE];
        Parameters:
        value - The predictionSchemaUri to set.
        Returns:
        This builder for chaining.

      • clearPredictionSchemaUri

        public PredictSchemata.Builder clearPredictionSchemaUri()
         Immutable. Points to a YAML file stored on Google Cloud Storage describing
 the format of a single prediction produced by this Model, which are
 returned via
 [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions],
 [ExplainResponse.explanations][google.cloud.aiplatform.v1.ExplainResponse.explanations],
 and
 [BatchPredictionJob.output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config].
 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).
 AutoML Models always have this field populated by Vertex AI.
 Note: The URI given on output will be immutable and probably different,
 including the URI scheme, than the one given on input. The output URI will
 point to a location where the user only has a read access.
        string prediction_schema_uri = 3 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        This builder for chaining.

      • setPredictionSchemaUriBytes

        public PredictSchemata.Builder setPredictionSchemaUriBytes​(com.google.protobuf.ByteString value)
         Immutable. Points to a YAML file stored on Google Cloud Storage describing
 the format of a single prediction produced by this Model, which are
 returned via
 [PredictResponse.predictions][google.cloud.aiplatform.v1.PredictResponse.predictions],
 [ExplainResponse.explanations][google.cloud.aiplatform.v1.ExplainResponse.explanations],
 and
 [BatchPredictionJob.output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config].
 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).
 AutoML Models always have this field populated by Vertex AI.
 Note: The URI given on output will be immutable and probably different,
 including the URI scheme, than the one given on input. The output URI will
 point to a location where the user only has a read access.
        string prediction_schema_uri = 3 [(.google.api.field_behavior) = IMMUTABLE];
        Parameters:
        value - The bytes for predictionSchemaUri to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

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

      • mergeUnknownFields

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