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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceOpsItemSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description InstantactualEndTime()The time a runbook workflow ended.InstantactualStartTime()The time a runbook workflow started.static OpsItemSummary.Builderbuilder()Stringcategory()A list of OpsItems by category.StringcreatedBy()The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.InstantcreatedTime()The date and time the OpsItem was created.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasOperationalData()For responses, this returns true if the service returned a value for the OperationalData property.StringlastModifiedBy()The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.InstantlastModifiedTime()The date and time the OpsItem was last updated.Map<String,OpsItemDataValue>operationalData()Operational data is custom data that provides useful reference details about the OpsItem.StringopsItemId()The ID of the OpsItem.StringopsItemType()The type of OpsItem.InstantplannedEndTime()The time specified in a change request for a runbook workflow to end.InstantplannedStartTime()The time specified in a change request for a runbook workflow to start.Integerpriority()The importance of this OpsItem in relation to other OpsItems in the system.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends OpsItemSummary.Builder>serializableBuilderClass()Stringseverity()A list of OpsItems by severity.Stringsource()The impacted Amazon Web Services resource.OpsItemStatusstatus()The OpsItem status.StringstatusAsString()The OpsItem status.Stringtitle()A short heading that describes the nature of the OpsItem and the impacted resource.OpsItemSummary.BuildertoBuilder()StringtoString()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
-
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,
statuswill returnOpsItemStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The OpsItem status.
- See Also:
OpsItemStatus
-
statusAsString
public final String statusAsString()
The OpsItem status.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnOpsItemStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The OpsItem status.
- See Also:
OpsItemStatus
-
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 theisEmpty()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/issueThis type of OpsItem is used for default OpsItems created by OpsCenter.
-
/aws/changerequestThis type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.
-
/aws/insightThis 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/issueThis type of OpsItem is used for default OpsItems created by OpsCenter.
-
/aws/changerequestThis type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.
-
/aws/insightThis 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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<OpsItemSummary.Builder,OpsItemSummary>
-
builder
public static OpsItemSummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends OpsItemSummary.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-