Class AutomationExecutionInputs
- java.lang.Object
-
- software.amazon.awssdk.services.ssm.model.AutomationExecutionInputs
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AutomationExecutionInputs.Builder,AutomationExecutionInputs>
@Generated("software.amazon.awssdk:codegen") public final class AutomationExecutionInputs extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AutomationExecutionInputs.Builder,AutomationExecutionInputs>
Information about the optional inputs that can be specified for an automation execution preview.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
AutomationExecutionInputs.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static AutomationExecutionInputs.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasParameters()
For responses, this returns true if the service returned a value for the Parameters property.boolean
hasTargetLocations()
For responses, this returns true if the service returned a value for the TargetLocations property.boolean
hasTargetMaps()
For responses, this returns true if the service returned a value for the TargetMaps property.boolean
hasTargets()
For responses, this returns true if the service returned a value for the Targets property.Map<String,List<String>>
parameters()
Information about parameters that can be specified for the preview operation.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends AutomationExecutionInputs.Builder>
serializableBuilderClass()
List<TargetLocation>
targetLocations()
Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the Automation execution preview operation.String
targetLocationsURL()
A publicly accessible URL for a file that contains theTargetLocations
body.List<Map<String,List<String>>>
targetMaps()
A key-value mapping of document parameters to target resources.String
targetParameterName()
The name of the parameter used as the target resource for the rate-controlled execution.List<Target>
targets()
Information about the resources that would be included in the actual runbook execution, if it were to be run.AutomationExecutionInputs.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
-
hasParameters
public final boolean hasParameters()
For responses, this returns true if the service returned a value for the Parameters 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.
-
parameters
public final Map<String,List<String>> parameters()
Information about parameters that can be specified for the preview 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
hasParameters()
method.- Returns:
- Information about parameters that can be specified for the preview operation.
-
targetParameterName
public final String targetParameterName()
The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.
- Returns:
- The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.
-
hasTargets
public final boolean hasTargets()
For responses, this returns true if the service returned a value for the Targets 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.
-
targets
public final List<Target> targets()
Information about the resources that would be included in the actual runbook execution, if it were to be run. Both Targets and TargetMaps can't be specified together.
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
hasTargets()
method.- Returns:
- Information about the resources that would be included in the actual runbook execution, if it were to be run. Both Targets and TargetMaps can't be specified together.
-
hasTargetMaps
public final boolean hasTargetMaps()
For responses, this returns true if the service returned a value for the TargetMaps 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.
-
targetMaps
public final List<Map<String,List<String>>> targetMaps()
A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
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
hasTargetMaps()
method.- Returns:
- A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
-
hasTargetLocations
public final boolean hasTargetLocations()
For responses, this returns true if the service returned a value for the TargetLocations 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.
-
targetLocations
public final List<TargetLocation> targetLocations()
Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the Automation execution preview 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
hasTargetLocations()
method.- Returns:
- Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the Automation execution preview operation.
-
targetLocationsURL
public final String targetLocationsURL()
A publicly accessible URL for a file that contains the
TargetLocations
body. Currently, only files in presigned Amazon S3 buckets are supported.- Returns:
- A publicly accessible URL for a file that contains the
TargetLocations
body. Currently, only files in presigned Amazon S3 buckets are supported.
-
toBuilder
public AutomationExecutionInputs.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<AutomationExecutionInputs.Builder,AutomationExecutionInputs>
-
builder
public static AutomationExecutionInputs.Builder builder()
-
serializableBuilderClass
public static Class<? extends AutomationExecutionInputs.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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-