software.amazon.awssdk.services.auditmanager.model

Class CreateAssessmentRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.auditmanager.model.AuditManagerRequest

software.amazon.awssdk.services.auditmanager.model.CreateAssessmentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateAssessmentRequest.Builder,CreateAssessmentRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateAssessmentRequest
extends AuditManagerRequest
implements ToCopyableBuilder<CreateAssessmentRequest.Builder,CreateAssessmentRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateAssessmentRequest.Builder

Method Summary

Modifier and Type	Method and Description
AssessmentReportsDestination	assessmentReportsDestination() The assessment report storage destination for the assessment that's being created.
static CreateAssessmentRequest.Builder	builder()
String	description() The optional description of the assessment to be created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	frameworkId() The identifier for the framework that the assessment will be created from.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRoles() For responses, this returns true if the service returned a value for the Roles property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	name() The name of the assessment to be created.
List<Role>	roles() The list of roles for the assessment.
Scope	scope() Returns the value of the Scope property for this object.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateAssessmentRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags() The tags that are associated with the assessment.
CreateAssessmentRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

name

public final String name()

The name of the assessment to be created.

Returns:

The name of the assessment to be created.

description

public final String description()

The optional description of the assessment to be created.

Returns:

The optional description of the assessment to be created.

assessmentReportsDestination

public final AssessmentReportsDestination assessmentReportsDestination()

The assessment report storage destination for the assessment that's being created.

Returns:

The assessment report storage destination for the assessment that's being created.

scope

public final Scope scope()

Returns the value of the Scope property for this object.

Returns:

The value of the Scope property for this object.

hasRoles

public final boolean hasRoles()

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

roles

public final List<Role> roles()

The list of roles for the assessment.

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

Returns:

The list of roles for the assessment.

frameworkId

public final String frameworkId()

The identifier for the framework that the assessment will be created from.

Returns:

The identifier for the framework that the assessment will be created from.

hasTags

public final boolean hasTags()

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

tags

public final Map<String,String> tags()

The tags that are associated with the assessment.

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

Returns:

The tags that are associated with the assessment.

toBuilder

public CreateAssessmentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateAssessmentRequest.Builder,CreateAssessmentRequest>

Specified by:

toBuilder in class AuditManagerRequest

builder

public static CreateAssessmentRequest.Builder builder()

serializableBuilderClass

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