@Generated(value="software.amazon.awssdk:codegen") public final class CreateNotificationRuleRequest extends CodestarNotificationsRequest implements ToCopyableBuilder<CreateNotificationRuleRequest.Builder,CreateNotificationRuleRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateNotificationRuleRequest.Builder |
| 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.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String name()
The name for the notification rule. Notification rule names must be unique in your Amazon Web Services account.
public final boolean hasEventTypeIds()
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.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.
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.
public final boolean hasTargets()
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.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.
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().
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.DetailTypepublic 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().
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.DetailTypepublic 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.
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.
public final boolean hasTags()
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.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.
aws".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().
ENABLED. If the status is set to
DISABLED, notifications aren't sent for the notification rule.NotificationRuleStatuspublic 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().
ENABLED. If the status is set to
DISABLED, notifications aren't sent for the notification rule.NotificationRuleStatuspublic CreateNotificationRuleRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateNotificationRuleRequest.Builder,CreateNotificationRuleRequest>toBuilder in class CodestarNotificationsRequestpublic static CreateNotificationRuleRequest.Builder builder()
public static Class<? extends CreateNotificationRuleRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.