클래스: Mongo::Mongoing::Event::CommandSucceeded

상속:
Event::Base
  • 객체
모두 표시
다음을 포함합니다.
안전
다음에 정의됨:
빌드/ Ruby-driver-v2.19/lib/mongo/ 모니터링/ 이벤트/command_succeeded.rb

개요

명령 작업이 성공하면 발생하는 이벤트입니다.

이후:

  • 2.1.0

상수 요약

Secure에서 포함된 상수

보안::REDACTED_COMMANDS

인스턴스 속성 요약 접기

클래스 메서드 요약 접기

인스턴스 메서드 요약 접기

보안에 포함된 메서드

#compression_allowed?, #redacted, #sensitivity?

생성자 세부 정보

#initialize(command_name, database_name, 주소, request_id, operation_id, 회신, 기간, started_event:, server_connection_id: nil, service_id: nil) ⇒ CommandSucceeded

이 메서드는 비공개 API의 일부입니다. 이 방법은 향후 제거되거나 변경될 수 있으므로 가능하면 사용하지 않는 것이 좋습니다.

새 이벤트를 만듭니다.

예시:

이벤트를 만듭니다.

매개변수:

  • command_name (string)

    명령의 이름입니다.

  • database_name (string)

    데이터베이스 이름입니다.

  • 주소 (Server::Address)

    서버 주소 입니다.

  • request_id (정수)

    요청 ID입니다.

  • operation_id (정수)

    작업 ID입니다.

  • 회신 (BSON::Document)

    명령 응답입니다.

  • 기간 (Float)

    명령에 소요된 시간(초)입니다.

  • started_event (Monitoring::Event::CommandStarted)

    해당 시작 이벤트 입니다.

  • service_id (객체) (기본값: nil)

    서비스 ID(있는 경우)입니다.

이후:

  • 2.1.0



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# 파일 'build/ruby-driver-v2.19/lib/mongo/monitoring/event/command_succeeded.rb', 줄 78

def 초기화(command_name, database_name, 주소, request_id,
  operation_id, 회신, 기간, started_event:,
  server_connection_id: nil, service_id: nil
)
  @command_name = command_name.to_s
  @database_name = database_name
  @address = 주소
  @request_id = request_id
  @operation_id = operation_id
  @service_id = service_id
  @started_event = started_event
  @reply = 편집됨(command_name, 회신)
  @duration = 기간
  @server_connection_id = server_connection_id
end

인스턴스 속성 세부 정보

#주소Server::Address (읽기 전용)

주소 서버 주소를 반환합니다.

반환합니다:

  • (Server::Address)

    주소 서버 주소.

이후:

  • 2.1.0



29
30
31
# 파일 'build/ruby-driver-v2.19/lib/mongo/monitoring/event/command_succeeded.rb', 줄 29

def 주소
  @address
end

#command_namestring (읽기 전용)

반환값 command_name 명령의 이름입니다.

반환합니다:

  • (string)

    command_name 명령의 이름입니다.

이후:

  • 2.1.0



32
33
34
# 파일 'build/ruby-driver-v2.19/lib/mongo/monitoring/event/command_succeeded.rb', 줄 32

def command_name
  @command_name
end

#database_namestring (읽기 전용)

반환값 database_name 데이터베이스 의 이름입니다.

반환합니다:

  • (string)

    database_name 데이터베이스 의 이름입니다.

이후:

  • 2.1.0



38
39
40
# 파일 'build/ruby-driver-v2.19/lib/mongo/monitoring/event/command_succeeded.rb', 줄 38

def database_name
  @database_name
end

#durationFloat (읽기 전용)

기간을 반환합니다. 이벤트 기간을 반환합니다.

반환합니다:

  • (Float)

    duration 이벤트 의 기간입니다.

이후:

  • 2.1.0



41
42
43
# 파일 'build/ruby-driver-v2.19/lib/mongo/monitoring/event/command_succeeded.rb', 줄 41

def 기간
  @duration
end

#operation_id정수 (읽기 전용)

반환 operation_id 작업 ID입니다.

반환합니다:

  • (정수)

    operation_id 작업 ID입니다.

이후:

  • 2.1.0



44
45
46
# 파일 'build/ruby-driver-v2.19/lib/mongo/monitoring/event/command_succeeded.rb', 줄 44

def operation_id
  @operation_id
end

#회신BSON::Document (읽기 전용)

회신을 반환합니다.

반환합니다:

  • (BSON::Document)

    회신 명령을 실행합니다.

이후:

  • 2.1.0



35
36
37
# 파일 'build/ruby-driver-v2.19/lib/mongo/monitoring/event/command_succeeded.rb', 줄 35

def 회신
  @reply
end

#request_id정수 (읽기 전용)

반환 request_id 요청 ID입니다.

반환합니다:

  • (정수)

    request_id 요청 ID입니다.

이후:

  • 2.1.0



47
48
49
# 파일 'build/ruby-driver-v2.19/lib/mongo/monitoring/event/command_succeeded.rb', 줄 47

def request_id
  @request_id
end

#server_connection_id정수 (읽기 전용)

반환값 server_connection_id 서버 연결 ID입니다.

반환합니다:

  • (정수)

    server_connection_id 서버 연결 ID입니다.

이후:

  • 2.1.0



50
51
52
# 파일 'build/ruby-driver-v2.19/lib/mongo/monitoring/event/command_succeeded.rb', 줄 50

def server_connection_id
  @server_connection_id
end

#service_idnil | 객체 (읽기 전용)

서비스 ID(있는 경우)를 반환합니다.

반환합니다:

  • (nil | 객체)

    서비스 ID(있는 경우)입니다.

이후:

  • 2.1.0



53
54
55
# 파일 'build/ruby-driver-v2.19/lib/mongo/monitoring/event/command_succeeded.rb', 줄 53

def service_id
  @service_id
end

#started_eventMonitoring::Event::CommandStarted (읽기 전용)

이 메서드는 비공개 API의 일부입니다. 이 방법은 향후 제거되거나 변경될 수 있으므로 가능하면 사용하지 않는 것이 좋습니다.

started_event 해당 시작 이벤트 를 반환합니다.

반환합니다:

이후:

  • 2.1.0



59
60
61
# 파일 'build/ruby-driver-v2.19/lib/mongo/monitoring/event/command_succeeded.rb', 줄 59

def started_event
  @started_event
end

클래스 메서드 세부 정보

.생성(주소, 작업_ID, 명령_페이로드, 회신_페이로드, 기간, 시작된_이벤트:, 서버_연결_ID: nil, 서비스 _ID : nil) ⇒ 명령완료

이 메서드는 비공개 API의 일부입니다. 이 방법은 향후 제거되거나 변경될 수 있으므로 가능하면 사용하지 않는 것이 좋습니다.

유선 프로토콜 메시지 페이로드에서 이벤트를 생성합니다.

예시:

이벤트를 만듭니다.

CommandSucceeded.generate(address, 1, command_payload, reply_payload, 0.5)

매개변수:

  • 주소 (Server::Address)

    서버 주소 입니다.

  • operation_id (정수)

    작업 ID입니다.

  • command_payload (해시)

    명령 메시지 페이로드입니다.

  • 응답 페이로드 (해시)

    회신 메시지 페이로드입니다.

  • 기간 (Float)

    명령의 지속 시간(초)입니다.

  • started_event (Monitoring::Event::CommandStarted)

    해당 시작 이벤트 입니다.

  • service_id (객체) (기본값: nil)

    서비스 ID(있는 경우)입니다.

반환합니다:

  • (CommandCompleted)

    이벤트.

이후:

  • 2.1.0



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
# 파일 'build/ruby-driver-v2.19/lib/mongo/monitoring/event/command_succeeded.rb', 줄 123

def self.생성(주소, operation_id, command_payload,
  응답 페이로드, 기간, started_event:, server_connection_id: nil,
  service_id: nil
)
  신규(
    command_payload[:command_name],
    command_payload[:database_name],
    주소,
    command_payload[:request_id],
    operation_id,
    generate_reply(command_payload, 응답 페이로드),
    기간,
    started_event: started_event,
    server_connection_id: server_connection_id,
    service_id: service_id,
  )
end

인스턴스 메서드 세부 정보

#요약string

참고:

이 방법은 실험적이며 변경될 수 있습니다.

이벤트에 대한 간결하면서도 유용한 요약을 반환합니다.

반환합니다:

  • (string)

    이벤트의 string 요약입니다.

이후:

  • 2.1.0



101
102
103
# 파일 'build/ruby-driver-v2.19/lib/mongo/monitoring/event/command_succeeded.rb', 줄 101

def 요약
  "#<#{짧은 클래스_이름} 주소=#{주소} #{database_name}.#{command_name}>"
end