Class ScopeConfiguration

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

The scope of resources that Amazon Inspector scans for a single scanning type, including the scope level, the targeted resources, and the current state.

See Also:

  • Method Details

    • scopeType

      public final ScopeType scopeType()

      The type of scope. Valid values are TENANT, which scans all resources in the Azure tenant, and SUBSCRIPTION, which scans only the resources in the specified Azure subscriptions.

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

      Returns:
      The type of scope. Valid values are TENANT, which scans all resources in the Azure tenant, and SUBSCRIPTION, which scans only the resources in the specified Azure subscriptions.
      See Also:

    • scopeTypeAsString

      public final String scopeTypeAsString()

      The type of scope. Valid values are TENANT, which scans all resources in the Azure tenant, and SUBSCRIPTION, which scans only the resources in the specified Azure subscriptions.

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

      Returns:
      The type of scope. Valid values are TENANT, which scans all resources in the Azure tenant, and SUBSCRIPTION, which scans only the resources in the specified Azure subscriptions.
      See Also:

    • hasScopeValues

      public final boolean hasScopeValues()
      For responses, this returns true if the service returned a value for the ScopeValues 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.

    • scopeValues

      public final List<String> scopeValues()

      The list of scope values. For subscription-level scope, these are Azure subscription IDs.

      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 hasScopeValues() method.

      Returns:
      The list of scope values. For subscription-level scope, these are Azure subscription IDs.

    • state

      public final ScopeState state()

      The current state of the scope configuration.

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

      Returns:
      The current state of the scope configuration.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current state of the scope configuration.

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

      Returns:
      The current state of the scope configuration.
      See Also:

    • stateReason

      public final String stateReason()

      The reason for the current state of the scope configuration.

      Returns:
      The reason for the current state of the scope configuration.

    • toBuilder

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

    • builder

      public static ScopeConfiguration.Builder builder()

    • serializableBuilderClass

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