Package com.google.cloud.automl.v1

Class PredictRequest

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    PredictRequest.Builder
    Request message for [PredictionService.Predict][google.cloud.automl.v1.PredictionService.Predict].

    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
    NAME_FIELD_NUMBER
     
    static final int
    PARAMS_FIELD_NUMBER
     
    static final int
    PAYLOAD_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
    containsParams(String key)
    Additional domain-specific parameters, any string must be up to 25000 characters long.
    boolean
    equals(Object obj)
     
    static PredictRequest
    getDefaultInstance()
     
    PredictRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getName()
    Required.
    com.google.protobuf.ByteString
    getNameBytes()
    Required.
    Map<String,String>
    getParams()
    Deprecated.
    int
    getParamsCount()
    Additional domain-specific parameters, any string must be up to 25000 characters long.
    Map<String,String>
    getParamsMap()
    Additional domain-specific parameters, any string must be up to 25000 characters long.
    String
    getParamsOrDefault(String key, String defaultValue)
    Additional domain-specific parameters, any string must be up to 25000 characters long.
    String
    getParamsOrThrow(String key)
    Additional domain-specific parameters, any string must be up to 25000 characters long.
    com.google.protobuf.Parser<PredictRequest>
    getParserForType()
     
    ExamplePayload
    getPayload()
    Required.
    ExamplePayloadOrBuilder
    getPayloadOrBuilder()
    Required.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasPayload()
    Required.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapFieldReflectionAccessor
    internalGetMapFieldReflection(int number)
     
    final boolean
    isInitialized()
     
    static PredictRequest.Builder
    newBuilder()
     
    static PredictRequest.Builder
    newBuilder(PredictRequest prototype)
     
    PredictRequest.Builder
    newBuilderForType()
     
    protected PredictRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static PredictRequest
    parseDelimitedFrom(InputStream input)
     
    static PredictRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PredictRequest
    parseFrom(byte[] data)
     
    static PredictRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PredictRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static PredictRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PredictRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static PredictRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PredictRequest
    parseFrom(InputStream input)
     
    static PredictRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PredictRequest
    parseFrom(ByteBuffer data)
     
    static PredictRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<PredictRequest>
    parser()
     
    PredictRequest.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, 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()

    • 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()
       Required. Name of the model requested to serve the prediction.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getName in interface PredictRequestOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Required. Name of the model requested to serve the prediction.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getNameBytes in interface PredictRequestOrBuilder
      Returns:
      The bytes for name.

    • hasPayload

      public boolean hasPayload()
       Required. Payload to perform a prediction on. The payload must match the
 problem type that the model was trained to solve.
      .google.cloud.automl.v1.ExamplePayload payload = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasPayload in interface PredictRequestOrBuilder
      Returns:
      Whether the payload field is set.

    • getPayload

      public ExamplePayload getPayload()
       Required. Payload to perform a prediction on. The payload must match the
 problem type that the model was trained to solve.
      .google.cloud.automl.v1.ExamplePayload payload = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPayload in interface PredictRequestOrBuilder
      Returns:
      The payload.

    • getPayloadOrBuilder

      public ExamplePayloadOrBuilder getPayloadOrBuilder()
       Required. Payload to perform a prediction on. The payload must match the
 problem type that the model was trained to solve.
      .google.cloud.automl.v1.ExamplePayload payload = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPayloadOrBuilder in interface PredictRequestOrBuilder

    • getParamsCount

      public int getParamsCount()
      Description copied from interface: PredictRequestOrBuilder
       Additional domain-specific parameters, any string must be up to 25000
 characters long.

 AutoML Vision Classification

 `score_threshold`
 : (float) A value from 0.0 to 1.0. When the model
 makes predictions for an image, it will only produce results that have
 at least this confidence score. The default is 0.5.

 AutoML Vision Object Detection

 `score_threshold`
 : (float) When Model detects objects on the image,
 it will only produce bounding boxes which have at least this
 confidence score. Value in 0 to 1 range, default is 0.5.

 `max_bounding_box_count`
 : (int64) The maximum number of bounding
 boxes returned. The default is 100. The
 number of returned bounding boxes might be limited by the server.

 AutoML Tables

 `feature_importance`
 : (boolean) Whether
 [feature_importance][google.cloud.automl.v1.TablesModelColumnInfo.feature_importance]
 is populated in the returned list of
 [TablesAnnotation][google.cloud.automl.v1.TablesAnnotation]
 objects. The default is false.
      map<string, string> params = 3;
      Specified by:
      getParamsCount in interface PredictRequestOrBuilder

    • containsParams

      public boolean containsParams(String key)
       Additional domain-specific parameters, any string must be up to 25000
 characters long.

 AutoML Vision Classification

 `score_threshold`
 : (float) A value from 0.0 to 1.0. When the model
 makes predictions for an image, it will only produce results that have
 at least this confidence score. The default is 0.5.

 AutoML Vision Object Detection

 `score_threshold`
 : (float) When Model detects objects on the image,
 it will only produce bounding boxes which have at least this
 confidence score. Value in 0 to 1 range, default is 0.5.

 `max_bounding_box_count`
 : (int64) The maximum number of bounding
 boxes returned. The default is 100. The
 number of returned bounding boxes might be limited by the server.

 AutoML Tables

 `feature_importance`
 : (boolean) Whether
 [feature_importance][google.cloud.automl.v1.TablesModelColumnInfo.feature_importance]
 is populated in the returned list of
 [TablesAnnotation][google.cloud.automl.v1.TablesAnnotation]
 objects. The default is false.
      map<string, string> params = 3;
      Specified by:
      containsParams in interface PredictRequestOrBuilder

    • getParams

      @Deprecated public Map<String,String> getParams()
      Deprecated.
      Use getParamsMap() instead.
      Specified by:
      getParams in interface PredictRequestOrBuilder

    • getParamsMap

      public Map<String,String> getParamsMap()
       Additional domain-specific parameters, any string must be up to 25000
 characters long.

 AutoML Vision Classification

 `score_threshold`
 : (float) A value from 0.0 to 1.0. When the model
 makes predictions for an image, it will only produce results that have
 at least this confidence score. The default is 0.5.

 AutoML Vision Object Detection

 `score_threshold`
 : (float) When Model detects objects on the image,
 it will only produce bounding boxes which have at least this
 confidence score. Value in 0 to 1 range, default is 0.5.

 `max_bounding_box_count`
 : (int64) The maximum number of bounding
 boxes returned. The default is 100. The
 number of returned bounding boxes might be limited by the server.

 AutoML Tables

 `feature_importance`
 : (boolean) Whether
 [feature_importance][google.cloud.automl.v1.TablesModelColumnInfo.feature_importance]
 is populated in the returned list of
 [TablesAnnotation][google.cloud.automl.v1.TablesAnnotation]
 objects. The default is false.
      map<string, string> params = 3;
      Specified by:
      getParamsMap in interface PredictRequestOrBuilder

    • getParamsOrDefault

      public String getParamsOrDefault(String key, String defaultValue)
       Additional domain-specific parameters, any string must be up to 25000
 characters long.

 AutoML Vision Classification

 `score_threshold`
 : (float) A value from 0.0 to 1.0. When the model
 makes predictions for an image, it will only produce results that have
 at least this confidence score. The default is 0.5.

 AutoML Vision Object Detection

 `score_threshold`
 : (float) When Model detects objects on the image,
 it will only produce bounding boxes which have at least this
 confidence score. Value in 0 to 1 range, default is 0.5.

 `max_bounding_box_count`
 : (int64) The maximum number of bounding
 boxes returned. The default is 100. The
 number of returned bounding boxes might be limited by the server.

 AutoML Tables

 `feature_importance`
 : (boolean) Whether
 [feature_importance][google.cloud.automl.v1.TablesModelColumnInfo.feature_importance]
 is populated in the returned list of
 [TablesAnnotation][google.cloud.automl.v1.TablesAnnotation]
 objects. The default is false.
      map<string, string> params = 3;
      Specified by:
      getParamsOrDefault in interface PredictRequestOrBuilder

    • getParamsOrThrow

      public String getParamsOrThrow(String key)
       Additional domain-specific parameters, any string must be up to 25000
 characters long.

 AutoML Vision Classification

 `score_threshold`
 : (float) A value from 0.0 to 1.0. When the model
 makes predictions for an image, it will only produce results that have
 at least this confidence score. The default is 0.5.

 AutoML Vision Object Detection

 `score_threshold`
 : (float) When Model detects objects on the image,
 it will only produce bounding boxes which have at least this
 confidence score. Value in 0 to 1 range, default is 0.5.

 `max_bounding_box_count`
 : (int64) The maximum number of bounding
 boxes returned. The default is 100. The
 number of returned bounding boxes might be limited by the server.

 AutoML Tables

 `feature_importance`
 : (boolean) Whether
 [feature_importance][google.cloud.automl.v1.TablesModelColumnInfo.feature_importance]
 is populated in the returned list of
 [TablesAnnotation][google.cloud.automl.v1.TablesAnnotation]
 objects. The default is false.
      map<string, string> params = 3;
      Specified by:
      getParamsOrThrow in interface PredictRequestOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static PredictRequest.Builder newBuilder()

    • newBuilder

      public static PredictRequest.Builder newBuilder(PredictRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static PredictRequest getDefaultInstance()

    • parser

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

    • getParserForType

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