Class CodeSecurityScanConfigurationSummary

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

A summary of information about a code security scan configuration.

See Also:

  • Method Details

    • scanConfigurationArn

      public final String scanConfigurationArn()

      The Amazon Resource Name (ARN) of the scan configuration.

      Returns:
      The Amazon Resource Name (ARN) of the scan configuration.

    • name

      public final String name()

      The name of the scan configuration.

      Returns:
      The name of the scan configuration.

    • ownerAccountId

      public final String ownerAccountId()

      The Amazon Web Services account ID that owns the scan configuration.

      Returns:
      The Amazon Web Services account ID that owns the scan configuration.

    • periodicScanFrequency

      public final PeriodicScanFrequency periodicScanFrequency()

      The frequency at which periodic scans are performed.

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

      Returns:
      The frequency at which periodic scans are performed.
      See Also:

    • periodicScanFrequencyAsString

      public final String periodicScanFrequencyAsString()

      The frequency at which periodic scans are performed.

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

      Returns:
      The frequency at which periodic scans are performed.
      See Also:

    • frequencyExpression

      public final String frequencyExpression()

      The schedule expression for periodic scans, in cron format.

      Returns:
      The schedule expression for periodic scans, in cron format.

    • continuousIntegrationScanSupportedEvents

      public final List<ContinuousIntegrationScanEvent> continuousIntegrationScanSupportedEvents()

      The repository events that trigger continuous integration scans.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasContinuousIntegrationScanSupportedEvents() method.

      Returns:
      The repository events that trigger continuous integration scans.

    • hasContinuousIntegrationScanSupportedEvents

      public final boolean hasContinuousIntegrationScanSupportedEvents()
      For responses, this returns true if the service returned a value for the ContinuousIntegrationScanSupportedEvents property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • continuousIntegrationScanSupportedEventsAsStrings

      public final List<String> continuousIntegrationScanSupportedEventsAsStrings()

      The repository events that trigger continuous integration scans.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasContinuousIntegrationScanSupportedEvents() method.

      Returns:
      The repository events that trigger continuous integration scans.

    • ruleSetCategories

      public final List<RuleSetCategory> ruleSetCategories()

      The categories of security rules applied during the scan.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRuleSetCategories() method.

      Returns:
      The categories of security rules applied during the scan.

    • hasRuleSetCategories

      public final boolean hasRuleSetCategories()
      For responses, this returns true if the service returned a value for the RuleSetCategories property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • ruleSetCategoriesAsStrings

      public final List<String> ruleSetCategoriesAsStrings()

      The categories of security rules applied during the scan.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRuleSetCategories() method.

      Returns:
      The categories of security rules applied during the scan.

    • scopeSettings

      public final ScopeSettings scopeSettings()

      The scope settings that define which repositories will be scanned. If the ScopeSetting parameter is ALL the scan configuration applies to all existing and future projects imported into Amazon Inspector.

      Returns:
      The scope settings that define which repositories will be scanned. If the ScopeSetting parameter is ALL the scan configuration applies to all existing and future projects imported into Amazon Inspector.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final Map<String,String> tags()

      The tags associated with the scan configuration.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      The tags associated with the scan configuration.

    • toBuilder

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

    • builder

      public static CodeSecurityScanConfigurationSummary.Builder builder()

    • serializableBuilderClass

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