Class ScanJobSummary

java.lang.Object
software.amazon.awssdk.services.backup.model.ScanJobSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ScanJobSummary.Builder,ScanJobSummary>
@Generated("software.amazon.awssdk:codegen") public final class ScanJobSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ScanJobSummary.Builder,ScanJobSummary>

Contains summary information about scan jobs, including counts and metadata for a specific time period and criteria.

See Also:

  • Method Details

    • region

      public final String region()

      The Amazon Web Services Region where the scan jobs were executed.

      Returns:
      The Amazon Web Services Region where the scan jobs were executed.

    • accountId

      public final String accountId()

      The account ID that owns the scan jobs included in this summary.

      Returns:
      The account ID that owns the scan jobs included in this summary.

    • state

      public final ScanJobStatus state()

      The state of the scan jobs included in this summary.

      Valid values: CREATED | RUNNING | COMPLETED | COMPLETED_WITH_ISSUES | FAILED | CANCELED.

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

      Returns:
      The state of the scan jobs included in this summary.

      Valid values: CREATED | RUNNING | COMPLETED | COMPLETED_WITH_ISSUES | FAILED | CANCELED.

      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the scan jobs included in this summary.

      Valid values: CREATED | RUNNING | COMPLETED | COMPLETED_WITH_ISSUES | FAILED | CANCELED.

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

      Returns:
      The state of the scan jobs included in this summary.

      Valid values: CREATED | RUNNING | COMPLETED | COMPLETED_WITH_ISSUES | FAILED | CANCELED.

      See Also:

    • resourceType

      public final String resourceType()

      The type of Amazon Web Services resource for the scan jobs included in this summary.

      Returns:
      The type of Amazon Web Services resource for the scan jobs included in this summary.

    • count

      public final Integer count()

      The number of scan jobs that match the specified criteria.

      Returns:
      The number of scan jobs that match the specified criteria.

    • startTime

      public final Instant startTime()

      The value of time in number format of a job start time.

      This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      Returns:
      The value of time in number format of a job start time.

      This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    • endTime

      public final Instant endTime()

      The value of time in number format of a job end time.

      This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      Returns:
      The value of time in number format of a job end time.

      This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    • malwareScanner

      public final MalwareScanner malwareScanner()

      Specifies the malware scanner used during the scan job. Currently only supports GUARDDUTY.

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

      Returns:
      Specifies the malware scanner used during the scan job. Currently only supports GUARDDUTY.
      See Also:

    • malwareScannerAsString

      public final String malwareScannerAsString()

      Specifies the malware scanner used during the scan job. Currently only supports GUARDDUTY.

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

      Returns:
      Specifies the malware scanner used during the scan job. Currently only supports GUARDDUTY.
      See Also:

    • scanResultStatus

      public final ScanResultStatus scanResultStatus()

      The scan result status for the scan jobs included in this summary.

      Valid values: THREATS_FOUND | NO_THREATS_FOUND.

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

      Returns:
      The scan result status for the scan jobs included in this summary.

      Valid values: THREATS_FOUND | NO_THREATS_FOUND.

      See Also:

    • scanResultStatusAsString

      public final String scanResultStatusAsString()

      The scan result status for the scan jobs included in this summary.

      Valid values: THREATS_FOUND | NO_THREATS_FOUND.

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

      Returns:
      The scan result status for the scan jobs included in this summary.

      Valid values: THREATS_FOUND | NO_THREATS_FOUND.

      See Also:

    • toBuilder

      public ScanJobSummary.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<ScanJobSummary.Builder,ScanJobSummary>
      Returns:
      a builder for type T

    • builder

      public static ScanJobSummary.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • 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)

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