Package software.amazon.awssdk.services.codestarnotifications.model

Class UpdateNotificationRuleRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.codestarnotifications.model.CodestarNotificationsRequest

software.amazon.awssdk.services.codestarnotifications.model.UpdateNotificationRuleRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateNotificationRuleRequest.Builder,UpdateNotificationRuleRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateNotificationRuleRequest
extends CodestarNotificationsRequest
implements ToCopyableBuilder<UpdateNotificationRuleRequest.Builder,UpdateNotificationRuleRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateNotificationRuleRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) of the notification rule.
static UpdateNotificationRuleRequest.Builder	builder()
DetailType	detailType()	The level of detail to include in the notifications for this resource.
String	detailTypeAsString()	The level of detail to include in the notifications for this resource.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	eventTypeIds()	A list of event types associated with this notification rule.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEventTypeIds()	For responses, this returns true if the service returned a value for the EventTypeIds property.
int	hashCode()
boolean	hasTargets()	For responses, this returns true if the service returned a value for the Targets property.
String	name()	The name of the notification rule.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateNotificationRuleRequest.Builder>	serializableBuilderClass()
NotificationRuleStatus	status()	The status of the notification rule.
String	statusAsString()	The status of the notification rule.
List<Target>	targets()	The address and type of the targets to receive notifications from this notification rule.
UpdateNotificationRuleRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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.

status

public final NotificationRuleStatus status()

The status of the notification rule. Valid statuses include enabled (sending notifications) or disabled (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 include enabled (sending notifications) or disabled (not sending notifications).

See Also:

NotificationRuleStatus

statusAsString

public final String statusAsString()

The status of the notification rule. Valid statuses include enabled (sending notifications) or disabled (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 include enabled (sending notifications) or disabled (not sending notifications).

See Also:

NotificationRuleStatus

hasEventTypeIds

public final boolean hasEventTypeIds()

For responses, this returns true if the service returned a value for the EventTypeIds 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.

eventTypeIds

public final List<String> eventTypeIds()

A list of event types associated with this notification rule. For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console 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 hasEventTypeIds() method.

Returns:

A list of event types associated with this notification rule. For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide.

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<Target> targets()

The address and type of the targets to receive notifications from this 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:

The address and type of the targets to receive notifications from this notification rule.

detailType

public final DetailType detailType()

The level of detail to include 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 to include 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 to include 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 to include 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

toBuilder

public UpdateNotificationRuleRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateNotificationRuleRequest.Builder,UpdateNotificationRuleRequest>

Specified by:

toBuilder in class CodestarNotificationsRequest

builder

public static UpdateNotificationRuleRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateNotificationRuleRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo