software.amazon.awssdk.services.inspector.model

Class AssessmentTemplate

java.lang.Object

software.amazon.awssdk.services.inspector.model.AssessmentTemplate

All Implemented Interfaces:

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

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

Contains information about an Amazon Inspector assessment template. This data type is used as the response element in the DescribeAssessmentTemplates action.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AssessmentTemplate.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The ARN of the assessment template.
Integer	assessmentRunCount() The number of existing assessment runs associated with this assessment template.
String	assessmentTargetArn() The ARN of the assessment target that corresponds to this assessment template.
static AssessmentTemplate.Builder	builder()
Instant	createdAt() The time at which the assessment template is created.
Integer	durationInSeconds() The duration in seconds specified for this assessment template.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRulesPackageArns() For responses, this returns true if the service returned a value for the RulesPackageArns property.
boolean	hasUserAttributesForFindings() For responses, this returns true if the service returned a value for the UserAttributesForFindings property.
String	lastAssessmentRunArn() The Amazon Resource Name (ARN) of the most recent assessment run associated with this assessment template.
String	name() The name of the assessment template.
List<String>	rulesPackageArns() The rules packages that are specified for this assessment template.
List<SdkField<?>>	sdkFields()
static Class<? extends AssessmentTemplate.Builder>	serializableBuilderClass()
AssessmentTemplate.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<Attribute>	userAttributesForFindings() The user-defined attributes that are assigned to every generated finding from the assessment run that uses this assessment template.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

arn

public final String arn()

The ARN of the assessment template.

Returns:

The ARN of the assessment template.

name

public final String name()

The name of the assessment template.

Returns:

The name of the assessment template.

assessmentTargetArn

public final String assessmentTargetArn()

The ARN of the assessment target that corresponds to this assessment template.

Returns:

The ARN of the assessment target that corresponds to this assessment template.

durationInSeconds

public final Integer durationInSeconds()

The duration in seconds specified for this assessment template. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).

Returns:

The duration in seconds specified for this assessment template. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).

hasRulesPackageArns

public final boolean hasRulesPackageArns()

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

rulesPackageArns

public final List<String> rulesPackageArns()

The rules packages that are specified for this assessment template.

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

Returns:

The rules packages that are specified for this assessment template.

hasUserAttributesForFindings

public final boolean hasUserAttributesForFindings()

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

userAttributesForFindings

public final List<Attribute> userAttributesForFindings()

The user-defined attributes that are assigned to every generated finding from the assessment run that uses this assessment template.

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

Returns:

The user-defined attributes that are assigned to every generated finding from the assessment run that uses this assessment template.

lastAssessmentRunArn

public final String lastAssessmentRunArn()

The Amazon Resource Name (ARN) of the most recent assessment run associated with this assessment template. This value exists only when the value of assessmentRunCount is greaterpa than zero.

Returns:

The Amazon Resource Name (ARN) of the most recent assessment run associated with this assessment template. This value exists only when the value of assessmentRunCount is greaterpa than zero.

assessmentRunCount

public final Integer assessmentRunCount()

The number of existing assessment runs associated with this assessment template. This value can be zero or a positive integer.

Returns:

The number of existing assessment runs associated with this assessment template. This value can be zero or a positive integer.

createdAt

public final Instant createdAt()

The time at which the assessment template is created.

Returns:

The time at which the assessment template is created.

toBuilder

public AssessmentTemplate.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AssessmentTemplate.Builder,AssessmentTemplate>

builder

public static AssessmentTemplate.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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