Class WarningDetail
- java.lang.Object
-
- software.amazon.awssdk.services.cloudformation.model.WarningDetail
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<WarningDetail.Builder,WarningDetail>
@Generated("software.amazon.awssdk:codegen") public final class WarningDetail extends Object implements SdkPojo, Serializable, ToCopyableBuilder<WarningDetail.Builder,WarningDetail>
The warnings generated for a specific resource for this generated template.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
WarningDetail.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static WarningDetail.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasProperties()
For responses, this returns true if the service returned a value for the Properties property.List<WarningProperty>
properties()
The properties of the resource that are impacted by this warning.List<SdkField<?>>
sdkFields()
static Class<? extends WarningDetail.Builder>
serializableBuilderClass()
WarningDetail.Builder
toBuilder()
String
toString()
Returns a string representation of this object.WarningType
type()
The type of this warning.String
typeAsString()
The type of this warning.-
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
-
type
public final WarningType type()
The type of this warning. For more information, see IaC generator and write-only properties in the CloudFormation User Guide.
-
MUTUALLY_EXCLUSIVE_PROPERTIES
- The resource requires mutually-exclusive write-only properties. The IaC generator selects one set of mutually exclusive properties and converts the included properties into parameters. The parameter names have a suffixOneOf
and the parameter descriptions indicate that the corresponding property can be replaced with other exclusive properties. -
UNSUPPORTED_PROPERTIES
- Unsupported properties are present in the resource. One example of unsupported properties would be a required write-only property that is an array, because a parameter cannot be an array. Another example is an optional write-only property. -
MUTUALLY_EXCLUSIVE_TYPES
- One or more required write-only properties are found in the resource, and the type of that property can be any of several types.
Currently the resource and property reference documentation does not indicate if a property uses a type of
oneOf
oranyOf
. You need to look at the resource provider schema.If the service returns an enum value that is not available in the current SDK version,
type
will returnWarningType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of this warning. For more information, see IaC generator and write-only properties in the CloudFormation User Guide.
-
MUTUALLY_EXCLUSIVE_PROPERTIES
- The resource requires mutually-exclusive write-only properties. The IaC generator selects one set of mutually exclusive properties and converts the included properties into parameters. The parameter names have a suffixOneOf
and the parameter descriptions indicate that the corresponding property can be replaced with other exclusive properties. -
UNSUPPORTED_PROPERTIES
- Unsupported properties are present in the resource. One example of unsupported properties would be a required write-only property that is an array, because a parameter cannot be an array. Another example is an optional write-only property. -
MUTUALLY_EXCLUSIVE_TYPES
- One or more required write-only properties are found in the resource, and the type of that property can be any of several types.
Currently the resource and property reference documentation does not indicate if a property uses a type of
oneOf
oranyOf
. You need to look at the resource provider schema. -
- See Also:
WarningType
-
-
typeAsString
public final String typeAsString()
The type of this warning. For more information, see IaC generator and write-only properties in the CloudFormation User Guide.
-
MUTUALLY_EXCLUSIVE_PROPERTIES
- The resource requires mutually-exclusive write-only properties. The IaC generator selects one set of mutually exclusive properties and converts the included properties into parameters. The parameter names have a suffixOneOf
and the parameter descriptions indicate that the corresponding property can be replaced with other exclusive properties. -
UNSUPPORTED_PROPERTIES
- Unsupported properties are present in the resource. One example of unsupported properties would be a required write-only property that is an array, because a parameter cannot be an array. Another example is an optional write-only property. -
MUTUALLY_EXCLUSIVE_TYPES
- One or more required write-only properties are found in the resource, and the type of that property can be any of several types.
Currently the resource and property reference documentation does not indicate if a property uses a type of
oneOf
oranyOf
. You need to look at the resource provider schema.If the service returns an enum value that is not available in the current SDK version,
type
will returnWarningType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of this warning. For more information, see IaC generator and write-only properties in the CloudFormation User Guide.
-
MUTUALLY_EXCLUSIVE_PROPERTIES
- The resource requires mutually-exclusive write-only properties. The IaC generator selects one set of mutually exclusive properties and converts the included properties into parameters. The parameter names have a suffixOneOf
and the parameter descriptions indicate that the corresponding property can be replaced with other exclusive properties. -
UNSUPPORTED_PROPERTIES
- Unsupported properties are present in the resource. One example of unsupported properties would be a required write-only property that is an array, because a parameter cannot be an array. Another example is an optional write-only property. -
MUTUALLY_EXCLUSIVE_TYPES
- One or more required write-only properties are found in the resource, and the type of that property can be any of several types.
Currently the resource and property reference documentation does not indicate if a property uses a type of
oneOf
oranyOf
. You need to look at the resource provider schema. -
- See Also:
WarningType
-
-
hasProperties
public final boolean hasProperties()
For responses, this returns true if the service returned a value for the Properties property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
properties
public final List<WarningProperty> properties()
The properties of the resource that are impacted by this warning.
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
hasProperties()
method.- Returns:
- The properties of the resource that are impacted by this warning.
-
toBuilder
public WarningDetail.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<WarningDetail.Builder,WarningDetail>
-
builder
public static WarningDetail.Builder builder()
-
serializableBuilderClass
public static Class<? extends WarningDetail.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-