Class Node

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

A node in the context graph representing a service, resource, or remote service.

See Also:

  • Method Details

    • nodeId

      public final String nodeId()

      The unique identifier of the node within the context graph.

      Returns:
      The unique identifier of the node within the context graph.

    • nodeType

      public final NodeType nodeType()

      Whether the node is a service, a resource, or a remote service.

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

      Returns:
      Whether the node is a service, a resource, or a remote service.
      See Also:

    • nodeTypeAsString

      public final String nodeTypeAsString()

      Whether the node is a service, a resource, or a remote service.

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

      Returns:
      Whether the node is a service, a resource, or a remote service.
      See Also:

    • name

      public final String name()

      The primary display name of the node.

      Returns:
      The primary display name of the node.

    • hasAlternateNames

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

    • alternateNames

      public final List<String> alternateNames()

      Other names this node was observed under. A node that merged across sources reports one resolved name, and the names it was merged away from appear here.

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

      Returns:
      Other names this node was observed under. A node that merged across sources reports one resolved name, and the names it was merged away from appear here.

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      The tags observed on the underlying resource.

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

      Returns:
      The tags observed on the underlying resource.

    • nodeProperties

      public final NodeProperties nodeProperties()

      Identity attributes promoted out of the flat attribute map onto typed members.

      Returns:
      Identity attributes promoted out of the flat attribute map onto typed members.

    • 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 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.

    • telemetryAttributes

      public final Map<String,String> telemetryAttributes()

      The node's OpenTelemetry (OTel) attributes, as emitted by telemetry — the raw values, as opposed to the normalized nodeProperties. A key promoted onto a nodeProperties member 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 node's OpenTelemetry (OTel) attributes, as emitted by telemetry — the raw values, as opposed to the normalized nodeProperties. A key promoted onto a nodeProperties member is removed here, so no value appears twice.

    • hasOperationDetails

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

    • operationDetails

      public final Map<String,List<Map<String,String>>> operationDetails()

      The operations observed on this node, keyed by operation name. Each value lists the dimension sets that identify the metric series for that operation.

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

      Returns:
      The operations observed on this node, keyed by operation name. Each value lists the dimension sets that identify the metric series for that operation.

    • signalTypes

      public final List<Signal> signalTypes()

      The kinds of telemetry signal observed on this node.

      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 node.

    • 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 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.

    • signalTypesAsStrings

      public final List<String> signalTypesAsStrings()

      The kinds of telemetry signal observed on this node.

      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 node.

    • sources

      public final List<Source> sources()

      The discovery sources that contributed this node.

      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 node.

    • 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 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.

    • sourcesAsStrings

      public final List<String> sourcesAsStrings()

      The discovery sources that contributed this node.

      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 node.

    • metadata

      public final Metadata metadata()

      Descriptive metadata about the node. Present only when the request sets includeMetadata.

      Returns:
      Descriptive metadata about the node. Present only when the request sets includeMetadata.

    • firstObservedAt

      public final Instant firstObservedAt()

      When this node was first observed (UTC), at minute granularity. For a node that merged across sources, this is the earliest value any source reported.

      Returns:
      When this node was first observed (UTC), at minute granularity. For a node that merged across sources, this is the earliest value any source reported.

    • lastObservedAt

      public final Instant lastObservedAt()

      When this node was most recently observed (UTC), at minute granularity. For a node that merged across sources, this is the latest value any source reported.

      Returns:
      When this node was most recently observed (UTC), at minute granularity. For a node that merged across sources, this is the latest value any source reported.

    • hasEdges

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

    • edges

      public final List<Edge> edges()

      Outbound edges originating from this node. Each edge carries its from.

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

      Returns:
      Outbound edges originating from this node. Each edge carries its from.

    • toBuilder

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

    • builder

      public static Node.Builder builder()

    • serializableBuilderClass

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