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)
boolean	hasEventTypeIds() For responses, this returns true if the service returned a value for the EventTypeIds 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.
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 Amazon Simple Notification Service topics and Chatbot clients 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 final String name()

The name for the notification rule. Notification rule names must be unique in your Amazon Web Services account.

Returns:

The name for the notification rule. Notification rule names must be unique in your Amazon Web Services account.

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 list of allowed events, see EventTypeSummary.

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 list of allowed events, see EventTypeSummary.

resource

public final String resource()

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

Returns:

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

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

A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and Chatbot clients to associate 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 Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and Chatbot clients to associate with the 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

clientRequestToken

public final 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 Amazon Web Services SDKs prepopulate client request tokens. If you are using an Amazon Web Services 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 Amazon Web Services SDKs prepopulate client request tokens. If you are using an Amazon Web Services SDK, an idempotency token is created for you.

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

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.

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:

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

status

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