You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-xray/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.

Instance Attribute Summary collapse

Instance Attribute Details

#account_idString

Identifier of the AWS account in which the service runs.

Returns:

  • (String)


670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 670

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)
  include Aws::Structure
end

#duration_histogramArray<Types::HistogramEntry>

A histogram that maps the spread of service durations.

Returns:



670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 670

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)
  include Aws::Structure
end

#edgesArray<Types::Edge>

Connections to downstream services.

Returns:



670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 670

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)
  include Aws::Structure
end

#end_timeTime

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

Returns:

  • (Time)


670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 670

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)
  include Aws::Structure
end

#nameString

The canonical name of the service.

Returns:

  • (String)


670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 670

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)
  include Aws::Structure
end

#namesArray<String>

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

Returns:

  • (Array<String>)


670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 670

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)
  include Aws::Structure
end

#reference_idInteger

Identifier for the service. Unique within the service map.

Returns:

  • (Integer)


670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 670

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)
  include Aws::Structure
end

#response_time_histogramArray<Types::HistogramEntry>

A histogram that maps the spread of service response times.

Returns:



670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 670

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)
  include Aws::Structure
end

#rootBoolean

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

Returns:

  • (Boolean)


670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 670

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)
  include Aws::Structure
end

#start_timeTime

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

Returns:

  • (Time)


670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 670

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)
  include Aws::Structure
end

#stateString

The service's state.

Returns:

  • (String)


670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 670

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)
  include Aws::Structure
end

#summary_statisticsTypes::ServiceStatistics

Aggregated statistics for the service.



670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 670

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)
  include Aws::Structure
end

#typeString

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:

  • (String)


670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 670

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)
  include Aws::Structure
end