Class GetRemediationsV2Request

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

  • Method Details

    • targetUid

      public final String targetUid()

      The unique identifier (ID) of an existing remediation target to return. Returns the single matching target. You can't use TargetUid together with MetadataUid or Filters.

      Returns:
      The unique identifier (ID) of an existing remediation target to return. Returns the single matching target. You can't use TargetUid together with MetadataUid or Filters.

    • metadataUid

      public final String metadataUid()

      The unique identifier (ID) of the Security Hub exposure finding, found under the metadata.uid field of the finding. Returns the remediation targets associated with that finding. You can't use MetadataUid together with TargetUid or Filters.

      Returns:
      The unique identifier (ID) of the Security Hub exposure finding, found under the metadata.uid field of the finding. Returns the remediation targets associated with that finding. You can't use MetadataUid together with TargetUid or Filters.

    • filters

      public final RemediationFilters filters()

      Filters remediation targets based on a set of criteria. You can't use Filters together with TargetUid or MetadataUid.

      Returns:
      Filters remediation targets based on a set of criteria. You can't use Filters together with TargetUid or MetadataUid.

    • showGuidance

      public final Boolean showGuidance()

      Specifies whether to show remediation target guidance.

      Returns:
      Specifies whether to show remediation target guidance.

    • guidanceFormat

      public final GuidanceFormat guidanceFormat()

      The format of the remediation guidance examples to return. Valid values are All, AwsCli, Cli, Python, Terraform, Cdk, CloudFormation, IaC, and Template. If you don't specify a value, all formats are returned. Applies only when ShowGuidance is true.

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

      Returns:
      The format of the remediation guidance examples to return. Valid values are All, AwsCli, Cli, Python, Terraform, Cdk, CloudFormation, IaC, and Template. If you don't specify a value, all formats are returned. Applies only when ShowGuidance is true.
      See Also:

    • guidanceFormatAsString

      public final String guidanceFormatAsString()

      The format of the remediation guidance examples to return. Valid values are All, AwsCli, Cli, Python, Terraform, Cdk, CloudFormation, IaC, and Template. If you don't specify a value, all formats are returned. Applies only when ShowGuidance is true.

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

      Returns:
      The format of the remediation guidance examples to return. Valid values are All, AwsCli, Cli, Python, Terraform, Cdk, CloudFormation, IaC, and Template. If you don't specify a value, all formats are returned. Applies only when ShowGuidance is true.
      See Also:

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return. Valid range is 1-100. If you don't specify a value, the operation returns up to 25 results.

      Returns:
      The maximum number of results to return. Valid range is 1-100. If you don't specify a value, the operation returns up to 25 results.

    • nextToken

      public final String nextToken()

      The token used to paginate the remediations target list returned. On your first call to GetRemediationsV2, omit this parameter or set it to NULL. For subsequent calls, use the NextToken value returned in the previous response to retrieve the next page of results.

      Returns:
      The token used to paginate the remediations target list returned. On your first call to GetRemediationsV2, omit this parameter or set it to NULL. For subsequent calls, use the NextToken value returned in the previous response to retrieve the next page of results.

    • toBuilder

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

    • builder

      public static GetRemediationsV2Request.Builder builder()

    • serializableBuilderClass

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