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

Class DataCaptureConfig

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

Configuration to control how SageMaker captures inference data.

See Also:

  • Method Details

    • enableCapture

      public final Boolean enableCapture()

      Whether data capture should be enabled or disabled (defaults to enabled).

      Returns:
      Whether data capture should be enabled or disabled (defaults to enabled).

    • initialSamplingPercentage

      public final Integer initialSamplingPercentage()

      The percentage of requests SageMaker will capture. A lower value is recommended for Endpoints with high traffic.

      Returns:
      The percentage of requests SageMaker will capture. A lower value is recommended for Endpoints with high traffic.

    • destinationS3Uri

      public final String destinationS3Uri()

      The Amazon S3 location used to capture the data.

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

    • kmsKeyId

      public final String kmsKeyId()

      The Amazon Resource Name (ARN) of an Key Management Service key that SageMaker uses to encrypt the captured data at rest using Amazon S3 server-side encryption.

      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 an Key Management Service key that SageMaker uses to encrypt the captured data at rest using Amazon S3 server-side encryption.

      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

    • hasCaptureOptions

      public final boolean hasCaptureOptions()
      For responses, this returns true if the service returned a value for the CaptureOptions 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.

    • captureOptions

      public final List<CaptureOption> captureOptions()

      Specifies data Model Monitor will capture. You can configure whether to collect only input, only output, or both

      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 hasCaptureOptions() method.

      Returns:
      Specifies data Model Monitor will capture. You can configure whether to collect only input, only output, or both

    • captureContentTypeHeader

      public final CaptureContentTypeHeader captureContentTypeHeader()

      Configuration specifying how to treat different headers. If no headers are specified SageMaker will by default base64 encode when capturing the data.

      Returns:
      Configuration specifying how to treat different headers. If no headers are specified SageMaker will by default base64 encode when capturing the data.

    • toBuilder

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

    • builder

      public static DataCaptureConfig.Builder builder()

    • serializableBuilderClass

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