DescribeNotificationRuleResponse (AWS Java SDK :: Services :: codestar notifications 2.10.21 API)

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.codestarnotifications.model.CodestarNotificationsResponse
    - - software.amazon.awssdk.services.codestarnotifications.model.DescribeNotificationRuleResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeNotificationRuleResponse.Builder,DescribeNotificationRuleResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeNotificationRuleResponse
extends CodestarNotificationsResponse
implements ToCopyableBuilder<DescribeNotificationRuleResponse.Builder,DescribeNotificationRuleResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeNotificationRuleResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeNotificationRuleResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The Amazon Resource Name (ARN) of the notification rule.
`static DescribeNotificationRuleResponse.Builder`	`builder()`
`String`	`createdBy()` The name or email alias of the person who created the notification rule.
`Instant`	`createdTimestamp()` The date and time the notification rule was created, in timestamp format.
`DetailType`	`detailType()` The level of detail included in the notifications for this resource.
`String`	`detailTypeAsString()` The level of detail included in the notifications for this resource.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<EventTypeSummary>`	`eventTypes()` A list of the event types associated with the notification rule.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Instant`	`lastModifiedTimestamp()` The date and time the notification rule was most recently updated, in timestamp format.
`String`	`name()` The name of the notification rule.
`String`	`resource()` The Amazon Resource Name (ARN) of the resource associated with the notification rule.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeNotificationRuleResponse.Builder>`	`serializableBuilderClass()`
`NotificationRuleStatus`	`status()` The status of the notification rule.
`String`	`statusAsString()` The status of the notification rule.
`Map<String,String>`	`tags()` The tags associated with the notification rule.
`List<TargetSummary>`	`targets()` A list of the SNS topics associated with the notification rule.
`DescribeNotificationRuleResponse.Builder`	`toBuilder()`
`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 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
  - arn
```
public String arn()
```
    The Amazon Resource Name (ARN) of the notification rule.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the notification rule.
  - name
```
public String name()
```
    The name of the notification rule.
    
    Returns:
    
    The name of the notification rule.
  - eventTypes
```
public List<EventTypeSummary> 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.
    
    Returns:
    
    A list of the event types associated with the notification rule.
  - resource
```
public String 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.
  - targets
```
public List<TargetSummary> targets()
```
    A list of the SNS topics associated with the notification rule.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A list of the SNS topics associated with the notification rule.
  - detailType
```
public DetailType 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 AWS 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 return DetailType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from detailTypeAsString().
    
    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 AWS 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:
    
    DetailType
  - detailTypeAsString
```
public String 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 AWS 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 return DetailType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from detailTypeAsString().
    
    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 AWS 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:
    
    DetailType
  - createdBy
```
public String 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
```
public NotificationRuleStatus 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 return NotificationRuleStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the notification rule. Valid statuses are on (sending notifications) or off (not sending notifications).
    
    See Also:
    
    NotificationRuleStatus
  - statusAsString
```
public String 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 return NotificationRuleStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the notification rule. Valid statuses are on (sending notifications) or off (not sending notifications).
    
    See Also:
    
    NotificationRuleStatus
  - createdTimestamp
```
public Instant 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
```
public Instant 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.
  - tags
```
public Map<String,String> tags()
```
    The tags associated with the notification rule.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The tags associated with the notification rule.
  - toBuilder
```
public DescribeNotificationRuleResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeNotificationRuleResponse.Builder,DescribeNotificationRuleResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeNotificationRuleResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeNotificationRuleResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeNotificationRuleResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.codestarnotifications.model.CodestarNotificationsResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

arn

name

eventTypes

resource

targets

detailType

detailTypeAsString

createdBy

status

statusAsString

createdTimestamp

lastModifiedTimestamp

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields