Class ApiInventoryItem

java.lang.Object
software.amazon.awssdk.services.apiportal.model.ApiInventoryItem
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ApiInventoryItem.Builder,ApiInventoryItem>

@Generated("software.amazon.awssdk:codegen") public final class ApiInventoryItem extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ApiInventoryItem.Builder,ApiInventoryItem>

An API found by discovery.

See Also:
  • Method Details

    • method

      public final HttpMethod method()

      The HTTP method of the API.

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

      Returns:
      The HTTP method of the API.
      See Also:
    • methodAsString

      public final String methodAsString()

      The HTTP method of the API.

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

      Returns:
      The HTTP method of the API.
      See Also:
    • host

      public final String host()
      Returns the value of the Host property for this object.
      Returns:
      The value of the Host property for this object.
    • port

      public final Integer port()

      The port the API listens on, from 0 to 65535.

      Returns:
      The port the API listens on, from 0 to 65535.
    • path

      public final String path()

      The request path of the API.

      Returns:
      The request path of the API.
    • accountId

      public final String accountId()

      The AWS account ID that owns the API.

      Returns:
      The AWS account ID that owns the API.
    • resourceArn

      public final String resourceArn()

      The ARN of the resource that serves the API, such as an API Gateway stage or a load balancer.

      Returns:
      The ARN of the resource that serves the API, such as an API Gateway stage or a load balancer.
    • region

      public final String region()

      The AWS Region the API was discovered in.

      Returns:
      The AWS Region the API was discovered in.
    • discoverySource

      public final DiscoverySource discoverySource()
      Returns the value of the DiscoverySource property for this object.

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

      Returns:
      The value of the DiscoverySource property for this object.
      See Also:
    • discoverySourceAsString

      public final String discoverySourceAsString()
      Returns the value of the DiscoverySource property for this object.

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

      Returns:
      The value of the DiscoverySource property for this object.
      See Also:
    • firstSeen

      public final Instant firstSeen()

      When discovery first observed the API.

      Returns:
      When discovery first observed the API.
    • lastSeen

      public final Instant lastSeen()

      When discovery most recently observed the API.

      Returns:
      When discovery most recently observed the API.
    • visibility

      public final Visibility visibility()
      Returns the value of the Visibility property for this object.

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

      Returns:
      The value of the Visibility property for this object.
      See Also:
    • visibilityAsString

      public final String visibilityAsString()
      Returns the value of the Visibility property for this object.

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

      Returns:
      The value of the Visibility property for this object.
      See Also:
    • wafStatus

      public final WafStatus wafStatus()
      Returns the value of the WafStatus property for this object.

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

      Returns:
      The value of the WafStatus property for this object.
      See Also:
    • wafStatusAsString

      public final String wafStatusAsString()
      Returns the value of the WafStatus property for this object.

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

      Returns:
      The value of the WafStatus property for this object.
      See Also:
    • classification

      public final Classification classification()
      Returns the value of the Classification property for this object.

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

      Returns:
      The value of the Classification property for this object.
      See Also:
    • classificationAsString

      public final String classificationAsString()
      Returns the value of the Classification property for this object.

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

      Returns:
      The value of the Classification property for this object.
      See Also:
    • managedBy

      public final ManagedBy managedBy()
      Returns the value of the ManagedBy property for this object.

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

      Returns:
      The value of the ManagedBy property for this object.
      See Also:
    • managedByAsString

      public final String managedByAsString()
      Returns the value of the ManagedBy property for this object.

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

      Returns:
      The value of the ManagedBy property for this object.
      See Also:
    • workloads

      public final List<Workload> workloads()

      AI protocols seen in this API's traffic, each listed at most once. Absent when none has been reported, which includes an account that has not enabled AI discovery.

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

      Returns:
      AI protocols seen in this API's traffic, each listed at most once. Absent when none has been reported, which includes an account that has not enabled AI discovery.
    • hasWorkloads

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

      public final List<String> workloadsAsStrings()

      AI protocols seen in this API's traffic, each listed at most once. Absent when none has been reported, which includes an account that has not enabled AI discovery.

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

      Returns:
      AI protocols seen in this API's traffic, each listed at most once. Absent when none has been reported, which includes an account that has not enabled AI discovery.
    • toBuilder

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

      public static ApiInventoryItem.Builder builder()
    • serializableBuilderClass

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