Class Resource

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

A resource related to a finding.

See Also:

  • Method Details

    • type

      public final String type()

      The type of the resource that details are provided for. If possible, set Type to one of the supported resource types. For example, if the resource is an EC2 instance, then set Type to AwsEc2Instance.

      If the resource does not match any of the provided types, then set Type to Other.

      Length Constraints: Minimum length of 1. Maximum length of 256.

      Returns:
      The type of the resource that details are provided for. If possible, set Type to one of the supported resource types. For example, if the resource is an EC2 instance, then set Type to AwsEc2Instance.

      If the resource does not match any of the provided types, then set Type to Other.

      Length Constraints: Minimum length of 1. Maximum length of 256.

    • id

      public final String id()

      The canonical identifier for the given resource type.

      Returns:
      The canonical identifier for the given resource type.

    • partition

      public final Partition partition()

      The canonical Amazon Web Services partition name that the Region is assigned to.

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

      Returns:
      The canonical Amazon Web Services partition name that the Region is assigned to.
      See Also:

    • partitionAsString

      public final String partitionAsString()

      The canonical Amazon Web Services partition name that the Region is assigned to.

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

      Returns:
      The canonical Amazon Web Services partition name that the Region is assigned to.
      See Also:

    • region

      public final String region()

      The canonical Amazon Web Services external Region name where this resource is located.

      Length Constraints: Minimum length of 1. Maximum length of 16.

      Returns:
      The canonical Amazon Web Services external Region name where this resource is located.

      Length Constraints: Minimum length of 1. Maximum length of 16.

    • resourceRole

      public final String resourceRole()

      Identifies the role of the resource in the finding. A resource is either the actor or target of the finding activity,

      Returns:
      Identifies the role of the resource in the finding. A resource is either the actor or target of the finding activity,

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

      A list of Amazon Web Services tags associated with a resource at the time the finding was processed. Tags must follow Amazon Web Services tag naming limits and requirements.

      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:
      A list of Amazon Web Services tags associated with a resource at the time the finding was processed. Tags must follow Amazon Web Services tag naming limits and requirements.

    • dataClassification

      public final DataClassificationDetails dataClassification()

      Contains information about sensitive data that was detected on the resource.

      Returns:
      Contains information about sensitive data that was detected on the resource.

    • details

      public final ResourceDetails details()

      Additional details about the resource related to a finding.

      Returns:
      Additional details about the resource related to a finding.

    • applicationName

      public final String applicationName()

      The name of the application that is related to a finding.

      Returns:
      The name of the application that is related to a finding.

    • applicationArn

      public final String applicationArn()

      The Amazon Resource Name (ARN) of the application that is related to a finding.

      Returns:
      The Amazon Resource Name (ARN) of the application that is related to a finding.

    • toBuilder

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

    • builder

      public static Resource.Builder builder()

    • serializableBuilderClass

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