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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ConfigurationTemplate.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`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.
`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.
`List<RecordField>`	`allowedFields()`	The allowed fields that a caller can use in the `recordFields` parameter of a CreateDelivery or UpdateDeliveryConfiguration operation.
`List<OutputFormat>`	`allowedOutputFormats()`	The list of delivery destination output formats that are supported by this log source.
`List<String>`	`allowedOutputFormatsAsStrings()`	The list of delivery destination output formats that are supported by this log source.
`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.
`static ConfigurationTemplate.Builder`	`builder()`
`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.
`DeliveryDestinationType`	`deliveryDestinationType()`	A string specifying which destination type this configuration template applies to.
`String`	`deliveryDestinationTypeAsString()`	A string specifying which destination type this configuration template applies to.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAllowedFieldDelimiters()`	For responses, this returns true if the service returned a value for the AllowedFieldDelimiters property.
`boolean`	`hasAllowedFields()`	For responses, this returns true if the service returned a value for the AllowedFields property.
`boolean`	`hasAllowedOutputFormats()`	For responses, this returns true if the service returned a value for the AllowedOutputFormats property.
`boolean`	`hasAllowedSuffixPathFields()`	For responses, this returns true if the service returned a value for the AllowedSuffixPathFields property.
`int`	`hashCode()`
`String`	`logType()`	A string specifying which log type this configuration template applies to.
`String`	`resourceType()`	A string specifying which resource type this configuration template applies to.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ConfigurationTemplate.Builder>`	`serializableBuilderClass()`
`String`	`service()`	A string specifying which service this configuration template applies to.
`ConfigurationTemplate.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    DeliveryDestinationType
  - 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:
    
    DeliveryDestinationType
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ConfigurationTemplate.Builder,ConfigurationTemplate>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class ConfigurationTemplate

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

service

logType

resourceType

deliveryDestinationType

deliveryDestinationTypeAsString

defaultDeliveryConfigValues

hasAllowedFields

allowedFields

allowedOutputFormats

hasAllowedOutputFormats

allowedOutputFormatsAsStrings

allowedActionForAllowVendedLogsDeliveryForResource

hasAllowedFieldDelimiters

allowedFieldDelimiters

hasAllowedSuffixPathFields

allowedSuffixPathFields

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField