Class CreateBatchInferenceJobRequest

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

  • Method Details

    • jobName

      public final String jobName()

      The name of the batch inference job to create.

      Returns:
      The name of the batch inference job to create.

    • solutionVersionArn

      public final String solutionVersionArn()

      The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.

      Returns:
      The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.

    • filterArn

      public final String filterArn()

      The ARN of the filter to apply to the batch inference job. For more information on using filters, see Filtering batch recommendations.

      Returns:
      The ARN of the filter to apply to the batch inference job. For more information on using filters, see Filtering batch recommendations.

    • numResults

      public final Integer numResults()

      The number of recommendations to retrieve.

      Returns:
      The number of recommendations to retrieve.

    • jobInput

      public final BatchInferenceJobInput jobInput()

      The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.

      Returns:
      The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.

    • jobOutput

      public final BatchInferenceJobOutput jobOutput()

      The path to the Amazon S3 bucket where the job's output will be stored.

      Returns:
      The path to the Amazon S3 bucket where the job's output will be stored.

    • roleArn

      public final String roleArn()

      The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.

      Returns:
      The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.

    • batchInferenceJobConfig

      public final BatchInferenceJobConfig batchInferenceJobConfig()

      The configuration details of a batch inference job.

      Returns:
      The configuration details of a batch inference job.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      A list of tags to apply to the batch inference job.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      A list of tags to apply to the batch inference job.

    • batchInferenceJobMode

      public final BatchInferenceJobMode batchInferenceJobMode()

      The mode of the batch inference job. To generate descriptive themes for groups of similar items, set the job mode to THEME_GENERATION. If you don't want to generate themes, use the default BATCH_INFERENCE.

      When you get batch recommendations with themes, you will incur additional costs. For more information, see Amazon Personalize pricing.

      If the service returns an enum value that is not available in the current SDK version, batchInferenceJobMode will return BatchInferenceJobMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from batchInferenceJobModeAsString().

      Returns:
      The mode of the batch inference job. To generate descriptive themes for groups of similar items, set the job mode to THEME_GENERATION. If you don't want to generate themes, use the default BATCH_INFERENCE.

      When you get batch recommendations with themes, you will incur additional costs. For more information, see Amazon Personalize pricing.

      See Also:

    • batchInferenceJobModeAsString

      public final String batchInferenceJobModeAsString()

      The mode of the batch inference job. To generate descriptive themes for groups of similar items, set the job mode to THEME_GENERATION. If you don't want to generate themes, use the default BATCH_INFERENCE.

      When you get batch recommendations with themes, you will incur additional costs. For more information, see Amazon Personalize pricing.

      If the service returns an enum value that is not available in the current SDK version, batchInferenceJobMode will return BatchInferenceJobMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from batchInferenceJobModeAsString().

      Returns:
      The mode of the batch inference job. To generate descriptive themes for groups of similar items, set the job mode to THEME_GENERATION. If you don't want to generate themes, use the default BATCH_INFERENCE.

      When you get batch recommendations with themes, you will incur additional costs. For more information, see Amazon Personalize pricing.

      See Also:

    • themeGenerationConfig

      public final ThemeGenerationConfig themeGenerationConfig()

      For theme generation jobs, specify the name of the column in your Items dataset that contains each item's name.

      Returns:
      For theme generation jobs, specify the name of the column in your Items dataset that contains each item's name.

    • toBuilder

      public CreateBatchInferenceJobRequest.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<CreateBatchInferenceJobRequest.Builder,CreateBatchInferenceJobRequest>
      Specified by:
      toBuilder in class PersonalizeRequest
      Returns:
      a builder for type T

    • builder

      public static CreateBatchInferenceJobRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateBatchInferenceJobRequest.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.