Class ServerlessFunctionAggregation

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

An aggregation of information about serverless functions.

See Also:

  • Method Details

    • hasResourceIds

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

    • resourceIds

      public final List<StringFilter> resourceIds()

      The resource IDs to aggregate findings for.

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

      Returns:
      The resource IDs to aggregate findings for.

    • hasFunctionNames

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

    • functionNames

      public final List<StringFilter> functionNames()

      The function names to aggregate findings for.

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

      Returns:
      The function names to aggregate findings for.

    • hasRuntimes

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

    • runtimes

      public final List<StringFilter> runtimes()

      The runtimes to aggregate findings for.

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

      Returns:
      The runtimes to aggregate findings for.

    • hasFunctionTags

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

    • functionTags

      public final List<MapFilter> functionTags()

      The function tags to aggregate findings for.

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

      Returns:
      The function tags to aggregate findings for.

    • hasCloudProviders

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

    • cloudProviders

      public final List<StringFilter> cloudProviders()

      The cloud providers to aggregate findings for. Valid values:

      • AWS – Findings from Amazon Web Services resources.

      • AZURE – Findings from Microsoft Azure resources.

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

      Returns:
      The cloud providers to aggregate findings for. Valid values:

      • AWS – Findings from Amazon Web Services resources.

      • AZURE – Findings from Microsoft Azure resources.

    • hasCloudPartitions

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

    • cloudPartitions

      public final List<StringFilter> cloudPartitions()

      The cloud partitions to aggregate findings for. Valid values:

      • aws – Amazon Web Services commercial Regions.

      • aws-cn – Amazon Web Services China Regions.

      • aws-us-gov – Amazon Web Services GovCloud (US) Regions.

      • AzureCloud – Azure commercial Regions.

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

      Returns:
      The cloud partitions to aggregate findings for. Valid values:

      • aws – Amazon Web Services commercial Regions.

      • aws-cn – Amazon Web Services China Regions.

      • aws-us-gov – Amazon Web Services GovCloud (US) Regions.

      • AzureCloud – Azure commercial Regions.

    • hasCloudRegions

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

    • cloudRegions

      public final List<StringFilter> cloudRegions()

      The cloud regions to aggregate findings for. The value format depends on the cloud provider:

      • An Amazon Web Services Region, such as us-east-1.

      • An Azure region, such as eastus.

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

      Returns:
      The cloud regions to aggregate findings for. The value format depends on the cloud provider:

      • An Amazon Web Services Region, such as us-east-1.

      • An Azure region, such as eastus.

    • hasCloudOrgIds

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

    • cloudOrgIds

      public final List<StringFilter> cloudOrgIds()

      The cloud organization IDs to aggregate findings for.

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

      Returns:
      The cloud organization IDs to aggregate findings for.

    • hasCloudAccountIds

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

    • cloudAccountIds

      public final List<StringFilter> cloudAccountIds()

      The cloud account IDs to aggregate findings for.

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

      Returns:
      The cloud account IDs to aggregate findings for.

    • sortOrder

      public final SortOrder sortOrder()

      The order to sort results by. Valid values are ASC and DESC.

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

      Returns:
      The order to sort results by. Valid values are ASC and DESC.
      See Also:

    • sortOrderAsString

      public final String sortOrderAsString()

      The order to sort results by. Valid values are ASC and DESC.

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

      Returns:
      The order to sort results by. Valid values are ASC and DESC.
      See Also:

    • sortBy

      public final ServerlessFunctionSortBy sortBy()

      The value to sort results by. Specify a field name from the aggregation response, such as CRITICAL, HIGH, or ALL.

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

      Returns:
      The value to sort results by. Specify a field name from the aggregation response, such as CRITICAL, HIGH, or ALL.
      See Also:

    • sortByAsString

      public final String sortByAsString()

      The value to sort results by. Specify a field name from the aggregation response, such as CRITICAL, HIGH, or ALL.

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

      Returns:
      The value to sort results by. Specify a field name from the aggregation response, such as CRITICAL, HIGH, or ALL.
      See Also:

    • toBuilder

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

    • builder

      public static ServerlessFunctionAggregation.Builder builder()

    • serializableBuilderClass

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