Class PutProtectConfigurationRuleSetNumberOverrideRequest

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.PutProtectConfigurationRuleSetNumberOverrideRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutProtectConfigurationRuleSetNumberOverrideRequest.Builder,PutProtectConfigurationRuleSetNumberOverrideRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutProtectConfigurationRuleSetNumberOverrideRequest extends PinpointSmsVoiceV2Request implements ToCopyableBuilder<PutProtectConfigurationRuleSetNumberOverrideRequest.Builder,PutProtectConfigurationRuleSetNumberOverrideRequest>

  • Method Details

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

    • protectConfigurationId

      public final String protectConfigurationId()

      The unique identifier for the protect configuration.

      Returns:
      The unique identifier for the protect configuration.

    • destinationPhoneNumber

      public final String destinationPhoneNumber()

      The destination phone number in E.164 format.

      Returns:
      The destination phone number in E.164 format.

    • action

      public final ProtectConfigurationRuleOverrideAction action()

      The action for the rule to either block or allow messages to the destination phone number.

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

      Returns:
      The action for the rule to either block or allow messages to the destination phone number.
      See Also:

    • actionAsString

      public final String actionAsString()

      The action for the rule to either block or allow messages to the destination phone number.

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

      Returns:
      The action for the rule to either block or allow messages to the destination phone number.
      See Also:

    • expirationTimestamp

      public final Instant expirationTimestamp()

      The time the rule will expire at. If ExpirationTimestamp is not set then the rule does not expire.

      Returns:
      The time the rule will expire at. If ExpirationTimestamp is not set then the rule does not expire.

    • toBuilder

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

    • builder

      public static PutProtectConfigurationRuleSetNumberOverrideRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PutProtectConfigurationRuleSetNumberOverrideRequest.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.

    • sdkFieldNameToField

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