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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceService.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringaccountId()Identifier of the Amazon Web Services account in which the service runs.static Service.Builderbuilder()List<HistogramEntry>durationHistogram()A histogram that maps the spread of service durations.List<Edge>edges()Connections to downstream services.InstantendTime()The end time of the last segment that the service generated.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasDurationHistogram()For responses, this returns true if the service returned a value for the DurationHistogram property.booleanhasEdges()For responses, this returns true if the service returned a value for the Edges property.inthashCode()booleanhasNames()For responses, this returns true if the service returned a value for the Names property.booleanhasResponseTimeHistogram()For responses, this returns true if the service returned a value for the ResponseTimeHistogram property.Stringname()The canonical name of the service.List<String>names()A list of names for the service, including the canonical name.IntegerreferenceId()Identifier for the service.List<HistogramEntry>responseTimeHistogram()A histogram that maps the spread of service response times.Booleanroot()Indicates that the service was the first service to process a request.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends Service.Builder>serializableBuilderClass()InstantstartTime()The start time of the first segment that the service generated.Stringstate()The service's state.ServiceStatisticssummaryStatistics()Aggregated statistics for the service.Service.BuildertoBuilder()StringtoString()Returns a string representation of this object.Stringtype()The type of service.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 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.
-
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::Instancefor an application running on Amazon EC2 orAWS::DynamoDB::Tablefor an Amazon DynamoDB table that the application used. -
Amazon Web Services Service - The type of an Amazon Web Services service. For example,
AWS::DynamoDBfor 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::Instancefor an application running on Amazon EC2 orAWS::DynamoDB::Tablefor an Amazon DynamoDB table that the application used. -
Amazon Web Services Service - The type of an Amazon Web Services service. For example,
AWS::DynamoDBfor 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 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.
-
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 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.
-
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 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
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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Service.Builder,Service>
-
builder
public static Service.Builder builder()
-
serializableBuilderClass
public static Class<? extends Service.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-