software.amazon.awssdk.services.codestarnotifications.model

Class CreateNotificationRuleRequest

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.CreateNotificationRuleRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateNotificationRuleRequest.Builder,CreateNotificationRuleRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateNotificationRuleRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateNotificationRuleRequest.Builder	builder()
String	clientRequestToken() A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter.
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)
int	hashCode()
String	name() The name for the notification rule.
String	resource() The Amazon Resource Name (ARN) of the resource to associate with the notification rule.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateNotificationRuleRequest.Builder>	serializableBuilderClass()
NotificationRuleStatus	status() The status of the notification rule.
String	statusAsString() The status of the notification rule.
Map<String,String>	tags() A list of tags to apply to this notification rule.
List<Target>	targets() A list of Amazon Resource Names (ARNs) of SNS topics to associate with the notification rule.
CreateNotificationRuleRequest.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

name

public String name()

The name for the notification rule. Notifictaion rule names must be unique in your AWS account.

Returns:

The name for the notification rule. Notifictaion rule names must be unique in your AWS account.

eventTypeIds

public List<String> eventTypeIds()

A list of event types associated with this notification rule. For a list of allowed events, see EventTypeSummary.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A list of event types associated with this notification rule. For a list of allowed events, see EventTypeSummary.

resource

public String resource()

The Amazon Resource Name (ARN) of the resource to associate with the notification rule. Supported resources include pipelines in AWS CodePipeline, repositories in AWS CodeCommit, and build projects in AWS CodeBuild.

Returns:

The Amazon Resource Name (ARN) of the resource to associate with the notification rule. Supported resources include pipelines in AWS CodePipeline, repositories in AWS CodeCommit, and build projects in AWS CodeBuild.

targets

public List<Target> targets()

A list of Amazon Resource Names (ARNs) of SNS topics to associate with the notification rule.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A list of Amazon Resource Names (ARNs) of SNS topics to associate with the notification rule.

detailType

public 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 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 to include 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 to include 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 to include 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

clientRequestToken

public String clientRequestToken()

A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request with the same parameters is received and a token is included, the request returns information about the initial request that used that token.

The AWS SDKs prepopulate client request tokens. If you are using an AWS SDK, an idempotency token is created for you.

Returns:

A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request with the same parameters is received and a token is included, the request returns information about the initial request that used that token.

The AWS SDKs prepopulate client request tokens. If you are using an AWS SDK, an idempotency token is created for you.

tags

public Map<String,String> tags()

A list of tags to apply to this notification rule. Key names cannot start with "aws".

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A list of tags to apply to this notification rule. Key names cannot start with "aws".

status

public NotificationRuleStatus status()

The status of the notification rule. The default value is ENABLED. If the status is set to DISABLED, notifications aren't sent for the notification rule.

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. The default value is ENABLED. If the status is set to DISABLED, notifications aren't sent for the notification rule.

See Also:

NotificationRuleStatus

statusAsString

public String statusAsString()

The status of the notification rule. The default value is ENABLED. If the status is set to DISABLED, notifications aren't sent for the notification rule.

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. The default value is ENABLED. If the status is set to DISABLED, notifications aren't sent for the notification rule.

See Also:

NotificationRuleStatus

toBuilder

public CreateNotificationRuleRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateNotificationRuleRequest.Builder,CreateNotificationRuleRequest>

Specified by:

toBuilder in class CodestarNotificationsRequest

builder

public static CreateNotificationRuleRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo