Class ApiInventoryItem
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ApiInventoryItem.Builder,ApiInventoryItem>
An API found by discovery.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal StringThe AWS account ID that owns the API.static ApiInventoryItem.Builderbuilder()final ClassificationReturns the value of the Classification property for this object.final StringReturns the value of the Classification property for this object.final DiscoverySourceReturns the value of the DiscoverySource property for this object.final StringReturns the value of the DiscoverySource property for this object.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final InstantWhen discovery first observed the API.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()final booleanFor responses, this returns true if the service returned a value for the Workloads property.final Stringhost()Returns the value of the Host property for this object.final InstantlastSeen()When discovery most recently observed the API.final ManagedByReturns the value of the ManagedBy property for this object.final StringReturns the value of the ManagedBy property for this object.final HttpMethodmethod()The HTTP method of the API.final StringThe HTTP method of the API.final Stringpath()The request path of the API.final Integerport()The port the API listens on, from 0 to 65535.final Stringregion()The AWS Region the API was discovered in.final StringThe ARN of the resource that serves the API, such as an API Gateway stage or a load balancer.static Class<? extends ApiInventoryItem.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.final VisibilityReturns the value of the Visibility property for this object.final StringReturns the value of the Visibility property for this object.final WafStatusReturns the value of the WafStatus property for this object.final StringReturns the value of the WafStatus property for this object.AI protocols seen in this API's traffic, each listed at most once.AI protocols seen in this API's traffic, each listed at most once.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
method
The HTTP method of the API.
If the service returns an enum value that is not available in the current SDK version,
methodwill returnHttpMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frommethodAsString().- Returns:
- The HTTP method of the API.
- See Also:
-
methodAsString
The HTTP method of the API.
If the service returns an enum value that is not available in the current SDK version,
methodwill returnHttpMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frommethodAsString().- Returns:
- The HTTP method of the API.
- See Also:
-
host
Returns the value of the Host property for this object.- Returns:
- The value of the Host property for this object.
-
port
The port the API listens on, from 0 to 65535.
- Returns:
- The port the API listens on, from 0 to 65535.
-
path
-
accountId
The AWS account ID that owns the API.
- Returns:
- The AWS account ID that owns the API.
-
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
The AWS Region the API was discovered in.
- Returns:
- The AWS Region the API was discovered in.
-
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,
discoverySourcewill returnDiscoverySource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdiscoverySourceAsString().- Returns:
- The value of the DiscoverySource property for this object.
- See Also:
-
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,
discoverySourcewill returnDiscoverySource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdiscoverySourceAsString().- Returns:
- The value of the DiscoverySource property for this object.
- See Also:
-
firstSeen
When discovery first observed the API.
- Returns:
- When discovery first observed the API.
-
lastSeen
When discovery most recently observed the API.
- Returns:
- When discovery most recently observed the API.
-
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,
visibilitywill returnVisibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromvisibilityAsString().- Returns:
- The value of the Visibility property for this object.
- See Also:
-
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,
visibilitywill returnVisibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromvisibilityAsString().- Returns:
- The value of the Visibility property for this object.
- See Also:
-
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,
wafStatuswill returnWafStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromwafStatusAsString().- Returns:
- The value of the WafStatus property for this object.
- See Also:
-
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,
wafStatuswill returnWafStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromwafStatusAsString().- Returns:
- The value of the WafStatus property for this object.
- See Also:
-
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,
classificationwill returnClassification.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromclassificationAsString().- Returns:
- The value of the Classification property for this object.
- See Also:
-
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,
classificationwill returnClassification.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromclassificationAsString().- Returns:
- The value of the Classification property for this object.
- See Also:
-
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,
managedBywill returnManagedBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frommanagedByAsString().- Returns:
- The value of the ManagedBy property for this object.
- See Also:
-
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,
managedBywill returnManagedBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frommanagedByAsString().- Returns:
- The value of the ManagedBy property for this object.
- See Also:
-
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 theisEmpty()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
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
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<ApiInventoryItem.Builder,ApiInventoryItem> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-