@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class OpsItem extends Object implements Serializable, Cloneable, StructuredPojo
Operations engineers and IT professionals use the Systems Manager OpsItems capability to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsItems in the AWS Systems Manager User Guide.
Constructor and Description |
---|
OpsItem() |
Modifier and Type | Method and Description |
---|---|
OpsItem |
addOperationalDataEntry(String key,
OpsItemDataValue value) |
OpsItem |
clearOperationalDataEntries()
Removes all the entries added into OperationalData.
|
OpsItem |
clone() |
boolean |
equals(Object obj) |
String |
getCreatedBy()
The ARN of the AWS account that created the OpsItem.
|
Date |
getCreatedTime()
The date and time the OpsItem was created.
|
String |
getDescription()
The OpsItem description.
|
String |
getLastModifiedBy()
The ARN of the AWS account that last updated the OpsItem.
|
Date |
getLastModifiedTime()
The date and time the OpsItem was last updated.
|
List<OpsItemNotification> |
getNotifications()
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or
changed.
|
Map<String,OpsItemDataValue> |
getOperationalData()
Operational data is custom data that provides useful reference details about the OpsItem.
|
String |
getOpsItemId()
The ID of the OpsItem.
|
Integer |
getPriority()
The importance of this OpsItem in relation to other OpsItems in the system.
|
List<RelatedOpsItem> |
getRelatedOpsItems()
One or more OpsItems that share something in common with the current OpsItems.
|
String |
getSource()
The origin of the OpsItem, such as Amazon EC2 or AWS Systems Manager.
|
String |
getStatus()
The OpsItem status.
|
String |
getTitle()
A short heading that describes the nature of the OpsItem and the impacted resource.
|
String |
getVersion()
The version of this OpsItem.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setCreatedBy(String createdBy)
The ARN of the AWS account that created the OpsItem.
|
void |
setCreatedTime(Date createdTime)
The date and time the OpsItem was created.
|
void |
setDescription(String description)
The OpsItem description.
|
void |
setLastModifiedBy(String lastModifiedBy)
The ARN of the AWS account that last updated the OpsItem.
|
void |
setLastModifiedTime(Date lastModifiedTime)
The date and time the OpsItem was last updated.
|
void |
setNotifications(Collection<OpsItemNotification> notifications)
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or
changed.
|
void |
setOperationalData(Map<String,OpsItemDataValue> operationalData)
Operational data is custom data that provides useful reference details about the OpsItem.
|
void |
setOpsItemId(String opsItemId)
The ID of the OpsItem.
|
void |
setPriority(Integer priority)
The importance of this OpsItem in relation to other OpsItems in the system.
|
void |
setRelatedOpsItems(Collection<RelatedOpsItem> relatedOpsItems)
One or more OpsItems that share something in common with the current OpsItems.
|
void |
setSource(String source)
The origin of the OpsItem, such as Amazon EC2 or AWS Systems Manager.
|
void |
setStatus(String status)
The OpsItem status.
|
void |
setTitle(String title)
A short heading that describes the nature of the OpsItem and the impacted resource.
|
void |
setVersion(String version)
The version of this OpsItem.
|
String |
toString()
Returns a string representation of this object.
|
OpsItem |
withCreatedBy(String createdBy)
The ARN of the AWS account that created the OpsItem.
|
OpsItem |
withCreatedTime(Date createdTime)
The date and time the OpsItem was created.
|
OpsItem |
withDescription(String description)
The OpsItem description.
|
OpsItem |
withLastModifiedBy(String lastModifiedBy)
The ARN of the AWS account that last updated the OpsItem.
|
OpsItem |
withLastModifiedTime(Date lastModifiedTime)
The date and time the OpsItem was last updated.
|
OpsItem |
withNotifications(Collection<OpsItemNotification> notifications)
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or
changed.
|
OpsItem |
withNotifications(OpsItemNotification... notifications)
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or
changed.
|
OpsItem |
withOperationalData(Map<String,OpsItemDataValue> operationalData)
Operational data is custom data that provides useful reference details about the OpsItem.
|
OpsItem |
withOpsItemId(String opsItemId)
The ID of the OpsItem.
|
OpsItem |
withPriority(Integer priority)
The importance of this OpsItem in relation to other OpsItems in the system.
|
OpsItem |
withRelatedOpsItems(Collection<RelatedOpsItem> relatedOpsItems)
One or more OpsItems that share something in common with the current OpsItems.
|
OpsItem |
withRelatedOpsItems(RelatedOpsItem... relatedOpsItems)
One or more OpsItems that share something in common with the current OpsItems.
|
OpsItem |
withSource(String source)
The origin of the OpsItem, such as Amazon EC2 or AWS Systems Manager.
|
OpsItem |
withStatus(OpsItemStatus status)
The OpsItem status.
|
OpsItem |
withStatus(String status)
The OpsItem status.
|
OpsItem |
withTitle(String title)
A short heading that describes the nature of the OpsItem and the impacted resource.
|
OpsItem |
withVersion(String version)
The version of this OpsItem.
|
public void setCreatedBy(String createdBy)
The ARN of the AWS account that created the OpsItem.
createdBy
- The ARN of the AWS account that created the OpsItem.public String getCreatedBy()
The ARN of the AWS account that created the OpsItem.
public OpsItem withCreatedBy(String createdBy)
The ARN of the AWS account that created the OpsItem.
createdBy
- The ARN of the AWS account that created the OpsItem.public void setCreatedTime(Date createdTime)
The date and time the OpsItem was created.
createdTime
- The date and time the OpsItem was created.public Date getCreatedTime()
The date and time the OpsItem was created.
public OpsItem withCreatedTime(Date createdTime)
The date and time the OpsItem was created.
createdTime
- The date and time the OpsItem was created.public void setDescription(String description)
The OpsItem description.
description
- The OpsItem description.public String getDescription()
The OpsItem description.
public OpsItem withDescription(String description)
The OpsItem description.
description
- The OpsItem description.public void setLastModifiedBy(String lastModifiedBy)
The ARN of the AWS account that last updated the OpsItem.
lastModifiedBy
- The ARN of the AWS account that last updated the OpsItem.public String getLastModifiedBy()
The ARN of the AWS account that last updated the OpsItem.
public OpsItem withLastModifiedBy(String lastModifiedBy)
The ARN of the AWS account that last updated the OpsItem.
lastModifiedBy
- The ARN of the AWS account that last updated the OpsItem.public void setLastModifiedTime(Date lastModifiedTime)
The date and time the OpsItem was last updated.
lastModifiedTime
- The date and time the OpsItem was last updated.public Date getLastModifiedTime()
The date and time the OpsItem was last updated.
public OpsItem withLastModifiedTime(Date lastModifiedTime)
The date and time the OpsItem was last updated.
lastModifiedTime
- The date and time the OpsItem was last updated.public List<OpsItemNotification> getNotifications()
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
public void setNotifications(Collection<OpsItemNotification> notifications)
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
notifications
- The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or
changed.public OpsItem withNotifications(OpsItemNotification... notifications)
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
NOTE: This method appends the values to the existing list (if any). Use
setNotifications(java.util.Collection)
or withNotifications(java.util.Collection)
if you want
to override the existing values.
notifications
- The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or
changed.public OpsItem withNotifications(Collection<OpsItemNotification> notifications)
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
notifications
- The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or
changed.public void setPriority(Integer priority)
The importance of this OpsItem in relation to other OpsItems in the system.
priority
- The importance of this OpsItem in relation to other OpsItems in the system.public Integer getPriority()
The importance of this OpsItem in relation to other OpsItems in the system.
public OpsItem withPriority(Integer priority)
The importance of this OpsItem in relation to other OpsItems in the system.
priority
- The importance of this OpsItem in relation to other OpsItems in the system.public List<RelatedOpsItem> getRelatedOpsItems()
One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.
public void setRelatedOpsItems(Collection<RelatedOpsItem> relatedOpsItems)
One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.
relatedOpsItems
- One or more OpsItems that share something in common with the current OpsItems. For example, related
OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the
impacted resource.public OpsItem withRelatedOpsItems(RelatedOpsItem... relatedOpsItems)
One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.
NOTE: This method appends the values to the existing list (if any). Use
setRelatedOpsItems(java.util.Collection)
or withRelatedOpsItems(java.util.Collection)
if you
want to override the existing values.
relatedOpsItems
- One or more OpsItems that share something in common with the current OpsItems. For example, related
OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the
impacted resource.public OpsItem withRelatedOpsItems(Collection<RelatedOpsItem> relatedOpsItems)
One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.
relatedOpsItems
- One or more OpsItems that share something in common with the current OpsItems. For example, related
OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the
impacted resource.public void setStatus(String status)
The OpsItem status. Status can be Open
, In Progress
, or Resolved
. For more
information, see Editing OpsItem Details in the AWS Systems Manager User Guide.
status
- The OpsItem status. Status can be Open
, In Progress
, or Resolved
.
For more information, see Editing OpsItem Details in the AWS Systems Manager User Guide.OpsItemStatus
public String getStatus()
The OpsItem status. Status can be Open
, In Progress
, or Resolved
. For more
information, see Editing OpsItem Details in the AWS Systems Manager User Guide.
Open
, In Progress
, or Resolved
.
For more information, see Editing OpsItem Details in the AWS Systems Manager User Guide.OpsItemStatus
public OpsItem withStatus(String status)
The OpsItem status. Status can be Open
, In Progress
, or Resolved
. For more
information, see Editing OpsItem Details in the AWS Systems Manager User Guide.
status
- The OpsItem status. Status can be Open
, In Progress
, or Resolved
.
For more information, see Editing OpsItem Details in the AWS Systems Manager User Guide.OpsItemStatus
public OpsItem withStatus(OpsItemStatus status)
The OpsItem status. Status can be Open
, In Progress
, or Resolved
. For more
information, see Editing OpsItem Details in the AWS Systems Manager User Guide.
status
- The OpsItem status. Status can be Open
, In Progress
, or Resolved
.
For more information, see Editing OpsItem Details in the AWS Systems Manager User Guide.OpsItemStatus
public void setOpsItemId(String opsItemId)
The ID of the OpsItem.
opsItemId
- The ID of the OpsItem.public String getOpsItemId()
The ID of the OpsItem.
public OpsItem withOpsItemId(String opsItemId)
The ID of the OpsItem.
opsItemId
- The ID of the OpsItem.public void setVersion(String version)
The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.
version
- The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.public String getVersion()
The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.
public OpsItem withVersion(String version)
The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.
version
- The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.public void setTitle(String title)
A short heading that describes the nature of the OpsItem and the impacted resource.
title
- A short heading that describes the nature of the OpsItem and the impacted resource.public String getTitle()
A short heading that describes the nature of the OpsItem and the impacted resource.
public OpsItem withTitle(String title)
A short heading that describes the nature of the OpsItem and the impacted resource.
title
- A short heading that describes the nature of the OpsItem and the impacted resource.public void setSource(String source)
The origin of the OpsItem, such as Amazon EC2 or AWS Systems Manager. The impacted resource is a subset of source.
source
- The origin of the OpsItem, such as Amazon EC2 or AWS Systems Manager. The impacted resource is a subset of
source.public String getSource()
The origin of the OpsItem, such as Amazon EC2 or AWS Systems Manager. The impacted resource is a subset of source.
public OpsItem withSource(String source)
The origin of the OpsItem, such as Amazon EC2 or AWS Systems Manager. The impacted resource is a subset of source.
source
- The origin of the OpsItem, such as Amazon EC2 or AWS Systems Manager. The impacted resource is a subset of
source.public Map<String,OpsItemDataValue> getOperationalData()
Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.
This custom data is searchable, but with restrictions. For the Searchable operational data
feature,
all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API action) can
view and search on the specified data. For the Private operational data
feature, the data is only
viewable by users who have access to the OpsItem (as provided by the GetOpsItem API action).
This custom data is searchable, but with restrictions. For the Searchable operational data
feature, all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems
API action) can view and search on the specified data. For the Private operational data
feature, the data is only viewable by users who have access to the OpsItem (as provided by the
GetOpsItem API action).
public void setOperationalData(Map<String,OpsItemDataValue> operationalData)
Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.
This custom data is searchable, but with restrictions. For the Searchable operational data
feature,
all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API action) can
view and search on the specified data. For the Private operational data
feature, the data is only
viewable by users who have access to the OpsItem (as provided by the GetOpsItem API action).
operationalData
- Operational data is custom data that provides useful reference details about the OpsItem. For example, you
can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You
enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a
maximum size of 20 KB.
This custom data is searchable, but with restrictions. For the Searchable operational data
feature, all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems
API action) can view and search on the specified data. For the Private operational data
feature, the data is only viewable by users who have access to the OpsItem (as provided by the
GetOpsItem API action).
public OpsItem withOperationalData(Map<String,OpsItemDataValue> operationalData)
Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.
This custom data is searchable, but with restrictions. For the Searchable operational data
feature,
all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API action) can
view and search on the specified data. For the Private operational data
feature, the data is only
viewable by users who have access to the OpsItem (as provided by the GetOpsItem API action).
operationalData
- Operational data is custom data that provides useful reference details about the OpsItem. For example, you
can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You
enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a
maximum size of 20 KB.
This custom data is searchable, but with restrictions. For the Searchable operational data
feature, all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems
API action) can view and search on the specified data. For the Private operational data
feature, the data is only viewable by users who have access to the OpsItem (as provided by the
GetOpsItem API action).
public OpsItem addOperationalDataEntry(String key, OpsItemDataValue value)
public OpsItem clearOperationalDataEntries()
public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.