Class: Google::Cloud::Logging::V2::TailLogEntriesResponse

Inherits:

Object

Object
Google::Cloud::Logging::V2::TailLogEntriesResponse

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/logging/v2/logging.rb

Overview

Result returned from TailLogEntries.

Defined Under Namespace

Classes: SuppressionInfo

Instance Attribute Summary collapse

#entries ⇒ ::Array<::Google::Cloud::Logging::V2::LogEntry>
A list of log entries.
#suppression_info ⇒ ::Array<::Google::Cloud::Logging::V2::TailLogEntriesResponse::SuppressionInfo>
If entries that otherwise would have been included in the session were not sent back to the client, counts of relevant entries omitted from the session with the reason that they were not included.

Instance Attribute Details

#entries ⇒ `::Array<::Google::Cloud::Logging::V2::LogEntry>`

Returns A list of log entries. Each response in the stream will order entries with increasing values of LogEntry.timestamp. Ordering is not guaranteed between separate responses.

Returns:

(::Array<::Google::Cloud::Logging::V2::LogEntry>) —
A list of log entries. Each response in the stream will order entries with increasing values of LogEntry.timestamp. Ordering is not guaranteed between separate responses.

# File 'proto_docs/google/logging/v2/logging.rb', line 375

class TailLogEntriesResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Information about entries that were omitted from the session.
  # @!attribute [rw] reason
  #   @return [::Google::Cloud::Logging::V2::TailLogEntriesResponse::SuppressionInfo::Reason]
  #     The reason that entries were omitted from the session.
  # @!attribute [rw] suppressed_count
  #   @return [::Integer]
  #     A lower bound on the count of entries omitted due to `reason`.
  class SuppressionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # An indicator of why entries were omitted.
    module Reason
      # Unexpected default.
      REASON_UNSPECIFIED = 0

      # Indicates suppression occurred due to relevant entries being
      # received in excess of rate limits. For quotas and limits, see
      # [Logging API quotas and
      # limits](https://cloud.google.com/logging/quotas#api-limits).
      RATE_LIMIT = 1

      # Indicates suppression occurred due to the client not consuming
      # responses quickly enough.
      NOT_CONSUMED = 2
    end
  end
end

#suppression_info ⇒ `::Array<::Google::Cloud::Logging::V2::TailLogEntriesResponse::SuppressionInfo>`

Returns If entries that otherwise would have been included in the session were not sent back to the client, counts of relevant entries omitted from the session with the reason that they were not included. There will be at most one of each reason per response. The counts represent the number of suppressed entries since the last streamed response.