Package software.amazon.awssdk.services.personalize.model

Class CreateBatchInferenceJobRequest

    • Method Detail

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

      • 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:
        BatchInferenceJobMode

      • 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:
        BatchInferenceJobMode

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

      • 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