Class: Google::Devtools::Cloudtrace::V2::Span::TimeEvent

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/trace/v2/doc/google/devtools/cloudtrace/v2/trace.rb

Overview

A time-stamped annotation or message event in the Span.

Defined Under Namespace

Classes: Annotation, MessageEvent

Instance Attribute Summary collapse

Instance Attribute Details

#annotation ⇒ Google::Devtools::Cloudtrace::V2::Span::TimeEvent::Annotation

Returns Text annotation with a set of attributes.

Returns:



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/google/cloud/trace/v2/doc/google/devtools/cloudtrace/v2/trace.rb', line 118

class TimeEvent
  # Text annotation with a set of attributes.
  # @!attribute [rw] description
  #   @return [Google::Devtools::Cloudtrace::V2::TruncatableString]
  #     A user-supplied message describing the event. The maximum length for
  #     the description is 256 bytes.
  # @!attribute [rw] attributes
  #   @return [Google::Devtools::Cloudtrace::V2::Span::Attributes]
  #     A set of attributes on the annotation. You can have up to 4 attributes
  #     per Annotation.
  class Annotation; end

  # An event describing a message sent/received between Spans.
  # @!attribute [rw] type
  #   @return [Google::Devtools::Cloudtrace::V2::Span::TimeEvent::MessageEvent::Type]
  #     Type of MessageEvent. Indicates whether the message was sent or
  #     received.
  # @!attribute [rw] id
  #   @return [Integer]
  #     An identifier for the MessageEvent's message that can be used to match
  #     SENT and RECEIVED MessageEvents. It is recommended to be unique within
  #     a Span.
  # @!attribute [rw] uncompressed_size_bytes
  #   @return [Integer]
  #     The number of uncompressed bytes sent or received.
  # @!attribute [rw] compressed_size_bytes
  #   @return [Integer]
  #     The number of compressed bytes sent or received. If missing assumed to
  #     be the same size as uncompressed.
  class MessageEvent
    # Indicates whether the message was sent or received.
    module Type
      # Unknown event type.
      TYPE_UNSPECIFIED = 0

      # Indicates a sent message.
      SENT = 1

      # Indicates a received message.
      RECEIVED = 2
    end
  end
end

#message_event ⇒ Google::Devtools::Cloudtrace::V2::Span::TimeEvent::MessageEvent

Returns An event describing a message sent/received between Spans.

Returns:



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/google/cloud/trace/v2/doc/google/devtools/cloudtrace/v2/trace.rb', line 118

class TimeEvent
  # Text annotation with a set of attributes.
  # @!attribute [rw] description
  #   @return [Google::Devtools::Cloudtrace::V2::TruncatableString]
  #     A user-supplied message describing the event. The maximum length for
  #     the description is 256 bytes.
  # @!attribute [rw] attributes
  #   @return [Google::Devtools::Cloudtrace::V2::Span::Attributes]
  #     A set of attributes on the annotation. You can have up to 4 attributes
  #     per Annotation.
  class Annotation; end

  # An event describing a message sent/received between Spans.
  # @!attribute [rw] type
  #   @return [Google::Devtools::Cloudtrace::V2::Span::TimeEvent::MessageEvent::Type]
  #     Type of MessageEvent. Indicates whether the message was sent or
  #     received.
  # @!attribute [rw] id
  #   @return [Integer]
  #     An identifier for the MessageEvent's message that can be used to match
  #     SENT and RECEIVED MessageEvents. It is recommended to be unique within
  #     a Span.
  # @!attribute [rw] uncompressed_size_bytes
  #   @return [Integer]
  #     The number of uncompressed bytes sent or received.
  # @!attribute [rw] compressed_size_bytes
  #   @return [Integer]
  #     The number of compressed bytes sent or received. If missing assumed to
  #     be the same size as uncompressed.
  class MessageEvent
    # Indicates whether the message was sent or received.
    module Type
      # Unknown event type.
      TYPE_UNSPECIFIED = 0

      # Indicates a sent message.
      SENT = 1

      # Indicates a received message.
      RECEIVED = 2
    end
  end
end

#time ⇒ Google::Protobuf::Timestamp

Returns The timestamp indicating the time the event occurred.

Returns:



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/google/cloud/trace/v2/doc/google/devtools/cloudtrace/v2/trace.rb', line 118

class TimeEvent
  # Text annotation with a set of attributes.
  # @!attribute [rw] description
  #   @return [Google::Devtools::Cloudtrace::V2::TruncatableString]
  #     A user-supplied message describing the event. The maximum length for
  #     the description is 256 bytes.
  # @!attribute [rw] attributes
  #   @return [Google::Devtools::Cloudtrace::V2::Span::Attributes]
  #     A set of attributes on the annotation. You can have up to 4 attributes
  #     per Annotation.
  class Annotation; end

  # An event describing a message sent/received between Spans.
  # @!attribute [rw] type
  #   @return [Google::Devtools::Cloudtrace::V2::Span::TimeEvent::MessageEvent::Type]
  #     Type of MessageEvent. Indicates whether the message was sent or
  #     received.
  # @!attribute [rw] id
  #   @return [Integer]
  #     An identifier for the MessageEvent's message that can be used to match
  #     SENT and RECEIVED MessageEvents. It is recommended to be unique within
  #     a Span.
  # @!attribute [rw] uncompressed_size_bytes
  #   @return [Integer]
  #     The number of uncompressed bytes sent or received.
  # @!attribute [rw] compressed_size_bytes
  #   @return [Integer]
  #     The number of compressed bytes sent or received. If missing assumed to
  #     be the same size as uncompressed.
  class MessageEvent
    # Indicates whether the message was sent or received.
    module Type
      # Unknown event type.
      TYPE_UNSPECIFIED = 0

      # Indicates a sent message.
      SENT = 1

      # Indicates a received message.
      RECEIVED = 2
    end
  end
end