Class TelemetryConfiguration

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

A model representing the state of a resource within an account according to telemetry config.

See Also:

  • Method Details

    • accountIdentifier

      public final String accountIdentifier()

      The account ID which contains the resource managed in telemetry configuration. An example of a valid account ID is 012345678901.

      Returns:
      The account ID which contains the resource managed in telemetry configuration. An example of a valid account ID is 012345678901.

    • telemetryConfigurationState

      public final Map<TelemetryType,TelemetryState> telemetryConfigurationState()

      The configuration state for the resource, for example { Logs: NotApplicable; Metrics: Enabled; Traces: NotApplicable; }.

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

      Returns:
      The configuration state for the resource, for example { Logs: NotApplicable; Metrics: Enabled; Traces: NotApplicable; }.

    • hasTelemetryConfigurationState

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

    • telemetryConfigurationStateAsStrings

      public final Map<String,String> telemetryConfigurationStateAsStrings()

      The configuration state for the resource, for example { Logs: NotApplicable; Metrics: Enabled; Traces: NotApplicable; }.

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

      Returns:
      The configuration state for the resource, for example { Logs: NotApplicable; Metrics: Enabled; Traces: NotApplicable; }.

    • resourceType

      public final ResourceType resourceType()

      The type of resource, for example Amazon Web Services::EC2::Instance.

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

      Returns:
      The type of resource, for example Amazon Web Services::EC2::Instance.
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The type of resource, for example Amazon Web Services::EC2::Instance.

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

      Returns:
      The type of resource, for example Amazon Web Services::EC2::Instance.
      See Also:

    • resourceIdentifier

      public final String resourceIdentifier()

      The identifier of the resource, for example i-0b22a22eec53b9321.

      Returns:
      The identifier of the resource, for example i-0b22a22eec53b9321.

    • hasResourceTags

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

    • resourceTags

      public final Map<String,String> resourceTags()

      Tags associated with the resource, for example { Name: "ExampleInstance", Environment: "Development" }.

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

      Returns:
      Tags associated with the resource, for example { Name: "ExampleInstance", Environment: "Development" }.

    • lastUpdateTimeStamp

      public final Long lastUpdateTimeStamp()

      The timestamp of the last change to the telemetry configuration for the resource. For example, 1728679196318.

      Returns:
      The timestamp of the last change to the telemetry configuration for the resource. For example, 1728679196318.

    • toBuilder

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

    • builder

      public static TelemetryConfiguration.Builder builder()

    • serializableBuilderClass

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