Class Edge
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Edge.Builder,Edge>
A directed edge in the context graph connecting two nodes.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic Edge.Builderbuilder()final StringedgeId()The unique identifier of the edge within the context graph.final EdgePropertiesAttributes promoted out of the flat attribute map onto typed members.final EdgeTypeedgeType()The kind of relationship the edge represents.final StringThe kind of relationship the edge represents.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final InstantWhen this edge was first observed (UTC), at minute granularity.final Stringfrom()The node identifier the edge originates from.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 Operations property.final booleanFor responses, this returns true if the service returned a value for the SignalTypes property.final booleanFor responses, this returns true if the service returned a value for the Sources property.final booleanFor responses, this returns true if the service returned a value for the TelemetryAttributes property.final InstantWhen this edge was most recently observed (UTC), at minute granularity.final Metadatametadata()Descriptive metadata about the edge.The operations observed on this edge.static Class<? extends Edge.Builder> The kinds of telemetry signal observed on this edge.The kinds of telemetry signal observed on this edge.sources()The discovery sources that contributed this edge.The discovery sources that contributed this edge.The edge's OpenTelemetry (OTel) attributes, as emitted by telemetry.final Stringto()The node identifier the edge points to.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
edgeId
The unique identifier of the edge within the context graph.
- Returns:
- The unique identifier of the edge within the context graph.
-
from
The node identifier the edge originates from.
- Returns:
- The node identifier the edge originates from.
-
to
The node identifier the edge points to.
- Returns:
- The node identifier the edge points to.
-
edgeType
The kind of relationship the edge represents.
If the service returns an enum value that is not available in the current SDK version,
edgeTypewill returnEdgeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromedgeTypeAsString().- Returns:
- The kind of relationship the edge represents.
- See Also:
-
edgeTypeAsString
The kind of relationship the edge represents.
If the service returns an enum value that is not available in the current SDK version,
edgeTypewill returnEdgeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromedgeTypeAsString().- Returns:
- The kind of relationship the edge represents.
- See Also:
-
hasOperations
public final boolean hasOperations()For responses, this returns true if the service returned a value for the Operations 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. -
operations
The operations observed on this 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
hasOperations()method.- Returns:
- The operations observed on this edge.
-
edgeProperties
Attributes promoted out of the flat attribute map onto typed members. Which members are present depends on what produced the edge.
- Returns:
- Attributes promoted out of the flat attribute map onto typed members. Which members are present depends on what produced the edge.
-
hasTelemetryAttributes
public final boolean hasTelemetryAttributes()For responses, this returns true if the service returned a value for the TelemetryAttributes 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. -
telemetryAttributes
The edge's OpenTelemetry (OTel) attributes, as emitted by telemetry. A key promoted onto an
edgePropertiesmember is removed here, so no value appears twice.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
hasTelemetryAttributes()method.- Returns:
- The edge's OpenTelemetry (OTel) attributes, as emitted by telemetry. A key promoted onto an
edgePropertiesmember is removed here, so no value appears twice.
-
signalTypes
The kinds of telemetry signal observed on this 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
hasSignalTypes()method.- Returns:
- The kinds of telemetry signal observed on this edge.
-
hasSignalTypes
public final boolean hasSignalTypes()For responses, this returns true if the service returned a value for the SignalTypes 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. -
signalTypesAsStrings
The kinds of telemetry signal observed on this 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
hasSignalTypes()method.- Returns:
- The kinds of telemetry signal observed on this edge.
-
sources
The discovery sources that contributed this 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
hasSources()method.- Returns:
- The discovery sources that contributed this edge.
-
hasSources
public final boolean hasSources()For responses, this returns true if the service returned a value for the Sources 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. -
sourcesAsStrings
The discovery sources that contributed this 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
hasSources()method.- Returns:
- The discovery sources that contributed this edge.
-
metadata
Descriptive metadata about the edge. Present only when the request sets includeMetadata.
- Returns:
- Descriptive metadata about the edge. Present only when the request sets includeMetadata.
-
firstObservedAt
When this edge was first observed (UTC), at minute granularity. For an edge that merged across sources, this is the earliest value any source reported.
- Returns:
- When this edge was first observed (UTC), at minute granularity. For an edge that merged across sources, this is the earliest value any source reported.
-
lastObservedAt
When this edge was most recently observed (UTC), at minute granularity. For an edge that merged across sources, this is the latest value any source reported.
- Returns:
- When this edge was most recently observed (UTC), at minute granularity. For an edge that merged across sources, this is the latest value any source reported.
-
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<Edge.Builder,Edge> - 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.
-