Class Product

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

Contains details about a product.

See Also:

  • Method Details

    • productArn

      public final String productArn()

      The ARN assigned to the product.

      Returns:
      The ARN assigned to the product.

    • productName

      public final String productName()

      The name of the product.

      Returns:
      The name of the product.

    • companyName

      public final String companyName()

      The name of the company that provides the product.

      Returns:
      The name of the company that provides the product.

    • description

      public final String description()

      A description of the product.

      Returns:
      A description of the product.

    • hasCategories

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

    • categories

      public final List<String> categories()

      The categories assigned to the product.

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

      Returns:
      The categories assigned to the product.

    • integrationTypes

      public final List<IntegrationType> integrationTypes()

      The types of integration that the product supports. Available values are the following.

      • SEND_FINDINGS_TO_SECURITY_HUB - The integration sends findings to Security Hub.

      • RECEIVE_FINDINGS_FROM_SECURITY_HUB - The integration receives findings from Security Hub.

      • UPDATE_FINDINGS_IN_SECURITY_HUB - The integration does not send new findings to Security Hub, but does make updates to the findings that it receives from Security Hub.

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

      Returns:
      The types of integration that the product supports. Available values are the following.

      • SEND_FINDINGS_TO_SECURITY_HUB - The integration sends findings to Security Hub.

      • RECEIVE_FINDINGS_FROM_SECURITY_HUB - The integration receives findings from Security Hub.

      • UPDATE_FINDINGS_IN_SECURITY_HUB - The integration does not send new findings to Security Hub, but does make updates to the findings that it receives from Security Hub.

    • hasIntegrationTypes

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

    • integrationTypesAsStrings

      public final List<String> integrationTypesAsStrings()

      The types of integration that the product supports. Available values are the following.

      • SEND_FINDINGS_TO_SECURITY_HUB - The integration sends findings to Security Hub.

      • RECEIVE_FINDINGS_FROM_SECURITY_HUB - The integration receives findings from Security Hub.

      • UPDATE_FINDINGS_IN_SECURITY_HUB - The integration does not send new findings to Security Hub, but does make updates to the findings that it receives from Security Hub.

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

      Returns:
      The types of integration that the product supports. Available values are the following.

      • SEND_FINDINGS_TO_SECURITY_HUB - The integration sends findings to Security Hub.

      • RECEIVE_FINDINGS_FROM_SECURITY_HUB - The integration receives findings from Security Hub.

      • UPDATE_FINDINGS_IN_SECURITY_HUB - The integration does not send new findings to Security Hub, but does make updates to the findings that it receives from Security Hub.

    • marketplaceUrl

      public final String marketplaceUrl()

      For integrations with Amazon Web Services services, the Amazon Web Services Console URL from which to activate the service.

      For integrations with third-party products, the Amazon Web Services Marketplace URL from which to subscribe to or purchase the product.

      Returns:
      For integrations with Amazon Web Services services, the Amazon Web Services Console URL from which to activate the service.

      For integrations with third-party products, the Amazon Web Services Marketplace URL from which to subscribe to or purchase the product.

    • activationUrl

      public final String activationUrl()

      The URL to the service or product documentation about the integration with Security Hub, including how to activate the integration.

      Returns:
      The URL to the service or product documentation about the integration with Security Hub, including how to activate the integration.

    • productSubscriptionResourcePolicy

      public final String productSubscriptionResourcePolicy()

      The resource policy associated with the product.

      Returns:
      The resource policy associated with the product.

    • toBuilder

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

    • builder

      public static Product.Builder builder()

    • serializableBuilderClass

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