Class UpdateOpsItemRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateOpsItemRequest.Builder,
UpdateOpsItemRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Instant
The time a runbook workflow ended.final Instant
The time a runbook workflow started.static UpdateOpsItemRequest.Builder
builder()
final String
category()
Specify a new category for an OpsItem.final String
User-defined text that contains information about the OpsItem, in Markdown format.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Notifications property.final boolean
For responses, this returns true if the service returned a value for the OperationalData property.final boolean
For responses, this returns true if the service returned a value for the OperationalDataToDelete property.final boolean
For responses, this returns true if the service returned a value for the RelatedOpsItems property.final List
<OpsItemNotification> The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.final Map
<String, OpsItemDataValue> Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.Keys that you want to remove from the OperationalData map.final String
The OpsItem Amazon Resource Name (ARN).final String
The ID of the OpsItem.final Instant
The time specified in a change request for a runbook workflow to end.final Instant
The time specified in a change request for a runbook workflow to start.final Integer
priority()
The importance of this OpsItem in relation to other OpsItems in the system.final List
<RelatedOpsItem> One or more OpsItems that share something in common with the current OpsItems.static Class
<? extends UpdateOpsItemRequest.Builder> final String
severity()
Specify a new severity for an OpsItem.final OpsItemStatus
status()
The OpsItem status.final String
The OpsItem status.final String
title()
A short heading that describes the nature of the OpsItem and the impacted resource.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
description
User-defined text that contains information about the OpsItem, in Markdown format.
- Returns:
- User-defined text that contains information about the OpsItem, in Markdown format.
-
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
Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.
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.
Operational data keys can't begin with the following:
amazon
,aws
,amzn
,ssm
,/amazon
,/aws
,/amzn
,/ssm
.You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation).
Use the
/aws/resources
key in OperationalData to specify a related resource in the request. Use the/aws/automations
key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.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:
- Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.
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.
Operational data keys can't begin with the following:
amazon
,aws
,amzn
,ssm
,/amazon
,/aws
,/amzn
,/ssm
.You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation).
Use the
/aws/resources
key in OperationalData to specify a related resource in the request. Use the/aws/automations
key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.
-
hasOperationalDataToDelete
public final boolean hasOperationalDataToDelete()For responses, this returns true if the service returned a value for the OperationalDataToDelete 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. -
operationalDataToDelete
Keys that you want to remove from the OperationalData map.
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
hasOperationalDataToDelete()
method.- Returns:
- Keys that you want to remove from the OperationalData map.
-
hasNotifications
public final boolean hasNotifications()For responses, this returns true if the service returned a value for the Notifications 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. -
notifications
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
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
hasNotifications()
method.- Returns:
- The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
-
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.
-
hasRelatedOpsItems
public final boolean hasRelatedOpsItems()For responses, this returns true if the service returned a value for the RelatedOpsItems 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. -
status
The OpsItem status. Status can be
Open
,In Progress
, orResolved
. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.If the service returns an enum value that is not available in the current SDK version,
status
will returnOpsItemStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The OpsItem status. Status can be
Open
,In Progress
, orResolved
. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide. - See Also:
-
statusAsString
The OpsItem status. Status can be
Open
,In Progress
, orResolved
. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.If the service returns an enum value that is not available in the current SDK version,
status
will returnOpsItemStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The OpsItem status. Status can be
Open
,In Progress
, orResolved
. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide. - See Also:
-
opsItemId
The ID of the OpsItem.
- Returns:
- The ID of the OpsItem.
-
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.
-
category
Specify a new category for an OpsItem.
- Returns:
- Specify a new category for an OpsItem.
-
severity
Specify a new severity for an OpsItem.
- Returns:
- Specify a new severity for an OpsItem.
-
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
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
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
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
.
-
opsItemArn
The OpsItem Amazon Resource Name (ARN).
- Returns:
- The OpsItem Amazon Resource Name (ARN).
-
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 interfaceToCopyableBuilder<UpdateOpsItemRequest.Builder,
UpdateOpsItemRequest> - Specified by:
toBuilder
in classSsmRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-