Class GetExclusionsPreviewRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetExclusionsPreviewRequest.Builder,GetExclusionsPreviewRequest>

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

    • assessmentTemplateArn

      public final 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 final String previewToken()

      The unique identifier associated of the exclusions preview.

      Returns:
      The unique identifier associated of the exclusions preview.
    • nextToken

      public final 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 final 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 final 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:
    • localeAsString

      public final 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:
    • 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 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.