Class Signal

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

Contains information about the signals involved in the attack sequence.

See Also:

  • Method Details

    • uid

      public final String uid()

      The unique identifier of the signal.

      Returns:
      The unique identifier of the signal.

    • type

      public final SignalType type()

      The type of the signal used to identify an attack sequence.

      Signals can be GuardDuty findings or activities observed in data sources that GuardDuty monitors. For more information, see Foundational data sources in the Amazon GuardDuty User Guide.

      A signal type can be one of the valid values listed in this API. Here are the related descriptions:

      • FINDING - Individually generated GuardDuty finding.

      • CLOUD_TRAIL - Activity observed from CloudTrail logs

      • S3_DATA_EVENTS - Activity observed from CloudTrail data events for S3. Activities associated with this type will show up only when you have enabled GuardDuty S3 Protection feature in your account. For more information about S3 Protection and steps to enable it, see S3 Protection in the Amazon GuardDuty User Guide.

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

      Returns:
      The type of the signal used to identify an attack sequence.

      Signals can be GuardDuty findings or activities observed in data sources that GuardDuty monitors. For more information, see Foundational data sources in the Amazon GuardDuty User Guide.

      A signal type can be one of the valid values listed in this API. Here are the related descriptions:

      • FINDING - Individually generated GuardDuty finding.

      • CLOUD_TRAIL - Activity observed from CloudTrail logs

      • S3_DATA_EVENTS - Activity observed from CloudTrail data events for S3. Activities associated with this type will show up only when you have enabled GuardDuty S3 Protection feature in your account. For more information about S3 Protection and steps to enable it, see S3 Protection in the Amazon GuardDuty User Guide.

      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the signal used to identify an attack sequence.

      Signals can be GuardDuty findings or activities observed in data sources that GuardDuty monitors. For more information, see Foundational data sources in the Amazon GuardDuty User Guide.

      A signal type can be one of the valid values listed in this API. Here are the related descriptions:

      • FINDING - Individually generated GuardDuty finding.

      • CLOUD_TRAIL - Activity observed from CloudTrail logs

      • S3_DATA_EVENTS - Activity observed from CloudTrail data events for S3. Activities associated with this type will show up only when you have enabled GuardDuty S3 Protection feature in your account. For more information about S3 Protection and steps to enable it, see S3 Protection in the Amazon GuardDuty User Guide.

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

      Returns:
      The type of the signal used to identify an attack sequence.

      Signals can be GuardDuty findings or activities observed in data sources that GuardDuty monitors. For more information, see Foundational data sources in the Amazon GuardDuty User Guide.

      A signal type can be one of the valid values listed in this API. Here are the related descriptions:

      • FINDING - Individually generated GuardDuty finding.

      • CLOUD_TRAIL - Activity observed from CloudTrail logs

      • S3_DATA_EVENTS - Activity observed from CloudTrail data events for S3. Activities associated with this type will show up only when you have enabled GuardDuty S3 Protection feature in your account. For more information about S3 Protection and steps to enable it, see S3 Protection in the Amazon GuardDuty User Guide.

      See Also:

    • description

      public final String description()

      The description of the signal.

      Returns:
      The description of the signal.

    • name

      public final String name()

      The name of the signal. For example, when signal type is FINDING, the signal name is the name of the finding.

      Returns:
      The name of the signal. For example, when signal type is FINDING, the signal name is the name of the finding.

    • createdAt

      public final Instant createdAt()

      The timestamp when the first finding or activity related to this signal was observed.

      Returns:
      The timestamp when the first finding or activity related to this signal was observed.

    • updatedAt

      public final Instant updatedAt()

      The timestamp when this signal was last observed.

      Returns:
      The timestamp when this signal was last observed.

    • firstSeenAt

      public final Instant firstSeenAt()

      The timestamp when the first finding or activity related to this signal was observed.

      Returns:
      The timestamp when the first finding or activity related to this signal was observed.

    • lastSeenAt

      public final Instant lastSeenAt()

      The timestamp when the last finding or activity related to this signal was observed.

      Returns:
      The timestamp when the last finding or activity related to this signal was observed.

    • severity

      public final Double severity()

      The severity associated with the signal. For more information about severity, see Findings severity levels in the Amazon GuardDuty User Guide.

      Returns:
      The severity associated with the signal. For more information about severity, see Findings severity levels in the Amazon GuardDuty User Guide.

    • count

      public final Integer count()

      The number of times this signal was observed.

      Returns:
      The number of times this signal was observed.

    • hasResourceUids

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

    • resourceUids

      public final List<String> resourceUids()

      Information about the unique identifiers of the resources involved in the signal.

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

      Returns:
      Information about the unique identifiers of the resources involved in the signal.

    • hasActorIds

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

    • actorIds

      public final List<String> actorIds()

      Information about the IDs of the threat actors involved in the signal.

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

      Returns:
      Information about the IDs of the threat actors involved in the signal.

    • hasEndpointIds

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

    • endpointIds

      public final List<String> endpointIds()

      Information about the endpoint IDs associated with this signal.

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

      Returns:
      Information about the endpoint IDs associated with this signal.

    • hasSignalIndicators

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

    • signalIndicators

      public final List<Indicator> signalIndicators()

      Contains information about the indicators associated with the signals.

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

      Returns:
      Contains information about the indicators associated with the signals.

    • toBuilder

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

    • builder

      public static Signal.Builder builder()

    • serializableBuilderClass

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