Class TelemetryRule

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

Defines how telemetry should be configured for specific Amazon Web Services resources.

See Also:

  • Method Details

    • resourceType

      public final ResourceType resourceType()

      The type of Amazon Web Services resource to configure telemetry for (e.g., "AWS::EC2::VPC", "AWS::EKS::Cluster", "AWS::WAFv2::WebACL").

      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 Amazon Web Services resource to configure telemetry for (e.g., "AWS::EC2::VPC", "AWS::EKS::Cluster", "AWS::WAFv2::WebACL").
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The type of Amazon Web Services resource to configure telemetry for (e.g., "AWS::EC2::VPC", "AWS::EKS::Cluster", "AWS::WAFv2::WebACL").

      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 Amazon Web Services resource to configure telemetry for (e.g., "AWS::EC2::VPC", "AWS::EKS::Cluster", "AWS::WAFv2::WebACL").
      See Also:

    • telemetryType

      public final TelemetryType telemetryType()

      The type of telemetry to collect (Logs, Metrics, or Traces).

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

      Returns:
      The type of telemetry to collect (Logs, Metrics, or Traces).
      See Also:

    • telemetryTypeAsString

      public final String telemetryTypeAsString()

      The type of telemetry to collect (Logs, Metrics, or Traces).

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

      Returns:
      The type of telemetry to collect (Logs, Metrics, or Traces).
      See Also:

    • telemetrySourceTypes

      public final List<TelemetrySourceType> telemetrySourceTypes()

      The specific telemetry source types to configure for the resource, such as VPC_FLOW_LOGS or EKS_AUDIT_LOGS. TelemetrySourceTypes must be correlated with the specific resource type.

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

      Returns:
      The specific telemetry source types to configure for the resource, such as VPC_FLOW_LOGS or EKS_AUDIT_LOGS. TelemetrySourceTypes must be correlated with the specific resource type.

    • hasTelemetrySourceTypes

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

    • telemetrySourceTypesAsStrings

      public final List<String> telemetrySourceTypesAsStrings()

      The specific telemetry source types to configure for the resource, such as VPC_FLOW_LOGS or EKS_AUDIT_LOGS. TelemetrySourceTypes must be correlated with the specific resource type.

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

      Returns:
      The specific telemetry source types to configure for the resource, such as VPC_FLOW_LOGS or EKS_AUDIT_LOGS. TelemetrySourceTypes must be correlated with the specific resource type.

    • destinationConfiguration

      public final TelemetryDestinationConfiguration destinationConfiguration()

      Configuration specifying where and how the telemetry data should be delivered.

      Returns:
      Configuration specifying where and how the telemetry data should be delivered.

    • scope

      public final String scope()

      The organizational scope to which the rule applies, specified using accounts or organizational units.

      Returns:
      The organizational scope to which the rule applies, specified using accounts or organizational units.

    • selectionCriteria

      public final String selectionCriteria()

      Criteria for selecting which resources the rule applies to, such as resource tags.

      Returns:
      Criteria for selecting which resources the rule applies to, such as resource tags.

    • toBuilder

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

    • builder

      public static TelemetryRule.Builder builder()

    • serializableBuilderClass

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