docker-engine-api 0.2.1

data/rbi/docker_engine_api/models/secret.rbi

@@ -0,0 +1,125 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class Secret < DockerEngineAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(DockerEngineAPI::Secret, DockerEngineAPI::Internal::AnyHash)
+        end
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :created_at
+
+      sig { params(created_at: String).void }
+      attr_writer :created_at
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      sig { returns(T.nilable(DockerEngineAPI::Spec)) }
+      attr_reader :spec
+
+      sig { params(spec: DockerEngineAPI::Spec::OrHash).void }
+      attr_writer :spec
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :updated_at
+
+      sig { params(updated_at: String).void }
+      attr_writer :updated_at
+
+      # The version number of the object such as node, service, etc. This is needed to
+      # avoid conflicting writes. The client must send the version number along with the
+      # modified specification when updating these objects.
+      #
+      # This approach ensures safe concurrency and determinism in that the change on the
+      # object may not be applied if the version number has changed from the last read.
+      # In other words, if two update requests specify the same base version, only one
+      # of the requests can succeed. As a result, two separate update requests that
+      # happen at the same time will not unintentionally overwrite each other.
+      sig { returns(T.nilable(DockerEngineAPI::Secret::Version)) }
+      attr_reader :version
+
+      sig { params(version: DockerEngineAPI::Secret::Version::OrHash).void }
+      attr_writer :version
+
+      sig do
+        params(
+          created_at: String,
+          id: String,
+          spec: DockerEngineAPI::Spec::OrHash,
+          updated_at: String,
+          version: DockerEngineAPI::Secret::Version::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        created_at: nil,
+        id: nil,
+        spec: nil,
+        updated_at: nil,
+        # The version number of the object such as node, service, etc. This is needed to
+        # avoid conflicting writes. The client must send the version number along with the
+        # modified specification when updating these objects.
+        #
+        # This approach ensures safe concurrency and determinism in that the change on the
+        # object may not be applied if the version number has changed from the last read.
+        # In other words, if two update requests specify the same base version, only one
+        # of the requests can succeed. As a result, two separate update requests that
+        # happen at the same time will not unintentionally overwrite each other.
+        version: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            created_at: String,
+            id: String,
+            spec: DockerEngineAPI::Spec,
+            updated_at: String,
+            version: DockerEngineAPI::Secret::Version
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Version < DockerEngineAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              DockerEngineAPI::Secret::Version,
+              DockerEngineAPI::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :index
+
+        sig { params(index: Integer).void }
+        attr_writer :index
+
+        # The version number of the object such as node, service, etc. This is needed to
+        # avoid conflicting writes. The client must send the version number along with the
+        # modified specification when updating these objects.
+        #
+        # This approach ensures safe concurrency and determinism in that the change on the
+        # object may not be applied if the version number has changed from the last read.
+        # In other words, if two update requests specify the same base version, only one
+        # of the requests can succeed. As a result, two separate update requests that
+        # happen at the same time will not unintentionally overwrite each other.
+        sig { params(index: Integer).returns(T.attached_class) }
+        def self.new(index: nil)
+        end
+
+        sig { override.returns({ index: Integer }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/models/secret_create_params.rbi

@@ -0,0 +1,64 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class SecretCreateParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::SecretCreateParams,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T.nilable(DockerEngineAPI::SecretCreateParams::Spec)) }
+      attr_reader :spec
+
+      sig do
+        params(spec: DockerEngineAPI::SecretCreateParams::Spec::OrHash).void
+      end
+      attr_writer :spec
+
+      sig do
+        params(
+          spec: DockerEngineAPI::SecretCreateParams::Spec::OrHash,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(spec: nil, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          {
+            spec: DockerEngineAPI::SecretCreateParams::Spec,
+            request_options: DockerEngineAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Spec < DockerEngineAPI::Models::Spec
+        OrHash =
+          T.type_alias do
+            T.any(
+              DockerEngineAPI::SecretCreateParams::Spec,
+              DockerEngineAPI::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.attached_class) }
+        def self.new
+        end
+
+        sig { override.returns({}) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/models/secret_create_response.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class SecretCreateResponse < DockerEngineAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::Models::SecretCreateResponse,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      # The id of the newly created object.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Response to an API call that returns just an Id
+      sig { params(id: String).returns(T.attached_class) }
+      def self.new(
+        # The id of the newly created object.
+        id:
+      )
+      end
+
+      sig { override.returns({ id: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/models/secret_delete_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class SecretDeleteParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::SecretDeleteParams,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(request_options: {})
+      end
+
+      sig do
+        override.returns({ request_options: DockerEngineAPI::RequestOptions })
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/models/secret_inspect_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class SecretInspectParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::SecretInspectParams,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(request_options: {})
+      end
+
+      sig do
+        override.returns({ request_options: DockerEngineAPI::RequestOptions })
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/models/secret_list_params.rbi

@@ -0,0 +1,62 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class SecretListParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::SecretListParams,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      # A JSON encoded value of the filters (a `map[string][]string`) to process on the
+      # secrets list.
+      #
+      # Available filters:
+      #
+      # - `id=<secret id>`
+      # - `label=<key> or label=<key>=value`
+      # - `name=<secret name>`
+      # - `names=<secret name>`
+      sig { returns(T.nilable(String)) }
+      attr_reader :filters
+
+      sig { params(filters: String).void }
+      attr_writer :filters
+
+      sig do
+        params(
+          filters: String,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A JSON encoded value of the filters (a `map[string][]string`) to process on the
+        # secrets list.
+        #
+        # Available filters:
+        #
+        # - `id=<secret id>`
+        # - `label=<key> or label=<key>=value`
+        # - `name=<secret name>`
+        # - `names=<secret name>`
+        filters: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { filters: String, request_options: DockerEngineAPI::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/docker_engine_api/models/secret_list_response.rbi

@@ -0,0 +1,11 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    SecretListResponse =
+      T.let(
+        DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Secret],
+        DockerEngineAPI::Internal::Type::Converter
+      )
+  end
+end

data/rbi/docker_engine_api/models/secret_update_params.rbi

@@ -0,0 +1,45 @@
+# typed: strong
+
+module DockerEngineAPI
+  module Models
+    class SecretUpdateParams < DockerEngineAPI::Internal::Type::BaseModel
+      extend DockerEngineAPI::Internal::Type::RequestParameters::Converter
+      include DockerEngineAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            DockerEngineAPI::SecretUpdateParams,
+            DockerEngineAPI::Internal::AnyHash
+          )
+        end
+
+      # The version number of the secret object being updated. This is required to avoid
+      # conflicting writes.
+      sig { returns(Integer) }
+      attr_accessor :version
+
+      sig do
+        params(
+          version: Integer,
+          request_options: DockerEngineAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The version number of the secret object being updated. This is required to avoid
+        # conflicting writes.
+        version:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { version: Integer, request_options: DockerEngineAPI::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end