Package software.amazon.awssdk.services.sagemaker.model

Class BatchDataCaptureConfig

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.BatchDataCaptureConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<BatchDataCaptureConfig.Builder,BatchDataCaptureConfig>
@Generated("software.amazon.awssdk:codegen") public final class BatchDataCaptureConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<BatchDataCaptureConfig.Builder,BatchDataCaptureConfig>

Configuration to control how SageMaker captures inference data for batch transform jobs.

See Also:

  • Method Details

    • destinationS3Uri

      public final String destinationS3Uri()

      The Amazon S3 location being used to capture the data.

      Returns:
      The Amazon S3 location being used to capture the data.

    • kmsKeyId

      public final String kmsKeyId()

      The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the batch transform job.

      The KmsKeyId can be any of the following formats:

      • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

      • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

      • Alias name: alias/ExampleAlias

      • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

      Returns:
      The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the batch transform job.

      The KmsKeyId can be any of the following formats:

      • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

      • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

      • Alias name: alias/ExampleAlias

      • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

    • generateInferenceId

      public final Boolean generateInferenceId()

      Flag that indicates whether to append inference id to the output.

      Returns:
      Flag that indicates whether to append inference id to the output.

    • toBuilder

      public BatchDataCaptureConfig.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<BatchDataCaptureConfig.Builder,BatchDataCaptureConfig>
      Returns:
      a builder for type T

    • builder

      public static BatchDataCaptureConfig.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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