Service (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.xray.model.Service

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Service
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Information about an application that processed requests, users that made requests, or downstream services, resources and applications that an application used.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Service()

Constructors
Constructor and Description
`Service()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Service`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAccountId()` Identifier of the AWS account in which the service runs.
`List<HistogramEntry>`	`getDurationHistogram()` A histogram that maps the spread of service durations.
`List<Edge>`	`getEdges()` Connections to downstream services.
`Date`	`getEndTime()` The end time of the last segment that the service generated.
`String`	`getName()` The canonical name of the service.
`List<String>`	`getNames()` A list of names for the service, including the canonical name.
`Integer`	`getReferenceId()` Identifier for the service.
`List<HistogramEntry>`	`getResponseTimeHistogram()` A histogram that maps the spread of service response times.
`Boolean`	`getRoot()` Indicates that the service was the first service to process a request.
`Date`	`getStartTime()` The start time of the first segment that the service generated.
`String`	`getState()` The service's state.
`ServiceStatistics`	`getSummaryStatistics()` Aggregated statistics for the service.
`String`	`getType()` The type of service.
`int`	`hashCode()`
`Boolean`	`isRoot()` Indicates that the service was the first service to process a request.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAccountId(String accountId)` Identifier of the AWS account in which the service runs.
`void`	`setDurationHistogram(Collection<HistogramEntry> durationHistogram)` A histogram that maps the spread of service durations.
`void`	`setEdges(Collection<Edge> edges)` Connections to downstream services.
`void`	`setEndTime(Date endTime)` The end time of the last segment that the service generated.
`void`	`setName(String name)` The canonical name of the service.
`void`	`setNames(Collection<String> names)` A list of names for the service, including the canonical name.
`void`	`setReferenceId(Integer referenceId)` Identifier for the service.
`void`	`setResponseTimeHistogram(Collection<HistogramEntry> responseTimeHistogram)` A histogram that maps the spread of service response times.
`void`	`setRoot(Boolean root)` Indicates that the service was the first service to process a request.
`void`	`setStartTime(Date startTime)` The start time of the first segment that the service generated.
`void`	`setState(String state)` The service's state.
`void`	`setSummaryStatistics(ServiceStatistics summaryStatistics)` Aggregated statistics for the service.
`void`	`setType(String type)` The type of service.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Service`	`withAccountId(String accountId)` Identifier of the AWS account in which the service runs.
`Service`	`withDurationHistogram(Collection<HistogramEntry> durationHistogram)` A histogram that maps the spread of service durations.
`Service`	`withDurationHistogram(HistogramEntry... durationHistogram)` A histogram that maps the spread of service durations.
`Service`	`withEdges(Collection<Edge> edges)` Connections to downstream services.
`Service`	`withEdges(Edge... edges)` Connections to downstream services.
`Service`	`withEndTime(Date endTime)` The end time of the last segment that the service generated.
`Service`	`withName(String name)` The canonical name of the service.
`Service`	`withNames(Collection<String> names)` A list of names for the service, including the canonical name.
`Service`	`withNames(String... names)` A list of names for the service, including the canonical name.
`Service`	`withReferenceId(Integer referenceId)` Identifier for the service.
`Service`	`withResponseTimeHistogram(Collection<HistogramEntry> responseTimeHistogram)` A histogram that maps the spread of service response times.
`Service`	`withResponseTimeHistogram(HistogramEntry... responseTimeHistogram)` A histogram that maps the spread of service response times.
`Service`	`withRoot(Boolean root)` Indicates that the service was the first service to process a request.
`Service`	`withStartTime(Date startTime)` The start time of the first segment that the service generated.
`Service`	`withState(String state)` The service's state.
`Service`	`withSummaryStatistics(ServiceStatistics summaryStatistics)` Aggregated statistics for the service.
`Service`	`withType(String type)` The type of service.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Service
```
public Service()
```
- Method Detail
  - setReferenceId
```
public void setReferenceId(Integer referenceId)
```
    Identifier for the service. Unique within the service map.
    
    Parameters:
    
    referenceId - Identifier for the service. Unique within the service map.
  - getReferenceId
```
public Integer getReferenceId()
```
    Identifier for the service. Unique within the service map.
    
    Returns:
    
    Identifier for the service. Unique within the service map.
  - withReferenceId
```
public Service withReferenceId(Integer referenceId)
```
    Identifier for the service. Unique within the service map.
    
    Parameters:
    
    referenceId - Identifier for the service. Unique within the service map.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The canonical name of the service.
    
    Parameters:
    
    name - The canonical name of the service.
  - getName
```
public String getName()
```
    The canonical name of the service.
    
    Returns:
    
    The canonical name of the service.
  - withName
```
public Service withName(String name)
```
    The canonical name of the service.
    
    Parameters:
    
    name - The canonical name of the service.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getNames
```
public List<String> getNames()
```
    A list of names for the service, including the canonical name.
    
    Returns:
    
    A list of names for the service, including the canonical name.
  - setNames
```
public void setNames(Collection<String> names)
```
    A list of names for the service, including the canonical name.
    
    Parameters:
    
    names - A list of names for the service, including the canonical name.
  - withNames
```
public Service withNames(String... names)
```
    A list of names for the service, including the canonical name.
    
    NOTE: This method appends the values to the existing list (if any). Use setNames(java.util.Collection) or withNames(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    names - A list of names for the service, including the canonical name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withNames
```
public Service withNames(Collection<String> names)
```
    A list of names for the service, including the canonical name.
    
    Parameters:
    
    names - A list of names for the service, including the canonical name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoot
```
public void setRoot(Boolean root)
```
    Indicates that the service was the first service to process a request.
    
    Parameters:
    
    root - Indicates that the service was the first service to process a request.
  - getRoot
```
public Boolean getRoot()
```
    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.
  - withRoot
```
public Service withRoot(Boolean root)
```
    Indicates that the service was the first service to process a request.
    
    Parameters:
    
    root - Indicates that the service was the first service to process a request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isRoot
```
public Boolean isRoot()
```
    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.
  - setAccountId
```
public void setAccountId(String accountId)
```
    Identifier of the AWS account in which the service runs.
    
    Parameters:
    
    accountId - Identifier of the AWS account in which the service runs.
  - getAccountId
```
public String getAccountId()
```
    Identifier of the AWS account in which the service runs.
    
    Returns:
    
    Identifier of the AWS account in which the service runs.
  - withAccountId
```
public Service withAccountId(String accountId)
```
    Identifier of the AWS account in which the service runs.
    
    Parameters:
    
    accountId - Identifier of the AWS account in which the service runs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    The type of service.
    - AWS Resource - The type of an AWS resource. For example, AWS::EC2::Instance for a application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used.
    - AWS Service - The type of an AWS 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.
    Parameters:
    type - The type of service.
    
    AWS Resource - The type of an AWS resource. For example, AWS::EC2::Instance for a application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used.
    
    AWS Service - The type of an AWS 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.
  - getType
```
public String getType()
```
    The type of service.
    - AWS Resource - The type of an AWS resource. For example, AWS::EC2::Instance for a application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used.
    - AWS Service - The type of an AWS 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.
    
    AWS Resource - The type of an AWS resource. For example, AWS::EC2::Instance for a application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used.
    
    AWS Service - The type of an AWS 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.
  - withType
```
public Service withType(String type)
```
    The type of service.
    - AWS Resource - The type of an AWS resource. For example, AWS::EC2::Instance for a application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used.
    - AWS Service - The type of an AWS 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.
    Parameters:
    type - The type of service.
    
    AWS Resource - The type of an AWS resource. For example, AWS::EC2::Instance for a application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used.
    
    AWS Service - The type of an AWS 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    The service's state.
    
    Parameters:
    
    state - The service's state.
  - getState
```
public String getState()
```
    The service's state.
    
    Returns:
    
    The service's state.
  - withState
```
public Service withState(String state)
```
    The service's state.
    
    Parameters:
    
    state - The service's state.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartTime
```
public void setStartTime(Date startTime)
```
    The start time of the first segment that the service generated.
    
    Parameters:
    
    startTime - The start time of the first segment that the service generated.
  - getStartTime
```
public Date getStartTime()
```
    The start time of the first segment that the service generated.
    
    Returns:
    
    The start time of the first segment that the service generated.
  - withStartTime
```
public Service withStartTime(Date startTime)
```
    The start time of the first segment that the service generated.
    
    Parameters:
    
    startTime - The start time of the first segment that the service generated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndTime
```
public void setEndTime(Date endTime)
```
    The end time of the last segment that the service generated.
    
    Parameters:
    
    endTime - The end time of the last segment that the service generated.
  - getEndTime
```
public Date getEndTime()
```
    The end time of the last segment that the service generated.
    
    Returns:
    
    The end time of the last segment that the service generated.
  - withEndTime
```
public Service withEndTime(Date endTime)
```
    The end time of the last segment that the service generated.
    
    Parameters:
    
    endTime - The end time of the last segment that the service generated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEdges
```
public List<Edge> getEdges()
```
    Connections to downstream services.
    
    Returns:
    
    Connections to downstream services.
  - setEdges
```
public void setEdges(Collection<Edge> edges)
```
    Connections to downstream services.
    
    Parameters:
    
    edges - Connections to downstream services.
  - withEdges
```
public Service withEdges(Edge... edges)
```
    Connections to downstream services.
    
    NOTE: This method appends the values to the existing list (if any). Use setEdges(java.util.Collection) or withEdges(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    edges - Connections to downstream services.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withEdges
```
public Service withEdges(Collection<Edge> edges)
```
    Connections to downstream services.
    
    Parameters:
    
    edges - Connections to downstream services.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSummaryStatistics
```
public void setSummaryStatistics(ServiceStatistics summaryStatistics)
```
    Aggregated statistics for the service.
    
    Parameters:
    
    summaryStatistics - Aggregated statistics for the service.
  - getSummaryStatistics
```
public ServiceStatistics getSummaryStatistics()
```
    Aggregated statistics for the service.
    
    Returns:
    
    Aggregated statistics for the service.
  - withSummaryStatistics
```
public Service withSummaryStatistics(ServiceStatistics summaryStatistics)
```
    Aggregated statistics for the service.
    
    Parameters:
    
    summaryStatistics - Aggregated statistics for the service.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDurationHistogram
```
public List<HistogramEntry> getDurationHistogram()
```
    A histogram that maps the spread of service durations.
    
    Returns:
    
    A histogram that maps the spread of service durations.
  - setDurationHistogram
```
public void setDurationHistogram(Collection<HistogramEntry> durationHistogram)
```
    A histogram that maps the spread of service durations.
    
    Parameters:
    
    durationHistogram - A histogram that maps the spread of service durations.
  - withDurationHistogram
```
public Service withDurationHistogram(HistogramEntry... durationHistogram)
```
    A histogram that maps the spread of service durations.
    
    NOTE: This method appends the values to the existing list (if any). Use setDurationHistogram(java.util.Collection) or withDurationHistogram(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    durationHistogram - A histogram that maps the spread of service durations.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withDurationHistogram
```
public Service withDurationHistogram(Collection<HistogramEntry> durationHistogram)
```
    A histogram that maps the spread of service durations.
    
    Parameters:
    
    durationHistogram - A histogram that maps the spread of service durations.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getResponseTimeHistogram
```
public List<HistogramEntry> getResponseTimeHistogram()
```
    A histogram that maps the spread of service response times.
    
    Returns:
    
    A histogram that maps the spread of service response times.
  - setResponseTimeHistogram
```
public void setResponseTimeHistogram(Collection<HistogramEntry> responseTimeHistogram)
```
    A histogram that maps the spread of service response times.
    
    Parameters:
    
    responseTimeHistogram - A histogram that maps the spread of service response times.
  - withResponseTimeHistogram
```
public Service withResponseTimeHistogram(HistogramEntry... responseTimeHistogram)
```
    A histogram that maps the spread of service response times.
    
    NOTE: This method appends the values to the existing list (if any). Use setResponseTimeHistogram(java.util.Collection) or withResponseTimeHistogram(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    responseTimeHistogram - A histogram that maps the spread of service response times.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withResponseTimeHistogram
```
public Service withResponseTimeHistogram(Collection<HistogramEntry> responseTimeHistogram)
```
    A histogram that maps the spread of service response times.
    
    Parameters:
    
    responseTimeHistogram - A histogram that maps the spread of service response times.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Service clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Service

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Service

Method Detail

setReferenceId

getReferenceId

withReferenceId

setName

getName

withName

getNames

setNames

withNames

withNames

setRoot

getRoot

withRoot

isRoot

setAccountId

getAccountId

withAccountId

setType

getType

withType

setState

getState

withState

setStartTime

getStartTime

withStartTime

setEndTime

getEndTime

withEndTime

getEdges

setEdges

withEdges

withEdges

setSummaryStatistics

getSummaryStatistics

withSummaryStatistics

getDurationHistogram

setDurationHistogram

withDurationHistogram

withDurationHistogram

getResponseTimeHistogram

setResponseTimeHistogram

withResponseTimeHistogram

withResponseTimeHistogram

toString

equals

hashCode

clone

marshall