Class RemediationProperties


  • public final class RemediationProperties
    extends Object
    The remediation properties.
    • Constructor Detail

      • RemediationProperties

        public RemediationProperties()
    • Method Detail

      • policyAssignmentId

        public String policyAssignmentId()
        Get the policyAssignmentId property: The resource ID of the policy assignment that should be remediated.
        Returns:
        the policyAssignmentId value.
      • withPolicyAssignmentId

        public RemediationProperties withPolicyAssignmentId​(String policyAssignmentId)
        Set the policyAssignmentId property: The resource ID of the policy assignment that should be remediated.
        Parameters:
        policyAssignmentId - the policyAssignmentId value to set.
        Returns:
        the RemediationProperties object itself.
      • policyDefinitionReferenceId

        public String policyDefinitionReferenceId()
        Get the policyDefinitionReferenceId property: The policy definition reference ID of the individual definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.
        Returns:
        the policyDefinitionReferenceId value.
      • withPolicyDefinitionReferenceId

        public RemediationProperties withPolicyDefinitionReferenceId​(String policyDefinitionReferenceId)
        Set the policyDefinitionReferenceId property: The policy definition reference ID of the individual definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition.
        Parameters:
        policyDefinitionReferenceId - the policyDefinitionReferenceId value to set.
        Returns:
        the RemediationProperties object itself.
      • resourceDiscoveryMode

        public ResourceDiscoveryMode resourceDiscoveryMode()
        Get the resourceDiscoveryMode property: The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified.
        Returns:
        the resourceDiscoveryMode value.
      • withResourceDiscoveryMode

        public RemediationProperties withResourceDiscoveryMode​(ResourceDiscoveryMode resourceDiscoveryMode)
        Set the resourceDiscoveryMode property: The way resources to remediate are discovered. Defaults to ExistingNonCompliant if not specified.
        Parameters:
        resourceDiscoveryMode - the resourceDiscoveryMode value to set.
        Returns:
        the RemediationProperties object itself.
      • provisioningState

        public String provisioningState()
        Get the provisioningState property: The status of the remediation.
        Returns:
        the provisioningState value.
      • createdOn

        public OffsetDateTime createdOn()
        Get the createdOn property: The time at which the remediation was created.
        Returns:
        the createdOn value.
      • lastUpdatedOn

        public OffsetDateTime lastUpdatedOn()
        Get the lastUpdatedOn property: The time at which the remediation was last updated.
        Returns:
        the lastUpdatedOn value.
      • filters

        public RemediationFilters filters()
        Get the filters property: The filters that will be applied to determine which resources to remediate.
        Returns:
        the filters value.
      • withFilters

        public RemediationProperties withFilters​(RemediationFilters filters)
        Set the filters property: The filters that will be applied to determine which resources to remediate.
        Parameters:
        filters - the filters value to set.
        Returns:
        the RemediationProperties object itself.
      • deploymentStatus

        public RemediationDeploymentSummary deploymentStatus()
        Get the deploymentStatus property: The deployment status summary for all deployments created by the remediation.
        Returns:
        the deploymentStatus value.
      • statusMessage

        public String statusMessage()
        Get the statusMessage property: The remediation status message. Provides additional details regarding the state of the remediation.
        Returns:
        the statusMessage value.
      • correlationId

        public String correlationId()
        Get the correlationId property: The remediation correlation Id. Can be used to find events related to the remediation in the activity log.
        Returns:
        the correlationId value.
      • resourceCount

        public Integer resourceCount()
        Get the resourceCount property: Determines the max number of resources that can be remediated by the remediation job. If not provided, the default resource count is used.
        Returns:
        the resourceCount value.
      • withResourceCount

        public RemediationProperties withResourceCount​(Integer resourceCount)
        Set the resourceCount property: Determines the max number of resources that can be remediated by the remediation job. If not provided, the default resource count is used.
        Parameters:
        resourceCount - the resourceCount value to set.
        Returns:
        the RemediationProperties object itself.
      • parallelDeployments

        public Integer parallelDeployments()
        Get the parallelDeployments property: Determines how many resources to remediate at any given time. Can be used to increase or reduce the pace of the remediation. If not provided, the default parallel deployments value is used.
        Returns:
        the parallelDeployments value.
      • withParallelDeployments

        public RemediationProperties withParallelDeployments​(Integer parallelDeployments)
        Set the parallelDeployments property: Determines how many resources to remediate at any given time. Can be used to increase or reduce the pace of the remediation. If not provided, the default parallel deployments value is used.
        Parameters:
        parallelDeployments - the parallelDeployments value to set.
        Returns:
        the RemediationProperties object itself.
      • failureThreshold

        public RemediationPropertiesFailureThreshold failureThreshold()
        Get the failureThreshold property: The remediation failure threshold settings.
        Returns:
        the failureThreshold value.
      • withFailureThreshold

        public RemediationProperties withFailureThreshold​(RemediationPropertiesFailureThreshold failureThreshold)
        Set the failureThreshold property: The remediation failure threshold settings.
        Parameters:
        failureThreshold - the failureThreshold value to set.
        Returns:
        the RemediationProperties object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.