Class Operation

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

Describes the API operation.

See Also:

  • Method Details

    • id

      public final String id()

      The ID of the operation.

      Returns:
      The ID of the operation.

    • resourceName

      public final String resourceName()

      The resource name.

      Returns:
      The resource name.

    • resourceType

      public final ResourceType resourceType()

      The resource type.

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

      Returns:
      The resource type.
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The resource type.

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

      Returns:
      The resource type.
      See Also:

    • createdAt

      public final Instant createdAt()

      The timestamp when the operation was initialized (1479816991.349).

      Returns:
      The timestamp when the operation was initialized (1479816991.349).

    • location

      public final ResourceLocation location()

      The Amazon Web Services Region and Availability Zone.

      Returns:
      The Amazon Web Services Region and Availability Zone.

    • isTerminal

      public final Boolean isTerminal()

      A Boolean value indicating whether the operation is terminal.

      Returns:
      A Boolean value indicating whether the operation is terminal.

    • operationDetails

      public final String operationDetails()

      Details about the operation (Debian-1GB-Ohio-1).

      Returns:
      Details about the operation (Debian-1GB-Ohio-1).

    • operationType

      public final OperationType operationType()

      The type of operation.

      If the service returns an enum value that is not available in the current SDK version, operationType will return OperationType.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 OperationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operationTypeAsString().

      Returns:
      The type of operation.
      See Also:

    • status

      public final OperationStatus status()

      The status of the operation.

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

      Returns:
      The status of the operation.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the operation.

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

      Returns:
      The status of the operation.
      See Also:

    • statusChangedAt

      public final Instant statusChangedAt()

      The timestamp when the status was changed (1479816991.349).

      Returns:
      The timestamp when the status was changed (1479816991.349).

    • errorCode

      public final String errorCode()

      The error code.

      Returns:
      The error code.

    • errorDetails

      public final String errorDetails()

      The error details.

      Returns:
      The error details.

    • toBuilder

      public Operation.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<Operation.Builder,Operation>
      Returns:
      a builder for type T

    • builder

      public static Operation.Builder builder()

    • serializableBuilderClass

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