Package software.amazon.awssdk.services.workmail.model

Class PutMobileDeviceAccessOverrideRequest

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

  • Method Details

    • organizationId

      public final String organizationId()

      Identifies the WorkMail organization for which you create the override.

      Returns:
      Identifies the WorkMail organization for which you create the override.

    • userId

      public final String userId()

      The WorkMail user for which you create the override. Accepts the following types of user identities:

      • User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

      • Email address: user@domain.tld

      • User name: user

      Returns:
      The WorkMail user for which you create the override. Accepts the following types of user identities:

      • User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

      • Email address: user@domain.tld

      • User name: user

    • deviceId

      public final String deviceId()

      The mobile device for which you create the override. DeviceId is case insensitive.

      Returns:
      The mobile device for which you create the override. DeviceId is case insensitive.

    • effect

      public final MobileDeviceAccessRuleEffect effect()

      The effect of the override, ALLOW or DENY.

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

      Returns:
      The effect of the override, ALLOW or DENY.
      See Also:

    • effectAsString

      public final String effectAsString()

      The effect of the override, ALLOW or DENY.

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

      Returns:
      The effect of the override, ALLOW or DENY.
      See Also:

    • description

      public final String description()

      A description of the override.

      Returns:
      A description of the override.

    • toBuilder

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

    • builder

      public static PutMobileDeviceAccessOverrideRequest.Builder builder()

    • serializableBuilderClass

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