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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceEventParameters.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static EventParameters.Builderbuilder()StringdescriptionRegex()The snapshot description that can trigger the policy.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)EventTypeValueseventType()The type of event.StringeventTypeAsString()The type of event.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasSnapshotOwner()For responses, this returns true if the service returned a value for the SnapshotOwner property.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends EventParameters.Builder>serializableBuilderClass()List<String>snapshotOwner()The IDs of the Amazon Web Services accounts that can trigger policy by sharing snapshots with your account.EventParameters.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
-
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,
eventTypewill returnEventTypeValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromeventTypeAsString().- Returns:
- The type of event. Currently, only snapshot sharing events are supported.
- See Also:
EventTypeValues
-
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,
eventTypewill returnEventTypeValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromeventTypeAsString().- Returns:
- The type of event. Currently, only snapshot sharing events are supported.
- See Also:
EventTypeValues
-
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 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.
-
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 policypolicy-1234567890abcdef0are 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 policypolicy-1234567890abcdef0are shared with your account.
-
toBuilder
public EventParameters.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<EventParameters.Builder,EventParameters>
-
builder
public static EventParameters.Builder builder()
-
serializableBuilderClass
public static Class<? extends EventParameters.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
-
-