Package software.amazon.awssdk.services.inspector.model

Class CreateAssessmentTemplateRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.inspector.model.InspectorRequest

software.amazon.awssdk.services.inspector.model.CreateAssessmentTemplateRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateAssessmentTemplateRequest.Builder,CreateAssessmentTemplateRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateAssessmentTemplateRequest
extends InspectorRequest
implements ToCopyableBuilder<CreateAssessmentTemplateRequest.Builder,CreateAssessmentTemplateRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateAssessmentTemplateRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	assessmentTargetArn()	The ARN that specifies the assessment target for which you want to create the assessment template.
String	assessmentTemplateName()	The user-defined name that identifies the assessment template that you want to create.
static CreateAssessmentTemplateRequest.Builder	builder()
Integer	durationInSeconds()	The duration of the assessment run in seconds.
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.
List<String>	rulesPackageArns()	The ARNs that specify the rules packages that you want to attach to the assessment template.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateAssessmentTemplateRequest.Builder>	serializableBuilderClass()
CreateAssessmentTemplateRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<Attribute>	userAttributesForFindings()	The user-defined attributes that are assigned to every finding that is generated by the assessment run that uses this assessment template.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

assessmentTargetArn

public final String assessmentTargetArn()

The ARN that specifies the assessment target for which you want to create the assessment template.

Returns:

The ARN that specifies the assessment target for which you want to create the assessment template.

assessmentTemplateName

public final String assessmentTemplateName()

The user-defined name that identifies the assessment template that you want to create. You can create several assessment templates for an assessment target. The names of the assessment templates that correspond to a particular assessment target must be unique.

Returns:

The user-defined name that identifies the assessment template that you want to create. You can create several assessment templates for an assessment target. The names of the assessment templates that correspond to a particular assessment target must be unique.

durationInSeconds

public final Integer durationInSeconds()

The duration of the assessment run in seconds.

Returns:

The duration of the assessment run in seconds.

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 ARNs that specify the rules packages that you want to attach to the 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 ARNs that specify the rules packages that you want to attach to the 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 finding that is generated by the assessment run that uses this assessment template. An attribute is a key and value pair (an Attribute object). Within an assessment template, each key must be unique.

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 finding that is generated by the assessment run that uses this assessment template. An attribute is a key and value pair (an Attribute object). Within an assessment template, each key must be unique.

toBuilder

public CreateAssessmentTemplateRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateAssessmentTemplateRequest.Builder,CreateAssessmentTemplateRequest>

Specified by:

toBuilder in class InspectorRequest

builder

public static CreateAssessmentTemplateRequest.Builder builder()

serializableBuilderClass

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

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo