aws-sdk-gameliftstreams 1.0.0

data/lib/aws-sdk-gameliftstreams/waiters.rb

@@ -0,0 +1,299 @@
+# frozen_string_literal: true
+
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+require 'aws-sdk-core/waiters'
+
+module Aws::GameLiftStreams
+  # Waiters are utility methods that poll for a particular state to occur
+  # on a client. Waiters can fail after a number of attempts at a polling
+  # interval defined for the service client.
+  #
+  # For a list of operations that can be waited for and the
+  # client methods called for each operation, see the table below or the
+  # {Client#wait_until} field documentation for the {Client}.
+  #
+  # # Invoking a Waiter
+  # To invoke a waiter, call #wait_until on a {Client}. The first parameter
+  # is the waiter name, which is specific to the service client and indicates
+  # which operation is being waited for. The second parameter is a hash of
+  # parameters that are passed to the client method called by the waiter,
+  # which varies according to the waiter name.
+  #
+  # # Wait Failures
+  # To catch errors in a waiter, use WaiterFailed,
+  # as shown in the following example.
+  #
+  #     rescue rescue Aws::Waiters::Errors::WaiterFailed => error
+  #       puts "failed waiting for instance running: #{error.message}
+  #     end
+  #
+  # # Configuring a Waiter
+  # Each waiter has a default polling interval and a maximum number of
+  # attempts it will make before returning control to your program.
+  # To set these values, use the `max_attempts` and `delay` parameters
+  # in your `#wait_until` call.
+  # The following example waits for up to 25 seconds, polling every five seconds.
+  #
+  #     client.wait_until(...) do |w|
+  #       w.max_attempts = 5
+  #       w.delay = 5
+  #     end
+  #
+  # To disable wait failures, set the value of either of these parameters
+  # to `nil`.
+  #
+  # # Extending a Waiter
+  # To modify the behavior of waiters, you can register callbacks that are
+  # triggered before each polling attempt and before waiting.
+  #
+  # The following example implements an exponential backoff in a waiter
+  # by doubling the amount of time to wait on every attempt.
+  #
+  #     client.wait_until(...) do |w|
+  #       w.interval = 0 # disable normal sleep
+  #       w.before_wait do |n, resp|
+  #         sleep(n ** 2)
+  #       end
+  #     end
+  #
+  # # Available Waiters
+  #
+  # The following table lists the valid waiter names, the operations they call,
+  # and the default `:delay` and `:max_attempts` values.
+  #
+  # | waiter_name           | params                      | :delay   | :max_attempts |
+  # | --------------------- | --------------------------- | -------- | ------------- |
+  # | application_deleted   | {Client#get_application}    | 2        | 60            |
+  # | application_ready     | {Client#get_application}    | 2        | 60            |
+  # | stream_group_active   | {Client#get_stream_group}   | 30       | 120           |
+  # | stream_group_deleted  | {Client#get_stream_group}   | 30       | 60            |
+  # | stream_session_active | {Client#get_stream_session} | 2        | 60            |
+  #
+  module Waiters
+
+    # Waits until an application is deleted
+    class ApplicationDeleted
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts (60)
+      # @option options [Integer] :delay (2)
+      # @option options [Proc] :before_attempt
+      # @option options [Proc] :before_wait
+      def initialize(options)
+        @client = options.fetch(:client)
+        @waiter = Aws::Waiters::Waiter.new({
+          max_attempts: 60,
+          delay: 2,
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :get_application,
+            acceptors: [{
+              "matcher" => "error",
+              "state" => "success",
+              "expected" => "ResourceNotFoundException"
+            }]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#get_application)
+      # @return (see Client#get_application)
+      def wait(params = {})
+        @waiter.wait(client: @client, params: params)
+      end
+
+      # @api private
+      attr_reader :waiter
+
+    end
+
+    # Waits until an application is ready
+    class ApplicationReady
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts (60)
+      # @option options [Integer] :delay (2)
+      # @option options [Proc] :before_attempt
+      # @option options [Proc] :before_wait
+      def initialize(options)
+        @client = options.fetch(:client)
+        @waiter = Aws::Waiters::Waiter.new({
+          max_attempts: 60,
+          delay: 2,
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :get_application,
+            acceptors: [
+              {
+                "matcher" => "path",
+                "argument" => "status",
+                "state" => "success",
+                "expected" => "READY"
+              },
+              {
+                "matcher" => "path",
+                "argument" => "status",
+                "state" => "failure",
+                "expected" => "ERROR"
+              }
+            ]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#get_application)
+      # @return (see Client#get_application)
+      def wait(params = {})
+        @waiter.wait(client: @client, params: params)
+      end
+
+      # @api private
+      attr_reader :waiter
+
+    end
+
+    # Waits until a stream group is active
+    class StreamGroupActive
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts (120)
+      # @option options [Integer] :delay (30)
+      # @option options [Proc] :before_attempt
+      # @option options [Proc] :before_wait
+      def initialize(options)
+        @client = options.fetch(:client)
+        @waiter = Aws::Waiters::Waiter.new({
+          max_attempts: 120,
+          delay: 30,
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :get_stream_group,
+            acceptors: [
+              {
+                "matcher" => "path",
+                "argument" => "status",
+                "state" => "success",
+                "expected" => "ACTIVE"
+              },
+              {
+                "matcher" => "path",
+                "argument" => "status",
+                "state" => "failure",
+                "expected" => "ERROR"
+              },
+              {
+                "matcher" => "path",
+                "argument" => "status",
+                "state" => "failure",
+                "expected" => "ACTIVE_WITH_ERRORS"
+              },
+              {
+                "matcher" => "path",
+                "argument" => "status",
+                "state" => "failure",
+                "expected" => "DELETING"
+              }
+            ]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#get_stream_group)
+      # @return (see Client#get_stream_group)
+      def wait(params = {})
+        @waiter.wait(client: @client, params: params)
+      end
+
+      # @api private
+      attr_reader :waiter
+
+    end
+
+    # Waits until a stream group is deleted
+    class StreamGroupDeleted
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts (60)
+      # @option options [Integer] :delay (30)
+      # @option options [Proc] :before_attempt
+      # @option options [Proc] :before_wait
+      def initialize(options)
+        @client = options.fetch(:client)
+        @waiter = Aws::Waiters::Waiter.new({
+          max_attempts: 60,
+          delay: 30,
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :get_stream_group,
+            acceptors: [{
+              "matcher" => "error",
+              "state" => "success",
+              "expected" => "ResourceNotFoundException"
+            }]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#get_stream_group)
+      # @return (see Client#get_stream_group)
+      def wait(params = {})
+        @waiter.wait(client: @client, params: params)
+      end
+
+      # @api private
+      attr_reader :waiter
+
+    end
+
+    # Waits until a stream session is active
+    class StreamSessionActive
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts (60)
+      # @option options [Integer] :delay (2)
+      # @option options [Proc] :before_attempt
+      # @option options [Proc] :before_wait
+      def initialize(options)
+        @client = options.fetch(:client)
+        @waiter = Aws::Waiters::Waiter.new({
+          max_attempts: 60,
+          delay: 2,
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :get_stream_session,
+            acceptors: [
+              {
+                "matcher" => "path",
+                "argument" => "status",
+                "state" => "success",
+                "expected" => "ACTIVE"
+              },
+              {
+                "matcher" => "path",
+                "argument" => "status",
+                "state" => "failure",
+                "expected" => "ERROR"
+              }
+            ]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#get_stream_session)
+      # @return (see Client#get_stream_session)
+      def wait(params = {})
+        @waiter.wait(client: @client, params: params)
+      end
+
+      # @api private
+      attr_reader :waiter
+
+    end
+  end
+end

data/lib/aws-sdk-gameliftstreams.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+
+require 'aws-sdk-core'
+require 'aws-sigv4'
+
+Aws::Plugins::GlobalConfiguration.add_identifier(:gameliftstreams)
+
+# This module provides support for Amazon GameLift Streams. This module is available in the
+# `aws-sdk-gameliftstreams` gem.
+#
+# # Client
+#
+# The {Client} class provides one method for each API operation. Operation
+# methods each accept a hash of request parameters and return a response
+# structure.
+#
+#     game_lift_streams = Aws::GameLiftStreams::Client.new
+#     resp = game_lift_streams.add_stream_group_locations(params)
+#
+# See {Client} for more information.
+#
+# # Errors
+#
+# Errors returned from Amazon GameLift Streams are defined in the
+# {Errors} module and all extend {Errors::ServiceError}.
+#
+#     begin
+#       # do stuff
+#     rescue Aws::GameLiftStreams::Errors::ServiceError
+#       # rescues all Amazon GameLift Streams API errors
+#     end
+#
+# See {Errors} for more information.
+#
+# @!group service
+module Aws::GameLiftStreams
+  autoload :Types, 'aws-sdk-gameliftstreams/types'
+  autoload :ClientApi, 'aws-sdk-gameliftstreams/client_api'
+  module Plugins
+    autoload :Endpoints, 'aws-sdk-gameliftstreams/plugins/endpoints.rb'
+  end
+  autoload :Client, 'aws-sdk-gameliftstreams/client'
+  autoload :Errors, 'aws-sdk-gameliftstreams/errors'
+  autoload :Waiters, 'aws-sdk-gameliftstreams/waiters'
+  autoload :Resource, 'aws-sdk-gameliftstreams/resource'
+  autoload :EndpointParameters, 'aws-sdk-gameliftstreams/endpoint_parameters'
+  autoload :EndpointProvider, 'aws-sdk-gameliftstreams/endpoint_provider'
+  autoload :Endpoints, 'aws-sdk-gameliftstreams/endpoints'
+
+  GEM_VERSION = '1.0.0'
+
+end
+
+require_relative 'aws-sdk-gameliftstreams/customizations'