Class: Aws::XRay::Types::Service

Inherits:

Struct

• Object
• Struct
• Aws::XRay::Types::Service

Includes:

Structure

Defined in:

lib/aws-sdk-xray/types.rb

Overview

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

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #account_id ⇒ String

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

• #duration_histogram ⇒ Array<Types::HistogramEntry>

  A histogram that maps the spread of service durations.

• #edges ⇒ Array<Types::Edge>

  Connections to downstream services.

• #end_time ⇒ Time

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

• #name ⇒ String

  The canonical name of the service.

• #names ⇒ Array<String>

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

• #reference_id ⇒ Integer

  Identifier for the service.

• #response_time_histogram ⇒ Array<Types::HistogramEntry>

  A histogram that maps the spread of service response times.

• #root ⇒ Boolean

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

• #start_time ⇒ Time

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

• #state ⇒ String

  The service’s state.

• #summary_statistics ⇒ Types::ServiceStatistics

  Aggregated statistics for the service.

• #type ⇒ String

  The type of service.

Instance Attribute Details

#account_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-xray/types.rb', line 2756

class Service < Struct.new(
  :reference_id,
  :name,
  :names,
  :root,
  :account_id,
  :type,
  :state,
  :start_time,
  :end_time,
  :edges,
  :summary_statistics,
  :duration_histogram,
  :response_time_histogram)
  SENSITIVE = []
  include Aws::Structure
end

#duration_histogram ⇒ Array<Types::HistogramEntry>

A histogram that maps the spread of service durations.

Returns:

• (Array<Types::HistogramEntry>)

# File 'lib/aws-sdk-xray/types.rb', line 2756

class Service < Struct.new(
  :reference_id,
  :name,
  :names,
  :root,
  :account_id,
  :type,
  :state,
  :start_time,
  :end_time,
  :edges,
  :summary_statistics,
  :duration_histogram,
  :response_time_histogram)
  SENSITIVE = []
  include Aws::Structure
end

#edges ⇒ Array<Types::Edge>

Connections to downstream services.

Returns:

• (Array<Types::Edge>)

# File 'lib/aws-sdk-xray/types.rb', line 2756

class Service < Struct.new(
  :reference_id,
  :name,
  :names,
  :root,
  :account_id,
  :type,
  :state,
  :start_time,
  :end_time,
  :edges,
  :summary_statistics,
  :duration_histogram,
  :response_time_histogram)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-xray/types.rb', line 2756

class Service < Struct.new(
  :reference_id,
  :name,
  :names,
  :root,
  :account_id,
  :type,
  :state,
  :start_time,
  :end_time,
  :edges,
  :summary_statistics,
  :duration_histogram,
  :response_time_histogram)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The canonical name of the service.

Returns:

• (String)

# File 'lib/aws-sdk-xray/types.rb', line 2756

class Service < Struct.new(
  :reference_id,
  :name,
  :names,
  :root,
  :account_id,
  :type,
  :state,
  :start_time,
  :end_time,
  :edges,
  :summary_statistics,
  :duration_histogram,
  :response_time_histogram)
  SENSITIVE = []
  include Aws::Structure
end

#names ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'lib/aws-sdk-xray/types.rb', line 2756

class Service < Struct.new(
  :reference_id,
  :name,
  :names,
  :root,
  :account_id,
  :type,
  :state,
  :start_time,
  :end_time,
  :edges,
  :summary_statistics,
  :duration_histogram,
  :response_time_histogram)
  SENSITIVE = []
  include Aws::Structure
end

#reference_id ⇒ Integer

Identifier for the service. Unique within the service map.

Returns:

• (Integer)

# File 'lib/aws-sdk-xray/types.rb', line 2756

class Service < Struct.new(
  :reference_id,
  :name,
  :names,
  :root,
  :account_id,
  :type,
  :state,
  :start_time,
  :end_time,
  :edges,
  :summary_statistics,
  :duration_histogram,
  :response_time_histogram)
  SENSITIVE = []
  include Aws::Structure
end

#response_time_histogram ⇒ Array<Types::HistogramEntry>

A histogram that maps the spread of service response times.

Returns:

• (Array<Types::HistogramEntry>)

# File 'lib/aws-sdk-xray/types.rb', line 2756

class Service < Struct.new(
  :reference_id,
  :name,
  :names,
  :root,
  :account_id,
  :type,
  :state,
  :start_time,
  :end_time,
  :edges,
  :summary_statistics,
  :duration_histogram,
  :response_time_histogram)
  SENSITIVE = []
  include Aws::Structure
end

#root ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-xray/types.rb', line 2756

class Service < Struct.new(
  :reference_id,
  :name,
  :names,
  :root,
  :account_id,
  :type,
  :state,
  :start_time,
  :end_time,
  :edges,
  :summary_statistics,
  :duration_histogram,
  :response_time_histogram)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-xray/types.rb', line 2756

class Service < Struct.new(
  :reference_id,
  :name,
  :names,
  :root,
  :account_id,
  :type,
  :state,
  :start_time,
  :end_time,
  :edges,
  :summary_statistics,
  :duration_histogram,
  :response_time_histogram)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The service’s state.

Returns:

• (String)

# File 'lib/aws-sdk-xray/types.rb', line 2756

class Service < Struct.new(
  :reference_id,
  :name,
  :names,
  :root,
  :account_id,
  :type,
  :state,
  :start_time,
  :end_time,
  :edges,
  :summary_statistics,
  :duration_histogram,
  :response_time_histogram)
  SENSITIVE = []
  include Aws::Structure
end

#summary_statistics ⇒ Types::ServiceStatistics

Aggregated statistics for the service.

Returns:

• (Types::ServiceStatistics)

# File 'lib/aws-sdk-xray/types.rb', line 2756

class Service < Struct.new(
  :reference_id,
  :name,
  :names,
  :root,
  :account_id,
  :type,
  :state,
  :start_time,
  :end_time,
  :edges,
  :summary_statistics,
  :duration_histogram,
  :response_time_histogram)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

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:

• (String)

# File 'lib/aws-sdk-xray/types.rb', line 2756

class Service < Struct.new(
  :reference_id,
  :name,
  :names,
  :root,
  :account_id,
  :type,
  :state,
  :start_time,
  :end_time,
  :edges,
  :summary_statistics,
  :duration_histogram,
  :response_time_histogram)
  SENSITIVE = []
  include Aws::Structure
end