Class ObservabilityConfiguration

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

Describes an App Runner observability configuration resource. Multiple revisions of a configuration have the same ObservabilityConfigurationName and different ObservabilityConfigurationRevision values.

The resource is designed to configure multiple features (currently one feature, tracing). This type contains optional members that describe the configuration of these features (currently one member, TraceConfiguration). If a feature member isn't specified, the feature isn't enabled.

See Also:

  • Method Details

    • observabilityConfigurationArn

      public final String observabilityConfigurationArn()

      The Amazon Resource Name (ARN) of this observability configuration.

      Returns:
      The Amazon Resource Name (ARN) of this observability configuration.

    • observabilityConfigurationName

      public final String observabilityConfigurationName()

      The customer-provided observability configuration name. It can be used in multiple revisions of a configuration.

      Returns:
      The customer-provided observability configuration name. It can be used in multiple revisions of a configuration.

    • traceConfiguration

      public final TraceConfiguration traceConfiguration()

      The configuration of the tracing feature within this observability configuration. If not specified, tracing isn't enabled.

      Returns:
      The configuration of the tracing feature within this observability configuration. If not specified, tracing isn't enabled.

    • observabilityConfigurationRevision

      public final Integer observabilityConfigurationRevision()

      The revision of this observability configuration. It's unique among all the active configurations ( "Status": "ACTIVE") that share the same ObservabilityConfigurationName.

      Returns:
      The revision of this observability configuration. It's unique among all the active configurations ( "Status": "ACTIVE") that share the same ObservabilityConfigurationName.

    • latest

      public final Boolean latest()

      It's set to true for the configuration with the highest Revision among all configurations that share the same ObservabilityConfigurationName. It's set to false otherwise.

      Returns:
      It's set to true for the configuration with the highest Revision among all configurations that share the same ObservabilityConfigurationName. It's set to false otherwise.

    • status

      public final ObservabilityConfigurationStatus status()

      The current state of the observability configuration. If the status of a configuration revision is INACTIVE, it was deleted and can't be used. Inactive configuration revisions are permanently removed some time after they are deleted.

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

      Returns:
      The current state of the observability configuration. If the status of a configuration revision is INACTIVE, it was deleted and can't be used. Inactive configuration revisions are permanently removed some time after they are deleted.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current state of the observability configuration. If the status of a configuration revision is INACTIVE, it was deleted and can't be used. Inactive configuration revisions are permanently removed some time after they are deleted.

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

      Returns:
      The current state of the observability configuration. If the status of a configuration revision is INACTIVE, it was deleted and can't be used. Inactive configuration revisions are permanently removed some time after they are deleted.
      See Also:

    • createdAt

      public final Instant createdAt()

      The time when the observability configuration was created. It's in Unix time stamp format.

      Returns:
      The time when the observability configuration was created. It's in Unix time stamp format.

    • deletedAt

      public final Instant deletedAt()

      The time when the observability configuration was deleted. It's in Unix time stamp format.

      Returns:
      The time when the observability configuration was deleted. It's in Unix time stamp format.

    • toBuilder

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

    • builder

      public static ObservabilityConfiguration.Builder builder()

    • serializableBuilderClass

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