Class StartResourceEvaluationRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.config.model.ConfigRequest
software.amazon.awssdk.services.config.model.StartResourceEvaluationRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartResourceEvaluationRequest.Builder,StartResourceEvaluationRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartResourceEvaluationRequest extends ConfigRequest implements ToCopyableBuilder<StartResourceEvaluationRequest.Builder,StartResourceEvaluationRequest>

  • Method Details

    • resourceDetails

      public final ResourceDetails resourceDetails()

      Returns a ResourceDetails object.

      Returns:
      Returns a ResourceDetails object.

    • evaluationContext

      public final EvaluationContext evaluationContext()

      Returns an EvaluationContext object.

      Returns:
      Returns an EvaluationContext object.

    • evaluationMode

      public final EvaluationMode evaluationMode()

      The mode of an evaluation. The valid values for this API are DETECTIVE and PROACTIVE.

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

      Returns:
      The mode of an evaluation. The valid values for this API are DETECTIVE and PROACTIVE.
      See Also:

    • evaluationModeAsString

      public final String evaluationModeAsString()

      The mode of an evaluation. The valid values for this API are DETECTIVE and PROACTIVE.

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

      Returns:
      The mode of an evaluation. The valid values for this API are DETECTIVE and PROACTIVE.
      See Also:

    • evaluationTimeout

      public final Integer evaluationTimeout()

      The timeout for an evaluation. The default is 900 seconds. You cannot specify a number greater than 3600. If you specify 0, Config uses the default.

      Returns:
      The timeout for an evaluation. The default is 900 seconds. You cannot specify a number greater than 3600. If you specify 0, Config uses the default.

    • clientToken

      public final String clientToken()

      A client token is a unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions, specify a client token in the request.

      Avoid reusing the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, other than the Region or Availability Zone, the retry fails with an IdempotentParameterMismatch error.

      Returns:
      A client token is a unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions, specify a client token in the request.

      Avoid reusing the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, other than the Region or Availability Zone, the retry fails with an IdempotentParameterMismatch error.

    • toBuilder

      public StartResourceEvaluationRequest.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<StartResourceEvaluationRequest.Builder,StartResourceEvaluationRequest>
      Specified by:
      toBuilder in class ConfigRequest
      Returns:
      a builder for type T

    • builder

      public static StartResourceEvaluationRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.