Class ConfigurationTemplate

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

A structure containing information about the deafult settings and available settings that you can use to configure a delivery or a delivery destination.

See Also:

  • Method Details

    • service

      public final String service()

      A string specifying which service this configuration template applies to. For more information about supported services see Enable logging from Amazon Web Services services..

      Returns:
      A string specifying which service this configuration template applies to. For more information about supported services see Enable logging from Amazon Web Services services..

    • logType

      public final String logType()

      A string specifying which log type this configuration template applies to.

      Returns:
      A string specifying which log type this configuration template applies to.

    • resourceType

      public final String resourceType()

      A string specifying which resource type this configuration template applies to.

      Returns:
      A string specifying which resource type this configuration template applies to.

    • deliveryDestinationType

      public final DeliveryDestinationType deliveryDestinationType()

      A string specifying which destination type this configuration template applies to.

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

      Returns:
      A string specifying which destination type this configuration template applies to.
      See Also:

    • deliveryDestinationTypeAsString

      public final String deliveryDestinationTypeAsString()

      A string specifying which destination type this configuration template applies to.

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

      Returns:
      A string specifying which destination type this configuration template applies to.
      See Also:

    • defaultDeliveryConfigValues

      public final ConfigurationTemplateDeliveryConfigValues defaultDeliveryConfigValues()

      A mapping that displays the default value of each property within a delivery's configuration, if it is not specified in the request.

      Returns:
      A mapping that displays the default value of each property within a delivery's configuration, if it is not specified in the request.

    • hasAllowedFields

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

    • allowedFields

      public final List<RecordField> allowedFields()

      The allowed fields that a caller can use in the recordFields parameter of a CreateDelivery or UpdateDeliveryConfiguration operation.

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

      Returns:
      The allowed fields that a caller can use in the recordFields parameter of a CreateDelivery or UpdateDeliveryConfiguration operation.

    • allowedOutputFormats

      public final List<OutputFormat> allowedOutputFormats()

      The list of delivery destination output formats that are supported by this log source.

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

      Returns:
      The list of delivery destination output formats that are supported by this log source.

    • hasAllowedOutputFormats

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

    • allowedOutputFormatsAsStrings

      public final List<String> allowedOutputFormatsAsStrings()

      The list of delivery destination output formats that are supported by this log source.

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

      Returns:
      The list of delivery destination output formats that are supported by this log source.

    • allowedActionForAllowVendedLogsDeliveryForResource

      public final String allowedActionForAllowVendedLogsDeliveryForResource()

      The action permissions that a caller needs to have to be able to successfully create a delivery source on the desired resource type when calling PutDeliverySource.

      Returns:
      The action permissions that a caller needs to have to be able to successfully create a delivery source on the desired resource type when calling PutDeliverySource.

    • hasAllowedFieldDelimiters

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

    • allowedFieldDelimiters

      public final List<String> allowedFieldDelimiters()

      The valid values that a caller can use as field delimiters when calling CreateDelivery or UpdateDeliveryConfiguration on a delivery that delivers in Plain, W3C, or Raw format.

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

      Returns:
      The valid values that a caller can use as field delimiters when calling CreateDelivery or UpdateDeliveryConfiguration on a delivery that delivers in Plain, W3C, or Raw format.

    • hasAllowedSuffixPathFields

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

    • allowedSuffixPathFields

      public final List<String> allowedSuffixPathFields()

      The list of variable fields that can be used in the suffix path of a delivery that delivers to an S3 bucket.

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

      Returns:
      The list of variable fields that can be used in the suffix path of a delivery that delivers to an S3 bucket.

    • toBuilder

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

    • builder

      public static ConfigurationTemplate.Builder builder()

    • serializableBuilderClass

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