Class InstrumentationConfiguration

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

The full instrumentation configuration, including the instrumentation type, service, environment, signal type, location details, stable location hash, capture settings, filters, expiration, creation time, and ARN.

See Also:

  • Method Details

    • instrumentationType

      public final InstrumentationType instrumentationType()

      The type of instrumentation for this configuration.

      If the service returns an enum value that is not available in the current SDK version, instrumentationType will return InstrumentationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instrumentationTypeAsString().

      Returns:
      The type of instrumentation for this configuration.
      See Also:

    • instrumentationTypeAsString

      public final String instrumentationTypeAsString()

      The type of instrumentation for this configuration.

      If the service returns an enum value that is not available in the current SDK version, instrumentationType will return InstrumentationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instrumentationTypeAsString().

      Returns:
      The type of instrumentation for this configuration.
      See Also:

    • service

      public final String service()

      The service that this instrumentation configuration targets.

      Returns:
      The service that this instrumentation configuration targets.

    • environment

      public final String environment()

      The environment where the service is running.

      Returns:
      The environment where the service is running.

    • signalType

      public final DynamicInstrumentationSignalType signalType()

      The telemetry signal type for this instrumentation configuration.

      If the service returns an enum value that is not available in the current SDK version, signalType will return DynamicInstrumentationSignalType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from signalTypeAsString().

      Returns:
      The telemetry signal type for this instrumentation configuration.
      See Also:

    • signalTypeAsString

      public final String signalTypeAsString()

      The telemetry signal type for this instrumentation configuration.

      If the service returns an enum value that is not available in the current SDK version, signalType will return DynamicInstrumentationSignalType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from signalTypeAsString().

      Returns:
      The telemetry signal type for this instrumentation configuration.
      See Also:

    • location

      public final Location location()

      The location where this instrumentation is applied.

      Returns:
      The location where this instrumentation is applied.

    • locationHash

      public final String locationHash()

      The stable hash derived from the location that uniquely identifies this instrumentation point within the service and environment.

      Returns:
      The stable hash derived from the location that uniquely identifies this instrumentation point within the service and environment.

    • description

      public final String description()

      An optional short description of the instrumentation configuration.

      Returns:
      An optional short description of the instrumentation configuration.

    • expiresAt

      public final Instant expiresAt()

      The timestamp when this configuration expires.

      Returns:
      The timestamp when this configuration expires.

    • hasAttributeFilters

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

    • attributeFilters

      public final List<Map<String,String>> attributeFilters()

      Client-side filters that determine which instances apply this instrumentation.

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

      Returns:
      Client-side filters that determine which instances apply this instrumentation.

    • captureConfiguration

      public final CaptureConfiguration captureConfiguration()

      The capture settings for this instrumentation configuration.

      Returns:
      The capture settings for this instrumentation configuration.

    • createdAt

      public final Instant createdAt()

      The timestamp when this instrumentation configuration was created.

      Returns:
      The timestamp when this instrumentation configuration was created.

    • arn

      public final String arn()

      ARN for the instrumentation configuration

      Returns:
      ARN for the instrumentation configuration

    • toBuilder

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

    • builder

      public static InstrumentationConfiguration.Builder builder()

    • serializableBuilderClass

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