Class DescribeNotificationRuleResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeNotificationRuleResponse.Builder,
DescribeNotificationRuleResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) of the notification rule.builder()
final String
The name or email alias of the person who created the notification rule.final Instant
The date and time the notification rule was created, in timestamp format.final DetailType
The level of detail included in the notifications for this resource.final String
The level of detail included in the notifications for this resource.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List
<EventTypeSummary> A list of the event types associated with the notification rule.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the EventTypes property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final boolean
For responses, this returns true if the service returned a value for the Targets property.final Instant
The date and time the notification rule was most recently updated, in timestamp format.final String
name()
The name of the notification rule.final String
resource()
The Amazon Resource Name (ARN) of the resource associated with the notification rule.static Class
<? extends DescribeNotificationRuleResponse.Builder> final NotificationRuleStatus
status()
The status of the notification rule.final String
The status of the notification rule.tags()
The tags associated with the notification rule.final List
<TargetSummary> targets()
A list of the Chatbot topics and Chatbot clients associated with the notification rule.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.services.codestarnotifications.model.CodestarNotificationsResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
The Amazon Resource Name (ARN) of the notification rule.
- Returns:
- The Amazon Resource Name (ARN) of the notification rule.
-
name
The name of the notification rule.
- Returns:
- The name of the notification rule.
-
hasEventTypes
public final boolean hasEventTypes()For responses, this returns true if the service returned a value for the EventTypes 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. -
eventTypes
A list of the event types associated with the notification rule.
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
hasEventTypes()
method.- Returns:
- A list of the event types associated with the notification rule.
-
resource
The Amazon Resource Name (ARN) of the resource associated with the notification rule.
- Returns:
- The Amazon Resource Name (ARN) of the resource associated with the notification rule.
-
hasTargets
public final boolean hasTargets()For responses, this returns true if the service returned a value for the Targets 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. -
targets
A list of the Chatbot topics and Chatbot clients associated with the notification rule.
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
hasTargets()
method.- Returns:
- A list of the Chatbot topics and Chatbot clients associated with the notification rule.
-
detailType
The level of detail included in the notifications for this resource. BASIC will include only the contents of the event as it would appear in Amazon CloudWatch. FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.
If the service returns an enum value that is not available in the current SDK version,
detailType
will returnDetailType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdetailTypeAsString()
.- Returns:
- The level of detail included in the notifications for this resource. BASIC will include only the contents of the event as it would appear in Amazon CloudWatch. FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.
- See Also:
-
detailTypeAsString
The level of detail included in the notifications for this resource. BASIC will include only the contents of the event as it would appear in Amazon CloudWatch. FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.
If the service returns an enum value that is not available in the current SDK version,
detailType
will returnDetailType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdetailTypeAsString()
.- Returns:
- The level of detail included in the notifications for this resource. BASIC will include only the contents of the event as it would appear in Amazon CloudWatch. FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.
- See Also:
-
createdBy
The name or email alias of the person who created the notification rule.
- Returns:
- The name or email alias of the person who created the notification rule.
-
status
The status of the notification rule. Valid statuses are on (sending notifications) or off (not sending notifications).
If the service returns an enum value that is not available in the current SDK version,
status
will returnNotificationRuleStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the notification rule. Valid statuses are on (sending notifications) or off (not sending notifications).
- See Also:
-
statusAsString
The status of the notification rule. Valid statuses are on (sending notifications) or off (not sending notifications).
If the service returns an enum value that is not available in the current SDK version,
status
will returnNotificationRuleStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the notification rule. Valid statuses are on (sending notifications) or off (not sending notifications).
- See Also:
-
createdTimestamp
The date and time the notification rule was created, in timestamp format.
- Returns:
- The date and time the notification rule was created, in timestamp format.
-
lastModifiedTimestamp
The date and time the notification rule was most recently updated, in timestamp format.
- Returns:
- The date and time the notification rule was most recently updated, in timestamp format.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags 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. -
tags
The tags associated with the notification rule.
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
hasTags()
method.- Returns:
- The tags associated with the notification rule.
-
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<DescribeNotificationRuleResponse.Builder,
DescribeNotificationRuleResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-