Class GetEventRuleResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.notifications.model.NotificationsResponse
software.amazon.awssdk.services.notifications.model.GetEventRuleResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetEventRuleResponse.Builder,GetEventRuleResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetEventRuleResponse extends NotificationsResponse implements ToCopyableBuilder<GetEventRuleResponse.Builder,GetEventRuleResponse>

  • Method Details

    • arn

      public final String arn()

      The ARN of the resource.

      Returns:
      The ARN of the resource.

    • notificationConfigurationArn

      public final String notificationConfigurationArn()

      The ARN of a NotificationConfiguration.

      Returns:
      The ARN of a NotificationConfiguration.

    • creationTime

      public final Instant creationTime()

      The date when the EventRule was created.

      Returns:
      The date when the EventRule was created.

    • source

      public final String source()

      The matched event source.

      Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

      Returns:
      The matched event source.

      Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services 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 Amazon CloudWatch Alarm State Change. For more information, see Event delivery from Amazon Web Services 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 Amazon CloudWatch Alarm State Change. For more information, see Event delivery from Amazon Web Services 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 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.

    • regions

      public final List<String> regions()

      A list of Amazon Web Services 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 Amazon Web Services 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 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.

    • managedRules

      public final List<String> managedRules()

      A list of managed rules from EventBridge that are associated with this EventRule.

      These are created by User Notifications within your account so this EventRule functions.

      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 managed rules from EventBridge that are associated with this EventRule.

      These are created by User Notifications within your account so this EventRule functions.

    • 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 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.

    • 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 GetEventRuleResponse.Builder 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 interface ToCopyableBuilder<GetEventRuleResponse.Builder,GetEventRuleResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetEventRuleResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetEventRuleResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.