software.amazon.awssdk.services.ssm.model

Class TargetLocation

java.lang.Object

software.amazon.awssdk.services.ssm.model.TargetLocation

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TargetLocation.Builder,TargetLocation>

@Generated(value="software.amazon.awssdk:codegen")
public final class TargetLocation
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TargetLocation.Builder,TargetLocation>

The combination of Amazon Web Services Regions and Amazon Web Services accounts targeted by the current Automation execution.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TargetLocation.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	accounts() The Amazon Web Services accounts targeted by the current Automation execution.
static TargetLocation.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	executionRoleName() The Automation execution role used by the currently running Automation.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAccounts() For responses, this returns true if the service returned a value for the Accounts property.
int	hashCode()
boolean	hasRegions() For responses, this returns true if the service returned a value for the Regions property.
List<String>	regions() The Amazon Web Services Regions targeted by the current Automation execution.
List<SdkField<?>>	sdkFields()
static Class<? extends TargetLocation.Builder>	serializableBuilderClass()
AlarmConfiguration	targetLocationAlarmConfiguration() Returns the value of the TargetLocationAlarmConfiguration property for this object.
String	targetLocationMaxConcurrency() The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation concurrently.
String	targetLocationMaxErrors() The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.
TargetLocation.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

hasAccounts

public final boolean hasAccounts()

For responses, this returns true if the service returned a value for the Accounts 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.

accounts

public final List<String> accounts()

The Amazon Web Services accounts targeted by the current Automation execution.

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

Returns:

The Amazon Web Services accounts targeted by the current Automation execution.

hasRegions

public final boolean hasRegions()

For responses, this returns true if the service returned a value for the Regions 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.

regions

public final List<String> regions()

The Amazon Web Services Regions targeted by the current Automation execution.

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

Returns:

The Amazon Web Services Regions targeted by the current Automation execution.

targetLocationMaxConcurrency

public final String targetLocationMaxConcurrency()

The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation concurrently.

Returns:

The maximum number of Amazon Web Services Regions and Amazon Web Services accounts allowed to run the Automation concurrently.

targetLocationMaxErrors

public final String targetLocationMaxErrors()

The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.

Returns:

The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.

executionRoleName

public final String executionRoleName()

The Automation execution role used by the currently running Automation. If not specified, the default value is AWS-SystemsManager-AutomationExecutionRole.

Returns:

The Automation execution role used by the currently running Automation. If not specified, the default value is AWS-SystemsManager-AutomationExecutionRole.

targetLocationAlarmConfiguration

public final AlarmConfiguration targetLocationAlarmConfiguration()

Returns the value of the TargetLocationAlarmConfiguration property for this object.

Returns:

The value of the TargetLocationAlarmConfiguration property for this object.

toBuilder

public TargetLocation.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TargetLocation.Builder,TargetLocation>

builder

public static TargetLocation.Builder builder()

serializableBuilderClass

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