Class CreateMobileDeviceAccessRuleRequest

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

  • Method Details

    • organizationId

      public final String organizationId()

      The WorkMail organization under which the rule will be created.

      Returns:
      The WorkMail organization under which the rule will be created.

    • clientToken

      public final String clientToken()

      The idempotency token for the client request.

      Returns:
      The idempotency token for the client request.

    • name

      public final String name()

      The rule name.

      Returns:
      The rule name.

    • description

      public final String description()

      The rule description.

      Returns:
      The rule description.

    • effect

      public final MobileDeviceAccessRuleEffect effect()

      The effect of the rule when it matches. Allowed values are 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 rule when it matches. Allowed values are ALLOW or DENY.
      See Also:

    • effectAsString

      public final String effectAsString()

      The effect of the rule when it matches. Allowed values are 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 rule when it matches. Allowed values are ALLOW or DENY.
      See Also:

    • hasDeviceTypes

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

    • deviceTypes

      public final List<String> deviceTypes()

      Device types that the rule will match.

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

      Returns:
      Device types that the rule will match.

    • hasNotDeviceTypes

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

    • notDeviceTypes

      public final List<String> notDeviceTypes()

      Device types that the rule will not match. All other device types will match.

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

      Returns:
      Device types that the rule will not match. All other device types will match.

    • hasDeviceModels

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

    • deviceModels

      public final List<String> deviceModels()

      Device models that the rule will match.

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

      Returns:
      Device models that the rule will match.

    • hasNotDeviceModels

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

    • notDeviceModels

      public final List<String> notDeviceModels()

      Device models that the rule will not match. All other device models will match.

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

      Returns:
      Device models that the rule will not match. All other device models will match.

    • hasDeviceOperatingSystems

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

    • deviceOperatingSystems

      public final List<String> deviceOperatingSystems()

      Device operating systems that the rule will match.

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

      Returns:
      Device operating systems that the rule will match.

    • hasNotDeviceOperatingSystems

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

    • notDeviceOperatingSystems

      public final List<String> notDeviceOperatingSystems()

      Device operating systems that the rule will not match. All other device operating systems will match.

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

      Returns:
      Device operating systems that the rule will not match. All other device operating systems will match.

    • hasDeviceUserAgents

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

    • deviceUserAgents

      public final List<String> deviceUserAgents()

      Device user agents that the rule will match.

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

      Returns:
      Device user agents that the rule will match.

    • hasNotDeviceUserAgents

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

    • notDeviceUserAgents

      public final List<String> notDeviceUserAgents()

      Device user agents that the rule will not match. All other device user agents will match.

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

      Returns:
      Device user agents that the rule will not match. All other device user agents will match.

    • toBuilder

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

    • builder

      public static CreateMobileDeviceAccessRuleRequest.Builder builder()

    • serializableBuilderClass

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