Package software.amazon.awssdk.services.controltower.model

Class ControlOperation

java.lang.Object

software.amazon.awssdk.services.controltower.model.ControlOperation

All Implemented Interfaces:

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

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

An operation performed by the control.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ControlOperation.Builder

Method Summary

Modifier and Type	Method	Description
static ControlOperation.Builder	builder()
String	controlIdentifier()	The controlIdentifier of the control for the operation.
String	enabledControlIdentifier()	The controlIdentifier of the enabled control.
Instant	endTime()	The time that the operation finished.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	operationIdentifier()	The identifier of the specified operation.
ControlOperationType	operationType()	One of ENABLE_CONTROL or DISABLE_CONTROL.
String	operationTypeAsString()	One of ENABLE_CONTROL or DISABLE_CONTROL.
List<SdkField<?>>	sdkFields()
static Class<? extends ControlOperation.Builder>	serializableBuilderClass()
Instant	startTime()	The time that the operation began.
ControlOperationStatus	status()	One of IN_PROGRESS, SUCEEDED, or FAILED.
String	statusAsString()	One of IN_PROGRESS, SUCEEDED, or FAILED.
String	statusMessage()	If the operation result is FAILED, this string contains a message explaining why the operation failed.
String	targetIdentifier()	The target upon which the control operation is working.
ControlOperation.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

controlIdentifier

public final String controlIdentifier()

The controlIdentifier of the control for the operation.

Returns:

The controlIdentifier of the control for the operation.

enabledControlIdentifier

public final String enabledControlIdentifier()

The controlIdentifier of the enabled control.

Returns:

The controlIdentifier of the enabled control.

endTime

public final Instant endTime()

The time that the operation finished.

Returns:

The time that the operation finished.

operationIdentifier

public final String operationIdentifier()

The identifier of the specified operation.

Returns:

The identifier of the specified operation.

operationType

public final ControlOperationType operationType()

One of ENABLE_CONTROL or DISABLE_CONTROL.

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

Returns:

One of ENABLE_CONTROL or DISABLE_CONTROL.

See Also:

ControlOperationType

operationTypeAsString

public final String operationTypeAsString()

One of ENABLE_CONTROL or DISABLE_CONTROL.

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

Returns:

One of ENABLE_CONTROL or DISABLE_CONTROL.

See Also:

ControlOperationType

startTime

public final Instant startTime()

The time that the operation began.

Returns:

The time that the operation began.

status

public final ControlOperationStatus status()

One of IN_PROGRESS, SUCEEDED, or FAILED.

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

Returns:

One of IN_PROGRESS, SUCEEDED, or FAILED.

See Also:

ControlOperationStatus

statusAsString

public final String statusAsString()

One of IN_PROGRESS, SUCEEDED, or FAILED.

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

Returns:

One of IN_PROGRESS, SUCEEDED, or FAILED.

See Also:

ControlOperationStatus

statusMessage

public final String statusMessage()

If the operation result is FAILED, this string contains a message explaining why the operation failed.

Returns:

If the operation result is FAILED, this string contains a message explaining why the operation failed.

targetIdentifier

public final String targetIdentifier()

The target upon which the control operation is working.

Returns:

The target upon which the control operation is working.

toBuilder

public ControlOperation.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ControlOperation.Builder,ControlOperation>

builder

public static ControlOperation.Builder builder()

serializableBuilderClass

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