Class ControlOperationSummary

java.lang.Object
software.amazon.awssdk.services.controltower.model.ControlOperationSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ControlOperationSummary.Builder,ControlOperationSummary>
@Generated("software.amazon.awssdk:codegen") public final class ControlOperationSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ControlOperationSummary.Builder,ControlOperationSummary>

A summary of information about the specified control operation.

See Also:

  • Method Details

    • controlIdentifier

      public final String controlIdentifier()

      The controlIdentifier of a control.

      Returns:
      The controlIdentifier of a control.

    • enabledControlIdentifier

      public final String enabledControlIdentifier()

      The controlIdentifier of an enabled control.

      Returns:
      The controlIdentifier of an enabled control.

    • endTime

      public final Instant endTime()

      The time at which the control operation was completed.

      Returns:
      The time at which the control operation was completed.

    • operationIdentifier

      public final String operationIdentifier()

      The unique identifier of a control operation.

      Returns:
      The unique identifier of a control operation.

    • operationType

      public final ControlOperationType operationType()

      The type of operation.

      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:
      The type of operation.
      See Also:

    • operationTypeAsString

      public final String operationTypeAsString()

      The type of operation.

      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:
      The type of operation.
      See Also:

    • startTime

      public final Instant startTime()

      The time at which a control operation began.

      Returns:
      The time at which a control operation began.

    • status

      public final ControlOperationStatus status()

      The status of the specified control operation.

      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:
      The status of the specified control operation.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the specified control operation.

      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:
      The status of the specified control operation.
      See Also:

    • statusMessage

      public final String statusMessage()

      A speficic message displayed as part of the control status.

      Returns:
      A speficic message displayed as part of the control status.

    • targetIdentifier

      public final String targetIdentifier()

      The unique identifier of the target of a control operation.

      Returns:
      The unique identifier of the target of a control operation.

    • toBuilder

      public ControlOperationSummary.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ControlOperationSummary.Builder,ControlOperationSummary>
      Returns:
      a builder for type T

    • builder

      public static ControlOperationSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ControlOperationSummary.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.