Class Edge
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Edge.Builder,
Edge>
Information about a connection between two services. An edge can be a synchronous connection, such as typical call between client and service, or an asynchronous link, such as a Lambda function which retrieves an event from an SNS queue.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionaliases()
Aliases for the edge.static Edge.Builder
builder()
final String
edgeType()
Describes an asynchronous connection, with a value oflink
.final Instant
endTime()
The end time of the last segment on the edge.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Aliases property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ReceivedEventAgeHistogram property.final boolean
For responses, this returns true if the service returned a value for the ResponseTimeHistogram property.final List
<HistogramEntry> A histogram that maps the spread of event age when received by consumers.final Integer
Identifier of the edge.final List
<HistogramEntry> A histogram that maps the spread of client response times on an edge.static Class
<? extends Edge.Builder> final Instant
The start time of the first segment on the edge.final EdgeStatistics
Response statistics for segments on the edge.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
referenceId
Identifier of the edge. Unique within a service map.
- Returns:
- Identifier of the edge. Unique within a service map.
-
startTime
The start time of the first segment on the edge.
- Returns:
- The start time of the first segment on the edge.
-
endTime
The end time of the last segment on the edge.
- Returns:
- The end time of the last segment on the edge.
-
summaryStatistics
Response statistics for segments on the edge.
- Returns:
- Response statistics for segments on the edge.
-
hasResponseTimeHistogram
public final boolean hasResponseTimeHistogram()For responses, this returns true if the service returned a value for the ResponseTimeHistogram 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. -
responseTimeHistogram
A histogram that maps the spread of client response times on an edge. Only populated for synchronous edges.
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
hasResponseTimeHistogram()
method.- Returns:
- A histogram that maps the spread of client response times on an edge. Only populated for synchronous edges.
-
hasAliases
public final boolean hasAliases()For responses, this returns true if the service returned a value for the Aliases 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. -
aliases
Aliases for the edge.
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
hasAliases()
method.- Returns:
- Aliases for the edge.
-
edgeType
Describes an asynchronous connection, with a value of
link
.- Returns:
- Describes an asynchronous connection, with a value of
link
.
-
hasReceivedEventAgeHistogram
public final boolean hasReceivedEventAgeHistogram()For responses, this returns true if the service returned a value for the ReceivedEventAgeHistogram 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. -
receivedEventAgeHistogram
A histogram that maps the spread of event age when received by consumers. Age is calculated each time an event is received. Only populated when EdgeType is
link
.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
hasReceivedEventAgeHistogram()
method.- Returns:
- A histogram that maps the spread of event age when received by consumers. Age is calculated each time an
event is received. Only populated when EdgeType is
link
.
-
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 interfaceToCopyableBuilder<Edge.Builder,
Edge> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in 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
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. -
getValueForField
-
sdkFields
-