Class CodeCaptureConfiguration

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

Defines what data to capture for code-level instrumentation, including arguments, return values, stack traces, local variables, and safety limits.

See Also:

  • Method Details

    • hasCaptureArguments

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

    • captureArguments

      public final List<String> captureArguments()

      The function arguments to capture. Omit to capture defaults, use an empty list to capture none, use ["*"] to capture all arguments, or specify argument names to capture selectively (up to 10 entries).

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

      Returns:
      The function arguments to capture. Omit to capture defaults, use an empty list to capture none, use ["*"] to capture all arguments, or specify argument names to capture selectively (up to 10 entries).

    • captureReturn

      public final Boolean captureReturn()

      Whether to capture the return value. Defaults to false.

      Returns:
      Whether to capture the return value. Defaults to false.

    • captureStackTrace

      public final Boolean captureStackTrace()

      Whether to capture a stack trace when the instrumentation point is hit. Defaults to true.

      Returns:
      Whether to capture a stack trace when the instrumentation point is hit. Defaults to true.

    • hasCaptureLocals

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

    • captureLocals

      public final List<String> captureLocals()

      The local variables to capture by name. Omit or pass an empty list to capture none. You can specify up to 20 names.

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

      Returns:
      The local variables to capture by name. Omit or pass an empty list to capture none. You can specify up to 20 names.

    • captureLimits

      public final CaptureLimitsConfig captureLimits()

      Safety limits that bound what is captured, including hit counts, string length, collection depth, and stack trace size.

      Returns:
      Safety limits that bound what is captured, including hit counts, string length, collection depth, and stack trace size.

    • toBuilder

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

    • builder

      public static CodeCaptureConfiguration.Builder builder()

    • serializableBuilderClass

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