Class Service

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

Information about an application that processed requests, users that made requests, or downstream services, resources, and applications that an application used.

See Also:

  • Method Details

    • referenceId

      public final Integer referenceId()

      Identifier for the service. Unique within the service map.

      Returns:
      Identifier for the service. Unique within the service map.

    • name

      public final String name()

      The canonical name of the service.

      Returns:
      The canonical name of the service.

    • hasNames

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

    • names

      public final List<String> names()

      A list of names for the service, including the canonical name.

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

      Returns:
      A list of names for the service, including the canonical name.

    • root

      public final Boolean root()

      Indicates that the service was the first service to process a request.

      Returns:
      Indicates that the service was the first service to process a request.

    • accountId

      public final String accountId()

      Identifier of the Amazon Web Services account in which the service runs.

      Returns:
      Identifier of the Amazon Web Services account in which the service runs.

    • type

      public final String type()

      The type of service.

      • Amazon Web Services Resource - The type of an Amazon Web Services resource. For example, AWS::EC2::Instance for an application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used.

      • Amazon Web Services Service - The type of an Amazon Web Services service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't target a specific table.

      • client - Represents the clients that sent requests to a root service.

      • remote - A downstream service of indeterminate type.

      Returns:
      The type of service.

      • Amazon Web Services Resource - The type of an Amazon Web Services resource. For example, AWS::EC2::Instance for an application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used.

      • Amazon Web Services Service - The type of an Amazon Web Services service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't target a specific table.

      • client - Represents the clients that sent requests to a root service.

      • remote - A downstream service of indeterminate type.

    • state

      public final String state()

      The service's state.

      Returns:
      The service's state.

    • startTime

      public final Instant startTime()

      The start time of the first segment that the service generated.

      Returns:
      The start time of the first segment that the service generated.

    • endTime

      public final Instant endTime()

      The end time of the last segment that the service generated.

      Returns:
      The end time of the last segment that the service generated.

    • 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()

      Connections to downstream services.

      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:
      Connections to downstream services.

    • summaryStatistics

      public final ServiceStatistics summaryStatistics()

      Aggregated statistics for the service.

      Returns:
      Aggregated statistics for the service.

    • hasDurationHistogram

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

    • durationHistogram

      public final List<HistogramEntry> durationHistogram()

      A histogram that maps the spread of service durations.

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

      Returns:
      A histogram that maps the spread of service durations.

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

    • responseTimeHistogram

      public final List<HistogramEntry> responseTimeHistogram()

      A histogram that maps the spread of service response times.

      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 service response times.

    • toBuilder

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

    • builder

      public static Service.Builder builder()

    • serializableBuilderClass

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