Class EventParameters

java.lang.Object
software.amazon.awssdk.services.dlm.model.EventParameters
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<EventParameters.Builder,EventParameters>
@Generated("software.amazon.awssdk:codegen") public final class EventParameters extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EventParameters.Builder,EventParameters>

[Event-based policies only] Specifies an event that activates an event-based policy.

See Also:

  • Method Details

    • eventType

      public final EventTypeValues eventType()

      The type of event. Currently, only snapshot sharing events are supported.

      If the service returns an enum value that is not available in the current SDK version, eventType will return EventTypeValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventTypeAsString().

      Returns:
      The type of event. Currently, only snapshot sharing events are supported.
      See Also:

    • eventTypeAsString

      public final String eventTypeAsString()

      The type of event. Currently, only snapshot sharing events are supported.

      If the service returns an enum value that is not available in the current SDK version, eventType will return EventTypeValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventTypeAsString().

      Returns:
      The type of event. Currently, only snapshot sharing events are supported.
      See Also:

    • hasSnapshotOwner

      public final boolean hasSnapshotOwner()
      For responses, this returns true if the service returned a value for the SnapshotOwner 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.

    • snapshotOwner

      public final List<String> snapshotOwner()

      The IDs of the Amazon Web Services accounts that can trigger policy by sharing snapshots with your account. The policy only runs if one of the specified Amazon Web Services accounts shares a snapshot with your account.

      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 hasSnapshotOwner() method.

      Returns:
      The IDs of the Amazon Web Services accounts that can trigger policy by sharing snapshots with your account. The policy only runs if one of the specified Amazon Web Services accounts shares a snapshot with your account.

    • descriptionRegex

      public final String descriptionRegex()

      The snapshot description that can trigger the policy. The description pattern is specified using a regular expression. The policy runs only if a snapshot with a description that matches the specified pattern is shared with your account.

      For example, specifying ^.*Created for policy: policy-1234567890abcdef0.*$ configures the policy to run only if snapshots created by policy policy-1234567890abcdef0 are shared with your account.

      Returns:
      The snapshot description that can trigger the policy. The description pattern is specified using a regular expression. The policy runs only if a snapshot with a description that matches the specified pattern is shared with your account.

      For example, specifying ^.*Created for policy: policy-1234567890abcdef0.*$ configures the policy to run only if snapshots created by policy policy-1234567890abcdef0 are shared with your account.

    • toBuilder

      public EventParameters.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<EventParameters.Builder,EventParameters>
      Returns:
      a builder for type T

    • builder

      public static EventParameters.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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