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(value="software.amazon.awssdk:codegen")
public final class CreateAssessmentTemplateRequest
extends InspectorRequest
implements ToCopyableBuilder<CreateAssessmentTemplateRequest.Builder,CreateAssessmentTemplateRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateAssessmentTemplateRequest.Builder

Method Summary

Modifier and Type	Method and 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) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
boolean	hasRulesPackageArns() Returns true if the RulesPackageArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasUserAttributesForFindings() Returns true if the UserAttributesForFindings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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() 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.
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

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

Returns true if the RulesPackageArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasRulesPackageArns() to see if a value was sent in this field.

Returns:

The ARNs that specify the rules packages that you want to attach to the assessment template.

hasUserAttributesForFindings

public final boolean hasUserAttributesForFindings()

Returns true if the UserAttributesForFindings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasUserAttributesForFindings() to see if a value was sent in this field.

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

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<CreateAssessmentTemplateRequest.Builder,CreateAssessmentTemplateRequest>

Specified by:

toBuilder in class InspectorRequest

Returns:

a builder for type T

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)

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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

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.