Class OpsItemSummary

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

A count of OpsItems.

See Also:

  • Method Details

    • createdBy

      public final String createdBy()

      The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.

      Returns:
      The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.

    • createdTime

      public final Instant createdTime()

      The date and time the OpsItem was created.

      Returns:
      The date and time the OpsItem was created.

    • lastModifiedBy

      public final String lastModifiedBy()

      The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.

      Returns:
      The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The date and time the OpsItem was last updated.

      Returns:
      The date and time the OpsItem was last updated.

    • priority

      public final Integer priority()

      The importance of this OpsItem in relation to other OpsItems in the system.

      Returns:
      The importance of this OpsItem in relation to other OpsItems in the system.

    • source

      public final String source()

      The impacted Amazon Web Services resource.

      Returns:
      The impacted Amazon Web Services resource.

    • status

      public final OpsItemStatus status()

      The OpsItem status.

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

      Returns:
      The OpsItem status.
      See Also:

    • statusAsString

      public final String statusAsString()

      The OpsItem status.

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

      Returns:
      The OpsItem status.
      See Also:

    • opsItemId

      public final String opsItemId()

      The ID of the OpsItem.

      Returns:
      The ID of the OpsItem.

    • title

      public final String title()

      A short heading that describes the nature of the OpsItem and the impacted resource.

      Returns:
      A short heading that describes the nature of the OpsItem and the impacted resource.

    • hasOperationalData

      public final boolean hasOperationalData()
      For responses, this returns true if the service returned a value for the OperationalData 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.

    • operationalData

      public final Map<String,OpsItemDataValue> operationalData()

      Operational data is custom data that provides useful reference details about the OpsItem.

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

      Returns:
      Operational data is custom data that provides useful reference details about the OpsItem.

    • category

      public final String category()

      A list of OpsItems by category.

      Returns:
      A list of OpsItems by category.

    • severity

      public final String severity()

      A list of OpsItems by severity.

      Returns:
      A list of OpsItems by severity.

    • opsItemType

      public final String opsItemType()

      The type of OpsItem. Systems Manager supports the following types of OpsItems:

      • /aws/issue

        This type of OpsItem is used for default OpsItems created by OpsCenter.

      • /aws/changerequest

        This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.

      • /aws/insight

        This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.

      Returns:
      The type of OpsItem. Systems Manager supports the following types of OpsItems:

      • /aws/issue

        This type of OpsItem is used for default OpsItems created by OpsCenter.

      • /aws/changerequest

        This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.

      • /aws/insight

        This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.

    • actualStartTime

      public final Instant actualStartTime()

      The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest .

      Returns:
      The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.

    • actualEndTime

      public final Instant actualEndTime()

      The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.

      Returns:
      The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.

    • plannedStartTime

      public final Instant plannedStartTime()

      The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.

      Returns:
      The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.

    • plannedEndTime

      public final Instant plannedEndTime()

      The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.

      Returns:
      The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.

    • toBuilder

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

    • builder

      public static OpsItemSummary.Builder builder()

    • serializableBuilderClass

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