software.amazon.awssdk.services.inspector.model

Class GetExclusionsPreviewRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetExclusionsPreviewRequest.Builder,GetExclusionsPreviewRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetExclusionsPreviewRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	assessmentTemplateArn() The ARN that specifies the assessment template for which the exclusions preview was requested.
static GetExclusionsPreviewRequest.Builder	builder()
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()
Locale	locale() The locale into which you want to translate the exclusion's title, description, and recommendation.
String	localeAsString() The locale into which you want to translate the exclusion's title, description, and recommendation.
Integer	maxResults() You can use this parameter to indicate the maximum number of items you want in the response.
String	nextToken() You can use this parameter when paginating results.
String	previewToken() The unique identifier associated of the exclusions preview.
List<SdkField<?>>	sdkFields()
static Class<? extends GetExclusionsPreviewRequest.Builder>	serializableBuilderClass()
GetExclusionsPreviewRequest.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.

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

assessmentTemplateArn

public String assessmentTemplateArn()

The ARN that specifies the assessment template for which the exclusions preview was requested.

Returns:

The ARN that specifies the assessment template for which the exclusions preview was requested.

previewToken

public String previewToken()

The unique identifier associated of the exclusions preview.

Returns:

The unique identifier associated of the exclusions preview.

nextToken

public String nextToken()

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the GetExclusionsPreviewRequest action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data.

Returns:

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the GetExclusionsPreviewRequest action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data.

maxResults

public Integer maxResults()

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 100. The maximum value is 500.

Returns:

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 100. The maximum value is 500.

locale

public Locale locale()

The locale into which you want to translate the exclusion's title, description, and recommendation.

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

Returns:

The locale into which you want to translate the exclusion's title, description, and recommendation.

See Also:

Locale

localeAsString

public String localeAsString()

The locale into which you want to translate the exclusion's title, description, and recommendation.

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

Returns:

The locale into which you want to translate the exclusion's title, description, and recommendation.

See Also:

Locale

toBuilder

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

Specified by:

toBuilder in class InspectorRequest

Returns:

a builder for type T

builder

public static GetExclusionsPreviewRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

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