Package software.amazon.awssdk.services.machinelearning.model

Class CreateBatchPredictionRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.machinelearning.model.MachineLearningRequest
software.amazon.awssdk.services.machinelearning.model.CreateBatchPredictionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateBatchPredictionRequest.Builder,CreateBatchPredictionRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateBatchPredictionRequest extends MachineLearningRequest implements ToCopyableBuilder<CreateBatchPredictionRequest.Builder,CreateBatchPredictionRequest>

  • Method Details

    • batchPredictionId

      public final String batchPredictionId()

      A user-supplied ID that uniquely identifies the BatchPrediction.

      Returns:
      A user-supplied ID that uniquely identifies the BatchPrediction.

    • batchPredictionName

      public final String batchPredictionName()

      A user-supplied name or description of the BatchPrediction. BatchPredictionName can only use the UTF-8 character set.

      Returns:
      A user-supplied name or description of the BatchPrediction. BatchPredictionName can only use the UTF-8 character set.

    • mlModelId

      public final String mlModelId()

      The ID of the MLModel that will generate predictions for the group of observations.

      Returns:
      The ID of the MLModel that will generate predictions for the group of observations.

    • batchPredictionDataSourceId

      public final String batchPredictionDataSourceId()

      The ID of the DataSource that points to the group of observations to predict.

      Returns:
      The ID of the DataSource that points to the group of observations to predict.

    • outputUri

      public final String outputUri()

      The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the s3 key portion of the outputURI field: ':', '//', '/./', '/../'.

      Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the Amazon Machine Learning Developer Guide.

      Returns:
      The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the s3 key portion of the outputURI field: ':', '//', '/./', '/../'.

      Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the Amazon Machine Learning Developer Guide.

    • toBuilder

      public CreateBatchPredictionRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateBatchPredictionRequest.Builder,CreateBatchPredictionRequest>
      Specified by:
      toBuilder in class MachineLearningRequest
      Returns:
      a builder for type T

    • builder

      public static CreateBatchPredictionRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateBatchPredictionRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.