Class AnalyzerSummary

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

Contains information about the analyzer.

See Also:

  • Method Details

    • arn

      public final String arn()

      The ARN of the analyzer.

      Returns:
      The ARN of the analyzer.

    • name

      public final String name()

      The name of the analyzer.

      Returns:
      The name of the analyzer.

    • type

      public final Type type()

      The type of analyzer, which corresponds to the zone of trust chosen for the analyzer.

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

      Returns:
      The type of analyzer, which corresponds to the zone of trust chosen for the analyzer.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of analyzer, which corresponds to the zone of trust chosen for the analyzer.

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

      Returns:
      The type of analyzer, which corresponds to the zone of trust chosen for the analyzer.
      See Also:

    • createdAt

      public final Instant createdAt()

      A timestamp for the time at which the analyzer was created.

      Returns:
      A timestamp for the time at which the analyzer was created.

    • lastResourceAnalyzed

      public final String lastResourceAnalyzed()

      The resource that was most recently analyzed by the analyzer.

      Returns:
      The resource that was most recently analyzed by the analyzer.

    • lastResourceAnalyzedAt

      public final Instant lastResourceAnalyzedAt()

      The time at which the most recently analyzed resource was analyzed.

      Returns:
      The time at which the most recently analyzed resource was analyzed.

    • 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 added to the analyzer.

      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 added to the analyzer.

    • status

      public final AnalyzerStatus status()

      The status of the analyzer. An Active analyzer successfully monitors supported resources and generates new findings. The analyzer is Disabled when a user action, such as removing trusted access for Identity and Access Management Access Analyzer from Organizations, causes the analyzer to stop generating new findings. The status is Creating when the analyzer creation is in progress and Failed when the analyzer creation has failed.

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

      Returns:
      The status of the analyzer. An Active analyzer successfully monitors supported resources and generates new findings. The analyzer is Disabled when a user action, such as removing trusted access for Identity and Access Management Access Analyzer from Organizations, causes the analyzer to stop generating new findings. The status is Creating when the analyzer creation is in progress and Failed when the analyzer creation has failed.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the analyzer. An Active analyzer successfully monitors supported resources and generates new findings. The analyzer is Disabled when a user action, such as removing trusted access for Identity and Access Management Access Analyzer from Organizations, causes the analyzer to stop generating new findings. The status is Creating when the analyzer creation is in progress and Failed when the analyzer creation has failed.

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

      Returns:
      The status of the analyzer. An Active analyzer successfully monitors supported resources and generates new findings. The analyzer is Disabled when a user action, such as removing trusted access for Identity and Access Management Access Analyzer from Organizations, causes the analyzer to stop generating new findings. The status is Creating when the analyzer creation is in progress and Failed when the analyzer creation has failed.
      See Also:

    • statusReason

      public final StatusReason statusReason()

      The statusReason provides more details about the current status of the analyzer. For example, if the creation for the analyzer fails, a Failed status is returned. For an analyzer with organization as the type, this failure can be due to an issue with creating the service-linked roles required in the member accounts of the Amazon Web Services organization.

      Returns:
      The statusReason provides more details about the current status of the analyzer. For example, if the creation for the analyzer fails, a Failed status is returned. For an analyzer with organization as the type, this failure can be due to an issue with creating the service-linked roles required in the member accounts of the Amazon Web Services organization.

    • configuration

      public final AnalyzerConfiguration configuration()

      Specifies if the analyzer is an external access, unused access, or internal access analyzer.

      Returns:
      Specifies if the analyzer is an external access, unused access, or internal access analyzer.

    • toBuilder

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

    • builder

      public static AnalyzerSummary.Builder builder()

    • serializableBuilderClass

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