Class CreateEventDestinationRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.pinpointsmsvoicev2.model.PinpointSmsVoiceV2Request
software.amazon.awssdk.services.pinpointsmsvoicev2.model.CreateEventDestinationRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateEventDestinationRequest.Builder,CreateEventDestinationRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateEventDestinationRequest extends PinpointSmsVoiceV2Request implements ToCopyableBuilder<CreateEventDestinationRequest.Builder,CreateEventDestinationRequest>

  • Method Details

    • configurationSetName

      public final String configurationSetName()

      Either the name of the configuration set or the configuration set ARN to apply event logging to. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.

      Returns:
      Either the name of the configuration set or the configuration set ARN to apply event logging to. The ConfigurateSetName and ConfigurationSetArn can be found using the DescribeConfigurationSets action.

    • eventDestinationName

      public final String eventDestinationName()

      The name that identifies the event destination.

      Returns:
      The name that identifies the event destination.

    • matchingEventTypes

      public final List<EventType> matchingEventTypes()

      An array of event types that determine which events to log. If "ALL" is used, then AWS End User Messaging SMS and Voice logs every event type.

      The TEXT_SENT event type is not supported.

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

      Returns:
      An array of event types that determine which events to log. If "ALL" is used, then AWS End User Messaging SMS and Voice logs every event type.

      The TEXT_SENT event type is not supported.

    • hasMatchingEventTypes

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

    • matchingEventTypesAsStrings

      public final List<String> matchingEventTypesAsStrings()

      An array of event types that determine which events to log. If "ALL" is used, then AWS End User Messaging SMS and Voice logs every event type.

      The TEXT_SENT event type is not supported.

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

      Returns:
      An array of event types that determine which events to log. If "ALL" is used, then AWS End User Messaging SMS and Voice logs every event type.

      The TEXT_SENT event type is not supported.

    • cloudWatchLogsDestination

      public final CloudWatchLogsDestination cloudWatchLogsDestination()

      An object that contains information about an event destination for logging to Amazon CloudWatch Logs.

      Returns:
      An object that contains information about an event destination for logging to Amazon CloudWatch Logs.

    • kinesisFirehoseDestination

      public final KinesisFirehoseDestination kinesisFirehoseDestination()

      An object that contains information about an event destination for logging to Amazon Data Firehose.

      Returns:
      An object that contains information about an event destination for logging to Amazon Data Firehose.

    • snsDestination

      public final SnsDestination snsDestination()

      An object that contains information about an event destination for logging to Amazon SNS.

      Returns:
      An object that contains information about an event destination for logging to Amazon SNS.

    • clientToken

      public final String clientToken()

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

      Returns:
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

    • toBuilder

      public CreateEventDestinationRequest.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<CreateEventDestinationRequest.Builder,CreateEventDestinationRequest>
      Specified by:
      toBuilder in class PinpointSmsVoiceV2Request
      Returns:
      a builder for type T

    • builder

      public static CreateEventDestinationRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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