Class EventRuleStructure
- java.lang.Object
-
- software.amazon.awssdk.services.notifications.model.EventRuleStructure
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<EventRuleStructure.Builder,EventRuleStructure>
@Generated("software.amazon.awssdk:codegen") public final class EventRuleStructure extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EventRuleStructure.Builder,EventRuleStructure>
Contains a complete list of fields related to an EventRule.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceEventRuleStructure.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringarn()The Amazon Resource Name (ARN) of the resource.static EventRuleStructure.Builderbuilder()InstantcreationTime()The creation time of the resource.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringeventPattern()An additional event pattern used to further filter the events this EventRule receives.StringeventType()The event type to match.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasManagedRules()For responses, this returns true if the service returned a value for the ManagedRules property.booleanhasRegions()For responses, this returns true if the service returned a value for the Regions property.booleanhasStatusSummaryByRegion()For responses, this returns true if the service returned a value for the StatusSummaryByRegion property.List<String>managedRules()A list of Amazon EventBridge Managed Rule ARNs associated with this EventRule.StringnotificationConfigurationArn()The ARN for the NotificationConfiguration associated with this EventRule.List<String>regions()A list of AWS Regions that send events to this EventRule.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends EventRuleStructure.Builder>serializableBuilderClass()Stringsource()The matched event source.Map<String,EventRuleStatusSummary>statusSummaryByRegion()A list of an EventRule's status by Region.EventRuleStructure.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
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
-
arn
public final String arn()
The Amazon Resource Name (ARN) of the resource.
- Returns:
- The Amazon Resource Name (ARN) of the resource.
-
notificationConfigurationArn
public final String notificationConfigurationArn()
The ARN for the NotificationConfiguration associated with this EventRule.
- Returns:
- The ARN for the NotificationConfiguration associated with this EventRule.
-
creationTime
public final Instant creationTime()
The creation time of the resource.
- Returns:
- The creation time of the resource.
-
source
public final String source()
The matched event source.
Must match one of the valid EventBridge sources. Only AWS service sourced events are supported. For example,
aws.ec2andaws.cloudwatch. For more information, see Event delivery from AWS services in the Amazon EventBridge User Guide.- Returns:
- The matched event source.
Must match one of the valid EventBridge sources. Only AWS service sourced events are supported. For example,
aws.ec2andaws.cloudwatch. For more information, see Event delivery from AWS services in the Amazon EventBridge User Guide.
-
eventType
public final String eventType()
The event type to match.
Must match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and AWS CloudWatch Alarm State Change. For more information, see Event delivery from AWS services in the Amazon EventBridge User Guide.
- Returns:
- The event type to match.
Must match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and AWS CloudWatch Alarm State Change. For more information, see Event delivery from AWS services in the Amazon EventBridge User Guide.
-
eventPattern
public final String eventPattern()
An additional event pattern used to further filter the events this EventRule receives.
For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.
- Returns:
- An additional event pattern used to further filter the events this EventRule receives.
For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.
-
hasRegions
public final boolean hasRegions()
For responses, this returns true if the service returned a value for the Regions 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.
-
regions
public final List<String> regions()
A list of AWS Regions that send events to this EventRule.
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
hasRegions()method.- Returns:
- A list of AWS Regions that send events to this EventRule.
-
hasManagedRules
public final boolean hasManagedRules()
For responses, this returns true if the service returned a value for the ManagedRules 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.
-
managedRules
public final List<String> managedRules()
A list of Amazon EventBridge Managed Rule ARNs associated with this EventRule.
These are created by AWS User Notifications within your account so your EventRules can function.
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
hasManagedRules()method.- Returns:
- A list of Amazon EventBridge Managed Rule ARNs associated with this EventRule.
These are created by AWS User Notifications within your account so your EventRules can function.
-
hasStatusSummaryByRegion
public final boolean hasStatusSummaryByRegion()
For responses, this returns true if the service returned a value for the StatusSummaryByRegion 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.
-
statusSummaryByRegion
public final Map<String,EventRuleStatusSummary> statusSummaryByRegion()
A list of an EventRule's status by Region. Regions are mapped to EventRuleStatusSummary.
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
hasStatusSummaryByRegion()method.- Returns:
- A list of an EventRule's status by Region. Regions are mapped to EventRuleStatusSummary.
-
toBuilder
public EventRuleStructure.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<EventRuleStructure.Builder,EventRuleStructure>
-
builder
public static EventRuleStructure.Builder builder()
-
serializableBuilderClass
public static Class<? extends EventRuleStructure.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-