docker-engine 0.1.1 → 0.2.0

data/rbi/docker_engine/models/system_events_response.rbi

@@ -0,0 +1,285 @@
+# typed: strong
+
+module DockerEngine
+  module Models
+    class SystemEventsResponse < DockerEngine::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngine::Models::SystemEventsResponse,
+            DockerEngine::Internal::AnyHash
+          )
+        end
+
+      # The type of event
+      sig { returns(T.nilable(String)) }
+      attr_reader :action
+
+      sig { params(action: String).void }
+      attr_writer :action
+
+      # Actor describes something that generates events, like a container, network, or a
+      # volume.
+      sig do
+        returns(T.nilable(DockerEngine::Models::SystemEventsResponse::Actor))
+      end
+      attr_reader :actor
+
+      sig do
+        params(
+          actor: DockerEngine::Models::SystemEventsResponse::Actor::OrHash
+        ).void
+      end
+      attr_writer :actor
+
+      # Scope of the event. Engine events are `local` scope. Cluster (Swarm) events are
+      # `swarm` scope.
+      sig do
+        returns(
+          T.nilable(
+            DockerEngine::Models::SystemEventsResponse::Scope::TaggedSymbol
+          )
+        )
+      end
+      attr_reader :scope
+
+      sig do
+        params(
+          scope: DockerEngine::Models::SystemEventsResponse::Scope::OrSymbol
+        ).void
+      end
+      attr_writer :scope
+
+      # Timestamp of event
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :time
+
+      sig { params(time: Integer).void }
+      attr_writer :time
+
+      # Timestamp of event, with nanosecond accuracy
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :time_nano
+
+      sig { params(time_nano: Integer).void }
+      attr_writer :time_nano
+
+      # The type of object emitting the event
+      sig do
+        returns(
+          T.nilable(
+            DockerEngine::Models::SystemEventsResponse::Type::TaggedSymbol
+          )
+        )
+      end
+      attr_reader :type
+
+      sig do
+        params(
+          type: DockerEngine::Models::SystemEventsResponse::Type::OrSymbol
+        ).void
+      end
+      attr_writer :type
+
+      # EventMessage represents the information an event contains.
+      sig do
+        params(
+          action: String,
+          actor: DockerEngine::Models::SystemEventsResponse::Actor::OrHash,
+          scope: DockerEngine::Models::SystemEventsResponse::Scope::OrSymbol,
+          time: Integer,
+          time_nano: Integer,
+          type: DockerEngine::Models::SystemEventsResponse::Type::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The type of event
+        action: nil,
+        # Actor describes something that generates events, like a container, network, or a
+        # volume.
+        actor: nil,
+        # Scope of the event. Engine events are `local` scope. Cluster (Swarm) events are
+        # `swarm` scope.
+        scope: nil,
+        # Timestamp of event
+        time: nil,
+        # Timestamp of event, with nanosecond accuracy
+        time_nano: nil,
+        # The type of object emitting the event
+        type: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            action: String,
+            actor: DockerEngine::Models::SystemEventsResponse::Actor,
+            scope:
+              DockerEngine::Models::SystemEventsResponse::Scope::TaggedSymbol,
+            time: Integer,
+            time_nano: Integer,
+            type: DockerEngine::Models::SystemEventsResponse::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Actor < DockerEngine::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              DockerEngine::Models::SystemEventsResponse::Actor,
+              DockerEngine::Internal::AnyHash
+            )
+          end
+
+        # Various key/value attributes of the object, depending on its type.
+        sig { returns(T.nilable(T::Hash[Symbol, String])) }
+        attr_reader :attributes
+
+        sig { params(attributes: T::Hash[Symbol, String]).void }
+        attr_writer :attributes
+
+        # The ID of the object emitting the event
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        # Actor describes something that generates events, like a container, network, or a
+        # volume.
+        sig do
+          params(attributes: T::Hash[Symbol, String], id: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Various key/value attributes of the object, depending on its type.
+          attributes: nil,
+          # The ID of the object emitting the event
+          id: nil
+        )
+        end
+
+        sig do
+          override.returns({ attributes: T::Hash[Symbol, String], id: String })
+        end
+        def to_hash
+        end
+      end
+
+      # Scope of the event. Engine events are `local` scope. Cluster (Swarm) events are
+      # `swarm` scope.
+      module Scope
+        extend DockerEngine::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, DockerEngine::Models::SystemEventsResponse::Scope)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        LOCAL =
+          T.let(
+            :local,
+            DockerEngine::Models::SystemEventsResponse::Scope::TaggedSymbol
+          )
+        SWARM =
+          T.let(
+            :swarm,
+            DockerEngine::Models::SystemEventsResponse::Scope::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              DockerEngine::Models::SystemEventsResponse::Scope::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # The type of object emitting the event
+      module Type
+        extend DockerEngine::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, DockerEngine::Models::SystemEventsResponse::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        BUILDER =
+          T.let(
+            :builder,
+            DockerEngine::Models::SystemEventsResponse::Type::TaggedSymbol
+          )
+        CONFIG =
+          T.let(
+            :config,
+            DockerEngine::Models::SystemEventsResponse::Type::TaggedSymbol
+          )
+        CONTAINER =
+          T.let(
+            :container,
+            DockerEngine::Models::SystemEventsResponse::Type::TaggedSymbol
+          )
+        DAEMON =
+          T.let(
+            :daemon,
+            DockerEngine::Models::SystemEventsResponse::Type::TaggedSymbol
+          )
+        IMAGE =
+          T.let(
+            :image,
+            DockerEngine::Models::SystemEventsResponse::Type::TaggedSymbol
+          )
+        NETWORK =
+          T.let(
+            :network,
+            DockerEngine::Models::SystemEventsResponse::Type::TaggedSymbol
+          )
+        NODE =
+          T.let(
+            :node,
+            DockerEngine::Models::SystemEventsResponse::Type::TaggedSymbol
+          )
+        PLUGIN =
+          T.let(
+            :plugin,
+            DockerEngine::Models::SystemEventsResponse::Type::TaggedSymbol
+          )
+        SECRET =
+          T.let(
+            :secret,
+            DockerEngine::Models::SystemEventsResponse::Type::TaggedSymbol
+          )
+        SERVICE =
+          T.let(
+            :service,
+            DockerEngine::Models::SystemEventsResponse::Type::TaggedSymbol
+          )
+        VOLUME =
+          T.let(
+            :volume,
+            DockerEngine::Models::SystemEventsResponse::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              DockerEngine::Models::SystemEventsResponse::Type::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end