Class CaptureLimitsConfig

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

Guardrails that prevent instrumentation from impacting application performance by limiting how much data is captured.

See Also:

  • Method Details

    • maxHits

      public final Integer maxHits()

      The maximum number of times the instrumentation point can be hit before it is automatically disabled. Defaults to 100.

      Returns:
      The maximum number of times the instrumentation point can be hit before it is automatically disabled. Defaults to 100.

    • maxStringLength

      public final Integer maxStringLength()

      The maximum length of captured string values in characters. Strings longer than this are truncated. Defaults to 128.

      Returns:
      The maximum length of captured string values in characters. Strings longer than this are truncated. Defaults to 128.

    • maxCollectionWidth

      public final Integer maxCollectionWidth()

      The maximum number of items to capture from any collection to prevent large payloads. Defaults to 10.

      Returns:
      The maximum number of items to capture from any collection to prevent large payloads. Defaults to 10.

    • maxCollectionDepth

      public final Integer maxCollectionDepth()

      The maximum nesting depth to traverse inside collections. Defaults to 3.

      Returns:
      The maximum nesting depth to traverse inside collections. Defaults to 3.

    • maxStackFrames

      public final Integer maxStackFrames()

      The maximum number of stack frames to capture in stack traces. Defaults to 2.

      Returns:
      The maximum number of stack frames to capture in stack traces. Defaults to 2.

    • maxStackTraceSize

      public final Integer maxStackTraceSize()

      The maximum total size, in bytes, of a captured stack trace. Defaults to 1000.

      Returns:
      The maximum total size, in bytes, of a captured stack trace. Defaults to 1000.

    • maxObjectDepth

      public final Integer maxObjectDepth()

      The maximum depth for nested object traversal when capturing structured data. Defaults to 3.

      Returns:
      The maximum depth for nested object traversal when capturing structured data. Defaults to 3.

    • maxFieldsPerObject

      public final Integer maxFieldsPerObject()

      The maximum number of fields to capture for any object. Defaults to 10.

      Returns:
      The maximum number of fields to capture for any object. Defaults to 10.

    • toBuilder

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

    • builder

      public static CaptureLimitsConfig.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

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