Class SecurityRequirementArtifact

java.lang.Object

software.amazon.awssdk.services.securityagent.model.SecurityRequirementArtifact

All Implemented Interfaces:

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

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

A document used as source material for importing security requirements.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SecurityRequirementArtifact.Builder

Method Summary

Modifier and Type	Method	Description
static SecurityRequirementArtifact.Builder	builder()
final SdkBytes	content()	The binary content of the document.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final SecurityRequirementArtifactFormat	format()	The format of the document.
final String	formatAsString()	The format of the document.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final String	name()	The file name of the document.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends SecurityRequirementArtifact.Builder>	serializableBuilderClass()
SecurityRequirementArtifact.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final 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 Details

name

public final String name()

The file name of the document.

Returns:

The file name of the document.

format

public final SecurityRequirementArtifactFormat format()

The format of the document. Valid values are MD, PDF, TXT, DOCX, and DOC.

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

Returns:

The format of the document. Valid values are MD, PDF, TXT, DOCX, and DOC.

See Also:

• SecurityRequirementArtifactFormat

formatAsString

public final String formatAsString()

The format of the document. Valid values are MD, PDF, TXT, DOCX, and DOC.

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

Returns:

The format of the document. Valid values are MD, PDF, TXT, DOCX, and DOC.

See Also:

• SecurityRequirementArtifactFormat

content

public final SdkBytes content()

The binary content of the document.

Returns:

The binary content of the document.

toBuilder

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

Returns:

a builder for type T

builder

public static SecurityRequirementArtifact.Builder builder()

serializableBuilderClass

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