com.amazonaws.services.codestarnotifications.model

Class CreateNotificationRuleRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.codestarnotifications.model.CreateNotificationRuleRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateNotificationRuleRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateNotificationRuleRequest()

Method Summary

Modifier and Type	Method and Description
CreateNotificationRuleRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateNotificationRuleRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateNotificationRuleRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientRequestToken() A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter.
String	getDetailType() The level of detail to include in the notifications for this resource.
List<String>	getEventTypeIds() A list of event types associated with this notification rule.
String	getName() The name for the notification rule.
String	getResource() The Amazon Resource Name (ARN) of the resource to associate with the notification rule.
String	getStatus() The status of the notification rule.
Map<String,String>	getTags() A list of tags to apply to this notification rule.
List<Target>	getTargets() A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and Chatbot clients to associate with the notification rule.
int	hashCode()
void	setClientRequestToken(String clientRequestToken) A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter.
void	setDetailType(String detailType) The level of detail to include in the notifications for this resource.
void	setEventTypeIds(Collection<String> eventTypeIds) A list of event types associated with this notification rule.
void	setName(String name) The name for the notification rule.
void	setResource(String resource) The Amazon Resource Name (ARN) of the resource to associate with the notification rule.
void	setStatus(String status) The status of the notification rule.
void	setTags(Map<String,String> tags) A list of tags to apply to this notification rule.
void	setTargets(Collection<Target> targets) A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and Chatbot clients to associate with the notification rule.
String	toString() Returns a string representation of this object.
CreateNotificationRuleRequest	withClientRequestToken(String clientRequestToken) A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter.
CreateNotificationRuleRequest	withDetailType(DetailType detailType) The level of detail to include in the notifications for this resource.
CreateNotificationRuleRequest	withDetailType(String detailType) The level of detail to include in the notifications for this resource.
CreateNotificationRuleRequest	withEventTypeIds(Collection<String> eventTypeIds) A list of event types associated with this notification rule.
CreateNotificationRuleRequest	withEventTypeIds(String... eventTypeIds) A list of event types associated with this notification rule.
CreateNotificationRuleRequest	withName(String name) The name for the notification rule.
CreateNotificationRuleRequest	withResource(String resource) The Amazon Resource Name (ARN) of the resource to associate with the notification rule.
CreateNotificationRuleRequest	withStatus(NotificationRuleStatus status) The status of the notification rule.
CreateNotificationRuleRequest	withStatus(String status) The status of the notification rule.
CreateNotificationRuleRequest	withTags(Map<String,String> tags) A list of tags to apply to this notification rule.
CreateNotificationRuleRequest	withTargets(Collection<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	withTargets(Target... targets) A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and Chatbot clients to associate with the notification rule.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateNotificationRuleRequest

public CreateNotificationRuleRequest()

Method Detail

setName

public void setName(String name)

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

Parameters:

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

getName

public String getName()

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.

withName

public CreateNotificationRuleRequest withName(String name)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getEventTypeIds

public List<String> getEventTypeIds()

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

Returns:

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

setEventTypeIds

public void setEventTypeIds(Collection<String> eventTypeIds)

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

Parameters:

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

withEventTypeIds

public CreateNotificationRuleRequest withEventTypeIds(String... eventTypeIds)

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

NOTE: This method appends the values to the existing list (if any). Use setEventTypeIds(java.util.Collection) or withEventTypeIds(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withEventTypeIds

public CreateNotificationRuleRequest withEventTypeIds(Collection<String> eventTypeIds)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setResource

public void setResource(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.

Parameters:

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.

getResource

public String getResource()

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.

withResource

public CreateNotificationRuleRequest withResource(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

getTargets

public List<Target> getTargets()

A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and Chatbot clients to associate with the notification rule.

Returns:

A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and Chatbot clients to associate with the notification rule.

setTargets

public void setTargets(Collection<Target> targets)

A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and Chatbot clients to associate with the notification rule.

Parameters:

targets - A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and Chatbot clients to associate with the notification rule.

withTargets

public CreateNotificationRuleRequest withTargets(Target... targets)

A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and Chatbot clients to associate with the notification rule.

NOTE: This method appends the values to the existing list (if any). Use setTargets(java.util.Collection) or withTargets(java.util.Collection) if you want to override the existing values.

Parameters:

targets - A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and Chatbot clients to associate with the notification rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTargets

public CreateNotificationRuleRequest withTargets(Collection<Target> targets)

A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and Chatbot clients to associate with the notification rule.

Parameters:

targets - A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and Chatbot clients to associate with the notification rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDetailType

public void setDetailType(String 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.

Parameters:

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.

See Also:

DetailType

getDetailType

public String getDetailType()

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.

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

withDetailType

public CreateNotificationRuleRequest withDetailType(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DetailType

withDetailType

public CreateNotificationRuleRequest withDetailType(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DetailType

setClientRequestToken

public void setClientRequestToken(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.

Parameters:

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.

getClientRequestToken

public String getClientRequestToken()

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.

withClientRequestToken

public CreateNotificationRuleRequest withClientRequestToken(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

getTags

public Map<String,String> getTags()

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

Returns:

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

setTags

public void setTags(Map<String,String> tags)

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

Parameters:

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

withTags

public CreateNotificationRuleRequest withTags(Map<String,String> tags)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

addTagsEntry

public CreateNotificationRuleRequest addTagsEntry(String key,
                                                  String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreateNotificationRuleRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStatus

public void setStatus(String 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.

Parameters:

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.

See Also:

NotificationRuleStatus

getStatus

public String getStatus()

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.

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

withStatus

public CreateNotificationRuleRequest withStatus(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

NotificationRuleStatus

withStatus

public CreateNotificationRuleRequest withStatus(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

NotificationRuleStatus

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateNotificationRuleRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()