Class CreateNotificationRuleRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateNotificationRuleRequest.Builder,
CreateNotificationRuleRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter.final DetailType
The level of detail to include in the notifications for this resource.final String
The level of detail to include in the notifications for this resource.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.A list of event types associated with this notification rule.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the EventTypeIds property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final boolean
For responses, this returns true if the service returned a value for the Targets property.final String
name()
The name for the notification rule.final String
resource()
The Amazon Resource Name (ARN) of the resource to associate with the notification rule.static Class
<? extends CreateNotificationRuleRequest.Builder> final NotificationRuleStatus
status()
The status of the notification rule.final String
The status of the notification rule.tags()
A list of tags to apply to this notification rule.targets()
A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and Chatbot clients to associate with the notification rule.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
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
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 theisEmpty()
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
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
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 returnDetailType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdetailTypeAsString()
.- 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:
-
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 returnDetailType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdetailTypeAsString()
.- 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:
-
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 theisEmpty()
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
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
The status of the notification rule. The default value is
ENABLED
. If the status is set toDISABLED
, 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 returnNotificationRuleStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the notification rule. The default value is
ENABLED
. If the status is set toDISABLED
, notifications aren't sent for the notification rule. - See Also:
-
statusAsString
The status of the notification rule. The default value is
ENABLED
. If the status is set toDISABLED
, 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 returnNotificationRuleStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the notification rule. The default value is
ENABLED
. If the status is set toDISABLED
, notifications aren't sent for the notification rule. - See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateNotificationRuleRequest.Builder,
CreateNotificationRuleRequest> - Specified by:
toBuilder
in classCodestarNotificationsRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-