Class SecurityGroupSettingsRequest

java.lang.Object
software.amazon.awssdk.services.wickr.model.SecurityGroupSettingsRequest
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SecurityGroupSettingsRequest.Builder,SecurityGroupSettingsRequest>
@Generated("software.amazon.awssdk:codegen") public final class SecurityGroupSettingsRequest extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SecurityGroupSettingsRequest.Builder,SecurityGroupSettingsRequest>

Contains the security group configuration settings that can be specified when creating or updating a security group. This is a subset of SecurityGroupSettings containing only the modifiable federation and security settings.

See Also:

  • Method Details

    • lockoutThreshold

      public final Integer lockoutThreshold()

      The number of failed password attempts before a user account is locked out.

      Returns:
      The number of failed password attempts before a user account is locked out.

    • hasPermittedNetworks

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

    • permittedNetworks

      public final List<String> permittedNetworks()

      A list of network IDs that are permitted for local federation when federation mode is set to restricted.

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

      Returns:
      A list of network IDs that are permitted for local federation when federation mode is set to restricted.

    • enableGuestFederation

      public final Boolean enableGuestFederation()

      Guest users let you work with people outside your organization that only have limited access to Wickr. Only valid when federationMode is set to Global.

      Returns:
      Guest users let you work with people outside your organization that only have limited access to Wickr. Only valid when federationMode is set to Global.

    • globalFederation

      public final Boolean globalFederation()

      Allow users to securely federate with all Amazon Web Services Wickr networks and Amazon Web Services Enterprise networks.

      Returns:
      Allow users to securely federate with all Amazon Web Services Wickr networks and Amazon Web Services Enterprise networks.

    • federationMode

      public final Integer federationMode()

      The local federation mode. Values: 0 (none), 1 (federated - all networks), 2 (restricted - only permitted networks).

      Returns:
      The local federation mode. Values: 0 (none), 1 (federated - all networks), 2 (restricted - only permitted networks).

    • enableRestrictedGlobalFederation

      public final Boolean enableRestrictedGlobalFederation()

      Enables restricted global federation to limit communication to specific permitted networks only. Requires globalFederation to be enabled.

      Returns:
      Enables restricted global federation to limit communication to specific permitted networks only. Requires globalFederation to be enabled.

    • hasPermittedWickrAwsNetworks

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

    • permittedWickrAwsNetworks

      public final List<WickrAwsNetworks> permittedWickrAwsNetworks()

      A list of permitted Amazon Web Services Wickr networks for restricted global federation.

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

      Returns:
      A list of permitted Amazon Web Services Wickr networks for restricted global federation.

    • hasPermittedWickrEnterpriseNetworks

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

    • permittedWickrEnterpriseNetworks

      public final List<PermittedWickrEnterpriseNetwork> permittedWickrEnterpriseNetworks()

      A list of permitted Wickr Enterprise networks for restricted global federation.

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

      Returns:
      A list of permitted Wickr Enterprise networks for restricted global federation.

    • toBuilder

      public SecurityGroupSettingsRequest.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<SecurityGroupSettingsRequest.Builder,SecurityGroupSettingsRequest>
      Returns:
      a builder for type T

    • builder

      public static SecurityGroupSettingsRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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