software.amazon.awssdk.services.transfer.model

Class DescribedSecurityPolicy

java.lang.Object

software.amazon.awssdk.services.transfer.model.DescribedSecurityPolicy

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DescribedSecurityPolicy.Builder,DescribedSecurityPolicy>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribedSecurityPolicy
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DescribedSecurityPolicy.Builder,DescribedSecurityPolicy>

Describes the properties of a security policy that was specified. For more information about security policies, see Working with security policies.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribedSecurityPolicy.Builder

Method Summary

Modifier and Type	Method and Description
static DescribedSecurityPolicy.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
Boolean	fips() Specifies whether this policy enables Federal Information Processing Standards (FIPS).
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSshCiphers() For responses, this returns true if the service returned a value for the SshCiphers property.
boolean	hasSshKexs() For responses, this returns true if the service returned a value for the SshKexs property.
boolean	hasSshMacs() For responses, this returns true if the service returned a value for the SshMacs property.
boolean	hasTlsCiphers() For responses, this returns true if the service returned a value for the TlsCiphers property.
List<SdkField<?>>	sdkFields()
String	securityPolicyName() Specifies the name of the security policy that is attached to the server.
static Class<? extends DescribedSecurityPolicy.Builder>	serializableBuilderClass()
List<String>	sshCiphers() Specifies the enabled Secure Shell (SSH) cipher encryption algorithms in the security policy that is attached to the server.
List<String>	sshKexs() Specifies the enabled SSH key exchange (KEX) encryption algorithms in the security policy that is attached to the server.
List<String>	sshMacs() Specifies the enabled SSH message authentication code (MAC) encryption algorithms in the security policy that is attached to the server.
List<String>	tlsCiphers() Specifies the enabled Transport Layer Security (TLS) cipher encryption algorithms in the security policy that is attached to the server.
DescribedSecurityPolicy.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

fips

public final Boolean fips()

Specifies whether this policy enables Federal Information Processing Standards (FIPS).

Returns:

Specifies whether this policy enables Federal Information Processing Standards (FIPS).

securityPolicyName

public final String securityPolicyName()

Specifies the name of the security policy that is attached to the server.

Returns:

Specifies the name of the security policy that is attached to the server.

hasSshCiphers

public final boolean hasSshCiphers()

For responses, this returns true if the service returned a value for the SshCiphers 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.

sshCiphers

public final List<String> sshCiphers()

Specifies the enabled Secure Shell (SSH) cipher encryption algorithms in the security policy that is attached to the server.

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

Returns:

Specifies the enabled Secure Shell (SSH) cipher encryption algorithms in the security policy that is attached to the server.

hasSshKexs

public final boolean hasSshKexs()

For responses, this returns true if the service returned a value for the SshKexs 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.

sshKexs

public final List<String> sshKexs()

Specifies the enabled SSH key exchange (KEX) encryption algorithms in the security policy that is attached to the server.

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

Returns:

Specifies the enabled SSH key exchange (KEX) encryption algorithms in the security policy that is attached to the server.

hasSshMacs

public final boolean hasSshMacs()

For responses, this returns true if the service returned a value for the SshMacs 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.

sshMacs

public final List<String> sshMacs()

Specifies the enabled SSH message authentication code (MAC) encryption algorithms in the security policy that is attached to the server.

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

Returns:

Specifies the enabled SSH message authentication code (MAC) encryption algorithms in the security policy that is attached to the server.

hasTlsCiphers

public final boolean hasTlsCiphers()

For responses, this returns true if the service returned a value for the TlsCiphers 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.

tlsCiphers

public final List<String> tlsCiphers()

Specifies the enabled Transport Layer Security (TLS) cipher encryption algorithms in the security policy that is attached to the server.

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

Returns:

Specifies the enabled Transport Layer Security (TLS) cipher encryption algorithms in the security policy that is attached to the server.

toBuilder

public DescribedSecurityPolicy.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<DescribedSecurityPolicy.Builder,DescribedSecurityPolicy>

Returns:

a builder for type T

builder

public static DescribedSecurityPolicy.Builder builder()

serializableBuilderClass

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