Class DeliverySourceConfigurationSchema

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

A structure that describes a single configuration for a log type, including its name, value type, default value, and the range of supported values.

See Also:

  • Method Details

    • keyName

      public final String keyName()

      The name of the configuration.

      Returns:
      The name of the configuration.

    • valueType

      public final DeliverySourceConfigurationSchemaValueType valueType()

      The data type of the configuration value. Valid values are string, boolean, int, double, and long.

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

      Returns:
      The data type of the configuration value. Valid values are string, boolean, int, double, and long.
      See Also:

    • valueTypeAsString

      public final String valueTypeAsString()

      The data type of the configuration value. Valid values are string, boolean, int, double, and long.

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

      Returns:
      The data type of the configuration value. Valid values are string, boolean, int, double, and long.
      See Also:

    • defaultValue

      public final String defaultValue()

      The default value of the configuration that is used when a value is not specified in a PutDeliverySource request.

      Returns:
      The default value of the configuration that is used when a value is not specified in a PutDeliverySource request.

    • hasSupportedValues

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

    • supportedValues

      public final List<String> supportedValues()

      The list of allowed values for the configuration. Empty for free-form configuration.

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

      Returns:
      The list of allowed values for the configuration. Empty for free-form configuration.

    • minValue

      public final Double minValue()

      The minimum numeric value allowed for the configuration. This applies only when the valueType is a numeric type.

      Returns:
      The minimum numeric value allowed for the configuration. This applies only when the valueType is a numeric type.

    • maxValue

      public final Double maxValue()

      The maximum numeric value allowed for the configuration. This applies only when the valueType is a numeric type.

      Returns:
      The maximum numeric value allowed for the configuration. This applies only when the valueType is a numeric type.

    • toBuilder

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

    • builder

      public static DeliverySourceConfigurationSchema.Builder builder()

    • serializableBuilderClass

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