software.amazon.awssdk.services.inspector.model

Class StopAssessmentRunRequest

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.StopAssessmentRunRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StopAssessmentRunRequest.Builder,StopAssessmentRunRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StopAssessmentRunRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	assessmentRunArn() The ARN of the assessment run that you want to stop.
static StopAssessmentRunRequest.Builder	builder()
boolean	equals(Object obj)
<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()
List<SdkField<?>>	sdkFields()
static Class<? extends StopAssessmentRunRequest.Builder>	serializableBuilderClass()
StopAction	stopAction() An input option that can be set to either START_EVALUATION or SKIP_EVALUATION.
String	stopActionAsString() An input option that can be set to either START_EVALUATION or SKIP_EVALUATION.
StopAssessmentRunRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

assessmentRunArn

public String assessmentRunArn()

The ARN of the assessment run that you want to stop.

Returns:

The ARN of the assessment run that you want to stop.

stopAction

public StopAction stopAction()

An input option that can be set to either START_EVALUATION or SKIP_EVALUATION. START_EVALUATION (the default value), stops the AWS agent from collecting data and begins the results evaluation and the findings generation process. SKIP_EVALUATION cancels the assessment run immediately, after which no findings are generated.

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

Returns:

An input option that can be set to either START_EVALUATION or SKIP_EVALUATION. START_EVALUATION (the default value), stops the AWS agent from collecting data and begins the results evaluation and the findings generation process. SKIP_EVALUATION cancels the assessment run immediately, after which no findings are generated.

See Also:

StopAction

stopActionAsString

public String stopActionAsString()

An input option that can be set to either START_EVALUATION or SKIP_EVALUATION. START_EVALUATION (the default value), stops the AWS agent from collecting data and begins the results evaluation and the findings generation process. SKIP_EVALUATION cancels the assessment run immediately, after which no findings are generated.

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

Returns:

An input option that can be set to either START_EVALUATION or SKIP_EVALUATION. START_EVALUATION (the default value), stops the AWS agent from collecting data and begins the results evaluation and the findings generation process. SKIP_EVALUATION cancels the assessment run immediately, after which no findings are generated.

See Also:

StopAction

toBuilder

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

Specified by:

toBuilder in class InspectorRequest

Returns:

a builder for type T

builder

public static StopAssessmentRunRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StopAssessmentRunRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <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 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.