Package com.google.cloud.aiplatform.v1

Class RawPredictRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.RawPredictRequest
All Implemented Interfaces:
RawPredictRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class RawPredictRequest extends com.google.protobuf.GeneratedMessage implements RawPredictRequestOrBuilder
 Request message for
 [PredictionService.RawPredict][google.cloud.aiplatform.v1.PredictionService.RawPredict].
Protobuf type google.cloud.aiplatform.v1.RawPredictRequest
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    RawPredictRequest.Builder
    Request message for [PredictionService.RawPredict][google.cloud.aiplatform.v1.PredictionService.RawPredict].

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ENDPOINT_FIELD_NUMBER
     
    static final int
    HTTP_BODY_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static RawPredictRequest
    getDefaultInstance()
     
    RawPredictRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getEndpoint()
    Required.
    com.google.protobuf.ByteString
    getEndpointBytes()
    Required.
    HttpBody
    getHttpBody()
    The prediction input.
    HttpBodyOrBuilder
    getHttpBodyOrBuilder()
    The prediction input.
    com.google.protobuf.Parser<RawPredictRequest>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasHttpBody()
    The prediction input.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static RawPredictRequest.Builder
    newBuilder()
     
    static RawPredictRequest.Builder
    newBuilder(RawPredictRequest prototype)
     
    RawPredictRequest.Builder
    newBuilderForType()
     
    protected RawPredictRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static RawPredictRequest
    parseDelimitedFrom(InputStream input)
     
    static RawPredictRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RawPredictRequest
    parseFrom(byte[] data)
     
    static RawPredictRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RawPredictRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static RawPredictRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RawPredictRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static RawPredictRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RawPredictRequest
    parseFrom(InputStream input)
     
    static RawPredictRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RawPredictRequest
    parseFrom(ByteBuffer data)
     
    static RawPredictRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<RawPredictRequest>
    parser()
     
    RawPredictRequest.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • getEndpoint

      public String getEndpoint()
       Required. The name of the Endpoint requested to serve the prediction.
 Format:
 `projects/{project}/locations/{location}/endpoints/{endpoint}`
      string endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getEndpoint in interface RawPredictRequestOrBuilder
      Returns:
      The endpoint.

    • getEndpointBytes

      public com.google.protobuf.ByteString getEndpointBytes()
       Required. The name of the Endpoint requested to serve the prediction.
 Format:
 `projects/{project}/locations/{location}/endpoints/{endpoint}`
      string endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getEndpointBytes in interface RawPredictRequestOrBuilder
      Returns:
      The bytes for endpoint.

    • hasHttpBody

      public boolean hasHttpBody()
       The prediction input. Supports HTTP headers and arbitrary data payload.

 A [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] may have an
 upper limit on the number of instances it supports per request. When this
 limit it is exceeded for an AutoML model, the
 [RawPredict][google.cloud.aiplatform.v1.PredictionService.RawPredict]
 method returns an error. When this limit is exceeded for a custom-trained
 model, the behavior varies depending on the model.

 You can specify the schema for each instance in the
 [predict_schemata.instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]
 field when you create a [Model][google.cloud.aiplatform.v1.Model]. This
 schema applies when you deploy the `Model` as a `DeployedModel` to an
 [Endpoint][google.cloud.aiplatform.v1.Endpoint] and use the `RawPredict`
 method.
      .google.api.HttpBody http_body = 2;
      Specified by:
      hasHttpBody in interface RawPredictRequestOrBuilder
      Returns:
      Whether the httpBody field is set.

    • getHttpBody

      public HttpBody getHttpBody()
       The prediction input. Supports HTTP headers and arbitrary data payload.

 A [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] may have an
 upper limit on the number of instances it supports per request. When this
 limit it is exceeded for an AutoML model, the
 [RawPredict][google.cloud.aiplatform.v1.PredictionService.RawPredict]
 method returns an error. When this limit is exceeded for a custom-trained
 model, the behavior varies depending on the model.

 You can specify the schema for each instance in the
 [predict_schemata.instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]
 field when you create a [Model][google.cloud.aiplatform.v1.Model]. This
 schema applies when you deploy the `Model` as a `DeployedModel` to an
 [Endpoint][google.cloud.aiplatform.v1.Endpoint] and use the `RawPredict`
 method.
      .google.api.HttpBody http_body = 2;
      Specified by:
      getHttpBody in interface RawPredictRequestOrBuilder
      Returns:
      The httpBody.

    • getHttpBodyOrBuilder

      public HttpBodyOrBuilder getHttpBodyOrBuilder()
       The prediction input. Supports HTTP headers and arbitrary data payload.

 A [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] may have an
 upper limit on the number of instances it supports per request. When this
 limit it is exceeded for an AutoML model, the
 [RawPredict][google.cloud.aiplatform.v1.PredictionService.RawPredict]
 method returns an error. When this limit is exceeded for a custom-trained
 model, the behavior varies depending on the model.

 You can specify the schema for each instance in the
 [predict_schemata.instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri]
 field when you create a [Model][google.cloud.aiplatform.v1.Model]. This
 schema applies when you deploy the `Model` as a `DeployedModel` to an
 [Endpoint][google.cloud.aiplatform.v1.Endpoint] and use the `RawPredict`
 method.
      .google.api.HttpBody http_body = 2;
      Specified by:
      getHttpBodyOrBuilder in interface RawPredictRequestOrBuilder

    • 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 RawPredictRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static RawPredictRequest.Builder newBuilder()

    • newBuilder

      public static RawPredictRequest.Builder newBuilder(RawPredictRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static RawPredictRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<RawPredictRequest> 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 RawPredictRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder