software.amazon.awssdk.services.codestarnotifications.model

Class DescribeNotificationRuleResponse

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

Method Summary

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)
boolean	hasEventTypes() For responses, this returns true if the service returned a value for the EventTypes property.
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
boolean	hasTargets() For responses, this returns true if the service returned a value for the Targets property.
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 Chatbot topics and Chatbot clients 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 final String arn()

The Amazon Resource Name (ARN) of the notification rule.

Returns:

The Amazon Resource Name (ARN) of the notification rule.

name

public final String 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 the isEmpty() 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

public final 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.

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

public final 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.

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 the isEmpty() 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

public final List<TargetSummary> 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

public final 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 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 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 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:

DetailType

detailTypeAsString

public final 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 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 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 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:

DetailType

createdBy

public final 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 final 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 final 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 final 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 final 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.

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 the isEmpty() 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

public final 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.

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

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 final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo