diff --git a/sorbet/rbi/gems/active_record_doctor@1.12.0.rbi b/sorbet/rbi/gems/active_record_doctor@1.14.0.rbi similarity index 96% rename from sorbet/rbi/gems/active_record_doctor@1.12.0.rbi rename to sorbet/rbi/gems/active_record_doctor@1.14.0.rbi index e80d0fb29..38cbd9320 100644 --- a/sorbet/rbi/gems/active_record_doctor@1.12.0.rbi +++ b/sorbet/rbi/gems/active_record_doctor@1.14.0.rbi @@ -130,6 +130,11 @@ class ActiveRecordDoctor::Detectors::Base # source://active_record_doctor//lib/active_record_doctor/detectors/base.rb#258 def each_table(except: T.unsafe(nil)); end + # @return [Boolean] + # + # source://active_record_doctor//lib/active_record_doctor/detectors/base.rb#325 + def ignored?(name, patterns); end + # source://active_record_doctor//lib/active_record_doctor/detectors/base.rb#116 def indexes(table_name); end @@ -234,32 +239,32 @@ class ActiveRecordDoctor::Detectors::IncorrectDependentOption < ::ActiveRecordDo # @return [Boolean] # - # source://active_record_doctor//lib/active_record_doctor/detectors/incorrect_dependent_option.rb#161 + # source://active_record_doctor//lib/active_record_doctor/detectors/incorrect_dependent_option.rb#166 def defines_destroy_callbacks?(model); end # @return [Boolean] # - # source://active_record_doctor//lib/active_record_doctor/detectors/incorrect_dependent_option.rb#145 + # source://active_record_doctor//lib/active_record_doctor/detectors/incorrect_dependent_option.rb#150 def deletable?(model); end - # source://active_record_doctor//lib/active_record_doctor/detectors/incorrect_dependent_option.rb#175 + # source://active_record_doctor//lib/active_record_doctor/detectors/incorrect_dependent_option.rb#180 def dependent_models(model); end # source://active_record_doctor//lib/active_record_doctor/detectors/incorrect_dependent_option.rb#53 def detect; end - # source://active_record_doctor//lib/active_record_doctor/detectors/incorrect_dependent_option.rb#181 + # source://active_record_doctor//lib/active_record_doctor/detectors/incorrect_dependent_option.rb#186 def foreign_key(from_table, to_table); end # source://active_record_doctor//lib/active_record_doctor/detectors/incorrect_dependent_option.rb#21 def message(model:, association:, problem:, associated_models_type: T.unsafe(nil), table_name: T.unsafe(nil), column_name: T.unsafe(nil), associated_models: T.unsafe(nil)); end - # source://active_record_doctor//lib/active_record_doctor/detectors/incorrect_dependent_option.rb#134 + # source://active_record_doctor//lib/active_record_doctor/detectors/incorrect_dependent_option.rb#139 def models_having_association_with_options(as:); end # @return [Boolean] # - # source://active_record_doctor//lib/active_record_doctor/detectors/incorrect_dependent_option.rb#157 + # source://active_record_doctor//lib/active_record_doctor/detectors/incorrect_dependent_option.rb#162 def through?(reflection); end end @@ -383,30 +388,30 @@ class ActiveRecordDoctor::Detectors::MissingUniqueIndexes < ::ActiveRecordDoctor # @return [Boolean] # - # source://active_record_doctor//lib/active_record_doctor/detectors/missing_unique_indexes.rb#102 + # source://active_record_doctor//lib/active_record_doctor/detectors/missing_unique_indexes.rb#107 def conditional_validator?(validator); end # source://active_record_doctor//lib/active_record_doctor/detectors/missing_unique_indexes.rb#35 def detect; end - # source://active_record_doctor//lib/active_record_doctor/detectors/missing_unique_indexes.rb#143 + # source://active_record_doctor//lib/active_record_doctor/detectors/missing_unique_indexes.rb#152 def extract_index_columns(columns); end - # source://active_record_doctor//lib/active_record_doctor/detectors/missing_unique_indexes.rb#81 + # source://active_record_doctor//lib/active_record_doctor/detectors/missing_unique_indexes.rb#85 def has_ones_without_indexes; end - # source://active_record_doctor//lib/active_record_doctor/detectors/missing_unique_indexes.rb#137 + # source://active_record_doctor//lib/active_record_doctor/detectors/missing_unique_indexes.rb#142 def ignore_columns; end # source://active_record_doctor//lib/active_record_doctor/detectors/missing_unique_indexes.rb#22 def message(model:, table:, columns:, problem:); end - # source://active_record_doctor//lib/active_record_doctor/detectors/missing_unique_indexes.rb#106 + # source://active_record_doctor//lib/active_record_doctor/detectors/missing_unique_indexes.rb#111 def resolve_attributes(model, attributes); end # @return [Boolean] # - # source://active_record_doctor//lib/active_record_doctor/detectors/missing_unique_indexes.rb#120 + # source://active_record_doctor//lib/active_record_doctor/detectors/missing_unique_indexes.rb#125 def unique_index?(table_name, columns, scope = T.unsafe(nil)); end # source://active_record_doctor//lib/active_record_doctor/detectors/missing_unique_indexes.rb#40 @@ -462,7 +467,7 @@ class ActiveRecordDoctor::Detectors::UnindexedForeignKeys < ::ActiveRecordDoctor # @return [Boolean] # - # source://active_record_doctor//lib/active_record_doctor/detectors/unindexed_foreign_keys.rb#70 + # source://active_record_doctor//lib/active_record_doctor/detectors/unindexed_foreign_keys.rb#71 def column_exists?(table, column_name); end # source://active_record_doctor//lib/active_record_doctor/detectors/unindexed_foreign_keys.rb#27 @@ -470,17 +475,17 @@ class ActiveRecordDoctor::Detectors::UnindexedForeignKeys < ::ActiveRecordDoctor # @return [Boolean] # - # source://active_record_doctor//lib/active_record_doctor/detectors/unindexed_foreign_keys.rb#52 + # source://active_record_doctor//lib/active_record_doctor/detectors/unindexed_foreign_keys.rb#53 def foreign_key?(table, column); end # @return [Boolean] # - # source://active_record_doctor//lib/active_record_doctor/detectors/unindexed_foreign_keys.rb#58 + # source://active_record_doctor//lib/active_record_doctor/detectors/unindexed_foreign_keys.rb#59 def indexed?(table, column); end # @return [Boolean] # - # source://active_record_doctor//lib/active_record_doctor/detectors/unindexed_foreign_keys.rb#64 + # source://active_record_doctor//lib/active_record_doctor/detectors/unindexed_foreign_keys.rb#65 def indexed_as_polymorphic?(table, column); end # source://active_record_doctor//lib/active_record_doctor/detectors/unindexed_foreign_keys.rb#21 @@ -488,10 +493,10 @@ class ActiveRecordDoctor::Detectors::UnindexedForeignKeys < ::ActiveRecordDoctor # @return [Boolean] # - # source://active_record_doctor//lib/active_record_doctor/detectors/unindexed_foreign_keys.rb#48 + # source://active_record_doctor//lib/active_record_doctor/detectors/unindexed_foreign_keys.rb#49 def named_like_foreign_key?(column); end - # source://active_record_doctor//lib/active_record_doctor/detectors/unindexed_foreign_keys.rb#74 + # source://active_record_doctor//lib/active_record_doctor/detectors/unindexed_foreign_keys.rb#75 def type_column_name(column); end end @@ -789,14 +794,17 @@ class ActiveRecordDoctor::Rake::Task < ::Rake::TaskLib # source://active_record_doctor//lib/active_record_doctor/rake/task.rb#70 def config; end - # source://active_record_doctor//lib/active_record_doctor/rake/task.rb#77 + # source://active_record_doctor//lib/active_record_doctor/rake/task.rb#75 + def effective_config_path; end + + # source://active_record_doctor//lib/active_record_doctor/rake/task.rb#109 def logger; end # source://active_record_doctor//lib/active_record_doctor/rake/task.rb#66 def runner; end end -# An excecution environment for active_record_doctor that provides a config +# An execution environment for active_record_doctor that provides a config # and an output device for use by detectors. # # source://active_record_doctor//lib/active_record_doctor/runner.rb#6 diff --git a/sorbet/rbi/gems/activerecord-postgis-adapter@8.0.2.rbi b/sorbet/rbi/gems/activerecord-postgis-adapter@8.0.3.rbi similarity index 99% rename from sorbet/rbi/gems/activerecord-postgis-adapter@8.0.2.rbi rename to sorbet/rbi/gems/activerecord-postgis-adapter@8.0.3.rbi index 00d6ae1e8..9a156d47c 100644 --- a/sorbet/rbi/gems/activerecord-postgis-adapter@8.0.2.rbi +++ b/sorbet/rbi/gems/activerecord-postgis-adapter@8.0.3.rbi @@ -319,7 +319,7 @@ end module ActiveRecord::ConnectionAdapters::PostGIS::SchemaStatements # override # - # source://activerecord-postgis-adapter//lib/active_record/connection_adapters/postgis/schema_statements.rb#38 + # source://activerecord-postgis-adapter//lib/active_record/connection_adapters/postgis/schema_statements.rb#43 def create_table_definition(*args, **kwargs); end # override @@ -331,7 +331,7 @@ module ActiveRecord::ConnectionAdapters::PostGIS::SchemaStatements # memoize hash of column infos for tables # - # source://activerecord-postgis-adapter//lib/active_record/connection_adapters/postgis/schema_statements.rb#43 + # source://activerecord-postgis-adapter//lib/active_record/connection_adapters/postgis/schema_statements.rb#48 def spatial_column_info(table_name); end end diff --git a/sorbet/rbi/gems/addressable@2.8.5.rbi b/sorbet/rbi/gems/addressable@2.8.7.rbi similarity index 90% rename from sorbet/rbi/gems/addressable@2.8.5.rbi rename to sorbet/rbi/gems/addressable@2.8.7.rbi index cb0d49710..eb8dae420 100644 --- a/sorbet/rbi/gems/addressable@2.8.5.rbi +++ b/sorbet/rbi/gems/addressable@2.8.7.rbi @@ -638,7 +638,7 @@ class Addressable::Template::MatchData # @param key [String, Symbol, Fixnum] Capture index or name. Note that when accessing by with index # of 0, the full URI will be returned. The intention is to mimic # the ::MatchData#[] behavior. - # @param len [#to_int, nil] If provided, an array of values will be returend with the given + # @param len [#to_int, nil] If provided, an array of values will be returned with the given # parameter used as length. # @return [Array, String, nil] The captured value corresponding to the index or name. If the # value was not provided or the key is unknown, nil will be @@ -791,7 +791,7 @@ class Addressable::URI # @param [String, [Hash] a customizable set of options # @return [Addressable::URI] The constructed URI object. # - # source://addressable//lib/addressable/uri.rb#819 + # source://addressable//lib/addressable/uri.rb#830 def initialize(options = T.unsafe(nil)); end # Joins two URIs together. @@ -799,7 +799,7 @@ class Addressable::URI # @param The [String, Addressable::URI, #to_str] URI to join with. # @return [Addressable::URI] The joined URI. # - # source://addressable//lib/addressable/uri.rb#1878 + # source://addressable//lib/addressable/uri.rb#1889 def +(uri); end # Returns true if the URI objects are equal. This method @@ -809,7 +809,7 @@ class Addressable::URI # @return [TrueClass, FalseClass] true if the URIs are equivalent, false # otherwise. # - # source://addressable//lib/addressable/uri.rb#2228 + # source://addressable//lib/addressable/uri.rb#2239 def ==(uri); end # Returns true if the URI objects are equal. This method @@ -820,7 +820,7 @@ class Addressable::URI # @return [TrueClass, FalseClass] true if the URIs are equivalent, false # otherwise. # - # source://addressable//lib/addressable/uri.rb#2206 + # source://addressable//lib/addressable/uri.rb#2217 def ===(uri); end # Determines if the URI is absolute. @@ -828,7 +828,7 @@ class Addressable::URI # @return [TrueClass, FalseClass] true if the URI is absolute. false # otherwise. # - # source://addressable//lib/addressable/uri.rb#1868 + # source://addressable//lib/addressable/uri.rb#1879 def absolute?; end # The authority component for this URI. @@ -836,21 +836,21 @@ class Addressable::URI # # @return [String] The authority component. # - # source://addressable//lib/addressable/uri.rb#1223 + # source://addressable//lib/addressable/uri.rb#1234 def authority; end # Sets the authority component for this URI. # # @param new_authority [String, #to_str] The new authority component. # - # source://addressable//lib/addressable/uri.rb#1263 + # source://addressable//lib/addressable/uri.rb#1274 def authority=(new_authority); end # The basename, if any, of the file in the path component. # # @return [String] The path's basename. # - # source://addressable//lib/addressable/uri.rb#1577 + # source://addressable//lib/addressable/uri.rb#1588 def basename; end # The default port for this URI's scheme. @@ -859,7 +859,7 @@ class Addressable::URI # # @return [Integer] The default port. # - # source://addressable//lib/addressable/uri.rb#1443 + # source://addressable//lib/addressable/uri.rb#1454 def default_port; end # This method allows you to make several changes to a URI simultaneously, @@ -869,7 +869,7 @@ class Addressable::URI # # @param block [Proc] A set of operations to perform on a given URI. # - # source://addressable//lib/addressable/uri.rb#2385 + # source://addressable//lib/addressable/uri.rb#2396 def defer_validation; end # Creates a URI suitable for display to users. If semantic attacks are @@ -879,7 +879,7 @@ class Addressable::URI # # @return [Addressable::URI] A URI suitable for display purposes. # - # source://addressable//lib/addressable/uri.rb#2190 + # source://addressable//lib/addressable/uri.rb#2201 def display_uri; end # Returns the public suffix domain for this host. @@ -887,24 +887,24 @@ class Addressable::URI # @example # Addressable::URI.parse("http://www.example.co.uk").domain # => "example.co.uk" # - # source://addressable//lib/addressable/uri.rb#1214 + # source://addressable//lib/addressable/uri.rb#1225 def domain; end # Clones the URI object. # # @return [Addressable::URI] The cloned URI. # - # source://addressable//lib/addressable/uri.rb#2260 + # source://addressable//lib/addressable/uri.rb#2271 def dup; end # Determines if the URI is an empty string. # # @return [TrueClass, FalseClass] Returns true if empty, false otherwise. # - # source://addressable//lib/addressable/uri.rb#2322 + # source://addressable//lib/addressable/uri.rb#2333 def empty?; end - # source://addressable//lib/addressable/uri.rb#2395 + # source://addressable//lib/addressable/uri.rb#2406 def encode_with(coder); end # Returns true if the URI objects are equal. This method @@ -914,7 +914,7 @@ class Addressable::URI # @return [TrueClass, FalseClass] true if the URIs are equivalent, false # otherwise. # - # source://addressable//lib/addressable/uri.rb#2242 + # source://addressable//lib/addressable/uri.rb#2253 def eql?(uri); end # The extname, if any, of the file in the path component. @@ -922,28 +922,28 @@ class Addressable::URI # # @return [String] The path's extname. # - # source://addressable//lib/addressable/uri.rb#1587 + # source://addressable//lib/addressable/uri.rb#1598 def extname; end # The fragment component for this URI. # # @return [String] The fragment component. # - # source://addressable//lib/addressable/uri.rb#1799 + # source://addressable//lib/addressable/uri.rb#1810 def fragment; end # Sets the fragment component for this URI. # # @param new_fragment [String, #to_str] The new fragment component. # - # source://addressable//lib/addressable/uri.rb#1824 + # source://addressable//lib/addressable/uri.rb#1835 def fragment=(new_fragment); end # Freeze URI, initializing instance variables. # # @return [Addressable::URI] The frozen URI object. # - # source://addressable//lib/addressable/uri.rb#859 + # source://addressable//lib/addressable/uri.rb#870 def freeze; end # A hash value that will make a URI equivalent to its normalized @@ -951,21 +951,21 @@ class Addressable::URI # # @return [Integer] A hash of the URI. # - # source://addressable//lib/addressable/uri.rb#2252 + # source://addressable//lib/addressable/uri.rb#2263 def hash; end # The host component for this URI. # # @return [String] The host component. # - # source://addressable//lib/addressable/uri.rb#1109 + # source://addressable//lib/addressable/uri.rb#1120 def host; end # Sets the host component for this URI. # # @param new_host [String, #to_str] The new host component. # - # source://addressable//lib/addressable/uri.rb#1145 + # source://addressable//lib/addressable/uri.rb#1156 def host=(new_host); end # This method is same as URI::Generic#host except @@ -974,7 +974,7 @@ class Addressable::URI # @return [String] The hostname for this URI. # @see Addressable::URI#host # - # source://addressable//lib/addressable/uri.rb#1167 + # source://addressable//lib/addressable/uri.rb#1178 def hostname; end # This method is same as URI::Generic#host= except @@ -983,7 +983,7 @@ class Addressable::URI # @param new_hostname [String, #to_str] The new hostname for this URI. # @see Addressable::URI#host= # - # source://addressable//lib/addressable/uri.rb#1179 + # source://addressable//lib/addressable/uri.rb#1190 def hostname=(new_hostname); end # The inferred port component for this URI. @@ -992,17 +992,17 @@ class Addressable::URI # # @return [Integer] The inferred port component. # - # source://addressable//lib/addressable/uri.rb#1429 + # source://addressable//lib/addressable/uri.rb#1440 def inferred_port; end - # source://addressable//lib/addressable/uri.rb#2406 + # source://addressable//lib/addressable/uri.rb#2417 def init_with(coder); end # Returns a String representation of the URI object's state. # # @return [String] The URI object's state, as a String. # - # source://addressable//lib/addressable/uri.rb#2373 + # source://addressable//lib/addressable/uri.rb#2384 def inspect; end # Determines if the scheme indicates an IP-based protocol. @@ -1010,7 +1010,7 @@ class Addressable::URI # @return [TrueClass, FalseClass] true if the scheme indicates an IP-based protocol. # false otherwise. # - # source://addressable//lib/addressable/uri.rb#1844 + # source://addressable//lib/addressable/uri.rb#1855 def ip_based?; end # Joins two URIs together. @@ -1018,7 +1018,7 @@ class Addressable::URI # @param The [String, Addressable::URI, #to_str] URI to join with. # @return [Addressable::URI] The joined URI. # - # source://addressable//lib/addressable/uri.rb#1878 + # source://addressable//lib/addressable/uri.rb#1889 def join(uri); end # Destructive form of join. @@ -1027,7 +1027,7 @@ class Addressable::URI # @return [Addressable::URI] The joined URI. # @see Addressable::URI#join # - # source://addressable//lib/addressable/uri.rb#1981 + # source://addressable//lib/addressable/uri.rb#1992 def join!(uri); end # Merges a URI with a Hash of components. @@ -1039,7 +1039,7 @@ class Addressable::URI # @return [Addressable::URI] The merged URI. # @see Hash#merge # - # source://addressable//lib/addressable/uri.rb#1996 + # source://addressable//lib/addressable/uri.rb#2007 def merge(hash); end # Destructive form of merge. @@ -1048,7 +1048,7 @@ class Addressable::URI # @return [Addressable::URI] The merged URI. # @see Addressable::URI#merge # - # source://addressable//lib/addressable/uri.rb#2061 + # source://addressable//lib/addressable/uri.rb#2072 def merge!(uri); end # Returns a normalized URI object. @@ -1061,7 +1061,7 @@ class Addressable::URI # # @return [Addressable::URI] The normalized URI. # - # source://addressable//lib/addressable/uri.rb#2153 + # source://addressable//lib/addressable/uri.rb#2164 def normalize; end # Destructively normalizes this URI object. @@ -1069,63 +1069,63 @@ class Addressable::URI # @return [Addressable::URI] The normalized URI. # @see Addressable::URI#normalize # - # source://addressable//lib/addressable/uri.rb#2179 + # source://addressable//lib/addressable/uri.rb#2190 def normalize!; end # The authority component for this URI, normalized. # # @return [String] The authority component, normalized. # - # source://addressable//lib/addressable/uri.rb#1241 + # source://addressable//lib/addressable/uri.rb#1252 def normalized_authority; end # The fragment component for this URI, normalized. # # @return [String] The fragment component, normalized. # - # source://addressable//lib/addressable/uri.rb#1805 + # source://addressable//lib/addressable/uri.rb#1816 def normalized_fragment; end # The host component for this URI, normalized. # # @return [String] The host component, normalized. # - # source://addressable//lib/addressable/uri.rb#1115 + # source://addressable//lib/addressable/uri.rb#1126 def normalized_host; end # The password component for this URI, normalized. # # @return [String] The password component, normalized. # - # source://addressable//lib/addressable/uri.rb#991 + # source://addressable//lib/addressable/uri.rb#1002 def normalized_password; end # The path component for this URI, normalized. # # @return [String] The path component, normalized. # - # source://addressable//lib/addressable/uri.rb#1524 + # source://addressable//lib/addressable/uri.rb#1535 def normalized_path; end # The port component for this URI, normalized. # # @return [Integer] The port component, normalized. # - # source://addressable//lib/addressable/uri.rb#1381 + # source://addressable//lib/addressable/uri.rb#1392 def normalized_port; end # The query component for this URI, normalized. # # @return [String] The query component, normalized. # - # source://addressable//lib/addressable/uri.rb#1602 + # source://addressable//lib/addressable/uri.rb#1613 def normalized_query(*flags); end # The scheme component for this URI, normalized. # # @return [String] The scheme component, normalized. # - # source://addressable//lib/addressable/uri.rb#885 + # source://addressable//lib/addressable/uri.rb#896 def normalized_scheme; end # The normalized combination of components that represent a site. @@ -1137,21 +1137,21 @@ class Addressable::URI # # @return [String] The normalized components that identify a site. # - # source://addressable//lib/addressable/uri.rb#1474 + # source://addressable//lib/addressable/uri.rb#1485 def normalized_site; end # The user component for this URI, normalized. # # @return [String] The user component, normalized. # - # source://addressable//lib/addressable/uri.rb#936 + # source://addressable//lib/addressable/uri.rb#947 def normalized_user; end # The userinfo component for this URI, normalized. # # @return [String] The userinfo component, normalized. # - # source://addressable//lib/addressable/uri.rb#1057 + # source://addressable//lib/addressable/uri.rb#1068 def normalized_userinfo; end # Omits components from a URI. @@ -1164,7 +1164,7 @@ class Addressable::URI # @param *components [Symbol] The components to be omitted. # @return [Addressable::URI] The URI with components omitted. # - # source://addressable//lib/addressable/uri.rb#2286 + # source://addressable//lib/addressable/uri.rb#2297 def omit(*components); end # Destructive form of omit. @@ -1173,7 +1173,7 @@ class Addressable::URI # @return [Addressable::URI] The URI with components omitted. # @see Addressable::URI#omit # - # source://addressable//lib/addressable/uri.rb#2313 + # source://addressable//lib/addressable/uri.rb#2324 def omit!(*components); end # The origin for this URI, serialized to ASCII, as per @@ -1181,7 +1181,7 @@ class Addressable::URI # # @return [String] The serialized origin. # - # source://addressable//lib/addressable/uri.rb#1303 + # source://addressable//lib/addressable/uri.rb#1314 def origin; end # Sets the origin for this URI, serialized to ASCII, as per @@ -1190,35 +1190,35 @@ class Addressable::URI # # @param new_origin [String, #to_str] The new origin component. # - # source://addressable//lib/addressable/uri.rb#1322 + # source://addressable//lib/addressable/uri.rb#1333 def origin=(new_origin); end # The password component for this URI. # # @return [String] The password component. # - # source://addressable//lib/addressable/uri.rb#985 + # source://addressable//lib/addressable/uri.rb#996 def password; end # Sets the password component for this URI. # # @param new_password [String, #to_str] The new password component. # - # source://addressable//lib/addressable/uri.rb#1014 + # source://addressable//lib/addressable/uri.rb#1025 def password=(new_password); end # The path component for this URI. # # @return [String] The path component. # - # source://addressable//lib/addressable/uri.rb#1517 + # source://addressable//lib/addressable/uri.rb#1528 def path; end # Sets the path component for this URI. # # @param new_path [String, #to_str] The new path component. # - # source://addressable//lib/addressable/uri.rb#1556 + # source://addressable//lib/addressable/uri.rb#1567 def path=(new_path); end # The port component for this URI. @@ -1227,28 +1227,28 @@ class Addressable::URI # # @return [Integer] The port component. # - # source://addressable//lib/addressable/uri.rb#1375 + # source://addressable//lib/addressable/uri.rb#1386 def port; end # Sets the port component for this URI. # # @param new_port [String, Integer, #to_s] The new port component. # - # source://addressable//lib/addressable/uri.rb#1397 + # source://addressable//lib/addressable/uri.rb#1408 def port=(new_port); end # The query component for this URI. # # @return [String] The query component. # - # source://addressable//lib/addressable/uri.rb#1596 + # source://addressable//lib/addressable/uri.rb#1607 def query; end # Sets the query component for this URI. # # @param new_query [String, #to_str] The new query component. # - # source://addressable//lib/addressable/uri.rb#1630 + # source://addressable//lib/addressable/uri.rb#1641 def query=(new_query); end # Converts the query component to a Hash value. @@ -1269,7 +1269,7 @@ class Addressable::URI # @return [Hash, Array, nil] The query string parsed as a Hash or Array # or nil if the query string is blank. # - # source://addressable//lib/addressable/uri.rb#1661 + # source://addressable//lib/addressable/uri.rb#1672 def query_values(return_type = T.unsafe(nil)); end # Sets the query component for this URI from a Hash object. @@ -1290,7 +1290,7 @@ class Addressable::URI # # => "flag&key=value" # @param new_query_values [Hash, #to_hash, Array] The new query values. # - # source://addressable//lib/addressable/uri.rb#1712 + # source://addressable//lib/addressable/uri.rb#1723 def query_values=(new_query_values); end # Determines if the URI is relative. @@ -1298,7 +1298,7 @@ class Addressable::URI # @return [TrueClass, FalseClass] true if the URI is relative. false # otherwise. # - # source://addressable//lib/addressable/uri.rb#1858 + # source://addressable//lib/addressable/uri.rb#1869 def relative?; end # The HTTP request URI for this URI. This is the path and the @@ -1306,14 +1306,14 @@ class Addressable::URI # # @return [String] The request URI required for an HTTP request. # - # source://addressable//lib/addressable/uri.rb#1763 + # source://addressable//lib/addressable/uri.rb#1774 def request_uri; end # Sets the HTTP request URI for this URI. # # @param new_request_uri [String, #to_str] The new HTTP request URI. # - # source://addressable//lib/addressable/uri.rb#1775 + # source://addressable//lib/addressable/uri.rb#1786 def request_uri=(new_request_uri); end # Returns the shortest normalized relative form of this URI that uses the @@ -1323,7 +1323,7 @@ class Addressable::URI # @param uri [String, Addressable::URI, #to_str] The URI to route from. # @return [Addressable::URI] The normalized relative URI that is equivalent to the original URI. # - # source://addressable//lib/addressable/uri.rb#2074 + # source://addressable//lib/addressable/uri.rb#2085 def route_from(uri); end # Returns the shortest normalized relative form of the supplied URI that @@ -1333,21 +1333,21 @@ class Addressable::URI # @param uri [String, Addressable::URI, #to_str] The URI to route to. # @return [Addressable::URI] The normalized relative URI that is equivalent to the supplied URI. # - # source://addressable//lib/addressable/uri.rb#2139 + # source://addressable//lib/addressable/uri.rb#2150 def route_to(uri); end # The scheme component for this URI. # # @return [String] The scheme component. # - # source://addressable//lib/addressable/uri.rb#879 + # source://addressable//lib/addressable/uri.rb#890 def scheme; end # Sets the scheme component for this URI. # # @param new_scheme [String, #to_str] The new scheme component. # - # source://addressable//lib/addressable/uri.rb#906 + # source://addressable//lib/addressable/uri.rb#917 def scheme=(new_scheme); end # The combination of components that represent a site. @@ -1359,14 +1359,14 @@ class Addressable::URI # # @return [String] The components that identify a site. # - # source://addressable//lib/addressable/uri.rb#1456 + # source://addressable//lib/addressable/uri.rb#1467 def site; end # Sets the site value for this URI. # # @param new_site [String, #to_str] The new site value. # - # source://addressable//lib/addressable/uri.rb#1495 + # source://addressable//lib/addressable/uri.rb#1506 def site=(new_site); end # Returns the top-level domain for this host. @@ -1374,28 +1374,28 @@ class Addressable::URI # @example # Addressable::URI.parse("http://www.example.co.uk").tld # => "co.uk" # - # source://addressable//lib/addressable/uri.rb#1196 + # source://addressable//lib/addressable/uri.rb#1207 def tld; end # Sets the top-level domain for this URI. # # @param new_tld [String, #to_str] The new top-level domain. # - # source://addressable//lib/addressable/uri.rb#1204 + # source://addressable//lib/addressable/uri.rb#1215 def tld=(new_tld); end # Returns a Hash of the URI components. # # @return [Hash] The URI as a Hash of components. # - # source://addressable//lib/addressable/uri.rb#2356 + # source://addressable//lib/addressable/uri.rb#2367 def to_hash; end # Converts the URI to a String. # # @return [String] The URI's String representation. # - # source://addressable//lib/addressable/uri.rb#2330 + # source://addressable//lib/addressable/uri.rb#2341 def to_s; end # Converts the URI to a String. @@ -1403,21 +1403,21 @@ class Addressable::URI # # @return [String] The URI's String representation. # - # source://addressable//lib/addressable/uri.rb#2330 + # source://addressable//lib/addressable/uri.rb#2341 def to_str; end # The user component for this URI. # # @return [String] The user component. # - # source://addressable//lib/addressable/uri.rb#930 + # source://addressable//lib/addressable/uri.rb#941 def user; end # Sets the user component for this URI. # # @param new_user [String, #to_str] The new user component. # - # source://addressable//lib/addressable/uri.rb#959 + # source://addressable//lib/addressable/uri.rb#970 def user=(new_user); end # The userinfo component for this URI. @@ -1425,14 +1425,14 @@ class Addressable::URI # # @return [String] The userinfo component. # - # source://addressable//lib/addressable/uri.rb#1041 + # source://addressable//lib/addressable/uri.rb#1052 def userinfo; end # Sets the userinfo component for this URI. # # @param new_userinfo [String, #to_str] The new userinfo component. # - # source://addressable//lib/addressable/uri.rb#1080 + # source://addressable//lib/addressable/uri.rb#1091 def userinfo=(new_userinfo); end protected @@ -1441,14 +1441,14 @@ class Addressable::URI # # @api private # - # source://addressable//lib/addressable/uri.rb#2550 + # source://addressable//lib/addressable/uri.rb#2561 def force_utf8_encoding_if_needed(str); end # Resets composite values for the entire URI # # @api private # - # source://addressable//lib/addressable/uri.rb#2541 + # source://addressable//lib/addressable/uri.rb#2552 def remove_composite_values; end # Replaces the internal state of self with the specified URI's state. @@ -1457,7 +1457,7 @@ class Addressable::URI # @param uri [Addressable::URI] The URI to replace self with. # @return [Addressable::URI] self. # - # source://addressable//lib/addressable/uri.rb#2508 + # source://addressable//lib/addressable/uri.rb#2519 def replace_self(uri); end # Splits path string with "/" (slash). @@ -1467,12 +1467,12 @@ class Addressable::URI # @param path [String] The path to split. # @return [Array] An array of parts of path. # - # source://addressable//lib/addressable/uri.rb#2531 + # source://addressable//lib/addressable/uri.rb#2542 def split_path(path); end # Ensures that the URI is valid. # - # source://addressable//lib/addressable/uri.rb#2465 + # source://addressable//lib/addressable/uri.rb#2476 def validate; end private @@ -1481,7 +1481,7 @@ class Addressable::URI # # @api private # - # source://addressable//lib/addressable/uri.rb#2562 + # source://addressable//lib/addressable/uri.rb#2573 def reset_ivs; end class << self @@ -1510,7 +1510,7 @@ class Addressable::URI # @return [Addressable::URI] The parsed file scheme URI or the original URI if some other URI # scheme was provided. # - # source://addressable//lib/addressable/uri.rb#279 + # source://addressable//lib/addressable/uri.rb#292 def convert_path(path); end # Percent encodes any special characters in the URI. @@ -1524,7 +1524,7 @@ class Addressable::URI # The return type is determined by the return_type # parameter. # - # source://addressable//lib/addressable/uri.rb#605 + # source://addressable//lib/addressable/uri.rb#616 def encode(uri, return_type = T.unsafe(nil)); end # Percent encodes a URI component. @@ -1557,7 +1557,7 @@ class Addressable::URI # character_class. # @return [String] The encoded component. # - # source://addressable//lib/addressable/uri.rb#390 + # source://addressable//lib/addressable/uri.rb#403 def encode_component(component, character_class = T.unsafe(nil), upcase_encoded = T.unsafe(nil)); end # Percent encodes any special characters in the URI. @@ -1571,7 +1571,7 @@ class Addressable::URI # The return type is determined by the return_type # parameter. # - # source://addressable//lib/addressable/uri.rb#605 + # source://addressable//lib/addressable/uri.rb#616 def escape(uri, return_type = T.unsafe(nil)); end # Percent encodes a URI component. @@ -1604,7 +1604,7 @@ class Addressable::URI # character_class. # @return [String] The encoded component. # - # source://addressable//lib/addressable/uri.rb#390 + # source://addressable//lib/addressable/uri.rb#403 def escape_component(component, character_class = T.unsafe(nil), upcase_encoded = T.unsafe(nil)); end # Encodes a set of key/value pairs according to the rules for the @@ -1615,7 +1615,7 @@ class Addressable::URI # Defaults to false. # @return [String] The encoded value. # - # source://addressable//lib/addressable/uri.rb#729 + # source://addressable//lib/addressable/uri.rb#740 def form_encode(form_values, sort = T.unsafe(nil)); end # Decodes a String according to the rules for the @@ -1626,7 +1626,7 @@ class Addressable::URI # This is not a Hash because of the possibility for # duplicate keys. # - # source://addressable//lib/addressable/uri.rb#782 + # source://addressable//lib/addressable/uri.rb#793 def form_unencode(encoded_value); end # Converts an input to a URI. The input does not have to be a valid @@ -1640,14 +1640,14 @@ class Addressable::URI # Defaults to {:scheme => "http"}. # @return [Addressable::URI] The parsed URI. # - # source://addressable//lib/addressable/uri.rb#178 + # source://addressable//lib/addressable/uri.rb#191 def heuristic_parse(uri, hints = T.unsafe(nil)); end # Returns an array of known ip-based schemes. These schemes typically # use a similar URI form: # //:@:/ # - # source://addressable//lib/addressable/uri.rb#1358 + # source://addressable//lib/addressable/uri.rb#1369 def ip_based_schemes; end # Joins several URIs together. @@ -1660,7 +1660,7 @@ class Addressable::URI # @param *uris [String, Addressable::URI, #to_str] The URIs to join. # @return [Addressable::URI] The joined URI. # - # source://addressable//lib/addressable/uri.rb#330 + # source://addressable//lib/addressable/uri.rb#343 def join(*uris); end # Normalizes the encoding of a URI component. @@ -1702,7 +1702,7 @@ class Addressable::URI # normalized to "%2F") but otherwise left alone. # @return [String] The normalized component. # - # source://addressable//lib/addressable/uri.rb#541 + # source://addressable//lib/addressable/uri.rb#552 def normalize_component(component, character_class = T.unsafe(nil), leave_encoded = T.unsafe(nil)); end # Resolves paths to their simplest form. @@ -1710,7 +1710,7 @@ class Addressable::URI # @param path [String] The path to normalize. # @return [String] The normalized path. # - # source://addressable//lib/addressable/uri.rb#2429 + # source://addressable//lib/addressable/uri.rb#2440 def normalize_path(path); end # Normalizes the encoding of a URI. Characters within a hostname are @@ -1725,7 +1725,7 @@ class Addressable::URI # The return type is determined by the return_type # parameter. # - # source://addressable//lib/addressable/uri.rb#660 + # source://addressable//lib/addressable/uri.rb#671 def normalized_encode(uri, return_type = T.unsafe(nil)); end # Returns a URI object based on the parsed string. @@ -1735,14 +1735,14 @@ class Addressable::URI # Addressable::URI. # @return [Addressable::URI] The parsed URI. # - # source://addressable//lib/addressable/uri.rb#101 + # source://addressable//lib/addressable/uri.rb#114 def parse(uri); end # Returns a hash of common IP-based schemes and their default port # numbers. Adding new schemes to this hash, as necessary, will allow # for better URI normalization. # - # source://addressable//lib/addressable/uri.rb#1365 + # source://addressable//lib/addressable/uri.rb#1376 def port_mapping; end # Unencodes any percent encoded characters within a URI component. @@ -1761,7 +1761,7 @@ class Addressable::URI # The return type is determined by the return_type # parameter. # - # source://addressable//lib/addressable/uri.rb#461 + # source://addressable//lib/addressable/uri.rb#472 def unencode(uri, return_type = T.unsafe(nil), leave_encoded = T.unsafe(nil)); end # Unencodes any percent encoded characters within a URI component. @@ -1780,7 +1780,7 @@ class Addressable::URI # The return type is determined by the return_type # parameter. # - # source://addressable//lib/addressable/uri.rb#461 + # source://addressable//lib/addressable/uri.rb#472 def unencode_component(uri, return_type = T.unsafe(nil), leave_encoded = T.unsafe(nil)); end # Unencodes any percent encoded characters within a URI component. @@ -1799,7 +1799,7 @@ class Addressable::URI # The return type is determined by the return_type # parameter. # - # source://addressable//lib/addressable/uri.rb#461 + # source://addressable//lib/addressable/uri.rb#472 def unescape(uri, return_type = T.unsafe(nil), leave_encoded = T.unsafe(nil)); end # Unencodes any percent encoded characters within a URI component. @@ -1818,7 +1818,7 @@ class Addressable::URI # The return type is determined by the return_type # parameter. # - # source://addressable//lib/addressable/uri.rb#461 + # source://addressable//lib/addressable/uri.rb#472 def unescape_component(uri, return_type = T.unsafe(nil), leave_encoded = T.unsafe(nil)); end end end @@ -1838,34 +1838,37 @@ module Addressable::URI::CharacterClasses; end # source://addressable//lib/addressable/uri.rb#47 Addressable::URI::CharacterClasses::ALPHA = T.let(T.unsafe(nil), String) -# source://addressable//lib/addressable/uri.rb#56 +# source://addressable//lib/addressable/uri.rb#57 Addressable::URI::CharacterClasses::AUTHORITY = T.let(T.unsafe(nil), String) # source://addressable//lib/addressable/uri.rb#48 Addressable::URI::CharacterClasses::DIGIT = T.let(T.unsafe(nil), String) -# source://addressable//lib/addressable/uri.rb#59 +# source://addressable//lib/addressable/uri.rb#60 Addressable::URI::CharacterClasses::FRAGMENT = T.let(T.unsafe(nil), String) # source://addressable//lib/addressable/uri.rb#49 Addressable::URI::CharacterClasses::GEN_DELIMS = T.let(T.unsafe(nil), String) -# source://addressable//lib/addressable/uri.rb#55 +# source://addressable//lib/addressable/uri.rb#56 Addressable::URI::CharacterClasses::HOST = T.let(T.unsafe(nil), String) -# source://addressable//lib/addressable/uri.rb#57 +# source://addressable//lib/addressable/uri.rb#58 Addressable::URI::CharacterClasses::PATH = T.let(T.unsafe(nil), String) -# source://addressable//lib/addressable/uri.rb#53 +# source://addressable//lib/addressable/uri.rb#54 Addressable::URI::CharacterClasses::PCHAR = T.let(T.unsafe(nil), String) -# source://addressable//lib/addressable/uri.rb#58 +# source://addressable//lib/addressable/uri.rb#59 Addressable::URI::CharacterClasses::QUERY = T.let(T.unsafe(nil), String) # source://addressable//lib/addressable/uri.rb#51 Addressable::URI::CharacterClasses::RESERVED = T.let(T.unsafe(nil), String) -# source://addressable//lib/addressable/uri.rb#54 +# source://addressable//lib/addressable/uri.rb#53 +Addressable::URI::CharacterClasses::RESERVED_AND_UNRESERVED = T.let(T.unsafe(nil), String) + +# source://addressable//lib/addressable/uri.rb#55 Addressable::URI::CharacterClasses::SCHEME = T.let(T.unsafe(nil), String) # source://addressable//lib/addressable/uri.rb#50 @@ -1875,6 +1878,36 @@ Addressable::URI::CharacterClasses::SUB_DELIMS = T.let(T.unsafe(nil), String) Addressable::URI::CharacterClasses::UNRESERVED = T.let(T.unsafe(nil), String) # source://addressable//lib/addressable/uri.rb#72 +module Addressable::URI::CharacterClassesRegexps; end + +# source://addressable//lib/addressable/uri.rb#73 +Addressable::URI::CharacterClassesRegexps::AUTHORITY = T.let(T.unsafe(nil), Regexp) + +# source://addressable//lib/addressable/uri.rb#74 +Addressable::URI::CharacterClassesRegexps::FRAGMENT = T.let(T.unsafe(nil), Regexp) + +# source://addressable//lib/addressable/uri.rb#75 +Addressable::URI::CharacterClassesRegexps::HOST = T.let(T.unsafe(nil), Regexp) + +# source://addressable//lib/addressable/uri.rb#76 +Addressable::URI::CharacterClassesRegexps::PATH = T.let(T.unsafe(nil), Regexp) + +# source://addressable//lib/addressable/uri.rb#77 +Addressable::URI::CharacterClassesRegexps::QUERY = T.let(T.unsafe(nil), Regexp) + +# source://addressable//lib/addressable/uri.rb#78 +Addressable::URI::CharacterClassesRegexps::RESERVED = T.let(T.unsafe(nil), Regexp) + +# source://addressable//lib/addressable/uri.rb#79 +Addressable::URI::CharacterClassesRegexps::RESERVED_AND_UNRESERVED = T.let(T.unsafe(nil), Regexp) + +# source://addressable//lib/addressable/uri.rb#80 +Addressable::URI::CharacterClassesRegexps::SCHEME = T.let(T.unsafe(nil), Regexp) + +# source://addressable//lib/addressable/uri.rb#81 +Addressable::URI::CharacterClassesRegexps::UNRESERVED = T.let(T.unsafe(nil), Regexp) + +# source://addressable//lib/addressable/uri.rb#85 Addressable::URI::EMPTY_STR = T.let(T.unsafe(nil), String) # Raised if something other than a uri is supplied. @@ -1882,67 +1915,67 @@ Addressable::URI::EMPTY_STR = T.let(T.unsafe(nil), String) # source://addressable//lib/addressable/uri.rb#34 class Addressable::URI::InvalidURIError < ::StandardError; end -# source://addressable//lib/addressable/uri.rb#2587 +# source://addressable//lib/addressable/uri.rb#2598 module Addressable::URI::NONE; end -# source://addressable//lib/addressable/uri.rb#1519 +# source://addressable//lib/addressable/uri.rb#1530 Addressable::URI::NORMPATH = T.let(T.unsafe(nil), Regexp) -# source://addressable//lib/addressable/uri.rb#62 +# source://addressable//lib/addressable/uri.rb#63 module Addressable::URI::NormalizeCharacterClasses; end -# source://addressable//lib/addressable/uri.rb#67 +# source://addressable//lib/addressable/uri.rb#68 Addressable::URI::NormalizeCharacterClasses::FRAGMENT = T.let(T.unsafe(nil), Regexp) -# source://addressable//lib/addressable/uri.rb#63 +# source://addressable//lib/addressable/uri.rb#64 Addressable::URI::NormalizeCharacterClasses::HOST = T.let(T.unsafe(nil), Regexp) -# source://addressable//lib/addressable/uri.rb#65 +# source://addressable//lib/addressable/uri.rb#66 Addressable::URI::NormalizeCharacterClasses::PCHAR = T.let(T.unsafe(nil), Regexp) -# source://addressable//lib/addressable/uri.rb#68 +# source://addressable//lib/addressable/uri.rb#69 Addressable::URI::NormalizeCharacterClasses::QUERY = T.let(T.unsafe(nil), Regexp) -# source://addressable//lib/addressable/uri.rb#66 +# source://addressable//lib/addressable/uri.rb#67 Addressable::URI::NormalizeCharacterClasses::SCHEME = T.let(T.unsafe(nil), Regexp) -# source://addressable//lib/addressable/uri.rb#64 +# source://addressable//lib/addressable/uri.rb#65 Addressable::URI::NormalizeCharacterClasses::UNRESERVED = T.let(T.unsafe(nil), Regexp) -# source://addressable//lib/addressable/uri.rb#2416 +# source://addressable//lib/addressable/uri.rb#2427 Addressable::URI::PARENT = T.let(T.unsafe(nil), String) -# source://addressable//lib/addressable/uri.rb#76 +# source://addressable//lib/addressable/uri.rb#89 Addressable::URI::PORT_MAPPING = T.let(T.unsafe(nil), Hash) -# source://addressable//lib/addressable/uri.rb#2418 +# source://addressable//lib/addressable/uri.rb#2429 Addressable::URI::RULE_2A = T.let(T.unsafe(nil), Regexp) -# source://addressable//lib/addressable/uri.rb#2419 +# source://addressable//lib/addressable/uri.rb#2430 Addressable::URI::RULE_2B_2C = T.let(T.unsafe(nil), Regexp) -# source://addressable//lib/addressable/uri.rb#2420 +# source://addressable//lib/addressable/uri.rb#2431 Addressable::URI::RULE_2D = T.let(T.unsafe(nil), Regexp) -# source://addressable//lib/addressable/uri.rb#2421 +# source://addressable//lib/addressable/uri.rb#2432 Addressable::URI::RULE_PREFIXED_PARENT = T.let(T.unsafe(nil), Regexp) -# source://addressable//lib/addressable/uri.rb#2415 +# source://addressable//lib/addressable/uri.rb#2426 Addressable::URI::SELF_REF = T.let(T.unsafe(nil), String) # Tables used to optimize encoding operations in `self.encode_component` # and `self.normalize_component` # -# source://addressable//lib/addressable/uri.rb#347 +# source://addressable//lib/addressable/uri.rb#360 Addressable::URI::SEQUENCE_ENCODING_TABLE = T.let(T.unsafe(nil), Array) -# source://addressable//lib/addressable/uri.rb#351 +# source://addressable//lib/addressable/uri.rb#364 Addressable::URI::SEQUENCE_UPCASED_PERCENT_ENCODING_TABLE = T.let(T.unsafe(nil), Array) -# source://addressable//lib/addressable/uri.rb#71 +# source://addressable//lib/addressable/uri.rb#84 Addressable::URI::SLASH = T.let(T.unsafe(nil), String) -# source://addressable//lib/addressable/uri.rb#74 +# source://addressable//lib/addressable/uri.rb#87 Addressable::URI::URIREGEX = T.let(T.unsafe(nil), Regexp) # source://addressable//lib/addressable/version.rb#23 diff --git a/sorbet/rbi/gems/airbrussh@1.4.2.rbi b/sorbet/rbi/gems/airbrussh@1.5.2.rbi similarity index 100% rename from sorbet/rbi/gems/airbrussh@1.4.2.rbi rename to sorbet/rbi/gems/airbrussh@1.5.2.rbi diff --git a/sorbet/rbi/gems/autoprefixer-rails@10.4.13.0.rbi b/sorbet/rbi/gems/autoprefixer-rails@10.4.16.0.rbi similarity index 100% rename from sorbet/rbi/gems/autoprefixer-rails@10.4.13.0.rbi rename to sorbet/rbi/gems/autoprefixer-rails@10.4.16.0.rbi diff --git a/sorbet/rbi/gems/aws-eventstream@1.2.0.rbi b/sorbet/rbi/gems/aws-eventstream@1.3.0.rbi similarity index 96% rename from sorbet/rbi/gems/aws-eventstream@1.2.0.rbi rename to sorbet/rbi/gems/aws-eventstream@1.3.0.rbi index 5417b4bcf..c0dd78e60 100644 --- a/sorbet/rbi/gems/aws-eventstream@1.2.0.rbi +++ b/sorbet/rbi/gems/aws-eventstream@1.3.0.rbi @@ -8,28 +8,28 @@ # source://aws-eventstream//lib/aws-eventstream/decoder.rb#7 module Aws class << self - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core.rb#133 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core.rb#138 def config; end - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core.rb#136 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core.rb#141 def config=(config); end - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core.rb#195 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core.rb#200 def eager_autoload!(*args); end - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core.rb#188 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core.rb#193 def empty_connection_pools!; end - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core.rb#145 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core.rb#150 def partition(partition_name); end - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core.rb#150 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core.rb#155 def partitions; end - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core.rb#126 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core.rb#131 def shared_config; end - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core.rb#165 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core.rb#170 def use_bundled_cert!; end end end diff --git a/sorbet/rbi/gems/aws-partitions@1.805.0.rbi b/sorbet/rbi/gems/aws-partitions@1.958.0.rbi similarity index 97% rename from sorbet/rbi/gems/aws-partitions@1.805.0.rbi rename to sorbet/rbi/gems/aws-partitions@1.958.0.rbi index f21805876..5cf6fb92b 100644 --- a/sorbet/rbi/gems/aws-partitions@1.805.0.rbi +++ b/sorbet/rbi/gems/aws-partitions@1.958.0.rbi @@ -8,28 +8,28 @@ # source://aws-partitions//lib/aws-partitions/endpoint_provider.rb#3 module Aws class << self - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core.rb#133 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core.rb#138 def config; end - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core.rb#136 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core.rb#141 def config=(config); end - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core.rb#195 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core.rb#200 def eager_autoload!(*args); end - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core.rb#188 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core.rb#193 def empty_connection_pools!; end - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core.rb#145 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core.rb#150 def partition(partition_name); end - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core.rb#150 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core.rb#155 def partitions; end - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core.rb#126 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core.rb#131 def shared_config; end - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core.rb#165 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core.rb#170 def use_bundled_cert!; end end end diff --git a/sorbet/rbi/gems/aws-sdk-core@3.180.3.rbi b/sorbet/rbi/gems/aws-sdk-core@3.201.3.rbi similarity index 86% rename from sorbet/rbi/gems/aws-sdk-core@3.180.3.rbi rename to sorbet/rbi/gems/aws-sdk-core@3.201.3.rbi index 4caeeabb9..9cddaf2de 100644 --- a/sorbet/rbi/gems/aws-sdk-core@3.180.3.rbi +++ b/sorbet/rbi/gems/aws-sdk-core@3.201.3.rbi @@ -11,17 +11,17 @@ module Aws # @return [Hash] Returns a hash of default configuration options shared # by all constructed clients. # - # source://aws-sdk-core//lib/aws-sdk-core.rb#133 + # source://aws-sdk-core//lib/aws-sdk-core.rb#138 def config; end # @param config [Hash] # - # source://aws-sdk-core//lib/aws-sdk-core.rb#136 + # source://aws-sdk-core//lib/aws-sdk-core.rb#141 def config=(config); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core.rb#195 + # source://aws-sdk-core//lib/aws-sdk-core.rb#200 def eager_autoload!(*args); end # Close any long-lived connections maintained by the SDK's internal @@ -38,22 +38,22 @@ module Aws # # @return [nil] # - # source://aws-sdk-core//lib/aws-sdk-core.rb#188 + # source://aws-sdk-core//lib/aws-sdk-core.rb#193 def empty_connection_pools!; end # @see (Aws::Partitions.partition) # - # source://aws-sdk-core//lib/aws-sdk-core.rb#145 + # source://aws-sdk-core//lib/aws-sdk-core.rb#150 def partition(partition_name); end # @see (Aws::Partitions.partitions) # - # source://aws-sdk-core//lib/aws-sdk-core.rb#150 + # source://aws-sdk-core//lib/aws-sdk-core.rb#155 def partitions; end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core.rb#126 + # source://aws-sdk-core//lib/aws-sdk-core.rb#131 def shared_config; end # The SDK ships with a ca certificate bundle to use when verifying SSL @@ -68,7 +68,7 @@ module Aws # # @return [String] Returns the path to the bundled cert. # - # source://aws-sdk-core//lib/aws-sdk-core.rb#165 + # source://aws-sdk-core//lib/aws-sdk-core.rb#170 def use_bundled_cert!; end end end @@ -429,23 +429,23 @@ class Aws::Binary::EventBuilder # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/binary/event_builder.rb#118 - def _build_payload(streaming, ref, value); end + # source://aws-sdk-core//lib/aws-sdk-core/binary/event_builder.rb#24 + def _event_stream_message(event_ref, params); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/binary/event_builder.rb#89 - def _content_type(shape); end + # source://aws-sdk-core//lib/aws-sdk-core/binary/event_builder.rb#116 + def build_payload_members(payload_ref, params); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/binary/event_builder.rb#24 - def _event_stream_message(event_ref, params); end + # source://aws-sdk-core//lib/aws-sdk-core/binary/event_builder.rb#87 + def content_type(shape); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/binary/event_builder.rb#105 - def _header_value_type(shape, value); end + # source://aws-sdk-core//lib/aws-sdk-core/binary/event_builder.rb#103 + def header_value_type(shape, value); end end # @api private @@ -544,7 +544,7 @@ class Aws::Binary::EventStreamDecoder # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/binary/event_stream_decoder.rb#54 + # source://aws-sdk-core//lib/aws-sdk-core/binary/event_stream_decoder.rb#55 def extract_stream_class(type_class); end # @api private @@ -595,9 +595,478 @@ class Aws::Binary::EventStreamEncoder def serializer_class(protocol); end end -# source://aws-sdk-core//lib/aws-sdk-core.rb#119 +# source://aws-sdk-core//lib/aws-sdk-core.rb#124 Aws::CORE_GEM_VERSION = T.let(T.unsafe(nil), String) +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-core/cbor.rb#5 +module Aws::Cbor + class << self + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor.rb#74 + def decode(bytes); end + + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor.rb#70 + def encode(data); end + + # @api private + # @return [Class] Returns the default engine. + # One of: + # + # * {CborEngine} + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor.rb#65 + def engine; end + + # @api private + # @param engine [Symbol, Class] Must be one of the following values: + # + # * :cbor + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor.rb#56 + def engine=(engine); end + + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor.rb#79 + def set_default_engine; end + + private + + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor.rb#91 + def load_engine(name); end + + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor.rb#97 + def try_load_engine(name); end + end +end + +# Pure Ruby implementation of CBOR encode and decode +# +# source://aws-sdk-core//lib/aws-sdk-core/cbor/cbor_engine.rb#9 +module Aws::Cbor::CborEngine + class << self + # source://aws-sdk-core//lib/aws-sdk-core/cbor/cbor_engine.rb#14 + def decode(bytes); end + + # source://aws-sdk-core//lib/aws-sdk-core/cbor/cbor_engine.rb#10 + def encode(data); end + end +end + +# Pure Ruby implementation of CBOR Decoder +# +# source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#6 +class Aws::Cbor::Decoder + # @return [Decoder] a new instance of Decoder + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#7 + def initialize(bytes); end + + # @raise [ExtraBytesError] + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#12 + def decode; end + + private + + # high level, generic decode. Based on the next type. Consumes and returns + # the next item as a ruby object. + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#31 + def decode_item; end + + # @raise [OutOfBytesError] + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#303 + def peek(n_bytes); end + + # low level streaming interface + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#83 + def peek_type; end + + # returns only the length of the array, caller must read the correct number of values after this + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#142 + def read_array; end + + # A decimal fraction or a bigfloat is represented as a tagged array + # that contains exactly two integer numbers: + # an exponent e and a mantissa m + # See: https://www.rfc-editor.org/rfc/rfc8949.html#name-decimal-fractions-and-bigfl + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#265 + def read_big_decimal; end + + # tag type 2 or 3 + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#244 + def read_bignum(tag_value); end + + # source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#131 + def read_binary_string; end + + # source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#182 + def read_boolean; end + + # source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#113 + def read_break_stop_code; end + + # source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#281 + def read_count(add_info); end + + # source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#238 + def read_double; end + + # returns nothing but consumes and checks the type/info. + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#160 + def read_end_indefinite_collection; end + + # source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#233 + def read_float; end + + # 16 bit IEEE 754 half-precision floats + # Support decoding only + # format: + # sign - 1 bit + # exponent - 5 bits + # precision - 10 bits + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#210 + def read_half; end + + # return a tuple of major_type, add_info + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#276 + def read_info; end + + # source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#118 + def read_integer; end + + # returns only the length of the array, caller must read the correct number of key value pairs after this + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#165 + def read_map; end + + # source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#194 + def read_nil; end + + # @raise [Error] + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#176 + def read_reserved_undefined; end + + # returns nothing but consumes and checks the type/info. + # Caller must keep reading until encountering the stop sequence + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#149 + def read_start_indefinite_array; end + + # returns nothing but consumes and checks the type/info. + # Caller must keep reading until encountering the stop sequence + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#155 + def read_start_indefinite_map; end + + # source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#136 + def read_string; end + + # returns only the tag, caller must interpret the tag and read another value as appropriate + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#171 + def read_tag; end + + # source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#199 + def read_undefined; end + + # @raise [OutOfBytesError] + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#294 + def take(n_bytes); end +end + +# source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#23 +Aws::Cbor::Decoder::FIVE_BIT_MASK = T.let(T.unsafe(nil), Integer) + +# source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#27 +Aws::Cbor::Decoder::TAG_TYPE_BIGDEC = T.let(T.unsafe(nil), Integer) + +# source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#25 +Aws::Cbor::Decoder::TAG_TYPE_BIGNUM = T.let(T.unsafe(nil), Integer) + +# source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#24 +Aws::Cbor::Decoder::TAG_TYPE_EPOCH = T.let(T.unsafe(nil), Integer) + +# source://aws-sdk-core//lib/aws-sdk-core/cbor/decoder.rb#26 +Aws::Cbor::Decoder::TAG_TYPE_NEG_BIGNUM = T.let(T.unsafe(nil), Integer) + +# Pure ruby implementation of CBOR encoder. +# +# source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#8 +class Aws::Cbor::Encoder + # @return [Encoder] a new instance of Encoder + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#9 + def initialize; end + + # generic method for adding generic Ruby data based on its type + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#19 + def add(value); end + + # @return the encoded bytes in CBOR format for all added data + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#14 + def bytes; end + + private + + # source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#167 + def add_auto_float(value); end + + # source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#140 + def add_auto_integer(value); end + + # A decimal fraction or a bigfloat is represented as a tagged array + # that contains exactly two integer numbers: + # an exponent e and a mantissa m + # decimal fractions are always represented with a base of 10 + # See: https://www.rfc-editor.org/rfc/rfc8949.html#name-decimal-fractions-and-bigfl + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#123 + def add_big_decimal(value); end + + # source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#104 + def add_bignum(value); end + + # source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#184 + def add_boolean(value); end + + # Encoding MUST already be Encoding::BINARY + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#189 + def add_byte_string(value); end + + # source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#163 + def add_double(value); end + + # source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#159 + def add_float(value); end + + # streaming style, lower level interface + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#93 + def add_integer(value); end + + # source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#180 + def add_nil; end + + # source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#194 + def add_string(value); end + + # source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#223 + def add_tag(tag); end + + # source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#227 + def add_time(value); end + + # source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#233 + def bignum_to_bytes(value); end + + # source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#218 + def end_indefinite_collection; end + + # source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#74 + def head(major_type, value); end + + # caller is responsible for adding length values + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#201 + def start_array(length); end + + # source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#205 + def start_indefinite_array; end + + # source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#214 + def start_indefinite_map; end + + # caller is responsible for adding length key/value pairs + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#210 + def start_map(length); end +end + +# 111_ 11011 - Major type 7 (Float) + value: 26 +# +# source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#65 +Aws::Cbor::Encoder::DOUBLE_BYTES = T.let(T.unsafe(nil), Integer) + +# 111_11010 - Major type 7 (Float) + value: 26 +# +# source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#64 +Aws::Cbor::Encoder::FLOAT_BYTES = T.let(T.unsafe(nil), Integer) + +# 100_00000 - Major Type 4 (Array) +# +# source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#59 +Aws::Cbor::Encoder::MAJOR_TYPE_ARRAY = T.let(T.unsafe(nil), Integer) + +# 010_00000 - Major Type 2 (Byte String) +# +# source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#57 +Aws::Cbor::Encoder::MAJOR_TYPE_BYTE_STR = T.let(T.unsafe(nil), Integer) + +# 101_00000 - Major Type 5 (Map) +# +# source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#60 +Aws::Cbor::Encoder::MAJOR_TYPE_MAP = T.let(T.unsafe(nil), Integer) + +# 001_00000 - Major Type 1 - negative int +# +# source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#56 +Aws::Cbor::Encoder::MAJOR_TYPE_NEGATIVE_INT = T.let(T.unsafe(nil), Integer) + +# 111_00000 - Major type 7 (111) + 5 bit 0 +# +# source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#62 +Aws::Cbor::Encoder::MAJOR_TYPE_SIMPLE = T.let(T.unsafe(nil), Integer) + +# 011_00000 - Major Type 3 (Text String) +# +# source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#58 +Aws::Cbor::Encoder::MAJOR_TYPE_STR = T.let(T.unsafe(nil), Integer) + +# 110_00000 - Major type 6 (Tag) +# +# source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#61 +Aws::Cbor::Encoder::MAJOR_TYPE_TAG = T.let(T.unsafe(nil), Integer) + +# 000_00000 - Major Type 0 - unsigned int +# +# source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#55 +Aws::Cbor::Encoder::MAJOR_TYPE_UNSIGNED_INT = T.let(T.unsafe(nil), Integer) + +# 2^64 +# +# source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#72 +Aws::Cbor::Encoder::MAX_INTEGER = T.let(T.unsafe(nil), Integer) + +# source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#69 +Aws::Cbor::Encoder::TAG_BIGNUM_BASE = T.let(T.unsafe(nil), Integer) + +# source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#70 +Aws::Cbor::Encoder::TAG_TYPE_BIGDEC = T.let(T.unsafe(nil), Integer) + +# https://www.rfc-editor.org/rfc/rfc8949.html#tags +# +# source://aws-sdk-core//lib/aws-sdk-core/cbor/encoder.rb#68 +Aws::Cbor::Encoder::TAG_TYPE_EPOCH = T.let(T.unsafe(nil), Integer) + +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-core/cbor.rb#22 +class Aws::Cbor::Error < ::StandardError; end + +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-core/cbor.rb#36 +class Aws::Cbor::ExtraBytesError < ::Aws::Cbor::Error + # @api private + # @return [ExtraBytesError] a new instance of ExtraBytesError + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor.rb#37 + def initialize(pos, size); end +end + +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-core/cbor.rb#24 +class Aws::Cbor::OutOfBytesError < ::Aws::Cbor::Error + # @api private + # @return [OutOfBytesError] a new instance of OutOfBytesError + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor.rb#25 + def initialize(n, left); end +end + +# CBOR Tagged data (Major type 6). +# A Tag consists of a tag number and a value. +# In the extended generic data model, a tag number's definition +# describes the additional semantics conveyed with the tag number. +# # @!method initialize(*args) +# @option args [Integer] :tag The tag number. +# @option args [Object] :value The tag's content. +# +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-core/cbor.rb#20 +class Aws::Cbor::Tagged < ::Struct + # The tag number. + # + # @return [Integer] + def tag; end + + # The tag number. + # + # @return [Integer] + def tag=(_); end + + # The tag's content. + # + # @return [Object] + def value; end + + # The tag's content. + # + # @return [Object] + def value=(_); end + + class << self + def [](*_arg0); end + def inspect; end + def keyword_init?; end + def members; end + def new(*_arg0); end + end +end + +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-core/cbor.rb#44 +class Aws::Cbor::UnexpectedAdditionalInformationError < ::Aws::Cbor::Error + # @api private + # @return [UnexpectedAdditionalInformationError] a new instance of UnexpectedAdditionalInformationError + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor.rb#45 + def initialize(add_info); end +end + +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-core/cbor.rb#42 +class Aws::Cbor::UnexpectedBreakCodeError < ::Aws::Cbor::Error; end + +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-core/cbor.rb#30 +class Aws::Cbor::UnknownTypeError < ::Aws::Cbor::Error + # @api private + # @return [UnknownTypeError] a new instance of UnknownTypeError + # + # source://aws-sdk-core//lib/aws-sdk-core/cbor.rb#31 + def initialize(type); end +end + # source://aws-sdk-core//lib/aws-sdk-core/client_side_monitoring/request_metrics.rb#4 module Aws::ClientSideMonitoring; end @@ -973,12 +1442,12 @@ module Aws::ClientStubs # @return [Array] Returns an array of the api requests made. Each request # object contains the :operation_name, :params, and :context. # - # source://aws-sdk-core//lib/aws-sdk-core/client_stubs.rb#195 + # source://aws-sdk-core//lib/aws-sdk-core/client_stubs.rb#196 def api_requests(options = T.unsafe(nil)); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/client_stubs.rb#232 + # source://aws-sdk-core//lib/aws-sdk-core/client_stubs.rb#235 def next_stub(context); end # @api private @@ -1005,7 +1474,7 @@ module Aws::ClientStubs # @return [Structure] Returns a stubbed response data structure. The # actual class returned will depend on the given `operation_name`. # - # source://aws-sdk-core//lib/aws-sdk-core/client_stubs.rb#227 + # source://aws-sdk-core//lib/aws-sdk-core/client_stubs.rb#230 def stub_data(operation_name, data = T.unsafe(nil)); end # Configures what data / errors should be returned from the named operation @@ -1142,7 +1611,7 @@ module Aws::ClientStubs # `:stub_responses => true`. # @return [void] # - # source://aws-sdk-core//lib/aws-sdk-core/client_stubs.rb#176 + # source://aws-sdk-core//lib/aws-sdk-core/client_stubs.rb#177 def stub_responses(operation_name, *stubs); end private @@ -1152,28 +1621,28 @@ module Aws::ClientStubs # plugin to provide a HTTP response that triggers all normal events # during response handling. # - # source://aws-sdk-core//lib/aws-sdk-core/client_stubs.rb#256 + # source://aws-sdk-core//lib/aws-sdk-core/client_stubs.rb#259 def apply_stubs(operation_name, stubs); end - # source://aws-sdk-core//lib/aws-sdk-core/client_stubs.rb#264 + # source://aws-sdk-core//lib/aws-sdk-core/client_stubs.rb#267 def convert_stub(operation_name, stub); end - # source://aws-sdk-core//lib/aws-sdk-core/client_stubs.rb#298 + # source://aws-sdk-core//lib/aws-sdk-core/client_stubs.rb#301 def data_to_http_resp(operation_name, data); end - # source://aws-sdk-core//lib/aws-sdk-core/client_stubs.rb#247 + # source://aws-sdk-core//lib/aws-sdk-core/client_stubs.rb#250 def default_stub(operation_name); end - # source://aws-sdk-core//lib/aws-sdk-core/client_stubs.rb#290 + # source://aws-sdk-core//lib/aws-sdk-core/client_stubs.rb#293 def hash_to_http_resp(data); end - # source://aws-sdk-core//lib/aws-sdk-core/client_stubs.rb#282 + # source://aws-sdk-core//lib/aws-sdk-core/client_stubs.rb#285 def http_response_stub(operation_name, data); end - # source://aws-sdk-core//lib/aws-sdk-core/client_stubs.rb#305 + # source://aws-sdk-core//lib/aws-sdk-core/client_stubs.rb#308 def protocol_helper; end - # source://aws-sdk-core//lib/aws-sdk-core/client_stubs.rb#278 + # source://aws-sdk-core//lib/aws-sdk-core/client_stubs.rb#281 def service_error_stub(error_code); end end @@ -1705,7 +2174,7 @@ class Aws::EC2Metadata::TokenExpiredError < ::RuntimeError; end class Aws::EC2Metadata::TokenRetrievalError < ::RuntimeError; end # An auto-refreshing credential provider that loads credentials from -# instances running in ECS. +# instances running in containers. # # ecs_credentials = Aws::ECSCredentials.new(retries: 3) # ec2 = Aws::EC2::Client.new(credentials: ecs_credentials) @@ -1728,62 +2197,101 @@ class Aws::ECSCredentials # @param options [Hash] # @return [ECSCredentials] a new instance of ECSCredentials # - # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#61 + # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#67 def initialize(options = T.unsafe(nil)); end # @return [Integer] The number of times to retry failed attempts to # fetch credentials from the instance metadata service. Defaults to 0. # - # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#80 + # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#85 def retries; end private - # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#142 + # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#173 def backoff(backoff); end - # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#168 + # Verify that the IP address is a link-local address from ECS or EKS. + # ECS container host (IPv4 `169.254.170.2`) + # EKS container host (IPv4 `169.254.170.23`, IPv6 `fd00:ec2::23`) + # + # @return [Boolean] + # + # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#162 + def ecs_or_eks_ip?(ip_address); end + + # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#215 + def fetch_authorization_token; end + + # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#223 + def fetch_authorization_token_file(path); end + + # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#199 def get_credentials; end # @raise [Non200Response] # - # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#191 + # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#249 def http_get(connection, path); end - # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#104 + # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#109 def initialize_full_uri(endpoint); end - # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#97 + # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#102 def initialize_relative_uri(options, path); end - # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#84 + # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#89 def initialize_uri(options, credential_path, endpoint); end # loopback? method is available in Ruby 2.5+ # Replicate the logic here. + # loopback (IPv4 127.0.0.0/8, IPv6 ::1/128) # # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#131 + # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#148 def ip_loopback?(ip_address); end - # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#181 + # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#239 def open_connection; end - # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#150 + # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#181 def refresh; end - # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#200 + # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#265 def retry_errors(error_classes, options = T.unsafe(nil)); end + # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#258 + def set_authorization_token(request); end + + # @return [Boolean] + # + # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#141 + def valid_ip_address?(ip_address); end + + # @raise [InvalidTokenError] + # + # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#231 + def validate_authorization_token!(token); end + # Validate that the full URI is using a loopback address if scheme is http. # # @raise [ArgumentError] # - # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#114 + # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#126 def validate_full_uri!(full_uri); end + + # @raise [ArgumentError] + # + # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#119 + def validate_full_uri_scheme!(full_uri); end end +# Raised when the token file is invalid. +# +# source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#24 +class Aws::ECSCredentials::InvalidTokenError < ::RuntimeError; end + # These are the errors we trap when attempting to talk to the # instance metadata service. Any of these imply the service # is not present, no responding or some other non-recoverable @@ -1791,7 +2299,7 @@ end # # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#25 +# source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#31 Aws::ECSCredentials::NETWORK_ERRORS = T.let(T.unsafe(nil), Array) # @api private @@ -1799,6 +2307,11 @@ Aws::ECSCredentials::NETWORK_ERRORS = T.let(T.unsafe(nil), Array) # source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#18 class Aws::ECSCredentials::Non200Response < ::RuntimeError; end +# Raised when the token file cannot be read. +# +# source://aws-sdk-core//lib/aws-sdk-core/ecs_credentials.rb#21 +class Aws::ECSCredentials::TokenFileReadError < ::RuntimeError; end + # @api private # # source://aws-sdk-core//lib/aws-sdk-core/eager_loader.rb#7 @@ -2009,29 +2522,48 @@ module Aws::Endpoints class << self # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/endpoints.rb#21 + # source://aws-sdk-core//lib/aws-sdk-core/endpoints.rb#27 def resolve_auth_scheme(context, endpoint); end private # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/endpoints.rb#67 - def default_api_authtype(context); end + # source://aws-sdk-core//lib/aws-sdk-core/endpoints.rb#93 + def default_api_auth(context); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/endpoints.rb#36 + # source://aws-sdk-core//lib/aws-sdk-core/endpoints.rb#68 def default_auth_scheme(context); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/endpoints.rb#55 + # source://aws-sdk-core//lib/aws-sdk-core/endpoints.rb#124 + def legacy_default_api_authtype(context); end + + # Legacy auth resolution - looks for deprecated signatureVersion + # and authType traits. + # + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/endpoints.rb#105 + def legacy_default_auth_scheme(context); end + + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/endpoints.rb#42 def merge_signing_defaults(auth_scheme, config); end + # @api private + # @return [Boolean] + # + # source://aws-sdk-core//lib/aws-sdk-core/endpoints.rb#98 + def s3_or_s3v4_signature_version?(context); end + # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/endpoints.rb#72 + # source://aws-sdk-core//lib/aws-sdk-core/endpoints.rb#63 def sigv4_name(config); end end end @@ -2263,14 +2795,14 @@ module Aws::Endpoints::Matchers # # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/endpoints/matchers.rb#104 + # source://aws-sdk-core//lib/aws-sdk-core/endpoints/matchers.rb#108 def aws_parse_arn(value); end # aws.partition(value: string) Option # # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/endpoints/matchers.rb#92 + # source://aws-sdk-core//lib/aws-sdk-core/endpoints/matchers.rb#96 def aws_partition(value); end # aws.isVirtualHostableS3Bucket(value: string, allowSubDomains: bool) bool @@ -2278,7 +2810,7 @@ module Aws::Endpoints::Matchers # @api private # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/endpoints/matchers.rb#116 + # source://aws-sdk-core//lib/aws-sdk-core/endpoints/matchers.rb#120 def aws_virtual_hostable_s3_bucket?(value, allow_sub_domains = T.unsafe(nil)); end # booleanEquals(value1: bool, value2: bool) bool @@ -2286,7 +2818,7 @@ module Aws::Endpoints::Matchers # @api private # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/endpoints/matchers.rb#61 + # source://aws-sdk-core//lib/aws-sdk-core/endpoints/matchers.rb#65 def boolean_equals?(value1, value2); end # not(value: bool) bool @@ -2300,7 +2832,7 @@ module Aws::Endpoints::Matchers # # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/endpoints/matchers.rb#71 + # source://aws-sdk-core//lib/aws-sdk-core/endpoints/matchers.rb#75 def parse_url(value); end # isSet(value: Option) bool @@ -2316,19 +2848,19 @@ module Aws::Endpoints::Matchers # @api private # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/endpoints/matchers.rb#56 + # source://aws-sdk-core//lib/aws-sdk-core/endpoints/matchers.rb#60 def string_equals?(value1, value2); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/endpoints/matchers.rb#43 + # source://aws-sdk-core//lib/aws-sdk-core/endpoints/matchers.rb#47 def substring(input, start, stop, reverse); end # uriEncode(value: string) string # # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/endpoints/matchers.rb#66 + # source://aws-sdk-core//lib/aws-sdk-core/endpoints/matchers.rb#70 def uri_encode(value); end # isValidHostLabel(value: string, allowSubDomains: bool) bool @@ -2336,7 +2868,7 @@ module Aws::Endpoints::Matchers # @api private # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/endpoints/matchers.rb#78 + # source://aws-sdk-core//lib/aws-sdk-core/endpoints/matchers.rb#82 def valid_host_label?(value, allow_sub_domains = T.unsafe(nil)); end end end @@ -2466,6 +2998,11 @@ class Aws::Endpoints::RulesProvider def resolve_rules(parameters); end end +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-core/endpoints.rb#24 +Aws::Endpoints::SUPPORTED_AUTH_TRAITS = T.let(T.unsafe(nil), Array) + # This class is deprecated. It is used by the Runtime endpoint # resolution approach. It has been replaced by a code generated # approach in each service gem. It can be removed in a new @@ -2603,8 +3140,25 @@ class Aws::Endpoints::URL def _is_ip(authority); end end -# source://aws-sdk-core//lib/aws-sdk-core/errors.rb#4 -module Aws::Errors; end +# source://aws-sdk-core//lib/aws-sdk-core/error_handler.rb#4 +class Aws::ErrorHandler < ::Seahorse::Client::Handler + private + + # source://aws-sdk-core//lib/aws-sdk-core/error_handler.rb#18 + def build_error(context, code, message, data); end + + # source://aws-sdk-core//lib/aws-sdk-core/error_handler.rb#8 + def error(context); end + + # source://aws-sdk-core//lib/aws-sdk-core/error_handler.rb#23 + def http_status_error(context); end + + # source://aws-sdk-core//lib/aws-sdk-core/error_handler.rb#27 + def http_status_error_code(context); end +end + +# source://aws-sdk-core//lib/aws-sdk-core/errors.rb#4 +module Aws::Errors; end # Various plugins perform client-side checksums of responses. # This error indicates a checksum failed. @@ -2631,11 +3185,11 @@ class Aws::Errors::CredentialSourceConflictError < ::RuntimeError; end # # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/errors.rb#337 +# source://aws-sdk-core//lib/aws-sdk-core/errors.rb#346 module Aws::Errors::DynamicErrors # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#344 + # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#353 def const_missing(constant); end # Given the name of a service and an error code, this method @@ -2646,7 +3200,7 @@ module Aws::Errors::DynamicErrors # # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#355 + # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#364 def error_class(error_code); end private @@ -2660,25 +3214,25 @@ module Aws::Errors::DynamicErrors # @return [Symbol] Returns a symbolized constant name for the given # `error_code`. # - # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#376 + # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#385 def error_class_constant(error_code); end # @api private # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#398 + # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#407 def error_const_set?(constant); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#385 + # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#394 def set_error_constant(constant); end class << self # @api private # @private # - # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#339 + # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#348 def extended(submodule); end end end @@ -2783,19 +3337,30 @@ class Aws::Errors::InvalidProcessCredentialsPayload < ::RuntimeError; end # Raised when a client is contsructed and the region is not valid. # -# source://aws-sdk-core//lib/aws-sdk-core/errors.rb#240 +# source://aws-sdk-core//lib/aws-sdk-core/errors.rb#249 class Aws::Errors::InvalidRegionError < ::ArgumentError # @return [InvalidRegionError] a new instance of InvalidRegionError # - # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#241 + # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#250 def initialize(*args); end private - # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#258 + # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#267 def possible_regions; end end +# Raised when a client is constructed and the sigv4a region set is invalid. +# It is invalid when it is empty and/or contains empty strings. +# +# source://aws-sdk-core//lib/aws-sdk-core/errors.rb#241 +class Aws::Errors::InvalidRegionSetError < ::ArgumentError + # @return [InvalidRegionSetError] a new instance of InvalidRegionSetError + # + # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#242 + def initialize(*args); end +end + # Raised when SSO Credentials are invalid # # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#211 @@ -2900,31 +3465,31 @@ class Aws::Errors::NoSourceProfileError < ::RuntimeError; end # is received from the HTTP client. This error is typically the result # of configuring an invalid `:region`. # -# source://aws-sdk-core//lib/aws-sdk-core/errors.rb#270 +# source://aws-sdk-core//lib/aws-sdk-core/errors.rb#279 class Aws::Errors::NoSuchEndpointError < ::RuntimeError # @return [NoSuchEndpointError] a new instance of NoSuchEndpointError # - # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#272 + # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#281 def initialize(options = T.unsafe(nil)); end # Returns the value of attribute context. # - # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#299 + # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#308 def context; end # Returns the value of attribute endpoint. # - # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#301 + # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#310 def endpoint; end # Returns the value of attribute original_error. # - # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#303 + # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#312 def original_error; end private - # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#307 + # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#316 def possible_regions; end end @@ -2940,11 +3505,11 @@ class Aws::Errors::NonSupportedRubyVersionError < ::RuntimeError; end # Raised when attempting to retry a request # and no capacity is available to retry (See adaptive retry_mode) # -# source://aws-sdk-core//lib/aws-sdk-core/errors.rb#318 +# source://aws-sdk-core//lib/aws-sdk-core/errors.rb#327 class Aws::Errors::RetryCapacityNotAvailableError < ::RuntimeError # @return [RetryCapacityNotAvailableError] a new instance of RetryCapacityNotAvailableError # - # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#319 + # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#328 def initialize(*args); end end @@ -2956,7 +3521,7 @@ end # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#12 class Aws::Errors::ServiceError < ::RuntimeError # @param context [Seahorse::Client::RequestContext] - # @param message [String] + # @param message [String, nil] # @param data [Aws::Structure] # @return [ServiceError] a new instance of ServiceError # @@ -2979,6 +3544,11 @@ class Aws::Errors::ServiceError < ::RuntimeError # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#33 def data; end + # @return [Aws::Structure] + # + # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#33 + def data=(_arg0); end + # @api private undocumented # @return [Boolean] # @@ -2992,12 +3562,12 @@ class Aws::Errors::ServiceError < ::RuntimeError def throttling?; end class << self - # @return [String] + # @return [String, nil] # # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#38 def code; end - # @return [String] + # @return [String, nil] # # source://aws-sdk-core//lib/aws-sdk-core/errors.rb#38 def code=(_arg0); end @@ -3023,69 +3593,62 @@ class Aws::EventEmitter # source://aws-sdk-core//lib/aws-sdk-core/event_emitter.rb#6 def initialize; end - # source://aws-sdk-core//lib/aws-sdk-core/event_emitter.rb#32 + # source://aws-sdk-core//lib/aws-sdk-core/event_emitter.rb#31 def emit(type, params); end # Returns the value of attribute encoder. # - # source://aws-sdk-core//lib/aws-sdk-core/event_emitter.rb#15 + # source://aws-sdk-core//lib/aws-sdk-core/event_emitter.rb#14 def encoder; end # Sets the attribute encoder # # @param value the value to set the attribute encoder to. # - # source://aws-sdk-core//lib/aws-sdk-core/event_emitter.rb#15 + # source://aws-sdk-core//lib/aws-sdk-core/event_emitter.rb#14 def encoder=(_arg0); end - # source://aws-sdk-core//lib/aws-sdk-core/event_emitter.rb#21 + # source://aws-sdk-core//lib/aws-sdk-core/event_emitter.rb#20 def on(type, callback); end - # source://aws-sdk-core//lib/aws-sdk-core/event_emitter.rb#25 + # source://aws-sdk-core//lib/aws-sdk-core/event_emitter.rb#24 def signal(type, event); end # Returns the value of attribute signal_queue. # - # source://aws-sdk-core//lib/aws-sdk-core/event_emitter.rb#19 + # source://aws-sdk-core//lib/aws-sdk-core/event_emitter.rb#18 def signal_queue; end # Sets the attribute signal_queue # # @param value the value to set the attribute signal_queue to. # - # source://aws-sdk-core//lib/aws-sdk-core/event_emitter.rb#19 + # source://aws-sdk-core//lib/aws-sdk-core/event_emitter.rb#18 def signal_queue=(_arg0); end # Returns the value of attribute stream. # - # source://aws-sdk-core//lib/aws-sdk-core/event_emitter.rb#13 + # source://aws-sdk-core//lib/aws-sdk-core/event_emitter.rb#12 def stream; end # Sets the attribute stream # # @param value the value to set the attribute stream to. # - # source://aws-sdk-core//lib/aws-sdk-core/event_emitter.rb#13 + # source://aws-sdk-core//lib/aws-sdk-core/event_emitter.rb#12 def stream=(_arg0); end # Returns the value of attribute validate_event. # - # source://aws-sdk-core//lib/aws-sdk-core/event_emitter.rb#17 + # source://aws-sdk-core//lib/aws-sdk-core/event_emitter.rb#16 def validate_event; end # Sets the attribute validate_event # # @param value the value to set the attribute validate_event to. # - # source://aws-sdk-core//lib/aws-sdk-core/event_emitter.rb#17 + # source://aws-sdk-core//lib/aws-sdk-core/event_emitter.rb#16 def validate_event=(_arg0); end - - private - - # @return [Boolean] - # - # source://aws-sdk-core//lib/aws-sdk-core/event_emitter.rb#52 - def _ready_for_events?; end end # @api private @@ -3122,73 +3685,85 @@ class Aws::InstanceProfileCredentials # @option options # @option options # @option options + # @option options # @param options [Hash] # @return [InstanceProfileCredentials] a new instance of InstanceProfileCredentials # - # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#75 + # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#77 def initialize(options = T.unsafe(nil)); end # @return [Integer] Number of times to retry when retrieving credentials # from the instance metadata service. Defaults to 0 when resolving from # the default credential chain ({Aws::CredentialProviderChain}). # - # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#94 + # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#99 def retries; end private + # token is optional - if nil, uses v1 (insecure) flow + # + # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#243 + def _get_credentials(conn, token); end + # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#234 + # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#259 def _metadata_disabled?; end - # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#126 + # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#141 def backoff(backoff); end # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#306 + # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#329 def empty_credentials?(creds); end - # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#183 + # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#225 + def fetch_token(conn); end + + # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#197 def get_credentials; end # GET request fetch profile and credentials # - # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#249 + # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#274 def http_get(connection, path, token = T.unsafe(nil)); end # PUT request fetch token with ttl # - # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#265 + # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#290 def http_put(connection, path, ttl); end - # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#238 + # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#263 def open_connection; end - # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#134 + # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#149 def refresh; end # Compute an offset for refresh with jitter # - # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#311 + # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#334 def refresh_offset; end - # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#107 + # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#131 + def resolve_disable_v1(options); end + + # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#112 def resolve_endpoint(options, endpoint_mode); end - # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#98 + # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#103 def resolve_endpoint_mode(options); end - # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#286 + # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#309 def retry_errors(error_classes, options = T.unsafe(nil), &_block); end # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#230 + # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#255 def token_set?; end - # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#300 + # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#323 def warn_expired_credentials; end end @@ -3225,25 +3800,25 @@ class Aws::InstanceProfileCredentials::Non200Response < ::RuntimeError; end # # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#317 +# source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#340 class Aws::InstanceProfileCredentials::Token # @api private # @return [Token] a new instance of Token # - # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#318 + # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#341 def initialize(value, ttl, created_time = T.unsafe(nil)); end # @api private # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#327 + # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#350 def expired?; end # [String] token value # # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#325 + # source://aws-sdk-core//lib/aws-sdk-core/instance_profile_credentials.rb#348 def value; end end @@ -3264,25 +3839,49 @@ module Aws::Json class << self # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/json.rb#32 + # source://aws-sdk-core//lib/aws-sdk-core/json.rb#46 def dump(value); end + # @api private + # @return [Class] Returns the default engine. + # One of: + # + # * {OjEngine} + # * {JsonEngine} + # + # source://aws-sdk-core//lib/aws-sdk-core/json.rb#37 + def engine; end + + # @api private + # @param engine [Symbol, Class] Must be one of the following values: + # + # * :oj + # * :json + # + # source://aws-sdk-core//lib/aws-sdk-core/json.rb#27 + def engine=(engine); end + # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/json.rb#24 + # source://aws-sdk-core//lib/aws-sdk-core/json.rb#42 def load(json); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/json.rb#28 - def load_file(path); end + # source://aws-sdk-core//lib/aws-sdk-core/json.rb#50 + def set_default_engine; end private # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/json.rb#38 - def select_engine; end + # source://aws-sdk-core//lib/aws-sdk-core/json.rb#63 + def load_engine(name); end + + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/json.rb#69 + def try_load_engine(name); end end end @@ -3293,7 +3892,7 @@ class Aws::Json::Builder # @return [Builder] a new instance of Builder # # source://aws-sdk-core//lib/aws-sdk-core/json/builder.rb#11 - def initialize(rules); end + def initialize(rules, _options = T.unsafe(nil)); end # source://aws-sdk-core//lib/aws-sdk-core/json/builder.rb#15 def serialize(params); end @@ -3303,58 +3902,53 @@ class Aws::Json::Builder private - # source://aws-sdk-core//lib/aws-sdk-core/json/builder.rb#56 + # source://aws-sdk-core//lib/aws-sdk-core/json/builder.rb#63 def encode(blob); end - # source://aws-sdk-core//lib/aws-sdk-core/json/builder.rb#45 + # source://aws-sdk-core//lib/aws-sdk-core/json/builder.rb#51 def format(ref, value); end - # source://aws-sdk-core//lib/aws-sdk-core/json/builder.rb#33 + # source://aws-sdk-core//lib/aws-sdk-core/json/builder.rb#35 def list(ref, values); end - # source://aws-sdk-core//lib/aws-sdk-core/json/builder.rb#38 + # source://aws-sdk-core//lib/aws-sdk-core/json/builder.rb#42 def map(ref, values); end # source://aws-sdk-core//lib/aws-sdk-core/json/builder.rb#22 def structure(ref, values); end - # source://aws-sdk-core//lib/aws-sdk-core/json/builder.rb#60 + # source://aws-sdk-core//lib/aws-sdk-core/json/builder.rb#67 def timestamp(ref, value); end end -# @api private -# -# source://aws-sdk-core//lib/aws-sdk-core/json.rb#47 -Aws::Json::ENGINE = Aws::Json::OjEngine - # source://aws-sdk-core//lib/aws-sdk-core/json/error_handler.rb#5 -class Aws::Json::ErrorHandler < ::Aws::Xml::ErrorHandler - # @param context [Seahorse::Client::RequestContext] - # @return [Seahorse::Client::Response] - # - # source://aws-sdk-core//lib/aws-sdk-core/json/error_handler.rb#9 +class Aws::Json::ErrorHandler < ::Aws::ErrorHandler + # source://aws-sdk-core//lib/aws-sdk-core/json/error_handler.rb#7 def call(context); end private + # source://aws-sdk-core//lib/aws-sdk-core/json/error_handler.rb#82 + def apply_error_headers(rule, context, data); end + # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/json/error_handler.rb#45 + # source://aws-sdk-core//lib/aws-sdk-core/json/error_handler.rb#43 def aws_query_error?(context); end - # source://aws-sdk-core//lib/aws-sdk-core/json/error_handler.rb#28 + # source://aws-sdk-core//lib/aws-sdk-core/json/error_handler.rb#26 def error_code(json, context); end - # source://aws-sdk-core//lib/aws-sdk-core/json/error_handler.rb#58 + # source://aws-sdk-core//lib/aws-sdk-core/json/error_handler.rb#56 def error_message(code, json); end - # source://aws-sdk-core//lib/aws-sdk-core/json/error_handler.rb#18 + # source://aws-sdk-core//lib/aws-sdk-core/json/error_handler.rb#16 def extract_error(body, context); end - # source://aws-sdk-core//lib/aws-sdk-core/json/error_handler.rb#66 - def parse_error_data(context, code); end + # source://aws-sdk-core//lib/aws-sdk-core/json/error_handler.rb#64 + def parse_error_data(context, body, code); end - # source://aws-sdk-core//lib/aws-sdk-core/json/error_handler.rb#50 + # source://aws-sdk-core//lib/aws-sdk-core/json/error_handler.rb#48 def remove_prefix(error_code, context); end end @@ -3368,54 +3962,48 @@ class Aws::Json::Handler < ::Seahorse::Client::Handler private - # source://aws-sdk-core//lib/aws-sdk-core/json/handler.rb#78 + # source://aws-sdk-core//lib/aws-sdk-core/json/handler.rb#80 def apply_request_id(context); end - # source://aws-sdk-core//lib/aws-sdk-core/json/handler.rb#28 + # source://aws-sdk-core//lib/aws-sdk-core/json/handler.rb#27 def build_body(context); end - # source://aws-sdk-core//lib/aws-sdk-core/json/handler.rb#21 + # source://aws-sdk-core//lib/aws-sdk-core/json/handler.rb#20 def build_request(context); end - # source://aws-sdk-core//lib/aws-sdk-core/json/handler.rb#69 + # source://aws-sdk-core//lib/aws-sdk-core/json/handler.rb#71 def content_type(context); end - # source://aws-sdk-core//lib/aws-sdk-core/json/handler.rb#40 + # source://aws-sdk-core//lib/aws-sdk-core/json/handler.rb#39 def parse_body(context); end - # source://aws-sdk-core//lib/aws-sdk-core/json/handler.rb#36 + # source://aws-sdk-core//lib/aws-sdk-core/json/handler.rb#35 def parse_response(response); end # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/json/handler.rb#82 + # source://aws-sdk-core//lib/aws-sdk-core/json/handler.rb#88 + def query_compatible?(context); end + + # @return [Boolean] + # + # source://aws-sdk-core//lib/aws-sdk-core/json/handler.rb#84 def simple_json?(context); end - # source://aws-sdk-core//lib/aws-sdk-core/json/handler.rb#73 + # source://aws-sdk-core//lib/aws-sdk-core/json/handler.rb#75 def target(context); end end # source://aws-sdk-core//lib/aws-sdk-core/json/handler.rb#7 Aws::Json::Handler::CONTENT_TYPE = T.let(T.unsafe(nil), String) -# source://aws-sdk-core//lib/aws-sdk-core/json/json_engine.rb#5 -module Aws::Json::JSONEngine - class << self - # source://aws-sdk-core//lib/aws-sdk-core/json/json_engine.rb#13 - def dump(value); end - - # source://aws-sdk-core//lib/aws-sdk-core/json/json_engine.rb#7 - def load(json); end - end -end - -# source://aws-sdk-core//lib/aws-sdk-core/json/oj_engine.rb#5 +# source://aws-sdk-core//lib/aws-sdk-core/json/oj_engine.rb#7 module Aws::Json::OjEngine class << self - # source://aws-sdk-core//lib/aws-sdk-core/json/oj_engine.rb#19 + # source://aws-sdk-core//lib/aws-sdk-core/json/oj_engine.rb#25 def dump(value); end - # source://aws-sdk-core//lib/aws-sdk-core/json/oj_engine.rb#13 + # source://aws-sdk-core//lib/aws-sdk-core/json/oj_engine.rb#19 def load(json); end private @@ -3423,39 +4011,39 @@ module Aws::Json::OjEngine # Oj before 1.4.0 does not define Oj::ParseError and instead raises # SyntaxError on failure # - # source://aws-sdk-core//lib/aws-sdk-core/json/oj_engine.rb#27 + # source://aws-sdk-core//lib/aws-sdk-core/json/oj_engine.rb#33 def detect_oj_parse_errors; end end end # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/json/oj_engine.rb#10 +# source://aws-sdk-core//lib/aws-sdk-core/json/oj_engine.rb#16 Aws::Json::OjEngine::DUMP_OPTIONS = T.let(T.unsafe(nil), Hash) # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/json/oj_engine.rb#7 +# source://aws-sdk-core//lib/aws-sdk-core/json/oj_engine.rb#9 Aws::Json::OjEngine::LOAD_OPTIONS = T.let(T.unsafe(nil), Hash) # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/json/oj_engine.rb#41 +# source://aws-sdk-core//lib/aws-sdk-core/json/oj_engine.rb#47 Aws::Json::OjEngine::PARSE_ERRORS = T.let(T.unsafe(nil), Array) # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/json.rb#14 +# source://aws-sdk-core//lib/aws-sdk-core/json.rb#11 class Aws::Json::ParseError < ::StandardError # @api private # @return [ParseError] a new instance of ParseError # - # source://aws-sdk-core//lib/aws-sdk-core/json.rb#15 + # source://aws-sdk-core//lib/aws-sdk-core/json.rb#12 def initialize(error); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/json.rb#20 + # source://aws-sdk-core//lib/aws-sdk-core/json.rb#17 def error; end end @@ -3467,34 +4055,109 @@ class Aws::Json::Parser # @return [Parser] a new instance of Parser # # source://aws-sdk-core//lib/aws-sdk-core/json/parser.rb#13 - def initialize(rules); end + def initialize(rules, query_compatible: T.unsafe(nil)); end # @param json [String] # - # source://aws-sdk-core//lib/aws-sdk-core/json/parser.rb#18 + # source://aws-sdk-core//lib/aws-sdk-core/json/parser.rb#19 def parse(json, target = T.unsafe(nil)); end private - # source://aws-sdk-core//lib/aws-sdk-core/json/parser.rb#44 + # @return [Boolean] + # + # source://aws-sdk-core//lib/aws-sdk-core/json/parser.rb#104 + def flattened_list?(shape); end + + # @return [Boolean] + # + # source://aws-sdk-core//lib/aws-sdk-core/json/parser.rb#108 + def flattened_map?(shape); end + + # source://aws-sdk-core//lib/aws-sdk-core/json/parser.rb#63 def list(ref, values, target = T.unsafe(nil)); end - # source://aws-sdk-core//lib/aws-sdk-core/json/parser.rb#52 + # source://aws-sdk-core//lib/aws-sdk-core/json/parser.rb#71 def map(ref, values, target = T.unsafe(nil)); end - # source://aws-sdk-core//lib/aws-sdk-core/json/parser.rb#60 + # source://aws-sdk-core//lib/aws-sdk-core/json/parser.rb#81 def parse_ref(ref, value, target = T.unsafe(nil)); end - # source://aws-sdk-core//lib/aws-sdk-core/json/parser.rb#24 + # source://aws-sdk-core//lib/aws-sdk-core/json/parser.rb#27 def structure(ref, values, target = T.unsafe(nil)); end # @param value [String, Integer] # @return [Time] # - # source://aws-sdk-core//lib/aws-sdk-core/json/parser.rb#78 + # source://aws-sdk-core//lib/aws-sdk-core/json/parser.rb#100 def time(value); end end +# A simple thread safe LRU cache +# +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-core/lru_cache.rb#6 +class Aws::LRUCache + # @api private + # @option options + # @option options + # @param options [Hash] + # @return [LRUCache] a new instance of LRUCache + # + # source://aws-sdk-core//lib/aws-sdk-core/lru_cache.rb#10 + def initialize(options = T.unsafe(nil)); end + + # @api private + # @param key [String] + # @return [Object] + # + # source://aws-sdk-core//lib/aws-sdk-core/lru_cache.rb#19 + def [](key); end + + # @api private + # @param key [String] + # @param value [Object] + # + # source://aws-sdk-core//lib/aws-sdk-core/lru_cache.rb#32 + def []=(key, value); end + + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/lru_cache.rb#51 + def clear; end + + # @api private + # @param key [String] + # @return [Boolean] + # + # source://aws-sdk-core//lib/aws-sdk-core/lru_cache.rb#44 + def key?(key); end +end + +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-core/lru_cache.rb#58 +class Aws::LRUCache::Entry + # @api private + # @return [Entry] a new instance of Entry + # + # source://aws-sdk-core//lib/aws-sdk-core/lru_cache.rb#59 + def initialize(options = T.unsafe(nil)); end + + # @api private + # @return [Boolean] + # + # source://aws-sdk-core//lib/aws-sdk-core/lru_cache.rb#68 + def expired?; end + + # @api private + # @return [Object] + # + # source://aws-sdk-core//lib/aws-sdk-core/lru_cache.rb#66 + def value; end +end + # source://aws-sdk-core//lib/aws-sdk-core/log/formatter.rb#6 module Aws::Log; end @@ -4253,49 +4916,49 @@ class Aws::ParamValidator # @api private # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/param_validator.rb#197 + # source://aws-sdk-core//lib/aws-sdk-core/param_validator.rb#202 def correct_type?(ref, value, errors, context); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/param_validator.rb#128 + # source://aws-sdk-core//lib/aws-sdk-core/param_validator.rb#133 def document(ref, value, errors, context); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/param_validator.rb#222 + # source://aws-sdk-core//lib/aws-sdk-core/param_validator.rb#227 def error_messages(errors); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/param_validator.rb#232 + # source://aws-sdk-core//lib/aws-sdk-core/param_validator.rb#237 def expected_got(context, expected, got); end # @api private # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/param_validator.rb#213 + # source://aws-sdk-core//lib/aws-sdk-core/param_validator.rb#218 def io_like?(value, require_size = T.unsafe(nil)); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/param_validator.rb#99 + # source://aws-sdk-core//lib/aws-sdk-core/param_validator.rb#100 def list(ref, values, errors, context); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/param_validator.rb#113 + # source://aws-sdk-core//lib/aws-sdk-core/param_validator.rb#116 def map(ref, values, errors, context); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/param_validator.rb#148 + # source://aws-sdk-core//lib/aws-sdk-core/param_validator.rb#153 def shape(ref, value, errors, context); end # @api private # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/param_validator.rb#218 + # source://aws-sdk-core//lib/aws-sdk-core/param_validator.rb#223 def streaming_input?(ref); end # @api private @@ -4324,23 +4987,26 @@ Aws::ParamValidator::EXPECTED_GOT = T.let(T.unsafe(nil), String) # source://aws-sdk-core//lib/aws-sdk-core/plugins/bearer_authorization.rb#5 module Aws::Plugins; end +# Deprecated - does not look at new traits like `auth` and `unsignedPayload` +# Necessary to exist after endpoints 2.0 for old service clients + new core +# # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/plugins/bearer_authorization.rb#7 +# source://aws-sdk-core//lib/aws-sdk-core/plugins/bearer_authorization.rb#9 class Aws::Plugins::BearerAuthorization < ::Seahorse::Client::Plugin # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/bearer_authorization.rb#34 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/bearer_authorization.rb#36 def add_handlers(handlers, cfg); end end # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/plugins/bearer_authorization.rb#50 +# source://aws-sdk-core//lib/aws-sdk-core/plugins/bearer_authorization.rb#52 class Aws::Plugins::BearerAuthorization::Handler < ::Seahorse::Client::Handler # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/bearer_authorization.rb#51 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/bearer_authorization.rb#53 def call(context); end end @@ -4356,12 +5022,12 @@ class Aws::Plugins::ChecksumAlgorithm < ::Seahorse::Client::Plugin class << self # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#248 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#251 def calculate_checksum(algorithm, body); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#258 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#261 def digest_for_algorithm(algorithm); end # @api private @@ -4384,12 +5050,12 @@ class Aws::Plugins::ChecksumAlgorithm < ::Seahorse::Client::Plugin # # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#274 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#277 def trailer_length(algorithm, location_name); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#278 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#281 def update_in_chunks(digest, io); end end end @@ -4399,35 +5065,35 @@ end # # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#289 +# source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#292 class Aws::Plugins::ChecksumAlgorithm::AwsChunkedTrailerDigestIO # @api private # @return [AwsChunkedTrailerDigestIO] a new instance of AwsChunkedTrailerDigestIO # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#292 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#295 def initialize(io, algorithm, location_name); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#317 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#320 def read(length, buf = T.unsafe(nil)); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#313 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#316 def rewind; end # the size of the application layer aws-chunked + trailer body # # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#301 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#304 def size; end end # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#290 +# source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#293 Aws::Plugins::ChecksumAlgorithm::AwsChunkedTrailerDigestIO::CHUNK_SIZE = T.let(T.unsafe(nil), Integer) # priority order of checksum algorithms to validate responses against @@ -4477,43 +5143,43 @@ class Aws::Plugins::ChecksumAlgorithm::ChecksumHandler < ::Seahorse::Client::Han # # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#192 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#194 def add_verify_response_checksum_handlers(context); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#164 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#166 def apply_request_trailer_checksum(context, checksum_properties); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#150 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#152 def calculate_request_checksum(context, checksum_properties); end # determine where (header vs trailer) a request checksum should be added # # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#238 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#240 def checksum_request_in(context); end # returns nil if no headers to verify # # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#229 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#231 def response_header_to_verify(headers, validation_list); end # @api private # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#141 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#142 def should_calculate_request_checksum?(context); end # @api private # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#146 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/checksum_algorithm.rb#148 def should_verify_response_checksum?(context); end end @@ -4565,56 +5231,56 @@ end class Aws::Plugins::ClientMetricsPlugin < ::Seahorse::Client::Plugin # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/client_metrics_plugin.rb#60 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/client_metrics_plugin.rb#61 def add_handlers(handlers, config); end class << self # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/client_metrics_plugin.rb#114 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/client_metrics_plugin.rb#115 def resolve_client_id(cfg); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/client_metrics_plugin.rb#100 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/client_metrics_plugin.rb#101 def resolve_client_side_monitoring(cfg); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/client_metrics_plugin.rb#87 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/client_metrics_plugin.rb#88 def resolve_client_side_monitoring_host(cfg); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/client_metrics_plugin.rb#74 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/client_metrics_plugin.rb#75 def resolve_client_side_monitoring_port(cfg); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/client_metrics_plugin.rb#70 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/client_metrics_plugin.rb#71 def resolve_publisher(cfg); end end end # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/plugins/client_metrics_plugin.rb#122 +# source://aws-sdk-core//lib/aws-sdk-core/plugins/client_metrics_plugin.rb#123 class Aws::Plugins::ClientMetricsPlugin::Handler < ::Seahorse::Client::Handler # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/client_metrics_plugin.rb#123 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/client_metrics_plugin.rb#124 def call(context); end private # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/client_metrics_plugin.rb#202 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/client_metrics_plugin.rb#203 def _calculate_service_id(context); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/client_metrics_plugin.rb#208 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/client_metrics_plugin.rb#209 def _fallback_service_id(id); end end @@ -4630,28 +5296,38 @@ end # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/plugins/client_metrics_send_plugin.rb#30 +# source://aws-sdk-core//lib/aws-sdk-core/plugins/client_metrics_send_plugin.rb#32 class Aws::Plugins::ClientMetricsSendPlugin::AttemptHandler < ::Seahorse::Client::Handler # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/client_metrics_send_plugin.rb#31 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/client_metrics_send_plugin.rb#33 + def call(context); end +end + +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-core/plugins/client_metrics_send_plugin.rb#73 +class Aws::Plugins::ClientMetricsSendPlugin::ErrorHandler < ::Seahorse::Client::Handler + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/plugins/client_metrics_send_plugin.rb#74 def call(context); end private # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/client_metrics_send_plugin.rb#76 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/client_metrics_send_plugin.rb#88 def _extract_error_name(error); end end # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/plugins/client_metrics_send_plugin.rb#19 +# source://aws-sdk-core//lib/aws-sdk-core/plugins/client_metrics_send_plugin.rb#21 class Aws::Plugins::ClientMetricsSendPlugin::LatencyHandler < ::Seahorse::Client::Handler # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/client_metrics_send_plugin.rb#20 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/client_metrics_send_plugin.rb#22 def call(context); end end @@ -4804,7 +5480,7 @@ class Aws::Plugins::GlobalConfiguration < ::Seahorse::Client::Plugin # @api private # # source://aws-sdk-core//lib/aws-sdk-core/plugins/global_configuration.rb#65 - def apply_aws_defaults(client_class, options); end + def apply_aws_defaults(_client_class, options); end # @api private # @@ -4816,13 +5492,13 @@ class Aws::Plugins::GlobalConfiguration < ::Seahorse::Client::Plugin # # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/global_configuration.rb#77 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/global_configuration.rb#78 def add_identifier(identifier); end # @api private # @return [Set] # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/global_configuration.rb#83 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/global_configuration.rb#84 def identifiers; end end end @@ -4863,7 +5539,7 @@ end class Aws::Plugins::HttpChecksum < ::Seahorse::Client::Plugin # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/http_checksum.rb#56 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/http_checksum.rb#57 def add_handlers(handlers, _config); end end @@ -4881,19 +5557,19 @@ class Aws::Plugins::HttpChecksum::Handler < ::Seahorse::Client::Handler # @api private # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/http_checksum.rb#24 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/http_checksum.rb#25 def checksum_required?(context); end # @api private # @param value [File, Tempfile, IO#read, String] # @return [String] # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/http_checksum.rb#32 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/http_checksum.rb#33 def md5(value); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/http_checksum.rb#45 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/http_checksum.rb#46 def update_in_chunks(digest, io); end end @@ -4930,6 +5606,21 @@ class Aws::Plugins::IdempotencyToken::Handler < ::Seahorse::Client::Handler def auto_fill(params, ref); end end +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-core/plugins/invocation_id.rb#9 +class Aws::Plugins::InvocationId < ::Seahorse::Client::Plugin; end + +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-core/plugins/invocation_id.rb#12 +class Aws::Plugins::InvocationId::Handler < ::Seahorse::Client::Handler + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/plugins/invocation_id.rb#14 + def call(context); end +end + # Converts input value to JSON Syntax for members with jsonvalue trait # # @api private @@ -4964,19 +5655,19 @@ end class Aws::Plugins::Logging < ::Seahorse::Client::Plugin # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/logging.rb#31 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/logging.rb#33 def add_handlers(handlers, config); end end # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/plugins/logging.rb#35 +# source://aws-sdk-core//lib/aws-sdk-core/plugins/logging.rb#37 class Aws::Plugins::Logging::Handler < ::Seahorse::Client::Handler # @api private # @param context [RequestContext] # @return [Response] # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/logging.rb#39 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/logging.rb#41 def call(context); end private @@ -4986,7 +5677,7 @@ class Aws::Plugins::Logging::Handler < ::Seahorse::Client::Handler # @param response [Response] # @return [String] # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/logging.rb#59 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/logging.rb#61 def format(config, response); end # @api private @@ -4994,7 +5685,7 @@ class Aws::Plugins::Logging::Handler < ::Seahorse::Client::Handler # @param response [Response] # @return [void] # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/logging.rb#52 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/logging.rb#54 def log(config, response); end end @@ -5040,7 +5731,7 @@ end # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/plugins/protocols/query.rb#7 +# source://aws-sdk-core//lib/aws-sdk-core/plugins/protocols/query.rb#5 module Aws::Plugins::Protocols; end # @api private @@ -5050,7 +5741,7 @@ class Aws::Plugins::Protocols::JsonRpc < ::Seahorse::Client::Plugin; end # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/plugins/protocols/query.rb#8 +# source://aws-sdk-core//lib/aws-sdk-core/plugins/protocols/query.rb#6 class Aws::Plugins::Protocols::Query < ::Seahorse::Client::Plugin; end # @api private @@ -5058,16 +5749,6 @@ class Aws::Plugins::Protocols::Query < ::Seahorse::Client::Plugin; end # source://aws-sdk-core//lib/aws-sdk-core/plugins/protocols/rest_json.rb#6 class Aws::Plugins::Protocols::RestJson < ::Seahorse::Client::Plugin; end -# @api private -# -# source://aws-sdk-core//lib/aws-sdk-core/plugins/protocols/rest_json.rb#8 -class Aws::Plugins::Protocols::RestJson::ContentTypeHandler < ::Seahorse::Client::Handler - # @api private - # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/protocols/rest_json.rb#9 - def call(context); end -end - # @api private # # source://aws-sdk-core//lib/aws-sdk-core/plugins/protocols/rest_xml.rb#6 @@ -5100,8 +5781,9 @@ end # source://aws-sdk-core//lib/aws-sdk-core/plugins/regional_endpoint.rb#6 class Aws::Plugins::RegionalEndpoint < ::Seahorse::Client::Plugin # @api private + # @raise [Errors::MissingRegionError] # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/regional_endpoint.rb#67 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/regional_endpoint.rb#82 def after_initialize(client); end class << self @@ -5109,24 +5791,24 @@ class Aws::Plugins::RegionalEndpoint < ::Seahorse::Client::Plugin # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/regional_endpoint.rb#145 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/regional_endpoint.rb#174 def env_global_endpoint(cfg); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/regional_endpoint.rb#135 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/regional_endpoint.rb#164 def env_service_endpoint(cfg); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/regional_endpoint.rb#169 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/regional_endpoint.rb#198 def handle_legacy_pseudo_regions(cfg); end # get a custom configured endpoint from ENV or configuration # # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/regional_endpoint.rb#128 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/regional_endpoint.rb#157 def resolve_custom_config_endpoint(cfg); end # NOTE: with Endpoints 2.0, some of this logic is deprecated @@ -5139,46 +5821,51 @@ class Aws::Plugins::RegionalEndpoint < ::Seahorse::Client::Plugin # # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/regional_endpoint.rb#111 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/regional_endpoint.rb#140 def resolve_endpoint(cfg); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/regional_endpoint.rb#98 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/regional_endpoint.rb#127 def resolve_ignore_configured_endpoint_urls(cfg); end # set a default endpoint in config using legacy (endpoints.json) resolver # # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/regional_endpoint.rb#180 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/regional_endpoint.rb#209 def resolve_legacy_endpoint(cfg); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/regional_endpoint.rb#76 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/regional_endpoint.rb#99 def resolve_region(cfg); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/regional_endpoint.rb#84 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/regional_endpoint.rb#107 + def resolve_sigv4a_signing_region_set(cfg); end + + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/plugins/regional_endpoint.rb#113 def resolve_use_dualstack_endpoint(cfg); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/regional_endpoint.rb#92 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/regional_endpoint.rb#121 def resolve_use_fips_endpoint(cfg); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/regional_endpoint.rb#153 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/regional_endpoint.rb#182 def shared_config_endpoint(cfg); end # check region is a valid RFC host label # # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/regional_endpoint.rb#163 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/regional_endpoint.rb#192 def validate_region!(region); end end end @@ -5242,81 +5929,86 @@ class Aws::Plugins::RequestCompression::CompressionHandler < ::Seahorse::Client: # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/request_compression.rb#136 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/request_compression.rb#145 def gzip_compress(context); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/request_compression.rb#126 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/request_compression.rb#135 def process_compression(encoding, context); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/request_compression.rb#159 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/request_compression.rb#168 def process_streaming_compression(encoding, context); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/request_compression.rb#99 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/request_compression.rb#108 def request_encoding_selection(context); end # @api private # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/request_compression.rb#113 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/request_compression.rb#122 def should_compress?(context); end # @api private # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/request_compression.rb#118 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/request_compression.rb#127 def streaming?(input); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/request_compression.rb#104 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/request_compression.rb#113 def update_content_encoding(encoding, context); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/request_compression.rb#150 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/request_compression.rb#159 def update_in_chunks(compressor, io); end + + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/plugins/request_compression.rb#99 + def with_metric(encoding, &block); end end # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/plugins/request_compression.rb#202 +# source://aws-sdk-core//lib/aws-sdk-core/plugins/request_compression.rb#211 class Aws::Plugins::RequestCompression::CompressionHandler::ChunkBuffer # @api private # @return [ChunkBuffer] a new instance of ChunkBuffer # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/request_compression.rb#203 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/request_compression.rb#212 def initialize; end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/request_compression.rb#207 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/request_compression.rb#216 def last_chunk; end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/request_compression.rb#209 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/request_compression.rb#218 def write(data); end end # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/plugins/request_compression.rb#170 +# source://aws-sdk-core//lib/aws-sdk-core/plugins/request_compression.rb#179 class Aws::Plugins::RequestCompression::CompressionHandler::GzipIO # @api private # @return [GzipIO] a new instance of GzipIO # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/request_compression.rb#171 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/request_compression.rb#180 def initialize(body); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/request_compression.rb#177 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/request_compression.rb#186 def read(length, buff = T.unsafe(nil)); end end @@ -5701,28 +6393,28 @@ Aws::Plugins::Retries::RetryQuota::TIMEOUT_RETRY_COST = T.let(T.unsafe(nil), Int class Aws::Plugins::RetryErrors < ::Seahorse::Client::Plugin # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#421 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#430 def add_handlers(handlers, config); end class << self # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#198 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#199 def resolve_adaptive_retry_wait_to_fill(cfg); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#212 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#213 def resolve_correct_clock_skew(cfg); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#184 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#185 def resolve_max_attempts(cfg); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#165 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#166 def resolve_retry_mode(cfg); end end end @@ -5746,39 +6438,39 @@ Aws::Plugins::RetryErrors::FULL_JITTER = T.let(T.unsafe(nil), Proc) # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#226 +# source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#227 class Aws::Plugins::RetryErrors::Handler < ::Seahorse::Client::Handler # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#230 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#231 def call(context); end private # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#327 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#332 def add_retry_headers(context); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#341 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#346 def compute_request_ttl(context); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#309 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#314 def exponential_backoff(retries); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#273 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#278 def get_send_token(config); end # @api private # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#322 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#327 def refresh_credentials?(context, error); end # maxsendrate is updated if on adaptive mode and based on response @@ -5786,26 +6478,31 @@ class Aws::Plugins::RetryErrors::Handler < ::Seahorse::Client::Handler # # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#288 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#293 def request_bookkeeping(context, response, error_inspector); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#314 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#319 def retry_request(context, error); end # @api private # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#302 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#307 def retryable?(context, response, error_inspector); end + + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#274 + def with_metric(retry_mode, &block); end end # Max backoff (in seconds) # # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#228 +# source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#229 Aws::Plugins::RetryErrors::Handler::MAX_BACKOFF = T.let(T.unsafe(nil), Integer) # @api private @@ -5815,52 +6512,57 @@ Aws::Plugins::RetryErrors::JITTERS = T.let(T.unsafe(nil), Hash) # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#357 +# source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#362 class Aws::Plugins::RetryErrors::LegacyHandler < ::Seahorse::Client::Handler # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#359 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#364 def call(context); end private # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#397 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#406 def delay_retry(context); end # @api private # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#407 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#416 def refresh_credentials?(context, error); end # @api private # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#416 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#425 def response_truncatable?(context); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#379 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#388 def retry_if_possible(response, error_inspector); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#412 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#421 def retry_limit(context); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#388 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#397 def retry_request(context, error); end # @api private # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#401 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#410 def should_retry?(context, error); end + + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/plugins/retry_errors.rb#384 + def with_metric(&block); end end # @api private @@ -5883,46 +6585,46 @@ class Aws::Plugins::Sign < ::Seahorse::Client::Plugin # @api private # # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#27 - def signer_for(auth_scheme, config, region_override = T.unsafe(nil)); end + def signer_for(auth_scheme, config, sigv4_region_override = T.unsafe(nil), sigv4_credentials_override = T.unsafe(nil)); end end end # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#62 +# source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#67 class Aws::Plugins::Sign::Bearer # @api private # @return [Bearer] a new instance of Bearer # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#63 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#68 def initialize; end # @api private # @raise [ArgumentError] # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#80 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#85 def presign_url(*args); end # @api private # @raise [Errors::MissingBearerTokenError] # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#66 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#71 def sign(context); end # @api private # @raise [ArgumentError] # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#84 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#89 def sign_event(*args); end end # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#38 +# source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#42 class Aws::Plugins::Sign::Handler < ::Seahorse::Client::Handler # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#39 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#43 def call(context); end private @@ -5930,27 +6632,27 @@ class Aws::Plugins::Sign::Handler < ::Seahorse::Client::Handler # @api private # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#54 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#59 def v2_signing?(config); end end # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#188 +# source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#201 class Aws::Plugins::Sign::NullSigner # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#193 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#206 def presign_url(*args); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#190 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#203 def sign(context); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#196 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#209 def sign_event(*args); end end @@ -5961,100 +6663,107 @@ Aws::Plugins::Sign::SUPPORTED_AUTH_TYPES = T.let(T.unsafe(nil), Array) # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#90 +# source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#95 class Aws::Plugins::Sign::SignatureV4 # @api private # @return [SignatureV4] a new instance of SignatureV4 # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#91 - def initialize(auth_scheme, config, region_override = T.unsafe(nil)); end + # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#96 + def initialize(auth_scheme, config, sigv4_overrides = T.unsafe(nil)); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#146 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#151 def presign_url(*args); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#119 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#124 def sign(context); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#150 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#155 def sign_event(*args); end private # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#156 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#161 def apply_authtype(context, req); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#171 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#184 def apply_clock_skew(context, req); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#163 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#176 def reset_signature(req); end + + # @api private + # @return [Boolean] + # + # source://aws-sdk-core//lib/aws-sdk-core/plugins/sign.rb#170 + def unsigned_payload?(context, req); end end -# Necessary to exist after endpoints 2.0 +# Deprecated - does not look at new traits like `auth` and `unsignedPayload` +# Necessary to exist after endpoints 2.0 for old service clients + new core # # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/plugins/signature_v4.rb#9 +# source://aws-sdk-core//lib/aws-sdk-core/plugins/signature_v4.rb#10 class Aws::Plugins::SignatureV4 < ::Seahorse::Client::Plugin # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/signature_v4.rb#52 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/signature_v4.rb#53 def add_handlers(handlers, cfg); end class << self # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/signature_v4.rb#141 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/signature_v4.rb#142 def apply_authtype(context); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/signature_v4.rb#98 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/signature_v4.rb#99 def apply_signature(options = T.unsafe(nil)); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/signature_v4.rb#77 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/signature_v4.rb#78 def build_signer(cfg); end end end # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/plugins/signature_v4.rb#61 +# source://aws-sdk-core//lib/aws-sdk-core/plugins/signature_v4.rb#62 class Aws::Plugins::SignatureV4::Handler < ::Seahorse::Client::Handler # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/signature_v4.rb#62 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/signature_v4.rb#63 def call(context); end end # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/plugins/signature_v4.rb#68 +# source://aws-sdk-core//lib/aws-sdk-core/plugins/signature_v4.rb#69 class Aws::Plugins::SignatureV4::MissingCredentialsSigner # @api private # @raise [Errors::MissingCredentialsError] # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/signature_v4.rb#69 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/signature_v4.rb#70 def sign_request(*args); end end # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/plugins/signature_v4.rb#11 +# source://aws-sdk-core//lib/aws-sdk-core/plugins/signature_v4.rb#12 Aws::Plugins::SignatureV4::V4_AUTH = T.let(T.unsafe(nil), Array) # @api private @@ -6063,32 +6772,32 @@ Aws::Plugins::SignatureV4::V4_AUTH = T.let(T.unsafe(nil), Array) class Aws::Plugins::StubResponses < ::Seahorse::Client::Plugin # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/stub_responses.rb#31 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/stub_responses.rb#32 def add_handlers(handlers, config); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/stub_responses.rb#35 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/stub_responses.rb#36 def after_initialize(client); end end # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/plugins/stub_responses.rb#48 +# source://aws-sdk-core//lib/aws-sdk-core/plugins/stub_responses.rb#49 class Aws::Plugins::StubResponses::Handler < ::Seahorse::Client::Handler # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/stub_responses.rb#64 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/stub_responses.rb#65 def apply_stub(stub, response, async_mode = T.unsafe(nil)); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/stub_responses.rb#50 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/stub_responses.rb#51 def call(context); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/stub_responses.rb#73 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/stub_responses.rb#74 def signal_error(error, http_resp); end # @api private @@ -6096,26 +6805,27 @@ class Aws::Plugins::StubResponses::Handler < ::Seahorse::Client::Handler # @param http_resp [Seahorse::Client::Http::Response | Seahorse::Client::Http::AsyncResponse] # @param async_mode [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/stub_responses.rb#84 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/stub_responses.rb#85 def signal_http(stub, http_resp, async_mode = T.unsafe(nil)); end end # For Streaming Input Operations, when `requiresLength` is enabled # checking whether `Content-Length` header can be set, -# for `v4-unsigned-body` operations, set `Transfer-Encoding` header +# for `unsignedPayload` and `v4-unsigned-body` operations, +# set `Transfer-Encoding` header. # # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/plugins/transfer_encoding.rb#9 +# source://aws-sdk-core//lib/aws-sdk-core/plugins/transfer_encoding.rb#10 class Aws::Plugins::TransferEncoding < ::Seahorse::Client::Plugin; end # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/plugins/transfer_encoding.rb#12 +# source://aws-sdk-core//lib/aws-sdk-core/plugins/transfer_encoding.rb#13 class Aws::Plugins::TransferEncoding::Handler < ::Seahorse::Client::Handler # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/transfer_encoding.rb#13 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/transfer_encoding.rb#14 def call(context); end private @@ -6123,14 +6833,20 @@ class Aws::Plugins::TransferEncoding::Handler < ::Seahorse::Client::Handler # @api private # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/transfer_encoding.rb#40 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/transfer_encoding.rb#45 def requires_length?(ref); end # @api private # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/transfer_encoding.rb#31 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/transfer_encoding.rb#32 def streaming?(ref); end + + # @api private + # @return [Boolean] + # + # source://aws-sdk-core//lib/aws-sdk-core/plugins/transfer_encoding.rb#40 + def unsigned_payload?(operation); end end # @api private @@ -6138,41 +6854,48 @@ end # source://aws-sdk-core//lib/aws-sdk-core/plugins/user_agent.rb#6 class Aws::Plugins::UserAgent < ::Seahorse::Client::Plugin class << self + # Deprecated - must exist for old service gems + # + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/plugins/user_agent.rb#44 + def feature(_feature, &block); end + # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/user_agent.rb#25 - def feature(feature, &block); end + # source://aws-sdk-core//lib/aws-sdk-core/plugins/user_agent.rb#48 + def metric(metric, &block); end end end # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/plugins/user_agent.rb#34 +# source://aws-sdk-core//lib/aws-sdk-core/plugins/user_agent.rb#60 class Aws::Plugins::UserAgent::Handler < ::Seahorse::Client::Handler # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/user_agent.rb#35 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/user_agent.rb#61 def call(context); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/user_agent.rb#40 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/user_agent.rb#66 def set_user_agent(context); end end # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/plugins/user_agent.rb#44 +# source://aws-sdk-core//lib/aws-sdk-core/plugins/user_agent.rb#70 class Aws::Plugins::UserAgent::Handler::UserAgent # @api private # @return [UserAgent] a new instance of UserAgent # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/user_agent.rb#45 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/user_agent.rb#71 def initialize(context); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/user_agent.rb#49 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/user_agent.rb#75 def to_s; end private @@ -6181,53 +6904,59 @@ class Aws::Plugins::UserAgent::Handler::UserAgent # # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/user_agent.rb#69 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/user_agent.rb#104 def api_metadata; end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/user_agent.rb#113 - def app_id; end - - # @api private - # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/user_agent.rb#109 - def config_metadata; end + # source://aws-sdk-core//lib/aws-sdk-core/plugins/user_agent.rb#143 + def app_id_metadata; end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/user_agent.rb#103 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/user_agent.rb#137 def env_metadata; end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/user_agent.rb#121 - def feature_metadata; end - - # @api private - # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/user_agent.rb#127 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/user_agent.rb#151 def framework_metadata; end # Used to be RUBY_ENGINE/RUBY_VERSION # # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/user_agent.rb#99 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/user_agent.rb#133 def language_metadata; end + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/plugins/user_agent.rb#168 + def metric_metadata; end + # Used to be RUBY_PLATFORM # # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/plugins/user_agent.rb#79 + # source://aws-sdk-core//lib/aws-sdk-core/plugins/user_agent.rb#114 def os_metadata; end end +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-core/plugins/user_agent.rb#7 +Aws::Plugins::UserAgent::METRICS = T.let(T.unsafe(nil), Hash) + # A credential provider that executes a given process and attempts -# to read its stdout to recieve a JSON payload containing the credentials. +# to read its stdout to receive a JSON payload containing the credentials. +# +# credentials = Aws::ProcessCredentials.new(['/usr/bin/credential_proc']) +# ec2 = Aws::EC2::Client.new(credentials: credentials) # -# credentials = Aws::ProcessCredentials.new('/usr/bin/credential_proc') +# Arguments should be provided as strings in the array, for example: +# +# process = ['/usr/bin/credential_proc', 'arg1', 'arg2'] +# credentials = Aws::ProcessCredentials.new(process) # ec2 = Aws::EC2::Client.new(credentials: credentials) # # Automatically handles refreshing credentials if an Expiration time is @@ -6235,7 +6964,7 @@ end # # @see https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#sourcing-credentials-from-external-processes # -# source://aws-sdk-core//lib/aws-sdk-core/process_credentials.rb#14 +# source://aws-sdk-core//lib/aws-sdk-core/process_credentials.rb#20 class Aws::ProcessCredentials include ::Aws::CredentialProvider include ::Aws::RefreshingCredentials @@ -6243,79 +6972,117 @@ class Aws::ProcessCredentials # Creates a new ProcessCredentials object, which allows an # external process to be used as a credential provider. # - # credentials provider. - # - # @param process [String] Invocation string for process + # @param process [Array, String] An array of strings including + # the process name and its arguments to execute, or a single string to be + # executed by the shell (deprecated and insecure). # @return [ProcessCredentials] a new instance of ProcessCredentials # - # source://aws-sdk-core//lib/aws-sdk-core/process_credentials.rb#24 + # source://aws-sdk-core//lib/aws-sdk-core/process_credentials.rb#31 def initialize(process); end private # @raise [Errors::InvalidProcessCredentialsPayload] # - # source://aws-sdk-core//lib/aws-sdk-core/process_credentials.rb#58 + # source://aws-sdk-core//lib/aws-sdk-core/process_credentials.rb#73 def _parse_payload_format_v1(creds_json); end - # source://aws-sdk-core//lib/aws-sdk-core/process_credentials.rb#33 - def credentials_from_process(proc_invocation); end + # @raise [Errors::InvalidProcessCredentialsPayload] + # + # source://aws-sdk-core//lib/aws-sdk-core/process_credentials.rb#45 + def credentials_from_process; end # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/process_credentials.rb#74 + # source://aws-sdk-core//lib/aws-sdk-core/process_credentials.rb#92 def near_expiration?(expiration_length); end - # source://aws-sdk-core//lib/aws-sdk-core/process_credentials.rb#70 + # source://aws-sdk-core//lib/aws-sdk-core/process_credentials.rb#88 def refresh; end end # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/query/ec2_param_builder.rb#6 +# source://aws-sdk-core//lib/aws-sdk-core/query/handler.rb#5 module Aws::Query; end +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-core/query/ec2_handler.rb#6 +class Aws::Query::EC2Handler < ::Aws::Query::Handler + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/query/ec2_handler.rb#8 + def apply_params(param_list, params, rules); end + + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/query/ec2_handler.rb#12 + def parse_xml(context); end +end + +# @api private +# # source://aws-sdk-core//lib/aws-sdk-core/query/ec2_param_builder.rb#7 class Aws::Query::EC2ParamBuilder include ::Seahorse::Model::Shapes + # @api private # @return [EC2ParamBuilder] a new instance of EC2ParamBuilder # # source://aws-sdk-core//lib/aws-sdk-core/query/ec2_param_builder.rb#11 def initialize(param_list); end + # @api private + # # source://aws-sdk-core//lib/aws-sdk-core/query/ec2_param_builder.rb#17 def apply(ref, params); end - # Returns the value of attribute params. + # @api private # # source://aws-sdk-core//lib/aws-sdk-core/query/ec2_param_builder.rb#15 def params; end private - # source://aws-sdk-core//lib/aws-sdk-core/query/ec2_param_builder.rb#68 + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/query/ec2_param_builder.rb#66 def blob(value); end - # source://aws-sdk-core//lib/aws-sdk-core/query/ec2_param_builder.rb#44 + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/query/ec2_param_builder.rb#42 def format(ref, value, prefix); end + # @api private + # # source://aws-sdk-core//lib/aws-sdk-core/query/ec2_param_builder.rb#33 def list(ref, values, prefix); end - # source://aws-sdk-core//lib/aws-sdk-core/query/ec2_param_builder.rb#56 + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/query/ec2_param_builder.rb#54 def query_name(ref); end - # source://aws-sdk-core//lib/aws-sdk-core/query/ec2_param_builder.rb#60 + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/query/ec2_param_builder.rb#58 def set(name, value); end + # @api private + # # source://aws-sdk-core//lib/aws-sdk-core/query/ec2_param_builder.rb#23 def structure(ref, values, prefix); end - # source://aws-sdk-core//lib/aws-sdk-core/query/ec2_param_builder.rb#73 + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/query/ec2_param_builder.rb#71 def timestamp(ref, value); end - # source://aws-sdk-core//lib/aws-sdk-core/query/ec2_param_builder.rb#64 + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/query/ec2_param_builder.rb#62 def ucfirst(str); end end @@ -6673,17 +7440,17 @@ end # # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/refreshing_credentials.rb#18 +# source://aws-sdk-core//lib/aws-sdk-core/refreshing_credentials.rb#16 module Aws::RefreshingCredentials # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/refreshing_credentials.rb#25 + # source://aws-sdk-core//lib/aws-sdk-core/refreshing_credentials.rb#23 def initialize(options = T.unsafe(nil)); end # @api private # @return [Credentials] # - # source://aws-sdk-core//lib/aws-sdk-core/refreshing_credentials.rb#34 + # source://aws-sdk-core//lib/aws-sdk-core/refreshing_credentials.rb#32 def credentials; end # Refresh credentials. @@ -6691,16 +7458,21 @@ module Aws::RefreshingCredentials # @api private # @return [void] # - # source://aws-sdk-core//lib/aws-sdk-core/refreshing_credentials.rb#41 + # source://aws-sdk-core//lib/aws-sdk-core/refreshing_credentials.rb#39 def refresh!; end private # @api private - # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/refreshing_credentials.rb#80 - def near_expiration?(expiration_length); end + # source://aws-sdk-core//lib/aws-sdk-core/refreshing_credentials.rb#53 + def async_expiration_length; end + + # @api private + # @return [Boolean] + # + # source://aws-sdk-core//lib/aws-sdk-core/refreshing_credentials.rb#86 + def near_expiration?(expiration_length); end # Refreshes credentials asynchronously and synchronously. # If we are near to expiration, block while getting new credentials. @@ -6709,27 +7481,32 @@ module Aws::RefreshingCredentials # # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/refreshing_credentials.rb#55 + # source://aws-sdk-core//lib/aws-sdk-core/refreshing_credentials.rb#61 def refresh_if_near_expiration!; end + + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/refreshing_credentials.rb#49 + def sync_expiration_length; end end # 10 minutes # # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/refreshing_credentials.rb#21 +# source://aws-sdk-core//lib/aws-sdk-core/refreshing_credentials.rb#19 Aws::RefreshingCredentials::ASYNC_EXPIRATION_LENGTH = T.let(T.unsafe(nil), Integer) # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/refreshing_credentials.rb#23 +# source://aws-sdk-core//lib/aws-sdk-core/refreshing_credentials.rb#21 Aws::RefreshingCredentials::CLIENT_EXCLUDE_OPTIONS = T.let(T.unsafe(nil), Set) # 5 minutes # # @api private # -# source://aws-sdk-core//lib/aws-sdk-core/refreshing_credentials.rb#20 +# source://aws-sdk-core//lib/aws-sdk-core/refreshing_credentials.rb#18 Aws::RefreshingCredentials::SYNC_EXPIRATION_LENGTH = T.let(T.unsafe(nil), Integer) # Module/mixin used by token provider classes that can be refreshed. This @@ -6868,6 +7645,33 @@ end # source://aws-sdk-core//lib/aws-sdk-core/rest/handler.rb#5 module Aws::Rest; end +# NOTE: headers could be already populated if specified on input shape +# +# source://aws-sdk-core//lib/aws-sdk-core/rest/content_type_handler.rb#6 +class Aws::Rest::ContentTypeHandler < ::Seahorse::Client::Handler + # source://aws-sdk-core//lib/aws-sdk-core/rest/content_type_handler.rb#7 + def call(context); end + + private + + # content-type defaults as noted here: + # rest-json: https://smithy.io/2.0/aws/protocols/aws-restxml-protocol.html#content-type + # rest-xml: https://smithy.io/2.0/aws/protocols/aws-restxml-protocol.html#content-type + # + # source://aws-sdk-core//lib/aws-sdk-core/rest/content_type_handler.rb#46 + def apply_default_content_type(context); end + + # @return [Boolean] + # + # source://aws-sdk-core//lib/aws-sdk-core/rest/content_type_handler.rb#36 + def eventstream?(context); end + + # @return [Boolean] + # + # source://aws-sdk-core//lib/aws-sdk-core/rest/content_type_handler.rb#32 + def non_empty_body?(body); end +end + # @api private # # source://aws-sdk-core//lib/aws-sdk-core/rest/handler.rb#6 @@ -6881,7 +7685,7 @@ class Aws::Rest::Handler < ::Seahorse::Client::Handler # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/rest/handler.rb#18 + # source://aws-sdk-core//lib/aws-sdk-core/rest/handler.rb#17 def apply_request_id(context); end end @@ -6915,33 +7719,50 @@ class Aws::Rest::Request::Body # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/rest/request/body.rb#66 + # source://aws-sdk-core//lib/aws-sdk-core/rest/request/body.rb#93 def body_params(params); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/rest/request/body.rb#43 + # source://aws-sdk-core//lib/aws-sdk-core/rest/request/body.rb#46 def build_body(params); end + # @api private + # @return [Boolean] + # + # source://aws-sdk-core//lib/aws-sdk-core/rest/request/body.rb#85 + def json_builder?; end + # operation is modeled for body when it is modeled for a payload # either with payload trait or normal members. # # @api private # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/rest/request/body.rb#34 + # source://aws-sdk-core//lib/aws-sdk-core/rest/request/body.rb#37 def modeled_body?; end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/rest/request/body.rb#62 - def serialize(rules, params); end + # source://aws-sdk-core//lib/aws-sdk-core/rest/request/body.rb#69 + def payload_location_name; end + + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/rest/request/body.rb#89 + def serialize(rules, params, location_name: T.unsafe(nil)); end # @api private # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/rest/request/body.rb#55 + # source://aws-sdk-core//lib/aws-sdk-core/rest/request/body.rb#74 def streaming?; end + + # @api private + # @return [Boolean] + # + # source://aws-sdk-core//lib/aws-sdk-core/rest/request/body.rb#81 + def xml_builder?; end end # @api private @@ -7010,24 +7831,29 @@ class Aws::Rest::Request::Endpoint # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/rest/request/endpoint.rb#57 + # source://aws-sdk-core//lib/aws-sdk-core/rest/request/endpoint.rb#77 def apply_querystring_params(uri, params); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/rest/request/endpoint.rb#71 + # source://aws-sdk-core//lib/aws-sdk-core/rest/request/endpoint.rb#91 def escape(string); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/rest/request/endpoint.rb#51 + # source://aws-sdk-core//lib/aws-sdk-core/rest/request/endpoint.rb#61 def param_name(placeholder); end # @api private # @raise [ArgumentError] # - # source://aws-sdk-core//lib/aws-sdk-core/rest/request/endpoint.rb#39 + # source://aws-sdk-core//lib/aws-sdk-core/rest/request/endpoint.rb#41 def param_value_for_placeholder(placeholder, params); end + + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/rest/request/endpoint.rb#67 + def timestamp(ref, value); end end # @api private @@ -7054,12 +7880,12 @@ class Aws::Rest::Request::Headers # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/rest/request/headers.rb#60 + # source://aws-sdk-core//lib/aws-sdk-core/rest/request/headers.rb#68 def apply_header_map(headers, ref, values); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/rest/request/headers.rb#33 + # source://aws-sdk-core//lib/aws-sdk-core/rest/request/headers.rb#34 def apply_header_value(headers, ref, value); end # With complex headers value in json syntax, @@ -7068,17 +7894,17 @@ class Aws::Rest::Request::Headers # # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/rest/request/headers.rb#70 + # source://aws-sdk-core//lib/aws-sdk-core/rest/request/headers.rb#78 def apply_json_trait(value); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/rest/request/headers.rb#52 - def list(headers, ref, value); end + # source://aws-sdk-core//lib/aws-sdk-core/rest/request/headers.rb#53 + def list(headers, ref, values); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/rest/request/headers.rb#42 + # source://aws-sdk-core//lib/aws-sdk-core/rest/request/headers.rb#43 def timestamp(ref, value); end end @@ -7104,35 +7930,50 @@ class Aws::Rest::Request::QuerystringBuilder # model shape references and request parameter value pairs. # @return [String] Returns a built querystring # - # source://aws-sdk-core//lib/aws-sdk-core/rest/request/querystring_builder.rb#25 + # source://aws-sdk-core//lib/aws-sdk-core/rest/request/querystring_builder.rb#32 def build(params); end private # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/rest/request/querystring_builder.rb#33 - def build_part(shape_ref, param_value); end + # source://aws-sdk-core//lib/aws-sdk-core/rest/request/querystring_builder.rb#50 + def build_part(shape_ref, param_value, query_keys); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/rest/request/querystring_builder.rb#98 + # source://aws-sdk-core//lib/aws-sdk-core/rest/request/querystring_builder.rb#125 def escape(string); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/rest/request/querystring_builder.rb#92 - def list_of_strings(name, values); end + # source://aws-sdk-core//lib/aws-sdk-core/rest/request/querystring_builder.rb#85 + def generate_query_list(ref, values); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/rest/request/querystring_builder.rb#74 - def query_map_of_string(hash); end + # source://aws-sdk-core//lib/aws-sdk-core/rest/request/querystring_builder.rb#93 + def generate_query_map(ref, value, query_keys); end + + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/rest/request/querystring_builder.rb#42 + def query_keys(params); end + + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/rest/request/querystring_builder.rb#105 + def query_map_of_string(hash, query_keys); end + + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/rest/request/querystring_builder.rb#114 + def query_map_of_string_list(hash, query_keys); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/rest/request/querystring_builder.rb#82 - def query_map_of_string_list(hash); end + # source://aws-sdk-core//lib/aws-sdk-core/rest/request/querystring_builder.rb#74 + def query_value(ref, value); end # @api private # @@ -7140,6 +7981,11 @@ class Aws::Rest::Request::QuerystringBuilder def timestamp(ref, value); end end +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-core/rest/request/querystring_builder.rb#9 +Aws::Rest::Request::QuerystringBuilder::SUPPORTED_TYPES = T.let(T.unsafe(nil), Array) + # @api private # # source://aws-sdk-core//lib/aws-sdk-core/rest/response/body.rb#5 @@ -7171,1582 +8017,318 @@ class Aws::Rest::Response::Body # @api private # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/rest/response/body.rb#33 - def event_stream?; end - - # @api private - # - # source://aws-sdk-core//lib/aws-sdk-core/rest/response/body.rb#44 - def parse(body, rules, target = T.unsafe(nil)); end - - # @api private - # - # source://aws-sdk-core//lib/aws-sdk-core/rest/response/body.rb#48 - def parse_eventstream(body); end + # source://aws-sdk-core//lib/aws-sdk-core/rest/response/body.rb#34 + def empty_blob_payload?(body); end # @api private # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/rest/response/body.rb#37 - def streaming?; end -end - -# @api private -# -# source://aws-sdk-core//lib/aws-sdk-core/rest/response/headers.rb#9 -class Aws::Rest::Response::Headers - include ::Seahorse::Model::Shapes - - # @api private - # @param rules [Seahorse::Model::ShapeRef] - # @return [Headers] a new instance of Headers - # - # source://aws-sdk-core//lib/aws-sdk-core/rest/response/headers.rb#14 - def initialize(rules); end - - # @api private - # @param http_resp [Seahorse::Client::Http::Response] - # @param target [Hash, Struct] - # - # source://aws-sdk-core//lib/aws-sdk-core/rest/response/headers.rb#20 - def apply(http_resp, target); end - - # @api private - # - # source://aws-sdk-core//lib/aws-sdk-core/rest/response/headers.rb#36 - def cast_value(ref, value); end - - # @api private - # - # source://aws-sdk-core//lib/aws-sdk-core/rest/response/headers.rb#61 - def extract_header_map(headers, name, ref, data); end - - # @api private - # - # source://aws-sdk-core//lib/aws-sdk-core/rest/response/headers.rb#30 - def extract_header_value(headers, name, ref, data); end - - # @api private - # - # source://aws-sdk-core//lib/aws-sdk-core/rest/response/headers.rb#71 - def extract_json_trait(value); end -end - -# @api private -# -# source://aws-sdk-core//lib/aws-sdk-core/rest/response/parser.rb#6 -class Aws::Rest::Response::Parser - # @api private - # - # source://aws-sdk-core//lib/aws-sdk-core/rest/response/parser.rb#8 - def apply(response); end - - private - - # @api private - # - # source://aws-sdk-core//lib/aws-sdk-core/rest/response/parser.rb#32 - def extract_body(rules, response); end + # source://aws-sdk-core//lib/aws-sdk-core/rest/response/body.rb#43 + def empty_body?(body); end # @api private + # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/rest/response/parser.rb#27 - def extract_headers(rules, response); end + # source://aws-sdk-core//lib/aws-sdk-core/rest/response/body.rb#47 + def event_stream?; end # @api private + # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/rest/response/parser.rb#22 - def extract_status_code(rules, response); end + # source://aws-sdk-core//lib/aws-sdk-core/rest/response/body.rb#38 + def non_streaming_blob_payload?; end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/rest/response/parser.rb#40 - def parser_class(response); end -end + # source://aws-sdk-core//lib/aws-sdk-core/rest/response/body.rb#58 + def parse(body, rules, target = T.unsafe(nil)); end -# @api private -# -# source://aws-sdk-core//lib/aws-sdk-core/rest/response/status_code.rb#6 -class Aws::Rest::Response::StatusCode # @api private - # @param rules [Seahorse::Model::Shapes::ShapeRef] - # @return [StatusCode] a new instance of StatusCode # - # source://aws-sdk-core//lib/aws-sdk-core/rest/response/status_code.rb#9 - def initialize(rules); end + # source://aws-sdk-core//lib/aws-sdk-core/rest/response/body.rb#62 + def parse_eventstream(body); end # @api private - # @param http_resp [Seahorse::Client::Http::Response] - # @param data [Hash, Struct] + # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/rest/response/status_code.rb#15 - def apply(http_resp, data); end -end - -module Aws::S3; end - -class Aws::S3::Bucket - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#22 - def initialize(*args); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#695 - def acl; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/customizations/bucket.rb#15 - def clear!; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#47 - def client; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#703 - def cors; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#282 - def create(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#40 - def creation_date; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#62 - def data; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#70 - def data_loaded?; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#301 - def delete(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/customizations/bucket.rb#35 - def delete!(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#372 - def delete_objects(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#1024 - def deprecated_identifiers; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#77 - def exists?(options = T.unsafe(nil)); end - - # source://aws-sdk-core//lib/aws-sdk-core/deprecations.rb#65 - def identifiers(*args, &block); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#711 - def lifecycle; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#719 - def lifecycle_configuration; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/customizations/bucket.rb#136 - def load; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#727 - def logging; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#801 - def multipart_uploads(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#33 - def name; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#825 - def notification; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#834 - def object(key); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#898 - def object_versions(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#960 - def objects(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#983 - def policy; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/customizations/bucket.rb#126 - def presigned_post(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#680 - def put_object(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#53 - def reload; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#991 - def request_payment; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#999 - def tagging; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/customizations/bucket.rb#88 - def url(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#1007 - def versioning; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#206 - def wait_until(options = T.unsafe(nil), &block); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#94 - def wait_until_exists(options = T.unsafe(nil), &block); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#113 - def wait_until_not_exists(options = T.unsafe(nil), &block); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#1015 - def website; end - - private - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#1031 - def extract_name(args, options); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#1052 - def separate_params_and_options(options); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket.rb#1042 - def yield_waiter_and_warn(waiter, &block); end -end - -class Aws::S3::BucketAcl - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_acl.rb#22 - def initialize(*args); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_acl.rb#281 - def bucket; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_acl.rb#33 - def bucket_name; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_acl.rb#52 - def client; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_acl.rb#74 - def data; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_acl.rb#82 - def data_loaded?; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_acl.rb#290 - def deprecated_identifiers; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_acl.rb#45 - def grants; end - - # source://aws-sdk-core//lib/aws-sdk-core/deprecations.rb#65 - def identifiers(*args, &block); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_acl.rb#62 - def load; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_acl.rb#39 - def owner; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_acl.rb#270 - def put(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_acl.rb#62 - def reload; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_acl.rb#166 - def wait_until(options = T.unsafe(nil), &block); end - - private - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_acl.rb#297 - def extract_bucket_name(args, options); end -end - -class Aws::S3::BucketCors - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_cors.rb#22 - def initialize(*args); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_cors.rb#272 - def bucket; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_cors.rb#33 - def bucket_name; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_cors.rb#47 - def client; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_cors.rb#40 - def cors_rules; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_cors.rb#69 - def data; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_cors.rb#77 - def data_loaded?; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_cors.rb#193 - def delete(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_cors.rb#281 - def deprecated_identifiers; end - - # source://aws-sdk-core//lib/aws-sdk-core/deprecations.rb#65 - def identifiers(*args, &block); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_cors.rb#57 - def load; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_cors.rb#261 - def put(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_cors.rb#57 - def reload; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_cors.rb#161 - def wait_until(options = T.unsafe(nil), &block); end - - private - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_cors.rb#288 - def extract_bucket_name(args, options); end + # source://aws-sdk-core//lib/aws-sdk-core/rest/response/body.rb#51 + def streaming?; end end -class Aws::S3::BucketLifecycle - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_lifecycle.rb#22 - def initialize(*args); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_lifecycle.rb#275 - def bucket; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_lifecycle.rb#33 - def bucket_name; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_lifecycle.rb#46 - def client; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_lifecycle.rb#68 - def data; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_lifecycle.rb#76 - def data_loaded?; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_lifecycle.rb#192 - def delete(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_lifecycle.rb#284 - def deprecated_identifiers; end - - # source://aws-sdk-core//lib/aws-sdk-core/deprecations.rb#65 - def identifiers(*args, &block); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_lifecycle.rb#56 - def load; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_lifecycle.rb#264 - def put(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_lifecycle.rb#56 - def reload; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_lifecycle.rb#39 - def rules; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_lifecycle.rb#160 - def wait_until(options = T.unsafe(nil), &block); end - - private - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_lifecycle.rb#291 - def extract_bucket_name(args, options); end -end - -class Aws::S3::BucketLifecycleConfiguration - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb#22 - def initialize(*args); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb#295 - def bucket; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb#33 - def bucket_name; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb#46 - def client; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb#68 - def data; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb#76 - def data_loaded?; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb#192 - def delete(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb#304 - def deprecated_identifiers; end - - # source://aws-sdk-core//lib/aws-sdk-core/deprecations.rb#65 - def identifiers(*args, &block); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb#56 - def load; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb#284 - def put(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb#56 - def reload; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb#39 - def rules; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb#160 - def wait_until(options = T.unsafe(nil), &block); end - - private - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_lifecycle_configuration.rb#311 - def extract_bucket_name(args, options); end -end - -class Aws::S3::BucketLogging - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_logging.rb#22 - def initialize(*args); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_logging.rb#252 - def bucket; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_logging.rb#33 - def bucket_name; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_logging.rb#52 - def client; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_logging.rb#74 - def data; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_logging.rb#82 - def data_loaded?; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_logging.rb#261 - def deprecated_identifiers; end - - # source://aws-sdk-core//lib/aws-sdk-core/deprecations.rb#65 - def identifiers(*args, &block); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_logging.rb#62 - def load; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_logging.rb#45 - def logging_enabled; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_logging.rb#241 - def put(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_logging.rb#62 - def reload; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_logging.rb#166 - def wait_until(options = T.unsafe(nil), &block); end - - private - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_logging.rb#268 - def extract_bucket_name(args, options); end -end - -class Aws::S3::BucketNotification - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_notification.rb#22 - def initialize(*args); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_notification.rb#287 - def bucket; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_notification.rb#33 - def bucket_name; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_notification.rb#67 - def client; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_notification.rb#89 - def data; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_notification.rb#97 - def data_loaded?; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_notification.rb#296 - def deprecated_identifiers; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_notification.rb#60 - def event_bridge_configuration; end - - # source://aws-sdk-core//lib/aws-sdk-core/deprecations.rb#65 - def identifiers(*args, &block); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_notification.rb#54 - def lambda_function_configurations; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_notification.rb#77 - def load; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_notification.rb#276 - def put(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_notification.rb#47 - def queue_configurations; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_notification.rb#77 - def reload; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_notification.rb#40 - def topic_configurations; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_notification.rb#181 - def wait_until(options = T.unsafe(nil), &block); end - - private - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_notification.rb#303 - def extract_bucket_name(args, options); end -end - -class Aws::S3::BucketPolicy - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_policy.rb#22 - def initialize(*args); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_policy.rb#252 - def bucket; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_policy.rb#33 - def bucket_name; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_policy.rb#46 - def client; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_policy.rb#68 - def data; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_policy.rb#76 - def data_loaded?; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_policy.rb#192 - def delete(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_policy.rb#261 - def deprecated_identifiers; end - - # source://aws-sdk-core//lib/aws-sdk-core/deprecations.rb#65 - def identifiers(*args, &block); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_policy.rb#56 - def load; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_policy.rb#39 - def policy; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_policy.rb#241 - def put(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_policy.rb#56 - def reload; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_policy.rb#160 - def wait_until(options = T.unsafe(nil), &block); end - - private - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_policy.rb#268 - def extract_bucket_name(args, options); end -end - -class Aws::S3::BucketRequestPayment - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_request_payment.rb#22 - def initialize(*args); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_request_payment.rb#237 - def bucket; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_request_payment.rb#33 - def bucket_name; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_request_payment.rb#46 - def client; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_request_payment.rb#68 - def data; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_request_payment.rb#76 - def data_loaded?; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_request_payment.rb#246 - def deprecated_identifiers; end - - # source://aws-sdk-core//lib/aws-sdk-core/deprecations.rb#65 - def identifiers(*args, &block); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_request_payment.rb#56 - def load; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_request_payment.rb#39 - def payer; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_request_payment.rb#226 - def put(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_request_payment.rb#56 - def reload; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_request_payment.rb#160 - def wait_until(options = T.unsafe(nil), &block); end - - private - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_request_payment.rb#253 - def extract_bucket_name(args, options); end -end - -class Aws::S3::BucketTagging - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_tagging.rb#22 - def initialize(*args); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_tagging.rb#261 - def bucket; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_tagging.rb#33 - def bucket_name; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_tagging.rb#46 - def client; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_tagging.rb#68 - def data; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_tagging.rb#76 - def data_loaded?; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_tagging.rb#192 - def delete(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_tagging.rb#270 - def deprecated_identifiers; end - - # source://aws-sdk-core//lib/aws-sdk-core/deprecations.rb#65 - def identifiers(*args, &block); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_tagging.rb#56 - def load; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_tagging.rb#250 - def put(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_tagging.rb#56 - def reload; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_tagging.rb#39 - def tag_set; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_tagging.rb#160 - def wait_until(options = T.unsafe(nil), &block); end - - private - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_tagging.rb#277 - def extract_bucket_name(args, options); end -end - -class Aws::S3::BucketVersioning - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_versioning.rb#22 - def initialize(*args); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_versioning.rb#368 - def bucket; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_versioning.rb#33 - def bucket_name; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_versioning.rb#55 - def client; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_versioning.rb#77 - def data; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_versioning.rb#85 - def data_loaded?; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_versioning.rb#377 - def deprecated_identifiers; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_versioning.rb#235 - def enable(options = T.unsafe(nil)); end - - # source://aws-sdk-core//lib/aws-sdk-core/deprecations.rb#65 - def identifiers(*args, &block); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_versioning.rb#65 - def load; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_versioning.rb#48 - def mfa_delete; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_versioning.rb#299 - def put(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_versioning.rb#65 - def reload; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_versioning.rb#39 - def status; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_versioning.rb#352 - def suspend(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_versioning.rb#169 - def wait_until(options = T.unsafe(nil), &block); end - - private - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_versioning.rb#384 - def extract_bucket_name(args, options); end -end - -class Aws::S3::BucketWebsite - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_website.rb#22 - def initialize(*args); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_website.rb#302 - def bucket; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_website.rb#33 - def bucket_name; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_website.rb#68 - def client; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_website.rb#90 - def data; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_website.rb#98 - def data_loaded?; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_website.rb#214 - def delete(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_website.rb#311 - def deprecated_identifiers; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_website.rb#54 - def error_document; end - - # source://aws-sdk-core//lib/aws-sdk-core/deprecations.rb#65 - def identifiers(*args, &block); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_website.rb#47 - def index_document; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_website.rb#78 - def load; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_website.rb#291 - def put(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_website.rb#40 - def redirect_all_requests_to; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_website.rb#78 - def reload; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_website.rb#61 - def routing_rules; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_website.rb#182 - def wait_until(options = T.unsafe(nil), &block); end - - private - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/bucket_website.rb#318 - def extract_bucket_name(args, options); end -end - -module Aws::S3::Encryption; end - -class Aws::S3::Encryption::Client - # source://aws-sdk-core//lib/aws-sdk-core/deprecations.rb#65 - def initialize(*args, &block); end - - # source://forwardable/1.3.3/forwardable.rb#231 - def build_request(*args, **_arg1, &block); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/encryption/client.rb#245 - def client; end - - # source://forwardable/1.3.3/forwardable.rb#231 - def config(*args, **_arg1, &block); end - - # source://forwardable/1.3.3/forwardable.rb#231 - def delete_object(*args, **_arg1, &block); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/encryption/client.rb#252 - def envelope_location; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/encryption/client.rb#291 - def get_object(params = T.unsafe(nil), &block); end - - # source://forwardable/1.3.3/forwardable.rb#231 - def head_object(*args, **_arg1, &block); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/encryption/client.rb#257 - def instruction_file_suffix; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/encryption/client.rb#249 - def key_provider; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/encryption/client.rb#265 - def put_object(params = T.unsafe(nil)); end - - private - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/encryption/client.rb#332 - def cipher_provider(options); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/encryption/client.rb#230 - def deprecated_initialize(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/encryption/client.rb#356 - def envelope_options(params); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/encryption/client.rb#310 - def extract_client(options); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/encryption/client.rb#345 - def extract_key_provider(options); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/encryption/client.rb#366 - def extract_location(options); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/encryption/client.rb#377 - def extract_suffix(options); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/encryption/client.rb#323 - def kms_client(options); end -end - -class Aws::S3::MultipartUpload - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload.rb#26 - def initialize(*args); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload.rb#249 - def abort(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload.rb#371 - def basic_complete(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload.rb#39 - def bucket_name; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload.rb#92 - def checksum_algorithm; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload.rb#99 - def client; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/customizations/multipart_upload.rb#27 - def complete(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload.rb#114 - def data; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload.rb#122 - def data_loaded?; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload.rb#492 - def deprecated_identifiers; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload.rb#49 - def id; end - - # source://aws-sdk-core//lib/aws-sdk-core/deprecations.rb#65 - def identifiers(*args, &block); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload.rb#67 - def initiated; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload.rb#86 - def initiator; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload.rb#61 - def key; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload.rb#105 - def load; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload.rb#390 - def object; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload.rb#44 - def object_key; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload.rb#80 - def owner; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload.rb#400 - def part(part_number); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload.rb#462 - def parts(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload.rb#105 - def reload; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload.rb#73 - def storage_class; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload.rb#55 - def upload_id; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload.rb#206 - def wait_until(options = T.unsafe(nil), &block); end - - private - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/customizations/multipart_upload.rb#36 - def compute_parts; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload.rb#503 - def extract_bucket_name(args, options); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload.rb#525 - def extract_id(args, options); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload.rb#514 - def extract_object_key(args, options); end -end - -class Aws::S3::MultipartUploadPart - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload_part.rb#28 - def initialize(*args); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload_part.rb#42 - def bucket_name; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload_part.rb#89 - def checksum_crc32; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload_part.rb#103 - def checksum_crc32c; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload_part.rb#117 - def checksum_sha1; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload_part.rb#131 - def checksum_sha256; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload_part.rb#138 - def client; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload_part.rb#393 - def copy_from(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload_part.rb#153 - def data; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload_part.rb#161 - def data_loaded?; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload_part.rb#548 - def deprecated_identifiers; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload_part.rb#69 - def etag; end - - # source://aws-sdk-core//lib/aws-sdk-core/deprecations.rb#65 - def identifiers(*args, &block); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload_part.rb#63 - def last_modified; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload_part.rb#144 - def load; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload_part.rb#537 - def multipart_upload; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload_part.rb#52 - def multipart_upload_id; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload_part.rb#47 - def object_key; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload_part.rb#57 - def part_number; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload_part.rb#144 - def reload; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload_part.rb#75 - def size; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload_part.rb#521 - def upload(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload_part.rb#245 - def wait_until(options = T.unsafe(nil), &block); end - - private - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload_part.rb#560 - def extract_bucket_name(args, options); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload_part.rb#582 - def extract_multipart_upload_id(args, options); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload_part.rb#571 - def extract_object_key(args, options); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/multipart_upload_part.rb#593 - def extract_part_number(args, options); end -end - -class Aws::S3::Object - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#24 - def initialize(*args); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#55 - def accept_ranges; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#1722 - def acl; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#96 - def archive_status; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#1731 - def bucket; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#283 - def bucket_key_enabled; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#36 - def bucket_name; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#193 - def cache_control; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#122 - def checksum_crc32; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#136 - def checksum_crc32c; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#150 - def checksum_sha1; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#164 - def checksum_sha256; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#399 - def client; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#199 - def content_disposition; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#207 - def content_encoding; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#213 - def content_language; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#108 - def content_length; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#219 - def content_type; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/customizations/object.rb#78 - def copy_from(source, options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/customizations/object.rb#121 - def copy_to(target, options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#424 - def data; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#432 - def data_loaded?; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#891 - def delete(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#49 - def delete_marker; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#1762 - def deprecated_identifiers; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/customizations/object.rb#510 - def download_file(destination, options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#171 - def etag; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#439 - def exists?(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#64 - def expiration; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#225 - def expires; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#230 - def expires_string; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#1000 - def get(options = T.unsafe(nil), &block); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#1708 - def head(options = T.unsafe(nil)); end - - # source://aws-sdk-core//lib/aws-sdk-core/deprecations.rb#65 - def identifiers(*args, &block); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#1172 - def initiate_multipart_upload(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#41 - def key; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#102 - def last_modified; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#409 - def load; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#251 - def metadata; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#181 - def missing_meta; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/customizations/object.rb#135 - def move_to(target, options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#1740 - def multipart_upload(id); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#392 - def object_lock_legal_hold_status; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#370 - def object_lock_mode; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#378 - def object_lock_retain_until_date; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#357 - def parts_count; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/customizations/object.rb#149 - def presigned_post(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/customizations/object.rb#293 - def presigned_request(method, params = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/customizations/object.rb#220 - def presigned_url(method, params = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/customizations/object.rb#328 - def public_url(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#1485 - def put(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#409 - def reload; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#349 - def replication_status; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#304 - def request_charged; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#90 - def restore; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#1620 - def restore_object(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#245 - def server_side_encryption; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#108 - def size; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#259 - def sse_customer_algorithm; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#268 - def sse_customer_key_md5; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#276 - def ssekms_key_id; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#297 - def storage_class; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/customizations/object.rb#451 - def upload_file(source, options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/customizations/object.rb#378 - def upload_stream(options = T.unsafe(nil), &block); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#1751 - def version(id); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#187 - def version_id; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#572 - def wait_until(options = T.unsafe(nil), &block); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#456 - def wait_until_exists(options = T.unsafe(nil), &block); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#477 - def wait_until_not_exists(options = T.unsafe(nil), &block); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#238 - def website_redirect_location; end - - private - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#1772 - def extract_bucket_name(args, options); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#1783 - def extract_key(args, options); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#1804 - def separate_params_and_options(options); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#1794 - def yield_waiter_and_warn(waiter, &block); end -end - -class Aws::S3::Object::Collection < ::Aws::Resources::Collection - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#1877 - def batch_delete!(options = T.unsafe(nil)); end - - # source://aws-sdk-core//lib/aws-sdk-core/deprecations.rb#65 - def delete(*args, &block); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object.rb#1877 - def deprecated_delete(options = T.unsafe(nil)); end -end - -class Aws::S3::ObjectAcl - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_acl.rb#24 - def initialize(*args); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_acl.rb#36 - def bucket_name; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_acl.rb#67 - def client; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_acl.rb#92 - def data; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_acl.rb#100 - def data_loaded?; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_acl.rb#340 - def deprecated_identifiers; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_acl.rb#53 - def grants; end - - # source://aws-sdk-core//lib/aws-sdk-core/deprecations.rb#65 - def identifiers(*args, &block); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_acl.rb#77 - def load; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_acl.rb#330 - def object; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_acl.rb#41 - def object_key; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_acl.rb#47 - def owner; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_acl.rb#316 - def put(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_acl.rb#77 - def reload; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_acl.rb#60 - def request_charged; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_acl.rb#184 - def wait_until(options = T.unsafe(nil), &block); end - - private - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_acl.rb#350 - def extract_bucket_name(args, options); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_acl.rb#361 - def extract_object_key(args, options); end -end - -class Aws::S3::ObjectSummary - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#24 - def initialize(*args); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#1343 - def acl; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#1352 - def bucket; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#36 - def bucket_name; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#79 - def checksum_algorithm; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#118 - def client; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#85 - def content_length; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/customizations/object_summary.rb#16 - def copy_from(source, options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/customizations/object_summary.rb#24 - def copy_to(target, options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#133 - def data; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#141 - def data_loaded?; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#600 - def delete(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#1392 - def deprecated_identifiers; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/customizations/object_summary.rb#79 - def download_file(destination, options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#73 - def etag; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#148 - def exists?(options = T.unsafe(nil)); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#709 - def get(options = T.unsafe(nil), &block); end +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-core/rest/response/header_list_parser.rb#9 +module Aws::Rest::Response::HeaderListParser + class << self + # parse a list of possibly quoted and escaped string values + # Follows: + # # [RFC-7230's specification of header values](https://datatracker.ietf.org/doc/html/rfc7230#section-3.2.6). + # + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/rest/response/header_list_parser.rb#15 + def parse_string_list(value); end - # source://aws-sdk-core//lib/aws-sdk-core/deprecations.rb#65 - def identifiers(*args, &block); end + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/rest/response/header_list_parser.rb#24 + def parse_timestamp_list(value, ref); end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#881 - def initiate_multipart_upload(options = T.unsafe(nil)); end + private - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#41 - def key; end + # @api private + # @raise [ArgumentError] + # + # source://aws-sdk-core//lib/aws-sdk-core/rest/response/header_list_parser.rb#64 + def read_quoted_value(buffer); end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#47 - def last_modified; end + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/rest/response/header_list_parser.rb#57 + def read_unquoted_value(buffer); end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#124 - def load; end + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/rest/response/header_list_parser.rb#39 + def read_value(buffer); end + end +end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/customizations/object_summary.rb#32 - def move_to(target, options = T.unsafe(nil)); end +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-core/rest/response/headers.rb#10 +class Aws::Rest::Response::Headers + include ::Seahorse::Model::Shapes - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#1361 - def multipart_upload(id); end + # @api private + # @param rules [Seahorse::Model::ShapeRef] + # @return [Headers] a new instance of Headers + # + # source://aws-sdk-core//lib/aws-sdk-core/rest/response/headers.rb#15 + def initialize(rules); end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#1371 - def object; end + # @api private + # @param http_resp [Seahorse::Client::Http::Response] + # @param target [Hash, Struct] + # + # source://aws-sdk-core//lib/aws-sdk-core/rest/response/headers.rb#21 + def apply(http_resp, target); end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#97 - def owner; end + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/rest/response/headers.rb#37 + def cast_value(ref, value); end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/customizations/object_summary.rb#40 - def presigned_post(options = T.unsafe(nil)); end + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/rest/response/headers.rb#66 + def extract_header_map(headers, name, ref, data); end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/customizations/object_summary.rb#48 - def presigned_url(http_method, params = T.unsafe(nil)); end + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/rest/response/headers.rb#31 + def extract_header_value(headers, name, ref, data); end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/customizations/object_summary.rb#56 - def public_url(options = T.unsafe(nil)); end + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/rest/response/headers.rb#76 + def extract_json_trait(value); end +end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#1194 - def put(options = T.unsafe(nil)); end +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-core/rest/response/parser.rb#6 +class Aws::Rest::Response::Parser + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/rest/response/parser.rb#8 + def apply(response); end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#124 - def reload; end + private - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#1329 - def restore_object(options = T.unsafe(nil)); end + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/rest/response/parser.rb#32 + def extract_body(rules, response); end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#111 - def restore_status; end + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/rest/response/parser.rb#27 + def extract_headers(rules, response); end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#85 - def size; end + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/rest/response/parser.rb#22 + def extract_status_code(rules, response); end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#91 - def storage_class; end + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-core/rest/response/parser.rb#40 + def parser_class(response); end +end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/customizations/object_summary.rb#64 - def upload_file(source, options = T.unsafe(nil)); end +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-core/rest/response/status_code.rb#6 +class Aws::Rest::Response::StatusCode + # @api private + # @param rules [Seahorse::Model::Shapes::ShapeRef] + # @return [StatusCode] a new instance of StatusCode + # + # source://aws-sdk-core//lib/aws-sdk-core/rest/response/status_code.rb#9 + def initialize(rules); end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/customizations/object_summary.rb#71 - def upload_stream(options = T.unsafe(nil), &block); end + # @api private + # @param http_resp [Seahorse::Client::Http::Response] + # @param data [Hash, Struct] + # + # source://aws-sdk-core//lib/aws-sdk-core/rest/response/status_code.rb#15 + def apply(http_resp, data); end +end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#1381 - def version(id); end +# source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/handler.rb#4 +module Aws::RpcV2; end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#281 - def wait_until(options = T.unsafe(nil), &block); end +# source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/builder.rb#7 +class Aws::RpcV2::Builder + include ::Seahorse::Model::Shapes - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#165 - def wait_until_exists(options = T.unsafe(nil), &block); end + # @return [Builder] a new instance of Builder + # + # source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/builder.rb#10 + def initialize(rules, _options = T.unsafe(nil)); end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#186 - def wait_until_not_exists(options = T.unsafe(nil), &block); end + # source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/builder.rb#14 + def serialize(params); end private - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#1402 - def extract_bucket_name(args, options); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#1413 - def extract_key(args, options); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#1434 - def separate_params_and_options(options); end + # source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/builder.rb#47 + def blob(value); end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#1424 - def yield_waiter_and_warn(waiter, &block); end -end + # source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/builder.rb#51 + def format(ref, value); end -class Aws::S3::ObjectSummary::Collection < ::Aws::Resources::Collection - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#1507 - def batch_delete!(options = T.unsafe(nil)); end + # source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/builder.rb#35 + def list(ref, values); end - # source://aws-sdk-core//lib/aws-sdk-core/deprecations.rb#65 - def delete(*args, &block); end + # source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/builder.rb#40 + def map(ref, values); end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_summary.rb#1507 - def deprecated_delete(options = T.unsafe(nil)); end + # source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/builder.rb#24 + def structure(ref, values); end end -class Aws::S3::ObjectVersion - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_version.rb#26 - def initialize(*args); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_version.rb#39 - def bucket_name; end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_version.rb#61 - def checksum_algorithm; end +# source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/content_type_handler.rb#5 +class Aws::RpcV2::ContentTypeHandler < ::Seahorse::Client::Handler + # source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/content_type_handler.rb#6 + def call(context); end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_version.rb#125 - def client; end + private - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_version.rb#140 - def data; end + # @return [Boolean] + # + # source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/content_type_handler.rb#40 + def empty_input_structure?(context); end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_version.rb#148 - def data_loaded?; end + # @return [Boolean] + # + # source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/content_type_handler.rb#26 + def eventstream_input?(context); end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_version.rb#286 - def delete(options = T.unsafe(nil)); end + # @return [Boolean] + # + # source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/content_type_handler.rb#33 + def eventstream_output?(context); end +end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_version.rb#504 - def deprecated_identifiers; end +# source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/error_handler.rb#5 +class Aws::RpcV2::ErrorHandler < ::Aws::ErrorHandler + # source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/error_handler.rb#7 + def call(context); end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_version.rb#55 - def etag; end + private - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_version.rb#393 - def get(options = T.unsafe(nil), &block); end + # @return [Boolean] + # + # source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/error_handler.rb#70 + def aws_query_error?(context); end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_version.rb#479 - def head(options = T.unsafe(nil)); end + # source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/error_handler.rb#39 + def error_code(data, context); end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_version.rb#49 - def id; end + # source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/error_handler.rb#29 + def extract_error(body, context); end - # source://aws-sdk-core//lib/aws-sdk-core/deprecations.rb#65 - def identifiers(*args, &block); end + # source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/error_handler.rb#54 + def parse_error_data(context, body, code); end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_version.rb#92 - def is_latest; end + # source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/error_handler.rb#75 + def remove_prefix(error_code, context); end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_version.rb#79 - def key; end + # @return [Boolean] + # + # source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/error_handler.rb#23 + def valid_response?(context); end +end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_version.rb#98 - def last_modified; end +# source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/handler.rb#5 +class Aws::RpcV2::Handler < ::Seahorse::Client::Handler + # @param context [Seahorse::Client::RequestContext] + # @return [Seahorse::Client::Response] + # + # source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/handler.rb#8 + def call(context); end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_version.rb#131 - def load; end + private - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_version.rb#494 - def object; end + # source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/handler.rb#65 + def apply_request_id(context); end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_version.rb#44 - def object_key; end + # source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/handler.rb#31 + def build_body(context); end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_version.rb#104 - def owner; end + # source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/handler.rb#18 + def build_request(context); end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_version.rb#131 - def reload; end + # source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/handler.rb#25 + def build_url(context); end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_version.rb#118 - def restore_status; end + # source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/handler.rb#35 + def parse_body(context); end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_version.rb#67 - def size; end + # @return [Boolean] + # + # source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/handler.rb#69 + def query_compatible?(context); end +end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_version.rb#73 - def storage_class; end +# source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/parser.rb#7 +class Aws::RpcV2::Parser + include ::Seahorse::Model::Shapes - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_version.rb#85 - def version_id; end + # @param rules [Seahorse::Model::ShapeRef] + # @return [Parser] a new instance of Parser + # + # source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/parser.rb#11 + def initialize(rules, query_compatible: T.unsafe(nil)); end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_version.rb#232 - def wait_until(options = T.unsafe(nil), &block); end + # source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/parser.rb#16 + def parse(cbor, target = T.unsafe(nil)); end private - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_version.rb#515 - def extract_bucket_name(args, options); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_version.rb#537 - def extract_id(args, options); end - - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_version.rb#526 - def extract_object_key(args, options); end -end + # source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/parser.rb#60 + def list(ref, values, target = T.unsafe(nil)); end -class Aws::S3::ObjectVersion::Collection < ::Aws::Resources::Collection - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_version.rb#604 - def batch_delete!(options = T.unsafe(nil)); end + # source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/parser.rb#68 + def map(ref, values, target = T.unsafe(nil)); end - # source://aws-sdk-core//lib/aws-sdk-core/deprecations.rb#65 - def delete(*args, &block); end + # source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/parser.rb#76 + def parse_ref(ref, value, target = T.unsafe(nil)); end - # source://aws-sdk-s3/1.132.1/lib/aws-sdk-s3/object_version.rb#604 - def deprecated_delete(options = T.unsafe(nil)); end + # source://aws-sdk-core//lib/aws-sdk-core/rpc_v2/parser.rb#24 + def structure(ref, values, target = T.unsafe(nil)); end end # This module provides support for AWS Single Sign-On. This module is available in the @@ -8792,20 +8374,20 @@ module Aws::SSO; end # # See {#initialize} for a full list of supported configuration options. # -# source://aws-sdk-core//lib/aws-sdk-sso/client.rb#52 +# source://aws-sdk-core//lib/aws-sdk-sso/client.rb#53 class Aws::SSO::Client < ::Seahorse::Client::Base include ::Aws::ClientStubs # @overload initialize # @return [Client] a new instance of Client # - # source://aws-sdk-core//lib/aws-sdk-sso/client.rb#385 + # source://aws-sdk-core//lib/aws-sdk-sso/client.rb#422 def initialize(*args); end # @api private # @param params [{}] # - # source://aws-sdk-core//lib/aws-sdk-sso/client.rb#599 + # source://aws-sdk-core//lib/aws-sdk-sso/client.rb#636 def build_request(operation_name, params = T.unsafe(nil)); end # Returns the STS short-term credentials for a given role name that is @@ -8834,7 +8416,7 @@ class Aws::SSO::Client < ::Seahorse::Client::Base # * {Types::GetRoleCredentialsResponse#role_credentials #role_credentials} => Types::RoleCredentials # @see http://docs.aws.amazon.com/goto/WebAPI/sso-2019-06-10/GetRoleCredentials AWS API Documentation # - # source://aws-sdk-core//lib/aws-sdk-sso/client.rb#432 + # source://aws-sdk-core//lib/aws-sdk-sso/client.rb#469 def get_role_credentials(params = T.unsafe(nil), options = T.unsafe(nil)); end # Lists all roles that are assigned to the user for a given AWS account. @@ -8867,7 +8449,7 @@ class Aws::SSO::Client < ::Seahorse::Client::Base # * {Types::ListAccountRolesResponse#role_list #role_list} => Array<Types::RoleInfo> # @see http://docs.aws.amazon.com/goto/WebAPI/sso-2019-06-10/ListAccountRoles AWS API Documentation # - # source://aws-sdk-core//lib/aws-sdk-sso/client.rb#485 + # source://aws-sdk-core//lib/aws-sdk-sso/client.rb#522 def list_account_roles(params = T.unsafe(nil), options = T.unsafe(nil)); end # Lists all AWS accounts assigned to the user. These AWS accounts are @@ -8906,7 +8488,7 @@ class Aws::SSO::Client < ::Seahorse::Client::Base # * {Types::ListAccountsResponse#account_list #account_list} => Array<Types::AccountInfo> # @see http://docs.aws.amazon.com/goto/WebAPI/sso-2019-06-10/ListAccounts AWS API Documentation # - # source://aws-sdk-core//lib/aws-sdk-sso/client.rb#542 + # source://aws-sdk-core//lib/aws-sdk-sso/client.rb#579 def list_accounts(params = T.unsafe(nil), options = T.unsafe(nil)); end # Removes the locally stored SSO tokens from the client-side cache and @@ -8942,24 +8524,24 @@ class Aws::SSO::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/sso-2019-06-10/Logout AWS API Documentation # - # source://aws-sdk-core//lib/aws-sdk-sso/client.rb#590 + # source://aws-sdk-core//lib/aws-sdk-sso/client.rb#627 def logout(params = T.unsafe(nil), options = T.unsafe(nil)); end # @api private # @deprecated # - # source://aws-sdk-core//lib/aws-sdk-sso/client.rb#614 + # source://aws-sdk-core//lib/aws-sdk-sso/client.rb#651 def waiter_names; end class << self # @api private # - # source://aws-sdk-core//lib/aws-sdk-sso/client.rb#624 + # source://aws-sdk-core//lib/aws-sdk-sso/client.rb#661 def errors_module; end # @api private # - # source://aws-sdk-core//lib/aws-sdk-sso/client.rb#621 + # source://aws-sdk-core//lib/aws-sdk-sso/client.rb#658 def identifier; end end end @@ -9343,29 +8925,29 @@ module Aws::SSO::Plugins; end # source://aws-sdk-core//lib/aws-sdk-sso/plugins/endpoints.rb#13 class Aws::SSO::Plugins::Endpoints < ::Seahorse::Client::Plugin - # source://aws-sdk-core//lib/aws-sdk-sso/plugins/endpoints.rb#71 + # source://aws-sdk-core//lib/aws-sdk-sso/plugins/endpoints.rb#73 def add_handlers(handlers, _config); end end # @api private # -# source://aws-sdk-core//lib/aws-sdk-sso/plugins/endpoints.rb#26 +# source://aws-sdk-core//lib/aws-sdk-sso/plugins/endpoints.rb#27 class Aws::SSO::Plugins::Endpoints::Handler < ::Seahorse::Client::Handler # @api private # - # source://aws-sdk-core//lib/aws-sdk-sso/plugins/endpoints.rb#27 + # source://aws-sdk-core//lib/aws-sdk-sso/plugins/endpoints.rb#28 def call(context); end private # @api private # - # source://aws-sdk-core//lib/aws-sdk-sso/plugins/endpoints.rb#46 + # source://aws-sdk-core//lib/aws-sdk-sso/plugins/endpoints.rb#48 def apply_endpoint_headers(context, headers); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-sso/plugins/endpoints.rb#57 + # source://aws-sdk-core//lib/aws-sdk-sso/plugins/endpoints.rb#59 def parameters_for_operation(context); end end @@ -9660,26 +9242,62 @@ module Aws::SSOOIDC; end # # See {#initialize} for a full list of supported configuration options. # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client.rb#52 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client.rb#53 class Aws::SSOOIDC::Client < ::Seahorse::Client::Base include ::Aws::ClientStubs # @overload initialize # @return [Client] a new instance of Client # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/client.rb#385 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/client.rb#422 def initialize(*args); end # @api private # @param params [{}] # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/client.rb#595 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/client.rb#989 def build_request(operation_name, params = T.unsafe(nil)); end - # Creates and returns an access token for the authorized client. The - # access token issued will be used to fetch short-term credentials for - # the assigned roles in the AWS account. + # Creates and returns access and refresh tokens for clients that are + # authenticated using client secrets. The access token can be used to + # fetch short-term credentials for the assigned AWS accounts or to + # access application APIs using `bearer` authentication. + # + # @example Example: Call OAuth/OIDC /token endpoint for Device Code grant with Secret authentication + # + # resp = client.create_token({ + # client_id: "_yzkThXVzLWVhc3QtMQEXAMPLECLIENTID", + # client_secret: "VERYLONGSECRETeyJraWQiOiJrZXktMTU2NDAyODA5OSIsImFsZyI6IkhTMzg0In0", + # device_code: "yJraWQiOiJrZXktMTU2Njk2ODA4OCIsImFsZyI6IkhTMzIn0EXAMPLEDEVICECODE", + # grant_type: "urn:ietf:params:oauth:grant-type:device-code", + # }) + # + # resp.to_h outputs the following: + # { + # access_token: "aoal-YigITUDiNX1xZwOMXM5MxOWDL0E0jg9P6_C_jKQPxS_SKCP6f0kh1Up4g7TtvQqkMnD-GJiU_S1gvug6SrggAkc0:MGYCMQD3IatVjV7jAJU91kK3PkS/SfA2wtgWzOgZWDOR7sDGN9t0phCZz5It/aes/3C1Zj0CMQCKWOgRaiz6AIhza3DSXQNMLjRKXC8F8ceCsHlgYLMZ7hZidEXAMPLEACCESSTOKEN", + # expires_in: 1579729529, + # refresh_token: "aorvJYubGpU6i91YnH7Mfo-AT2fIVa1zCfA_Rvq9yjVKIP3onFmmykuQ7E93y2I-9Nyj-A_sVvMufaLNL0bqnDRtgAkc0:MGUCMFrRsktMRVlWaOR70XGMFGLL0SlcCw4DiYveIiOVx1uK9BbD0gvAddsW3UTLozXKMgIxAJ3qxUvjpnlLIOaaKOoa/FuNgqJVvr9GMwDtnAtlh9iZzAkEXAMPLEREFRESHTOKEN", + # token_type: "Bearer", + # } + # @example Example: Call OAuth/OIDC /token endpoint for Refresh Token grant with Secret authentication + # + # resp = client.create_token({ + # client_id: "_yzkThXVzLWVhc3QtMQEXAMPLECLIENTID", + # client_secret: "VERYLONGSECRETeyJraWQiOiJrZXktMTU2NDAyODA5OSIsImFsZyI6IkhTMzg0In0", + # grant_type: "refresh_token", + # refresh_token: "aorvJYubGpU6i91YnH7Mfo-AT2fIVa1zCfA_Rvq9yjVKIP3onFmmykuQ7E93y2I-9Nyj-A_sVvMufaLNL0bqnDRtgAkc0:MGUCMFrRsktMRVlWaOR70XGMFGLL0SlcCw4DiYveIiOVx1uK9BbD0gvAddsW3UTLozXKMgIxAJ3qxUvjpnlLIOaaKOoa/FuNgqJVvr9GMwDtnAtlh9iZzAkEXAMPLEREFRESHTOKEN", + # scope: [ + # "codewhisperer:completions", + # ], + # }) # + # resp.to_h outputs the following: + # { + # access_token: "aoal-YigITUDiNX1xZwOMXM5MxOWDL0E0jg9P6_C_jKQPxS_SKCP6f0kh1Up4g7TtvQqkMnD-GJiU_S1gvug6SrggAkc0:MGYCMQD3IatVjV7jAJU91kK3PkS/SfA2wtgWzOgZWDOR7sDGN9t0phCZz5It/aes/3C1Zj0CMQCKWOgRaiz6AIhza3DSXQNMLjRKXC8F8ceCsHlgYLMZ7hZidEXAMPLEACCESSTOKEN", + # expires_in: 1579729529, + # refresh_token: "aorvJYubGpU6i91YnH7Mfo-AT2fIVa1zCfA_Rvq9yjVKIP3onFmmykuQ7E93y2I-9Nyj-A_sVvMufaLNL0bqnDRtgAkc0:MGUCMFrRsktMRVlWaOR70XGMFGLL0SlcCw4DiYveIiOVx1uK9BbD0gvAddsW3UTLozXKMgIxAJ3qxUvjpnlLIOaaKOoa/FuNgqJVvr9GMwDtnAtlh9iZzAkEXAMPLEREFRESHTOKEN", + # token_type: "Bearer", + # } # @example Request syntax with placeholder values # # resp = client.create_token({ @@ -9691,6 +9309,7 @@ class Aws::SSOOIDC::Client < ::Seahorse::Client::Base # refresh_token: "RefreshToken", # scope: ["Scope"], # redirect_uri: "URI", + # code_verifier: "CodeVerifier", # }) # @example Response structure # @@ -9707,6 +9326,7 @@ class Aws::SSOOIDC::Client < ::Seahorse::Client::Base # @option params # @option params # @option params + # @option params # @overload create_token # @param params [Hash] ({}) # @return [Types::CreateTokenResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -9718,19 +9338,202 @@ class Aws::SSOOIDC::Client < ::Seahorse::Client::Base # * {Types::CreateTokenResponse#id_token #id_token} => String # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/CreateToken AWS API Documentation # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/client.rb#480 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/client.rb#564 def create_token(params = T.unsafe(nil), options = T.unsafe(nil)); end + # Creates and returns access and refresh tokens for clients and + # applications that are authenticated using IAM entities. The access + # token can be used to fetch short-term credentials for the assigned + # Amazon Web Services accounts or to access application APIs using + # `bearer` authentication. + # + # @example Example: Call OAuth/OIDC /token endpoint for Authorization Code grant with IAM authentication + # + # resp = client.create_token_with_iam({ + # client_id: "arn:aws:sso::123456789012:application/ssoins-111111111111/apl-222222222222", + # code: "yJraWQiOiJrZXktMTU2Njk2ODA4OCIsImFsZyI6IkhTMzg0In0EXAMPLEAUTHCODE", + # grant_type: "authorization_code", + # redirect_uri: "https://mywebapp.example/redirect", + # scope: [ + # "openid", + # "aws", + # "sts:identity_context", + # ], + # }) + # + # resp.to_h outputs the following: + # { + # access_token: "aoal-YigITUDiNX1xZwOMXM5MxOWDL0E0jg9P6_C_jKQPxS_SKCP6f0kh1Up4g7TtvQqkMnD-GJiU_S1gvug6SrggAkc0:MGYCMQD3IatVjV7jAJU91kK3PkS/SfA2wtgWzOgZWDOR7sDGN9t0phCZz5It/aes/3C1Zj0CMQCKWOgRaiz6AIhza3DSXQNMLjRKXC8F8ceCsHlgYLMZ7hZidEXAMPLEACCESSTOKEN", + # expires_in: 1579729529, + # id_token: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhd3M6aWRlbnRpdHlfc3RvcmVfaWQiOiJkLTMzMzMzMzMzMzMiLCJzdWIiOiI3MzA0NDhmMi1lMGExLTcwYTctYzk1NC0wMDAwMDAwMDAwMDAiLCJhd3M6aW5zdGFuY2VfYWNjb3VudCI6IjExMTExMTExMTExMSIsInN0czppZGVudGl0eV9jb250ZXh0IjoiRVhBTVBMRUlERU5USVRZQ09OVEVYVCIsInN0czphdWRpdF9jb250ZXh0IjoiRVhBTVBMRUFVRElUQ09OVEVYVCIsImlzcyI6Imh0dHBzOi8vaWRlbnRpdHljZW50ZXIuYW1hem9uYXdzLmNvbS9zc29pbnMtMTExMTExMTExMTExIiwiYXdzOmlkZW50aXR5X3N0b3JlX2FybiI6ImFybjphd3M6aWRlbnRpdHlzdG9yZTo6MTExMTExMTExMTExOmlkZW50aXR5c3RvcmUvZC0zMzMzMzMzMzMzIiwiYXVkIjoiYXJuOmF3czpzc286OjEyMzQ1Njc4OTAxMjphcHBsaWNhdGlvbi9zc29pbnMtMTExMTExMTExMTExL2FwbC0yMjIyMjIyMjIyMjIiLCJhd3M6aW5zdGFuY2VfYXJuIjoiYXJuOmF3czpzc286OjppbnN0YW5jZS9zc29pbnMtMTExMTExMTExMTExIiwiYXdzOmNyZWRlbnRpYWxfaWQiOiJfWlIyTjZhVkJqMjdGUEtheWpfcEtwVjc3QVBERl80MXB4ZXRfWWpJdUpONlVJR2RBdkpFWEFNUExFQ1JFRElEIiwiYXV0aF90aW1lIjoiMjAyMC0wMS0yMlQxMjo0NToyOVoiLCJleHAiOjE1Nzk3Mjk1MjksImlhdCI6MTU3OTcyNTkyOX0.Xyah6qbk78qThzJ41iFU2yfGuRqqtKXHrJYwQ8L9Ip0", + # issued_token_type: "urn:ietf:params:oauth:token-type:refresh_token", + # refresh_token: "aorvJYubGpU6i91YnH7Mfo-AT2fIVa1zCfA_Rvq9yjVKIP3onFmmykuQ7E93y2I-9Nyj-A_sVvMufaLNL0bqnDRtgAkc0:MGUCMFrRsktMRVlWaOR70XGMFGLL0SlcCw4DiYveIiOVx1uK9BbD0gvAddsW3UTLozXKMgIxAJ3qxUvjpnlLIOaaKOoa/FuNgqJVvr9GMwDtnAtlh9iZzAkEXAMPLEREFRESHTOKEN", + # scope: [ + # "openid", + # "aws", + # "sts:identity_context", + # ], + # token_type: "Bearer", + # } + # @example Example: Call OAuth/OIDC /token endpoint for Refresh Token grant with IAM authentication + # + # resp = client.create_token_with_iam({ + # client_id: "arn:aws:sso::123456789012:application/ssoins-111111111111/apl-222222222222", + # grant_type: "refresh_token", + # refresh_token: "aorvJYubGpU6i91YnH7Mfo-AT2fIVa1zCfA_Rvq9yjVKIP3onFmmykuQ7E93y2I-9Nyj-A_sVvMufaLNL0bqnDRtgAkc0:MGUCMFrRsktMRVlWaOR70XGMFGLL0SlcCw4DiYveIiOVx1uK9BbD0gvAddsW3UTLozXKMgIxAJ3qxUvjpnlLIOaaKOoa/FuNgqJVvr9GMwDtnAtlh9iZzAkEXAMPLEREFRESHTOKEN", + # }) + # + # resp.to_h outputs the following: + # { + # access_token: "aoal-YigITUDiNX1xZwOMXM5MxOWDL0E0jg9P6_C_jKQPxS_SKCP6f0kh1Up4g7TtvQqkMnD-GJiU_S1gvug6SrggAkc0:MGYCMQD3IatVjV7jAJU91kK3PkS/SfA2wtgWzOgZWDOR7sDGN9t0phCZz5It/aes/3C1Zj0CMQCKWOgRaiz6AIhza3DSXQNMLjRKXC8F8ceCsHlgYLMZ7hZidEXAMPLEACCESSTOKEN", + # expires_in: 1579729529, + # issued_token_type: "urn:ietf:params:oauth:token-type:refresh_token", + # refresh_token: "aorvJYubGpU6i91YnH7Mfo-AT2fIVa1zCfA_Rvq9yjVKIP3onFmmykuQ7E93y2I-9Nyj-A_sVvMufaLNL0bqnDRtgAkc0:MGUCMFrRsktMRVlWaOR70XGMFGLL0SlcCw4DiYveIiOVx1uK9BbD0gvAddsW3UTLozXKMgIxAJ3qxUvjpnlLIOaaKOoa/FuNgqJVvr9GMwDtnAtlh9iZzAkEXAMPLEREFRESHTOKEN", + # scope: [ + # "openid", + # "aws", + # "sts:identity_context", + # ], + # token_type: "Bearer", + # } + # @example Example: Call OAuth/OIDC /token endpoint for JWT Bearer grant with IAM authentication + # + # resp = client.create_token_with_iam({ + # assertion: "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6IjFMVE16YWtpaGlSbGFfOHoyQkVKVlhlV01xbyJ9.eyJ2ZXIiOiIyLjAiLCJpc3MiOiJodHRwczovL2xvZ2luLm1pY3Jvc29mdG9ubGluZS5jb20vOTEyMjA0MGQtNmM2Ny00YzViLWIxMTItMzZhMzA0YjY2ZGFkL3YyLjAiLCJzdWIiOiJBQUFBQUFBQUFBQUFBQUFBQUFBQUFJa3pxRlZyU2FTYUZIeTc4MmJidGFRIiwiYXVkIjoiNmNiMDQwMTgtYTNmNS00NmE3LWI5OTUtOTQwYzc4ZjVhZWYzIiwiZXhwIjoxNTM2MzYxNDExLCJpYXQiOjE1MzYyNzQ3MTEsIm5iZiI6MTUzNjI3NDcxMSwibmFtZSI6IkFiZSBMaW5jb2xuIiwicHJlZmVycmVkX3VzZXJuYW1lIjoiQWJlTGlAbWljcm9zb2Z0LmNvbSIsIm9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC02NmYzLTMzMzJlY2E3ZWE4MSIsInRpZCI6IjkxMjIwNDBkLTZjNjctNGM1Yi1iMTEyLTM2YTMwNGI2NmRhZCIsIm5vbmNlIjoiMTIzNTIzIiwiYWlvIjoiRGYyVVZYTDFpeCFsTUNXTVNPSkJjRmF0emNHZnZGR2hqS3Y4cTVnMHg3MzJkUjVNQjVCaXN2R1FPN1lXQnlqZDhpUURMcSFlR2JJRGFreXA1bW5PcmNkcUhlWVNubHRlcFFtUnA2QUlaOGpZIn0.1AFWW-Ck5nROwSlltm7GzZvDwUkqvhSQpm55TQsmVo9Y59cLhRXpvB8n-55HCr9Z6G_31_UbeUkoz612I2j_Sm9FFShSDDjoaLQr54CreGIJvjtmS3EkK9a7SJBbcpL1MpUtlfygow39tFjY7EVNW9plWUvRrTgVk7lYLprvfzw-CIqw3gHC-T7IK_m_xkr08INERBtaecwhTeN4chPC4W3jdmw_lIxzC48YoQ0dB1L9-ImX98Egypfrlbm0IBL5spFzL6JDZIRRJOu8vecJvj1mq-IUhGt0MacxX8jdxYLP-KUu2d9MbNKpCKJuZ7p8gwTL5B7NlUdh_dmSviPWrw", + # client_id: "arn:aws:sso::123456789012:application/ssoins-111111111111/apl-222222222222", + # grant_type: "urn:ietf:params:oauth:grant-type:jwt-bearer", + # }) + # + # resp.to_h outputs the following: + # { + # access_token: "aoal-YigITUDiNX1xZwOMXM5MxOWDL0E0jg9P6_C_jKQPxS_SKCP6f0kh1Up4g7TtvQqkMnD-GJiU_S1gvug6SrggAkc0:MGYCMQD3IatVjV7jAJU91kK3PkS/SfA2wtgWzOgZWDOR7sDGN9t0phCZz5It/aes/3C1Zj0CMQCKWOgRaiz6AIhza3DSXQNMLjRKXC8F8ceCsHlgYLMZ7hZidEXAMPLEACCESSTOKEN", + # expires_in: 1579729529, + # id_token: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhd3M6aWRlbnRpdHlfc3RvcmVfaWQiOiJkLTMzMzMzMzMzMzMiLCJzdWIiOiI3MzA0NDhmMi1lMGExLTcwYTctYzk1NC0wMDAwMDAwMDAwMDAiLCJhd3M6aW5zdGFuY2VfYWNjb3VudCI6IjExMTExMTExMTExMSIsInN0czppZGVudGl0eV9jb250ZXh0IjoiRVhBTVBMRUlERU5USVRZQ09OVEVYVCIsInN0czphdWRpdF9jb250ZXh0IjoiRVhBTVBMRUFVRElUQ09OVEVYVCIsImlzcyI6Imh0dHBzOi8vaWRlbnRpdHljZW50ZXIuYW1hem9uYXdzLmNvbS9zc29pbnMtMTExMTExMTExMTExIiwiYXdzOmlkZW50aXR5X3N0b3JlX2FybiI6ImFybjphd3M6aWRlbnRpdHlzdG9yZTo6MTExMTExMTExMTExOmlkZW50aXR5c3RvcmUvZC0zMzMzMzMzMzMzIiwiYXVkIjoiYXJuOmF3czpzc286OjEyMzQ1Njc4OTAxMjphcHBsaWNhdGlvbi9zc29pbnMtMTExMTExMTExMTExL2FwbC0yMjIyMjIyMjIyMjIiLCJhd3M6aW5zdGFuY2VfYXJuIjoiYXJuOmF3czpzc286OjppbnN0YW5jZS9zc29pbnMtMTExMTExMTExMTExIiwiYXdzOmNyZWRlbnRpYWxfaWQiOiJfWlIyTjZhVkJqMjdGUEtheWpfcEtwVjc3QVBERl80MXB4ZXRfWWpJdUpONlVJR2RBdkpFWEFNUExFQ1JFRElEIiwiYXV0aF90aW1lIjoiMjAyMC0wMS0yMlQxMjo0NToyOVoiLCJleHAiOjE1Nzk3Mjk1MjksImlhdCI6MTU3OTcyNTkyOX0.Xyah6qbk78qThzJ41iFU2yfGuRqqtKXHrJYwQ8L9Ip0", + # issued_token_type: "urn:ietf:params:oauth:token-type:refresh_token", + # refresh_token: "aorvJYubGpU6i91YnH7Mfo-AT2fIVa1zCfA_Rvq9yjVKIP3onFmmykuQ7E93y2I-9Nyj-A_sVvMufaLNL0bqnDRtgAkc0:MGUCMFrRsktMRVlWaOR70XGMFGLL0SlcCw4DiYveIiOVx1uK9BbD0gvAddsW3UTLozXKMgIxAJ3qxUvjpnlLIOaaKOoa/FuNgqJVvr9GMwDtnAtlh9iZzAkEXAMPLEREFRESHTOKEN", + # scope: [ + # "openid", + # "aws", + # "sts:identity_context", + # ], + # token_type: "Bearer", + # } + # @example Example: Call OAuth/OIDC /token endpoint for Token Exchange grant with IAM authentication + # + # resp = client.create_token_with_iam({ + # client_id: "arn:aws:sso::123456789012:application/ssoins-111111111111/apl-222222222222", + # grant_type: "urn:ietf:params:oauth:grant-type:token-exchange", + # requested_token_type: "urn:ietf:params:oauth:token-type:access_token", + # subject_token: "aoak-Hig8TUDPNX1xZwOMXM5MxOWDL0E0jg9P6_C_jKQPxS_SKCP6f0kh1Up4g7TtvQqkMnD-GJiU_S1gvug6SrggAkc0:MGYCMQD3IatVjV7jAJU91kK3PkS/SfA2wtgWzOgZWDOR7sDGN9t0phCZz5It/aes/3C1Zj0CMQCKWOgRaiz6AIhza3DSXQNMLjRKXC8F8ceCsHlgYLMZ7hZDIFFERENTACCESSTOKEN", + # subject_token_type: "urn:ietf:params:oauth:token-type:access_token", + # }) + # + # resp.to_h outputs the following: + # { + # access_token: "aoal-YigITUDiNX1xZwOMXM5MxOWDL0E0jg9P6_C_jKQPxS_SKCP6f0kh1Up4g7TtvQqkMnD-GJiU_S1gvug6SrggAkc0:MGYCMQD3IatVjV7jAJU91kK3PkS/SfA2wtgWzOgZWDOR7sDGN9t0phCZz5It/aes/3C1Zj0CMQCKWOgRaiz6AIhza3DSXQNMLjRKXC8F8ceCsHlgYLMZ7hZidEXAMPLEACCESSTOKEN", + # expires_in: 1579729529, + # id_token: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhd3M6aWRlbnRpdHlfc3RvcmVfaWQiOiJkLTMzMzMzMzMzMzMiLCJzdWIiOiI3MzA0NDhmMi1lMGExLTcwYTctYzk1NC0wMDAwMDAwMDAwMDAiLCJhd3M6aW5zdGFuY2VfYWNjb3VudCI6IjExMTExMTExMTExMSIsInN0czppZGVudGl0eV9jb250ZXh0IjoiRVhBTVBMRUlERU5USVRZQ09OVEVYVCIsImlzcyI6Imh0dHBzOi8vaWRlbnRpdHljZW50ZXIuYW1hem9uYXdzLmNvbS9zc29pbnMtMTExMTExMTExMTExIiwiYXdzOmlkZW50aXR5X3N0b3JlX2FybiI6ImFybjphd3M6aWRlbnRpdHlzdG9yZTo6MTExMTExMTExMTExOmlkZW50aXR5c3RvcmUvZC0zMzMzMzMzMzMzIiwiYXVkIjoiYXJuOmF3czpzc286OjEyMzQ1Njc4OTAxMjphcHBsaWNhdGlvbi9zc29pbnMtMTExMTExMTExMTExL2FwbC0yMjIyMjIyMjIyMjIiLCJhd3M6aW5zdGFuY2VfYXJuIjoiYXJuOmF3czpzc286OjppbnN0YW5jZS9zc29pbnMtMTExMTExMTExMTExIiwiYXdzOmNyZWRlbnRpYWxfaWQiOiJfWlIyTjZhVkJqMjdGUEtheWpfcEtwVjc3QVBERl80MXB4ZXRfWWpJdUpONlVJR2RBdkpFWEFNUExFQ1JFRElEIiwiYXV0aF90aW1lIjoiMjAyMC0wMS0yMlQxMjo0NToyOVoiLCJleHAiOjE1Nzk3Mjk1MjksImlhdCI6MTU3OTcyNTkyOX0.5SYiW1kMsuUr7nna-l5tlakM0GNbMHvIM2_n0QD23jM", + # issued_token_type: "urn:ietf:params:oauth:token-type:access_token", + # scope: [ + # "openid", + # "aws", + # "sts:identity_context", + # ], + # token_type: "Bearer", + # } + # @example Request syntax with placeholder values + # + # resp = client.create_token_with_iam({ + # client_id: "ClientId", # required + # grant_type: "GrantType", # required + # code: "AuthCode", + # refresh_token: "RefreshToken", + # assertion: "Assertion", + # scope: ["Scope"], + # redirect_uri: "URI", + # subject_token: "SubjectToken", + # subject_token_type: "TokenTypeURI", + # requested_token_type: "TokenTypeURI", + # code_verifier: "CodeVerifier", + # }) + # @example Response structure + # + # resp.access_token #=> String + # resp.token_type #=> String + # resp.expires_in #=> Integer + # resp.refresh_token #=> String + # resp.id_token #=> String + # resp.issued_token_type #=> String + # resp.scope #=> Array + # resp.scope[0] #=> String + # @option params + # @option params + # @option params + # @option params + # @option params + # @option params + # @option params + # @option params + # @option params + # @option params + # @option params + # @overload create_token_with_iam + # @param params [Hash] ({}) + # @return [Types::CreateTokenWithIAMResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::CreateTokenWithIAMResponse#access_token #access_token} => String + # * {Types::CreateTokenWithIAMResponse#token_type #token_type} => String + # * {Types::CreateTokenWithIAMResponse#expires_in #expires_in} => Integer + # * {Types::CreateTokenWithIAMResponse#refresh_token #refresh_token} => String + # * {Types::CreateTokenWithIAMResponse#id_token #id_token} => String + # * {Types::CreateTokenWithIAMResponse#issued_token_type #issued_token_type} => String + # * {Types::CreateTokenWithIAMResponse#scope #scope} => Array<String> + # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/CreateTokenWithIAM AWS API Documentation + # + # source://aws-sdk-core//lib/aws-sdk-ssooidc/client.rb#799 + def create_token_with_iam(params = T.unsafe(nil), options = T.unsafe(nil)); end + # Registers a client with IAM Identity Center. This allows clients to # initiate device authorization. The output should be persisted for # reuse through many authentication requests. # + # @example Example: Call OAuth/OIDC /register-client endpoint + # + # resp = client.register_client({ + # client_name: "My IDE Plugin", + # client_type: "public", + # entitled_application_arn: "arn:aws:sso::ACCOUNTID:application/ssoins-1111111111111111/apl-1111111111111111", + # grant_types: [ + # "authorization_code", + # "refresh_token", + # ], + # issuer_url: "https://identitycenter.amazonaws.com/ssoins-1111111111111111", + # redirect_uris: [ + # "127.0.0.1:PORT/oauth/callback", + # ], + # scopes: [ + # "sso:account:access", + # "codewhisperer:completions", + # ], + # }) + # + # resp.to_h outputs the following: + # { + # client_id: "_yzkThXVzLWVhc3QtMQEXAMPLECLIENTID", + # client_id_issued_at: 1579725929, + # client_secret: "VERYLONGSECRETeyJraWQiOiJrZXktMTU2NDAyODA5OSIsImFsZyI6IkhTMzg0In0", + # client_secret_expires_at: 1587584729, + # } # @example Request syntax with placeholder values # # resp = client.register_client({ # client_name: "ClientName", # required # client_type: "ClientType", # required # scopes: ["Scope"], + # redirect_uris: ["URI"], + # grant_types: ["GrantType"], + # issuer_url: "URI", + # entitled_application_arn: "ArnType", # }) # @example Response structure # @@ -9743,6 +9546,10 @@ class Aws::SSOOIDC::Client < ::Seahorse::Client::Base # @option params # @option params # @option params + # @option params + # @option params + # @option params + # @option params # @overload register_client # @param params [Hash] ({}) # @return [Types::RegisterClientResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -9755,12 +9562,29 @@ class Aws::SSOOIDC::Client < ::Seahorse::Client::Base # * {Types::RegisterClientResponse#token_endpoint #token_endpoint} => String # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/RegisterClient AWS API Documentation # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/client.rb#531 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/client.rb#905 def register_client(params = T.unsafe(nil), options = T.unsafe(nil)); end # Initiates device authorization by requesting a pair of verification # codes from the authorization service. # + # @example Example: Call OAuth/OIDC /start-device-authorization endpoint + # + # resp = client.start_device_authorization({ + # client_id: "_yzkThXVzLWVhc3QtMQEXAMPLECLIENTID", + # client_secret: "VERYLONGSECRETeyJraWQiOiJrZXktMTU2NDAyODA5OSIsImFsZyI6IkhTMzg0In0", + # start_url: "https://identitycenter.amazonaws.com/ssoins-111111111111", + # }) + # + # resp.to_h outputs the following: + # { + # device_code: "yJraWQiOiJrZXktMTU2Njk2ODA4OCIsImFsZyI6IkhTMzIn0EXAMPLEDEVICECODE", + # expires_in: 1579729529, + # interval: 1, + # user_code: "makdfsk83yJraWQiOiJrZXktMTU2Njk2sImFsZyI6IkhTMzIn0EXAMPLEUSERCODE", + # verification_uri: "https://device.sso.us-west-2.amazonaws.com", + # verification_uri_complete: "https://device.sso.us-west-2.amazonaws.com?user_code=makdfsk83yJraWQiOiJrZXktMTU2Njk2sImFsZyI6IkhTMzIn0EXAMPLEUSERCODE", + # } # @example Request syntax with placeholder values # # resp = client.start_device_authorization({ @@ -9791,24 +9615,24 @@ class Aws::SSOOIDC::Client < ::Seahorse::Client::Base # * {Types::StartDeviceAuthorizationResponse#interval #interval} => Integer # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/StartDeviceAuthorization AWS API Documentation # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/client.rb#586 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/client.rb#980 def start_device_authorization(params = T.unsafe(nil), options = T.unsafe(nil)); end # @api private # @deprecated # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/client.rb#610 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/client.rb#1004 def waiter_names; end class << self # @api private # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/client.rb#620 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/client.rb#1014 def errors_module; end # @api private # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/client.rb#617 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/client.rb#1011 def identifier; end end end @@ -9822,7 +9646,7 @@ end # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#150 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#204 Aws::SSOOIDC::ClientApi::API = T.let(T.unsafe(nil), Seahorse::Model::Api) # @api private @@ -9838,181 +9662,246 @@ Aws::SSOOIDC::ClientApi::AccessToken = T.let(T.unsafe(nil), Seahorse::Model::Sha # @api private # # source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#18 +Aws::SSOOIDC::ClientApi::ArnType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) + +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#19 +Aws::SSOOIDC::ClientApi::Assertion = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) + +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#20 Aws::SSOOIDC::ClientApi::AuthCode = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#19 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#21 Aws::SSOOIDC::ClientApi::AuthorizationPendingException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#20 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#22 Aws::SSOOIDC::ClientApi::ClientId = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#21 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#23 Aws::SSOOIDC::ClientApi::ClientName = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#22 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#24 Aws::SSOOIDC::ClientApi::ClientSecret = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#23 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#25 Aws::SSOOIDC::ClientApi::ClientType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#24 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#26 +Aws::SSOOIDC::ClientApi::CodeVerifier = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) + +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#27 Aws::SSOOIDC::ClientApi::CreateTokenRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#25 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#28 Aws::SSOOIDC::ClientApi::CreateTokenResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#26 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#29 +Aws::SSOOIDC::ClientApi::CreateTokenWithIAMRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) + +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#30 +Aws::SSOOIDC::ClientApi::CreateTokenWithIAMResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) + +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#31 Aws::SSOOIDC::ClientApi::DeviceCode = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#27 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#32 Aws::SSOOIDC::ClientApi::Error = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#28 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#33 Aws::SSOOIDC::ClientApi::ErrorDescription = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#29 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#34 Aws::SSOOIDC::ClientApi::ExpirationInSeconds = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#30 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#35 Aws::SSOOIDC::ClientApi::ExpiredTokenException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#31 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#36 Aws::SSOOIDC::ClientApi::GrantType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#32 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#37 +Aws::SSOOIDC::ClientApi::GrantTypes = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) + +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#38 Aws::SSOOIDC::ClientApi::IdToken = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#33 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#39 Aws::SSOOIDC::ClientApi::InternalServerException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#34 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#40 Aws::SSOOIDC::ClientApi::IntervalInSeconds = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#35 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#41 Aws::SSOOIDC::ClientApi::InvalidClientException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#36 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#42 Aws::SSOOIDC::ClientApi::InvalidClientMetadataException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#37 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#43 Aws::SSOOIDC::ClientApi::InvalidGrantException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#38 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#44 +Aws::SSOOIDC::ClientApi::InvalidRedirectUriException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) + +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#45 Aws::SSOOIDC::ClientApi::InvalidRequestException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#39 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#46 +Aws::SSOOIDC::ClientApi::InvalidRequestRegionException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) + +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#47 Aws::SSOOIDC::ClientApi::InvalidScopeException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#40 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#48 +Aws::SSOOIDC::ClientApi::Location = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) + +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#49 Aws::SSOOIDC::ClientApi::LongTimeStampType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#41 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#50 +Aws::SSOOIDC::ClientApi::RedirectUris = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) + +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#51 Aws::SSOOIDC::ClientApi::RefreshToken = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#42 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#52 +Aws::SSOOIDC::ClientApi::Region = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) + +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#53 Aws::SSOOIDC::ClientApi::RegisterClientRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#43 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#54 Aws::SSOOIDC::ClientApi::RegisterClientResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#44 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#55 Aws::SSOOIDC::ClientApi::Scope = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#45 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#56 Aws::SSOOIDC::ClientApi::Scopes = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#46 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#57 Aws::SSOOIDC::ClientApi::SlowDownException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#47 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#58 Aws::SSOOIDC::ClientApi::StartDeviceAuthorizationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#48 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#59 Aws::SSOOIDC::ClientApi::StartDeviceAuthorizationResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#49 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#60 +Aws::SSOOIDC::ClientApi::SubjectToken = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) + +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#61 Aws::SSOOIDC::ClientApi::TokenType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#50 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#62 +Aws::SSOOIDC::ClientApi::TokenTypeURI = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) + +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#63 Aws::SSOOIDC::ClientApi::URI = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#51 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#64 Aws::SSOOIDC::ClientApi::UnauthorizedClientException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#52 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#65 Aws::SSOOIDC::ClientApi::UnsupportedGrantTypeException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#53 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/client_api.rb#66 Aws::SSOOIDC::ClientApi::UserCode = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # Endpoint parameters used to influence endpoints per request. @@ -10103,7 +9992,7 @@ end # @api private # # source://aws-sdk-core//lib/aws-sdk-ssooidc/endpoints.rb#29 -class Aws::SSOOIDC::Endpoints::RegisterClient +class Aws::SSOOIDC::Endpoints::CreateTokenWithIAM class << self # @api private # @@ -10115,7 +10004,7 @@ end # @api private # # source://aws-sdk-core//lib/aws-sdk-ssooidc/endpoints.rb#43 -class Aws::SSOOIDC::Endpoints::StartDeviceAuthorization +class Aws::SSOOIDC::Endpoints::RegisterClient class << self # @api private # @@ -10124,6 +10013,18 @@ class Aws::SSOOIDC::Endpoints::StartDeviceAuthorization end end +# @api private +# +# source://aws-sdk-core//lib/aws-sdk-ssooidc/endpoints.rb#57 +class Aws::SSOOIDC::Endpoints::StartDeviceAuthorization + class << self + # @api private + # + # source://aws-sdk-core//lib/aws-sdk-ssooidc/endpoints.rb#58 + def build(context); end + end +end + # When SSOOIDC returns an error response, the Ruby SDK constructs and raises an error. # These errors all extend Aws::SSOOIDC::Errors::ServiceError < {Aws::Errors::ServiceError} # @@ -10149,7 +10050,9 @@ end # * {InvalidClientException} # * {InvalidClientMetadataException} # * {InvalidGrantException} +# * {InvalidRedirectUriException} # * {InvalidRequestException} +# * {InvalidRequestRegionException} # * {InvalidScopeException} # * {SlowDownException} # * {UnauthorizedClientException} @@ -10158,263 +10061,315 @@ end # Additionally, error classes are dynamically generated for service errors based on the error code # if they are not defined above. # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#45 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#47 module Aws::SSOOIDC::Errors extend ::Aws::Errors::DynamicErrors end -# source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#49 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#51 class Aws::SSOOIDC::Errors::AccessDeniedException < ::Aws::SSOOIDC::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::SSOOIDC::Types::AccessDeniedException] # @return [AccessDeniedException] a new instance of AccessDeniedException # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#54 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#56 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#59 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#61 def error; end # @return [String] # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#64 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#66 def error_description; end end -# source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#69 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#71 class Aws::SSOOIDC::Errors::AuthorizationPendingException < ::Aws::SSOOIDC::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::SSOOIDC::Types::AuthorizationPendingException] # @return [AuthorizationPendingException] a new instance of AuthorizationPendingException # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#74 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#76 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#79 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#81 def error; end # @return [String] # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#84 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#86 def error_description; end end -# source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#89 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#91 class Aws::SSOOIDC::Errors::ExpiredTokenException < ::Aws::SSOOIDC::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::SSOOIDC::Types::ExpiredTokenException] # @return [ExpiredTokenException] a new instance of ExpiredTokenException # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#94 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#96 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#99 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#101 def error; end # @return [String] # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#104 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#106 def error_description; end end -# source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#109 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#111 class Aws::SSOOIDC::Errors::InternalServerException < ::Aws::SSOOIDC::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::SSOOIDC::Types::InternalServerException] # @return [InternalServerException] a new instance of InternalServerException # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#114 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#116 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#119 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#121 def error; end # @return [String] # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#124 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#126 def error_description; end end -# source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#129 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#131 class Aws::SSOOIDC::Errors::InvalidClientException < ::Aws::SSOOIDC::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::SSOOIDC::Types::InvalidClientException] # @return [InvalidClientException] a new instance of InvalidClientException # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#134 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#136 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#139 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#141 def error; end # @return [String] # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#144 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#146 def error_description; end end -# source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#149 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#151 class Aws::SSOOIDC::Errors::InvalidClientMetadataException < ::Aws::SSOOIDC::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::SSOOIDC::Types::InvalidClientMetadataException] # @return [InvalidClientMetadataException] a new instance of InvalidClientMetadataException # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#154 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#156 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#159 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#161 def error; end # @return [String] # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#164 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#166 def error_description; end end -# source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#169 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#171 class Aws::SSOOIDC::Errors::InvalidGrantException < ::Aws::SSOOIDC::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::SSOOIDC::Types::InvalidGrantException] # @return [InvalidGrantException] a new instance of InvalidGrantException # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#174 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#176 + def initialize(context, message, data = T.unsafe(nil)); end + + # @return [String] + # + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#181 + def error; end + + # @return [String] + # + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#186 + def error_description; end +end + +# source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#191 +class Aws::SSOOIDC::Errors::InvalidRedirectUriException < ::Aws::SSOOIDC::Errors::ServiceError + # @param context [Seahorse::Client::RequestContext] + # @param message [String] + # @param data [Aws::SSOOIDC::Types::InvalidRedirectUriException] + # @return [InvalidRedirectUriException] a new instance of InvalidRedirectUriException + # + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#196 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#179 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#201 def error; end # @return [String] # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#184 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#206 def error_description; end end -# source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#189 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#211 class Aws::SSOOIDC::Errors::InvalidRequestException < ::Aws::SSOOIDC::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::SSOOIDC::Types::InvalidRequestException] # @return [InvalidRequestException] a new instance of InvalidRequestException # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#194 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#216 + def initialize(context, message, data = T.unsafe(nil)); end + + # @return [String] + # + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#221 + def error; end + + # @return [String] + # + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#226 + def error_description; end +end + +# source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#231 +class Aws::SSOOIDC::Errors::InvalidRequestRegionException < ::Aws::SSOOIDC::Errors::ServiceError + # @param context [Seahorse::Client::RequestContext] + # @param message [String] + # @param data [Aws::SSOOIDC::Types::InvalidRequestRegionException] + # @return [InvalidRequestRegionException] a new instance of InvalidRequestRegionException + # + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#236 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#199 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#251 + def endpoint; end + + # @return [String] + # + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#241 def error; end # @return [String] # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#204 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#246 def error_description; end + + # @return [String] + # + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#256 + def region; end end -# source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#209 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#261 class Aws::SSOOIDC::Errors::InvalidScopeException < ::Aws::SSOOIDC::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::SSOOIDC::Types::InvalidScopeException] # @return [InvalidScopeException] a new instance of InvalidScopeException # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#214 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#266 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#219 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#271 def error; end # @return [String] # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#224 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#276 def error_description; end end # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#0 class Aws::SSOOIDC::Errors::ServiceError < ::Aws::Errors::ServiceError; end -# source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#229 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#281 class Aws::SSOOIDC::Errors::SlowDownException < ::Aws::SSOOIDC::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::SSOOIDC::Types::SlowDownException] # @return [SlowDownException] a new instance of SlowDownException # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#234 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#286 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#239 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#291 def error; end # @return [String] # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#244 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#296 def error_description; end end -# source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#249 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#301 class Aws::SSOOIDC::Errors::UnauthorizedClientException < ::Aws::SSOOIDC::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::SSOOIDC::Types::UnauthorizedClientException] # @return [UnauthorizedClientException] a new instance of UnauthorizedClientException # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#254 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#306 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#259 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#311 def error; end # @return [String] # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#264 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#316 def error_description; end end -# source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#269 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#321 class Aws::SSOOIDC::Errors::UnsupportedGrantTypeException < ::Aws::SSOOIDC::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::SSOOIDC::Types::UnsupportedGrantTypeException] # @return [UnsupportedGrantTypeException] a new instance of UnsupportedGrantTypeException # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#274 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#326 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#279 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#331 def error; end # @return [String] # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#284 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/errors.rb#336 def error_description; end end @@ -10426,29 +10381,29 @@ module Aws::SSOOIDC::Plugins; end # source://aws-sdk-core//lib/aws-sdk-ssooidc/plugins/endpoints.rb#13 class Aws::SSOOIDC::Plugins::Endpoints < ::Seahorse::Client::Plugin - # source://aws-sdk-core//lib/aws-sdk-ssooidc/plugins/endpoints.rb#69 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/plugins/endpoints.rb#73 def add_handlers(handlers, _config); end end # @api private # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/plugins/endpoints.rb#26 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/plugins/endpoints.rb#27 class Aws::SSOOIDC::Plugins::Endpoints::Handler < ::Seahorse::Client::Handler # @api private # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/plugins/endpoints.rb#27 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/plugins/endpoints.rb#28 def call(context); end private # @api private # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/plugins/endpoints.rb#46 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/plugins/endpoints.rb#48 def apply_endpoint_headers(context, headers); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-ssooidc/plugins/endpoints.rb#57 + # source://aws-sdk-core//lib/aws-sdk-ssooidc/plugins/endpoints.rb#59 def parameters_for_operation(context); end end @@ -10474,12 +10429,12 @@ module Aws::SSOOIDC::Types; end # # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/AccessDeniedException AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#25 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#29 class Aws::SSOOIDC::Types::AccessDeniedException < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#26 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#30 Aws::SSOOIDC::Types::AccessDeniedException::SENSITIVE = T.let(T.unsafe(nil), Array) # Indicates that a request to authorize a client with an access user @@ -10487,45 +10442,65 @@ Aws::SSOOIDC::Types::AccessDeniedException::SENSITIVE = T.let(T.unsafe(nil), Arr # # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/AuthorizationPendingException AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#43 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#51 class Aws::SSOOIDC::Types::AuthorizationPendingException < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#44 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#52 Aws::SSOOIDC::Types::AuthorizationPendingException::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/CreateTokenRequest AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#119 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#139 class Aws::SSOOIDC::Types::CreateTokenRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#120 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#140 Aws::SSOOIDC::Types::CreateTokenRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/CreateTokenResponse AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#175 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#193 class Aws::SSOOIDC::Types::CreateTokenResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#176 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#194 Aws::SSOOIDC::Types::CreateTokenResponse::SENSITIVE = T.let(T.unsafe(nil), Array) +# @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/CreateTokenWithIAMRequest AWS API Documentation +# +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#309 +class Aws::SSOOIDC::Types::CreateTokenWithIAMRequest < ::Struct + include ::Aws::Structure +end + +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#310 +Aws::SSOOIDC::Types::CreateTokenWithIAMRequest::SENSITIVE = T.let(T.unsafe(nil), Array) + +# @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/CreateTokenWithIAMResponse AWS API Documentation +# +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#370 +class Aws::SSOOIDC::Types::CreateTokenWithIAMResponse < ::Struct + include ::Aws::Structure +end + +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#371 +Aws::SSOOIDC::Types::CreateTokenWithIAMResponse::SENSITIVE = T.let(T.unsafe(nil), Array) + # Indicates that the token issued by the service is expired and is no # longer valid. # # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/ExpiredTokenException AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#193 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#392 class Aws::SSOOIDC::Types::ExpiredTokenException < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#194 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#393 Aws::SSOOIDC::Types::ExpiredTokenException::SENSITIVE = T.let(T.unsafe(nil), Array) # Indicates that an error from the service occurred while trying to @@ -10533,12 +10508,12 @@ Aws::SSOOIDC::Types::ExpiredTokenException::SENSITIVE = T.let(T.unsafe(nil), Arr # # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/InternalServerException AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#211 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#414 class Aws::SSOOIDC::Types::InternalServerException < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#212 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#415 Aws::SSOOIDC::Types::InternalServerException::SENSITIVE = T.let(T.unsafe(nil), Array) # Indicates that the `clientId` or `clientSecret` in the request is @@ -10547,12 +10522,12 @@ Aws::SSOOIDC::Types::InternalServerException::SENSITIVE = T.let(T.unsafe(nil), A # # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/InvalidClientException AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#230 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#437 class Aws::SSOOIDC::Types::InvalidClientException < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#231 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#438 Aws::SSOOIDC::Types::InvalidClientException::SENSITIVE = T.let(T.unsafe(nil), Array) # Indicates that the client information sent in the request during @@ -10560,12 +10535,12 @@ Aws::SSOOIDC::Types::InvalidClientException::SENSITIVE = T.let(T.unsafe(nil), Ar # # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/InvalidClientMetadataException AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#248 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#459 class Aws::SSOOIDC::Types::InvalidClientMetadataException < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#249 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#460 Aws::SSOOIDC::Types::InvalidClientMetadataException::SENSITIVE = T.let(T.unsafe(nil), Array) # Indicates that a request contains an invalid grant. This can occur if @@ -10573,57 +10548,84 @@ Aws::SSOOIDC::Types::InvalidClientMetadataException::SENSITIVE = T.let(T.unsafe( # # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/InvalidGrantException AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#266 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#481 class Aws::SSOOIDC::Types::InvalidGrantException < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#267 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#482 Aws::SSOOIDC::Types::InvalidGrantException::SENSITIVE = T.let(T.unsafe(nil), Array) +# Indicates that one or more redirect URI in the request is not +# supported for this operation. +# +# @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/InvalidRedirectUriException AWS API Documentation +# +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#503 +class Aws::SSOOIDC::Types::InvalidRedirectUriException < ::Struct + include ::Aws::Structure +end + +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#504 +Aws::SSOOIDC::Types::InvalidRedirectUriException::SENSITIVE = T.let(T.unsafe(nil), Array) + # Indicates that something is wrong with the input to the request. For # example, a required parameter might be missing or out of range. # # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/InvalidRequestException AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#284 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#525 class Aws::SSOOIDC::Types::InvalidRequestException < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#285 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#526 Aws::SSOOIDC::Types::InvalidRequestException::SENSITIVE = T.let(T.unsafe(nil), Array) +# Indicates that a token provided as input to the request was issued by +# and is only usable by calling IAM Identity Center endpoints in another +# region. +# +# @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/InvalidRequestRegionException AWS API Documentation +# +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#559 +class Aws::SSOOIDC::Types::InvalidRequestRegionException < ::Struct + include ::Aws::Structure +end + +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#560 +Aws::SSOOIDC::Types::InvalidRequestRegionException::SENSITIVE = T.let(T.unsafe(nil), Array) + # Indicates that the scope provided in the request is invalid. # # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/InvalidScopeException AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#301 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#580 class Aws::SSOOIDC::Types::InvalidScopeException < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#302 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#581 Aws::SSOOIDC::Types::InvalidScopeException::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/RegisterClientRequest AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#326 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#635 class Aws::SSOOIDC::Types::RegisterClientRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#327 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#636 Aws::SSOOIDC::Types::RegisterClientRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/RegisterClientResponse AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#367 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#676 class Aws::SSOOIDC::Types::RegisterClientResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#368 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#677 Aws::SSOOIDC::Types::RegisterClientResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # Indicates that the client is making the request too frequently and is @@ -10631,32 +10633,32 @@ Aws::SSOOIDC::Types::RegisterClientResponse::SENSITIVE = T.let(T.unsafe(nil), Ar # # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/SlowDownException AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#385 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#697 class Aws::SSOOIDC::Types::SlowDownException < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#386 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#698 Aws::SSOOIDC::Types::SlowDownException::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/StartDeviceAuthorizationRequest AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#415 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#728 class Aws::SSOOIDC::Types::StartDeviceAuthorizationRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#416 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#729 Aws::SSOOIDC::Types::StartDeviceAuthorizationRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/StartDeviceAuthorizationResponse AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#459 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#772 class Aws::SSOOIDC::Types::StartDeviceAuthorizationResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#460 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#773 Aws::SSOOIDC::Types::StartDeviceAuthorizationResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # Indicates that the client is not currently authorized to make the @@ -10665,12 +10667,12 @@ Aws::SSOOIDC::Types::StartDeviceAuthorizationResponse::SENSITIVE = T.let(T.unsaf # # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/UnauthorizedClientException AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#478 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#795 class Aws::SSOOIDC::Types::UnauthorizedClientException < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#479 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#796 Aws::SSOOIDC::Types::UnauthorizedClientException::SENSITIVE = T.let(T.unsafe(nil), Array) # Indicates that the grant type in the request is not supported by the @@ -10678,12 +10680,12 @@ Aws::SSOOIDC::Types::UnauthorizedClientException::SENSITIVE = T.let(T.unsafe(nil # # @see http://docs.aws.amazon.com/goto/WebAPI/sso-oidc-2019-06-10/UnsupportedGrantTypeException AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#496 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#817 class Aws::SSOOIDC::Types::UnsupportedGrantTypeException < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#497 +# source://aws-sdk-core//lib/aws-sdk-ssooidc/types.rb#818 Aws::SSOOIDC::Types::UnsupportedGrantTypeException::SENSITIVE = T.let(T.unsafe(nil), Array) # source://aws-sdk-core//lib/aws-sdk-core/sso_token_provider.rb#4 @@ -10782,14 +10784,14 @@ module Aws::STS; end # # See {#initialize} for a full list of supported configuration options. # -# source://aws-sdk-core//lib/aws-sdk-sts/client.rb#53 +# source://aws-sdk-core//lib/aws-sdk-sts/client.rb#54 class Aws::STS::Client < ::Seahorse::Client::Base include ::Aws::ClientStubs # @overload initialize # @return [Client] a new instance of Client # - # source://aws-sdk-core//lib/aws-sdk-sts/client.rb#392 + # source://aws-sdk-core//lib/aws-sdk-sts/client.rb#429 def initialize(*args); end # Returns a set of temporary security credentials that you can use to @@ -10955,7 +10957,7 @@ class Aws::STS::Client < ::Seahorse::Client::Base # arn: "arnType", # }, # ], - # policy: "sessionPolicyDocumentType", + # policy: "unrestrictedSessionPolicyDocumentType", # duration_seconds: 1, # tags: [ # { @@ -11007,7 +11009,7 @@ class Aws::STS::Client < ::Seahorse::Client::Base # * {Types::AssumeRoleResponse#source_identity #source_identity} => String # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumeRole AWS API Documentation # - # source://aws-sdk-core//lib/aws-sdk-sts/client.rb#868 + # source://aws-sdk-core//lib/aws-sdk-sts/client.rb#913 def assume_role(params = T.unsafe(nil), options = T.unsafe(nil)); end # Returns a set of temporary security credentials for users who have @@ -11240,7 +11242,7 @@ class Aws::STS::Client < ::Seahorse::Client::Base # * {Types::AssumeRoleWithSAMLResponse#source_identity #source_identity} => String # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumeRoleWithSAML AWS API Documentation # - # source://aws-sdk-core//lib/aws-sdk-sts/client.rb#1220 + # source://aws-sdk-core//lib/aws-sdk-sts/client.rb#1265 def assume_role_with_saml(params = T.unsafe(nil), options = T.unsafe(nil)); end # Returns a set of temporary security credentials for users who have @@ -11485,13 +11487,13 @@ class Aws::STS::Client < ::Seahorse::Client::Base # * {Types::AssumeRoleWithWebIdentityResponse#source_identity #source_identity} => String # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumeRoleWithWebIdentity AWS API Documentation # - # source://aws-sdk-core//lib/aws-sdk-sts/client.rb#1598 + # source://aws-sdk-core//lib/aws-sdk-sts/client.rb#1643 def assume_role_with_web_identity(params = T.unsafe(nil), options = T.unsafe(nil)); end # @api private # @param params [{}] # - # source://aws-sdk-core//lib/aws-sdk-sts/client.rb#2338 + # source://aws-sdk-core//lib/aws-sdk-sts/client.rb#2383 def build_request(operation_name, params = T.unsafe(nil)); end # Decodes additional information about the authorization status of a @@ -11563,7 +11565,7 @@ class Aws::STS::Client < ::Seahorse::Client::Base # * {Types::DecodeAuthorizationMessageResponse#decoded_message #decoded_message} => String # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/DecodeAuthorizationMessage AWS API Documentation # - # source://aws-sdk-core//lib/aws-sdk-sts/client.rb#1679 + # source://aws-sdk-core//lib/aws-sdk-sts/client.rb#1724 def decode_authorization_message(params = T.unsafe(nil), options = T.unsafe(nil)); end # Returns the account identifier for the specified access key ID. @@ -11613,7 +11615,7 @@ class Aws::STS::Client < ::Seahorse::Client::Base # * {Types::GetAccessKeyInfoResponse#account #account} => String # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetAccessKeyInfo AWS API Documentation # - # source://aws-sdk-core//lib/aws-sdk-sts/client.rb#1740 + # source://aws-sdk-core//lib/aws-sdk-sts/client.rb#1785 def get_access_key_info(params = T.unsafe(nil), options = T.unsafe(nil)); end # Returns details about the IAM user or role whose credentials are used @@ -11689,7 +11691,7 @@ class Aws::STS::Client < ::Seahorse::Client::Base # * {Types::GetCallerIdentityResponse#arn #arn} => String # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetCallerIdentity AWS API Documentation # - # source://aws-sdk-core//lib/aws-sdk-sts/client.rb#1824 + # source://aws-sdk-core//lib/aws-sdk-sts/client.rb#1869 def get_caller_identity(params = T.unsafe(nil), options = T.unsafe(nil)); end # Returns a set of temporary security credentials (consisting of an @@ -11884,7 +11886,7 @@ class Aws::STS::Client < ::Seahorse::Client::Base # * {Types::GetFederationTokenResponse#packed_policy_size #packed_policy_size} => Integer # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetFederationToken AWS API Documentation # - # source://aws-sdk-core//lib/aws-sdk-sts/client.rb#2172 + # source://aws-sdk-core//lib/aws-sdk-sts/client.rb#2217 def get_federation_token(params = T.unsafe(nil), options = T.unsafe(nil)); end # Returns a set of temporary credentials for an Amazon Web Services @@ -12002,24 +12004,24 @@ class Aws::STS::Client < ::Seahorse::Client::Base # * {Types::GetSessionTokenResponse#credentials #credentials} => Types::Credentials # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetSessionToken AWS API Documentation # - # source://aws-sdk-core//lib/aws-sdk-sts/client.rb#2329 + # source://aws-sdk-core//lib/aws-sdk-sts/client.rb#2374 def get_session_token(params = T.unsafe(nil), options = T.unsafe(nil)); end # @api private # @deprecated # - # source://aws-sdk-core//lib/aws-sdk-sts/client.rb#2353 + # source://aws-sdk-core//lib/aws-sdk-sts/client.rb#2398 def waiter_names; end class << self # @api private # - # source://aws-sdk-core//lib/aws-sdk-sts/client.rb#2363 + # source://aws-sdk-core//lib/aws-sdk-sts/client.rb#2408 def errors_module; end # @api private # - # source://aws-sdk-core//lib/aws-sdk-sts/client.rb#2360 + # source://aws-sdk-core//lib/aws-sdk-sts/client.rb#2405 def identifier; end end end @@ -12033,7 +12035,7 @@ end # @api private # -# source://aws-sdk-core//lib/aws-sdk-sts/client_api.rb#247 +# source://aws-sdk-core//lib/aws-sdk-sts/client_api.rb#248 Aws::STS::ClientApi::API = T.let(T.unsafe(nil), Seahorse::Model::Api) # @api private @@ -12574,29 +12576,29 @@ module Aws::STS::Plugins; end # source://aws-sdk-core//lib/aws-sdk-sts/plugins/endpoints.rb#13 class Aws::STS::Plugins::Endpoints < ::Seahorse::Client::Plugin - # source://aws-sdk-core//lib/aws-sdk-sts/plugins/endpoints.rb#79 + # source://aws-sdk-core//lib/aws-sdk-sts/plugins/endpoints.rb#81 def add_handlers(handlers, _config); end end # @api private # -# source://aws-sdk-core//lib/aws-sdk-sts/plugins/endpoints.rb#26 +# source://aws-sdk-core//lib/aws-sdk-sts/plugins/endpoints.rb#27 class Aws::STS::Plugins::Endpoints::Handler < ::Seahorse::Client::Handler # @api private # - # source://aws-sdk-core//lib/aws-sdk-sts/plugins/endpoints.rb#27 + # source://aws-sdk-core//lib/aws-sdk-sts/plugins/endpoints.rb#28 def call(context); end private # @api private # - # source://aws-sdk-core//lib/aws-sdk-sts/plugins/endpoints.rb#46 + # source://aws-sdk-core//lib/aws-sdk-sts/plugins/endpoints.rb#48 def apply_endpoint_headers(context, headers); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-sts/plugins/endpoints.rb#57 + # source://aws-sdk-core//lib/aws-sdk-sts/plugins/endpoints.rb#59 def parameters_for_operation(context); end end @@ -12629,7 +12631,7 @@ class Aws::STS::Presigner # Returns a presigned url for get_caller_identity. # # This can be easily converted to a token used by the EKS service: - # {https://ruby-doc.org/stdlib-2.3.1/libdoc/base64/rdoc/Base64.html#method-i-encode64} + # {https://docs.ruby-lang.org/en/3.2/Base64.html#method-i-encode64} # "k8s-aws-v1." + Base64.urlsafe_encode64(url).chomp("==") # # @example @@ -12665,12 +12667,12 @@ module Aws::STS::Types; end # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumeRoleRequest AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#308 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#317 class Aws::STS::Types::AssumeRoleRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#309 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#318 Aws::STS::Types::AssumeRoleRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # Contains the response to a successful AssumeRole request, including @@ -12679,22 +12681,22 @@ Aws::STS::Types::AssumeRoleRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumeRoleResponse AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#374 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#383 class Aws::STS::Types::AssumeRoleResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#375 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#384 Aws::STS::Types::AssumeRoleResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumeRoleWithSAMLRequest AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#515 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#524 class Aws::STS::Types::AssumeRoleWithSAMLRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#516 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#525 Aws::STS::Types::AssumeRoleWithSAMLRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # Contains the response to a successful AssumeRoleWithSAML request, @@ -12703,22 +12705,22 @@ Aws::STS::Types::AssumeRoleWithSAMLRequest::SENSITIVE = T.let(T.unsafe(nil), Arr # # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumeRoleWithSAMLResponse AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#631 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#640 class Aws::STS::Types::AssumeRoleWithSAMLResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#632 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#641 Aws::STS::Types::AssumeRoleWithSAMLResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumeRoleWithWebIdentityRequest AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#788 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#797 class Aws::STS::Types::AssumeRoleWithWebIdentityRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#789 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#798 Aws::STS::Types::AssumeRoleWithWebIdentityRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # Contains the response to a successful AssumeRoleWithWebIdentity @@ -12727,12 +12729,12 @@ Aws::STS::Types::AssumeRoleWithWebIdentityRequest::SENSITIVE = T.let(T.unsafe(ni # # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumeRoleWithWebIdentityResponse AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#889 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#898 class Aws::STS::Types::AssumeRoleWithWebIdentityResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#890 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#899 Aws::STS::Types::AssumeRoleWithWebIdentityResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # The identifiers for the temporary security credentials that the @@ -12740,34 +12742,34 @@ Aws::STS::Types::AssumeRoleWithWebIdentityResponse::SENSITIVE = T.let(T.unsafe(n # # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumedRoleUser AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#918 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#927 class Aws::STS::Types::AssumedRoleUser < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#919 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#928 Aws::STS::Types::AssumedRoleUser::SENSITIVE = T.let(T.unsafe(nil), Array) # Amazon Web Services credentials for API authentication. # # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/Credentials AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#949 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#958 class Aws::STS::Types::Credentials < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#950 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#959 Aws::STS::Types::Credentials::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/DecodeAuthorizationMessageRequest AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#961 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#970 class Aws::STS::Types::DecodeAuthorizationMessageRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#962 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#971 Aws::STS::Types::DecodeAuthorizationMessageRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # A document that contains additional information about the @@ -12776,12 +12778,12 @@ Aws::STS::Types::DecodeAuthorizationMessageRequest::SENSITIVE = T.let(T.unsafe(n # # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/DecodeAuthorizationMessageResponse AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#977 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#986 class Aws::STS::Types::DecodeAuthorizationMessageResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#978 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#987 Aws::STS::Types::DecodeAuthorizationMessageResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # The web identity token that was passed is expired or is not valid. Get @@ -12790,12 +12792,12 @@ Aws::STS::Types::DecodeAuthorizationMessageResponse::SENSITIVE = T.let(T.unsafe( # # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/ExpiredTokenException AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#992 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1001 class Aws::STS::Types::ExpiredTokenException < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#993 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1002 Aws::STS::Types::ExpiredTokenException::SENSITIVE = T.let(T.unsafe(nil), Array) # Identifiers for the federated user that is associated with the @@ -12803,38 +12805,38 @@ Aws::STS::Types::ExpiredTokenException::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/FederatedUser AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1019 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1028 class Aws::STS::Types::FederatedUser < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1020 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1029 Aws::STS::Types::FederatedUser::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetAccessKeyInfoRequest AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1035 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1044 class Aws::STS::Types::GetAccessKeyInfoRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1036 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1045 Aws::STS::Types::GetAccessKeyInfoRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetAccessKeyInfoResponse AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1047 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1056 class Aws::STS::Types::GetAccessKeyInfoResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1048 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1057 Aws::STS::Types::GetAccessKeyInfoResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # @api private # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetCallerIdentityRequest AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1056 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1065 class Aws::STS::Types::GetCallerIdentityRequest < ::Aws::EmptyStructure; end # Contains the response to a successful GetCallerIdentity request, @@ -12842,22 +12844,22 @@ class Aws::STS::Types::GetCallerIdentityRequest < ::Aws::EmptyStructure; end # # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetCallerIdentityResponse AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1087 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1096 class Aws::STS::Types::GetCallerIdentityResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1088 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1097 Aws::STS::Types::GetCallerIdentityResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetFederationTokenRequest AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1260 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1269 class Aws::STS::Types::GetFederationTokenRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1261 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1270 Aws::STS::Types::GetFederationTokenRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # Contains the response to a successful GetFederationToken request, @@ -12866,22 +12868,22 @@ Aws::STS::Types::GetFederationTokenRequest::SENSITIVE = T.let(T.unsafe(nil), Arr # # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetFederationTokenResponse AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1299 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1308 class Aws::STS::Types::GetFederationTokenResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1300 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1309 Aws::STS::Types::GetFederationTokenResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetSessionTokenRequest AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1347 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1356 class Aws::STS::Types::GetSessionTokenRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1348 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1357 Aws::STS::Types::GetSessionTokenRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # Contains the response to a successful GetSessionToken request, @@ -12890,12 +12892,12 @@ Aws::STS::Types::GetSessionTokenRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetSessionTokenResponse AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1370 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1379 class Aws::STS::Types::GetSessionTokenResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1371 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1380 Aws::STS::Types::GetSessionTokenResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # The request could not be fulfilled because the identity provider (IDP) @@ -12907,12 +12909,12 @@ Aws::STS::Types::GetSessionTokenResponse::SENSITIVE = T.let(T.unsafe(nil), Array # # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/IDPCommunicationErrorException AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1388 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1397 class Aws::STS::Types::IDPCommunicationErrorException < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1389 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1398 Aws::STS::Types::IDPCommunicationErrorException::SENSITIVE = T.let(T.unsafe(nil), Array) # The identity provider (IdP) reported that authentication failed. This @@ -12924,12 +12926,12 @@ Aws::STS::Types::IDPCommunicationErrorException::SENSITIVE = T.let(T.unsafe(nil) # # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/IDPRejectedClaimException AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1406 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1415 class Aws::STS::Types::IDPRejectedClaimException < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1407 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1416 Aws::STS::Types::IDPRejectedClaimException::SENSITIVE = T.let(T.unsafe(nil), Array) # The error returned if the message passed to @@ -12938,12 +12940,12 @@ Aws::STS::Types::IDPRejectedClaimException::SENSITIVE = T.let(T.unsafe(nil), Arr # # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/InvalidAuthorizationMessageException AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1421 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1430 class Aws::STS::Types::InvalidAuthorizationMessageException < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1422 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1431 Aws::STS::Types::InvalidAuthorizationMessageException::SENSITIVE = T.let(T.unsafe(nil), Array) # The web identity token that was passed could not be validated by @@ -12952,12 +12954,12 @@ Aws::STS::Types::InvalidAuthorizationMessageException::SENSITIVE = T.let(T.unsaf # # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/InvalidIdentityTokenException AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1436 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1445 class Aws::STS::Types::InvalidIdentityTokenException < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1437 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1446 Aws::STS::Types::InvalidIdentityTokenException::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because the policy document was malformed. @@ -12965,12 +12967,12 @@ Aws::STS::Types::InvalidIdentityTokenException::SENSITIVE = T.let(T.unsafe(nil), # # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/MalformedPolicyDocumentException AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1450 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1459 class Aws::STS::Types::MalformedPolicyDocumentException < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1451 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1460 Aws::STS::Types::MalformedPolicyDocumentException::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because the total packed size of the session @@ -12993,12 +12995,12 @@ Aws::STS::Types::MalformedPolicyDocumentException::SENSITIVE = T.let(T.unsafe(ni # # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/PackedPolicyTooLargeException AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1479 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1488 class Aws::STS::Types::PackedPolicyTooLargeException < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1480 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1489 Aws::STS::Types::PackedPolicyTooLargeException::SENSITIVE = T.let(T.unsafe(nil), Array) # A reference to the IAM managed policy that is passed as a session @@ -13006,24 +13008,26 @@ Aws::STS::Types::PackedPolicyTooLargeException::SENSITIVE = T.let(T.unsafe(nil), # # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/PolicyDescriptorType AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1501 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1510 class Aws::STS::Types::PolicyDescriptorType < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1502 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1511 Aws::STS::Types::PolicyDescriptorType::SENSITIVE = T.let(T.unsafe(nil), Array) -# Reserved for future use. +# Contains information about the provided context. This includes the +# signed and encrypted trusted context assertion and the context +# provider ARN from which the trusted context assertion was generated. # # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/ProvidedContext AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1520 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1534 class Aws::STS::Types::ProvidedContext < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1521 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1535 Aws::STS::Types::ProvidedContext::SENSITIVE = T.let(T.unsafe(nil), Array) # STS is not activated in the requested region for the account that is @@ -13038,12 +13042,12 @@ Aws::STS::Types::ProvidedContext::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/RegionDisabledException AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1541 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1555 class Aws::STS::Types::RegionDisabledException < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1542 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1556 Aws::STS::Types::RegionDisabledException::SENSITIVE = T.let(T.unsafe(nil), Array) # You can pass custom key-value pair attributes when you assume a role @@ -13058,12 +13062,12 @@ Aws::STS::Types::RegionDisabledException::SENSITIVE = T.let(T.unsafe(nil), Array # # @see http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/Tag AWS API Documentation # -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1584 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1598 class Aws::STS::Types::Tag < ::Struct include ::Aws::Structure end -# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1585 +# source://aws-sdk-core//lib/aws-sdk-sts/types.rb#1599 Aws::STS::Types::Tag::SENSITIVE = T.let(T.unsafe(nil), Array) # @api private @@ -13190,6 +13194,9 @@ class Aws::SharedConfig # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#195 def ec2_metadata_service_endpoint_mode(opts = T.unsafe(nil)); end + # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#195 + def ec2_metadata_v1_disabled(opts = T.unsafe(nil)); end + # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#195 def endpoint_discovery_enabled(opts = T.unsafe(nil)); end @@ -13228,6 +13235,9 @@ class Aws::SharedConfig # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#195 def retry_mode(opts = T.unsafe(nil)); end + # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#195 + def s3_disable_express_session_auth(opts = T.unsafe(nil)); end + # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#195 def s3_disable_multiregion_access_points(opts = T.unsafe(nil)); end @@ -13240,6 +13250,9 @@ class Aws::SharedConfig # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#195 def sdk_ua_app_id(opts = T.unsafe(nil)); end + # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#195 + def sigv4a_signing_region_set(opts = T.unsafe(nil)); end + # Attempts to load from shared config or shared credentials file. # Will always attempt first to load from the shared credentials # file, if present. @@ -13271,52 +13284,52 @@ class Aws::SharedConfig # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#240 + # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#243 def assume_role_from_profile(cfg, profile, opts, chain_config); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#333 + # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#336 def assume_role_process_credentials_from_config(profile); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#348 + # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#351 def credentials_from_config(profile, _opts); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#410 + # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#413 def credentials_from_profile(prof_config); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#342 + # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#345 def credentials_from_shared(profile, _opts); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#318 + # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#321 def credentials_from_source(credential_source, config); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#437 + # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#440 def default_shared_config_path(file); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#433 + # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#436 def determine_config_path; end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#429 + # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#432 def determine_credentials_path; end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#453 + # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#456 def determine_profile(options); end # Get a config value from from shared credential/config files. @@ -13325,22 +13338,22 @@ class Aws::SharedConfig # # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#232 + # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#235 def get_config_value(key, opts); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#425 + # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#428 def load_config_file; end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#419 + # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#422 def load_credentials_file; end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#293 + # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#296 def resolve_source_profile(profile, opts = T.unsafe(nil)); end # If any of the sso_ profile values are present, attempt to construct @@ -13348,12 +13361,12 @@ class Aws::SharedConfig # # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#356 + # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#359 def sso_credentials_from_profile(cfg, profile); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#460 + # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#463 def sso_session(cfg, profile, sso_session_name); end # If the required sso_ profile values are present, attempt to construct @@ -13361,12 +13374,12 @@ class Aws::SharedConfig # # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#395 + # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#398 def sso_token_from_profile(cfg, profile); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#444 + # source://aws-sdk-core//lib/aws-sdk-core/shared_config.rb#447 def validate_profile_exists(profile); end class << self @@ -13604,7 +13617,7 @@ class Aws::Stubbing::EmptyStub def stub_structure(ref, visited); end end -# source://aws-sdk-core//lib/aws-sdk-core/stubbing/protocols/ec2.rb#5 +# source://aws-sdk-core//lib/aws-sdk-core/stubbing/protocols/json.rb#5 module Aws::Stubbing::Protocols; end # source://aws-sdk-core//lib/aws-sdk-core/stubbing/protocols/api_gateway.rb#6 @@ -13732,6 +13745,23 @@ class Aws::Stubbing::Protocols::RestXml < ::Aws::Stubbing::Protocols::Rest def xmlns(api); end end +# source://aws-sdk-core//lib/aws-sdk-core/stubbing/protocols/rpc_v2.rb#6 +class Aws::Stubbing::Protocols::RpcV2 + # source://aws-sdk-core//lib/aws-sdk-core/stubbing/protocols/rpc_v2.rb#8 + def stub_data(api, operation, data); end + + # source://aws-sdk-core//lib/aws-sdk-core/stubbing/protocols/rpc_v2.rb#17 + def stub_error(error_code); end + + private + + # source://aws-sdk-core//lib/aws-sdk-core/stubbing/protocols/rpc_v2.rb#35 + def build_body(operation, data); end + + # source://aws-sdk-core//lib/aws-sdk-core/stubbing/protocols/rpc_v2.rb#31 + def content_type(api); end +end + # @api private # # source://aws-sdk-core//lib/aws-sdk-core/stubbing/stub_data.rb#6 @@ -13901,6 +13931,20 @@ module Aws::Util # source://aws-sdk-core//lib/aws-sdk-core/util.rb#10 def deep_merge(left, right); end + # @api private + # @param str [String] + # @return [Number] The input as a number + # + # source://aws-sdk-core//lib/aws-sdk-core/util.rb#83 + def deserialize_number(str); end + + # @api private + # @param value [String] + # @return [Time] + # + # source://aws-sdk-core//lib/aws-sdk-core/util.rb#95 + def deserialize_time(value); end + # @api private # # source://aws-sdk-core//lib/aws-sdk-core/util.rb#49 @@ -13911,6 +13955,13 @@ module Aws::Util # source://aws-sdk-core//lib/aws-sdk-core/util.rb#57 def monotonic_seconds; end + # @api private + # @param input [Number] + # @return [Number, String] The serialized number + # + # source://aws-sdk-core//lib/aws-sdk-core/util.rb#72 + def serialize_number(input); end + # @api private # # source://aws-sdk-core//lib/aws-sdk-core/util.rb#61 @@ -14258,24 +14309,24 @@ class Aws::Xml::Builder # source://aws-sdk-core//lib/aws-sdk-core/xml/builder.rb#11 def initialize(rules, options = T.unsafe(nil)); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/builder.rb#19 + # source://aws-sdk-core//lib/aws-sdk-core/xml/builder.rb#21 def serialize(params); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/builder.rb#19 + # source://aws-sdk-core//lib/aws-sdk-core/xml/builder.rb#21 def to_xml(params); end private - # source://aws-sdk-core//lib/aws-sdk-core/xml/builder.rb#99 + # source://aws-sdk-core//lib/aws-sdk-core/xml/builder.rb#102 def blob(value); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/builder.rb#50 + # source://aws-sdk-core//lib/aws-sdk-core/xml/builder.rb#52 def list(name, ref, values); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/builder.rb#65 + # source://aws-sdk-core//lib/aws-sdk-core/xml/builder.rb#67 def map(name, ref, hash); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/builder.rb#87 + # source://aws-sdk-core//lib/aws-sdk-core/xml/builder.rb#90 def member(name, ref, value); end # The `args` list may contain: @@ -14288,24 +14339,24 @@ class Aws::Xml::Builder # Pass a block if you want to nest XML nodes inside. When doing this, # you may *not* pass a value to the `args` list. # - # source://aws-sdk-core//lib/aws-sdk-core/xml/builder.rb#124 + # source://aws-sdk-core//lib/aws-sdk-core/xml/builder.rb#127 def node(name, ref, *args, &block); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/builder.rb#131 + # source://aws-sdk-core//lib/aws-sdk-core/xml/builder.rb#134 def shape_attrs(ref); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/builder.rb#27 + # source://aws-sdk-core//lib/aws-sdk-core/xml/builder.rb#29 def structure(name, ref, values); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/builder.rb#41 + # source://aws-sdk-core//lib/aws-sdk-core/xml/builder.rb#43 def structure_attrs(ref, values); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/builder.rb#104 + # source://aws-sdk-core//lib/aws-sdk-core/xml/builder.rb#107 def timestamp(ref, value); end # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/xml/builder.rb#143 + # source://aws-sdk-core//lib/aws-sdk-core/xml/builder.rb#151 def xml_attribute?(ref); end end @@ -14374,37 +14425,37 @@ class Aws::Xml::DocBuilder end # source://aws-sdk-core//lib/aws-sdk-core/xml/error_handler.rb#7 -class Aws::Xml::ErrorHandler < ::Seahorse::Client::Handler +class Aws::Xml::ErrorHandler < ::Aws::ErrorHandler # source://aws-sdk-core//lib/aws-sdk-core/xml/error_handler.rb#9 def call(context); end private - # source://aws-sdk-core//lib/aws-sdk-core/xml/error_handler.rb#18 - def error(context); end + # source://aws-sdk-core//lib/aws-sdk-core/xml/error_handler.rb#59 + def apply_error_headers(rule, context, data); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/error_handler.rb#61 + # source://aws-sdk-core//lib/aws-sdk-core/xml/error_handler.rb#64 def error_code(body, context); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/error_handler.rb#42 - def error_data(context, code); end + # source://aws-sdk-core//lib/aws-sdk-core/xml/error_handler.rb#28 + def error_data(context, body, code); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/error_handler.rb#90 + # source://aws-sdk-core//lib/aws-sdk-core/xml/error_handler.rb#80 def error_message(body); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/error_handler.rb#33 + # source://aws-sdk-core//lib/aws-sdk-core/xml/error_handler.rb#18 def extract_error(body, context); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/error_handler.rb#69 - def http_status_error_code(context); end + # source://aws-sdk-core//lib/aws-sdk-core/xml/error_handler.rb#48 + def parse_error_data(rule, body); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/error_handler.rb#82 + # source://aws-sdk-core//lib/aws-sdk-core/xml/error_handler.rb#72 def remove_prefix(error_code, context); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/error_handler.rb#98 + # source://aws-sdk-core//lib/aws-sdk-core/xml/error_handler.rb#88 def request_id(body); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/error_handler.rb#104 + # source://aws-sdk-core//lib/aws-sdk-core/xml/error_handler.rb#94 def unescape(str); end end @@ -14420,7 +14471,7 @@ class Aws::Xml::Parser # @param rules [Seahorse::Model::ShapeRef] # @return [Parser] a new instance of Parser # - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser.rb#10 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser.rb#9 def initialize(rules, options = T.unsafe(nil)); end # Parses the XML document, returning a parsed structure. @@ -14443,7 +14494,7 @@ class Aws::Xml::Parser # @param target [Structure] (nil) # @return [Structure] # - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser.rb#33 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser.rb#32 def parse(xml, target = T.unsafe(nil), &unhandled_callback); end class << self @@ -14457,7 +14508,7 @@ class Aws::Xml::Parser # * {NokogiriEngine} # * {RexmlEngine} # - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser.rb#64 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser.rb#61 def engine; end # @api private @@ -14469,66 +14520,66 @@ class Aws::Xml::Parser # * :nokogiri # * :rexml # - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser.rb#51 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser.rb#49 def engine=(engine); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser.rb#69 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser.rb#66 def set_default_engine; end private # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser.rb#82 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser.rb#79 def load_engine(name); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser.rb#88 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser.rb#85 def try_load_engine(name); end end end -# source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#267 +# source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#263 class Aws::Xml::Parser::BlobFrame < ::Aws::Xml::Parser::Frame - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#268 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#264 def result; end end -# source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#273 +# source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#269 class Aws::Xml::Parser::BooleanFrame < ::Aws::Xml::Parser::Frame - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#274 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#270 def result; end end -# source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#317 +# source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#301 Aws::Xml::Parser::FRAME_CLASSES = T.let(T.unsafe(nil), Hash) -# source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#176 +# source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#172 class Aws::Xml::Parser::FlatListFrame < ::Aws::Xml::Parser::Frame # @return [FlatListFrame] a new instance of FlatListFrame # - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#178 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#174 def initialize(xml_name, *args); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#191 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#187 def child_frame(xml_name); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#195 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#191 def consume_child_frame(child); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#183 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#179 def result; end - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#187 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#183 def set_text(value); end end -# source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#279 +# source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#275 class Aws::Xml::Parser::FloatFrame < ::Aws::Xml::Parser::Frame - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#280 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#276 def result; end end @@ -14586,103 +14637,103 @@ class Aws::Xml::Parser::Frame end end -# source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#285 +# source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#281 class Aws::Xml::Parser::IntegerFrame < ::Aws::Xml::Parser::Frame - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#286 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#282 def result; end end -# source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#154 +# source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#150 class Aws::Xml::Parser::ListFrame < ::Aws::Xml::Parser::Frame # @return [ListFrame] a new instance of ListFrame # - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#156 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#152 def initialize(*args); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#162 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#158 def child_frame(xml_name); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#170 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#166 def consume_child_frame(child); end end -# source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#222 +# source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#218 class Aws::Xml::Parser::MapEntryFrame < ::Aws::Xml::Parser::Frame # @return [MapEntryFrame] a new instance of MapEntryFrame # - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#224 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#220 def initialize(xml_name, *args); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#238 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#234 def child_frame(xml_name); end # @return [StringFrame] # - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#233 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#229 def key; end # @return [Frame] # - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#236 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#232 def value; end end -# source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#201 +# source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#197 class Aws::Xml::Parser::MapFrame < ::Aws::Xml::Parser::Frame # @return [MapFrame] a new instance of MapFrame # - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#203 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#199 def initialize(*args); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#208 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#204 def child_frame(xml_name); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#216 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#212 def consume_child_frame(child); end end -# source://aws-sdk-core//lib/aws-sdk-core/xml/parser/engines/nokogiri.rb#8 +# source://aws-sdk-core//lib/aws-sdk-core/xml/parser/nokogiri_engine.rb#8 class Aws::Xml::Parser::NokogiriEngine # @return [NokogiriEngine] a new instance of NokogiriEngine # - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/engines/nokogiri.rb#10 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/nokogiri_engine.rb#10 def initialize(stack); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/engines/nokogiri.rb#32 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/nokogiri_engine.rb#32 def characters(chars); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/engines/nokogiri.rb#21 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/nokogiri_engine.rb#21 def comment(*args); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/engines/nokogiri.rb#20 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/nokogiri_engine.rb#20 def end_document; end - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/engines/nokogiri.rb#36 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/nokogiri_engine.rb#36 def end_element_namespace(*ignored); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/engines/nokogiri.rb#40 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/nokogiri_engine.rb#40 def error(msg); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/engines/nokogiri.rb#14 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/nokogiri_engine.rb#14 def parse(xml); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/engines/nokogiri.rb#19 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/nokogiri_engine.rb#19 def start_document; end - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/engines/nokogiri.rb#23 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/nokogiri_engine.rb#23 def start_element_namespace(element_name, attributes = T.unsafe(nil), *ignored); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/engines/nokogiri.rb#18 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/nokogiri_engine.rb#18 def xmldecl(*args); end end -# source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#250 +# source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#246 class Aws::Xml::Parser::NullFrame < ::Aws::Xml::Parser::Frame - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#255 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#251 def set_text(value); end class << self - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#251 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#247 def new(xml_name, parent); end end end @@ -14715,18 +14766,18 @@ class Aws::Xml::Parser::Stack # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/stack.rb#23 def attr(name, value); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/stack.rb#50 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/stack.rb#52 def child_frame(name); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/stack.rb#54 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/stack.rb#56 def consume_child_frame(frame); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/stack.rb#37 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/stack.rb#39 def end_element(*args); end # @raise [ParsingError] # - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/stack.rb#46 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/stack.rb#48 def error(msg, line = T.unsafe(nil), column = T.unsafe(nil)); end # Returns the value of attribute frame. @@ -14742,18 +14793,18 @@ class Aws::Xml::Parser::Stack # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/stack.rb#19 def start_element(name); end - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/stack.rb#33 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/stack.rb#35 def text(value); end # @api private # - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/stack.rb#59 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/stack.rb#61 def yield_unhandled_value(path, value); end end -# source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#291 +# source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#287 class Aws::Xml::Parser::StringFrame < ::Aws::Xml::Parser::Frame - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#292 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#288 def result; end end @@ -14777,25 +14828,22 @@ class Aws::Xml::Parser::StructureFrame < ::Aws::Xml::Parser::Frame # @return [Boolean] # - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#148 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#144 def flattened_list?(ref); end # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#140 def xml_name(ref); end end -# source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#297 +# source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#293 class Aws::Xml::Parser::TimestampFrame < ::Aws::Xml::Parser::Frame - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#301 - def parse(value); end - - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#298 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#294 def result; end end -# source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#261 +# source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#257 class Aws::Xml::Parser::UnknownMemberFrame < ::Aws::Xml::Parser::Frame - # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#262 + # source://aws-sdk-core//lib/aws-sdk-core/xml/parser/frame.rb#258 def result; end end @@ -14852,33 +14900,49 @@ class Seahorse::Client::AsyncResponse # source://aws-sdk-core//lib/seahorse/client/async_response.rb#7 def initialize(options = T.unsafe(nil)); end - # source://aws-sdk-core//lib/seahorse/client/async_response.rb#15 + # @return [RequestContext] + # + # source://aws-sdk-core//lib/seahorse/client/async_response.rb#16 def context; end - # source://aws-sdk-core//lib/seahorse/client/async_response.rb#19 + # @return [StandardError, nil] + # + # source://aws-sdk-core//lib/seahorse/client/async_response.rb#21 def error; end - # source://aws-sdk-core//lib/seahorse/client/async_response.rb#50 + # source://aws-sdk-core//lib/seahorse/client/async_response.rb#69 def join!; end - # source://aws-sdk-core//lib/seahorse/client/async_response.rb#23 + # @overload on + # @overload on + # @return [self] + # + # source://aws-sdk-core//lib/seahorse/client/async_response.rb#35 def on(range, &block); end - # source://aws-sdk-core//lib/seahorse/client/async_response.rb#28 + # @api private + # + # source://aws-sdk-core//lib/seahorse/client/async_response.rb#41 def on_complete(&block); end - # source://aws-sdk-core//lib/seahorse/client/async_response.rb#33 + # @return [Boolean] Returns `true` if the response is complete with + # no error. + # + # source://aws-sdk-core//lib/seahorse/client/async_response.rb#48 + def successful?; end + + # source://aws-sdk-core//lib/seahorse/client/async_response.rb#52 def wait; end end -# source://aws-sdk-core//lib/seahorse/client/base.rb#7 +# source://aws-sdk-core//lib/seahorse/client/base.rb#5 class Seahorse::Client::Base include ::Seahorse::Client::HandlerBuilder # @api private # @return [Base] a new instance of Base # - # source://aws-sdk-core//lib/seahorse/client/base.rb#21 + # source://aws-sdk-core//lib/seahorse/client/base.rb#20 def initialize(plugins, options); end # Builds and returns a {Request} for the named operation. The request @@ -14887,29 +14951,29 @@ class Seahorse::Client::Base # @param operation_name [Symbol, String] # @return [Request] # - # source://aws-sdk-core//lib/seahorse/client/base.rb#37 + # source://aws-sdk-core//lib/seahorse/client/base.rb#36 def build_request(operation_name, params = T.unsafe(nil)); end # @return [Configuration] # - # source://aws-sdk-core//lib/seahorse/client/base.rb#28 + # source://aws-sdk-core//lib/seahorse/client/base.rb#27 def config; end # @return [HandlerList] # - # source://aws-sdk-core//lib/seahorse/client/base.rb#31 + # source://aws-sdk-core//lib/seahorse/client/base.rb#30 def handlers; end # @api private # - # source://aws-sdk-core//lib/seahorse/client/base.rb#44 + # source://aws-sdk-core//lib/seahorse/client/base.rb#43 def inspect; end # @return [Array] Returns a list of valid request operation # names. These are valid arguments to {#build_request} and are also # valid methods. # - # source://aws-sdk-core//lib/seahorse/client/base.rb#51 + # source://aws-sdk-core//lib/seahorse/client/base.rb#50 def operation_names; end private @@ -14922,7 +14986,7 @@ class Seahorse::Client::Base # Constructs a {Configuration} object and gives each plugin the # opportunity to register options with default values. # - # source://aws-sdk-core//lib/seahorse/client/base.rb#59 + # source://aws-sdk-core//lib/seahorse/client/base.rb#58 def build_config(plugins, options); end # Gives each plugin the opportunity to register handlers for this client. @@ -15034,14 +15098,14 @@ class Seahorse::Client::Base def before_initialize(plugins, options); end # source://aws-sdk-core//lib/seahorse/client/base.rb#211 - def build_plugins; end + def build_plugins(plugins); end # source://aws-sdk-core//lib/seahorse/client/base.rb#199 def define_operation_methods; end # @private # - # source://aws-sdk-core//lib/seahorse/client/base.rb#221 + # source://aws-sdk-core//lib/seahorse/client/base.rb#231 def inherited(subclass); end end end @@ -15481,7 +15545,7 @@ class Seahorse::Client::H2::Handler < ::Seahorse::Client::Handler # @api private # - # source://aws-sdk-core//lib/seahorse/client/h2/handler.rb#139 + # source://aws-sdk-core//lib/seahorse/client/h2/handler.rb#140 def error_message(req, error); end end @@ -15501,7 +15565,7 @@ class Seahorse::Client::Handler def initialize(handler = T.unsafe(nil)); end # @param context [RequestContext] - # @return [Response] + # @return [Seahorse::Response] # # source://aws-sdk-core//lib/seahorse/client/handler.rb#19 def call(context); end @@ -16471,7 +16535,7 @@ class Seahorse::Client::NetHttp::ConnectionPool # @api private # @return [nil] # - # source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#133 + # source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#129 def clean!; end # Closes and removes all sessions from the pool. @@ -16482,7 +16546,7 @@ class Seahorse::Client::NetHttp::ConnectionPool # @api private # @return [nil] # - # source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#143 + # source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#139 def empty!; end # source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#51 @@ -16574,7 +16638,7 @@ class Seahorse::Client::NetHttp::ConnectionPool # @api private # @note **Must** be called behind a `@pool_mutex` synchronize block. # - # source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#313 + # source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#307 def _clean; end # Extract the parts of the http_proxy URI @@ -16582,12 +16646,12 @@ class Seahorse::Client::NetHttp::ConnectionPool # @api private # @return [Array(String)] # - # source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#265 + # source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#259 def http_proxy_parts; end # @api private # - # source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#155 + # source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#149 def remove_path_and_query(endpoint); end # Starts and returns a new HTTP(S) session. @@ -16596,7 +16660,7 @@ class Seahorse::Client::NetHttp::ConnectionPool # @param endpoint [String] # @return [Net::HTTPSession] # - # source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#277 + # source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#271 def start_session(endpoint); end class << self @@ -16619,14 +16683,14 @@ class Seahorse::Client::NetHttp::ConnectionPool # @param options [Hash] a customizable set of options # @return [ConnectionPool] # - # source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#219 + # source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#213 def for(options = T.unsafe(nil)); end # @api private # @return [Array] Returns a list of the # constructed connection pools. # - # source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#228 + # source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#222 def pools; end private @@ -16636,7 +16700,7 @@ class Seahorse::Client::NetHttp::ConnectionPool # @api private # @return [Hash] # - # source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#238 + # source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#232 def pool_options(options); end end end @@ -16646,42 +16710,42 @@ end # # @api private # -# source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#328 +# source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#322 class Seahorse::Client::NetHttp::ConnectionPool::ExtendedSession # @api private # @return [ExtendedSession] a new instance of ExtendedSession # - # source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#330 + # source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#324 def initialize(http); end # @api private # - # source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#338 + # source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#332 def __getobj__; end # @api private # - # source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#342 + # source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#336 def __setobj__(obj); end # Attempts to close/finish the session without raising an error. # # @api private # - # source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#353 + # source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#347 def finish; end # @api private # @return [Integer, nil] # - # source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#336 + # source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#330 def last_used; end # Sends the request and tracks that this session has been used. # # @api private # - # source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#347 + # source://aws-sdk-core//lib/seahorse/client/net_http/connection_pool.rb#341 def request(*args, &block); end end @@ -16833,7 +16897,7 @@ module Seahorse::Client::NetHttp::Patches end end -# For requests with bodys, Net::HTTP sets a default content type of: +# For requests with bodies, Net::HTTP sets a default content type of: # 'application/x-www-form-urlencoded' # There are cases where we should not send content type at all. # Even when no body is supplied, Net::HTTP uses a default empty body @@ -16842,11 +16906,11 @@ end # # @api private # -# source://aws-sdk-core//lib/seahorse/client/net_http/patches.rb#26 +# source://aws-sdk-core//lib/seahorse/client/net_http/patches.rb#23 module Seahorse::Client::NetHttp::Patches::PatchDefaultContentType # @api private # - # source://aws-sdk-core//lib/seahorse/client/net_http/patches.rb#27 + # source://aws-sdk-core//lib/seahorse/client/net_http/patches.rb#24 def supply_default_content_type; end end @@ -16951,73 +17015,83 @@ class Seahorse::Client::Plugin::PluginOption # @api private # - # source://aws-sdk-core//lib/seahorse/client/plugin.rb#121 + # source://aws-sdk-core//lib/seahorse/client/plugin.rb#129 def default; end # @api private # - # source://aws-sdk-core//lib/seahorse/client/plugin.rb#121 + # source://aws-sdk-core//lib/seahorse/client/plugin.rb#129 def default=(_arg0); end # @api private # - # source://aws-sdk-core//lib/seahorse/client/plugin.rb#122 + # source://aws-sdk-core//lib/seahorse/client/plugin.rb#130 def default_block; end # @api private # - # source://aws-sdk-core//lib/seahorse/client/plugin.rb#122 + # source://aws-sdk-core//lib/seahorse/client/plugin.rb#130 def default_block=(_arg0); end # @api private # - # source://aws-sdk-core//lib/seahorse/client/plugin.rb#128 + # source://aws-sdk-core//lib/seahorse/client/plugin.rb#137 def doc_default(options); end # @api private # - # source://aws-sdk-core//lib/seahorse/client/plugin.rb#125 + # source://aws-sdk-core//lib/seahorse/client/plugin.rb#133 def doc_default=(_arg0); end # @api private # - # source://aws-sdk-core//lib/seahorse/client/plugin.rb#124 + # source://aws-sdk-core//lib/seahorse/client/plugin.rb#132 def doc_type; end # @api private # - # source://aws-sdk-core//lib/seahorse/client/plugin.rb#124 + # source://aws-sdk-core//lib/seahorse/client/plugin.rb#132 def doc_type=(_arg0); end # @api private # - # source://aws-sdk-core//lib/seahorse/client/plugin.rb#126 + # source://aws-sdk-core//lib/seahorse/client/plugin.rb#134 def docstring; end # @api private # - # source://aws-sdk-core//lib/seahorse/client/plugin.rb#126 + # source://aws-sdk-core//lib/seahorse/client/plugin.rb#134 def docstring=(_arg0); end # @api private # @return [Boolean] # - # source://aws-sdk-core//lib/seahorse/client/plugin.rb#136 + # source://aws-sdk-core//lib/seahorse/client/plugin.rb#145 def documented?; end # @api private # - # source://aws-sdk-core//lib/seahorse/client/plugin.rb#120 + # source://aws-sdk-core//lib/seahorse/client/plugin.rb#128 def name; end # @api private # - # source://aws-sdk-core//lib/seahorse/client/plugin.rb#123 + # source://aws-sdk-core//lib/seahorse/client/plugin.rb#135 + def rbs_type; end + + # @api private + # + # source://aws-sdk-core//lib/seahorse/client/plugin.rb#135 + def rbs_type=(_arg0); end + + # @api private + # + # source://aws-sdk-core//lib/seahorse/client/plugin.rb#131 def required; end # @api private # - # source://aws-sdk-core//lib/seahorse/client/plugin.rb#123 + # source://aws-sdk-core//lib/seahorse/client/plugin.rb#131 def required=(_arg0); end end @@ -17161,16 +17235,16 @@ Seahorse::Client::Plugins::ContentLength::Handler::METHODS_WITHOUT_BODY = T.let( # source://aws-sdk-core//lib/seahorse/client/plugins/endpoint.rb#6 class Seahorse::Client::Plugins::Endpoint < ::Seahorse::Client::Plugin - # source://aws-sdk-core//lib/seahorse/client/plugins/endpoint.rb#23 + # source://aws-sdk-core//lib/seahorse/client/plugins/endpoint.rb#22 def add_handlers(handlers, config); end - # source://aws-sdk-core//lib/seahorse/client/plugins/endpoint.rb#27 + # source://aws-sdk-core//lib/seahorse/client/plugins/endpoint.rb#26 def after_initialize(client); end end -# source://aws-sdk-core//lib/seahorse/client/plugins/endpoint.rb#43 +# source://aws-sdk-core//lib/seahorse/client/plugins/endpoint.rb#42 class Seahorse::Client::Plugins::Endpoint::Handler < ::Seahorse::Client::Handler - # source://aws-sdk-core//lib/seahorse/client/plugins/endpoint.rb#45 + # source://aws-sdk-core//lib/seahorse/client/plugins/endpoint.rb#44 def call(context); end end @@ -17190,13 +17264,13 @@ end # source://aws-sdk-core//lib/seahorse/client/plugins/net_http.rb#8 class Seahorse::Client::Plugins::NetHttp < ::Seahorse::Client::Plugin class << self - # source://aws-sdk-core//lib/seahorse/client/plugins/net_http.rb#45 + # source://aws-sdk-core//lib/seahorse/client/plugins/net_http.rb#77 def resolve_http_open_timeout(cfg); end - # source://aws-sdk-core//lib/seahorse/client/plugins/net_http.rb#53 + # source://aws-sdk-core//lib/seahorse/client/plugins/net_http.rb#85 def resolve_http_read_timeout(cfg); end - # source://aws-sdk-core//lib/seahorse/client/plugins/net_http.rb#61 + # source://aws-sdk-core//lib/seahorse/client/plugins/net_http.rb#93 def resolve_ssl_timeout(cfg); end end end @@ -17257,26 +17331,31 @@ class Seahorse::Client::Plugins::RequestCallback < ::Seahorse::Client::Plugin; e # @api private # -# source://aws-sdk-core//lib/seahorse/client/plugins/request_callback.rb#64 +# source://aws-sdk-core//lib/seahorse/client/plugins/request_callback.rb#74 class Seahorse::Client::Plugins::RequestCallback::OptionHandler < ::Seahorse::Client::Handler # @api private # - # source://aws-sdk-core//lib/seahorse/client/plugins/request_callback.rb#65 + # source://aws-sdk-core//lib/seahorse/client/plugins/request_callback.rb#92 + def add_response_events(on_chunk_received, context); end + + # @api private + # + # source://aws-sdk-core//lib/seahorse/client/plugins/request_callback.rb#75 def call(context); end end # @api private # -# source://aws-sdk-core//lib/seahorse/client/plugins/request_callback.rb#76 +# source://aws-sdk-core//lib/seahorse/client/plugins/request_callback.rb#107 class Seahorse::Client::Plugins::RequestCallback::ReadCallbackHandler < ::Seahorse::Client::Handler # @api private # - # source://aws-sdk-core//lib/seahorse/client/plugins/request_callback.rb#77 + # source://aws-sdk-core//lib/seahorse/client/plugins/request_callback.rb#108 def call(context); end # @api private # - # source://aws-sdk-core//lib/seahorse/client/plugins/request_callback.rb#91 + # source://aws-sdk-core//lib/seahorse/client/plugins/request_callback.rb#122 def unwrap_callback_body(context); end end diff --git a/sorbet/rbi/gems/aws-sdk-ec2@1.398.0.rbi b/sorbet/rbi/gems/aws-sdk-ec2@1.467.0.rbi similarity index 100% rename from sorbet/rbi/gems/aws-sdk-ec2@1.398.0.rbi rename to sorbet/rbi/gems/aws-sdk-ec2@1.467.0.rbi diff --git a/sorbet/rbi/gems/aws-sdk-kms@1.71.0.rbi b/sorbet/rbi/gems/aws-sdk-kms@1.88.0.rbi similarity index 85% rename from sorbet/rbi/gems/aws-sdk-kms@1.71.0.rbi rename to sorbet/rbi/gems/aws-sdk-kms@1.88.0.rbi index 8bbfb569e..a46d37cc7 100644 --- a/sorbet/rbi/gems/aws-sdk-kms@1.71.0.rbi +++ b/sorbet/rbi/gems/aws-sdk-kms@1.88.0.rbi @@ -48,20 +48,20 @@ module Aws::KMS; end # # See {#initialize} for a full list of supported configuration options. # -# source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#52 +# source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#53 class Aws::KMS::Client < ::Seahorse::Client::Base include ::Aws::ClientStubs # @overload initialize # @return [Client] a new instance of Client # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#395 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#429 def initialize(*args); end # @api private # @param params [{}] # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#9882 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#10749 def build_request(operation_name, params = T.unsafe(nil)); end # Cancels the deletion of a KMS key. When this operation succeeds, the @@ -83,11 +83,15 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # **Related operations**: ScheduleKeyDeletion # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][4]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To cancel deletion of a KMS key # @@ -117,7 +121,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # * {Types::CancelKeyDeletionResponse#key_id #key_id} => String # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CancelKeyDeletion AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#473 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#511 def cancel_key_deletion(params = T.unsafe(nil), options = T.unsafe(nil)); end # Connects or reconnects a [custom key store][1] to its backing key @@ -209,6 +213,9 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * UpdateCustomKeyStore # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][8]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html @@ -218,6 +225,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html # [6]: https://docs.aws.amazon.com/kms/latest/developerguide/xks-troubleshooting.html # [7]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [8]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To connect a custom key store # @@ -244,7 +252,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ConnectCustomKeyStore AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#610 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#652 def connect_custom_key_store(params = T.unsafe(nil), options = T.unsafe(nil)); end # Creates a friendly name for a KMS key. @@ -299,6 +307,9 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * UpdateAlias # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][7]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/abac.html @@ -307,6 +318,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html # [6]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access + # [7]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To create an alias # @@ -329,7 +341,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateAlias AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#744 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#790 def create_alias(params = T.unsafe(nil), options = T.unsafe(nil)); end # Creates a [custom key store][1] backed by a key store that you own and @@ -415,6 +427,9 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * UpdateCustomKeyStore # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][10]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html @@ -426,6 +441,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # [7]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html # [8]: https://docs.aws.amazon.com/kms/latest/developerguide/xks-troubleshooting.html # [9]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [10]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To create an AWS CloudHSM key store # @@ -520,7 +536,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # * {Types::CreateCustomKeyStoreResponse#custom_key_store_id #custom_key_store_id} => String # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateCustomKeyStore AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#1129 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#1179 def create_custom_key_store(params = T.unsafe(nil), options = T.unsafe(nil)); end # Adds a grant to a KMS key. @@ -576,6 +592,9 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * RevokeGrant # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][6]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html @@ -583,6 +602,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [6]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To create a grant # @@ -608,7 +628,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # key_id: "KeyIdType", # required # grantee_principal: "PrincipalIdType", # required # retiring_principal: "PrincipalIdType", - # operations: ["Decrypt"], # required, accepts Decrypt, Encrypt, GenerateDataKey, GenerateDataKeyWithoutPlaintext, ReEncryptFrom, ReEncryptTo, Sign, Verify, GetPublicKey, CreateGrant, RetireGrant, DescribeKey, GenerateDataKeyPair, GenerateDataKeyPairWithoutPlaintext, GenerateMac, VerifyMac + # operations: ["Decrypt"], # required, accepts Decrypt, Encrypt, GenerateDataKey, GenerateDataKeyWithoutPlaintext, ReEncryptFrom, ReEncryptTo, Sign, Verify, GetPublicKey, CreateGrant, RetireGrant, DescribeKey, GenerateDataKeyPair, GenerateDataKeyPairWithoutPlaintext, GenerateMac, VerifyMac, DeriveSharedSecret # constraints: { # encryption_context_subset: { # "EncryptionContextKey" => "EncryptionContextValue", @@ -641,7 +661,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # * {Types::CreateGrantResponse#grant_id #grant_id} => String # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateGrant AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#1402 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#1456 def create_grant(params = T.unsafe(nil), options = T.unsafe(nil)); end # Creates a unique customer managed [KMS key][1] in your Amazon Web @@ -703,12 +723,17 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # key pair, or an SM2 key pair (China Regions only). The private key # in an asymmetric KMS key never leaves KMS unencrypted. However, you # can use the GetPublicKey operation to download the public key so it - # can be used outside of KMS. KMS keys with RSA or SM2 key pairs can - # be used to encrypt or decrypt data or sign and verify messages (but - # not both). KMS keys with ECC key pairs can be used only to sign and - # verify messages. For information about asymmetric KMS keys, see - # [Asymmetric KMS keys][3] in the *Key Management Service Developer - # Guide*. + # can be used outside of KMS. Each KMS key can have only one key + # usage. KMS keys with RSA key pairs can be used to encrypt and + # decrypt data or sign and verify messages (but not both). KMS keys + # with NIST-recommended ECC key pairs can be used to sign and verify + # messages or derive shared secrets (but not both). KMS keys with + # `ECC_SECG_P256K1` can be used only to sign and verify messages. KMS + # keys with SM2 key pairs (China Regions only) can be used to either + # encrypt and decrypt data, sign and verify messages, or derive shared + # secrets (you must choose one key usage type). For information about + # asymmetric KMS keys, see [Asymmetric KMS keys][3] in the *Key + # Management Service Developer Guide*. # # # @@ -849,6 +874,9 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * ScheduleKeyDeletion # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][12]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms-keys @@ -862,6 +890,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # [9]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html # [10]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html # [11]: https://docs.aws.amazon.com/kms/latest/developerguide/iam-policies.html#iam-policy-example-create-key + # [12]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To create a KMS key # @@ -1132,7 +1161,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # resp = client.create_key({ # policy: "PolicyType", # description: "DescriptionType", - # key_usage: "SIGN_VERIFY", # accepts SIGN_VERIFY, ENCRYPT_DECRYPT, GENERATE_VERIFY_MAC + # key_usage: "SIGN_VERIFY", # accepts SIGN_VERIFY, ENCRYPT_DECRYPT, GENERATE_VERIFY_MAC, KEY_AGREEMENT # customer_master_key_spec: "RSA_2048", # accepts RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SYMMETRIC_DEFAULT, HMAC_224, HMAC_256, HMAC_384, HMAC_512, SM2 # key_spec: "RSA_2048", # accepts RSA_2048, RSA_3072, RSA_4096, ECC_NIST_P256, ECC_NIST_P384, ECC_NIST_P521, ECC_SECG_P256K1, SYMMETRIC_DEFAULT, HMAC_224, HMAC_256, HMAC_384, HMAC_512, SM2 # origin: "AWS_KMS", # accepts AWS_KMS, EXTERNAL, AWS_CLOUDHSM, EXTERNAL_KEY_STORE @@ -1155,7 +1184,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # resp.key_metadata.creation_date #=> Time # resp.key_metadata.enabled #=> Boolean # resp.key_metadata.description #=> String - # resp.key_metadata.key_usage #=> String, one of "SIGN_VERIFY", "ENCRYPT_DECRYPT", "GENERATE_VERIFY_MAC" + # resp.key_metadata.key_usage #=> String, one of "SIGN_VERIFY", "ENCRYPT_DECRYPT", "GENERATE_VERIFY_MAC", "KEY_AGREEMENT" # resp.key_metadata.key_state #=> String, one of "Creating", "Enabled", "Disabled", "PendingDeletion", "PendingImport", "PendingReplicaDeletion", "Unavailable", "Updating" # resp.key_metadata.deletion_date #=> Time # resp.key_metadata.valid_to #=> Time @@ -1170,6 +1199,8 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # resp.key_metadata.encryption_algorithms[0] #=> String, one of "SYMMETRIC_DEFAULT", "RSAES_OAEP_SHA_1", "RSAES_OAEP_SHA_256", "SM2PKE" # resp.key_metadata.signing_algorithms #=> Array # resp.key_metadata.signing_algorithms[0] #=> String, one of "RSASSA_PSS_SHA_256", "RSASSA_PSS_SHA_384", "RSASSA_PSS_SHA_512", "RSASSA_PKCS1_V1_5_SHA_256", "RSASSA_PKCS1_V1_5_SHA_384", "RSASSA_PKCS1_V1_5_SHA_512", "ECDSA_SHA_256", "ECDSA_SHA_384", "ECDSA_SHA_512", "SM2DSA" + # resp.key_metadata.key_agreement_algorithms #=> Array + # resp.key_metadata.key_agreement_algorithms[0] #=> String, one of "ECDH" # resp.key_metadata.multi_region #=> Boolean # resp.key_metadata.multi_region_configuration.multi_region_key_type #=> String, one of "PRIMARY", "REPLICA" # resp.key_metadata.multi_region_configuration.primary_key.arn #=> String @@ -1199,7 +1230,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # * {Types::CreateKeyResponse#key_metadata #key_metadata} => Types::KeyMetadata # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateKey AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#2291 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#2363 def create_key(params = T.unsafe(nil), options = T.unsafe(nil)); end # Decrypts ciphertext that was encrypted by a KMS key using any of the @@ -1259,10 +1290,10 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # parameter to provide the attestation document for the enclave. Instead # of the plaintext data, the response includes the plaintext data # encrypted with the public key from the attestation document - # (`CiphertextForRecipient`).For information about the interaction + # (`CiphertextForRecipient`). For information about the interaction # between KMS and Amazon Web Services Nitro Enclaves, see [How Amazon # Web Services Nitro Enclaves uses KMS][7] in the *Key Management - # Service Developer Guide*.. + # Service Developer Guide*. # # The KMS key that you use for this operation must be in a compatible # key state. For details, see [Key states of KMS keys][8] in the *Key @@ -1284,6 +1315,9 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * ReEncrypt # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][10]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html @@ -1295,6 +1329,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # [7]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html # [8]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html # [9]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [10]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To decrypt data with a symmetric encryption KMS key # @@ -1389,7 +1424,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # * {Types::DecryptResponse#ciphertext_for_recipient #ciphertext_for_recipient} => String # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/Decrypt AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#2603 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#2679 def decrypt(params = T.unsafe(nil), options = T.unsafe(nil)); end # Deletes the specified alias. @@ -1430,11 +1465,15 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * UpdateAlias # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][4]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/abac.html # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access + # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To delete an alias # @@ -1454,7 +1493,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteAlias AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#2677 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#2757 def delete_alias(params = T.unsafe(nil), options = T.unsafe(nil)); end # Deletes a [custom key store][1]. This operation does not affect any @@ -1512,6 +1551,9 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * UpdateCustomKeyStore # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][6]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html @@ -1519,6 +1561,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [6]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To delete a custom key store from AWS KMS # @@ -1544,7 +1587,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteCustomKeyStore AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#2776 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#2860 def delete_custom_key_store(params = T.unsafe(nil), options = T.unsafe(nil)); end # Deletes key material that was previously imported. This operation @@ -1573,11 +1616,15 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * ImportKeyMaterial # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][4]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To delete imported key material # @@ -1597,9 +1644,161 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteImportedKeyMaterial AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#2850 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#2938 def delete_imported_key_material(params = T.unsafe(nil), options = T.unsafe(nil)); end + # Derives a shared secret using a key agreement algorithm. + # + # You must use an asymmetric NIST-recommended elliptic curve (ECC) or + # SM2 (China Regions only) KMS key pair with a `KeyUsage` value of + # `KEY_AGREEMENT` to call DeriveSharedSecret. + # + # + # + # DeriveSharedSecret uses the [Elliptic Curve Cryptography Cofactor + # Diffie-Hellman Primitive][1] (ECDH) to establish a key agreement + # between two peers by deriving a shared secret from their elliptic + # curve public-private key pairs. You can use the raw shared secret that + # DeriveSharedSecret returns to derive a symmetric key that can encrypt + # and decrypt data that is sent between the two peers, or that can + # generate and verify HMACs. KMS recommends that you follow [NIST + # recommendations for key derivation][2] when using the raw shared + # secret to derive a symmetric key. + # + # The following workflow demonstrates how to establish key agreement + # over an insecure communication channel using DeriveSharedSecret. + # + # 1. **Alice** calls CreateKey to create an asymmetric KMS key pair + # with a `KeyUsage` value of `KEY_AGREEMENT`. + # + # The asymmetric KMS key must use a NIST-recommended elliptic curve + # (ECC) or SM2 (China Regions only) key spec. + # + # 2. **Bob** creates an elliptic curve key pair. + # + # Bob can call CreateKey to create an asymmetric KMS key pair or + # generate a key pair outside of KMS. Bob's key pair must use the + # same NIST-recommended elliptic curve (ECC) or SM2 (China Regions + # ony) curve as Alice. + # + # 3. Alice and Bob **exchange their public keys** through an insecure + # communication channel (like the internet). + # + # Use GetPublicKey to download the public key of your asymmetric KMS + # key pair. + # + # KMS strongly recommends verifying that the public key you receive + # came from the expected party before using it to derive a shared + # secret. + # + # + # + # 4. **Alice** calls DeriveSharedSecret. + # + # KMS uses the private key from the KMS key pair generated in **Step + # 1**, Bob's public key, and the Elliptic Curve Cryptography + # Cofactor Diffie-Hellman Primitive to derive the shared secret. The + # private key in your KMS key pair never leaves KMS unencrypted. + # DeriveSharedSecret returns the raw shared secret. + # + # 5. **Bob** uses the Elliptic Curve Cryptography Cofactor + # Diffie-Hellman Primitive to calculate the same raw secret using + # his private key and Alice's public key. + # + # To derive a shared secret you must provide a key agreement algorithm, + # the private key of the caller's asymmetric NIST-recommended elliptic + # curve or SM2 (China Regions only) KMS key pair, and the public key + # from your peer's NIST-recommended elliptic curve or SM2 (China + # Regions only) key pair. The public key can be from another asymmetric + # KMS key pair or from a key pair generated outside of KMS, but both key + # pairs must be on the same elliptic curve. + # + # The KMS key that you use for this operation must be in a compatible + # key state. For details, see [Key states of KMS keys][3] in the *Key + # Management Service Developer Guide*. + # + # **Cross-account use**: Yes. To perform this operation with a KMS key + # in a different Amazon Web Services account, specify the key ARN or + # alias ARN in the value of the `KeyId` parameter. + # + # **Required permissions**: [kms:DeriveSharedSecret][4] (key policy) + # + # **Related operations:** + # + # * CreateKey + # + # * GetPublicKey + # + # * DescribeKey + # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][5]. + # + # + # + # [1]: https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-56Ar3.pdf#page=60 + # [2]: https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-56Cr2.pdf + # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html + # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html + # + # @example Example: To derive a shared secret + # + # # The following example derives a shared secret using a key agreement algorithm. + # + # resp = client.derive_shared_secret({ + # key_agreement_algorithm: "ECDH", # The key agreement algorithm used to derive the shared secret. The only valid value is ECDH. + # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The key identifier for an asymmetric KMS key pair. The private key in the specified key pair is used to derive the shared secret. + # public_key: "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvH3Yj0wbkLEpUl95Cv1cJVjsVNSjwGq3tCLnzXfhVwVvmzGN8pYj3U8nKwgouaHbBWNJYjP5VutbbkKS4Kv4GojwZBJyHN17kmxo8yTjRmjR15SKIQ8cqRA2uaERMLnpztIXdZp232PQPbWGxDyXYJ0aJ5EFSag", # The public key in your peer's asymmetric key pair. + # }) + # + # resp.to_h outputs the following: + # { + # key_agreement_algorithm: "ECDH", # The key agreement algorithm used to derive the shared secret. + # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The asymmetric KMS key pair used to derive the shared secret. + # key_origin: "AWS_KMS", # The source of the key material for the specified KMS key. + # shared_secret: "MEYCIQCKZLWyTk5runarx6XiAkU9gv3lbwPO/pHa+DXFehzdDwIhANwpsIV2g/9SPWLLsF6p/hiSskuIXMTRwqrMdVKWTMHG", # The raw secret derived from the specified key agreement algorithm, private key in the asymmetric KMS key, and your peer's public key. + # } + # @example Request syntax with placeholder values + # + # resp = client.derive_shared_secret({ + # key_id: "KeyIdType", # required + # key_agreement_algorithm: "ECDH", # required, accepts ECDH + # public_key: "data", # required + # grant_tokens: ["GrantTokenType"], + # dry_run: false, + # recipient: { + # key_encryption_algorithm: "RSAES_OAEP_SHA_256", # accepts RSAES_OAEP_SHA_256 + # attestation_document: "data", + # }, + # }) + # @example Response structure + # + # resp.key_id #=> String + # resp.shared_secret #=> String + # resp.ciphertext_for_recipient #=> String + # resp.key_agreement_algorithm #=> String, one of "ECDH" + # resp.key_origin #=> String, one of "AWS_KMS", "EXTERNAL", "AWS_CLOUDHSM", "EXTERNAL_KEY_STORE" + # @option params + # @option params + # @option params + # @option params + # @option params + # @option params + # @overload derive_shared_secret + # @param params [Hash] ({}) + # @return [Types::DeriveSharedSecretResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::DeriveSharedSecretResponse#key_id #key_id} => String + # * {Types::DeriveSharedSecretResponse#shared_secret #shared_secret} => String + # * {Types::DeriveSharedSecretResponse#ciphertext_for_recipient #ciphertext_for_recipient} => String + # * {Types::DeriveSharedSecretResponse#key_agreement_algorithm #key_agreement_algorithm} => String + # * {Types::DeriveSharedSecretResponse#key_origin #key_origin} => String + # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeriveSharedSecret AWS API Documentation + # + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#3202 + def derive_shared_secret(params = T.unsafe(nil), options = T.unsafe(nil)); end + # Gets information about [custom key stores][1] in the account and # Region. # @@ -1653,12 +1852,16 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * UpdateCustomKeyStore # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][5]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/xks-troubleshooting.html # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # @@ -1794,7 +1997,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # * {Types::DescribeCustomKeyStoresResponse#truncated #truncated} => Boolean # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DescribeCustomKeyStores AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#3081 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#3437 def describe_custom_key_stores(params = T.unsafe(nil), options = T.unsafe(nil)); end # Provides detailed information about a KMS key. You can run @@ -1808,15 +2011,11 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # also displays the key usage (encryption, signing, or generating and # verifying MACs) and the algorithms that the KMS key supports. # - # For [multi-Region - # keys](kms/latest/developerguide/multi-region-keys-overview.html), - # `DescribeKey` displays the primary key and all related replica keys. - # For KMS keys in [CloudHSM key - # stores](kms/latest/developerguide/keystore-cloudhsm.html), it includes - # information about the key store, such as the key store ID and the - # CloudHSM cluster ID. For KMS keys in [external key - # stores](kms/latest/developerguide/keystore-external.html), it includes - # the custom key store ID and the ID of the external key. + # For [multi-Region keys][3], `DescribeKey` displays the primary key and + # all related replica keys. For KMS keys in [CloudHSM key stores][4], it + # includes information about the key store, such as the key store ID and + # the CloudHSM cluster ID. For KMS keys in [external key stores][5], it + # includes the custom key store ID and the ID of the external key. # # `DescribeKey` does not return the following information: # @@ -1826,7 +2025,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # * Whether automatic key rotation is enabled on the KMS key. To get # this information, use GetKeyRotationStatus. Also, some key states # prevent a KMS key from being automatically rotated. For details, see - # [How Automatic Key Rotation Works][3] in the *Key Management Service + # [How Automatic Key Rotation Works][6] in the *Key Management Service # Developer Guide*. # # * Tags on the KMS key. To get this information, use ListResourceTags. @@ -1843,7 +2042,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # in a different Amazon Web Services account, specify the key ARN or # alias ARN in the value of the `KeyId` parameter. # - # **Required permissions**: [kms:DescribeKey][4] (key policy) + # **Required permissions**: [kms:DescribeKey][7] (key policy) # # **Related operations:** # @@ -1861,12 +2060,19 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * ListRetirableGrants # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][8]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk - # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-how-it-works - # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html + # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-cloudhsm.html + # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html + # [6]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-how-it-works + # [7]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [8]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To get details about a KMS key # @@ -2087,7 +2293,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # resp.key_metadata.creation_date #=> Time # resp.key_metadata.enabled #=> Boolean # resp.key_metadata.description #=> String - # resp.key_metadata.key_usage #=> String, one of "SIGN_VERIFY", "ENCRYPT_DECRYPT", "GENERATE_VERIFY_MAC" + # resp.key_metadata.key_usage #=> String, one of "SIGN_VERIFY", "ENCRYPT_DECRYPT", "GENERATE_VERIFY_MAC", "KEY_AGREEMENT" # resp.key_metadata.key_state #=> String, one of "Creating", "Enabled", "Disabled", "PendingDeletion", "PendingImport", "PendingReplicaDeletion", "Unavailable", "Updating" # resp.key_metadata.deletion_date #=> Time # resp.key_metadata.valid_to #=> Time @@ -2102,6 +2308,8 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # resp.key_metadata.encryption_algorithms[0] #=> String, one of "SYMMETRIC_DEFAULT", "RSAES_OAEP_SHA_1", "RSAES_OAEP_SHA_256", "SM2PKE" # resp.key_metadata.signing_algorithms #=> Array # resp.key_metadata.signing_algorithms[0] #=> String, one of "RSASSA_PSS_SHA_256", "RSASSA_PSS_SHA_384", "RSASSA_PSS_SHA_512", "RSASSA_PKCS1_V1_5_SHA_256", "RSASSA_PKCS1_V1_5_SHA_384", "RSASSA_PKCS1_V1_5_SHA_512", "ECDSA_SHA_256", "ECDSA_SHA_384", "ECDSA_SHA_512", "SM2DSA" + # resp.key_metadata.key_agreement_algorithms #=> Array + # resp.key_metadata.key_agreement_algorithms[0] #=> String, one of "ECDH" # resp.key_metadata.multi_region #=> Boolean # resp.key_metadata.multi_region_configuration.multi_region_key_type #=> String, one of "PRIMARY", "REPLICA" # resp.key_metadata.multi_region_configuration.primary_key.arn #=> String @@ -2122,7 +2330,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # * {Types::DescribeKeyResponse#key_metadata #key_metadata} => Types::KeyMetadata # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DescribeKey AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#3463 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#3824 def describe_key(params = T.unsafe(nil), options = T.unsafe(nil)); end # Sets the state of a KMS key to disabled. This change temporarily @@ -2143,11 +2351,15 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # **Related operations**: EnableKey # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][4]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To disable a KMS key # @@ -2167,7 +2379,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisableKey AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#3528 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#3893 def disable_key(params = T.unsafe(nil), options = T.unsafe(nil)); end # Disables [automatic rotation of the key material][1] of the specified @@ -2207,6 +2419,13 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * GetKeyRotationStatus # + # * ListKeyRotations + # + # * RotateKeyOnDemand + # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][12]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html @@ -2220,6 +2439,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # [9]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk # [10]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html # [11]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [12]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To disable automatic rotation of key material # @@ -2239,7 +2459,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisableKeyRotation AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#3630 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#4003 def disable_key_rotation(params = T.unsafe(nil), options = T.unsafe(nil)); end # Disconnects the [custom key store][1] from its backing key store. This @@ -2289,11 +2509,15 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * UpdateCustomKeyStore # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][4]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To disconnect a custom key store from its CloudHSM cluster # @@ -2320,7 +2544,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisconnectCustomKeyStore AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#3721 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#4098 def disconnect_custom_key_store(params = T.unsafe(nil), options = T.unsafe(nil)); end # Sets the key state of a KMS key to enabled. This allows you to use the @@ -2337,11 +2561,15 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # **Related operations**: DisableKey # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][4]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To enable a KMS key # @@ -2361,18 +2589,26 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EnableKey AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#3782 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#4163 def enable_key(params = T.unsafe(nil), options = T.unsafe(nil)); end # Enables [automatic rotation of the key material][1] of the specified # symmetric encryption KMS key. # - # When you enable automatic rotation of a[customer managed KMS key][2], - # KMS rotates the key material of the KMS key one year (approximately - # 365 days) from the enable date and every year thereafter. You can - # monitor rotation of the key material for your KMS keys in CloudTrail - # and Amazon CloudWatch. To disable rotation of the key material in a - # customer managed KMS key, use the DisableKeyRotation operation. + # By default, when you enable automatic rotation of a [customer managed + # KMS key][2], KMS rotates the key material of the KMS key one year + # (approximately 365 days) from the enable date and every year + # thereafter. You can use the optional `RotationPeriodInDays` parameter + # to specify a custom rotation period when you enable key rotation, or + # you can use `RotationPeriodInDays` to modify the rotation period of a + # key that you previously enabled automatic key rotation on. + # + # You can monitor rotation of the key material for your KMS keys in + # CloudTrail and Amazon CloudWatch. To disable rotation of the key + # material in a customer managed KMS key, use the DisableKeyRotation + # operation. You can use the GetKeyRotationStatus operation to identify + # any in progress rotations. You can use the ListKeyRotations operation + # to view the details of completed rotations. # # Automatic key rotation is supported only on [symmetric encryption KMS # keys][3]. You cannot enable automatic rotation of [asymmetric KMS @@ -2381,10 +2617,11 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # disable automatic rotation of a set of related [multi-Region keys][8], # set the property on the primary key. # - # You cannot enable or disable automatic rotation [Amazon Web Services - # managed KMS keys][9]. KMS always rotates the key material of Amazon - # Web Services managed keys every year. Rotation of [Amazon Web Services - # owned KMS keys][10] varies. + # You cannot enable or disable automatic rotation of [Amazon Web + # Services managed KMS keys][9]. KMS always rotates the key material of + # Amazon Web Services managed keys every year. Rotation of [Amazon Web + # Services owned KMS keys][10] is managed by the Amazon Web Services + # service that owns the key. # # In May 2022, KMS changed the rotation schedule for Amazon Web Services # managed keys from every three years (approximately 1,095 days) to @@ -2413,9 +2650,22 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * GetKeyRotationStatus # + # * ListKeyRotations # + # * RotateKeyOnDemand # - # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html + # You can perform on-demand (RotateKeyOnDemand) rotation of the key + # material in customer managed KMS keys, regardless of whether or not + # automatic key rotation is enabled. + # + # + # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][13]. + # + # + # + # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotating-keys-enable-disable # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html @@ -2427,26 +2677,30 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # [10]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk # [11]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html # [12]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [13]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To enable automatic rotation of key material # - # # The following example enables automatic annual rotation of the key material for the specified KMS key. + # # The following example enables automatic rotation with a rotation period of 365 days for the specified KMS key. # # resp = client.enable_key_rotation({ - # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the KMS key whose key material will be rotated annually. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key. + # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the KMS key whose key material will be automatically rotated. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key. + # rotation_period_in_days: 365, # The number of days between each rotation date. Specify a value between 9 and 2560. If no value is specified, the default value is 365 days. # }) # @example Request syntax with placeholder values # # resp = client.enable_key_rotation({ # key_id: "KeyIdType", # required + # rotation_period_in_days: 1, # }) # @option params + # @option params # @overload enable_key_rotation # @param params [Hash] ({}) # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EnableKeyRotation AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#3899 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#4324 def enable_key_rotation(params = T.unsafe(nil), options = T.unsafe(nil)); end # Encrypts plaintext of up to 4,096 bytes using a KMS key. You can use a @@ -2531,11 +2785,15 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * GenerateDataKeyPair # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][4]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To encrypt data with a symmetric encryption KMS key # @@ -2601,7 +2859,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # * {Types::EncryptResponse#encryption_algorithm #encryption_algorithm} => String # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/Encrypt AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#4146 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#4575 def encrypt(params = T.unsafe(nil), options = T.unsafe(nil)); end # Returns a unique symmetric data key for use outside of KMS. This @@ -2703,6 +2961,9 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * GenerateDataKeyWithoutPlaintext # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][10]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context @@ -2714,6 +2975,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # [7]: https://docs.aws.amazon.com/dynamodb-encryption-client/latest/devguide/ # [8]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html # [9]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [10]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To generate a data key # @@ -2794,7 +3056,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # * {Types::GenerateDataKeyResponse#ciphertext_for_recipient #ciphertext_for_recipient} => String # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKey AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#4457 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#4890 def generate_data_key(params = T.unsafe(nil), options = T.unsafe(nil)); end # Returns a unique asymmetric data key pair for use outside of KMS. This @@ -2802,8 +3064,9 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # a copy of the private key that is encrypted under the symmetric # encryption KMS key you specify. You can use the data key pair to # perform asymmetric cryptography and implement digital signatures - # outside of KMS. The bytes in the keys are random; they not related to - # the caller or to the KMS key that is used to encrypt the private key. + # outside of KMS. The bytes in the keys are random; they are not related + # to the caller or to the KMS key that is used to encrypt the private + # key. # # You can use the public key that `GenerateDataKeyPair` returns to # encrypt data or verify a signature outside of KMS. Then, store the @@ -2884,6 +3147,9 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * GenerateDataKeyWithoutPlaintext # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][9]. + # # # # [1]: https://tools.ietf.org/html/rfc5280 @@ -2894,6 +3160,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # [6]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context # [7]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html # [8]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [9]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To generate an RSA key pair for encryption and decryption # @@ -2980,7 +3247,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # * {Types::GenerateDataKeyPairResponse#ciphertext_for_recipient #ciphertext_for_recipient} => String # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyPair AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#4755 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#5196 def generate_data_key_pair(params = T.unsafe(nil), options = T.unsafe(nil)); end # Returns a unique asymmetric data key pair for use outside of KMS. This @@ -3045,12 +3312,16 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * GenerateDataKeyWithoutPlaintext # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][5]. + # # # # [1]: https://tools.ietf.org/html/rfc5280 # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To generate an asymmetric data key pair without a plaintext key # @@ -3101,7 +3372,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # * {Types::GenerateDataKeyPairWithoutPlaintextResponse#key_pair_spec #key_pair_spec} => String # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyPairWithoutPlaintext AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#4959 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#5404 def generate_data_key_pair_without_plaintext(params = T.unsafe(nil), options = T.unsafe(nil)); end # Returns a unique symmetric data key for use outside of KMS. This @@ -3178,11 +3449,15 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * GenerateDataKeyPairWithoutPlaintext # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][4]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To generate an encrypted data key # @@ -3229,7 +3504,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # * {Types::GenerateDataKeyWithoutPlaintextResponse#key_id #key_id} => String # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyWithoutPlaintext AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#5170 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#5619 def generate_data_key_without_plaintext(params = T.unsafe(nil), options = T.unsafe(nil)); end # Generates a hash-based message authentication code (HMAC) for a @@ -3267,12 +3542,16 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # **Related operations**: VerifyMac # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][5]. + # # # # [1]: https://datatracker.ietf.org/doc/html/rfc2104 # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To generate an HMAC for a message # @@ -3319,7 +3598,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # * {Types::GenerateMacResponse#key_id #key_id} => String # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateMac AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#5312 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#5765 def generate_mac(params = T.unsafe(nil), options = T.unsafe(nil)); end # Returns a random byte string that is cryptographically secure. @@ -3351,6 +3630,9 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # **Required permissions**: [kms:GenerateRandom][5] (IAM policy) # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][6]. + # # # # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave.html @@ -3358,6 +3640,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html # [4]: https://docs.aws.amazon.com/kms/latest/cryptographic-details/ # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [6]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To generate random data # @@ -3415,7 +3698,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # * {Types::GenerateRandomResponse#ciphertext_for_recipient #ciphertext_for_recipient} => String # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateRandom AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#5451 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#5908 def generate_random(params = T.unsafe(nil), options = T.unsafe(nil)); end # Gets a key policy attached to the specified KMS key. @@ -3425,11 +3708,16 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # **Required permissions**: [kms:GetKeyPolicy][1] (key policy) # - # **Related operations**: PutKeyPolicy + # **Related operations**: [PutKeyPolicy][2] + # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][3]. # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [2]: https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html + # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To retrieve a key policy # @@ -3448,11 +3736,12 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # resp = client.get_key_policy({ # key_id: "KeyIdType", # required - # policy_name: "PolicyNameType", # required + # policy_name: "PolicyNameType", # }) # @example Response structure # # resp.policy #=> String + # resp.policy_name #=> String # @option params # @option params # @overload get_key_policy @@ -3460,19 +3749,16 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # @return [Types::GetKeyPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetKeyPolicyResponse#policy #policy} => String + # * {Types::GetKeyPolicyResponse#policy_name #policy_name} => String # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyPolicy AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#5522 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#5987 def get_key_policy(params = T.unsafe(nil), options = T.unsafe(nil)); end - # Gets a Boolean value that indicates whether [automatic rotation of the - # key material][1] is enabled for the specified KMS key. - # - # When you enable automatic rotation for [customer managed KMS keys][2], - # KMS rotates the key material of the KMS key one year (approximately - # 365 days) from the enable date and every year thereafter. You can - # monitor rotation of the key material for your KMS keys in CloudTrail - # and Amazon CloudWatch. + # Provides detailed information about the rotation status for a KMS key, + # including whether [automatic rotation of the key material][1] is + # enabled for the specified KMS key, the [rotation period][2], and the + # next scheduled rotation date. # # Automatic key rotation is supported only on [symmetric encryption KMS # keys][3]. You cannot enable automatic rotation of [asymmetric KMS @@ -3488,6 +3774,13 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # Services managed KMS keys every year. The key rotation status for # Amazon Web Services managed KMS keys is always `true`. # + # You can perform on-demand (RotateKeyOnDemand) rotation of the key + # material in customer managed KMS keys, regardless of whether or not + # automatic key rotation is enabled. You can use GetKeyRotationStatus to + # identify the date and time that an in progress on-demand rotation was + # initiated. You can use ListKeyRotations to view the details of + # completed rotations. + # # In May 2022, KMS changed the rotation schedule for Amazon Web Services # managed keys from every three years to every year. For details, see # EnableKeyRotation. @@ -3524,10 +3817,17 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * EnableKeyRotation # + # * ListKeyRotations + # + # * RotateKeyOnDemand + # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][12]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html - # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk + # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotation-period # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html @@ -3537,10 +3837,12 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # [9]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk # [10]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html # [11]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [12]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To retrieve the rotation status for a KMS key # - # # The following example retrieves the status of automatic annual rotation of the key material for the specified KMS key. + # # The following example retrieves detailed information about the rotation status for a KMS key, including whether + # # automatic key rotation is enabled for the specified KMS key, the rotation period, and the next scheduled rotation date. # # resp = client.get_key_rotation_status({ # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the KMS key whose key material rotation status you want to retrieve. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key. @@ -3548,7 +3850,11 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # resp.to_h outputs the following: # { - # key_rotation_enabled: true, # A boolean that indicates the key material rotation status. Returns true when automatic annual rotation of the key material is enabled, or false when it is not. + # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # Identifies the specified symmetric encryption KMS key. + # key_rotation_enabled: true, # A boolean that indicates the key material rotation status. Returns true when automatic rotation of the key material is enabled, or false when it is not. + # next_rotation_date: Time.parse("2024-04-05T15:14:47.757000+00:00"), # The next date that the key material will be automatically rotated. + # on_demand_rotation_start_date: Time.parse("2024-03-02T10:11:36.564000+00:00"), # Identifies the date and time that an in progress on-demand rotation was initiated. + # rotation_period_in_days: 365, # The number of days between each automatic rotation. The default value is 365 days. # } # @example Request syntax with placeholder values # @@ -3558,15 +3864,23 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # @example Response structure # # resp.key_rotation_enabled #=> Boolean + # resp.key_id #=> String + # resp.rotation_period_in_days #=> Integer + # resp.next_rotation_date #=> Time + # resp.on_demand_rotation_start_date #=> Time # @option params # @overload get_key_rotation_status # @param params [Hash] ({}) # @return [Types::GetKeyRotationStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetKeyRotationStatusResponse#key_rotation_enabled #key_rotation_enabled} => Boolean + # * {Types::GetKeyRotationStatusResponse#key_id #key_id} => String + # * {Types::GetKeyRotationStatusResponse#rotation_period_in_days #rotation_period_in_days} => Integer + # * {Types::GetKeyRotationStatusResponse#next_rotation_date #next_rotation_date} => Time + # * {Types::GetKeyRotationStatusResponse#on_demand_rotation_start_date #on_demand_rotation_start_date} => Time # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyRotationStatus AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#5648 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#6137 def get_key_rotation_status(params = T.unsafe(nil), options = T.unsafe(nil)); end # Returns the public key and an import token you need to import or @@ -3584,14 +3898,11 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # material. You can import key material for a symmetric encryption KMS # key, HMAC KMS key, asymmetric encryption KMS key, or asymmetric # signing KMS key. You can also import key material into a [multi-Region - # key](kms/latest/developerguide/multi-region-keys-overview.html) of any - # supported type. However, you can't import key material into a KMS key - # in a [custom key - # store](kms/latest/developerguide/custom-key-store-overview.html). You - # can also use `GetParametersForImport` to get a public key and import - # token to [reimport the original key - # material](kms/latest/developerguide/importing-keys.html#reimport-key-material) - # into a KMS key whose key material expired or was deleted. + # key][2] of any supported type. However, you can't import key material + # into a KMS key in a [custom key store][3]. You can also use + # `GetParametersForImport` to get a public key and import token to + # [reimport the original key material][4] into a KMS key whose key + # material expired or was deleted. # # `GetParametersForImport` returns the items that you need to import # your key material. @@ -3628,13 +3939,13 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # algorithm each time you import or reimport the same key material. # # The KMS key that you use for this operation must be in a compatible - # key state. For details, see [Key states of KMS keys][2] in the *Key + # key state. For details, see [Key states of KMS keys][5] in the *Key # Management Service Developer Guide*. # # **Cross-account use**: No. You cannot perform this operation on a KMS # key in a different Amazon Web Services account. # - # **Required permissions**: [kms:GetParametersForImport][3] (key policy) + # **Required permissions**: [kms:GetParametersForImport][6] (key policy) # # **Related operations:** # @@ -3642,11 +3953,18 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * DeleteImportedKeyMaterial # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][7]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html - # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html - # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html + # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html + # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#reimport-key-material + # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html + # [6]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [7]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To download the public key and import token for a symmetric encryption KMS key # @@ -3726,8 +4044,8 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # resp = client.get_parameters_for_import({ # key_id: "KeyIdType", # required - # wrapping_algorithm: "RSAES_PKCS1_V1_5", # required, accepts RSAES_PKCS1_V1_5, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256, RSA_AES_KEY_WRAP_SHA_1, RSA_AES_KEY_WRAP_SHA_256 - # wrapping_key_spec: "RSA_2048", # required, accepts RSA_2048, RSA_3072, RSA_4096 + # wrapping_algorithm: "RSAES_PKCS1_V1_5", # required, accepts RSAES_PKCS1_V1_5, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256, RSA_AES_KEY_WRAP_SHA_1, RSA_AES_KEY_WRAP_SHA_256, SM2PKE + # wrapping_key_spec: "RSA_2048", # required, accepts RSA_2048, RSA_3072, RSA_4096, SM2 # }) # @example Response structure # @@ -3748,7 +4066,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # * {Types::GetParametersForImportResponse#parameters_valid_to #parameters_valid_to} => Time # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetParametersForImport AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#5904 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#6397 def get_parameters_for_import(params = T.unsafe(nil), options = T.unsafe(nil)); end # Returns the public key of an asymmetric KMS key. Unlike the private @@ -3774,7 +4092,8 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # * [KeySpec][2]: The type of key material in the public key, such as # `RSA_4096` or `ECC_NIST_P521`. # - # * [KeyUsage][3]: Whether the key is used for encryption or signing. + # * [KeyUsage][3]: Whether the key is used for encryption, signing, or + # deriving a shared secret. # # * [EncryptionAlgorithms][4] or [SigningAlgorithms][5]: A list of the # encryption algorithms or the signing algorithms for the key. @@ -3804,6 +4123,9 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # **Related operations**: CreateKey # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][9]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html @@ -3814,6 +4136,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # [6]: https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-sm-offline-verification # [7]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html # [8]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [9]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To download the public key of an asymmetric KMS key # @@ -3848,11 +4171,13 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # resp.public_key #=> String # resp.customer_master_key_spec #=> String, one of "RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521", "ECC_SECG_P256K1", "SYMMETRIC_DEFAULT", "HMAC_224", "HMAC_256", "HMAC_384", "HMAC_512", "SM2" # resp.key_spec #=> String, one of "RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521", "ECC_SECG_P256K1", "SYMMETRIC_DEFAULT", "HMAC_224", "HMAC_256", "HMAC_384", "HMAC_512", "SM2" - # resp.key_usage #=> String, one of "SIGN_VERIFY", "ENCRYPT_DECRYPT", "GENERATE_VERIFY_MAC" + # resp.key_usage #=> String, one of "SIGN_VERIFY", "ENCRYPT_DECRYPT", "GENERATE_VERIFY_MAC", "KEY_AGREEMENT" # resp.encryption_algorithms #=> Array # resp.encryption_algorithms[0] #=> String, one of "SYMMETRIC_DEFAULT", "RSAES_OAEP_SHA_1", "RSAES_OAEP_SHA_256", "SM2PKE" # resp.signing_algorithms #=> Array # resp.signing_algorithms[0] #=> String, one of "RSASSA_PSS_SHA_256", "RSASSA_PSS_SHA_384", "RSASSA_PSS_SHA_512", "RSASSA_PKCS1_V1_5_SHA_256", "RSASSA_PKCS1_V1_5_SHA_384", "RSASSA_PKCS1_V1_5_SHA_512", "ECDSA_SHA_256", "ECDSA_SHA_384", "ECDSA_SHA_512", "SM2DSA" + # resp.key_agreement_algorithms #=> Array + # resp.key_agreement_algorithms[0] #=> String, one of "ECDH" # @option params # @option params # @overload get_public_key @@ -3866,9 +4191,10 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # * {Types::GetPublicKeyResponse#key_usage #key_usage} => String # * {Types::GetPublicKeyResponse#encryption_algorithms #encryption_algorithms} => Array<String> # * {Types::GetPublicKeyResponse#signing_algorithms #signing_algorithms} => Array<String> + # * {Types::GetPublicKeyResponse#key_agreement_algorithms #key_agreement_algorithms} => Array<String> # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetPublicKey AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#6064 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#6565 def get_public_key(params = T.unsafe(nil), options = T.unsafe(nil)); end # Imports or reimports key material into an existing KMS key that was @@ -3887,9 +4213,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # import different key material. You might reimport key material to # replace key material that expired or key material that you deleted. # You might also reimport key material to change the expiration model or - # expiration date of the key material. Before reimporting key material, - # if necessary, call DeleteImportedKeyMaterial to delete the current - # imported key material. + # expiration date of the key material. # # Each time you import key material into KMS, you can determine whether # (`ExpirationModel`) and when (`ValidTo`) the key material expires. To @@ -3984,6 +4308,9 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * GetParametersForImport # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][7]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html @@ -3992,6 +4319,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#importing-keys-overview # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html # [6]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [7]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To import key material into a KMS key # @@ -4034,7 +4362,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ImportKeyMaterial AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#6305 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#6808 def import_key_material(params = T.unsafe(nil), options = T.unsafe(nil)); end # Gets a list of aliases in the caller's Amazon Web Services account @@ -4073,11 +4401,15 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * UpdateAlias # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][4]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#aliases-limit # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access + # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # @@ -4163,7 +4495,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # * {Types::ListAliasesResponse#truncated #truncated} => Boolean # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListAliases AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#6470 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#6977 def list_aliases(params = T.unsafe(nil), options = T.unsafe(nil)); end # Gets a list of all grants for the specified KMS key. @@ -4201,12 +4533,16 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * RevokeGrant # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][5]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html # [3]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # @@ -4295,7 +4631,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # resp.grants[0].retiring_principal #=> String # resp.grants[0].issuing_account #=> String # resp.grants[0].operations #=> Array - # resp.grants[0].operations[0] #=> String, one of "Decrypt", "Encrypt", "GenerateDataKey", "GenerateDataKeyWithoutPlaintext", "ReEncryptFrom", "ReEncryptTo", "Sign", "Verify", "GetPublicKey", "CreateGrant", "RetireGrant", "DescribeKey", "GenerateDataKeyPair", "GenerateDataKeyPairWithoutPlaintext", "GenerateMac", "VerifyMac" + # resp.grants[0].operations[0] #=> String, one of "Decrypt", "Encrypt", "GenerateDataKey", "GenerateDataKeyWithoutPlaintext", "ReEncryptFrom", "ReEncryptTo", "Sign", "Verify", "GetPublicKey", "CreateGrant", "RetireGrant", "DescribeKey", "GenerateDataKeyPair", "GenerateDataKeyPairWithoutPlaintext", "GenerateMac", "VerifyMac", "DeriveSharedSecret" # resp.grants[0].constraints.encryption_context_subset #=> Hash # resp.grants[0].constraints.encryption_context_subset["EncryptionContextKey"] #=> String # resp.grants[0].constraints.encryption_context_equals #=> Hash @@ -4316,7 +4652,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # * {Types::ListGrantsResponse#truncated #truncated} => Boolean # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListGrants AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#6663 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#7174 def list_grants(params = T.unsafe(nil), options = T.unsafe(nil)); end # Gets the names of the key policies that are attached to a KMS key. @@ -4333,11 +4669,16 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * GetKeyPolicy # - # * PutKeyPolicy + # * [PutKeyPolicy][2] + # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][3]. # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [2]: https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html + # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # @@ -4381,9 +4722,99 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # * {Types::ListKeyPoliciesResponse#truncated #truncated} => Boolean # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeyPolicies AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#6763 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#7279 def list_key_policies(params = T.unsafe(nil), options = T.unsafe(nil)); end + # Returns information about all completed key material rotations for the + # specified KMS key. + # + # You must specify the KMS key in all requests. You can refine the key + # rotations list by limiting the number of rotations returned. + # + # For detailed information about automatic and on-demand key rotations, + # see [Rotating KMS keys][1] in the *Key Management Service Developer + # Guide*. + # + # **Cross-account use**: No. You cannot perform this operation on a KMS + # key in a different Amazon Web Services account. + # + # **Required permissions**: [kms:ListKeyRotations][2] (key policy) + # + # **Related operations:** + # + # * EnableKeyRotation + # + # * DisableKeyRotation + # + # * GetKeyRotationStatus + # + # * RotateKeyOnDemand + # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][3]. + # + # + # + # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html + # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html + # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # + # @example Example: To retrieve information about all completed key material rotations + # + # # The following example returns information about all completed key material rotations for the specified KMS key. + # + # resp = client.list_key_rotations({ + # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", + # }) + # + # resp.to_h outputs the following: + # { + # rotations: [ + # { + # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", + # rotation_date: Time.parse("2024-03-02T10:11:36.564000+00:00"), + # rotation_type: "AUTOMATIC", + # }, + # { + # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", + # rotation_date: Time.parse("2024-04-05T15:14:47.757000+00:00"), + # rotation_type: "ON_DEMAND", + # }, + # ], # A list of key rotations. + # truncated: false, # A flag that indicates whether there are more items in the list. When the value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request. + # } + # @example Request syntax with placeholder values + # + # resp = client.list_key_rotations({ + # key_id: "KeyIdType", # required + # limit: 1, + # marker: "MarkerType", + # }) + # @example Response structure + # + # resp.rotations #=> Array + # resp.rotations[0].key_id #=> String + # resp.rotations[0].rotation_date #=> Time + # resp.rotations[0].rotation_type #=> String, one of "AUTOMATIC", "ON_DEMAND" + # resp.next_marker #=> String + # resp.truncated #=> Boolean + # @option params + # @option params + # @option params + # @overload list_key_rotations + # @param params [Hash] ({}) + # @return [Types::ListKeyRotationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::ListKeyRotationsResponse#rotations #rotations} => Array<Types::RotationsListEntry> + # * {Types::ListKeyRotationsResponse#next_marker #next_marker} => String + # * {Types::ListKeyRotationsResponse#truncated #truncated} => Boolean + # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeyRotations AWS API Documentation + # + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#7402 + def list_key_rotations(params = T.unsafe(nil), options = T.unsafe(nil)); end + # Gets a list of all KMS keys in the caller's Amazon Web Services # account and Region. # @@ -4402,9 +4833,13 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * ListResourceTags # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][2]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # @@ -4473,7 +4908,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # * {Types::ListKeysResponse#truncated #truncated} => Boolean # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeys AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#6874 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#7517 def list_keys(params = T.unsafe(nil), options = T.unsafe(nil)); end # Returns all tags on the specified KMS key. @@ -4498,11 +4933,15 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * UntagResource # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][4]. + # # # # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # @@ -4558,7 +4997,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # * {Types::ListResourceTagsResponse#truncated #truncated} => Boolean # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListResourceTags AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#6994 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#7641 def list_resource_tags(params = T.unsafe(nil), options = T.unsafe(nil)); end # Returns information about all grants in the Amazon Web Services @@ -4576,14 +5015,25 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # programming languages, see [Programming grants][2]. # # **Cross-account use**: You must specify a principal in your Amazon Web - # Services account. However, this operation can return grants in any - # Amazon Web Services account. You do not need `kms:ListRetirableGrants` - # permission (or any other additional permission) in any Amazon Web - # Services account other than your own. + # Services account. This operation returns a list of grants where the + # retiring principal specified in the `ListRetirableGrants` request is + # the same retiring principal on the grant. This can include grants on + # KMS keys owned by other Amazon Web Services accounts, but you do not + # need `kms:ListRetirableGrants` permission (or any other additional + # permission) in any Amazon Web Services account other than your own. # # **Required permissions**: [kms:ListRetirableGrants][3] (IAM policy) in # your Amazon Web Services account. # + # KMS authorizes `ListRetirableGrants` requests by evaluating the caller + # account's kms:ListRetirableGrants permissions. The authorized + # resource in `ListRetirableGrants` calls is the retiring principal + # specified in the request. KMS does not evaluate the caller's + # permissions to verify their access to any KMS keys or grants that + # might be returned by the `ListRetirableGrants` call. + # + # + # # **Related operations:** # # * CreateGrant @@ -4594,11 +5044,15 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * RevokeGrant # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][4]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # @@ -4646,7 +5100,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # resp.grants[0].retiring_principal #=> String # resp.grants[0].issuing_account #=> String # resp.grants[0].operations #=> Array - # resp.grants[0].operations[0] #=> String, one of "Decrypt", "Encrypt", "GenerateDataKey", "GenerateDataKeyWithoutPlaintext", "ReEncryptFrom", "ReEncryptTo", "Sign", "Verify", "GetPublicKey", "CreateGrant", "RetireGrant", "DescribeKey", "GenerateDataKeyPair", "GenerateDataKeyPairWithoutPlaintext", "GenerateMac", "VerifyMac" + # resp.grants[0].operations[0] #=> String, one of "Decrypt", "Encrypt", "GenerateDataKey", "GenerateDataKeyWithoutPlaintext", "ReEncryptFrom", "ReEncryptTo", "Sign", "Verify", "GetPublicKey", "CreateGrant", "RetireGrant", "DescribeKey", "GenerateDataKeyPair", "GenerateDataKeyPairWithoutPlaintext", "GenerateMac", "VerifyMac", "DeriveSharedSecret" # resp.grants[0].constraints.encryption_context_subset #=> Hash # resp.grants[0].constraints.encryption_context_subset["EncryptionContextKey"] #=> String # resp.grants[0].constraints.encryption_context_equals #=> Hash @@ -4665,7 +5119,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # * {Types::ListGrantsResponse#truncated #truncated} => Boolean # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListRetirableGrants AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#7134 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#7796 def list_retirable_grants(params = T.unsafe(nil), options = T.unsafe(nil)); end # Attaches a key policy to the specified KMS key. @@ -4685,12 +5139,16 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # **Related operations**: GetKeyPolicy # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][5]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-key-policies.html#put-policy # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To attach a key policy to a KMS key # @@ -4705,7 +5163,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # resp = client.put_key_policy({ # key_id: "KeyIdType", # required - # policy_name: "PolicyNameType", # required + # policy_name: "PolicyNameType", # policy: "PolicyType", # required # bypass_policy_lockout_safety_check: false, # }) @@ -4718,7 +5176,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/PutKeyPolicy AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#7269 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#7937 def put_key_policy(params = T.unsafe(nil), options = T.unsafe(nil)); end # Decrypts ciphertext and then reencrypts it entirely within KMS. You @@ -4813,6 +5271,9 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * GenerateDataKeyPair # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][9]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-manually @@ -4823,6 +5284,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # [6]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html # [7]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html # [8]: https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html + # [9]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To reencrypt data # @@ -4883,7 +5345,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # * {Types::ReEncryptResponse#destination_encryption_algorithm #destination_encryption_algorithm} => String # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ReEncrypt AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#7586 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#8258 def re_encrypt(params = T.unsafe(nil), options = T.unsafe(nil)); end # Replicates a multi-Region key into the specified Region. This @@ -4941,9 +5403,8 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # If you replicate a multi-Region primary key with imported key # material, the replica key is created with no key material. You must # import the same key material that you imported into the primary key. - # For details, see [Importing key material into multi-Region - # keys](kms/latest/developerguide/multi-region-keys-import.html) in the - # *Key Management Service Developer Guide*. + # For details, see [Importing key material into multi-Region keys][12] + # in the *Key Management Service Developer Guide*. # # To convert a replica key to a primary key, use the UpdatePrimaryRegion # operation. @@ -4973,6 +5434,9 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * UpdatePrimaryRegion # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][13]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html @@ -4986,6 +5450,8 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # [9]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html # [10]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html # [11]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html#mrk-sync-properties + # [12]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-import.html + # [13]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To replicate a multi-Region key in a different AWS Region # @@ -5055,7 +5521,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # resp.replica_key_metadata.creation_date #=> Time # resp.replica_key_metadata.enabled #=> Boolean # resp.replica_key_metadata.description #=> String - # resp.replica_key_metadata.key_usage #=> String, one of "SIGN_VERIFY", "ENCRYPT_DECRYPT", "GENERATE_VERIFY_MAC" + # resp.replica_key_metadata.key_usage #=> String, one of "SIGN_VERIFY", "ENCRYPT_DECRYPT", "GENERATE_VERIFY_MAC", "KEY_AGREEMENT" # resp.replica_key_metadata.key_state #=> String, one of "Creating", "Enabled", "Disabled", "PendingDeletion", "PendingImport", "PendingReplicaDeletion", "Unavailable", "Updating" # resp.replica_key_metadata.deletion_date #=> Time # resp.replica_key_metadata.valid_to #=> Time @@ -5070,6 +5536,8 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # resp.replica_key_metadata.encryption_algorithms[0] #=> String, one of "SYMMETRIC_DEFAULT", "RSAES_OAEP_SHA_1", "RSAES_OAEP_SHA_256", "SM2PKE" # resp.replica_key_metadata.signing_algorithms #=> Array # resp.replica_key_metadata.signing_algorithms[0] #=> String, one of "RSASSA_PSS_SHA_256", "RSASSA_PSS_SHA_384", "RSASSA_PSS_SHA_512", "RSASSA_PKCS1_V1_5_SHA_256", "RSASSA_PKCS1_V1_5_SHA_384", "RSASSA_PKCS1_V1_5_SHA_512", "ECDSA_SHA_256", "ECDSA_SHA_384", "ECDSA_SHA_512", "SM2DSA" + # resp.replica_key_metadata.key_agreement_algorithms #=> Array + # resp.replica_key_metadata.key_agreement_algorithms[0] #=> String, one of "ECDH" # resp.replica_key_metadata.multi_region #=> Boolean # resp.replica_key_metadata.multi_region_configuration.multi_region_key_type #=> String, one of "PRIMARY", "REPLICA" # resp.replica_key_metadata.multi_region_configuration.primary_key.arn #=> String @@ -5100,7 +5568,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # * {Types::ReplicateKeyResponse#replica_tags #replica_tags} => Array<Types::Tag> # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ReplicateKey AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#7980 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#8659 def replicate_key(params = T.unsafe(nil), options = T.unsafe(nil)); end # Deletes a grant. Typically, you retire a grant when you no longer need @@ -5123,7 +5591,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # **Cross-account use**: Yes. You can retire a grant on a KMS key in a # different Amazon Web Services account. # - # **Required permissions:**:Permission to retire a grant is determined + # **Required permissions**: Permission to retire a grant is determined # primarily by the grant. For details, see [Retiring and revoking # grants][2] in the *Key Management Service Developer Guide*. # @@ -5137,12 +5605,16 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * RevokeGrant # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][5]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html + # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To retire a grant # @@ -5169,7 +5641,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RetireGrant AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#8091 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#8774 def retire_grant(params = T.unsafe(nil), options = T.unsafe(nil)); end # Deletes the specified grant. You revoke a grant to terminate the @@ -5204,13 +5676,17 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * RetireGrant # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][6]. + # # # - # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/managing-grants.html#grant-delete + # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-eventual-consistency # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-grants.html # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [6]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To revoke a grant # @@ -5235,79 +5711,189 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RevokeGrant AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#8192 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#8879 def revoke_grant(params = T.unsafe(nil), options = T.unsafe(nil)); end - # Schedules the deletion of a KMS key. By default, KMS applies a waiting - # period of 30 days, but you can specify a waiting period of 7-30 days. - # When this operation is successful, the key state of the KMS key - # changes to `PendingDeletion` and the key can't be used in any - # cryptographic operations. It remains in this state for the duration of - # the waiting period. Before the waiting period ends, you can use - # CancelKeyDeletion to cancel the deletion of the KMS key. After the - # waiting period ends, KMS deletes the KMS key, its key material, and - # all KMS data associated with it, including all aliases that refer to - # it. + # Immediately initiates rotation of the key material of the specified + # symmetric encryption KMS key. # - # Deleting a KMS key is a destructive and potentially dangerous - # operation. When a KMS key is deleted, all data that was encrypted - # under the KMS key is unrecoverable. (The only exception is a - # [multi-Region replica - # key](kms/latest/developerguide/multi-region-keys-delete.html), or an - # [asymmetric or HMAC KMS key with imported key - # material](kms/latest/developerguide/importing-keys-managing.html#import-delete-key).) - # To prevent the use of a KMS key without deleting it, use DisableKey. + # You can perform [on-demand rotation][1] of the key material in + # customer managed KMS keys, regardless of whether or not [automatic key + # rotation][2] is enabled. On-demand rotations do not change existing + # automatic rotation schedules. For example, consider a KMS key that has + # automatic key rotation enabled with a rotation period of 730 days. If + # the key is scheduled to automatically rotate on April 14, 2024, and + # you perform an on-demand rotation on April 10, 2024, the key will + # automatically rotate, as scheduled, on April 14, 2024 and every 730 + # days thereafter. # - # You can schedule the deletion of a multi-Region primary key and its - # replica keys at any time. However, KMS will not delete a multi-Region - # primary key with existing replica keys. If you schedule the deletion - # of a primary key with replicas, its key state changes to - # `PendingReplicaDeletion` and it cannot be replicated or used in - # cryptographic operations. This status can continue indefinitely. When - # the last of its replicas keys is deleted (not just scheduled), the key - # state of the primary key changes to `PendingDeletion` and its waiting - # period (`PendingWindowInDays`) begins. For details, see [Deleting - # multi-Region keys][1] in the *Key Management Service Developer Guide*. + # You can perform on-demand key rotation a **maximum of 10 times** per + # KMS key. You can use the KMS console to view the number of remaining + # on-demand rotations available for a KMS key. # - # When KMS [deletes a KMS key from an CloudHSM key store][2], it makes a - # best effort to delete the associated key material from the associated - # CloudHSM cluster. However, you might need to manually [delete the - # orphaned key material][3] from the cluster and its backups. [Deleting - # a KMS key from an external key store][4] has no effect on the - # associated external key. However, for both types of custom key stores, - # deleting a KMS key is destructive and irreversible. You cannot decrypt - # ciphertext encrypted under the KMS key by using only its associated - # external key or CloudHSM key. Also, you cannot recreate a KMS key in - # an external key store by creating a new KMS key with the same key - # material. + # # - # For more information about scheduling a KMS key for deletion, see - # [Deleting KMS keys][5] in the *Key Management Service Developer - # Guide*. + # You can use GetKeyRotationStatus to identify any in progress on-demand + # rotations. You can use ListKeyRotations to identify the date that + # completed on-demand rotations were performed. You can monitor rotation + # of the key material for your KMS keys in CloudTrail and Amazon + # CloudWatch. + # + # On-demand key rotation is supported only on [symmetric encryption KMS + # keys][3]. You cannot perform on-demand rotation of [asymmetric KMS + # keys][4], [HMAC KMS keys][5], KMS keys with [imported key + # material][6], or KMS keys in a [custom key store][7]. To perform + # on-demand rotation of a set of related [multi-Region keys][8], invoke + # the on-demand rotation on the primary key. + # + # You cannot initiate on-demand rotation of [Amazon Web Services managed + # KMS keys][9]. KMS always rotates the key material of Amazon Web + # Services managed keys every year. Rotation of [Amazon Web Services + # owned KMS keys][10] is managed by the Amazon Web Services service that + # owns the key. # # The KMS key that you use for this operation must be in a compatible - # key state. For details, see [Key states of KMS keys][6] in the *Key + # key state. For details, see [Key states of KMS keys][11] in the *Key # Management Service Developer Guide*. # # **Cross-account use**: No. You cannot perform this operation on a KMS # key in a different Amazon Web Services account. # - # **Required permissions**: kms:ScheduleKeyDeletion (key policy) + # **Required permissions**: [kms:RotateKeyOnDemand][12] (key policy) # - # **Related operations** + # **Related operations:** # - # * CancelKeyDeletion + # * EnableKeyRotation # - # * DisableKey + # * DisableKeyRotation # + # * GetKeyRotationStatus # + # * ListKeyRotations # - # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html - # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/delete-cmk-keystore.html - # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key - # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/delete-xks-key.html + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][13]. + # + # + # + # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotating-keys-on-demand + # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotating-keys-enable-disable + # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks + # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html + # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html + # [6]: https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html + # [7]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html + # [8]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate + # [9]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk + # [10]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk + # [11]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html + # [12]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [13]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html + # + # @example Example: To perform on-demand rotation of key material + # + # # The following example immediately initiates rotation of the key material for the specified KMS key. + # + # resp = client.rotate_key_on_demand({ + # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The identifier of the KMS key whose key material you want to initiate on-demand rotation on. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key. + # }) + # + # resp.to_h outputs the following: + # { + # key_id: "1234abcd-12ab-34cd-56ef-1234567890ab", # The KMS key that you initiated on-demand rotation on. + # } + # @example Request syntax with placeholder values + # + # resp = client.rotate_key_on_demand({ + # key_id: "KeyIdType", # required + # }) + # @example Response structure + # + # resp.key_id #=> String + # @option params + # @overload rotate_key_on_demand + # @param params [Hash] ({}) + # @return [Types::RotateKeyOnDemandResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::RotateKeyOnDemandResponse#key_id #key_id} => String + # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RotateKeyOnDemand AWS API Documentation + # + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#9020 + def rotate_key_on_demand(params = T.unsafe(nil), options = T.unsafe(nil)); end + + # Schedules the deletion of a KMS key. By default, KMS applies a waiting + # period of 30 days, but you can specify a waiting period of 7-30 days. + # When this operation is successful, the key state of the KMS key + # changes to `PendingDeletion` and the key can't be used in any + # cryptographic operations. It remains in this state for the duration of + # the waiting period. Before the waiting period ends, you can use + # CancelKeyDeletion to cancel the deletion of the KMS key. After the + # waiting period ends, KMS deletes the KMS key, its key material, and + # all KMS data associated with it, including all aliases that refer to + # it. + # + # Deleting a KMS key is a destructive and potentially dangerous + # operation. When a KMS key is deleted, all data that was encrypted + # under the KMS key is unrecoverable. (The only exception is a + # [multi-Region replica key][1], or an [asymmetric or HMAC KMS key with + # imported key + # material](kms/latest/developerguide/importing-keys-managing.html#import-delete-key).) + # To prevent the use of a KMS key without deleting it, use DisableKey. + # + # You can schedule the deletion of a multi-Region primary key and its + # replica keys at any time. However, KMS will not delete a multi-Region + # primary key with existing replica keys. If you schedule the deletion + # of a primary key with replicas, its key state changes to + # `PendingReplicaDeletion` and it cannot be replicated or used in + # cryptographic operations. This status can continue indefinitely. When + # the last of its replicas keys is deleted (not just scheduled), the key + # state of the primary key changes to `PendingDeletion` and its waiting + # period (`PendingWindowInDays`) begins. For details, see [Deleting + # multi-Region keys][1] in the *Key Management Service Developer Guide*. + # + # When KMS [deletes a KMS key from an CloudHSM key store][2], it makes a + # best effort to delete the associated key material from the associated + # CloudHSM cluster. However, you might need to manually [delete the + # orphaned key material][3] from the cluster and its backups. [Deleting + # a KMS key from an external key store][4] has no effect on the + # associated external key. However, for both types of custom key stores, + # deleting a KMS key is destructive and irreversible. You cannot decrypt + # ciphertext encrypted under the KMS key by using only its associated + # external key or CloudHSM key. Also, you cannot recreate a KMS key in + # an external key store by creating a new KMS key with the same key + # material. + # + # For more information about scheduling a KMS key for deletion, see + # [Deleting KMS keys][5] in the *Key Management Service Developer + # Guide*. + # + # The KMS key that you use for this operation must be in a compatible + # key state. For details, see [Key states of KMS keys][6] in the *Key + # Management Service Developer Guide*. + # + # **Cross-account use**: No. You cannot perform this operation on a KMS + # key in a different Amazon Web Services account. + # + # **Required permissions**: kms:ScheduleKeyDeletion (key policy) + # + # **Related operations** + # + # * CancelKeyDeletion + # + # * DisableKey + # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][7]. + # + # + # + # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html + # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/delete-cmk-keystore.html + # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key + # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/delete-xks-key.html # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html # [6]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html + # [7]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To schedule a KMS key for deletion # @@ -5347,7 +5933,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # * {Types::ScheduleKeyDeletionResponse#pending_window_in_days #pending_window_in_days} => Integer # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ScheduleKeyDeletion AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#8342 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#9173 def schedule_key_deletion(params = T.unsafe(nil), options = T.unsafe(nil)); end # Creates a [digital signature][1] for a message or message digest by @@ -5409,12 +5995,16 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # **Related operations**: Verify # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][5]. + # # # # [1]: https://en.wikipedia.org/wiki/Digital_signature # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To digitally sign a message with an asymmetric KMS key. # @@ -5483,7 +6073,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # * {Types::SignResponse#signing_algorithm #signing_algorithm} => String # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/Sign AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#8586 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#9421 def sign(params = T.unsafe(nil), options = T.unsafe(nil)); end # Adds or edits tags on a [customer managed key][1]. @@ -5530,6 +6120,9 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * UntagResource # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][11]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk @@ -5542,6 +6135,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # [8]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html # [9]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html # [10]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [11]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To tag a KMS key # @@ -5574,7 +6168,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/TagResource AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#8708 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#9547 def tag_resource(params = T.unsafe(nil), options = T.unsafe(nil)); end # Deletes tags from a [customer managed key][1]. To delete a tag, @@ -5615,6 +6209,9 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * TagResource # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][7]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk @@ -5623,6 +6220,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # [4]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html # [6]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [7]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To remove tags from a KMS key # @@ -5648,7 +6246,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UntagResource AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#8804 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#9647 def untag_resource(params = T.unsafe(nil), options = T.unsafe(nil)); end # Associates an existing KMS alias with a different KMS key. Each alias @@ -5704,12 +6302,16 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * ListAliases # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][5]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/abac.html # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html#alias-access + # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To update an alias # @@ -5732,7 +6334,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateAlias AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#8932 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#9779 def update_alias(params = T.unsafe(nil), options = T.unsafe(nil)); end # Changes the properties of a custom key store. You can use this @@ -5831,10 +6433,14 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * DisconnectCustomKeyStore # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][3]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To edit the friendly name of a custom key store # @@ -5954,7 +6560,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateCustomKeyStore AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#9284 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#10135 def update_custom_key_store(params = T.unsafe(nil), options = T.unsafe(nil)); end # Updates the description of a KMS key. To see the description of a KMS @@ -5975,10 +6581,14 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * DescribeKey # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][3]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To update the description of a KMS key # @@ -6001,7 +6611,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateKeyDescription AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#9357 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#10212 def update_key_description(params = T.unsafe(nil), options = T.unsafe(nil)); end # Changes the primary key of a multi-Region key. @@ -6076,6 +6686,9 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # * ReplicateKey # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][10]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-update @@ -6087,6 +6700,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # [7]: https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html # [8]: https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html # [9]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html + # [10]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To update the primary Region of a multi-Region KMS key # @@ -6113,7 +6727,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdatePrimaryRegion AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#9497 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#10356 def update_primary_region(params = T.unsafe(nil), options = T.unsafe(nil)); end # Verifies a digital signature that was generated by the Sign operation. @@ -6167,12 +6781,16 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # **Related operations**: Sign # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][5]. + # # # # [1]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-sm-offline-verification # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To use an asymmetric KMS key to verify a digital signature # @@ -6245,7 +6863,7 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # * {Types::VerifyResponse#signing_algorithm #signing_algorithm} => String # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/Verify AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#9737 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#10600 def verify(params = T.unsafe(nil), options = T.unsafe(nil)); end # Verifies the hash-based message authentication code (HMAC) for a @@ -6276,12 +6894,16 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # # **Related operations**: GenerateMac # + # **Eventual consistency**: The KMS API follows an eventual consistency + # model. For more information, see [KMS eventual consistency][5]. + # # # # [1]: https://datatracker.ietf.org/doc/html/rfc2104 # [2]: https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html # [3]: https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html # [4]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html + # [5]: https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html # # @example Example: To verify an HMAC # @@ -6331,24 +6953,24 @@ class Aws::KMS::Client < ::Seahorse::Client::Base # * {Types::VerifyMacResponse#mac_algorithm #mac_algorithm} => String # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/VerifyMac AWS API Documentation # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#9873 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#10740 def verify_mac(params = T.unsafe(nil), options = T.unsafe(nil)); end # @api private # @deprecated # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#9897 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#10764 def waiter_names; end class << self # @api private # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#9907 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#10774 def errors_module; end # @api private # - # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#9904 + # source://aws-sdk-kms//lib/aws-sdk-kms/client.rb#10771 def identifier; end end end @@ -6362,7 +6984,7 @@ end # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#946 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#1010 Aws::KMS::ClientApi::API = T.let(T.unsafe(nil), Seahorse::Model::Api) # @api private @@ -6458,1006 +7080,1071 @@ Aws::KMS::ClientApi::CloudHsmClusterNotRelatedException = T.let(T.unsafe(nil), S # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#34 -Aws::KMS::ClientApi::ConnectCustomKeyStoreRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::ConflictException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#35 -Aws::KMS::ClientApi::ConnectCustomKeyStoreResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::ConnectCustomKeyStoreRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#36 -Aws::KMS::ClientApi::ConnectionErrorCodeType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::ConnectCustomKeyStoreResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#37 -Aws::KMS::ClientApi::ConnectionStateType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::ConnectionErrorCodeType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#38 -Aws::KMS::ClientApi::CreateAliasRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::ConnectionStateType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#39 -Aws::KMS::ClientApi::CreateCustomKeyStoreRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::CreateAliasRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#40 -Aws::KMS::ClientApi::CreateCustomKeyStoreResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::CreateCustomKeyStoreRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#41 -Aws::KMS::ClientApi::CreateGrantRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::CreateCustomKeyStoreResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#42 -Aws::KMS::ClientApi::CreateGrantResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::CreateGrantRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#43 -Aws::KMS::ClientApi::CreateKeyRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::CreateGrantResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#44 -Aws::KMS::ClientApi::CreateKeyResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::CreateKeyRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#45 -Aws::KMS::ClientApi::CustomKeyStoreHasCMKsException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::CreateKeyResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#46 -Aws::KMS::ClientApi::CustomKeyStoreIdType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::CustomKeyStoreHasCMKsException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#47 -Aws::KMS::ClientApi::CustomKeyStoreInvalidStateException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::CustomKeyStoreIdType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#48 -Aws::KMS::ClientApi::CustomKeyStoreNameInUseException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::CustomKeyStoreInvalidStateException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#49 -Aws::KMS::ClientApi::CustomKeyStoreNameType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::CustomKeyStoreNameInUseException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#50 -Aws::KMS::ClientApi::CustomKeyStoreNotFoundException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::CustomKeyStoreNameType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#51 -Aws::KMS::ClientApi::CustomKeyStoreType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::CustomKeyStoreNotFoundException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#52 -Aws::KMS::ClientApi::CustomKeyStoresList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::KMS::ClientApi::CustomKeyStoreType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#53 -Aws::KMS::ClientApi::CustomKeyStoresListEntry = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::CustomKeyStoresList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#54 -Aws::KMS::ClientApi::CustomerMasterKeySpec = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::CustomKeyStoresListEntry = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#55 -Aws::KMS::ClientApi::DataKeyPairSpec = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::CustomerMasterKeySpec = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#56 -Aws::KMS::ClientApi::DataKeySpec = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::DataKeyPairSpec = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#57 -Aws::KMS::ClientApi::DateType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::TimestampShape) +Aws::KMS::ClientApi::DataKeySpec = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#58 -Aws::KMS::ClientApi::DecryptRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::DateType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::TimestampShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#59 -Aws::KMS::ClientApi::DecryptResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::DecryptRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#60 -Aws::KMS::ClientApi::DeleteAliasRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::DecryptResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#61 -Aws::KMS::ClientApi::DeleteCustomKeyStoreRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::DeleteAliasRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#62 -Aws::KMS::ClientApi::DeleteCustomKeyStoreResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::DeleteCustomKeyStoreRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#63 -Aws::KMS::ClientApi::DeleteImportedKeyMaterialRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::DeleteCustomKeyStoreResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#64 -Aws::KMS::ClientApi::DependencyTimeoutException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::DeleteImportedKeyMaterialRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#65 -Aws::KMS::ClientApi::DescribeCustomKeyStoresRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::DependencyTimeoutException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#66 -Aws::KMS::ClientApi::DescribeCustomKeyStoresResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::DeriveSharedSecretRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#67 -Aws::KMS::ClientApi::DescribeKeyRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::DeriveSharedSecretResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#68 -Aws::KMS::ClientApi::DescribeKeyResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::DescribeCustomKeyStoresRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#69 -Aws::KMS::ClientApi::DescriptionType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::DescribeCustomKeyStoresResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#70 -Aws::KMS::ClientApi::DisableKeyRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::DescribeKeyRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#71 -Aws::KMS::ClientApi::DisableKeyRotationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::DescribeKeyResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#72 -Aws::KMS::ClientApi::DisabledException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::DescriptionType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#73 -Aws::KMS::ClientApi::DisconnectCustomKeyStoreRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::DisableKeyRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#74 -Aws::KMS::ClientApi::DisconnectCustomKeyStoreResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::DisableKeyRotationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#75 -Aws::KMS::ClientApi::DryRunOperationException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::DisabledException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#76 -Aws::KMS::ClientApi::EnableKeyRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::DisconnectCustomKeyStoreRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#77 -Aws::KMS::ClientApi::EnableKeyRotationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::DisconnectCustomKeyStoreResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#78 -Aws::KMS::ClientApi::EncryptRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::DryRunOperationException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#79 -Aws::KMS::ClientApi::EncryptResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::EnableKeyRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#80 -Aws::KMS::ClientApi::EncryptionAlgorithmSpec = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::EnableKeyRotationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#81 -Aws::KMS::ClientApi::EncryptionAlgorithmSpecList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::KMS::ClientApi::EncryptRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#82 -Aws::KMS::ClientApi::EncryptionContextKey = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::EncryptResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#83 -Aws::KMS::ClientApi::EncryptionContextType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::MapShape) +Aws::KMS::ClientApi::EncryptionAlgorithmSpec = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#84 -Aws::KMS::ClientApi::EncryptionContextValue = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::EncryptionAlgorithmSpecList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#85 -Aws::KMS::ClientApi::ErrorMessageType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::EncryptionContextKey = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#86 -Aws::KMS::ClientApi::ExpirationModelType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::EncryptionContextType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::MapShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#87 -Aws::KMS::ClientApi::ExpiredImportTokenException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::EncryptionContextValue = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#88 -Aws::KMS::ClientApi::GenerateDataKeyPairRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::ErrorMessageType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#89 -Aws::KMS::ClientApi::GenerateDataKeyPairResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::ExpirationModelType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#90 -Aws::KMS::ClientApi::GenerateDataKeyPairWithoutPlaintextRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::ExpiredImportTokenException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#91 -Aws::KMS::ClientApi::GenerateDataKeyPairWithoutPlaintextResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::GenerateDataKeyPairRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#92 -Aws::KMS::ClientApi::GenerateDataKeyRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::GenerateDataKeyPairResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#93 -Aws::KMS::ClientApi::GenerateDataKeyResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::GenerateDataKeyPairWithoutPlaintextRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#94 -Aws::KMS::ClientApi::GenerateDataKeyWithoutPlaintextRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::GenerateDataKeyPairWithoutPlaintextResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#95 -Aws::KMS::ClientApi::GenerateDataKeyWithoutPlaintextResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::GenerateDataKeyRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#96 -Aws::KMS::ClientApi::GenerateMacRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::GenerateDataKeyResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#97 -Aws::KMS::ClientApi::GenerateMacResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::GenerateDataKeyWithoutPlaintextRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#98 -Aws::KMS::ClientApi::GenerateRandomRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::GenerateDataKeyWithoutPlaintextResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#99 -Aws::KMS::ClientApi::GenerateRandomResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::GenerateMacRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#100 -Aws::KMS::ClientApi::GetKeyPolicyRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::GenerateMacResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#101 -Aws::KMS::ClientApi::GetKeyPolicyResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::GenerateRandomRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#102 -Aws::KMS::ClientApi::GetKeyRotationStatusRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::GenerateRandomResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#103 -Aws::KMS::ClientApi::GetKeyRotationStatusResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::GetKeyPolicyRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#104 -Aws::KMS::ClientApi::GetParametersForImportRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::GetKeyPolicyResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#105 -Aws::KMS::ClientApi::GetParametersForImportResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::GetKeyRotationStatusRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#106 -Aws::KMS::ClientApi::GetPublicKeyRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::GetKeyRotationStatusResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#107 -Aws::KMS::ClientApi::GetPublicKeyResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::GetParametersForImportRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#108 -Aws::KMS::ClientApi::GrantConstraints = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::GetParametersForImportResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#109 -Aws::KMS::ClientApi::GrantIdType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::GetPublicKeyRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#110 -Aws::KMS::ClientApi::GrantList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::KMS::ClientApi::GetPublicKeyResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#111 -Aws::KMS::ClientApi::GrantListEntry = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::GrantConstraints = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#112 -Aws::KMS::ClientApi::GrantNameType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::GrantIdType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#113 -Aws::KMS::ClientApi::GrantOperation = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::GrantList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#114 -Aws::KMS::ClientApi::GrantOperationList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::KMS::ClientApi::GrantListEntry = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#115 -Aws::KMS::ClientApi::GrantTokenList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::KMS::ClientApi::GrantNameType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#116 -Aws::KMS::ClientApi::GrantTokenType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::GrantOperation = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#117 -Aws::KMS::ClientApi::ImportKeyMaterialRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::GrantOperationList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#118 -Aws::KMS::ClientApi::ImportKeyMaterialResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::GrantTokenList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#119 -Aws::KMS::ClientApi::IncorrectKeyException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::GrantTokenType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#120 -Aws::KMS::ClientApi::IncorrectKeyMaterialException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::ImportKeyMaterialRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#121 -Aws::KMS::ClientApi::IncorrectTrustAnchorException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::ImportKeyMaterialResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#122 -Aws::KMS::ClientApi::InvalidAliasNameException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::IncorrectKeyException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#123 -Aws::KMS::ClientApi::InvalidArnException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::IncorrectKeyMaterialException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#124 -Aws::KMS::ClientApi::InvalidCiphertextException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::IncorrectTrustAnchorException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#125 -Aws::KMS::ClientApi::InvalidGrantIdException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::InvalidAliasNameException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#126 -Aws::KMS::ClientApi::InvalidGrantTokenException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::InvalidArnException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#127 -Aws::KMS::ClientApi::InvalidImportTokenException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::InvalidCiphertextException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#128 -Aws::KMS::ClientApi::InvalidKeyUsageException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::InvalidGrantIdException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#129 -Aws::KMS::ClientApi::InvalidMarkerException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::InvalidGrantTokenException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#130 -Aws::KMS::ClientApi::KMSInternalException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::InvalidImportTokenException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#131 -Aws::KMS::ClientApi::KMSInvalidMacException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::InvalidKeyUsageException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#132 -Aws::KMS::ClientApi::KMSInvalidSignatureException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::InvalidMarkerException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#133 -Aws::KMS::ClientApi::KMSInvalidStateException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::KMSInternalException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#134 -Aws::KMS::ClientApi::KeyEncryptionMechanism = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::KMSInvalidMacException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#135 -Aws::KMS::ClientApi::KeyIdType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::KMSInvalidSignatureException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#136 -Aws::KMS::ClientApi::KeyList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::KMS::ClientApi::KMSInvalidStateException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#137 -Aws::KMS::ClientApi::KeyListEntry = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::KeyAgreementAlgorithmSpec = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#138 -Aws::KMS::ClientApi::KeyManagerType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::KeyAgreementAlgorithmSpecList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#139 -Aws::KMS::ClientApi::KeyMetadata = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::KeyEncryptionMechanism = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#140 -Aws::KMS::ClientApi::KeySpec = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::KeyIdType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#141 -Aws::KMS::ClientApi::KeyState = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::KeyList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#142 -Aws::KMS::ClientApi::KeyStorePasswordType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::KeyListEntry = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#143 -Aws::KMS::ClientApi::KeyUnavailableException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::KeyManagerType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#144 -Aws::KMS::ClientApi::KeyUsageType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::KeyMetadata = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#145 -Aws::KMS::ClientApi::LimitExceededException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::KeySpec = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#146 -Aws::KMS::ClientApi::LimitType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) +Aws::KMS::ClientApi::KeyState = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#147 -Aws::KMS::ClientApi::ListAliasesRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::KeyStorePasswordType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#148 -Aws::KMS::ClientApi::ListAliasesResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::KeyUnavailableException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#149 -Aws::KMS::ClientApi::ListGrantsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::KeyUsageType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#150 -Aws::KMS::ClientApi::ListGrantsResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::LimitExceededException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#151 -Aws::KMS::ClientApi::ListKeyPoliciesRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::LimitType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#152 -Aws::KMS::ClientApi::ListKeyPoliciesResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::ListAliasesRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#153 -Aws::KMS::ClientApi::ListKeysRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::ListAliasesResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#154 -Aws::KMS::ClientApi::ListKeysResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::ListGrantsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#155 -Aws::KMS::ClientApi::ListResourceTagsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::ListGrantsResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#156 -Aws::KMS::ClientApi::ListResourceTagsResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::ListKeyPoliciesRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#157 -Aws::KMS::ClientApi::ListRetirableGrantsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::ListKeyPoliciesResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#158 -Aws::KMS::ClientApi::MacAlgorithmSpec = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::ListKeyRotationsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#159 -Aws::KMS::ClientApi::MacAlgorithmSpecList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::KMS::ClientApi::ListKeyRotationsResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#160 -Aws::KMS::ClientApi::MalformedPolicyDocumentException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::ListKeysRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#161 -Aws::KMS::ClientApi::MarkerType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::ListKeysResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#162 -Aws::KMS::ClientApi::MessageType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::ListResourceTagsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#163 -Aws::KMS::ClientApi::MultiRegionConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::ListResourceTagsResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#164 -Aws::KMS::ClientApi::MultiRegionKey = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::ListRetirableGrantsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#165 -Aws::KMS::ClientApi::MultiRegionKeyList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::KMS::ClientApi::MacAlgorithmSpec = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#166 -Aws::KMS::ClientApi::MultiRegionKeyType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::MacAlgorithmSpecList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#167 -Aws::KMS::ClientApi::NotFoundException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::MalformedPolicyDocumentException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#168 -Aws::KMS::ClientApi::NullableBooleanType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) +Aws::KMS::ClientApi::MarkerType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#169 -Aws::KMS::ClientApi::NumberOfBytesType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) +Aws::KMS::ClientApi::MessageType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#170 -Aws::KMS::ClientApi::OriginType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::MultiRegionConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#171 -Aws::KMS::ClientApi::PendingWindowInDaysType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) +Aws::KMS::ClientApi::MultiRegionKey = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#172 -Aws::KMS::ClientApi::PlaintextType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BlobShape) +Aws::KMS::ClientApi::MultiRegionKeyList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#173 -Aws::KMS::ClientApi::PolicyNameList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::KMS::ClientApi::MultiRegionKeyType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#174 -Aws::KMS::ClientApi::PolicyNameType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::NotFoundException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#175 -Aws::KMS::ClientApi::PolicyType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::NullableBooleanType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#176 -Aws::KMS::ClientApi::PrincipalIdType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::NumberOfBytesType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#177 -Aws::KMS::ClientApi::PublicKeyType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BlobShape) +Aws::KMS::ClientApi::OriginType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#178 -Aws::KMS::ClientApi::PutKeyPolicyRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::PendingWindowInDaysType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#179 -Aws::KMS::ClientApi::ReEncryptRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::PlaintextType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BlobShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#180 -Aws::KMS::ClientApi::ReEncryptResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::PolicyNameList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#181 -Aws::KMS::ClientApi::RecipientInfo = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::PolicyNameType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#182 -Aws::KMS::ClientApi::RegionType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::PolicyType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#183 -Aws::KMS::ClientApi::ReplicateKeyRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::PrincipalIdType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#184 -Aws::KMS::ClientApi::ReplicateKeyResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::PublicKeyType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BlobShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#185 -Aws::KMS::ClientApi::RetireGrantRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::PutKeyPolicyRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#186 -Aws::KMS::ClientApi::RevokeGrantRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::ReEncryptRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#187 -Aws::KMS::ClientApi::ScheduleKeyDeletionRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::ReEncryptResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#188 -Aws::KMS::ClientApi::ScheduleKeyDeletionResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::RecipientInfo = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#189 -Aws::KMS::ClientApi::SignRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::RegionType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#190 -Aws::KMS::ClientApi::SignResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::ReplicateKeyRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#191 -Aws::KMS::ClientApi::SigningAlgorithmSpec = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::ReplicateKeyResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#192 -Aws::KMS::ClientApi::SigningAlgorithmSpecList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::KMS::ClientApi::RetireGrantRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#193 -Aws::KMS::ClientApi::Tag = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::RevokeGrantRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#194 -Aws::KMS::ClientApi::TagException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::KMS::ClientApi::RotateKeyOnDemandRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#195 -Aws::KMS::ClientApi::TagKeyList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::KMS::ClientApi::RotateKeyOnDemandResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#196 -Aws::KMS::ClientApi::TagKeyType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::KMS::ClientApi::RotationPeriodInDaysType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#197 +Aws::KMS::ClientApi::RotationType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) + +# @api private +# +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#198 +Aws::KMS::ClientApi::RotationsList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) + +# @api private +# +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#199 +Aws::KMS::ClientApi::RotationsListEntry = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) + +# @api private +# +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#200 +Aws::KMS::ClientApi::ScheduleKeyDeletionRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) + +# @api private +# +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#201 +Aws::KMS::ClientApi::ScheduleKeyDeletionResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) + +# @api private +# +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#202 +Aws::KMS::ClientApi::SignRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) + +# @api private +# +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#203 +Aws::KMS::ClientApi::SignResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) + +# @api private +# +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#204 +Aws::KMS::ClientApi::SigningAlgorithmSpec = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) + +# @api private +# +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#205 +Aws::KMS::ClientApi::SigningAlgorithmSpecList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) + +# @api private +# +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#206 +Aws::KMS::ClientApi::Tag = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) + +# @api private +# +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#207 +Aws::KMS::ClientApi::TagException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) + +# @api private +# +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#208 +Aws::KMS::ClientApi::TagKeyList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) + +# @api private +# +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#209 +Aws::KMS::ClientApi::TagKeyType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) + +# @api private +# +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#210 Aws::KMS::ClientApi::TagList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#198 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#211 Aws::KMS::ClientApi::TagResourceRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#199 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#212 Aws::KMS::ClientApi::TagValueType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#200 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#213 Aws::KMS::ClientApi::TrustAnchorCertificateType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#201 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#214 Aws::KMS::ClientApi::UnsupportedOperationException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#202 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#215 Aws::KMS::ClientApi::UntagResourceRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#203 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#216 Aws::KMS::ClientApi::UpdateAliasRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#204 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#217 Aws::KMS::ClientApi::UpdateCustomKeyStoreRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#205 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#218 Aws::KMS::ClientApi::UpdateCustomKeyStoreResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#206 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#219 Aws::KMS::ClientApi::UpdateKeyDescriptionRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#207 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#220 Aws::KMS::ClientApi::UpdatePrimaryRegionRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#208 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#221 Aws::KMS::ClientApi::VerifyMacRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#209 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#222 Aws::KMS::ClientApi::VerifyMacResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#210 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#223 Aws::KMS::ClientApi::VerifyRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#211 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#224 Aws::KMS::ClientApi::VerifyResponse = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#212 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#225 Aws::KMS::ClientApi::WrappingKeySpec = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#213 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#226 Aws::KMS::ClientApi::XksKeyAlreadyInUseException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#214 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#227 Aws::KMS::ClientApi::XksKeyConfigurationType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#215 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#228 Aws::KMS::ClientApi::XksKeyIdType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#216 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#229 Aws::KMS::ClientApi::XksKeyInvalidConfigurationException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#217 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#230 Aws::KMS::ClientApi::XksKeyNotFoundException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#218 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#231 Aws::KMS::ClientApi::XksProxyAuthenticationAccessKeyIdType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#219 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#232 Aws::KMS::ClientApi::XksProxyAuthenticationCredentialType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#220 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#233 Aws::KMS::ClientApi::XksProxyAuthenticationRawSecretAccessKeyType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#221 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#234 Aws::KMS::ClientApi::XksProxyConfigurationType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#222 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#235 Aws::KMS::ClientApi::XksProxyConnectivityType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#223 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#236 Aws::KMS::ClientApi::XksProxyIncorrectAuthenticationCredentialException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#224 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#237 Aws::KMS::ClientApi::XksProxyInvalidConfigurationException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#225 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#238 Aws::KMS::ClientApi::XksProxyInvalidResponseException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#226 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#239 Aws::KMS::ClientApi::XksProxyUriEndpointInUseException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#227 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#240 Aws::KMS::ClientApi::XksProxyUriEndpointType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#228 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#241 Aws::KMS::ClientApi::XksProxyUriInUseException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#229 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#242 Aws::KMS::ClientApi::XksProxyUriPathType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#230 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#243 Aws::KMS::ClientApi::XksProxyUriUnreachableException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#231 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#244 Aws::KMS::ClientApi::XksProxyVpcEndpointServiceInUseException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#232 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#245 Aws::KMS::ClientApi::XksProxyVpcEndpointServiceInvalidConfigurationException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#233 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#246 Aws::KMS::ClientApi::XksProxyVpcEndpointServiceNameType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#234 +# source://aws-sdk-kms//lib/aws-sdk-kms/client_api.rb#247 Aws::KMS::ClientApi::XksProxyVpcEndpointServiceNotFoundException = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # Endpoint parameters used to influence endpoints per request. @@ -7656,7 +8343,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#155 -class Aws::KMS::Endpoints::DescribeCustomKeyStores +class Aws::KMS::Endpoints::DeriveSharedSecret class << self # @api private # @@ -7668,7 +8355,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#169 -class Aws::KMS::Endpoints::DescribeKey +class Aws::KMS::Endpoints::DescribeCustomKeyStores class << self # @api private # @@ -7680,7 +8367,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#183 -class Aws::KMS::Endpoints::DisableKey +class Aws::KMS::Endpoints::DescribeKey class << self # @api private # @@ -7692,7 +8379,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#197 -class Aws::KMS::Endpoints::DisableKeyRotation +class Aws::KMS::Endpoints::DisableKey class << self # @api private # @@ -7704,7 +8391,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#211 -class Aws::KMS::Endpoints::DisconnectCustomKeyStore +class Aws::KMS::Endpoints::DisableKeyRotation class << self # @api private # @@ -7716,7 +8403,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#225 -class Aws::KMS::Endpoints::EnableKey +class Aws::KMS::Endpoints::DisconnectCustomKeyStore class << self # @api private # @@ -7728,7 +8415,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#239 -class Aws::KMS::Endpoints::EnableKeyRotation +class Aws::KMS::Endpoints::EnableKey class << self # @api private # @@ -7740,7 +8427,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#253 -class Aws::KMS::Endpoints::Encrypt +class Aws::KMS::Endpoints::EnableKeyRotation class << self # @api private # @@ -7752,7 +8439,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#267 -class Aws::KMS::Endpoints::GenerateDataKey +class Aws::KMS::Endpoints::Encrypt class << self # @api private # @@ -7764,7 +8451,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#281 -class Aws::KMS::Endpoints::GenerateDataKeyPair +class Aws::KMS::Endpoints::GenerateDataKey class << self # @api private # @@ -7776,7 +8463,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#295 -class Aws::KMS::Endpoints::GenerateDataKeyPairWithoutPlaintext +class Aws::KMS::Endpoints::GenerateDataKeyPair class << self # @api private # @@ -7788,7 +8475,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#309 -class Aws::KMS::Endpoints::GenerateDataKeyWithoutPlaintext +class Aws::KMS::Endpoints::GenerateDataKeyPairWithoutPlaintext class << self # @api private # @@ -7800,7 +8487,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#323 -class Aws::KMS::Endpoints::GenerateMac +class Aws::KMS::Endpoints::GenerateDataKeyWithoutPlaintext class << self # @api private # @@ -7812,7 +8499,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#337 -class Aws::KMS::Endpoints::GenerateRandom +class Aws::KMS::Endpoints::GenerateMac class << self # @api private # @@ -7824,7 +8511,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#351 -class Aws::KMS::Endpoints::GetKeyPolicy +class Aws::KMS::Endpoints::GenerateRandom class << self # @api private # @@ -7836,7 +8523,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#365 -class Aws::KMS::Endpoints::GetKeyRotationStatus +class Aws::KMS::Endpoints::GetKeyPolicy class << self # @api private # @@ -7848,7 +8535,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#379 -class Aws::KMS::Endpoints::GetParametersForImport +class Aws::KMS::Endpoints::GetKeyRotationStatus class << self # @api private # @@ -7860,7 +8547,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#393 -class Aws::KMS::Endpoints::GetPublicKey +class Aws::KMS::Endpoints::GetParametersForImport class << self # @api private # @@ -7872,7 +8559,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#407 -class Aws::KMS::Endpoints::ImportKeyMaterial +class Aws::KMS::Endpoints::GetPublicKey class << self # @api private # @@ -7884,7 +8571,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#421 -class Aws::KMS::Endpoints::ListAliases +class Aws::KMS::Endpoints::ImportKeyMaterial class << self # @api private # @@ -7896,7 +8583,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#435 -class Aws::KMS::Endpoints::ListGrants +class Aws::KMS::Endpoints::ListAliases class << self # @api private # @@ -7908,7 +8595,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#449 -class Aws::KMS::Endpoints::ListKeyPolicies +class Aws::KMS::Endpoints::ListGrants class << self # @api private # @@ -7920,7 +8607,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#463 -class Aws::KMS::Endpoints::ListKeys +class Aws::KMS::Endpoints::ListKeyPolicies class << self # @api private # @@ -7932,7 +8619,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#477 -class Aws::KMS::Endpoints::ListResourceTags +class Aws::KMS::Endpoints::ListKeyRotations class << self # @api private # @@ -7944,7 +8631,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#491 -class Aws::KMS::Endpoints::ListRetirableGrants +class Aws::KMS::Endpoints::ListKeys class << self # @api private # @@ -7956,7 +8643,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#505 -class Aws::KMS::Endpoints::PutKeyPolicy +class Aws::KMS::Endpoints::ListResourceTags class << self # @api private # @@ -7968,7 +8655,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#519 -class Aws::KMS::Endpoints::ReEncrypt +class Aws::KMS::Endpoints::ListRetirableGrants class << self # @api private # @@ -7980,7 +8667,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#533 -class Aws::KMS::Endpoints::ReplicateKey +class Aws::KMS::Endpoints::PutKeyPolicy class << self # @api private # @@ -7992,7 +8679,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#547 -class Aws::KMS::Endpoints::RetireGrant +class Aws::KMS::Endpoints::ReEncrypt class << self # @api private # @@ -8004,7 +8691,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#561 -class Aws::KMS::Endpoints::RevokeGrant +class Aws::KMS::Endpoints::ReplicateKey class << self # @api private # @@ -8016,7 +8703,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#575 -class Aws::KMS::Endpoints::ScheduleKeyDeletion +class Aws::KMS::Endpoints::RetireGrant class << self # @api private # @@ -8028,7 +8715,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#589 -class Aws::KMS::Endpoints::Sign +class Aws::KMS::Endpoints::RevokeGrant class << self # @api private # @@ -8040,7 +8727,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#603 -class Aws::KMS::Endpoints::TagResource +class Aws::KMS::Endpoints::RotateKeyOnDemand class << self # @api private # @@ -8052,7 +8739,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#617 -class Aws::KMS::Endpoints::UntagResource +class Aws::KMS::Endpoints::ScheduleKeyDeletion class << self # @api private # @@ -8064,7 +8751,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#631 -class Aws::KMS::Endpoints::UpdateAlias +class Aws::KMS::Endpoints::Sign class << self # @api private # @@ -8076,7 +8763,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#645 -class Aws::KMS::Endpoints::UpdateCustomKeyStore +class Aws::KMS::Endpoints::TagResource class << self # @api private # @@ -8088,7 +8775,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#659 -class Aws::KMS::Endpoints::UpdateKeyDescription +class Aws::KMS::Endpoints::UntagResource class << self # @api private # @@ -8100,7 +8787,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#673 -class Aws::KMS::Endpoints::UpdatePrimaryRegion +class Aws::KMS::Endpoints::UpdateAlias class << self # @api private # @@ -8112,7 +8799,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#687 -class Aws::KMS::Endpoints::Verify +class Aws::KMS::Endpoints::UpdateCustomKeyStore class << self # @api private # @@ -8124,7 +8811,7 @@ end # @api private # # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#701 -class Aws::KMS::Endpoints::VerifyMac +class Aws::KMS::Endpoints::UpdateKeyDescription class << self # @api private # @@ -8133,6 +8820,42 @@ class Aws::KMS::Endpoints::VerifyMac end end +# @api private +# +# source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#715 +class Aws::KMS::Endpoints::UpdatePrimaryRegion + class << self + # @api private + # + # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#716 + def build(context); end + end +end + +# @api private +# +# source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#729 +class Aws::KMS::Endpoints::Verify + class << self + # @api private + # + # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#730 + def build(context); end + end +end + +# @api private +# +# source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#743 +class Aws::KMS::Endpoints::VerifyMac + class << self + # @api private + # + # source://aws-sdk-kms//lib/aws-sdk-kms/endpoints.rb#744 + def build(context); end + end +end + # When KMS returns an error response, the Ruby SDK constructs and raises an error. # These errors all extend Aws::KMS::Errors::ServiceError < {Aws::Errors::ServiceError} # @@ -8157,6 +8880,7 @@ end # * {CloudHsmClusterNotActiveException} # * {CloudHsmClusterNotFoundException} # * {CloudHsmClusterNotRelatedException} +# * {ConflictException} # * {CustomKeyStoreHasCMKsException} # * {CustomKeyStoreInvalidStateException} # * {CustomKeyStoreNameInUseException} @@ -8202,763 +8926,779 @@ end # Additionally, error classes are dynamically generated for service errors based on the error code # if they are not defined above. # -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#80 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#81 module Aws::KMS::Errors extend ::Aws::Errors::DynamicErrors end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#84 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#85 class Aws::KMS::Errors::AlreadyExistsException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::AlreadyExistsException] # @return [AlreadyExistsException] a new instance of AlreadyExistsException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#89 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#90 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#94 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#95 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#99 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#100 class Aws::KMS::Errors::CloudHsmClusterInUseException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::CloudHsmClusterInUseException] # @return [CloudHsmClusterInUseException] a new instance of CloudHsmClusterInUseException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#104 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#105 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#109 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#110 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#114 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#115 class Aws::KMS::Errors::CloudHsmClusterInvalidConfigurationException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::CloudHsmClusterInvalidConfigurationException] # @return [CloudHsmClusterInvalidConfigurationException] a new instance of CloudHsmClusterInvalidConfigurationException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#119 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#120 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#124 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#125 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#129 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#130 class Aws::KMS::Errors::CloudHsmClusterNotActiveException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::CloudHsmClusterNotActiveException] # @return [CloudHsmClusterNotActiveException] a new instance of CloudHsmClusterNotActiveException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#134 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#135 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#139 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#140 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#144 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#145 class Aws::KMS::Errors::CloudHsmClusterNotFoundException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::CloudHsmClusterNotFoundException] # @return [CloudHsmClusterNotFoundException] a new instance of CloudHsmClusterNotFoundException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#149 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#150 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#154 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#155 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#159 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#160 class Aws::KMS::Errors::CloudHsmClusterNotRelatedException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::CloudHsmClusterNotRelatedException] # @return [CloudHsmClusterNotRelatedException] a new instance of CloudHsmClusterNotRelatedException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#164 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#165 + def initialize(context, message, data = T.unsafe(nil)); end + + # @return [String] + # + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#170 + def message; end +end + +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#175 +class Aws::KMS::Errors::ConflictException < ::Aws::KMS::Errors::ServiceError + # @param context [Seahorse::Client::RequestContext] + # @param message [String] + # @param data [Aws::KMS::Types::ConflictException] + # @return [ConflictException] a new instance of ConflictException + # + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#180 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#169 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#185 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#174 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#190 class Aws::KMS::Errors::CustomKeyStoreHasCMKsException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::CustomKeyStoreHasCMKsException] # @return [CustomKeyStoreHasCMKsException] a new instance of CustomKeyStoreHasCMKsException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#179 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#195 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#184 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#200 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#189 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#205 class Aws::KMS::Errors::CustomKeyStoreInvalidStateException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::CustomKeyStoreInvalidStateException] # @return [CustomKeyStoreInvalidStateException] a new instance of CustomKeyStoreInvalidStateException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#194 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#210 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#199 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#215 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#204 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#220 class Aws::KMS::Errors::CustomKeyStoreNameInUseException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::CustomKeyStoreNameInUseException] # @return [CustomKeyStoreNameInUseException] a new instance of CustomKeyStoreNameInUseException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#209 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#225 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#214 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#230 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#219 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#235 class Aws::KMS::Errors::CustomKeyStoreNotFoundException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::CustomKeyStoreNotFoundException] # @return [CustomKeyStoreNotFoundException] a new instance of CustomKeyStoreNotFoundException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#224 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#240 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#229 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#245 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#234 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#250 class Aws::KMS::Errors::DependencyTimeoutException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::DependencyTimeoutException] # @return [DependencyTimeoutException] a new instance of DependencyTimeoutException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#239 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#255 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#244 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#260 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#249 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#265 class Aws::KMS::Errors::DisabledException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::DisabledException] # @return [DisabledException] a new instance of DisabledException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#254 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#270 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#259 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#275 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#264 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#280 class Aws::KMS::Errors::DryRunOperationException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::DryRunOperationException] # @return [DryRunOperationException] a new instance of DryRunOperationException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#269 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#285 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#274 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#290 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#279 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#295 class Aws::KMS::Errors::ExpiredImportTokenException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::ExpiredImportTokenException] # @return [ExpiredImportTokenException] a new instance of ExpiredImportTokenException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#284 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#300 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#289 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#305 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#294 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#310 class Aws::KMS::Errors::IncorrectKeyException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::IncorrectKeyException] # @return [IncorrectKeyException] a new instance of IncorrectKeyException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#299 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#315 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#304 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#320 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#309 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#325 class Aws::KMS::Errors::IncorrectKeyMaterialException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::IncorrectKeyMaterialException] # @return [IncorrectKeyMaterialException] a new instance of IncorrectKeyMaterialException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#314 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#330 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#319 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#335 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#324 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#340 class Aws::KMS::Errors::IncorrectTrustAnchorException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::IncorrectTrustAnchorException] # @return [IncorrectTrustAnchorException] a new instance of IncorrectTrustAnchorException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#329 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#345 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#334 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#350 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#339 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#355 class Aws::KMS::Errors::InvalidAliasNameException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::InvalidAliasNameException] # @return [InvalidAliasNameException] a new instance of InvalidAliasNameException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#344 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#360 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#349 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#365 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#354 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#370 class Aws::KMS::Errors::InvalidArnException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::InvalidArnException] # @return [InvalidArnException] a new instance of InvalidArnException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#359 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#375 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#364 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#380 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#369 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#385 class Aws::KMS::Errors::InvalidCiphertextException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::InvalidCiphertextException] # @return [InvalidCiphertextException] a new instance of InvalidCiphertextException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#374 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#390 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#379 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#395 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#384 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#400 class Aws::KMS::Errors::InvalidGrantIdException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::InvalidGrantIdException] # @return [InvalidGrantIdException] a new instance of InvalidGrantIdException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#389 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#405 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#394 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#410 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#399 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#415 class Aws::KMS::Errors::InvalidGrantTokenException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::InvalidGrantTokenException] # @return [InvalidGrantTokenException] a new instance of InvalidGrantTokenException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#404 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#420 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#409 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#425 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#414 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#430 class Aws::KMS::Errors::InvalidImportTokenException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::InvalidImportTokenException] # @return [InvalidImportTokenException] a new instance of InvalidImportTokenException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#419 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#435 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#424 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#440 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#429 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#445 class Aws::KMS::Errors::InvalidKeyUsageException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::InvalidKeyUsageException] # @return [InvalidKeyUsageException] a new instance of InvalidKeyUsageException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#434 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#450 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#439 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#455 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#444 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#460 class Aws::KMS::Errors::InvalidMarkerException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::InvalidMarkerException] # @return [InvalidMarkerException] a new instance of InvalidMarkerException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#449 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#465 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#454 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#470 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#459 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#475 class Aws::KMS::Errors::KMSInternalException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::KMSInternalException] # @return [KMSInternalException] a new instance of KMSInternalException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#464 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#480 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#469 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#485 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#474 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#490 class Aws::KMS::Errors::KMSInvalidMacException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::KMSInvalidMacException] # @return [KMSInvalidMacException] a new instance of KMSInvalidMacException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#479 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#495 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#484 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#500 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#489 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#505 class Aws::KMS::Errors::KMSInvalidSignatureException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::KMSInvalidSignatureException] # @return [KMSInvalidSignatureException] a new instance of KMSInvalidSignatureException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#494 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#510 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#499 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#515 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#504 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#520 class Aws::KMS::Errors::KMSInvalidStateException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::KMSInvalidStateException] # @return [KMSInvalidStateException] a new instance of KMSInvalidStateException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#509 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#525 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#514 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#530 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#519 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#535 class Aws::KMS::Errors::KeyUnavailableException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::KeyUnavailableException] # @return [KeyUnavailableException] a new instance of KeyUnavailableException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#524 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#540 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#529 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#545 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#534 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#550 class Aws::KMS::Errors::LimitExceededException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::LimitExceededException] # @return [LimitExceededException] a new instance of LimitExceededException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#539 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#555 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#544 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#560 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#549 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#565 class Aws::KMS::Errors::MalformedPolicyDocumentException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::MalformedPolicyDocumentException] # @return [MalformedPolicyDocumentException] a new instance of MalformedPolicyDocumentException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#554 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#570 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#559 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#575 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#564 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#580 class Aws::KMS::Errors::NotFoundException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::NotFoundException] # @return [NotFoundException] a new instance of NotFoundException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#569 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#585 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#574 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#590 def message; end end # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#0 class Aws::KMS::Errors::ServiceError < ::Aws::Errors::ServiceError; end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#579 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#595 class Aws::KMS::Errors::TagException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::TagException] # @return [TagException] a new instance of TagException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#584 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#600 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#589 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#605 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#594 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#610 class Aws::KMS::Errors::UnsupportedOperationException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::UnsupportedOperationException] # @return [UnsupportedOperationException] a new instance of UnsupportedOperationException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#599 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#615 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#604 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#620 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#609 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#625 class Aws::KMS::Errors::XksKeyAlreadyInUseException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::XksKeyAlreadyInUseException] # @return [XksKeyAlreadyInUseException] a new instance of XksKeyAlreadyInUseException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#614 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#630 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#619 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#635 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#624 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#640 class Aws::KMS::Errors::XksKeyInvalidConfigurationException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::XksKeyInvalidConfigurationException] # @return [XksKeyInvalidConfigurationException] a new instance of XksKeyInvalidConfigurationException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#629 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#645 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#634 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#650 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#639 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#655 class Aws::KMS::Errors::XksKeyNotFoundException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::XksKeyNotFoundException] # @return [XksKeyNotFoundException] a new instance of XksKeyNotFoundException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#644 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#660 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#649 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#665 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#654 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#670 class Aws::KMS::Errors::XksProxyIncorrectAuthenticationCredentialException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::XksProxyIncorrectAuthenticationCredentialException] # @return [XksProxyIncorrectAuthenticationCredentialException] a new instance of XksProxyIncorrectAuthenticationCredentialException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#659 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#675 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#664 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#680 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#669 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#685 class Aws::KMS::Errors::XksProxyInvalidConfigurationException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::XksProxyInvalidConfigurationException] # @return [XksProxyInvalidConfigurationException] a new instance of XksProxyInvalidConfigurationException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#674 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#690 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#679 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#695 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#684 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#700 class Aws::KMS::Errors::XksProxyInvalidResponseException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::XksProxyInvalidResponseException] # @return [XksProxyInvalidResponseException] a new instance of XksProxyInvalidResponseException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#689 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#705 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#694 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#710 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#699 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#715 class Aws::KMS::Errors::XksProxyUriEndpointInUseException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::XksProxyUriEndpointInUseException] # @return [XksProxyUriEndpointInUseException] a new instance of XksProxyUriEndpointInUseException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#704 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#720 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#709 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#725 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#714 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#730 class Aws::KMS::Errors::XksProxyUriInUseException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::XksProxyUriInUseException] # @return [XksProxyUriInUseException] a new instance of XksProxyUriInUseException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#719 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#735 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#724 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#740 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#729 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#745 class Aws::KMS::Errors::XksProxyUriUnreachableException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::XksProxyUriUnreachableException] # @return [XksProxyUriUnreachableException] a new instance of XksProxyUriUnreachableException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#734 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#750 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#739 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#755 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#744 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#760 class Aws::KMS::Errors::XksProxyVpcEndpointServiceInUseException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::XksProxyVpcEndpointServiceInUseException] # @return [XksProxyVpcEndpointServiceInUseException] a new instance of XksProxyVpcEndpointServiceInUseException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#749 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#765 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#754 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#770 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#759 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#775 class Aws::KMS::Errors::XksProxyVpcEndpointServiceInvalidConfigurationException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::XksProxyVpcEndpointServiceInvalidConfigurationException] # @return [XksProxyVpcEndpointServiceInvalidConfigurationException] a new instance of XksProxyVpcEndpointServiceInvalidConfigurationException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#764 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#780 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#769 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#785 def message; end end -# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#774 +# source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#790 class Aws::KMS::Errors::XksProxyVpcEndpointServiceNotFoundException < ::Aws::KMS::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] # @param message [String] # @param data [Aws::KMS::Types::XksProxyVpcEndpointServiceNotFoundException] # @return [XksProxyVpcEndpointServiceNotFoundException] a new instance of XksProxyVpcEndpointServiceNotFoundException # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#779 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#795 def initialize(context, message, data = T.unsafe(nil)); end # @return [String] # - # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#784 + # source://aws-sdk-kms//lib/aws-sdk-kms/errors.rb#800 def message; end end @@ -8970,29 +9710,29 @@ module Aws::KMS::Plugins; end # source://aws-sdk-kms//lib/aws-sdk-kms/plugins/endpoints.rb#13 class Aws::KMS::Plugins::Endpoints < ::Seahorse::Client::Plugin - # source://aws-sdk-kms//lib/aws-sdk-kms/plugins/endpoints.rb#163 + # source://aws-sdk-kms//lib/aws-sdk-kms/plugins/endpoints.rb#171 def add_handlers(handlers, _config); end end # @api private # -# source://aws-sdk-kms//lib/aws-sdk-kms/plugins/endpoints.rb#26 +# source://aws-sdk-kms//lib/aws-sdk-kms/plugins/endpoints.rb#27 class Aws::KMS::Plugins::Endpoints::Handler < ::Seahorse::Client::Handler # @api private # - # source://aws-sdk-kms//lib/aws-sdk-kms/plugins/endpoints.rb#27 + # source://aws-sdk-kms//lib/aws-sdk-kms/plugins/endpoints.rb#28 def call(context); end private # @api private # - # source://aws-sdk-kms//lib/aws-sdk-kms/plugins/endpoints.rb#46 + # source://aws-sdk-kms//lib/aws-sdk-kms/plugins/endpoints.rb#48 def apply_endpoint_headers(context, headers); end # @api private # - # source://aws-sdk-kms//lib/aws-sdk-kms/plugins/endpoints.rb#57 + # source://aws-sdk-kms//lib/aws-sdk-kms/plugins/endpoints.rb#59 def parameters_for_operation(context); end end @@ -9194,89 +9934,103 @@ end # source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#241 Aws::KMS::Types::CloudHsmClusterNotRelatedException::SENSITIVE = T.let(T.unsafe(nil), Array) +# The request was rejected because an automatic rotation of this key is +# currently in progress or scheduled to begin within the next 20 +# minutes. +# +# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ConflictException AWS API Documentation +# +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#255 +class Aws::KMS::Types::ConflictException < ::Struct + include ::Aws::Structure +end + +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#256 +Aws::KMS::Types::ConflictException::SENSITIVE = T.let(T.unsafe(nil), Array) + # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ConnectCustomKeyStoreRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#254 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#269 class Aws::KMS::Types::ConnectCustomKeyStoreRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#255 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#270 Aws::KMS::Types::ConnectCustomKeyStoreRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ConnectCustomKeyStoreResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#261 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#276 class Aws::KMS::Types::ConnectCustomKeyStoreResponse < ::Aws::EmptyStructure; end # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateAliasRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#315 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#330 class Aws::KMS::Types::CreateAliasRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#316 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#331 Aws::KMS::Types::CreateAliasRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateCustomKeyStoreRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#538 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#553 class Aws::KMS::Types::CreateCustomKeyStoreRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#539 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#554 Aws::KMS::Types::CreateCustomKeyStoreRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateCustomKeyStoreResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#550 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#565 class Aws::KMS::Types::CreateCustomKeyStoreResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#551 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#566 Aws::KMS::Types::CreateCustomKeyStoreResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateGrantRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#728 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#743 class Aws::KMS::Types::CreateGrantRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#729 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#744 Aws::KMS::Types::CreateGrantRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateGrantResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#758 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#773 class Aws::KMS::Types::CreateGrantResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#759 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#774 Aws::KMS::Types::CreateGrantResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateKeyRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1120 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1143 class Aws::KMS::Types::CreateKeyRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1121 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1144 Aws::KMS::Types::CreateKeyRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateKeyResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1132 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1155 class Aws::KMS::Types::CreateKeyResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1133 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1156 Aws::KMS::Types::CreateKeyResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because the custom key store contains KMS @@ -9286,12 +10040,12 @@ Aws::KMS::Types::CreateKeyResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CustomKeyStoreHasCMKsException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1148 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1171 class Aws::KMS::Types::CustomKeyStoreHasCMKsException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1149 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1172 Aws::KMS::Types::CustomKeyStoreHasCMKsException::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because of the `ConnectionState` of the @@ -9326,12 +10080,12 @@ Aws::KMS::Types::CustomKeyStoreHasCMKsException::SENSITIVE = T.let(T.unsafe(nil) # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CustomKeyStoreInvalidStateException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1189 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1212 class Aws::KMS::Types::CustomKeyStoreInvalidStateException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1190 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1213 Aws::KMS::Types::CustomKeyStoreInvalidStateException::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because the specified custom key store name @@ -9340,12 +10094,12 @@ Aws::KMS::Types::CustomKeyStoreInvalidStateException::SENSITIVE = T.let(T.unsafe # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CustomKeyStoreNameInUseException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1204 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1227 class Aws::KMS::Types::CustomKeyStoreNameInUseException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1205 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1228 Aws::KMS::Types::CustomKeyStoreNameInUseException::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because KMS cannot find a custom key store @@ -9353,12 +10107,12 @@ Aws::KMS::Types::CustomKeyStoreNameInUseException::SENSITIVE = T.let(T.unsafe(ni # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CustomKeyStoreNotFoundException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1218 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1241 class Aws::KMS::Types::CustomKeyStoreNotFoundException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1219 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1242 Aws::KMS::Types::CustomKeyStoreNotFoundException::SENSITIVE = T.let(T.unsafe(nil), Array) # Contains information about each custom key store in the custom key @@ -9366,67 +10120,67 @@ Aws::KMS::Types::CustomKeyStoreNotFoundException::SENSITIVE = T.let(T.unsafe(nil # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CustomKeyStoresListEntry AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1482 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1505 class Aws::KMS::Types::CustomKeyStoresListEntry < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1483 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1506 Aws::KMS::Types::CustomKeyStoresListEntry::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DecryptRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1625 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1648 class Aws::KMS::Types::DecryptRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1626 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1649 Aws::KMS::Types::DecryptRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DecryptResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1674 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1697 class Aws::KMS::Types::DecryptResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1675 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1698 Aws::KMS::Types::DecryptResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteAliasRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1687 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1710 class Aws::KMS::Types::DeleteAliasRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1688 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1711 Aws::KMS::Types::DeleteAliasRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteCustomKeyStoreRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1700 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1723 class Aws::KMS::Types::DeleteCustomKeyStoreRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1701 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1724 Aws::KMS::Types::DeleteCustomKeyStoreRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteCustomKeyStoreResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1707 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1730 class Aws::KMS::Types::DeleteCustomKeyStoreResponse < ::Aws::EmptyStructure; end # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteImportedKeyMaterialRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1729 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1752 class Aws::KMS::Types::DeleteImportedKeyMaterialRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1730 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1753 Aws::KMS::Types::DeleteImportedKeyMaterialRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # The system timed out while trying to fulfill the request. You can @@ -9434,151 +10188,171 @@ Aws::KMS::Types::DeleteImportedKeyMaterialRequest::SENSITIVE = T.let(T.unsafe(ni # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DependencyTimeoutException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1743 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1766 class Aws::KMS::Types::DependencyTimeoutException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1744 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1767 Aws::KMS::Types::DependencyTimeoutException::SENSITIVE = T.let(T.unsafe(nil), Array) +# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeriveSharedSecretRequest AWS API Documentation +# +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1898 +class Aws::KMS::Types::DeriveSharedSecretRequest < ::Struct + include ::Aws::Structure +end + +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1899 +Aws::KMS::Types::DeriveSharedSecretRequest::SENSITIVE = T.let(T.unsafe(nil), Array) + +# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeriveSharedSecretResponse AWS API Documentation +# +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1955 +class Aws::KMS::Types::DeriveSharedSecretResponse < ::Struct + include ::Aws::Structure +end + +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1956 +Aws::KMS::Types::DeriveSharedSecretResponse::SENSITIVE = T.let(T.unsafe(nil), Array) + # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DescribeCustomKeyStoresRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1786 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1998 class Aws::KMS::Types::DescribeCustomKeyStoresRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1787 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1999 Aws::KMS::Types::DescribeCustomKeyStoresRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DescribeCustomKeyStoresResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1812 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2024 class Aws::KMS::Types::DescribeCustomKeyStoresResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1813 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2025 Aws::KMS::Types::DescribeCustomKeyStoresResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DescribeKeyRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1867 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2079 class Aws::KMS::Types::DescribeKeyRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1868 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2080 Aws::KMS::Types::DescribeKeyRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DescribeKeyResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1879 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2091 class Aws::KMS::Types::DescribeKeyResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1880 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2092 Aws::KMS::Types::DescribeKeyResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisableKeyRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1903 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2115 class Aws::KMS::Types::DisableKeyRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1904 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2116 Aws::KMS::Types::DisableKeyRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisableKeyRotationRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1937 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2149 class Aws::KMS::Types::DisableKeyRotationRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1938 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2150 Aws::KMS::Types::DisableKeyRotationRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because the specified KMS key is not enabled. # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisabledException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1950 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2162 class Aws::KMS::Types::DisabledException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1951 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2163 Aws::KMS::Types::DisabledException::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisconnectCustomKeyStoreRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1964 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2176 class Aws::KMS::Types::DisconnectCustomKeyStoreRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1965 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2177 Aws::KMS::Types::DisconnectCustomKeyStoreRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisconnectCustomKeyStoreResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1971 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2183 class Aws::KMS::Types::DisconnectCustomKeyStoreResponse < ::Aws::EmptyStructure; end # The request was rejected because the DryRun parameter was specified. # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DryRunOperationException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1981 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2193 class Aws::KMS::Types::DryRunOperationException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#1982 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2194 Aws::KMS::Types::DryRunOperationException::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EnableKeyRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2005 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2217 class Aws::KMS::Types::EnableKeyRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2006 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2218 Aws::KMS::Types::EnableKeyRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EnableKeyRotationRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2041 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2274 class Aws::KMS::Types::EnableKeyRotationRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2042 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2275 Aws::KMS::Types::EnableKeyRotationRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EncryptRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2151 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2384 class Aws::KMS::Types::EncryptRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2152 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2385 Aws::KMS::Types::EncryptRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EncryptResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2180 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2413 class Aws::KMS::Types::EncryptResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2181 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2414 Aws::KMS::Types::EncryptResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because the specified import token is @@ -9588,212 +10362,212 @@ Aws::KMS::Types::EncryptResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ExpiredImportTokenException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2196 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2429 class Aws::KMS::Types::ExpiredImportTokenException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2197 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2430 Aws::KMS::Types::ExpiredImportTokenException::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyPairRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2327 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2563 class Aws::KMS::Types::GenerateDataKeyPairRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2328 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2564 Aws::KMS::Types::GenerateDataKeyPairRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyPairResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2391 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2627 class Aws::KMS::Types::GenerateDataKeyPairResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2392 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2628 Aws::KMS::Types::GenerateDataKeyPairResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyPairWithoutPlaintextRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2490 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2726 class Aws::KMS::Types::GenerateDataKeyPairWithoutPlaintextRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2491 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2727 Aws::KMS::Types::GenerateDataKeyPairWithoutPlaintextRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyPairWithoutPlaintextResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2526 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2762 class Aws::KMS::Types::GenerateDataKeyPairWithoutPlaintextResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2527 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2763 Aws::KMS::Types::GenerateDataKeyPairWithoutPlaintextResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2666 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2902 class Aws::KMS::Types::GenerateDataKeyRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2667 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2903 Aws::KMS::Types::GenerateDataKeyRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2719 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2955 class Aws::KMS::Types::GenerateDataKeyResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2720 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2956 Aws::KMS::Types::GenerateDataKeyResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyWithoutPlaintextRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2821 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3057 class Aws::KMS::Types::GenerateDataKeyWithoutPlaintextRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2822 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3058 Aws::KMS::Types::GenerateDataKeyWithoutPlaintextRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyWithoutPlaintextResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2845 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3081 class Aws::KMS::Types::GenerateDataKeyWithoutPlaintextResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2846 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3082 Aws::KMS::Types::GenerateDataKeyWithoutPlaintextResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateMacRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2912 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3148 class Aws::KMS::Types::GenerateMacRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2913 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3149 Aws::KMS::Types::GenerateMacRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateMacResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2941 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3177 class Aws::KMS::Types::GenerateMacResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2942 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3178 Aws::KMS::Types::GenerateMacResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateRandomRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2993 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3229 class Aws::KMS::Types::GenerateRandomRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#2994 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3230 Aws::KMS::Types::GenerateRandomRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateRandomResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3028 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3264 class Aws::KMS::Types::GenerateRandomResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3029 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3265 Aws::KMS::Types::GenerateRandomResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyPolicyRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3058 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3295 class Aws::KMS::Types::GetKeyPolicyRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3059 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3296 Aws::KMS::Types::GetKeyPolicyRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyPolicyResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3070 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3312 class Aws::KMS::Types::GetKeyPolicyResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3071 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3313 Aws::KMS::Types::GetKeyPolicyResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyRotationStatusRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3096 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3338 class Aws::KMS::Types::GetKeyRotationStatusRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3097 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3339 Aws::KMS::Types::GetKeyRotationStatusRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyRotationStatusResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3108 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3382 class Aws::KMS::Types::GetKeyRotationStatusResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3109 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3383 Aws::KMS::Types::GetKeyRotationStatusResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetParametersForImportRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3191 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3465 class Aws::KMS::Types::GetParametersForImportRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3192 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3466 Aws::KMS::Types::GetParametersForImportRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetParametersForImportResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3228 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3502 class Aws::KMS::Types::GetParametersForImportResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3229 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3503 Aws::KMS::Types::GetParametersForImportResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetPublicKeyRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3274 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3548 class Aws::KMS::Types::GetPublicKeyRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3275 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3549 Aws::KMS::Types::GetPublicKeyRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetPublicKeyResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3351 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3632 class Aws::KMS::Types::GetPublicKeyResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3352 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3633 Aws::KMS::Types::GetPublicKeyResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # Use this structure to allow [cryptographic operations][1] in the grant @@ -9831,39 +10605,39 @@ Aws::KMS::Types::GetPublicKeyResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GrantConstraints AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3416 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3697 class Aws::KMS::Types::GrantConstraints < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3417 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3698 Aws::KMS::Types::GrantConstraints::SENSITIVE = T.let(T.unsafe(nil), Array) # Contains information about a grant. # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GrantListEntry AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3484 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3765 class Aws::KMS::Types::GrantListEntry < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3485 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3766 Aws::KMS::Types::GrantListEntry::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ImportKeyMaterialRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3576 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3857 class Aws::KMS::Types::ImportKeyMaterialRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3577 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3858 Aws::KMS::Types::ImportKeyMaterialRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ImportKeyMaterialResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3583 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3864 class Aws::KMS::Types::ImportKeyMaterialResponse < ::Aws::EmptyStructure; end # The request was rejected because the specified KMS key cannot decrypt @@ -9873,12 +10647,12 @@ class Aws::KMS::Types::ImportKeyMaterialResponse < ::Aws::EmptyStructure; end # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/IncorrectKeyException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3596 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3877 class Aws::KMS::Types::IncorrectKeyException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3597 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3878 Aws::KMS::Types::IncorrectKeyException::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because the key material in the request is, @@ -9887,12 +10661,12 @@ Aws::KMS::Types::IncorrectKeyException::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/IncorrectKeyMaterialException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3611 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3892 class Aws::KMS::Types::IncorrectKeyMaterialException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3612 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3893 Aws::KMS::Types::IncorrectKeyMaterialException::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because the trust anchor certificate in the @@ -9908,12 +10682,12 @@ Aws::KMS::Types::IncorrectKeyMaterialException::SENSITIVE = T.let(T.unsafe(nil), # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/IncorrectTrustAnchorException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3633 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3914 class Aws::KMS::Types::IncorrectTrustAnchorException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3634 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3915 Aws::KMS::Types::IncorrectTrustAnchorException::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because the specified alias name is not @@ -9921,12 +10695,12 @@ Aws::KMS::Types::IncorrectTrustAnchorException::SENSITIVE = T.let(T.unsafe(nil), # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/InvalidAliasNameException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3647 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3928 class Aws::KMS::Types::InvalidAliasNameException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3648 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3929 Aws::KMS::Types::InvalidAliasNameException::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because a specified ARN, or an ARN in a key @@ -9934,12 +10708,12 @@ Aws::KMS::Types::InvalidAliasNameException::SENSITIVE = T.let(T.unsafe(nil), Arr # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/InvalidArnException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3661 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3942 class Aws::KMS::Types::InvalidArnException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3662 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3943 Aws::KMS::Types::InvalidArnException::SENSITIVE = T.let(T.unsafe(nil), Array) # From the Decrypt or ReEncrypt operation, the request was rejected @@ -9952,24 +10726,24 @@ Aws::KMS::Types::InvalidArnException::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/InvalidCiphertextException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3680 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3961 class Aws::KMS::Types::InvalidCiphertextException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3681 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3962 Aws::KMS::Types::InvalidCiphertextException::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because the specified `GrantId` is not valid. # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/InvalidGrantIdException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3693 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3974 class Aws::KMS::Types::InvalidGrantIdException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3694 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3975 Aws::KMS::Types::InvalidGrantIdException::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because the specified grant token is not @@ -9977,12 +10751,12 @@ Aws::KMS::Types::InvalidGrantIdException::SENSITIVE = T.let(T.unsafe(nil), Array # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/InvalidGrantTokenException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3707 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3988 class Aws::KMS::Types::InvalidGrantTokenException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3708 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3989 Aws::KMS::Types::InvalidGrantTokenException::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because the provided import token is invalid @@ -9990,12 +10764,12 @@ Aws::KMS::Types::InvalidGrantTokenException::SENSITIVE = T.let(T.unsafe(nil), Ar # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/InvalidImportTokenException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3721 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4002 class Aws::KMS::Types::InvalidImportTokenException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3722 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4003 Aws::KMS::Types::InvalidImportTokenException::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected for one of the following reasons: @@ -10011,20 +10785,21 @@ Aws::KMS::Types::InvalidImportTokenException::SENSITIVE = T.let(T.unsafe(nil), A # the `KeyUsage` must be `ENCRYPT_DECRYPT`. For signing and verifying # messages, the `KeyUsage` must be `SIGN_VERIFY`. For generating and # verifying message authentication codes (MACs), the `KeyUsage` must be -# `GENERATE_VERIFY_MAC`. To find the `KeyUsage` of a KMS key, use the -# DescribeKey operation. +# `GENERATE_VERIFY_MAC`. For deriving key agreement secrets, the +# `KeyUsage` must be `KEY_AGREEMENT`. To find the `KeyUsage` of a KMS +# key, use the DescribeKey operation. # # To find the encryption or signing algorithms supported for a # particular KMS key, use the DescribeKey operation. # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/InvalidKeyUsageException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3751 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4033 class Aws::KMS::Types::InvalidKeyUsageException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3752 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4034 Aws::KMS::Types::InvalidKeyUsageException::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because the marker that specifies where @@ -10032,12 +10807,12 @@ Aws::KMS::Types::InvalidKeyUsageException::SENSITIVE = T.let(T.unsafe(nil), Arra # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/InvalidMarkerException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3765 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4047 class Aws::KMS::Types::InvalidMarkerException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3766 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4048 Aws::KMS::Types::InvalidMarkerException::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because an internal exception occurred. The @@ -10045,12 +10820,12 @@ Aws::KMS::Types::InvalidMarkerException::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/KMSInternalException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3779 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4061 class Aws::KMS::Types::KMSInternalException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3780 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4062 Aws::KMS::Types::KMSInternalException::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because the HMAC verification failed. HMAC @@ -10060,12 +10835,12 @@ Aws::KMS::Types::KMSInternalException::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/KMSInvalidMacException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3795 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4077 class Aws::KMS::Types::KMSInvalidMacException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3796 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4078 Aws::KMS::Types::KMSInvalidMacException::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because the signature verification failed. @@ -10075,12 +10850,12 @@ Aws::KMS::Types::KMSInvalidMacException::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/KMSInvalidSignatureException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3811 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4093 class Aws::KMS::Types::KMSInvalidSignatureException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3812 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4094 Aws::KMS::Types::KMSInvalidSignatureException::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because the state of the specified resource @@ -10106,24 +10881,24 @@ Aws::KMS::Types::KMSInvalidSignatureException::SENSITIVE = T.let(T.unsafe(nil), # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/KMSInvalidStateException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3843 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4125 class Aws::KMS::Types::KMSInvalidStateException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3844 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4126 Aws::KMS::Types::KMSInvalidStateException::SENSITIVE = T.let(T.unsafe(nil), Array) # Contains information about each entry in the key list. # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/KeyListEntry AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3862 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4144 class Aws::KMS::Types::KeyListEntry < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#3863 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4145 Aws::KMS::Types::KeyListEntry::SENSITIVE = T.let(T.unsafe(nil), Array) # Contains metadata about a KMS key. @@ -10133,12 +10908,12 @@ Aws::KMS::Types::KeyListEntry::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/KeyMetadata AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4116 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4403 class Aws::KMS::Types::KeyMetadata < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4117 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4404 Aws::KMS::Types::KeyMetadata::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because the specified KMS key was not @@ -10146,12 +10921,12 @@ Aws::KMS::Types::KeyMetadata::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/KeyUnavailableException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4130 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4417 class Aws::KMS::Types::KeyUnavailableException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4131 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4418 Aws::KMS::Types::KeyUnavailableException::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because a quota was exceeded. For more @@ -10164,122 +10939,142 @@ Aws::KMS::Types::KeyUnavailableException::SENSITIVE = T.let(T.unsafe(nil), Array # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/LimitExceededException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4149 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4436 class Aws::KMS::Types::LimitExceededException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4150 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4437 Aws::KMS::Types::LimitExceededException::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListAliasesRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4195 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4482 class Aws::KMS::Types::ListAliasesRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4196 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4483 Aws::KMS::Types::ListAliasesRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListAliasesResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4221 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4508 class Aws::KMS::Types::ListAliasesResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4222 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4509 Aws::KMS::Types::ListAliasesResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListGrantsRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4278 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4565 class Aws::KMS::Types::ListGrantsRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4279 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4566 Aws::KMS::Types::ListGrantsRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListGrantsResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4304 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4591 class Aws::KMS::Types::ListGrantsResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4305 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4592 Aws::KMS::Types::ListGrantsResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeyPoliciesRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4348 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4635 class Aws::KMS::Types::ListKeyPoliciesRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4349 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4636 Aws::KMS::Types::ListKeyPoliciesRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeyPoliciesResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4374 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4661 class Aws::KMS::Types::ListKeyPoliciesResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4375 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4662 Aws::KMS::Types::ListKeyPoliciesResponse::SENSITIVE = T.let(T.unsafe(nil), Array) +# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeyRotationsRequest AWS API Documentation +# +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4703 +class Aws::KMS::Types::ListKeyRotationsRequest < ::Struct + include ::Aws::Structure +end + +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4704 +Aws::KMS::Types::ListKeyRotationsRequest::SENSITIVE = T.let(T.unsafe(nil), Array) + +# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeyRotationsResponse AWS API Documentation +# +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4729 +class Aws::KMS::Types::ListKeyRotationsResponse < ::Struct + include ::Aws::Structure +end + +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4730 +Aws::KMS::Types::ListKeyRotationsResponse::SENSITIVE = T.let(T.unsafe(nil), Array) + # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeysRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4399 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4754 class Aws::KMS::Types::ListKeysRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4400 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4755 Aws::KMS::Types::ListKeysRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeysResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4425 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4780 class Aws::KMS::Types::ListKeysResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4426 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4781 Aws::KMS::Types::ListKeysResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListResourceTagsRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4469 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4824 class Aws::KMS::Types::ListResourceTagsRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4470 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4825 Aws::KMS::Types::ListResourceTagsRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListResourceTagsResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4507 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4862 class Aws::KMS::Types::ListResourceTagsResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4508 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4863 Aws::KMS::Types::ListResourceTagsResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListRetirableGrantsRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4550 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4905 class Aws::KMS::Types::ListRetirableGrantsRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4551 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4906 Aws::KMS::Types::ListRetirableGrantsRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because the specified policy is not @@ -10287,12 +11082,12 @@ Aws::KMS::Types::ListRetirableGrantsRequest::SENSITIVE = T.let(T.unsafe(nil), Ar # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/MalformedPolicyDocumentException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4564 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4919 class Aws::KMS::Types::MalformedPolicyDocumentException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4565 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4920 Aws::KMS::Types::MalformedPolicyDocumentException::SENSITIVE = T.let(T.unsafe(nil), Array) # Describes the configuration of this multi-Region key. This field @@ -10304,24 +11099,24 @@ Aws::KMS::Types::MalformedPolicyDocumentException::SENSITIVE = T.let(T.unsafe(ni # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/MultiRegionConfiguration AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4595 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4950 class Aws::KMS::Types::MultiRegionConfiguration < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4596 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4951 Aws::KMS::Types::MultiRegionConfiguration::SENSITIVE = T.let(T.unsafe(nil), Array) # Describes the primary or replica key in a multi-Region key. # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/MultiRegionKey AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4616 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4971 class Aws::KMS::Types::MultiRegionKey < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4617 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4972 Aws::KMS::Types::MultiRegionKey::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because the specified entity or resource @@ -10329,42 +11124,42 @@ Aws::KMS::Types::MultiRegionKey::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/NotFoundException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4630 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4985 class Aws::KMS::Types::NotFoundException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4631 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4986 Aws::KMS::Types::NotFoundException::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/PutKeyPolicyRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4727 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5084 class Aws::KMS::Types::PutKeyPolicyRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4728 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5085 Aws::KMS::Types::PutKeyPolicyRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ReEncryptRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4908 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5265 class Aws::KMS::Types::ReEncryptRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4909 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5266 Aws::KMS::Types::ReEncryptRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ReEncryptResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4949 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5306 class Aws::KMS::Types::ReEncryptResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4950 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5307 Aws::KMS::Types::ReEncryptResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # Contains information about the party that receives the response from @@ -10382,92 +11177,124 @@ Aws::KMS::Types::ReEncryptResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RecipientInfo AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4982 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5339 class Aws::KMS::Types::RecipientInfo < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#4983 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5340 Aws::KMS::Types::RecipientInfo::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ReplicateKeyRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5180 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5538 class Aws::KMS::Types::ReplicateKeyRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5181 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5539 Aws::KMS::Types::ReplicateKeyRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ReplicateKeyResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5212 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5570 class Aws::KMS::Types::ReplicateKeyResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5213 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5571 Aws::KMS::Types::ReplicateKeyResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RetireGrantRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5268 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5626 class Aws::KMS::Types::RetireGrantRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5269 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5627 Aws::KMS::Types::RetireGrantRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RevokeGrantRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5315 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5673 class Aws::KMS::Types::RevokeGrantRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5316 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5674 Aws::KMS::Types::RevokeGrantRequest::SENSITIVE = T.let(T.unsafe(nil), Array) +# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RotateKeyOnDemandRequest AWS API Documentation +# +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5710 +class Aws::KMS::Types::RotateKeyOnDemandRequest < ::Struct + include ::Aws::Structure +end + +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5711 +Aws::KMS::Types::RotateKeyOnDemandRequest::SENSITIVE = T.let(T.unsafe(nil), Array) + +# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RotateKeyOnDemandResponse AWS API Documentation +# +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5723 +class Aws::KMS::Types::RotateKeyOnDemandResponse < ::Struct + include ::Aws::Structure +end + +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5724 +Aws::KMS::Types::RotateKeyOnDemandResponse::SENSITIVE = T.let(T.unsafe(nil), Array) + +# Contains information about completed key material rotations. +# +# @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RotationsListEntry AWS API Documentation +# +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5754 +class Aws::KMS::Types::RotationsListEntry < ::Struct + include ::Aws::Structure +end + +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5755 +Aws::KMS::Types::RotationsListEntry::SENSITIVE = T.let(T.unsafe(nil), Array) + # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ScheduleKeyDeletionRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5359 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5798 class Aws::KMS::Types::ScheduleKeyDeletionRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5360 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5799 Aws::KMS::Types::ScheduleKeyDeletionRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ScheduleKeyDeletionResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5407 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5846 class Aws::KMS::Types::ScheduleKeyDeletionResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5408 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5847 Aws::KMS::Types::ScheduleKeyDeletionResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/SignRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5534 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5973 class Aws::KMS::Types::SignRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5535 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5974 Aws::KMS::Types::SignRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/SignResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5578 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6017 class Aws::KMS::Types::SignResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5579 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6018 Aws::KMS::Types::SignResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # A key-value pair. A tag consists of a tag key and a tag value. Tag @@ -10488,34 +11315,34 @@ Aws::KMS::Types::SignResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/Tag AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5611 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6050 class Aws::KMS::Types::Tag < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5612 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6051 Aws::KMS::Types::Tag::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because one or more tags are not valid. # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/TagException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5624 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6063 class Aws::KMS::Types::TagException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5625 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6064 Aws::KMS::Types::TagException::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/TagResourceRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5662 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6101 class Aws::KMS::Types::TagResourceRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5663 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6102 Aws::KMS::Types::TagResourceRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because a specified parameter is not @@ -10523,122 +11350,122 @@ Aws::KMS::Types::TagResourceRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UnsupportedOperationException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5676 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6115 class Aws::KMS::Types::UnsupportedOperationException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5677 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6116 Aws::KMS::Types::UnsupportedOperationException::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UntagResourceRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5705 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6144 class Aws::KMS::Types::UntagResourceRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5706 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6145 Aws::KMS::Types::UntagResourceRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateAliasRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5756 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6195 class Aws::KMS::Types::UpdateAliasRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5757 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6196 Aws::KMS::Types::UpdateAliasRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateCustomKeyStoreRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5911 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6350 class Aws::KMS::Types::UpdateCustomKeyStoreRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5912 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6351 Aws::KMS::Types::UpdateCustomKeyStoreRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateCustomKeyStoreResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5918 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6357 class Aws::KMS::Types::UpdateCustomKeyStoreResponse < ::Aws::EmptyStructure; end # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateKeyDescriptionRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5948 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6387 class Aws::KMS::Types::UpdateKeyDescriptionRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5949 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6388 Aws::KMS::Types::UpdateKeyDescriptionRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdatePrimaryRegionRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5983 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6422 class Aws::KMS::Types::UpdatePrimaryRegionRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#5984 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6423 Aws::KMS::Types::UpdatePrimaryRegionRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/VerifyMacRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6051 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6490 class Aws::KMS::Types::VerifyMacRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6052 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6491 Aws::KMS::Types::VerifyMacRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/VerifyMacResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6079 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6518 class Aws::KMS::Types::VerifyMacResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6080 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6519 Aws::KMS::Types::VerifyMacResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/VerifyRequest AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6209 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6648 class Aws::KMS::Types::VerifyRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6210 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6649 Aws::KMS::Types::VerifyRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/VerifyResponse AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6240 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6679 class Aws::KMS::Types::VerifyResponse < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6241 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6680 Aws::KMS::Types::VerifyResponse::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because the (`XksKeyId`) is already -# associated with a KMS key in this external key store. Each KMS key in -# an external key store must be associated with a different external -# key. +# associated with another KMS key in this external key store. Each KMS +# key in an external key store must be associated with a different +# external key. # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/XksKeyAlreadyInUseException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6256 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6695 class Aws::KMS::Types::XksKeyAlreadyInUseException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6257 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6696 Aws::KMS::Types::XksKeyAlreadyInUseException::SENSITIVE = T.let(T.unsafe(nil), Array) # Information about the [external key ][1]that is associated with a KMS @@ -10660,12 +11487,12 @@ Aws::KMS::Types::XksKeyAlreadyInUseException::SENSITIVE = T.let(T.unsafe(nil), A # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/XksKeyConfigurationType AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6287 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6726 class Aws::KMS::Types::XksKeyConfigurationType < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6288 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6727 Aws::KMS::Types::XksKeyConfigurationType::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because the external key specified by the @@ -10677,12 +11504,12 @@ Aws::KMS::Types::XksKeyConfigurationType::SENSITIVE = T.let(T.unsafe(nil), Array # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/XksKeyInvalidConfigurationException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6305 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6744 class Aws::KMS::Types::XksKeyInvalidConfigurationException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6306 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6745 Aws::KMS::Types::XksKeyInvalidConfigurationException::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because the external key store proxy could @@ -10697,12 +11524,12 @@ Aws::KMS::Types::XksKeyInvalidConfigurationException::SENSITIVE = T.let(T.unsafe # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/XksKeyNotFoundException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6326 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6765 class Aws::KMS::Types::XksKeyNotFoundException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6327 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6766 Aws::KMS::Types::XksKeyNotFoundException::SENSITIVE = T.let(T.unsafe(nil), Array) # KMS uses the authentication credential to sign requests that it sends @@ -10714,12 +11541,12 @@ Aws::KMS::Types::XksKeyNotFoundException::SENSITIVE = T.let(T.unsafe(nil), Array # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/XksProxyAuthenticationCredentialType AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6351 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6790 class Aws::KMS::Types::XksProxyAuthenticationCredentialType < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6352 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6791 Aws::KMS::Types::XksProxyAuthenticationCredentialType::SENSITIVE = T.let(T.unsafe(nil), Array) # Detailed information about the external key store proxy (XKS proxy). @@ -10730,12 +11557,12 @@ Aws::KMS::Types::XksProxyAuthenticationCredentialType::SENSITIVE = T.let(T.unsaf # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/XksProxyConfigurationType AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6405 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6844 class Aws::KMS::Types::XksProxyConfigurationType < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6406 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6845 Aws::KMS::Types::XksProxyConfigurationType::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because the proxy credentials failed to @@ -10746,26 +11573,26 @@ Aws::KMS::Types::XksProxyConfigurationType::SENSITIVE = T.let(T.unsafe(nil), Arr # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/XksProxyIncorrectAuthenticationCredentialException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6422 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6861 class Aws::KMS::Types::XksProxyIncorrectAuthenticationCredentialException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6423 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6862 Aws::KMS::Types::XksProxyIncorrectAuthenticationCredentialException::SENSITIVE = T.let(T.unsafe(nil), Array) -# The request was rejected because the Amazon VPC endpoint service -# configuration does not fulfill the requirements for an external key -# store proxy. For details, see the exception message. +# The request was rejected because the external key store proxy is not +# configured correctly. To identify the cause, see the error message +# that accompanies the exception. # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/XksProxyInvalidConfigurationException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6437 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6876 class Aws::KMS::Types::XksProxyInvalidConfigurationException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6438 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6877 Aws::KMS::Types::XksProxyInvalidConfigurationException::SENSITIVE = T.let(T.unsafe(nil), Array) # KMS cannot interpret the response it received from the external key @@ -10775,44 +11602,43 @@ Aws::KMS::Types::XksProxyInvalidConfigurationException::SENSITIVE = T.let(T.unsa # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/XksProxyInvalidResponseException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6453 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6892 class Aws::KMS::Types::XksProxyInvalidResponseException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6454 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6893 Aws::KMS::Types::XksProxyInvalidResponseException::SENSITIVE = T.let(T.unsafe(nil), Array) -# The request was rejected because the concatenation of the -# `XksProxyUriEndpoint` is already associated with an external key store -# in the Amazon Web Services account and Region. Each external key store -# in an account and Region must use a unique external key store proxy -# address. +# The request was rejected because the `XksProxyUriEndpoint` is already +# associated with another external key store in this Amazon Web Services +# Region. To identify the cause, see the error message that accompanies +# the exception. # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/XksProxyUriEndpointInUseException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6470 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6908 class Aws::KMS::Types::XksProxyUriEndpointInUseException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6471 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6909 Aws::KMS::Types::XksProxyUriEndpointInUseException::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because the concatenation of the # `XksProxyUriEndpoint` and `XksProxyUriPath` is already associated with -# an external key store in the Amazon Web Services account and Region. -# Each external key store in an account and Region must use a unique -# external key store proxy API address. +# another external key store in this Amazon Web Services Region. Each +# external key store in a Region must use a unique external key store +# proxy API address. # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/XksProxyUriInUseException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6487 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6925 class Aws::KMS::Types::XksProxyUriInUseException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6488 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6926 Aws::KMS::Types::XksProxyUriInUseException::SENSITIVE = T.let(T.unsafe(nil), Array) # KMS was unable to reach the specified `XksProxyUriPath`. The path must @@ -10825,45 +11651,47 @@ Aws::KMS::Types::XksProxyUriInUseException::SENSITIVE = T.let(T.unsafe(nil), Arr # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/XksProxyUriUnreachableException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6506 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6944 class Aws::KMS::Types::XksProxyUriUnreachableException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6507 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6945 Aws::KMS::Types::XksProxyUriUnreachableException::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because the specified Amazon VPC endpoint -# service is already associated with an external key store in the Amazon -# Web Services account and Region. Each external key store in an Amazon -# Web Services account and Region must use a different Amazon VPC -# endpoint service. +# service is already associated with another external key store in this +# Amazon Web Services Region. Each external key store in a Region must +# use a different Amazon VPC endpoint service. # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/XksProxyVpcEndpointServiceInUseException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6523 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6960 class Aws::KMS::Types::XksProxyVpcEndpointServiceInUseException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6524 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6961 Aws::KMS::Types::XksProxyVpcEndpointServiceInUseException::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because the Amazon VPC endpoint service # configuration does not fulfill the requirements for an external key -# store proxy. For details, see the exception message and [review the -# requirements](kms/latest/developerguide/vpc-connectivity.html#xks-vpc-requirements) -# for Amazon VPC endpoint service connectivity for an external key -# store. +# store. To identify the cause, see the error message that accompanies +# the exception and [review the requirements][1] for Amazon VPC endpoint +# service connectivity for an external key store. +# +# +# +# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/vpc-connectivity.html#xks-vpc-requirements # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/XksProxyVpcEndpointServiceInvalidConfigurationException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6541 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6981 class Aws::KMS::Types::XksProxyVpcEndpointServiceInvalidConfigurationException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6542 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6982 Aws::KMS::Types::XksProxyVpcEndpointServiceInvalidConfigurationException::SENSITIVE = T.let(T.unsafe(nil), Array) # The request was rejected because KMS could not find the specified VPC @@ -10875,10 +11703,10 @@ Aws::KMS::Types::XksProxyVpcEndpointServiceInvalidConfigurationException::SENSIT # # @see http://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/XksProxyVpcEndpointServiceNotFoundException AWS API Documentation # -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6559 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6999 class Aws::KMS::Types::XksProxyVpcEndpointServiceNotFoundException < ::Struct include ::Aws::Structure end -# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#6560 +# source://aws-sdk-kms//lib/aws-sdk-kms/types.rb#7000 Aws::KMS::Types::XksProxyVpcEndpointServiceNotFoundException::SENSITIVE = T.let(T.unsafe(nil), Array) diff --git a/sorbet/rbi/gems/aws-sdk-s3@1.132.1.rbi b/sorbet/rbi/gems/aws-sdk-s3@1.156.0.rbi similarity index 80% rename from sorbet/rbi/gems/aws-sdk-s3@1.132.1.rbi rename to sorbet/rbi/gems/aws-sdk-s3@1.156.0.rbi index 1200f612b..dd3168b0a 100644 --- a/sorbet/rbi/gems/aws-sdk-s3@1.132.1.rbi +++ b/sorbet/rbi/gems/aws-sdk-s3@1.156.0.rbi @@ -8,28 +8,28 @@ # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/accelerate.rb#3 module Aws class << self - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core.rb#133 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core.rb#138 def config; end - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core.rb#136 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core.rb#141 def config=(config); end - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core.rb#195 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core.rb#200 def eager_autoload!(*args); end - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core.rb#188 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core.rb#193 def empty_connection_pools!; end - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core.rb#145 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core.rb#150 def partition(partition_name); end - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core.rb#150 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core.rb#155 def partitions; end - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core.rb#126 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core.rb#131 def shared_config; end - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core.rb#165 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core.rb#170 def use_bundled_cert!; end end end @@ -62,15 +62,160 @@ end # See {Errors} for more information. # # source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10 -module Aws::S3; end +module Aws::S3 + class << self + # @api private + # + # source://aws-sdk-s3//lib/aws-sdk-s3/access_grants_credentials_provider.rb#11 + def access_grants_account_id_cache; end + + # @api private + # + # source://aws-sdk-s3//lib/aws-sdk-s3/access_grants_credentials_provider.rb#6 + def access_grants_credentials_cache; end + + # @api private + # + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#8 + def bucket_region_cache; end + + # @api private + # + # source://aws-sdk-s3//lib/aws-sdk-s3/express_credentials_provider.rb#6 + def express_credentials_cache; end + end +end # source://aws-sdk-s3//lib/aws-sdk-s3/encryption.rb#20 Aws::S3::AES_GCM_TAG_LEN_BYTES = T.let(T.unsafe(nil), Integer) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/bucket_region_cache.rb#78 -Aws::S3::BUCKET_REGIONS = T.let(T.unsafe(nil), Aws::S3::BucketRegionCache) +# source://aws-sdk-s3//lib/aws-sdk-s3/access_grants_credentials.rb#8 +class Aws::S3::AccessGrantsCredentials + include ::Aws::CredentialProvider + include ::Aws::RefreshingCredentials + + # @api private + # @return [AccessGrantsCredentials] a new instance of AccessGrantsCredentials + # + # source://aws-sdk-s3//lib/aws-sdk-s3/access_grants_credentials.rb#12 + def initialize(options = T.unsafe(nil)); end + + # @api private + # @return [S3Control::Client] + # + # source://aws-sdk-s3//lib/aws-sdk-s3/access_grants_credentials.rb#25 + def client; end + + # @api private + # @return [String] + # + # source://aws-sdk-s3//lib/aws-sdk-s3/access_grants_credentials.rb#28 + def matched_grant_target; end + + private + + # @api private + # + # source://aws-sdk-s3//lib/aws-sdk-s3/access_grants_credentials.rb#32 + def refresh; end + + class << self + # @api private + # + # source://aws-sdk-s3//lib/aws-sdk-s3/access_grants_credentials.rb#47 + def get_data_access_options; end + end +end + +# Returns Credentials class for S3 Access Grants. Accepts GetDataAccess +# params and other configuration as options. See +# {Aws::S3Control::Client#get_data_access} for details. +# +# source://aws-sdk-s3//lib/aws-sdk-s3/access_grants_credentials_provider.rb#21 +class Aws::S3::AccessGrantsCredentialsProvider + # @option options + # @option options + # @option options + # @option options + # @option options + # @option options + # @option options + # @param options [Hash] + # @return [AccessGrantsCredentialsProvider] a new instance of AccessGrantsCredentialsProvider + # + # source://aws-sdk-s3//lib/aws-sdk-s3/access_grants_credentials_provider.rb#42 + def initialize(options = T.unsafe(nil)); end + + # source://aws-sdk-s3//lib/aws-sdk-s3/access_grants_credentials_provider.rb#56 + def access_grants_credentials_for(options = T.unsafe(nil)); end + + # Returns the value of attribute s3_client. + # + # source://aws-sdk-s3//lib/aws-sdk-s3/access_grants_credentials_provider.rb#77 + def s3_client; end + + # Sets the attribute s3_client + # + # @param value the value to set the attribute s3_client to. + # + # source://aws-sdk-s3//lib/aws-sdk-s3/access_grants_credentials_provider.rb#77 + def s3_client=(_arg0); end + + private + + # source://aws-sdk-s3//lib/aws-sdk-s3/access_grants_credentials_provider.rb#154 + def account_id_for_access_grants(target, credentials); end + + # returns the account id for the configured credentials + # + # source://aws-sdk-s3//lib/aws-sdk-s3/access_grants_credentials_provider.rb#204 + def account_id_for_credentials(region, credentials); end + + # source://aws-sdk-s3//lib/aws-sdk-s3/access_grants_credentials_provider.rb#131 + def broad_search_credentials_cache_characters(target, permission, credentials); end + + # source://aws-sdk-s3//lib/aws-sdk-s3/access_grants_credentials_provider.rb#120 + def broad_search_credentials_cache_prefix(target, permission, credentials); end + + # extracts bucket name from target prefix + # + # source://aws-sdk-s3//lib/aws-sdk-s3/access_grants_credentials_provider.rb#236 + def bucket_name_from(target); end + + # source://aws-sdk-s3//lib/aws-sdk-s3/access_grants_credentials_provider.rb#183 + def bucket_region_for_access_grants(target); end + + # source://aws-sdk-s3//lib/aws-sdk-s3/access_grants_credentials_provider.rb#162 + def cached_account_id_for(target, credentials); end + + # source://aws-sdk-s3//lib/aws-sdk-s3/access_grants_credentials_provider.rb#189 + def cached_bucket_region_for(bucket); end + + # source://aws-sdk-s3//lib/aws-sdk-s3/access_grants_credentials_provider.rb#93 + def cached_credentials_for(target, permission, credentials); end + + # source://aws-sdk-s3//lib/aws-sdk-s3/access_grants_credentials_provider.rb#230 + def credentials_cache_key(target, permission, credentials); end + + # returns the account id associated with the access grants instance + # + # source://aws-sdk-s3//lib/aws-sdk-s3/access_grants_credentials_provider.rb#173 + def new_account_id_for(target, credentials); end + + # source://aws-sdk-s3//lib/aws-sdk-s3/access_grants_credentials_provider.rb#197 + def new_bucket_region_for(bucket); end + + # source://aws-sdk-s3//lib/aws-sdk-s3/access_grants_credentials_provider.rb#142 + def new_credentials_for(target, permission, credentials); end + + # source://aws-sdk-s3//lib/aws-sdk-s3/access_grants_credentials_provider.rb#81 + def s3_control_client(bucket_region); end + + # source://aws-sdk-s3//lib/aws-sdk-s3/access_grants_credentials_provider.rb#220 + def target_prefix(bucket, key, prefix); end +end # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#12 class Aws::S3::Bucket @@ -85,7 +230,7 @@ class Aws::S3::Bucket # @return [BucketAcl] # - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#695 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#955 def acl; end # Deletes all objects and versioned objects from this bucket @@ -105,7 +250,7 @@ class Aws::S3::Bucket # @return [BucketCors] # - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#703 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#963 def cors; end # @example Request syntax with placeholder values @@ -113,7 +258,15 @@ class Aws::S3::Bucket # bucket.create({ # acl: "private", # accepts private, public-read, public-read-write, authenticated-read # create_bucket_configuration: { - # location_constraint: "af-south-1", # accepts af-south-1, ap-east-1, ap-northeast-1, ap-northeast-2, ap-northeast-3, ap-south-1, ap-southeast-1, ap-southeast-2, ap-southeast-3, ca-central-1, cn-north-1, cn-northwest-1, EU, eu-central-1, eu-north-1, eu-south-1, eu-west-1, eu-west-2, eu-west-3, me-south-1, sa-east-1, us-east-2, us-gov-east-1, us-gov-west-1, us-west-1, us-west-2, ap-south-2, eu-south-2 + # location_constraint: "af-south-1", # accepts af-south-1, ap-east-1, ap-northeast-1, ap-northeast-2, ap-northeast-3, ap-south-1, ap-south-2, ap-southeast-1, ap-southeast-2, ap-southeast-3, ca-central-1, cn-north-1, cn-northwest-1, EU, eu-central-1, eu-north-1, eu-south-1, eu-south-2, eu-west-1, eu-west-2, eu-west-3, me-south-1, sa-east-1, us-east-2, us-gov-east-1, us-gov-west-1, us-west-1, us-west-2 + # location: { + # type: "AvailabilityZone", # accepts AvailabilityZone + # name: "LocationNameAsString", + # }, + # bucket: { + # data_redundancy: "SingleAvailabilityZone", # accepts SingleAvailabilityZone + # type: "Directory", # accepts Directory + # }, # }, # grant_full_control: "GrantFullControl", # grant_read: "GrantRead", @@ -135,7 +288,7 @@ class Aws::S3::Bucket # @param options [Hash] ({}) # @return [Types::CreateBucketOutput] # - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#282 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#335 def create(options = T.unsafe(nil)); end # Date the bucket was created. This date can change when making changes @@ -167,7 +320,7 @@ class Aws::S3::Bucket # @param options [Hash] ({}) # @return [EmptyStructure] # - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#301 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#360 def delete(options = T.unsafe(nil)); end # Deletes all objects and versioned objects from this bucket and @@ -211,10 +364,10 @@ class Aws::S3::Bucket # @param options [Hash] ({}) # @return [Types::DeleteObjectsOutput] # - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#372 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#474 def delete_objects(options = T.unsafe(nil)); end - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#1024 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#1367 def deprecated_identifiers; end # @param options [Hash] ({}) @@ -226,17 +379,17 @@ class Aws::S3::Bucket # @api private # @deprecated # - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core/deprecations.rb#65 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core/deprecations.rb#65 def identifiers(*args, &block); end # @return [BucketLifecycle] # - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#711 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#971 def lifecycle; end # @return [BucketLifecycleConfiguration] # - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#719 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#979 def lifecycle_configuration; end # @api private @@ -246,7 +399,7 @@ class Aws::S3::Bucket # @return [BucketLogging] # - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#727 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#987 def logging; end # @example Request syntax with placeholder values @@ -270,7 +423,7 @@ class Aws::S3::Bucket # @param options [Hash] ({}) # @return [MultipartUpload::Collection] # - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#801 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#1097 def multipart_uploads(options = T.unsafe(nil)); end # @return [String] @@ -280,13 +433,13 @@ class Aws::S3::Bucket # @return [BucketNotification] # - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#825 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#1121 def notification; end # @param key [String] # @return [Object] # - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#834 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#1130 def object(key); end # @example Request syntax with placeholder values @@ -312,7 +465,7 @@ class Aws::S3::Bucket # @param options [Hash] ({}) # @return [ObjectVersion::Collection] # - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#898 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#1200 def object_versions(options = T.unsafe(nil)); end # @example Request syntax with placeholder values @@ -338,12 +491,12 @@ class Aws::S3::Bucket # @param options [Hash] ({}) # @return [ObjectSummary::Collection] # - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#960 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#1303 def objects(options = T.unsafe(nil)); end # @return [BucketPolicy] # - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#983 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#1326 def policy; end # Creates a {PresignedPost} that makes it easy to upload a file from @@ -418,7 +571,7 @@ class Aws::S3::Bucket # "MetadataKey" => "MetadataValue", # }, # server_side_encryption: "AES256", # accepts AES256, aws:kms, aws:kms:dsse - # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW + # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW, EXPRESS_ONEZONE # website_redirect_location: "WebsiteRedirectLocation", # sse_customer_algorithm: "SSECustomerAlgorithm", # sse_customer_key: "SSECustomerKey", @@ -472,7 +625,7 @@ class Aws::S3::Bucket # @param options [Hash] ({}) # @return [Object] # - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#680 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#940 def put_object(options = T.unsafe(nil)); end # @api private @@ -483,12 +636,12 @@ class Aws::S3::Bucket # @return [BucketRequestPayment] # - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#991 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#1334 def request_payment; end # @return [BucketTagging] # - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#999 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#1342 def tagging; end # Returns a public URL for this bucket. @@ -524,7 +677,7 @@ class Aws::S3::Bucket # @return [BucketVersioning] # - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#1007 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#1350 def versioning; end # Waiter polls an API operation until a resource enters a desired @@ -629,24 +782,24 @@ class Aws::S3::Bucket # @return [BucketWebsite] # - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#1015 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#1358 def website; end private - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#1031 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#1374 def extract_name(args, options); end - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#1052 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#1395 def separate_params_and_options(options); end # @yield [waiter.waiter] # - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#1042 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#1385 def yield_waiter_and_warn(waiter, &block); end end -# source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#1069 +# source://aws-sdk-s3//lib/aws-sdk-s3/bucket.rb#1412 class Aws::S3::Bucket::Collection < ::Aws::Resources::Collection; end # source://aws-sdk-s3//lib/aws-sdk-s3/bucket_acl.rb#12 @@ -700,7 +853,7 @@ class Aws::S3::BucketAcl # @api private # @deprecated # - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core/deprecations.rb#65 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core/deprecations.rb#65 def identifiers(*args, &block); end # Loads, or reloads {#data} for the current {BucketAcl}. @@ -930,7 +1083,7 @@ class Aws::S3::BucketCors # @api private # @deprecated # - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core/deprecations.rb#65 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core/deprecations.rb#65 def identifiers(*args, &block); end # Loads, or reloads {#data} for the current {BucketCors}. @@ -1127,7 +1280,7 @@ class Aws::S3::BucketLifecycle # @api private # @deprecated # - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core/deprecations.rb#65 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core/deprecations.rb#65 def identifiers(*args, &block); end # Loads, or reloads {#data} for the current {BucketLifecycle}. @@ -1350,7 +1503,7 @@ class Aws::S3::BucketLifecycleConfiguration # @api private # @deprecated # - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core/deprecations.rb#65 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core/deprecations.rb#65 def identifiers(*args, &block); end # Loads, or reloads {#data} for the current {BucketLifecycleConfiguration}. @@ -1552,7 +1705,7 @@ class Aws::S3::BucketLogging # @return [Bucket] # - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket_logging.rb#252 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket_logging.rb#259 def bucket; end # @return [String] @@ -1577,13 +1730,13 @@ class Aws::S3::BucketLogging # source://aws-sdk-s3//lib/aws-sdk-s3/bucket_logging.rb#82 def data_loaded?; end - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket_logging.rb#261 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket_logging.rb#268 def deprecated_identifiers; end # @api private # @deprecated # - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core/deprecations.rb#65 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core/deprecations.rb#65 def identifiers(*args, &block); end # Loads, or reloads {#data} for the current {BucketLogging}. @@ -1628,6 +1781,13 @@ class Aws::S3::BucketLogging # }, # ], # target_prefix: "TargetPrefix", # required + # target_object_key_format: { + # simple_prefix: { + # }, + # partitioned_prefix: { + # partition_date_source: "EventTime", # accepts EventTime, DeliveryTime + # }, + # }, # }, # }, # content_md5: "ContentMD5", @@ -1641,7 +1801,7 @@ class Aws::S3::BucketLogging # @param options [Hash] ({}) # @return [EmptyStructure] # - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket_logging.rb#241 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket_logging.rb#248 def put(options = T.unsafe(nil)); end # Loads, or reloads {#data} for the current {BucketLogging}. @@ -1736,11 +1896,11 @@ class Aws::S3::BucketLogging private - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket_logging.rb#268 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket_logging.rb#275 def extract_bucket_name(args, options); end end -# source://aws-sdk-s3//lib/aws-sdk-s3/bucket_logging.rb#279 +# source://aws-sdk-s3//lib/aws-sdk-s3/bucket_logging.rb#286 class Aws::S3::BucketLogging::Collection < ::Aws::Resources::Collection; end # source://aws-sdk-s3//lib/aws-sdk-s3/bucket_notification.rb#12 @@ -1794,7 +1954,7 @@ class Aws::S3::BucketNotification # @api private # @deprecated # - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core/deprecations.rb#65 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core/deprecations.rb#65 def identifiers(*args, &block); end # Describes the Lambda functions to invoke and the events for which to @@ -2013,7 +2173,7 @@ class Aws::S3::BucketPolicy # @return [Bucket] # - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket_policy.rb#252 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket_policy.rb#296 def bucket; end # @return [String] @@ -2047,16 +2207,16 @@ class Aws::S3::BucketPolicy # @param options [Hash] ({}) # @return [EmptyStructure] # - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket_policy.rb#192 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket_policy.rb#198 def delete(options = T.unsafe(nil)); end - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket_policy.rb#261 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket_policy.rb#305 def deprecated_identifiers; end # @api private # @deprecated # - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core/deprecations.rb#65 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core/deprecations.rb#65 def identifiers(*args, &block); end # Loads, or reloads {#data} for the current {BucketPolicy}. @@ -2093,7 +2253,7 @@ class Aws::S3::BucketPolicy # @param options [Hash] ({}) # @return [EmptyStructure] # - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket_policy.rb#241 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket_policy.rb#285 def put(options = T.unsafe(nil)); end # Loads, or reloads {#data} for the current {BucketPolicy}. @@ -2188,11 +2348,11 @@ class Aws::S3::BucketPolicy private - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket_policy.rb#268 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket_policy.rb#312 def extract_bucket_name(args, options); end end -# source://aws-sdk-s3//lib/aws-sdk-s3/bucket_policy.rb#279 +# source://aws-sdk-s3//lib/aws-sdk-s3/bucket_policy.rb#323 class Aws::S3::BucketPolicy::Collection < ::Aws::Resources::Collection; end # source://aws-sdk-s3//lib/aws-sdk-s3/bucket_region_cache.rb#7 @@ -2224,7 +2384,7 @@ class Aws::S3::BucketRegionCache # Registers a block as a callback. This listener is called when a # new bucket/region pair is added to the cache. # - # S3::BUCKET_REGIONS.bucket_added do |bucket_name, region_name| + # Aws::S3.bucket_region_cache.bucket_added do |bucket_name, region_name| # # ... # end # @@ -2246,17 +2406,23 @@ class Aws::S3::BucketRegionCache # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket_region_cache.rb#63 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket_region_cache.rb#71 def clear; end + # @param key [String] + # @return [Boolean] + # + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket_region_cache.rb#64 + def key?(key); end + # @return [Hash] Returns a hash of cached bucket names and region names. # - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket_region_cache.rb#68 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket_region_cache.rb#76 def to_h; end # @return [Hash] Returns a hash of cached bucket names and region names. # - # source://aws-sdk-s3//lib/aws-sdk-s3/bucket_region_cache.rb#68 + # source://aws-sdk-s3//lib/aws-sdk-s3/bucket_region_cache.rb#76 def to_hash; end end @@ -2304,7 +2470,7 @@ class Aws::S3::BucketRequestPayment # @api private # @deprecated # - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core/deprecations.rb#65 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core/deprecations.rb#65 def identifiers(*args, &block); end # Loads, or reloads {#data} for the current {BucketRequestPayment}. @@ -2499,7 +2665,7 @@ class Aws::S3::BucketTagging # @api private # @deprecated # - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core/deprecations.rb#65 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core/deprecations.rb#65 def identifiers(*args, &block); end # Loads, or reloads {#data} for the current {BucketTagging}. @@ -2705,7 +2871,7 @@ class Aws::S3::BucketVersioning # @api private # @deprecated # - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core/deprecations.rb#65 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core/deprecations.rb#65 def identifiers(*args, &block); end # Loads, or reloads {#data} for the current {BucketVersioning}. @@ -2939,7 +3105,7 @@ class Aws::S3::BucketWebsite # @api private # @deprecated # - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core/deprecations.rb#65 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core/deprecations.rb#65 def identifiers(*args, &block); end # The name of the index document for the website (for example @@ -3132,17 +3298,17 @@ class Aws::S3::BucketWebsite::Collection < ::Aws::Resources::Collection; end # # See {#initialize} for a full list of supported configuration options. # -# source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#71 +# source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#74 class Aws::S3::Client < ::Seahorse::Client::Base include ::Aws::ClientStubs # @overload initialize # @return [Client] a new instance of Client # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#471 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#529 def initialize(*args); end - # This action aborts a multipart upload. After a multipart upload is + # This operation aborts a multipart upload. After a multipart upload is # aborted, no additional parts can be uploaded using that upload ID. The # storage consumed by any previously uploaded parts will be freed. # However, if any part uploads are currently in progress, those part @@ -3150,33 +3316,66 @@ class Aws::S3::Client < ::Seahorse::Client::Base # to abort a given multipart upload multiple times in order to # completely free all storage consumed by all parts. # - # To verify that all parts have been removed, so you don't get charged - # for the part storage, you should call the [ListParts][1] action and - # ensure that the parts list is empty. + # To verify that all parts have been removed and prevent getting charged + # for the part storage, you should call the [ListParts][1] API operation + # and ensure that the parts list is empty. + # + # **Directory buckets** - For directory buckets, you must make requests + # for this API operation to the Zonal endpoint. These endpoints support + # virtual-hosted-style requests in the format + # `https://bucket_name.s3express-az_id.region.amazonaws.com/key-name `. + # Path-style requests are not supported. For more information, see + # [Regional and Zonal endpoints][2] in the *Amazon S3 User Guide*. # - # For information about permissions required to use the multipart - # upload, see [Multipart Upload and Permissions][2]. + # + # + # Permissions + # : * **General purpose bucket permissions** - For information about + # permissions required to use the multipart upload, see [Multipart + # Upload and Permissions][3] in the *Amazon S3 User Guide*. + # + # * **Directory bucket permissions** - To grant access to this API + # operation on a directory bucket, we recommend that you use the [ + # `CreateSession` ][4] API operation for session-based + # authorization. Specifically, you grant the + # `s3express:CreateSession` permission to the directory bucket in a + # bucket policy or an IAM identity-based policy. Then, you make the + # `CreateSession` API call on the bucket to obtain a session token. + # With the session token in your request header, you can make API + # requests to this operation. After the session token expires, you + # make another `CreateSession` API call to generate a new session + # token for use. Amazon Web Services CLI or SDKs create session and + # refresh the session token automatically to avoid service + # interruptions when a session expires. For more information about + # authorization, see [ `CreateSession` ][4]. + # + # HTTP Host header syntax + # + # : Directory buckets - The HTTP Host header syntax is ` + # Bucket_name.s3express-az_id.region.amazonaws.com`. # # The following operations are related to `AbortMultipartUpload`: # - # * [CreateMultipartUpload][3] + # * [CreateMultipartUpload][5] # - # * [UploadPart][4] + # * [UploadPart][6] # - # * [CompleteMultipartUpload][5] + # * [CompleteMultipartUpload][7] # # * [ListParts][1] # - # * [ListMultipartUploads][6] + # * [ListMultipartUploads][8] # # # # [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html - # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html - # [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html - # [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html - # [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html - # [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html + # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html + # [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html + # [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html + # [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html + # [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html + # [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html + # [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html # # @example Example: To abort a multipart upload # @@ -3215,114 +3414,151 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::AbortMultipartUploadOutput#request_charged #request_charged} => String # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/AbortMultipartUpload AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#597 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#713 def abort_multipart_upload(params = T.unsafe(nil), options = T.unsafe(nil)); end # @api private # @param params [{}] # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#15647 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#18857 def build_request(operation_name, params = T.unsafe(nil)); end # Completes a multipart upload by assembling previously uploaded parts. # # You first initiate the multipart upload and then upload all parts - # using the [UploadPart][1] operation. After successfully uploading all - # relevant parts of an upload, you call this action to complete the - # upload. Upon receiving this request, Amazon S3 concatenates all the - # parts in ascending order by part number to create a new object. In the - # Complete Multipart Upload request, you must provide the parts list. - # You must ensure that the parts list is complete. This action - # concatenates the parts that you provide in the list. For each part in - # the list, you must provide the part number and the `ETag` value, - # returned after that part was uploaded. - # - # Processing of a Complete Multipart Upload request could take several - # minutes to complete. After Amazon S3 begins processing the request, it - # sends an HTTP response header that specifies a 200 OK response. While - # processing is in progress, Amazon S3 periodically sends white space - # characters to keep the connection from timing out. A request could - # fail after the initial 200 OK response has been sent. This means that - # a `200 OK` response can contain either a success or an error. If you - # call the S3 API directly, make sure to design your application to - # parse the contents of the response and handle it appropriately. If you - # use Amazon Web Services SDKs, SDKs handle this condition. The SDKs - # detect the embedded error and apply error handling per your - # configuration settings (including automatically retrying the request - # as appropriate). If the condition persists, the SDKs throws an - # exception (or, for the SDKs that don't use exceptions, they return - # the error). + # using the [UploadPart][1] operation or the [UploadPartCopy][2] + # operation. After successfully uploading all relevant parts of an + # upload, you call this `CompleteMultipartUpload` operation to complete + # the upload. Upon receiving this request, Amazon S3 concatenates all + # the parts in ascending order by part number to create a new object. In + # the CompleteMultipartUpload request, you must provide the parts list + # and ensure that the parts list is complete. The + # CompleteMultipartUpload API operation concatenates the parts that you + # provide in the list. For each part in the list, you must provide the + # `PartNumber` value and the `ETag` value that are returned after that + # part was uploaded. + # + # The processing of a CompleteMultipartUpload request could take several + # minutes to finalize. After Amazon S3 begins processing the request, it + # sends an HTTP response header that specifies a `200 OK` response. + # While processing is in progress, Amazon S3 periodically sends white + # space characters to keep the connection from timing out. A request + # could fail after the initial `200 OK` response has been sent. This + # means that a `200 OK` response can contain either a success or an + # error. The error response might be embedded in the `200 OK` response. + # If you call this API operation directly, make sure to design your + # application to parse the contents of the response and handle it + # appropriately. If you use Amazon Web Services SDKs, SDKs handle this + # condition. The SDKs detect the embedded error and apply error handling + # per your configuration settings (including automatically retrying the + # request as appropriate). If the condition persists, the SDKs throw an + # exception (or, for the SDKs that don't use exceptions, they return an + # error). # # Note that if `CompleteMultipartUpload` fails, applications should be - # prepared to retry the failed requests. For more information, see - # [Amazon S3 Error Best Practices][2]. + # prepared to retry any failed requests (including 500 error responses). + # For more information, see [Amazon S3 Error Best Practices][3]. # - # You cannot use `Content-Type: application/x-www-form-urlencoded` with - # Complete Multipart Upload requests. Also, if you do not provide a - # `Content-Type` header, `CompleteMultipartUpload` returns a 200 OK - # response. + # You can't use `Content-Type: application/x-www-form-urlencoded` for + # the CompleteMultipartUpload requests. Also, if you don't provide a + # `Content-Type` header, `CompleteMultipartUpload` can still return a + # `200 OK` response. # # For more information about multipart uploads, see [Uploading Objects - # Using Multipart Upload][3]. + # Using Multipart Upload][4] in the *Amazon S3 User Guide*. + # + # **Directory buckets** - For directory buckets, you must make requests + # for this API operation to the Zonal endpoint. These endpoints support + # virtual-hosted-style requests in the format + # `https://bucket_name.s3express-az_id.region.amazonaws.com/key-name `. + # Path-style requests are not supported. For more information, see + # [Regional and Zonal endpoints][5] in the *Amazon S3 User Guide*. + # + # + # + # Permissions + # : * **General purpose bucket permissions** - For information about + # permissions required to use the multipart upload API, see + # [Multipart Upload and Permissions][6] in the *Amazon S3 User + # Guide*. + # + # * **Directory bucket permissions** - To grant access to this API + # operation on a directory bucket, we recommend that you use the [ + # `CreateSession` ][7] API operation for session-based + # authorization. Specifically, you grant the + # `s3express:CreateSession` permission to the directory bucket in a + # bucket policy or an IAM identity-based policy. Then, you make the + # `CreateSession` API call on the bucket to obtain a session token. + # With the session token in your request header, you can make API + # requests to this operation. After the session token expires, you + # make another `CreateSession` API call to generate a new session + # token for use. Amazon Web Services CLI or SDKs create session and + # refresh the session token automatically to avoid service + # interruptions when a session expires. For more information about + # authorization, see [ `CreateSession` ][7]. # - # For information about permissions required to use the multipart upload - # API, see [Multipart Upload and Permissions][4]. + # Special errors + # : * Error Code: `EntityTooSmall` # - # `CompleteMultipartUpload` has the following special errors: + # * Description: Your proposed upload is smaller than the minimum + # allowed object size. Each part must be at least 5 MB in size, + # except the last part. # - # * Error code: `EntityTooSmall` + # * HTTP Status Code: 400 Bad Request # - # * Description: Your proposed upload is smaller than the minimum - # allowed object size. Each part must be at least 5 MB in size, - # except the last part. + # * Error Code: `InvalidPart` # - # * 400 Bad Request + # * Description: One or more of the specified parts could not be + # found. The part might not have been uploaded, or the specified + # ETag might not have matched the uploaded part's ETag. # - # * Error code: `InvalidPart` + # * HTTP Status Code: 400 Bad Request # - # * Description: One or more of the specified parts could not be - # found. The part might not have been uploaded, or the specified - # entity tag might not have matched the part's entity tag. + # * Error Code: `InvalidPartOrder` # - # * 400 Bad Request + # * Description: The list of parts was not in ascending order. The + # parts list must be specified in order by part number. # - # * Error code: `InvalidPartOrder` + # * HTTP Status Code: 400 Bad Request # - # * Description: The list of parts was not in ascending order. The - # parts list must be specified in order by part number. + # * Error Code: `NoSuchUpload` # - # * 400 Bad Request + # * Description: The specified multipart upload does not exist. The + # upload ID might be invalid, or the multipart upload might have + # been aborted or completed. # - # * Error code: `NoSuchUpload` + # * HTTP Status Code: 404 Not Found # - # * Description: The specified multipart upload does not exist. The - # upload ID might be invalid, or the multipart upload might have - # been aborted or completed. + # HTTP Host header syntax # - # * 404 Not Found + # : Directory buckets - The HTTP Host header syntax is ` + # Bucket_name.s3express-az_id.region.amazonaws.com`. # # The following operations are related to `CompleteMultipartUpload`: # - # * [CreateMultipartUpload][5] + # * [CreateMultipartUpload][8] # # * [UploadPart][1] # - # * [AbortMultipartUpload][6] + # * [AbortMultipartUpload][9] # - # * [ListParts][7] + # * [ListParts][10] # - # * [ListMultipartUploads][8] + # * [ListMultipartUploads][11] # # # # [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html - # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ErrorBestPractices.html - # [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html - # [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html - # [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html - # [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html - # [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html - # [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html + # [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html + # [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ErrorBestPractices.html + # [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html + # [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html + # [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html + # [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html + # [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html + # [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html + # [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html + # [11]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html # # @example Example: To complete multipart upload # @@ -3430,7 +3666,7 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::CompleteMultipartUploadOutput#request_charged #request_charged} => String # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CompleteMultipartUpload AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#924 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#1115 def complete_multipart_upload(params = T.unsafe(nil), options = T.unsafe(nil)); end # Creates a copy of an object that is already stored in Amazon S3. @@ -3444,232 +3680,157 @@ class Aws::S3::Client < ::Seahorse::Client::Base # # # - # All copy requests must be authenticated. Additionally, you must have - # *read* access to the source object and *write* access to the - # destination bucket. For more information, see [REST - # Authentication][2]. Both the Region that you want to copy the object - # from and the Region that you want to copy the object to must be - # enabled for your account. - # - # A copy request might return an error when Amazon S3 receives the copy - # request or while Amazon S3 is copying the files. If the error occurs - # before the copy action starts, you receive a standard Amazon S3 error. - # If the error occurs during the copy operation, the error response is - # embedded in the `200 OK` response. This means that a `200 OK` response - # can contain either a success or an error. If you call the S3 API - # directly, make sure to design your application to parse the contents - # of the response and handle it appropriately. If you use Amazon Web - # Services SDKs, SDKs handle this condition. The SDKs detect the - # embedded error and apply error handling per your configuration - # settings (including automatically retrying the request as - # appropriate). If the condition persists, the SDKs throws an exception - # (or, for the SDKs that don't use exceptions, they return the error). - # - # If the copy is successful, you receive a response with information - # about the copied object. - # - # If the request is an HTTP 1.1 request, the response is chunk encoded. - # If it were not, it would not contain the content-length, and you would - # need to read the entire body. + # You can copy individual objects between general purpose buckets, + # between directory buckets, and between general purpose buckets and + # directory buckets. + # + # Directory buckets - For directory buckets, you must make + # requests for this API operation to the Zonal endpoint. These endpoints + # support virtual-hosted-style requests in the format + # `https://bucket_name.s3express-az_id.region.amazonaws.com/key-name `. + # Path-style requests are not supported. For more information, see + # [Regional and Zonal endpoints][2] in the *Amazon S3 User Guide*. # # # - # The copy request charge is based on the storage class and Region that - # you specify for the destination object. The request can also result in - # a data retrieval charge for the source if the source storage class - # bills for data retrieval. For pricing information, see [Amazon S3 - # pricing][3]. + # Both the Region that you want to copy the object from and the Region + # that you want to copy the object to must be enabled for your account. + # For more information about how to enable a Region for your account, + # see [Enable or disable a Region for standalone accounts][3] in the + # *Amazon Web Services Account Management Guide*. # # Amazon S3 transfer acceleration does not support cross-Region copies. # If you request a cross-Region copy using a transfer acceleration - # endpoint, you get a 400 `Bad Request` error. For more information, see + # endpoint, you get a `400 Bad Request` error. For more information, see # [Transfer Acceleration][4]. # - # Metadata - # - # : When copying an object, you can preserve all metadata (the default) - # or specify new metadata. However, the access control list (ACL) is - # not preserved and is set to private for the user making the request. - # To override the default ACL setting, specify a new ACL when - # generating a copy request. For more information, see [Using - # ACLs][5]. - # - # To specify whether you want the object metadata copied from the - # source object or replaced with metadata provided in the request, you - # can optionally add the `x-amz-metadata-directive` header. When you - # grant permissions, you can use the `s3:x-amz-metadata-directive` - # condition key to enforce certain metadata behavior when objects are - # uploaded. For more information, see [Specifying Conditions in a - # Policy][6] in the *Amazon S3 User Guide*. For a complete list of - # Amazon S3-specific condition keys, see [Actions, Resources, and - # Condition Keys for Amazon S3][7]. - # - # `x-amz-website-redirect-location` is unique to each object and must - # be specified in the request headers to copy the value. - # - # - # - # x-amz-copy-source-if Headers + # Authentication and authorization # - # : To only copy an object under certain conditions, such as whether the - # `Etag` matches or whether the object was modified before or after a - # specified date, use the following request parameters: + # : All `CopyObject` requests must be authenticated and signed by using + # IAM credentials (access key ID and secret access key for the IAM + # identities). All headers with the `x-amz-` prefix, including + # `x-amz-copy-source`, must be signed. For more information, see [REST + # Authentication][5]. # - # * `x-amz-copy-source-if-match` + # **Directory buckets** - You must use the IAM credentials to + # authenticate and authorize your access to the `CopyObject` API + # operation, instead of using the temporary security credentials + # through the `CreateSession` API operation. # - # * `x-amz-copy-source-if-none-match` + # Amazon Web Services CLI or SDKs handles authentication and + # authorization on your behalf. # - # * `x-amz-copy-source-if-unmodified-since` - # - # * `x-amz-copy-source-if-modified-since` - # - # If both the `x-amz-copy-source-if-match` and - # `x-amz-copy-source-if-unmodified-since` headers are present in the - # request and evaluate as follows, Amazon S3 returns `200 OK` and - # copies the data: - # - # * `x-amz-copy-source-if-match` condition evaluates to true - # - # * `x-amz-copy-source-if-unmodified-since` condition evaluates to - # false - # - # If both the `x-amz-copy-source-if-none-match` and - # `x-amz-copy-source-if-modified-since` headers are present in the - # request and evaluate as follows, Amazon S3 returns the `412 - # Precondition Failed` response code: - # - # * `x-amz-copy-source-if-none-match` condition evaluates to false - # - # * `x-amz-copy-source-if-modified-since` condition evaluates to true - # - # All headers with the `x-amz-` prefix, including `x-amz-copy-source`, - # must be signed. - # - # - # - # Server-side encryption - # - # : Amazon S3 automatically encrypts all new objects that are copied to - # an S3 bucket. When copying an object, if you don't specify - # encryption information in your copy request, the encryption setting - # of the target object is set to the default encryption configuration - # of the destination bucket. By default, all buckets have a base level - # of encryption configuration that uses server-side encryption with - # Amazon S3 managed keys (SSE-S3). If the destination bucket has a - # default encryption configuration that uses server-side encryption - # with Key Management Service (KMS) keys (SSE-KMS), dual-layer - # server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), - # or server-side encryption with customer-provided encryption keys - # (SSE-C), Amazon S3 uses the corresponding KMS key, or a - # customer-provided key to encrypt the target object copy. - # - # When you perform a `CopyObject` operation, if you want to use a - # different type of encryption setting for the target object, you can - # use other appropriate encryption-related headers to encrypt the - # target object with a KMS key, an Amazon S3 managed key, or a - # customer-provided key. With server-side encryption, Amazon S3 - # encrypts your data as it writes your data to disks in its data - # centers and decrypts the data when you access it. If the encryption - # setting in your request is different from the default encryption - # configuration of the destination bucket, the encryption setting in - # your request takes precedence. If the source object for the copy is - # stored in Amazon S3 using SSE-C, you must provide the necessary - # encryption information in your request so that Amazon S3 can decrypt - # the object for copying. For more information about server-side - # encryption, see [Using Server-Side Encryption][8]. - # - # If a target object uses SSE-KMS, you can enable an S3 Bucket Key for - # the object. For more information, see [Amazon S3 Bucket Keys][9] in - # the *Amazon S3 User Guide*. - # - # Access Control List (ACL)-Specific Request Headers - # - # : When copying an object, you can optionally use headers to grant - # ACL-based permissions. By default, all objects are private. Only the - # owner has full access control. When adding a new object, you can - # grant permissions to individual Amazon Web Services accounts or to - # predefined groups that are defined by Amazon S3. These permissions - # are then added to the ACL on the object. For more information, see - # [Access Control List (ACL) Overview][10] and [Managing ACLs Using - # the REST API][11]. - # - # If the bucket that you're copying objects to uses the bucket owner - # enforced setting for S3 Object Ownership, ACLs are disabled and no - # longer affect permissions. Buckets that use this setting only accept - # `PUT` requests that don't specify an ACL or `PUT` requests that - # specify bucket owner full control ACLs, such as the - # `bucket-owner-full-control` canned ACL or an equivalent form of this - # ACL expressed in the XML format. - # - # For more information, see [ Controlling ownership of objects and - # disabling ACLs][12] in the *Amazon S3 User Guide*. - # - # If your bucket uses the bucket owner enforced setting for Object - # Ownership, all objects written to the bucket by any account will be - # owned by the bucket owner. - # - # - # - # Checksums - # - # : When copying an object, if it has a checksum, that checksum will be - # copied to the new object by default. When you copy the object over, - # you can optionally specify a different checksum algorithm to use - # with the `x-amz-checksum-algorithm` header. - # - # Storage Class Options - # - # : You can use the `CopyObject` action to change the storage class of - # an object that is already stored in Amazon S3 by using the - # `StorageClass` parameter. For more information, see [Storage - # Classes][13] in the *Amazon S3 User Guide*. - # - # If the source object's storage class is GLACIER, you must restore a - # copy of this object before you can use it as a source object for the - # copy operation. For more information, see [RestoreObject][14]. For - # more information, see [Copying Objects][15]. - # - # Versioning - # - # : By default, `x-amz-copy-source` header identifies the current - # version of an object to copy. If the current version is a delete - # marker, Amazon S3 behaves as if the object was deleted. To copy a - # different version, use the `versionId` subresource. - # - # If you enable versioning on the target bucket, Amazon S3 generates a - # unique version ID for the object being copied. This version ID is - # different from the version ID of the source object. Amazon S3 - # returns the version ID of the copied object in the - # `x-amz-version-id` response header in the response. + # Permissions # - # If you do not enable versioning or suspend it on the target bucket, - # the version ID that Amazon S3 generates is always null. + # : You must have *read* access to the source object and *write* access + # to the destination bucket. + # + # * **General purpose bucket permissions** - You must have permissions + # in an IAM policy based on the source and destination bucket types + # in a `CopyObject` operation. + # + # * If the source object is in a general purpose bucket, you must + # have s3:GetObject permission to read the + # source object that is being copied. + # + # * If the destination bucket is a general purpose bucket, you must + # have s3:PutObject permission to write the + # object copy to the destination bucket. + # + # * **Directory bucket permissions** - You must have permissions in a + # bucket policy or an IAM identity-based policy based on the source + # and destination bucket types in a `CopyObject` operation. + # + # * If the source object that you want to copy is in a directory + # bucket, you must have the + # s3express:CreateSession permission in the + # `Action` element of a policy to read the object. By default, the + # session is in the `ReadWrite` mode. If you want to restrict the + # access, you can explicitly set the `s3express:SessionMode` + # condition key to `ReadOnly` on the copy source bucket. + # + # * If the copy destination is a directory bucket, you must have the + # s3express:CreateSession permission in the + # `Action` element of a policy to write the object to the + # destination. The `s3express:SessionMode` condition key can't be + # set to `ReadOnly` on the copy destination bucket. + # + # For example policies, see [Example bucket policies for S3 Express + # One Zone][6] and [Amazon Web Services Identity and Access + # Management (IAM) identity-based policies for S3 Express One + # Zone][7] in the *Amazon S3 User Guide*. + # + # Response and special errors + # + # : When the request is an HTTP 1.1 request, the response is chunk + # encoded. When the request is not an HTTP 1.1 request, the response + # would not contain the `Content-Length`. You always need to read the + # entire response body to check if the copy succeeds. + # + # * If the copy is successful, you receive a response with information + # about the copied object. + # + # * A copy request might return an error when Amazon S3 receives the + # copy request or while Amazon S3 is copying the files. A `200 OK` + # response can contain either a success or an error. + # + # * If the error occurs before the copy action starts, you receive a + # standard Amazon S3 error. + # + # * If the error occurs during the copy operation, the error + # response is embedded in the `200 OK` response. For example, in a + # cross-region copy, you may encounter throttling and receive a + # `200 OK` response. For more information, see [Resolve the Error + # 200 response when copying objects to Amazon S3][8]. The `200 OK` + # status code means the copy was accepted, but it doesn't mean + # the copy is complete. Another example is when you disconnect + # from Amazon S3 before the copy is complete, Amazon S3 might + # cancel the copy and you may receive a `200 OK` response. You + # must stay connected to Amazon S3 until the entire response is + # successfully received and processed. + # + # If you call this API operation directly, make sure to design + # your application to parse the content of the response and handle + # it appropriately. If you use Amazon Web Services SDKs, SDKs + # handle this condition. The SDKs detect the embedded error and + # apply error handling per your configuration settings (including + # automatically retrying the request as appropriate). If the + # condition persists, the SDKs throw an exception (or, for the + # SDKs that don't use exceptions, they return an error). + # + # Charge + # + # : The copy request charge is based on the storage class and Region + # that you specify for the destination object. The request can also + # result in a data retrieval charge for the source if the source + # storage class bills for data retrieval. If the copy source is in a + # different region, the data transfer is billed to the copy source + # account. For pricing information, see [Amazon S3 pricing][9]. + # + # HTTP Host header syntax + # + # : Directory buckets - The HTTP Host header syntax is ` + # Bucket_name.s3express-az_id.region.amazonaws.com`. # # The following operations are related to `CopyObject`: # - # * [PutObject][16] + # * [PutObject][10] # - # * [GetObject][17] + # * [GetObject][11] # # # # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjctsUsingRESTMPUapi.html - # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html - # [3]: http://aws.amazon.com/s3/pricing/ + # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html + # [3]: https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-regions.html#manage-acct-regions-enable-standalone # [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html - # [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html - # [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/amazon-s3-policy-keys.html - # [7]: https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html - # [8]: https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html - # [9]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html - # [10]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html - # [11]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html - # [12]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html - # [13]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html - # [14]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html - # [15]: https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html - # [16]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html - # [17]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html + # [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html + # [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html + # [7]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html + # [8]: https://repost.aws/knowledge-center/s3-resolve-200-internalerror + # [9]: http://aws.amazon.com/s3/pricing/ + # [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html + # [11]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html # # @example Example: To copy an object # @@ -3716,7 +3877,7 @@ class Aws::S3::Client < ::Seahorse::Client::Base # metadata_directive: "COPY", # accepts COPY, REPLACE # tagging_directive: "COPY", # accepts COPY, REPLACE # server_side_encryption: "AES256", # accepts AES256, aws:kms, aws:kms:dsse - # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW + # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW, EXPRESS_ONEZONE # website_redirect_location: "WebsiteRedirectLocation", # sse_customer_algorithm: "SSECustomerAlgorithm", # sse_customer_key: "SSECustomerKey", @@ -3811,106 +3972,142 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::CopyObjectOutput#request_charged #request_charged} => String # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CopyObject AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#1542 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#2084 def copy_object(params = T.unsafe(nil), options = T.unsafe(nil)); end - # Creates a new S3 bucket. To create a bucket, you must register with - # Amazon S3 and have a valid Amazon Web Services Access Key ID to - # authenticate requests. Anonymous requests are never allowed to create - # buckets. By creating the bucket, you become the bucket owner. - # - # Not every string is an acceptable bucket name. For information about - # bucket naming restrictions, see [Bucket naming rules][1]. - # - # If you want to create an Amazon S3 on Outposts bucket, see [Create - # Bucket][2]. - # - # By default, the bucket is created in the US East (N. Virginia) Region. - # You can optionally specify a Region in the request body. You might - # choose a Region to optimize latency, minimize costs, or address - # regulatory requirements. For example, if you reside in Europe, you - # will probably find it advantageous to create buckets in the Europe - # (Ireland) Region. For more information, see [Accessing a bucket][3]. - # - # If you send your create bucket request to the `s3.amazonaws.com` - # endpoint, the request goes to the `us-east-1` Region. Accordingly, the - # signature calculations in Signature Version 4 must use `us-east-1` as - # the Region, even if the location constraint in the request specifies - # another Region where the bucket is to be created. If you create a - # bucket in a Region other than US East (N. Virginia), your application - # must be able to handle 307 redirect. For more information, see - # [Virtual hosting of buckets][4]. + # This action creates an Amazon S3 bucket. To create an Amazon S3 on + # Outposts bucket, see [ `CreateBucket` ][1]. # # # - # Permissions + # Creates a new S3 bucket. To create a bucket, you must set up Amazon S3 + # and have a valid Amazon Web Services Access Key ID to authenticate + # requests. Anonymous requests are never allowed to create buckets. By + # creating the bucket, you become the bucket owner. + # + # There are two types of buckets: general purpose buckets and directory + # buckets. For more information about these bucket types, see [Creating, + # configuring, and working with Amazon S3 buckets][2] in the *Amazon S3 + # User Guide*. + # + # * **General purpose buckets** - If you send your `CreateBucket` + # request to the `s3.amazonaws.com` global endpoint, the request goes + # to the `us-east-1` Region. So the signature calculations in + # Signature Version 4 must use `us-east-1` as the Region, even if the + # location constraint in the request specifies another Region where + # the bucket is to be created. If you create a bucket in a Region + # other than US East (N. Virginia), your application must be able to + # handle 307 redirect. For more information, see [Virtual hosting of + # buckets][3] in the *Amazon S3 User Guide*. + # + # * Directory buckets - For directory buckets, you must make + # requests for this API operation to the Regional endpoint. These + # endpoints support path-style requests in the format + # `https://s3express-control.region_code.amazonaws.com/bucket-name `. + # Virtual-hosted-style requests aren't supported. For more + # information, see [Regional and Zonal endpoints][4] in the *Amazon S3 + # User Guide*. + # + # # - # : In addition to `s3:CreateBucket`, the following permissions are - # required when your `CreateBucket` request includes specific headers: - # - # * **Access control lists (ACLs)** - If your `CreateBucket` request - # specifies access control list (ACL) permissions and the ACL is - # public-read, public-read-write, authenticated-read, or if you - # specify access permissions explicitly through any other ACL, both - # `s3:CreateBucket` and `s3:PutBucketAcl` permissions are needed. If - # the ACL for the `CreateBucket` request is private or if the - # request doesn't specify any ACLs, only `s3:CreateBucket` - # permission is needed. - # - # * **Object Lock** - If `ObjectLockEnabledForBucket` is set to true - # in your `CreateBucket` request, - # `s3:PutBucketObjectLockConfiguration` and `s3:PutBucketVersioning` - # permissions are required. - # - # * **S3 Object Ownership** - If your `CreateBucket` request includes - # the `x-amz-object-ownership` header, then the - # `s3:PutBucketOwnershipControls` permission is required. By - # default, `ObjectOwnership` is set to `BucketOWnerEnforced` and - # ACLs are disabled. We recommend keeping ACLs disabled, except in - # uncommon use cases where you must control access for each object - # individually. If you want to change the `ObjectOwnership` setting, - # you can use the `x-amz-object-ownership` header in your - # `CreateBucket` request to set the `ObjectOwnership` setting of - # your choice. For more information about S3 Object Ownership, see - # [Controlling object ownership ][5] in the *Amazon S3 User Guide*. - # - # * **S3 Block Public Access** - If your specific use case requires - # granting public access to your S3 resources, you can disable Block - # Public Access. You can create a new bucket with Block Public - # Access enabled, then separately call the [ - # `DeletePublicAccessBlock` ][6] API. To use this operation, you - # must have the `s3:PutBucketPublicAccessBlock` permission. By - # default, all Block Public Access settings are enabled for new - # buckets. To avoid inadvertent exposure of your resources, we - # recommend keeping the S3 Block Public Access settings enabled. For - # more information about S3 Block Public Access, see [Blocking - # public access to your Amazon S3 storage ][5] in the *Amazon S3 + # Permissions + # : * **General purpose bucket permissions** - In addition to the + # `s3:CreateBucket` permission, the following permissions are + # required in a policy when your `CreateBucket` request includes + # specific headers: + # + # * **Access control lists (ACLs)** - In your `CreateBucket` + # request, if you specify an access control list (ACL) and set it + # to `public-read`, `public-read-write`, `authenticated-read`, or + # if you explicitly specify any other custom ACLs, both + # `s3:CreateBucket` and `s3:PutBucketAcl` permissions are + # required. In your `CreateBucket` request, if you set the ACL to + # `private`, or if you don't specify any ACLs, only the + # `s3:CreateBucket` permission is required. + # + # * **Object Lock** - In your `CreateBucket` request, if you set + # `x-amz-bucket-object-lock-enabled` to true, the + # `s3:PutBucketObjectLockConfiguration` and + # `s3:PutBucketVersioning` permissions are required. + # + # * **S3 Object Ownership** - If your `CreateBucket` request + # includes the `x-amz-object-ownership` header, then the + # `s3:PutBucketOwnershipControls` permission is required. + # + # To set an ACL on a bucket as part of a `CreateBucket` request, + # you must explicitly set S3 Object Ownership for the bucket to a + # different value than the default, `BucketOwnerEnforced`. + # Additionally, if your desired bucket ACL grants public access, + # you must first create the bucket (without the bucket ACL) and + # then explicitly disable Block Public Access on the bucket before + # using `PutBucketAcl` to set the ACL. If you try to create a + # bucket with a public ACL, the request will fail. + # + # For the majority of modern use cases in S3, we recommend that + # you keep all Block Public Access settings enabled and keep ACLs + # disabled. If you would like to share data with users outside of + # your account, you can use bucket policies as needed. For more + # information, see [Controlling ownership of objects and disabling + # ACLs for your bucket ][5] and [Blocking public access to your + # Amazon S3 storage ][6] in the *Amazon S3 User Guide*. + # + # * **S3 Block Public Access** - If your specific use case requires + # granting public access to your S3 resources, you can disable + # Block Public Access. Specifically, you can create a new bucket + # with Block Public Access enabled, then separately call the [ + # `DeletePublicAccessBlock` ][7] API. To use this operation, you + # must have the `s3:PutBucketPublicAccessBlock` permission. For + # more information about S3 Block Public Access, see [Blocking + # public access to your Amazon S3 storage ][6] in the *Amazon S3 + # User Guide*. + # + # * **Directory bucket permissions** - You must have the + # `s3express:CreateBucket` permission in an IAM identity-based + # policy instead of a bucket policy. Cross-account access to this + # API operation isn't supported. This operation can only be + # performed by the Amazon Web Services account that owns the + # resource. For more information about directory bucket policies and + # permissions, see [Amazon Web Services Identity and Access + # Management (IAM) for S3 Express One Zone][8] in the *Amazon S3 # User Guide*. # - # If your `CreateBucket` request sets `BucketOwnerEnforced` for Amazon - # S3 Object Ownership and specifies a bucket ACL that provides access to - # an external Amazon Web Services account, your request fails with a - # `400` error and returns the `InvalidBucketAcLWithObjectOwnership` - # error code. For more information, see [Setting Object Ownership on an - # existing bucket ][7] in the *Amazon S3 User Guide*. + # The permissions for ACLs, Object Lock, S3 Object Ownership, and S3 + # Block Public Access are not supported for directory buckets. For + # directory buckets, all Block Public Access settings are enabled at + # the bucket level and S3 Object Ownership is set to Bucket owner + # enforced (ACLs disabled). These settings can't be modified. + # + # For more information about permissions for creating and working + # with directory buckets, see [Directory buckets][9] in the *Amazon + # S3 User Guide*. For more information about supported S3 features + # for directory buckets, see [Features of S3 Express One Zone][10] + # in the *Amazon S3 User Guide*. + # + # HTTP Host header syntax + # + # : Directory buckets - The HTTP Host header syntax is + # `s3express-control.region.amazonaws.com`. # # The following operations are related to `CreateBucket`: # - # * [PutObject][8] + # * [PutObject][11] # - # * [DeleteBucket][9] + # * [DeleteBucket][12] # # # - # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html - # [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html - # [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro - # [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html + # [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html + # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html + # [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html + # [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html # [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html - # [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html - # [7]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-ownership-existing-bucket.html - # [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html - # [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html + # [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-block-public-access.html + # [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html + # [8]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html + # [9]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html + # [10]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-one-zone.html#s3-express-features + # [11]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html + # [12]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html # # @example Example: To create a bucket in a specific region # @@ -3945,7 +4142,15 @@ class Aws::S3::Client < ::Seahorse::Client::Base # acl: "private", # accepts private, public-read, public-read-write, authenticated-read # bucket: "BucketName", # required # create_bucket_configuration: { - # location_constraint: "af-south-1", # accepts af-south-1, ap-east-1, ap-northeast-1, ap-northeast-2, ap-northeast-3, ap-south-1, ap-southeast-1, ap-southeast-2, ap-southeast-3, ca-central-1, cn-north-1, cn-northwest-1, EU, eu-central-1, eu-north-1, eu-south-1, eu-west-1, eu-west-2, eu-west-3, me-south-1, sa-east-1, us-east-2, us-gov-east-1, us-gov-west-1, us-west-1, us-west-2, ap-south-2, eu-south-2 + # location_constraint: "af-south-1", # accepts af-south-1, ap-east-1, ap-northeast-1, ap-northeast-2, ap-northeast-3, ap-south-1, ap-south-2, ap-southeast-1, ap-southeast-2, ap-southeast-3, ca-central-1, cn-north-1, cn-northwest-1, EU, eu-central-1, eu-north-1, eu-south-1, eu-south-2, eu-west-1, eu-west-2, eu-west-3, me-south-1, sa-east-1, us-east-2, us-gov-east-1, us-gov-west-1, us-west-1, us-west-2 + # location: { + # type: "AvailabilityZone", # accepts AvailabilityZone + # name: "LocationNameAsString", + # }, + # bucket: { + # data_redundancy: "SingleAvailabilityZone", # accepts SingleAvailabilityZone + # type: "Directory", # accepts Directory + # }, # }, # grant_full_control: "GrantFullControl", # grant_read: "GrantRead", @@ -3975,7 +4180,7 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::CreateBucketOutput#location #location} => String # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CreateBucket AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#1754 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#2404 def create_bucket(params = T.unsafe(nil), options = T.unsafe(nil)); end # This action initiates a multipart upload and returns an upload ID. @@ -3983,264 +4188,209 @@ class Aws::S3::Client < ::Seahorse::Client::Base # multipart upload. You specify this upload ID in each of your # subsequent upload part requests (see [UploadPart][1]). You also # include this upload ID in the final request to either complete or - # abort the multipart upload request. - # - # For more information about multipart uploads, see [Multipart Upload - # Overview][2]. - # - # If you have configured a lifecycle rule to abort incomplete multipart - # uploads, the upload must complete within the number of days specified - # in the bucket lifecycle configuration. Otherwise, the incomplete - # multipart upload becomes eligible for an abort action and Amazon S3 - # aborts the multipart upload. For more information, see [Aborting - # Incomplete Multipart Uploads Using a Bucket Lifecycle - # Configuration][3]. - # - # For information about the permissions required to use the multipart - # upload API, see [Multipart Upload and Permissions][4]. - # - # For request signing, multipart upload is just a series of regular - # requests. You initiate a multipart upload, send one or more requests - # to upload parts, and then complete the multipart upload process. You - # sign each request individually. There is nothing special about signing - # multipart upload requests. For more information about signing, see - # [Authenticating Requests (Amazon Web Services Signature Version - # 4)][5]. + # abort the multipart upload request. For more information about + # multipart uploads, see [Multipart Upload Overview][2] in the *Amazon + # S3 User Guide*. # # After you initiate a multipart upload and upload one or more parts, to # stop being charged for storing the uploaded parts, you must either # complete or abort the multipart upload. Amazon S3 frees up the space - # used to store the parts and stop charging you for storing them only + # used to store the parts and stops charging you for storing them only # after you either complete or abort a multipart upload. # # # - # Server-side encryption is for data encryption at rest. Amazon S3 - # encrypts your data as it writes it to disks in its data centers and - # decrypts it when you access it. Amazon S3 automatically encrypts all - # new objects that are uploaded to an S3 bucket. When doing a multipart - # upload, if you don't specify encryption information in your request, - # the encryption setting of the uploaded parts is set to the default - # encryption configuration of the destination bucket. By default, all - # buckets have a base level of encryption configuration that uses - # server-side encryption with Amazon S3 managed keys (SSE-S3). If the - # destination bucket has a default encryption configuration that uses - # server-side encryption with an Key Management Service (KMS) key - # (SSE-KMS), or a customer-provided encryption key (SSE-C), Amazon S3 - # uses the corresponding KMS key, or a customer-provided key to encrypt - # the uploaded parts. When you perform a CreateMultipartUpload - # operation, if you want to use a different type of encryption setting - # for the uploaded parts, you can request that Amazon S3 encrypts the - # object with a KMS key, an Amazon S3 managed key, or a - # customer-provided key. If the encryption setting in your request is - # different from the default encryption configuration of the destination - # bucket, the encryption setting in your request takes precedence. If - # you choose to provide your own encryption key, the request headers you - # provide in [UploadPart][1] and [UploadPartCopy][6] requests must match - # the headers you used in the request to initiate the upload by using - # `CreateMultipartUpload`. You can request that Amazon S3 save the - # uploaded parts encrypted with server-side encryption with an Amazon S3 - # managed key (SSE-S3), an Key Management Service (KMS) key (SSE-KMS), - # or a customer-provided encryption key (SSE-C). - # - # To perform a multipart upload with encryption by using an Amazon Web - # Services KMS key, the requester must have permission to the - # `kms:Decrypt` and `kms:GenerateDataKey*` actions on the key. These - # permissions are required because Amazon S3 must decrypt and read data - # from the encrypted file parts before it completes the multipart - # upload. For more information, see [Multipart upload API and - # permissions][7] and [Protecting data using server-side encryption with - # Amazon Web Services KMS][8] in the *Amazon S3 User Guide*. - # - # If your Identity and Access Management (IAM) user or role is in the - # same Amazon Web Services account as the KMS key, then you must have - # these permissions on the key policy. If your IAM user or role belongs - # to a different account than the key, then you must have the - # permissions on both the key policy and your IAM user or role. - # - # For more information, see [Protecting Data Using Server-Side - # Encryption][9]. - # - # Access Permissions - # - # : When copying an object, you can optionally specify the accounts or - # groups that should be granted specific permissions on the new - # object. There are two ways to grant the permissions using the - # request headers: - # - # * Specify a canned ACL with the `x-amz-acl` request header. For more - # information, see [Canned ACL][10]. - # - # * Specify access permissions explicitly with the `x-amz-grant-read`, - # `x-amz-grant-read-acp`, `x-amz-grant-write-acp`, and - # `x-amz-grant-full-control` headers. These parameters map to the - # set of permissions that Amazon S3 supports in an ACL. For more - # information, see [Access Control List (ACL) Overview][11]. - # - # You can use either a canned ACL or specify access permissions - # explicitly. You cannot do both. - # - # Server-Side- Encryption-Specific Request Headers - # - # : Amazon S3 encrypts data by using server-side encryption with an - # Amazon S3 managed key (SSE-S3) by default. Server-side encryption is - # for data encryption at rest. Amazon S3 encrypts your data as it - # writes it to disks in its data centers and decrypts it when you - # access it. You can request that Amazon S3 encrypts data at rest by - # using server-side encryption with other key options. The option you - # use depends on whether you want to use KMS keys (SSE-KMS) or provide - # your own encryption keys (SSE-C). - # - # * Use KMS keys (SSE-KMS) that include the Amazon Web Services - # managed key (`aws/s3`) and KMS customer managed keys stored in Key - # Management Service (KMS) – If you want Amazon Web Services to - # manage the keys used to encrypt data, specify the following - # headers in the request. - # - # * `x-amz-server-side-encryption` - # - # * `x-amz-server-side-encryption-aws-kms-key-id` - # - # * `x-amz-server-side-encryption-context` - # - # If you specify `x-amz-server-side-encryption:aws:kms`, but don't - # provide `x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3 - # uses the Amazon Web Services managed key (`aws/s3` key) in KMS to - # protect the data. - # - # - # - # All `GET` and `PUT` requests for an object protected by KMS fail - # if you don't make them by using Secure Sockets Layer (SSL), - # Transport Layer Security (TLS), or Signature Version 4. - # - # For more information about server-side encryption with KMS keys - # (SSE-KMS), see [Protecting Data Using Server-Side Encryption with - # KMS keys][8]. - # - # * Use customer-provided encryption keys (SSE-C) – If you want to - # manage your own encryption keys, provide all the following headers - # in the request. - # - # * `x-amz-server-side-encryption-customer-algorithm` - # - # * `x-amz-server-side-encryption-customer-key` - # - # * `x-amz-server-side-encryption-customer-key-MD5` - # - # For more information about server-side encryption with - # customer-provided encryption keys (SSE-C), see [ Protecting data - # using server-side encryption with customer-provided encryption - # keys (SSE-C)][12]. - # - # Access-Control-List (ACL)-Specific Request Headers - # - # : You also can use the following access control–related headers with - # this operation. By default, all objects are private. Only the owner - # has full access control. When adding a new object, you can grant - # permissions to individual Amazon Web Services accounts or to - # predefined groups defined by Amazon S3. These permissions are then - # added to the access control list (ACL) on the object. For more - # information, see [Using ACLs][13]. With this operation, you can - # grant access permissions using one of the following two methods: - # - # * Specify a canned ACL (`x-amz-acl`) — Amazon S3 supports a set of - # predefined ACLs, known as *canned ACLs*. Each canned ACL has a - # predefined set of grantees and permissions. For more information, - # see [Canned ACL][10]. - # - # * Specify access permissions explicitly — To explicitly grant access - # permissions to specific Amazon Web Services accounts or groups, - # use the following headers. Each header maps to specific - # permissions that Amazon S3 supports in an ACL. For more - # information, see [Access Control List (ACL) Overview][11]. In the - # header, you specify a list of grantees who get the specific - # permission. To grant permissions explicitly, use: - # - # * `x-amz-grant-read` - # - # * `x-amz-grant-write` - # - # * `x-amz-grant-read-acp` - # - # * `x-amz-grant-write-acp` - # - # * `x-amz-grant-full-control` - # - # You specify each grantee as a type=value pair, where the type is - # one of the following: + # If you have configured a lifecycle rule to abort incomplete multipart + # uploads, the created multipart upload must be completed within the + # number of days specified in the bucket lifecycle configuration. + # Otherwise, the incomplete multipart upload becomes eligible for an + # abort action and Amazon S3 aborts the multipart upload. For more + # information, see [Aborting Incomplete Multipart Uploads Using a Bucket + # Lifecycle Configuration][3]. + # + # * Directory buckets - S3 Lifecycle is not supported by + # directory buckets. + # + # * Directory buckets - For directory buckets, you must make + # requests for this API operation to the Zonal endpoint. These + # endpoints support virtual-hosted-style requests in the format + # `https://bucket_name.s3express-az_id.region.amazonaws.com/key-name + # `. Path-style requests are not supported. For more information, see + # [Regional and Zonal endpoints][4] in the *Amazon S3 User Guide*. # - # * `id` – if the value specified is the canonical user ID of an - # Amazon Web Services account + # # - # * `uri` – if you are granting permissions to a predefined group + # Request signing # - # * `emailAddress` – if the value specified is the email address of - # an Amazon Web Services account + # : For request signing, multipart upload is just a series of regular + # requests. You initiate a multipart upload, send one or more requests + # to upload parts, and then complete the multipart upload process. You + # sign each request individually. There is nothing special about + # signing multipart upload requests. For more information about + # signing, see [Authenticating Requests (Amazon Web Services Signature + # Version 4)][5] in the *Amazon S3 User Guide*. # - # Using email addresses to specify a grantee is only supported in - # the following Amazon Web Services Regions: + # Permissions + # : * **General purpose bucket permissions** - For information about the + # permissions required to use the multipart upload API, see + # [Multipart upload and permissions][6] in the *Amazon S3 User + # Guide*. # - # * US East (N. Virginia) + # To perform a multipart upload with encryption by using an Amazon + # Web Services KMS key, the requester must have permission to the + # `kms:Decrypt` and `kms:GenerateDataKey*` actions on the key. These + # permissions are required because Amazon S3 must decrypt and read + # data from the encrypted file parts before it completes the + # multipart upload. For more information, see [Multipart upload API + # and permissions][7] and [Protecting data using server-side + # encryption with Amazon Web Services KMS][8] in the *Amazon S3 User + # Guide*. # - # * US West (N. California) + # * **Directory bucket permissions** - To grant access to this API + # operation on a directory bucket, we recommend that you use the [ + # `CreateSession` ][9] API operation for session-based + # authorization. Specifically, you grant the + # `s3express:CreateSession` permission to the directory bucket in a + # bucket policy or an IAM identity-based policy. Then, you make the + # `CreateSession` API call on the bucket to obtain a session token. + # With the session token in your request header, you can make API + # requests to this operation. After the session token expires, you + # make another `CreateSession` API call to generate a new session + # token for use. Amazon Web Services CLI or SDKs create session and + # refresh the session token automatically to avoid service + # interruptions when a session expires. For more information about + # authorization, see [ `CreateSession` ][9]. + # + # Encryption + # : * **General purpose buckets** - Server-side encryption is for data + # encryption at rest. Amazon S3 encrypts your data as it writes it + # to disks in its data centers and decrypts it when you access it. + # Amazon S3 automatically encrypts all new objects that are uploaded + # to an S3 bucket. When doing a multipart upload, if you don't + # specify encryption information in your request, the encryption + # setting of the uploaded parts is set to the default encryption + # configuration of the destination bucket. By default, all buckets + # have a base level of encryption configuration that uses + # server-side encryption with Amazon S3 managed keys (SSE-S3). If + # the destination bucket has a default encryption configuration that + # uses server-side encryption with an Key Management Service (KMS) + # key (SSE-KMS), or a customer-provided encryption key (SSE-C), + # Amazon S3 uses the corresponding KMS key, or a customer-provided + # key to encrypt the uploaded parts. When you perform a + # CreateMultipartUpload operation, if you want to use a different + # type of encryption setting for the uploaded parts, you can request + # that Amazon S3 encrypts the object with a different encryption key + # (such as an Amazon S3 managed key, a KMS key, or a + # customer-provided key). When the encryption setting in your + # request is different from the default encryption configuration of + # the destination bucket, the encryption setting in your request + # takes precedence. If you choose to provide your own encryption + # key, the request headers you provide in [UploadPart][1] and + # [UploadPartCopy][10] requests must match the headers you used in + # the `CreateMultipartUpload` request. + # + # * Use KMS keys (SSE-KMS) that include the Amazon Web Services + # managed key (`aws/s3`) and KMS customer managed keys stored in + # Key Management Service (KMS) – If you want Amazon Web Services + # to manage the keys used to encrypt data, specify the following + # headers in the request. + # + # * `x-amz-server-side-encryption` + # + # * `x-amz-server-side-encryption-aws-kms-key-id` + # + # * `x-amz-server-side-encryption-context` + # + # * If you specify `x-amz-server-side-encryption:aws:kms`, but + # don't provide `x-amz-server-side-encryption-aws-kms-key-id`, + # Amazon S3 uses the Amazon Web Services managed key (`aws/s3` + # key) in KMS to protect the data. + # + # * To perform a multipart upload with encryption by using an + # Amazon Web Services KMS key, the requester must have + # permission to the `kms:Decrypt` and `kms:GenerateDataKey*` + # actions on the key. These permissions are required because + # Amazon S3 must decrypt and read data from the encrypted file + # parts before it completes the multipart upload. For more + # information, see [Multipart upload API and permissions][7] and + # [Protecting data using server-side encryption with Amazon Web + # Services KMS][8] in the *Amazon S3 User Guide*. + # + # * If your Identity and Access Management (IAM) user or role is + # in the same Amazon Web Services account as the KMS key, then + # you must have these permissions on the key policy. If your IAM + # user or role is in a different account from the key, then you + # must have the permissions on both the key policy and your IAM + # user or role. + # + # * All `GET` and `PUT` requests for an object protected by KMS + # fail if you don't make them by using Secure Sockets Layer + # (SSL), Transport Layer Security (TLS), or Signature Version 4. + # For information about configuring any of the officially + # supported Amazon Web Services SDKs and Amazon Web Services + # CLI, see [Specifying the Signature Version in Request + # Authentication][11] in the *Amazon S3 User Guide*. # - # * US West (Oregon) + # # - # * Asia Pacific (Singapore) + # For more information about server-side encryption with KMS keys + # (SSE-KMS), see [Protecting Data Using Server-Side Encryption + # with KMS keys][8] in the *Amazon S3 User Guide*. # - # * Asia Pacific (Sydney) + # * Use customer-provided encryption keys (SSE-C) – If you want to + # manage your own encryption keys, provide all the following + # headers in the request. # - # * Asia Pacific (Tokyo) + # * `x-amz-server-side-encryption-customer-algorithm` # - # * Europe (Ireland) + # * `x-amz-server-side-encryption-customer-key` # - # * South America (São Paulo) + # * `x-amz-server-side-encryption-customer-key-MD5` # - # For a list of all the Amazon S3 supported Regions and endpoints, - # see [Regions and Endpoints][14] in the Amazon Web Services - # General Reference. + # For more information about server-side encryption with + # customer-provided encryption keys (SSE-C), see [ Protecting data + # using server-side encryption with customer-provided encryption + # keys (SSE-C)][12] in the *Amazon S3 User Guide*. # - # + # * **Directory buckets** -For directory buckets, only server-side + # encryption with Amazon S3 managed keys (SSE-S3) (`AES256`) is + # supported. # - # For example, the following `x-amz-grant-read` header grants the - # Amazon Web Services accounts identified by account IDs permissions - # to read object data and its metadata: + # HTTP Host header syntax # - # `x-amz-grant-read: id="11112222333", id="444455556666" ` + # : Directory buckets - The HTTP Host header syntax is ` + # Bucket_name.s3express-az_id.region.amazonaws.com`. # # The following operations are related to `CreateMultipartUpload`: # # * [UploadPart][1] # - # * [CompleteMultipartUpload][15] + # * [CompleteMultipartUpload][13] # - # * [AbortMultipartUpload][16] + # * [AbortMultipartUpload][14] # - # * [ListParts][17] + # * [ListParts][15] # - # * [ListMultipartUploads][18] + # * [ListMultipartUploads][16] # # # # [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html # [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config - # [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html + # [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html # [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html - # [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html + # [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html # [7]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions # [8]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html - # [9]: https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html - # [10]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL - # [11]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html + # [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html + # [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html + # [11]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version # [12]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html - # [13]: https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html - # [14]: https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region - # [15]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html - # [16]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html - # [17]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html - # [18]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html + # [13]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html + # [14]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html + # [15]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html + # [16]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html # # @example Example: To initiate a multipart upload # @@ -4277,7 +4427,7 @@ class Aws::S3::Client < ::Seahorse::Client::Base # "MetadataKey" => "MetadataValue", # }, # server_side_encryption: "AES256", # accepts AES256, aws:kms, aws:kms:dsse - # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW + # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW, EXPRESS_ONEZONE # website_redirect_location: "WebsiteRedirectLocation", # sse_customer_algorithm: "SSECustomerAlgorithm", # sse_customer_key: "SSECustomerKey", @@ -4357,47 +4507,200 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::CreateMultipartUploadOutput#checksum_algorithm #checksum_algorithm} => String # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CreateMultipartUpload AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#2294 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#3222 def create_multipart_upload(params = T.unsafe(nil), options = T.unsafe(nil)); end - # Deletes the S3 bucket. All objects (including all object versions and - # delete markers) in the bucket must be deleted before the bucket itself - # can be deleted. + # Creates a session that establishes temporary security credentials to + # support fast authentication and authorization for the Zonal endpoint + # APIs on directory buckets. For more information about Zonal endpoint + # APIs that include the Availability Zone in the request endpoint, see + # [S3 Express One Zone APIs][1] in the *Amazon S3 User Guide*. + # + # To make Zonal endpoint API requests on a directory bucket, use the + # `CreateSession` API operation. Specifically, you grant + # `s3express:CreateSession` permission to a bucket in a bucket policy or + # an IAM identity-based policy. Then, you use IAM credentials to make + # the `CreateSession` API request on the bucket, which returns temporary + # security credentials that include the access key ID, secret access + # key, session token, and expiration. These credentials have associated + # permissions to access the Zonal endpoint APIs. After the session is + # created, you don’t need to use other policies to grant permissions to + # each Zonal endpoint API individually. Instead, in your Zonal endpoint + # API requests, you sign your requests by applying the temporary + # security credentials of the session to the request headers and + # following the SigV4 protocol for authentication. You also apply the + # session token to the `x-amz-s3session-token` request header for + # authorization. Temporary security credentials are scoped to the bucket + # and expire after 5 minutes. After the expiration time, any calls that + # you make with those credentials will fail. You must use IAM + # credentials again to make a `CreateSession` API request that generates + # a new set of temporary credentials for use. Temporary credentials + # cannot be extended or refreshed beyond the original specified + # interval. + # + # If you use Amazon Web Services SDKs, SDKs handle the session token + # refreshes automatically to avoid service interruptions when a session + # expires. We recommend that you use the Amazon Web Services SDKs to + # initiate and manage requests to the CreateSession API. For more + # information, see [Performance guidelines and design patterns][2] in + # the *Amazon S3 User Guide*. # - # The following operations are related to `DeleteBucket`: + # * You must make requests for this API operation to the Zonal endpoint. + # These endpoints support virtual-hosted-style requests in the format + # `https://bucket_name.s3express-az_id.region.amazonaws.com`. + # Path-style requests are not supported. For more information, see + # [Regional and Zonal endpoints][3] in the *Amazon S3 User Guide*. + # + # * CopyObject API operation - Unlike other Zonal + # endpoint APIs, the `CopyObject` API operation doesn't use the + # temporary security credentials returned from the `CreateSession` API + # operation for authentication and authorization. For information + # about authentication and authorization of the `CopyObject` API + # operation on directory buckets, see [CopyObject][4]. + # + # * HeadBucket API operation - Unlike other Zonal + # endpoint APIs, the `HeadBucket` API operation doesn't use the + # temporary security credentials returned from the `CreateSession` API + # operation for authentication and authorization. For information + # about authentication and authorization of the `HeadBucket` API + # operation on directory buckets, see [HeadBucket][5]. # - # * [CreateBucket][1] + # # - # * [DeleteObject][2] + # Permissions # + # : To obtain temporary security credentials, you must create a bucket + # policy or an IAM identity-based policy that grants + # `s3express:CreateSession` permission to the bucket. In a policy, you + # can have the `s3express:SessionMode` condition key to control who + # can create a `ReadWrite` or `ReadOnly` session. For more information + # about `ReadWrite` or `ReadOnly` sessions, see [ + # `x-amz-create-session-mode` ][6]. For example policies, see [Example + # bucket policies for S3 Express One Zone][7] and [Amazon Web Services + # Identity and Access Management (IAM) identity-based policies for S3 + # Express One Zone][8] in the *Amazon S3 User Guide*. + # + # To grant cross-account access to Zonal endpoint APIs, the bucket + # policy should also grant both accounts the `s3express:CreateSession` + # permission. # + # HTTP Host header syntax # - # [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html - # [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html + # : Directory buckets - The HTTP Host header syntax is ` + # Bucket_name.s3express-az_id.region.amazonaws.com`. # - # @example Example: To delete a bucket # - # # The following example deletes the specified bucket. # - # resp = client.delete_bucket({ - # bucket: "forrandall2", - # }) + # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-APIs.html + # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-optimizing-performance-guidelines-design-patterns.html#s3-express-optimizing-performance-session-authentication + # [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html + # [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html + # [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html + # [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html#API_CreateSession_RequestParameters + # [7]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html + # [8]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html + # # @example Request syntax with placeholder values # - # resp = client.delete_bucket({ + # resp = client.create_session({ + # session_mode: "ReadOnly", # accepts ReadOnly, ReadWrite # bucket: "BucketName", # required - # expected_bucket_owner: "AccountId", # }) + # @example Response structure + # + # resp.credentials.access_key_id #=> String + # resp.credentials.secret_access_key #=> String + # resp.credentials.session_token #=> String + # resp.credentials.expiration #=> Time # @option params # @option params - # @overload delete_bucket + # @overload create_session # @param params [Hash] ({}) - # @return [Struct] Returns an empty {Seahorse::Client::Response response}. - # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucket AWS API Documentation + # @return [Types::CreateSessionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#2344 + # * {Types::CreateSessionOutput#credentials #credentials} => Types::SessionCredentials + # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CreateSession AWS API Documentation + # + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#3351 + def create_session(params = T.unsafe(nil), options = T.unsafe(nil)); end + + # Deletes the S3 bucket. All objects (including all object versions and + # delete markers) in the bucket must be deleted before the bucket itself + # can be deleted. + # + # * **Directory buckets** - If multipart uploads in a directory bucket + # are in progress, you can't delete the bucket until all the + # in-progress multipart uploads are aborted or completed. + # + # * Directory buckets - For directory buckets, you must make + # requests for this API operation to the Regional endpoint. These + # endpoints support path-style requests in the format + # `https://s3express-control.region_code.amazonaws.com/bucket-name `. + # Virtual-hosted-style requests aren't supported. For more + # information, see [Regional and Zonal endpoints][1] in the *Amazon S3 + # User Guide*. + # + # + # + # Permissions + # : * **General purpose bucket permissions** - You must have the + # `s3:DeleteBucket` permission on the specified bucket in a policy. + # + # * **Directory bucket permissions** - You must have the + # `s3express:DeleteBucket` permission in an IAM identity-based + # policy instead of a bucket policy. Cross-account access to this + # API operation isn't supported. This operation can only be + # performed by the Amazon Web Services account that owns the + # resource. For more information about directory bucket policies and + # permissions, see [Amazon Web Services Identity and Access + # Management (IAM) for S3 Express One Zone][2] in the *Amazon S3 + # User Guide*. + # + # HTTP Host header syntax + # + # : Directory buckets - The HTTP Host header syntax is + # `s3express-control.region.amazonaws.com`. + # + # The following operations are related to `DeleteBucket`: + # + # * [CreateBucket][3] + # + # * [DeleteObject][4] + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html + # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html + # [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html + # [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html + # + # @example Example: To delete a bucket + # + # # The following example deletes the specified bucket. + # + # resp = client.delete_bucket({ + # bucket: "forrandall2", + # }) + # @example Request syntax with placeholder values + # + # resp = client.delete_bucket({ + # bucket: "BucketName", # required + # expected_bucket_owner: "AccountId", + # }) + # @option params + # @option params + # @overload delete_bucket + # @param params [Hash] ({}) + # @return [Struct] Returns an empty {Seahorse::Client::Response response}. + # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucket AWS API Documentation + # + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#3456 def delete_bucket(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Deletes an analytics configuration for the bucket (specified by the # analytics configuration ID). # @@ -4444,9 +4747,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketAnalyticsConfiguration AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#2406 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#3522 def delete_bucket_analytics_configuration(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Deletes the `cors` configuration information set for the bucket. # # To use this operation, you must have permission to perform the @@ -4488,9 +4795,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketCors AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#2462 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#3582 def delete_bucket_cors(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # This implementation of the DELETE action resets the default encryption # for the bucket as server-side encryption with Amazon S3 managed keys # (SSE-S3). For information about the bucket default encryption feature, @@ -4532,9 +4843,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketEncryption AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#2517 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#3641 def delete_bucket_encryption(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Deletes the S3 Intelligent-Tiering configuration from the specified # bucket. # @@ -4586,9 +4901,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketIntelligentTieringConfiguration AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#2580 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#3708 def delete_bucket_intelligent_tiering_configuration(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Deletes an inventory configuration (identified by the inventory ID) # from the bucket. # @@ -4634,9 +4953,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketInventoryConfiguration AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#2641 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#3773 def delete_bucket_inventory_configuration(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Deletes the lifecycle configuration from the specified bucket. Amazon # S3 removes all the lifecycle configuration rules in the lifecycle # subresource associated with the bucket. Your objects never expire, and @@ -4686,9 +5009,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketLifecycle AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#2705 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#3841 def delete_bucket_lifecycle(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Deletes a metrics configuration for the Amazon CloudWatch request # metrics (specified by the metrics configuration ID) from the bucket. # Note that this doesn't include the daily storage metrics. @@ -4738,9 +5065,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketMetricsConfiguration AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#2771 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#3911 def delete_bucket_metrics_configuration(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Removes `OwnershipControls` for an Amazon S3 bucket. To use this # operation, you must have the `s3:PutBucketOwnershipControls` # permission. For more information about Amazon S3 permissions, see @@ -4774,44 +5105,77 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketOwnershipControls AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#2817 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#3961 def delete_bucket_ownership_controls(params = T.unsafe(nil), options = T.unsafe(nil)); end - # This implementation of the DELETE action uses the policy subresource - # to delete the policy of a specified bucket. If you are using an - # identity other than the root user of the Amazon Web Services account - # that owns the bucket, the calling identity must have the - # `DeleteBucketPolicy` permissions on the specified bucket and belong to - # the bucket owner's account to use this operation. - # - # If you don't have `DeleteBucketPolicy` permissions, Amazon S3 returns - # a `403 Access Denied` error. If you have the correct permissions, but - # you're not using an identity that belongs to the bucket owner's - # account, Amazon S3 returns a `405 Method Not Allowed` error. - # - # To ensure that bucket owners don't inadvertently lock themselves out - # of their own buckets, the root principal in a bucket owner's Amazon - # Web Services account can perform the `GetBucketPolicy`, - # `PutBucketPolicy`, and `DeleteBucketPolicy` API actions, even if their - # bucket policy explicitly denies the root principal's access. Bucket - # owner root principals can only be blocked from performing these API - # actions by VPC endpoint policies and Amazon Web Services Organizations - # policies. - # - # For more information about bucket policies, see [Using Bucket Policies - # and UserPolicies][1]. + # Deletes the policy of a specified bucket. + # + # Directory buckets - For directory buckets, you must make + # requests for this API operation to the Regional endpoint. These + # endpoints support path-style requests in the format + # `https://s3express-control.region_code.amazonaws.com/bucket-name `. + # Virtual-hosted-style requests aren't supported. For more information, + # see [Regional and Zonal endpoints][1] in the *Amazon S3 User Guide*. + # + # + # + # Permissions + # + # : If you are using an identity other than the root user of the Amazon + # Web Services account that owns the bucket, the calling identity must + # both have the `DeleteBucketPolicy` permissions on the specified + # bucket and belong to the bucket owner's account in order to use + # this operation. + # + # If you don't have `DeleteBucketPolicy` permissions, Amazon S3 + # returns a `403 Access Denied` error. If you have the correct + # permissions, but you're not using an identity that belongs to the + # bucket owner's account, Amazon S3 returns a `405 Method Not + # Allowed` error. + # + # To ensure that bucket owners don't inadvertently lock themselves + # out of their own buckets, the root principal in a bucket owner's + # Amazon Web Services account can perform the `GetBucketPolicy`, + # `PutBucketPolicy`, and `DeleteBucketPolicy` API actions, even if + # their bucket policy explicitly denies the root principal's access. + # Bucket owner root principals can only be blocked from performing + # these API actions by VPC endpoint policies and Amazon Web Services + # Organizations policies. + # + # * **General purpose bucket permissions** - The + # `s3:DeleteBucketPolicy` permission is required in a policy. For + # more information about general purpose buckets bucket policies, + # see [Using Bucket Policies and User Policies][2] in the *Amazon S3 + # User Guide*. + # + # * **Directory bucket permissions** - To grant access to this API + # operation, you must have the `s3express:DeleteBucketPolicy` + # permission in an IAM identity-based policy instead of a bucket + # policy. Cross-account access to this API operation isn't + # supported. This operation can only be performed by the Amazon Web + # Services account that owns the resource. For more information + # about directory bucket policies and permissions, see [Amazon Web + # Services Identity and Access Management (IAM) for S3 Express One + # Zone][3] in the *Amazon S3 User Guide*. + # + # HTTP Host header syntax + # + # : Directory buckets - The HTTP Host header syntax is + # `s3express-control.region.amazonaws.com`. # # The following operations are related to `DeleteBucketPolicy` # - # * [CreateBucket][2] + # * [CreateBucket][4] # - # * [DeleteObject][3] + # * [DeleteObject][5] # # # - # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html - # [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html - # [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html + # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html + # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html + # [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html + # [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html + # [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html # # @example Example: To delete bucket policy # @@ -4833,9 +5197,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketPolicy AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#2888 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#4085 def delete_bucket_policy(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Deletes the replication configuration from the bucket. # # To use this operation, you must have permissions to perform the @@ -4887,9 +5255,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketReplication AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#2954 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#4155 def delete_bucket_replication(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Deletes the tags from the bucket. # # To use this operation, you must have permission to perform the @@ -4927,9 +5299,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketTagging AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#3006 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#4211 def delete_bucket_tagging(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # This action removes the website configuration for a bucket. Amazon S3 # returns a `200 OK` response upon successfully deleting a website # configuration on the specified bucket. You will get a `200 OK` @@ -4978,55 +5354,123 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketWebsite AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#3070 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#4279 def delete_bucket_website(params = T.unsafe(nil), options = T.unsafe(nil)); end - # Removes the null version (if there is one) of an object and inserts a - # delete marker, which becomes the latest version of the object. If - # there isn't a null version, Amazon S3 does not remove any objects but - # will still respond that the command was successful. + # Removes an object from a bucket. The behavior depends on the bucket's + # versioning state: + # + # * If bucket versioning is not enabled, the operation permanently + # deletes the object. + # + # * If bucket versioning is enabled, the operation inserts a delete + # marker, which becomes the current version of the object. To + # permanently delete an object in a versioned bucket, you must include + # the object’s `versionId` in the request. For more information about + # versioning-enabled buckets, see [Deleting object versions from a + # versioning-enabled bucket][1]. + # + # * If bucket versioning is suspended, the operation removes the object + # that has a null `versionId`, if there is one, and inserts a delete + # marker that becomes the current version of the object. If there + # isn't an object with a null `versionId`, and all versions of the + # object have a `versionId`, Amazon S3 does not remove the object and + # only inserts a delete marker. To permanently delete an object that + # has a `versionId`, you must include the object’s `versionId` in the + # request. For more information about versioning-suspended buckets, + # see [Deleting objects from versioning-suspended buckets][2]. + # + # * **Directory buckets** - S3 Versioning isn't enabled and supported + # for directory buckets. For this API operation, only the `null` value + # of the version ID is supported by directory buckets. You can only + # specify `null` to the `versionId` query parameter in the request. + # + # * **Directory buckets** - For directory buckets, you must make + # requests for this API operation to the Zonal endpoint. These + # endpoints support virtual-hosted-style requests in the format + # `https://bucket_name.s3express-az_id.region.amazonaws.com/key-name + # `. Path-style requests are not supported. For more information, see + # [Regional and Zonal endpoints][3] in the *Amazon S3 User Guide*. # - # To remove a specific version, you must use the version Id subresource. - # Using this subresource permanently deletes the version. If the object - # deleted is a delete marker, Amazon S3 sets the response header, - # `x-amz-delete-marker`, to true. + # + # + # To remove a specific version, you must use the `versionId` query + # parameter. Using this query parameter permanently deletes the version. + # If the object deleted is a delete marker, Amazon S3 sets the response + # header `x-amz-delete-marker` to true. # # If the object you want to delete is in a bucket where the bucket # versioning configuration is MFA Delete enabled, you must include the # `x-amz-mfa` request header in the DELETE `versionId` request. Requests - # that include `x-amz-mfa` must use HTTPS. + # that include `x-amz-mfa` must use HTTPS. For more information about + # MFA Delete, see [Using MFA Delete][4] in the *Amazon S3 User Guide*. + # To see sample requests that use versioning, see [Sample Request][5]. # - # For more information about MFA Delete, see [Using MFA Delete][1]. To - # see sample requests that use versioning, see [Sample Request][2]. + # **Directory buckets** - MFA delete is not supported by directory + # buckets. # - # You can delete objects by explicitly calling DELETE Object or - # configure its lifecycle ([PutBucketLifecycle][3]) to enable Amazon S3 - # to remove them for you. If you want to block users or accounts from - # removing or deleting objects from your bucket, you must deny them the - # `s3:DeleteObject`, `s3:DeleteObjectVersion`, and - # `s3:PutLifeCycleConfiguration` actions. + # # - # The following action is related to `DeleteObject`: + # You can delete objects by explicitly calling DELETE Object or calling + # ([PutBucketLifecycle][6]) to enable Amazon S3 to remove them for you. + # If you want to block users or accounts from removing or deleting + # objects from your bucket, you must deny them the `s3:DeleteObject`, + # `s3:DeleteObjectVersion`, and `s3:PutLifeCycleConfiguration` actions. # - # * [PutObject][4] + # **Directory buckets** - S3 Lifecycle is not supported by directory + # buckets. # - # ^ + # # + # Permissions + # : * **General purpose bucket permissions** - The following permissions + # are required in your policies when your `DeleteObjects` request + # includes specific headers. + # + # * s3:DeleteObject - To delete an object from + # a bucket, you must always have the `s3:DeleteObject` permission. + # + # * s3:DeleteObjectVersion - To delete a + # specific version of an object from a versioning-enabled bucket, + # you must have the `s3:DeleteObjectVersion` permission. + # + # * **Directory bucket permissions** - To grant access to this API + # operation on a directory bucket, we recommend that you use the [ + # `CreateSession` ][7] API operation for session-based + # authorization. Specifically, you grant the + # `s3express:CreateSession` permission to the directory bucket in a + # bucket policy or an IAM identity-based policy. Then, you make the + # `CreateSession` API call on the bucket to obtain a session token. + # With the session token in your request header, you can make API + # requests to this operation. After the session token expires, you + # make another `CreateSession` API call to generate a new session + # token for use. Amazon Web Services CLI or SDKs create session and + # refresh the session token automatically to avoid service + # interruptions when a session expires. For more information about + # authorization, see [ `CreateSession` ][7]. + # + # HTTP Host header syntax + # + # : Directory buckets - The HTTP Host header syntax is ` + # Bucket_name.s3express-az_id.region.amazonaws.com`. # + # The following action is related to `DeleteObject`: # - # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html - # [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete - # [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html - # [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html + # * [PutObject][8] # - # @example Example: To delete an object (from a non-versioned bucket) + # ^ # - # # The following example deletes an object from a non-versioned bucket. # - # resp = client.delete_object({ - # bucket: "ExampleBucket", - # key: "HappyFace.jpg", - # }) + # + # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeletingObjectVersions.html + # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/DeletingObjectsfromVersioningSuspendedBuckets.html + # [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html + # [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html + # [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete + # [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html + # [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html + # [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html + # # @example Example: To delete an object # # # The following example deletes an object from an S3 bucket. @@ -5039,6 +5483,14 @@ class Aws::S3::Client < ::Seahorse::Client::Base # resp.to_h outputs the following: # { # } + # @example Example: To delete an object (from a non-versioned bucket) + # + # # The following example deletes an object from a non-versioned bucket. + # + # resp = client.delete_object({ + # bucket: "ExampleBucket", + # key: "HappyFace.jpg", + # }) # @example Request syntax with placeholder values # # resp = client.delete_object({ @@ -5071,9 +5523,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::DeleteObjectOutput#request_charged #request_charged} => String # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObject AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#3222 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#4545 def delete_object(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Removes the entire tag set from the specified object. For more # information about managing object tags, see [ Object Tagging][1]. # @@ -5096,34 +5552,34 @@ class Aws::S3::Client < ::Seahorse::Client::Base # [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html # [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html # - # @example Example: To remove tag set from an object + # @example Example: To remove tag set from an object version # - # # The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the - # # operation removes tag set from the latest object version. + # # The following example removes tag set associated with the specified object version. The request specifies both the + # # object key and object version. # # resp = client.delete_object_tagging({ # bucket: "examplebucket", # key: "HappyFace.jpg", + # version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI", # }) # # resp.to_h outputs the following: # { - # version_id: "null", + # version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI", # } - # @example Example: To remove tag set from an object version + # @example Example: To remove tag set from an object # - # # The following example removes tag set associated with the specified object version. The request specifies both the - # # object key and object version. + # # The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the + # # operation removes tag set from the latest object version. # # resp = client.delete_object_tagging({ # bucket: "examplebucket", # key: "HappyFace.jpg", - # version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI", # }) # # resp.to_h outputs the following: # { - # version_id: "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI", + # version_id: "null", # } # @example Request syntax with placeholder values # @@ -5147,28 +5603,41 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::DeleteObjectTaggingOutput#version_id #version_id} => String # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObjectTagging AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#3339 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#4669 def delete_object_tagging(params = T.unsafe(nil), options = T.unsafe(nil)); end - # This action enables you to delete multiple objects from a bucket using - # a single HTTP request. If you know the object keys that you want to - # delete, then this action provides a suitable alternative to sending - # individual delete requests, reducing per-request overhead. + # This operation enables you to delete multiple objects from a bucket + # using a single HTTP request. If you know the object keys that you want + # to delete, then this operation provides a suitable alternative to + # sending individual delete requests, reducing per-request overhead. # - # The request contains a list of up to 1000 keys that you want to + # The request can contain a list of up to 1000 keys that you want to # delete. In the XML, you provide the object key names, and optionally, # version IDs if you want to delete a specific version of the object # from a versioning-enabled bucket. For each key, Amazon S3 performs a - # delete action and returns the result of that delete, success, or + # delete operation and returns the result of that delete, success or # failure, in the response. Note that if the object specified in the # request is not found, Amazon S3 returns the result as deleted. # - # The action supports two modes for the response: verbose and quiet. By - # default, the action uses verbose mode in which the response includes - # the result of deletion of each key in your request. In quiet mode the - # response includes only keys where the delete action encountered an - # error. For a successful deletion, the action does not return any - # information about the delete in the response body. + # * **Directory buckets** - S3 Versioning isn't enabled and supported + # for directory buckets. + # + # * **Directory buckets** - For directory buckets, you must make + # requests for this API operation to the Zonal endpoint. These + # endpoints support virtual-hosted-style requests in the format + # `https://bucket_name.s3express-az_id.region.amazonaws.com/key-name + # `. Path-style requests are not supported. For more information, see + # [Regional and Zonal endpoints][1] in the *Amazon S3 User Guide*. + # + # + # + # The operation supports two modes for the response: verbose and quiet. + # By default, the operation uses verbose mode in which the response + # includes the result of deletion of each key in your request. In quiet + # mode the response includes only keys where the delete operation + # encountered an error. For a successful deletion in a quiet mode, the + # operation does not return any information about the delete in the + # response body. # # When performing this action on an MFA Delete enabled bucket, that # attempts to delete any versioned objects, you must include an MFA @@ -5176,32 +5645,81 @@ class Aws::S3::Client < ::Seahorse::Client::Base # if there are non-versioned objects you are trying to delete. If you # provide an invalid token, whether there are versioned keys in the # request or not, the entire Multi-Object Delete request will fail. For - # information about MFA Delete, see [ MFA Delete][1]. + # information about MFA Delete, see [MFA Delete][2] in the *Amazon S3 + # User Guide*. + # + # **Directory buckets** - MFA delete is not supported by directory + # buckets. + # + # # - # Finally, the Content-MD5 header is required for all Multi-Object - # Delete requests. Amazon S3 uses the header value to ensure that your - # request body has not been altered in transit. + # Permissions + # : * **General purpose bucket permissions** - The following permissions + # are required in your policies when your `DeleteObjects` request + # includes specific headers. + # + # * s3:DeleteObject - To delete an object from + # a bucket, you must always specify the `s3:DeleteObject` + # permission. + # + # * s3:DeleteObjectVersion - To delete a + # specific version of an object from a versioning-enabled bucket, + # you must specify the `s3:DeleteObjectVersion` permission. + # + # * **Directory bucket permissions** - To grant access to this API + # operation on a directory bucket, we recommend that you use the [ + # `CreateSession` ][3] API operation for session-based + # authorization. Specifically, you grant the + # `s3express:CreateSession` permission to the directory bucket in a + # bucket policy or an IAM identity-based policy. Then, you make the + # `CreateSession` API call on the bucket to obtain a session token. + # With the session token in your request header, you can make API + # requests to this operation. After the session token expires, you + # make another `CreateSession` API call to generate a new session + # token for use. Amazon Web Services CLI or SDKs create session and + # refresh the session token automatically to avoid service + # interruptions when a session expires. For more information about + # authorization, see [ `CreateSession` ][3]. + # + # Content-MD5 request header + # : * **General purpose bucket** - The Content-MD5 request header is + # required for all Multi-Object Delete requests. Amazon S3 uses the + # header value to ensure that your request body has not been altered + # in transit. + # + # * **Directory bucket** - The Content-MD5 request header or a + # additional checksum request header (including + # `x-amz-checksum-crc32`, `x-amz-checksum-crc32c`, + # `x-amz-checksum-sha1`, or `x-amz-checksum-sha256`) is required for + # all Multi-Object Delete requests. + # + # HTTP Host header syntax + # + # : Directory buckets - The HTTP Host header syntax is ` + # Bucket_name.s3express-az_id.region.amazonaws.com`. # # The following operations are related to `DeleteObjects`: # - # * [CreateMultipartUpload][2] + # * [CreateMultipartUpload][4] # - # * [UploadPart][3] + # * [UploadPart][5] # - # * [CompleteMultipartUpload][4] + # * [CompleteMultipartUpload][6] # - # * [ListParts][5] + # * [ListParts][7] # - # * [AbortMultipartUpload][6] + # * [AbortMultipartUpload][8] # # # - # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete - # [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html - # [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html - # [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html - # [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html - # [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html + # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html + # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete + # [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html + # [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html + # [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html + # [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html + # [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html + # [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html # # @example Example: To delete multiple objects from a versioned bucket # @@ -5321,9 +5839,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::DeleteObjectsOutput#errors #errors} => Array<Types::Error> # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObjects AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#3588 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#5042 def delete_objects(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Removes the `PublicAccessBlock` configuration for an Amazon S3 bucket. # To use this operation, you must have the # `s3:PutBucketPublicAccessBlock` permission. For more information about @@ -5363,9 +5885,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeletePublicAccessBlock AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#3641 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#5099 def delete_public_access_block(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # This implementation of the GET action uses the `accelerate` # subresource to return the Transfer Acceleration state of a bucket, # which is either `Enabled` or `Suspended`. Amazon S3 Transfer @@ -5427,20 +5953,24 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::GetBucketAccelerateConfigurationOutput#request_charged #request_charged} => String # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAccelerateConfiguration AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#3727 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#5195 def get_bucket_accelerate_configuration(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # This implementation of the `GET` action uses the `acl` subresource to # return the access control list (ACL) of a bucket. To use `GET` to - # return the ACL of the bucket, you must have `READ_ACP` access to the - # bucket. If `READ_ACP` permission is granted to the anonymous user, you - # can return the ACL of the bucket without using an authorization + # return the ACL of the bucket, you must have the `READ_ACP` access to + # the bucket. If `READ_ACP` permission is granted to the anonymous user, + # you can return the ACL of the bucket without using an authorization # header. # - # To use this API operation against an access point, provide the alias - # of the access point in place of the bucket name. + # When you use this API operation with an access point, provide the + # alias of the access point in place of the bucket name. # - # To use this API operation against an Object Lambda access point, + # When you use this API operation with an Object Lambda access point, # provide the alias of the Object Lambda access point in place of the # bucket name. If the Object Lambda access point alias in a request is # not valid, the error code `InvalidAccessPointAliasError` is returned. @@ -5494,9 +6024,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::GetBucketAclOutput#grants #grants} => Array<Types::Grant> # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAcl AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#3819 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#5291 def get_bucket_acl(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # This implementation of the GET action returns an analytics # configuration (identified by the analytics configuration ID) from the # bucket. @@ -5562,9 +6096,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::GetBucketAnalyticsConfigurationOutput#analytics_configuration #analytics_configuration} => Types::AnalyticsConfiguration # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAnalyticsConfiguration AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#3901 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#5377 def get_bucket_analytics_configuration(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Returns the Cross-Origin Resource Sharing (CORS) configuration # information set for the bucket. # @@ -5572,10 +6110,10 @@ class Aws::S3::Client < ::Seahorse::Client::Base # `s3:GetBucketCORS` action. By default, the bucket owner has this # permission and can grant it to others. # - # To use this API operation against an access point, provide the alias - # of the access point in place of the bucket name. + # When you use this API operation with an access point, provide the + # alias of the access point in place of the bucket name. # - # To use this API operation against an Object Lambda access point, + # When you use this API operation with an Object Lambda access point, # provide the alias of the Object Lambda access point in place of the # bucket name. If the Object Lambda access point alias in a request is # not valid, the error code `InvalidAccessPointAliasError` is returned. @@ -5651,9 +6189,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::GetBucketCorsOutput#cors_rules #cors_rules} => Array<Types::CORSRule> # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketCors AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#4017 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#5497 def get_bucket_cors(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Returns the default encryption configuration for an Amazon S3 bucket. # By default, all buckets have a default encryption configuration that # uses server-side encryption with Amazon S3 managed keys (SSE-S3). For @@ -5702,9 +6244,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::GetBucketEncryptionOutput#server_side_encryption_configuration #server_side_encryption_configuration} => Types::ServerSideEncryptionConfiguration # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketEncryption AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#4080 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#5564 def get_bucket_encryption(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Gets the S3 Intelligent-Tiering configuration from the specified # bucket. # @@ -5772,9 +6318,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::GetBucketIntelligentTieringConfigurationOutput#intelligent_tiering_configuration #intelligent_tiering_configuration} => Types::IntelligentTieringConfiguration # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketIntelligentTieringConfiguration AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#4160 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#5648 def get_bucket_intelligent_tiering_configuration(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Returns an inventory configuration (identified by the inventory # configuration ID) from the bucket. # @@ -5837,7 +6387,7 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::GetBucketInventoryConfigurationOutput#inventory_configuration #inventory_configuration} => Types::InventoryConfiguration # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketInventoryConfiguration AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#4239 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#5731 def get_bucket_inventory_configuration(params = T.unsafe(nil), options = T.unsafe(nil)); end # For an updated version of this API, see @@ -5846,6 +6396,10 @@ class Aws::S3::Client < ::Seahorse::Client::Base # version of this topic. This topic is provided for backward # compatibility. # + # This operation is not supported by directory buckets. + # + # + # # Returns the lifecycle configuration information set on the bucket. For # information about lifecycle configuration, see [Object Lifecycle # Management][2]. @@ -5938,17 +6492,24 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::GetBucketLifecycleOutput#rules #rules} => Array<Types::Rule> # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLifecycle AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#4353 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#5849 def get_bucket_lifecycle(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Bucket lifecycle configuration now supports specifying a lifecycle - # rule using an object key name prefix, one or more object tags, or a - # combination of both. Accordingly, this section describes the latest - # API. The response describes the new filter element that you can use to - # specify a filter to select a subset of objects to which the rule - # applies. If you are using a previous version of the lifecycle - # configuration, it still works. For the earlier action, see - # [GetBucketLifecycle][1]. + # rule using an object key name prefix, one or more object tags, object + # size, or any combination of these. Accordingly, this section describes + # the latest API. The previous version of the API supported filtering + # based only on an object key name prefix, which is supported for + # backward compatibility. For the related API description, see + # [GetBucketLifecycle][1]. Accordingly, this section describes the + # latest API. The response describes the new filter element that you can + # use to specify a filter to select a subset of objects to which the + # rule applies. If you are using a previous version of the lifecycle + # configuration, it still works. For the earlier action, # # # @@ -6061,17 +6622,21 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::GetBucketLifecycleConfigurationOutput#rules #rules} => Array<Types::LifecycleRule> # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLifecycleConfiguration AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#4489 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#5992 def get_bucket_lifecycle_configuration(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Returns the Region the bucket resides in. You set the bucket's Region # using the `LocationConstraint` request parameter in a `CreateBucket` # request. For more information, see [CreateBucket][1]. # - # To use this API operation against an access point, provide the alias - # of the access point in place of the bucket name. + # When you use this API operation with an access point, provide the + # alias of the access point in place of the bucket name. # - # To use this API operation against an Object Lambda access point, + # When you use this API operation with an Object Lambda access point, # provide the alias of the Object Lambda access point in place of the # bucket name. If the Object Lambda access point alias in a request is # not valid, the error code `InvalidAccessPointAliasError` is returned. @@ -6117,7 +6682,7 @@ class Aws::S3::Client < ::Seahorse::Client::Base # }) # @example Response structure # - # resp.location_constraint #=> String, one of "af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ca-central-1", "cn-north-1", "cn-northwest-1", "EU", "eu-central-1", "eu-north-1", "eu-south-1", "eu-west-1", "eu-west-2", "eu-west-3", "me-south-1", "sa-east-1", "us-east-2", "us-gov-east-1", "us-gov-west-1", "us-west-1", "us-west-2", "ap-south-2", "eu-south-2" + # resp.location_constraint #=> String, one of "af-south-1", "ap-east-1", "ap-northeast-1", "ap-northeast-2", "ap-northeast-3", "ap-south-1", "ap-south-2", "ap-southeast-1", "ap-southeast-2", "ap-southeast-3", "ca-central-1", "cn-north-1", "cn-northwest-1", "EU", "eu-central-1", "eu-north-1", "eu-south-1", "eu-south-2", "eu-west-1", "eu-west-2", "eu-west-3", "me-south-1", "sa-east-1", "us-east-2", "us-gov-east-1", "us-gov-west-1", "us-west-1", "us-west-2" # @option params # @option params # @overload get_bucket_location @@ -6127,9 +6692,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::GetBucketLocationOutput#location_constraint #location_constraint} => String # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLocation AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#4582 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#6089 def get_bucket_location(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Returns the logging status of a bucket and the permissions users have # to view and modify that status. # @@ -6161,6 +6730,7 @@ class Aws::S3::Client < ::Seahorse::Client::Base # resp.logging_enabled.target_grants[0].grantee.uri #=> String # resp.logging_enabled.target_grants[0].permission #=> String, one of "FULL_CONTROL", "READ", "WRITE" # resp.logging_enabled.target_prefix #=> String + # resp.logging_enabled.target_object_key_format.partitioned_prefix.partition_date_source #=> String, one of "EventTime", "DeliveryTime" # @option params # @option params # @overload get_bucket_logging @@ -6170,9 +6740,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::GetBucketLoggingOutput#logging_enabled #logging_enabled} => Types::LoggingEnabled # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLogging AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#4636 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#6148 def get_bucket_logging(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Gets a metrics configuration (specified by the metrics configuration # ID) from the bucket. Note that this doesn't include the daily storage # metrics. @@ -6236,9 +6810,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::GetBucketMetricsConfigurationOutput#metrics_configuration #metrics_configuration} => Types::MetricsConfiguration # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketMetricsConfiguration AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#4718 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#6234 def get_bucket_metrics_configuration(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # No longer used, see [GetBucketNotificationConfiguration][1]. # # @@ -6334,9 +6912,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::NotificationConfigurationDeprecated#cloud_function_configuration #cloud_function_configuration} => Types::CloudFunctionConfiguration # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketNotification AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#4845 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#6365 def get_bucket_notification(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Returns the notification configuration of a bucket. # # If notifications are not enabled on the bucket, the action returns an @@ -6347,10 +6929,10 @@ class Aws::S3::Client < ::Seahorse::Client::Base # policy to grant permission to other users to read this configuration # with the `s3:GetBucketNotification` permission. # - # To use this API operation against an access point, provide the alias - # of the access point in place of the bucket name. + # When you use this API operation with an access point, provide the + # alias of the access point in place of the bucket name. # - # To use this API operation against an Object Lambda access point, + # When you use this API operation with an Object Lambda access point, # provide the alias of the Object Lambda access point in place of the # bucket name. If the Object Lambda access point alias in a request is # not valid, the error code `InvalidAccessPointAliasError` is returned. @@ -6419,9 +7001,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::NotificationConfiguration#event_bridge_configuration #event_bridge_configuration} => Types::EventBridgeConfiguration # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketNotificationConfiguration AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#4956 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#6480 def get_bucket_notification_configuration(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Retrieves `OwnershipControls` for an Amazon S3 bucket. To use this # operation, you must have the `s3:GetBucketOwnershipControls` # permission. For more information about Amazon S3 permissions, see @@ -6460,53 +7046,85 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::GetBucketOwnershipControlsOutput#ownership_controls #ownership_controls} => Types::OwnershipControls # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketOwnershipControls AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#5009 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#6537 def get_bucket_ownership_controls(params = T.unsafe(nil), options = T.unsafe(nil)); end - # Returns the policy of a specified bucket. If you are using an identity - # other than the root user of the Amazon Web Services account that owns - # the bucket, the calling identity must have the `GetBucketPolicy` - # permissions on the specified bucket and belong to the bucket owner's - # account in order to use this operation. - # - # If you don't have `GetBucketPolicy` permissions, Amazon S3 returns a - # `403 Access Denied` error. If you have the correct permissions, but - # you're not using an identity that belongs to the bucket owner's - # account, Amazon S3 returns a `405 Method Not Allowed` error. - # - # To ensure that bucket owners don't inadvertently lock themselves out - # of their own buckets, the root principal in a bucket owner's Amazon - # Web Services account can perform the `GetBucketPolicy`, - # `PutBucketPolicy`, and `DeleteBucketPolicy` API actions, even if their - # bucket policy explicitly denies the root principal's access. Bucket - # owner root principals can only be blocked from performing these API - # actions by VPC endpoint policies and Amazon Web Services Organizations - # policies. - # - # To use this API operation against an access point, provide the alias - # of the access point in place of the bucket name. - # - # To use this API operation against an Object Lambda access point, - # provide the alias of the Object Lambda access point in place of the - # bucket name. If the Object Lambda access point alias in a request is - # not valid, the error code `InvalidAccessPointAliasError` is returned. - # For more information about `InvalidAccessPointAliasError`, see [List - # of Error Codes][1]. + # Returns the policy of a specified bucket. # - # For more information about bucket policies, see [Using Bucket Policies - # and User Policies][2]. + # Directory buckets - For directory buckets, you must make + # requests for this API operation to the Regional endpoint. These + # endpoints support path-style requests in the format + # `https://s3express-control.region_code.amazonaws.com/bucket-name `. + # Virtual-hosted-style requests aren't supported. For more information, + # see [Regional and Zonal endpoints][1] in the *Amazon S3 User Guide*. + # + # + # + # Permissions + # + # : If you are using an identity other than the root user of the Amazon + # Web Services account that owns the bucket, the calling identity must + # both have the `GetBucketPolicy` permissions on the specified bucket + # and belong to the bucket owner's account in order to use this + # operation. + # + # If you don't have `GetBucketPolicy` permissions, Amazon S3 returns + # a `403 Access Denied` error. If you have the correct permissions, + # but you're not using an identity that belongs to the bucket + # owner's account, Amazon S3 returns a `405 Method Not Allowed` + # error. + # + # To ensure that bucket owners don't inadvertently lock themselves + # out of their own buckets, the root principal in a bucket owner's + # Amazon Web Services account can perform the `GetBucketPolicy`, + # `PutBucketPolicy`, and `DeleteBucketPolicy` API actions, even if + # their bucket policy explicitly denies the root principal's access. + # Bucket owner root principals can only be blocked from performing + # these API actions by VPC endpoint policies and Amazon Web Services + # Organizations policies. + # + # * **General purpose bucket permissions** - The `s3:GetBucketPolicy` + # permission is required in a policy. For more information about + # general purpose buckets bucket policies, see [Using Bucket + # Policies and User Policies][2] in the *Amazon S3 User Guide*. + # + # * **Directory bucket permissions** - To grant access to this API + # operation, you must have the `s3express:GetBucketPolicy` + # permission in an IAM identity-based policy instead of a bucket + # policy. Cross-account access to this API operation isn't + # supported. This operation can only be performed by the Amazon Web + # Services account that owns the resource. For more information + # about directory bucket policies and permissions, see [Amazon Web + # Services Identity and Access Management (IAM) for S3 Express One + # Zone][3] in the *Amazon S3 User Guide*. + # + # Example bucket policies + # + # : **General purpose buckets example bucket policies** - See [Bucket + # policy examples][4] in the *Amazon S3 User Guide*. + # + # **Directory bucket example bucket policies** - See [Example bucket + # policies for S3 Express One Zone][5] in the *Amazon S3 User Guide*. + # + # HTTP Host header syntax + # + # : Directory buckets - The HTTP Host header syntax is + # `s3express-control.region.amazonaws.com`. # # The following action is related to `GetBucketPolicy`: # - # * [GetObject][3] + # * [GetObject][6] # # ^ # # # - # [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList + # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html - # [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html + # [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html + # [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html + # [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html + # [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html # # @example Example: To get bucket policy # @@ -6538,9 +7156,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::GetBucketPolicyOutput#policy #policy} => IO # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketPolicy AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#5114 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#6697 def get_bucket_policy(params = T.unsafe(nil), options = T.unsafe(nil), &block); end + # This operation is not supported by directory buckets. + # + # + # # Retrieves the policy status for an Amazon S3 bucket, indicating # whether the bucket is public. In order to use this operation, you must # have the `s3:GetBucketPolicyStatus` permission. For more information @@ -6587,9 +7209,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::GetBucketPolicyStatusOutput#policy_status #policy_status} => Types::PolicyStatus # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketPolicyStatus AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#5175 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#6762 def get_bucket_policy_status(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Returns the replication configuration of a bucket. # # It can take a while to propagate the put or delete a replication @@ -6676,7 +7302,7 @@ class Aws::S3::Client < ::Seahorse::Client::Base # resp.replication_configuration.rules[0].existing_object_replication.status #=> String, one of "Enabled", "Disabled" # resp.replication_configuration.rules[0].destination.bucket #=> String # resp.replication_configuration.rules[0].destination.account #=> String - # resp.replication_configuration.rules[0].destination.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW" + # resp.replication_configuration.rules[0].destination.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW", "EXPRESS_ONEZONE" # resp.replication_configuration.rules[0].destination.access_control_translation.owner #=> String, one of "Destination" # resp.replication_configuration.rules[0].destination.encryption_configuration.replica_kms_key_id #=> String # resp.replication_configuration.rules[0].destination.replication_time.status #=> String, one of "Enabled", "Disabled" @@ -6693,9 +7319,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::GetBucketReplicationOutput#replication_configuration #replication_configuration} => Types::ReplicationConfiguration # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketReplication AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#5294 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#6885 def get_bucket_replication(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Returns the request payment configuration of a bucket. To use this # version of the operation, you must be the bucket owner. For more # information, see [Requester Pays Buckets][1]. @@ -6741,9 +7371,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::GetBucketRequestPaymentOutput#payer #payer} => String # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketRequestPayment AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#5356 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#6951 def get_bucket_request_payment(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Returns the tag set associated with the bucket. # # To use this operation, you must have permission to perform the @@ -6810,9 +7444,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::GetBucketTaggingOutput#tag_set #tag_set} => Array<Types::Tag> # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketTagging AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#5438 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#7037 def get_bucket_tagging(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Returns the versioning state of a bucket. # # To retrieve the versioning state of a bucket, you must be the bucket @@ -6870,9 +7508,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::GetBucketVersioningOutput#mfa_delete #mfa_delete} => String # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketVersioning AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#5511 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#7114 def get_bucket_versioning(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Returns the website configuration for a bucket. To host website on # Amazon S3, you can configure a bucket as website by adding a website # configuration. For more information about hosting websites, see @@ -6945,170 +7587,168 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::GetBucketWebsiteOutput#routing_rules #routing_rules} => Array<Types::RoutingRule> # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketWebsite AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#5599 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#7206 def get_bucket_website(params = T.unsafe(nil), options = T.unsafe(nil)); end - # Retrieves objects from Amazon S3. To use `GET`, you must have `READ` - # access to the object. If you grant `READ` access to the anonymous - # user, you can return the object without using an authorization header. + # Retrieves an object from Amazon S3. # - # An Amazon S3 bucket has no directory hierarchy such as you would find - # in a typical computer file system. You can, however, create a logical - # hierarchy by using object key names that imply a folder structure. For - # example, instead of naming an object `sample.jpg`, you can name it - # `photos/2006/February/sample.jpg`. + # In the `GetObject` request, specify the full key name for the object. # - # To get an object from such a logical hierarchy, specify the full key - # name for the object in the `GET` operation. For a virtual hosted-style + # **General purpose buckets** - Both the virtual-hosted-style requests + # and the path-style requests are supported. For a virtual hosted-style # request example, if you have the object - # `photos/2006/February/sample.jpg`, specify the resource as + # `photos/2006/February/sample.jpg`, specify the object key name as # `/photos/2006/February/sample.jpg`. For a path-style request example, # if you have the object `photos/2006/February/sample.jpg` in the bucket - # named `examplebucket`, specify the resource as + # named `examplebucket`, specify the object key name as # `/examplebucket/photos/2006/February/sample.jpg`. For more information - # about request types, see [HTTP Host Header Bucket Specification][1]. + # about request types, see [HTTP Host Header Bucket Specification][1] in + # the *Amazon S3 User Guide*. # - # For more information about returning the ACL of an object, see - # [GetObjectAcl][2]. + # **Directory buckets** - Only virtual-hosted-style requests are + # supported. For a virtual hosted-style request example, if you have the + # object `photos/2006/February/sample.jpg` in the bucket named + # `examplebucket--use1-az5--x-s3`, specify the object key name as + # `/photos/2006/February/sample.jpg`. Also, when you make requests to + # this API operation, your requests are sent to the Zonal endpoint. + # These endpoints support virtual-hosted-style requests in the format + # `https://bucket_name.s3express-az_id.region.amazonaws.com/key-name `. + # Path-style requests are not supported. For more information, see + # [Regional and Zonal endpoints][2] in the *Amazon S3 User Guide*. # - # If the object you are retrieving is stored in the S3 Glacier Flexible - # Retrieval or S3 Glacier Deep Archive storage class, or S3 - # Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive - # tiers, before you can retrieve the object you must first restore a - # copy using [RestoreObject][3]. Otherwise, this action returns an - # `InvalidObjectState` error. For information about restoring archived - # objects, see [Restoring Archived Objects][4]. + # Permissions + # : * **General purpose bucket permissions** - You must have the + # required permissions in a policy. To use `GetObject`, you must + # have the `READ` access to the object (or version). If you grant + # `READ` access to the anonymous user, the `GetObject` operation + # returns the object without using an authorization header. For more + # information, see [Specifying permissions in a policy][3] in the + # *Amazon S3 User Guide*. + # + # If you include a `versionId` in your request header, you must have + # the `s3:GetObjectVersion` permission to access a specific version + # of an object. The `s3:GetObject` permission is not required in + # this scenario. + # + # If you request the current version of an object without a specific + # `versionId` in the request header, only the `s3:GetObject` + # permission is required. The `s3:GetObjectVersion` permission is + # not required in this scenario. + # + # If the object that you request doesn’t exist, the error that + # Amazon S3 returns depends on whether you also have the + # `s3:ListBucket` permission. + # + # * If you have the `s3:ListBucket` permission on the bucket, Amazon + # S3 returns an HTTP status code `404 Not Found` error. + # + # * If you don’t have the `s3:ListBucket` permission, Amazon S3 + # returns an HTTP status code `403 Access Denied` error. + # + # * **Directory bucket permissions** - To grant access to this API + # operation on a directory bucket, we recommend that you use the [ + # `CreateSession` ][4] API operation for session-based + # authorization. Specifically, you grant the + # `s3express:CreateSession` permission to the directory bucket in a + # bucket policy or an IAM identity-based policy. Then, you make the + # `CreateSession` API call on the bucket to obtain a session token. + # With the session token in your request header, you can make API + # requests to this operation. After the session token expires, you + # make another `CreateSession` API call to generate a new session + # token for use. Amazon Web Services CLI or SDKs create session and + # refresh the session token automatically to avoid service + # interruptions when a session expires. For more information about + # authorization, see [ `CreateSession` ][4]. + # + # Storage classes + # + # : If the object you are retrieving is stored in the S3 Glacier + # Flexible Retrieval storage class, the S3 Glacier Deep Archive + # storage class, the S3 Intelligent-Tiering Archive Access tier, or + # the S3 Intelligent-Tiering Deep Archive Access tier, before you can + # retrieve the object you must first restore a copy using + # [RestoreObject][5]. Otherwise, this operation returns an + # `InvalidObjectState` error. For information about restoring archived + # objects, see [Restoring Archived Objects][6] in the *Amazon S3 User + # Guide*. + # + # Directory buckets - For directory buckets, only the S3 + # Express One Zone storage class is supported to store newly created + # objects. Unsupported storage class values won't write a destination + # object and will respond with the HTTP status code `400 Bad Request`. + # + # Encryption + # + # : Encryption request headers, like `x-amz-server-side-encryption`, + # should not be sent for the `GetObject` requests, if your object uses + # server-side encryption with Amazon S3 managed encryption keys + # (SSE-S3), server-side encryption with Key Management Service (KMS) + # keys (SSE-KMS), or dual-layer server-side encryption with Amazon Web + # Services KMS keys (DSSE-KMS). If you include the header in your + # `GetObject` requests for the object that uses these types of keys, + # you’ll get an HTTP `400 Bad Request` error. + # + # Overriding response header values through the request # - # Encryption request headers, like `x-amz-server-side-encryption`, - # should not be sent for GET requests if your object uses server-side - # encryption with Key Management Service (KMS) keys (SSE-KMS), - # dual-layer server-side encryption with Amazon Web Services KMS keys - # (DSSE-KMS), or server-side encryption with Amazon S3 managed - # encryption keys (SSE-S3). If your object does use these types of keys, - # you’ll get an HTTP 400 Bad Request error. + # : There are times when you want to override certain response header + # values of a `GetObject` response. For example, you might override + # the `Content-Disposition` response header value through your + # `GetObject` request. # - # If you encrypt an object by using server-side encryption with - # customer-provided encryption keys (SSE-C) when you store the object in - # Amazon S3, then when you GET the object, you must use the following - # headers: + # You can override values for a set of response headers. These + # modified response header values are included only in a successful + # response, that is, when the HTTP status code `200 OK` is returned. + # The headers you can override using the following query parameters in + # the request are a subset of the headers that Amazon S3 accepts when + # you create an object. # - # * `x-amz-server-side-encryption-customer-algorithm` + # The response headers that you can override for the `GetObject` + # response are `Cache-Control`, `Content-Disposition`, + # `Content-Encoding`, `Content-Language`, `Content-Type`, and + # `Expires`. # - # * `x-amz-server-side-encryption-customer-key` + # To override values for a set of response headers in the `GetObject` + # response, you can use the following query parameters in the request. # - # * `x-amz-server-side-encryption-customer-key-MD5` + # * `response-cache-control` # - # For more information about SSE-C, see [Server-Side Encryption (Using - # Customer-Provided Encryption Keys)][5]. + # * `response-content-disposition` # - # Assuming you have the relevant permission to read object tags, the - # response also returns the `x-amz-tagging-count` header that provides - # the count of number of tags associated with the object. You can use - # [GetObjectTagging][6] to retrieve the tag set associated with an - # object. + # * `response-content-encoding` # - # Permissions + # * `response-content-language` # - # : You need the relevant read object (or version) permission for this - # operation. For more information, see [Specifying Permissions in a - # Policy][7]. If the object that you request doesn’t exist, the error - # that Amazon S3 returns depends on whether you also have the - # `s3:ListBucket` permission. + # * `response-content-type` # - # If you have the `s3:ListBucket` permission on the bucket, Amazon S3 - # returns an HTTP status code 404 (Not Found) error. + # * `response-expires` # - # If you don’t have the `s3:ListBucket` permission, Amazon S3 returns - # an HTTP status code 403 ("access denied") error. - # - # Versioning - # - # : By default, the `GET` action returns the current version of an - # object. To return a different version, use the `versionId` - # subresource. - # - # * If you supply a `versionId`, you need the `s3:GetObjectVersion` - # permission to access a specific version of an object. If you - # request a specific version, you do not need to have the - # `s3:GetObject` permission. If you request the current version - # without a specific version ID, only `s3:GetObject` permission is - # required. `s3:GetObjectVersion` permission won't be required. - # - # * If the current version of the object is a delete marker, Amazon S3 - # behaves as if the object was deleted and includes - # `x-amz-delete-marker: true` in the response. - # - # - # - # For more information about versioning, see [PutBucketVersioning][8]. - # - # Overriding Response Header Values - # - # : There are times when you want to override certain response header - # values in a `GET` response. For example, you might override the - # `Content-Disposition` response header value in your `GET` request. - # - # You can override values for a set of response headers using the - # following query parameters. These response header values are sent - # only on a successful request, that is, when status code 200 OK is - # returned. The set of headers you can override using these parameters - # is a subset of the headers that Amazon S3 accepts when you create an - # object. The response headers that you can override for the `GET` - # response are `Content-Type`, `Content-Language`, `Expires`, - # `Cache-Control`, `Content-Disposition`, and `Content-Encoding`. To - # override these header values in the `GET` response, you use the - # following request parameters. - # - # You must sign the request, either using an Authorization header or a - # presigned URL, when using these parameters. They cannot be used with - # an unsigned (anonymous) request. + # When you use these parameters, you must sign the request by using + # either an Authorization header or a presigned URL. These parameters + # cannot be used with an unsigned (anonymous) request. # # # - # * `response-content-type` - # - # * `response-content-language` - # - # * `response-expires` - # - # * `response-cache-control` - # - # * `response-content-disposition` - # - # * `response-content-encoding` - # - # Overriding Response Header Values + # HTTP Host header syntax # - # : If both of the `If-Match` and `If-Unmodified-Since` headers are - # present in the request as follows: `If-Match` condition evaluates to - # `true`, and; `If-Unmodified-Since` condition evaluates to `false`; - # then, S3 returns 200 OK and the data requested. - # - # If both of the `If-None-Match` and `If-Modified-Since` headers are - # present in the request as follows:` If-None-Match` condition - # evaluates to `false`, and; `If-Modified-Since` condition evaluates - # to `true`; then, S3 returns 304 Not Modified response code. - # - # For more information about conditional requests, see [RFC 7232][9]. + # : Directory buckets - The HTTP Host header syntax is ` + # Bucket_name.s3express-az_id.region.amazonaws.com`. # # The following operations are related to `GetObject`: # - # * [ListBuckets][10] + # * [ListBuckets][7] # - # * [GetObjectAcl][2] + # * [GetObjectAcl][8] # # # # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket - # [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html - # [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html - # [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html - # [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html - # [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html - # [7]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html - # [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketVersioning.html - # [9]: https://tools.ietf.org/html/rfc7232 - # [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html + # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html + # [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html + # [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html + # [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html + # [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html + # [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html + # [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html # # @example Example: To retrieve a byte range of an object # @@ -7237,9 +7877,9 @@ class Aws::S3::Client < ::Seahorse::Client::Base # resp.sse_customer_key_md5 #=> String # resp.ssekms_key_id #=> String # resp.bucket_key_enabled #=> Boolean - # resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW" + # resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW", "EXPRESS_ONEZONE" # resp.request_charged #=> String, one of "requester" - # resp.replication_status #=> String, one of "COMPLETE", "PENDING", "FAILED", "REPLICA" + # resp.replication_status #=> String, one of "COMPLETE", "PENDING", "FAILED", "REPLICA", "COMPLETED" # resp.parts_count #=> Integer # resp.tag_count #=> Integer # resp.object_lock_mode #=> String, one of "GOVERNANCE", "COMPLIANCE" @@ -7310,16 +7950,20 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::GetObjectOutput#object_lock_legal_hold_status #object_lock_legal_hold_status} => String # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObject AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#6079 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#7853 def get_object(params = T.unsafe(nil), options = T.unsafe(nil), &block); end + # This operation is not supported by directory buckets. + # + # + # # Returns the access control list (ACL) of an object. To use this # operation, you must have `s3:GetObjectAcl` permissions or `READ_ACP` # access to the object. For more information, see [Mapping of ACL # permissions and access policy permissions][1] in the *Amazon S3 User # Guide* # - # This action is not supported by Amazon S3 on Outposts. + # This functionality is not supported for Amazon S3 on Outposts. # # By default, GET returns ACL information about the current version of # an object. To return ACL information about a different version, use @@ -7437,116 +8081,173 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::GetObjectAclOutput#request_charged #request_charged} => String # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectAcl AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#6246 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#8037 def get_object_acl(params = T.unsafe(nil), options = T.unsafe(nil)); end # Retrieves all the metadata from an object without returning the object - # itself. This action is useful if you're interested only in an - # object's metadata. To use `GetObjectAttributes`, you must have READ - # access to the object. + # itself. This operation is useful if you're interested only in an + # object's metadata. # # `GetObjectAttributes` combines the functionality of `HeadObject` and # `ListParts`. All of the data returned with each of those individual # calls can be returned with a single call to `GetObjectAttributes`. # - # If you encrypt an object by using server-side encryption with - # customer-provided encryption keys (SSE-C) when you store the object in - # Amazon S3, then when you retrieve the metadata from the object, you - # must use the following headers: + # **Directory buckets** - For directory buckets, you must make requests + # for this API operation to the Zonal endpoint. These endpoints support + # virtual-hosted-style requests in the format + # `https://bucket_name.s3express-az_id.region.amazonaws.com/key-name `. + # Path-style requests are not supported. For more information, see + # [Regional and Zonal endpoints][1] in the *Amazon S3 User Guide*. + # + # + # + # Permissions + # : * **General purpose bucket permissions** - To use + # `GetObjectAttributes`, you must have READ access to the object. + # The permissions that you need to use this operation with depend on + # whether the bucket is versioned. If the bucket is versioned, you + # need both the `s3:GetObjectVersion` and + # `s3:GetObjectVersionAttributes` permissions for this operation. If + # the bucket is not versioned, you need the `s3:GetObject` and + # `s3:GetObjectAttributes` permissions. For more information, see + # [Specifying Permissions in a Policy][2] in the *Amazon S3 User + # Guide*. If the object that you request does not exist, the error + # Amazon S3 returns depends on whether you also have the + # `s3:ListBucket` permission. + # + # * If you have the `s3:ListBucket` permission on the bucket, Amazon + # S3 returns an HTTP status code `404 Not Found` ("no such key") + # error. + # + # * If you don't have the `s3:ListBucket` permission, Amazon S3 + # returns an HTTP status code `403 Forbidden` ("access denied") + # error. + # + # * **Directory bucket permissions** - To grant access to this API + # operation on a directory bucket, we recommend that you use the [ + # `CreateSession` ][3] API operation for session-based + # authorization. Specifically, you grant the + # `s3express:CreateSession` permission to the directory bucket in a + # bucket policy or an IAM identity-based policy. Then, you make the + # `CreateSession` API call on the bucket to obtain a session token. + # With the session token in your request header, you can make API + # requests to this operation. After the session token expires, you + # make another `CreateSession` API call to generate a new session + # token for use. Amazon Web Services CLI or SDKs create session and + # refresh the session token automatically to avoid service + # interruptions when a session expires. For more information about + # authorization, see [ `CreateSession` ][3]. + # + # Encryption + # : Encryption request headers, like `x-amz-server-side-encryption`, + # should not be sent for `HEAD` requests if your object uses + # server-side encryption with Key Management Service (KMS) keys + # (SSE-KMS), dual-layer server-side encryption with Amazon Web + # Services KMS keys (DSSE-KMS), or server-side encryption with Amazon + # S3 managed encryption keys (SSE-S3). The + # `x-amz-server-side-encryption` header is used when you `PUT` an + # object to S3 and want to specify the encryption method. If you + # include this header in a `GET` request for an object that uses these + # types of keys, you’ll get an HTTP `400 Bad Request` error. It's + # because the encryption method can't be changed when you retrieve + # the object. + # + # # - # * `x-amz-server-side-encryption-customer-algorithm` + # If you encrypt an object by using server-side encryption with + # customer-provided encryption keys (SSE-C) when you store the object + # in Amazon S3, then when you retrieve the metadata from the object, + # you must use the following headers to provide the encryption key for + # the server to be able to retrieve the object's metadata. The + # headers are: # - # * `x-amz-server-side-encryption-customer-key` + # * `x-amz-server-side-encryption-customer-algorithm` # - # * `x-amz-server-side-encryption-customer-key-MD5` + # * `x-amz-server-side-encryption-customer-key` # - # For more information about SSE-C, see [Server-Side Encryption (Using - # Customer-Provided Encryption Keys)][1] in the *Amazon S3 User Guide*. + # * `x-amz-server-side-encryption-customer-key-MD5` # - # * Encryption request headers, such as `x-amz-server-side-encryption`, - # should not be sent for GET requests if your object uses server-side - # encryption with Amazon Web Services KMS keys stored in Amazon Web - # Services Key Management Service (SSE-KMS) or server-side encryption - # with Amazon S3 managed keys (SSE-S3). If your object does use these - # types of keys, you'll get an HTTP `400 Bad Request` error. + # For more information about SSE-C, see [Server-Side Encryption (Using + # Customer-Provided Encryption Keys)][4] in the *Amazon S3 User + # Guide*. # - # * The last modified property in this case is the creation date of the - # object. + # **Directory bucket permissions** - For directory buckets, only + # server-side encryption with Amazon S3 managed keys (SSE-S3) + # (`AES256`) is supported. # - # + # # - # Consider the following when using request headers: + # Versioning # - # * If both of the `If-Match` and `If-Unmodified-Since` headers are - # present in the request as follows, then Amazon S3 returns the HTTP - # status code `200 OK` and the data requested: + # : **Directory buckets** - S3 Versioning isn't enabled and supported + # for directory buckets. For this API operation, only the `null` value + # of the version ID is supported by directory buckets. You can only + # specify `null` to the `versionId` query parameter in the request. # - # * `If-Match` condition evaluates to `true`. + # Conditional request headers # - # * `If-Unmodified-Since` condition evaluates to `false`. + # : Consider the following when using request headers: # - # * If both of the `If-None-Match` and `If-Modified-Since` headers are - # present in the request as follows, then Amazon S3 returns the HTTP - # status code `304 Not Modified`: + # * If both of the `If-Match` and `If-Unmodified-Since` headers are + # present in the request as follows, then Amazon S3 returns the HTTP + # status code `200 OK` and the data requested: # - # * `If-None-Match` condition evaluates to `false`. + # * `If-Match` condition evaluates to `true`. # - # * `If-Modified-Since` condition evaluates to `true`. + # * `If-Unmodified-Since` condition evaluates to `false`. # - # For more information about conditional requests, see [RFC 7232][2]. + # For more information about conditional requests, see [RFC + # 7232][5]. # - # Permissions + # * If both of the `If-None-Match` and `If-Modified-Since` headers are + # present in the request as follows, then Amazon S3 returns the HTTP + # status code `304 Not Modified`: # - # : The permissions that you need to use this operation depend on - # whether the bucket is versioned. If the bucket is versioned, you - # need both the `s3:GetObjectVersion` and - # `s3:GetObjectVersionAttributes` permissions for this operation. If - # the bucket is not versioned, you need the `s3:GetObject` and - # `s3:GetObjectAttributes` permissions. For more information, see - # [Specifying Permissions in a Policy][3] in the *Amazon S3 User - # Guide*. If the object that you request does not exist, the error - # Amazon S3 returns depends on whether you also have the - # `s3:ListBucket` permission. - # - # * If you have the `s3:ListBucket` permission on the bucket, Amazon - # S3 returns an HTTP status code `404 Not Found` ("no such key") - # error. - # - # * If you don't have the `s3:ListBucket` permission, Amazon S3 - # returns an HTTP status code `403 Forbidden` ("access denied") - # error. + # * `If-None-Match` condition evaluates to `false`. + # + # * `If-Modified-Since` condition evaluates to `true`. + # + # For more information about conditional requests, see [RFC + # 7232][5]. + # + # HTTP Host header syntax + # + # : Directory buckets - The HTTP Host header syntax is ` + # Bucket_name.s3express-az_id.region.amazonaws.com`. # # The following actions are related to `GetObjectAttributes`: # - # * [GetObject][4] + # * [GetObject][6] # - # * [GetObjectAcl][5] + # * [GetObjectAcl][7] # - # * [GetObjectLegalHold][6] + # * [GetObjectLegalHold][8] # - # * [GetObjectLockConfiguration][7] + # * [GetObjectLockConfiguration][9] # - # * [GetObjectRetention][8] + # * [GetObjectRetention][10] # - # * [GetObjectTagging][9] + # * [GetObjectTagging][11] # - # * [HeadObject][10] + # * [HeadObject][12] # - # * [ListParts][11] + # * [ListParts][13] # # # - # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html - # [2]: https://tools.ietf.org/html/rfc7232 - # [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html - # [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html - # [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html - # [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLegalHold.html - # [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLockConfiguration.html - # [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectRetention.html - # [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html - # [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html - # [11]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html + # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html + # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html + # [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html + # [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html + # [5]: https://tools.ietf.org/html/rfc7232 + # [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html + # [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html + # [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLegalHold.html + # [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectLockConfiguration.html + # [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectRetention.html + # [11]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html + # [12]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html + # [13]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html # # @example Request syntax with placeholder values # @@ -7586,7 +8287,7 @@ class Aws::S3::Client < ::Seahorse::Client::Base # resp.object_parts.parts[0].checksum_crc32c #=> String # resp.object_parts.parts[0].checksum_sha1 #=> String # resp.object_parts.parts[0].checksum_sha256 #=> String - # resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW" + # resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW", "EXPRESS_ONEZONE" # resp.object_size #=> Integer # @option params # @option params @@ -7614,13 +8315,17 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::GetObjectAttributesOutput#object_size #object_size} => Integer # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectAttributes AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#6491 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#8383 def get_object_attributes(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Gets an object's current legal hold status. For more information, see # [Locking Objects][1]. # - # This action is not supported by Amazon S3 on Outposts. + # This functionality is not supported for Amazon S3 on Outposts. # # The following action is related to `GetObjectLegalHold`: # @@ -7657,9 +8362,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::GetObjectLegalHoldOutput#legal_hold #legal_hold} => Types::ObjectLockLegalHold # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectLegalHold AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#6574 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#8479 def get_object_legal_hold(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Gets the Object Lock configuration for a bucket. The rule specified in # the Object Lock configuration will be applied by default to every new # object placed in the specified bucket. For more information, see @@ -7697,13 +8406,17 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::GetObjectLockConfigurationOutput#object_lock_configuration #object_lock_configuration} => Types::ObjectLockConfiguration # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectLockConfiguration AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#6637 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#8549 def get_object_lock_configuration(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Retrieves an object's retention settings. For more information, see # [Locking Objects][1]. # - # This action is not supported by Amazon S3 on Outposts. + # This functionality is not supported for Amazon S3 on Outposts. # # The following action is related to `GetObjectRetention`: # @@ -7741,9 +8454,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::GetObjectRetentionOutput#retention #retention} => Types::ObjectLockRetention # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectRetention AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#6721 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#8646 def get_object_retention(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Returns the tag-set of an object. You send the GET request against the # tagging subresource associated with the object. # @@ -7846,9 +8563,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::GetObjectTaggingOutput#tag_set #tag_set} => Array<Types::Tag> # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectTagging AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#6877 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#8815 def get_object_tagging(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Returns torrent files from a bucket. BitTorrent can save you bandwidth # when you're distributing large files. # @@ -7860,7 +8581,7 @@ class Aws::S3::Client < ::Seahorse::Client::Base # # To use GET, you must have READ access to the object. # - # This action is not supported by Amazon S3 on Outposts. + # This functionality is not supported for Amazon S3 on Outposts. # # The following action is related to `GetObjectTorrent`: # @@ -7909,9 +8630,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::GetObjectTorrentOutput#request_charged #request_charged} => String # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectTorrent AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#6968 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#8916 def get_object_torrent(params = T.unsafe(nil), options = T.unsafe(nil), &block); end + # This operation is not supported by directory buckets. + # + # + # # Retrieves the `PublicAccessBlock` configuration for an Amazon S3 # bucket. To use this operation, you must have the # `s3:GetBucketPublicAccessBlock` permission. For more information about @@ -7968,48 +8693,79 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::GetPublicAccessBlockOutput#public_access_block_configuration #public_access_block_configuration} => Types::PublicAccessBlockConfiguration # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetPublicAccessBlock AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#7039 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#8991 def get_public_access_block(params = T.unsafe(nil), options = T.unsafe(nil)); end - # This action is useful to determine if a bucket exists and you have - # permission to access it. The action returns a `200 OK` if the bucket - # exists and you have permission to access it. + # You can use this operation to determine if a bucket exists and if you + # have permission to access it. The action returns a `200 OK` if the + # bucket exists and you have permission to access it. # # If the bucket does not exist or you do not have permission to access # it, the `HEAD` request returns a generic `400 Bad Request`, `403 # Forbidden` or `404 Not Found` code. A message body is not included, so - # you cannot determine the exception beyond these error codes. + # you cannot determine the exception beyond these HTTP response codes. # - # To use this operation, you must have permissions to perform the - # `s3:ListBucket` action. The bucket owner has this permission by - # default and can grant this permission to others. For more information - # about permissions, see [Permissions Related to Bucket Subresource - # Operations][1] and [Managing Access Permissions to Your Amazon S3 - # Resources][2]. + # Directory buckets - You must make requests for this API + # operation to the Zonal endpoint. These endpoints support + # virtual-hosted-style requests in the format + # `https://bucket_name.s3express-az_id.region.amazonaws.com`. Path-style + # requests are not supported. For more information, see [Regional and + # Zonal endpoints][1] in the *Amazon S3 User Guide*. # - # To use this API operation against an access point, you must provide - # the alias of the access point in place of the bucket name or specify - # the access point ARN. When using the access point ARN, you must direct - # requests to the access point hostname. The access point hostname takes - # the form - # *AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com. - # When using the Amazon Web Services SDKs, you provide the ARN in place - # of the bucket name. For more information, see [Using access - # points][3]. - # - # To use this API operation against an Object Lambda access point, - # provide the alias of the Object Lambda access point in place of the - # bucket name. If the Object Lambda access point alias in a request is - # not valid, the error code `InvalidAccessPointAliasError` is returned. - # For more information about `InvalidAccessPointAliasError`, see [List - # of Error Codes][4]. + # # + # Authentication and authorization + # + # : All `HeadBucket` requests must be authenticated and signed by using + # IAM credentials (access key ID and secret access key for the IAM + # identities). All headers with the `x-amz-` prefix, including + # `x-amz-copy-source`, must be signed. For more information, see [REST + # Authentication][2]. + # + # **Directory bucket** - You must use IAM credentials to authenticate + # and authorize your access to the `HeadBucket` API operation, instead + # of using the temporary security credentials through the + # `CreateSession` API operation. + # + # Amazon Web Services CLI or SDKs handles authentication and + # authorization on your behalf. + # + # Permissions + # + # : + # + # * **General purpose bucket permissions** - To use this operation, + # you must have permissions to perform the `s3:ListBucket` action. + # The bucket owner has this permission by default and can grant this + # permission to others. For more information about permissions, see + # [Managing access permissions to your Amazon S3 resources][3] in + # the *Amazon S3 User Guide*. + # + # * **Directory bucket permissions** - You must have the + # s3express:CreateSession permission in the + # `Action` element of a policy. By default, the session is in the + # `ReadWrite` mode. If you want to restrict the access, you can + # explicitly set the `s3express:SessionMode` condition key to + # `ReadOnly` on the bucket. + # + # For more information about example bucket policies, see [Example + # bucket policies for S3 Express One Zone][4] and [Amazon Web + # Services Identity and Access Management (IAM) identity-based + # policies for S3 Express One Zone][5] in the *Amazon S3 User + # Guide*. + # + # HTTP Host header syntax + # + # : Directory buckets - The HTTP Host header syntax is ` + # Bucket_name.s3express-az_id.region.amazonaws.com`. # # - # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources - # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html - # [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html - # [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList + # + # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html + # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html + # [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html + # [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html + # [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html # # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage): # @@ -8029,108 +8785,165 @@ class Aws::S3::Client < ::Seahorse::Client::Base # bucket: "BucketName", # required # expected_bucket_owner: "AccountId", # }) + # @example Response structure + # + # resp.bucket_location_type #=> String, one of "AvailabilityZone" + # resp.bucket_location_name #=> String + # resp.bucket_region #=> String + # resp.access_point_alias #=> Boolean # @option params # @option params # @overload head_bucket # @param params [Hash] ({}) - # @return [Struct] Returns an empty {Seahorse::Client::Response response}. + # @return [Types::HeadBucketOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::HeadBucketOutput#bucket_location_type #bucket_location_type} => String + # * {Types::HeadBucketOutput#bucket_location_name #bucket_location_name} => String + # * {Types::HeadBucketOutput#bucket_region #bucket_region} => String + # * {Types::HeadBucketOutput#access_point_alias #access_point_alias} => Boolean # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/HeadBucket AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#7150 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#9164 def head_bucket(params = T.unsafe(nil), options = T.unsafe(nil)); end - # The `HEAD` action retrieves metadata from an object without returning - # the object itself. This action is useful if you're only interested in - # an object's metadata. To use `HEAD`, you must have READ access to the - # object. + # The `HEAD` operation retrieves metadata from an object without + # returning the object itself. This operation is useful if you're + # interested only in an object's metadata. # - # A `HEAD` request has the same options as a `GET` action on an object. - # The response is identical to the `GET` response except that there is - # no response body. Because of this, if the `HEAD` request generates an - # error, it returns a generic `400 Bad Request`, `403 Forbidden` or `404 - # Not Found` code. It is not possible to retrieve the exact exception - # beyond these error codes. + # A `HEAD` request has the same options as a `GET` operation on an + # object. The response is identical to the `GET` response except that + # there is no response body. Because of this, if the `HEAD` request + # generates an error, it returns a generic code, such as `400 Bad + # Request`, `403 Forbidden`, `404 Not Found`, `405 Method Not Allowed`, + # `412 Precondition Failed`, or `304 Not Modified`. It's not possible + # to retrieve the exact exception of these error codes. # - # If you encrypt an object by using server-side encryption with - # customer-provided encryption keys (SSE-C) when you store the object in - # Amazon S3, then when you retrieve the metadata from the object, you - # must use the following headers: - # - # * `x-amz-server-side-encryption-customer-algorithm` + # Request headers are limited to 8 KB in size. For more information, see + # [Common Request Headers][1]. # - # * `x-amz-server-side-encryption-customer-key` + # **Directory buckets** - For directory buckets, you must make requests + # for this API operation to the Zonal endpoint. These endpoints support + # virtual-hosted-style requests in the format + # `https://bucket_name.s3express-az_id.region.amazonaws.com/key-name `. + # Path-style requests are not supported. For more information, see + # [Regional and Zonal endpoints][2] in the *Amazon S3 User Guide*. # - # * `x-amz-server-side-encryption-customer-key-MD5` + # # - # For more information about SSE-C, see [Server-Side Encryption (Using - # Customer-Provided Encryption Keys)][1]. + # Permissions # - # * Encryption request headers, like `x-amz-server-side-encryption`, - # should not be sent for `GET` requests if your object uses + # : + # + # * **General purpose bucket permissions** - To use `HEAD`, you must + # have the `s3:GetObject` permission. You need the relevant read + # object (or version) permission for this operation. For more + # information, see [Actions, resources, and condition keys for + # Amazon S3][3] in the *Amazon S3 User Guide*. + # + # If the object you request doesn't exist, the error that Amazon S3 + # returns depends on whether you also have the `s3:ListBucket` + # permission. + # + # * If you have the `s3:ListBucket` permission on the bucket, Amazon + # S3 returns an HTTP status code `404 Not Found` error. + # + # * If you don’t have the `s3:ListBucket` permission, Amazon S3 + # returns an HTTP status code `403 Forbidden` error. + # + # * **Directory bucket permissions** - To grant access to this API + # operation on a directory bucket, we recommend that you use the [ + # `CreateSession` ][4] API operation for session-based + # authorization. Specifically, you grant the + # `s3express:CreateSession` permission to the directory bucket in a + # bucket policy or an IAM identity-based policy. Then, you make the + # `CreateSession` API call on the bucket to obtain a session token. + # With the session token in your request header, you can make API + # requests to this operation. After the session token expires, you + # make another `CreateSession` API call to generate a new session + # token for use. Amazon Web Services CLI or SDKs create session and + # refresh the session token automatically to avoid service + # interruptions when a session expires. For more information about + # authorization, see [ `CreateSession` ][4]. + # + # Encryption + # : Encryption request headers, like `x-amz-server-side-encryption`, + # should not be sent for `HEAD` requests if your object uses # server-side encryption with Key Management Service (KMS) keys # (SSE-KMS), dual-layer server-side encryption with Amazon Web # Services KMS keys (DSSE-KMS), or server-side encryption with Amazon - # S3 managed encryption keys (SSE-S3). If your object does use these - # types of keys, you’ll get an HTTP 400 Bad Request error. + # S3 managed encryption keys (SSE-S3). The + # `x-amz-server-side-encryption` header is used when you `PUT` an + # object to S3 and want to specify the encryption method. If you + # include this header in a `HEAD` request for an object that uses + # these types of keys, you’ll get an HTTP `400 Bad Request` error. + # It's because the encryption method can't be changed when you + # retrieve the object. # - # * The last modified property in this case is the creation date of the - # object. - # - # - # - # Request headers are limited to 8 KB in size. For more information, see - # [Common Request Headers][2]. + # # - # Consider the following when using request headers: + # If you encrypt an object by using server-side encryption with + # customer-provided encryption keys (SSE-C) when you store the object + # in Amazon S3, then when you retrieve the metadata from the object, + # you must use the following headers to provide the encryption key for + # the server to be able to retrieve the object's metadata. The + # headers are: # - # * Consideration 1 – If both of the `If-Match` and - # `If-Unmodified-Since` headers are present in the request as follows: + # * `x-amz-server-side-encryption-customer-algorithm` # - # * `If-Match` condition evaluates to `true`, and; + # * `x-amz-server-side-encryption-customer-key` # - # * `If-Unmodified-Since` condition evaluates to `false`; + # * `x-amz-server-side-encryption-customer-key-MD5` # - # Then Amazon S3 returns `200 OK` and the data requested. + # For more information about SSE-C, see [Server-Side Encryption (Using + # Customer-Provided Encryption Keys)][5] in the *Amazon S3 User + # Guide*. # - # * Consideration 2 – If both of the `If-None-Match` and - # `If-Modified-Since` headers are present in the request as follows: + # **Directory bucket permissions** - For directory buckets, only + # server-side encryption with Amazon S3 managed keys (SSE-S3) + # (`AES256`) is supported. # - # * `If-None-Match` condition evaluates to `false`, and; + # # - # * `If-Modified-Since` condition evaluates to `true`; + # Versioning + # : * If the current version of the object is a delete marker, Amazon S3 + # behaves as if the object was deleted and includes + # `x-amz-delete-marker: true` in the response. # - # Then Amazon S3 returns the `304 Not Modified` response code. + # * If the specified version is a delete marker, the response returns + # a `405 Method Not Allowed` error and the `Last-Modified: + # timestamp` response header. # - # For more information about conditional requests, see [RFC 7232][3]. + # * **Directory buckets** - Delete marker is not supported by + # directory buckets. # - # Permissions + # * **Directory buckets** - S3 Versioning isn't enabled and supported + # for directory buckets. For this API operation, only the `null` + # value of the version ID is supported by directory buckets. You can + # only specify `null` to the `versionId` query parameter in the + # request. # - # : You need the relevant read object (or version) permission for this - # operation. For more information, see [Actions, resources, and - # condition keys for Amazon S3][4]. If the object you request doesn't - # exist, the error that Amazon S3 returns depends on whether you also - # have the s3:ListBucket permission. + # # - # * If you have the `s3:ListBucket` permission on the bucket, Amazon - # S3 returns an HTTP status code 404 error. + # HTTP Host header syntax # - # * If you don’t have the `s3:ListBucket` permission, Amazon S3 - # returns an HTTP status code 403 error. + # : Directory buckets - The HTTP Host header syntax is ` + # Bucket_name.s3express-az_id.region.amazonaws.com`. # # The following actions are related to `HeadObject`: # - # * [GetObject][5] + # * [GetObject][6] # - # * [GetObjectAttributes][6] + # * [GetObjectAttributes][7] # # # - # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html - # [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html - # [3]: https://tools.ietf.org/html/rfc7232 - # [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html - # [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html - # [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html + # [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html + # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html + # [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html + # [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html + # [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html + # [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html + # [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html # # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage): # @@ -8167,6 +8980,12 @@ class Aws::S3::Client < ::Seahorse::Client::Base # if_unmodified_since: Time.now, # key: "ObjectKey", # required # range: "Range", + # response_cache_control: "ResponseCacheControl", + # response_content_disposition: "ResponseContentDisposition", + # response_content_encoding: "ResponseContentEncoding", + # response_content_language: "ResponseContentLanguage", + # response_content_type: "ResponseContentType", + # response_expires: Time.now, # version_id: "ObjectVersionId", # sse_customer_algorithm: "SSECustomerAlgorithm", # sse_customer_key: "SSECustomerKey", @@ -8207,9 +9026,9 @@ class Aws::S3::Client < ::Seahorse::Client::Base # resp.sse_customer_key_md5 #=> String # resp.ssekms_key_id #=> String # resp.bucket_key_enabled #=> Boolean - # resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW" + # resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW", "EXPRESS_ONEZONE" # resp.request_charged #=> String, one of "requester" - # resp.replication_status #=> String, one of "COMPLETE", "PENDING", "FAILED", "REPLICA" + # resp.replication_status #=> String, one of "COMPLETE", "PENDING", "FAILED", "REPLICA", "COMPLETED" # resp.parts_count #=> Integer # resp.object_lock_mode #=> String, one of "GOVERNANCE", "COMPLIANCE" # resp.object_lock_retain_until_date #=> Time @@ -8229,6 +9048,12 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @option params # @option params # @option params + # @option params + # @option params + # @option params + # @option params + # @option params + # @option params # @overload head_object # @param params [Hash] ({}) # @return [Types::HeadObjectOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -8270,9 +9095,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::HeadObjectOutput#object_lock_legal_hold_status #object_lock_legal_hold_status} => String # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/HeadObject AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#7476 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#9662 def head_object(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Lists the analytics configurations for the bucket. You can have up to # 1,000 analytics configurations per bucket. # @@ -8352,9 +9181,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::ListBucketAnalyticsConfigurationsOutput#analytics_configuration_list #analytics_configuration_list} => Array<Types::AnalyticsConfiguration> # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketAnalyticsConfigurations AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#7573 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#9763 def list_bucket_analytics_configurations(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Lists the S3 Intelligent-Tiering configuration from the specified # bucket. # @@ -8429,9 +9262,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::ListBucketIntelligentTieringConfigurationsOutput#intelligent_tiering_configuration_list #intelligent_tiering_configuration_list} => Array<Types::IntelligentTieringConfiguration> # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketIntelligentTieringConfigurations AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#7661 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#9855 def list_bucket_intelligent_tiering_configurations(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Returns a list of inventory configurations for the bucket. You can # have up to 1,000 analytics configurations per bucket. # @@ -8510,9 +9347,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::ListBucketInventoryConfigurationsOutput#next_continuation_token #next_continuation_token} => String # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketInventoryConfigurations AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#7759 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#9957 def list_bucket_inventory_configurations(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Lists the metrics configurations for the bucket. The metrics # configurations are only for the request metrics of the bucket and do # not provide information on daily storage metrics. You can have up to @@ -8591,9 +9432,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::ListBucketMetricsConfigurationsOutput#metrics_configuration_list #metrics_configuration_list} => Array<Types::MetricsConfiguration> # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketMetricsConfigurations AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#7857 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#10059 def list_bucket_metrics_configurations(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Returns a list of all buckets owned by the authenticated sender of the # request. To use this operation, you must have the # `s3:ListAllMyBuckets` permission. @@ -8648,56 +9493,184 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::ListBucketsOutput#owner #owner} => Types::Owner # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBuckets AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#7920 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#10126 def list_buckets(params = T.unsafe(nil), options = T.unsafe(nil)); end - # This action lists in-progress multipart uploads. An in-progress - # multipart upload is a multipart upload that has been initiated using - # the Initiate Multipart Upload request, but has not yet been completed - # or aborted. - # - # This action returns at most 1,000 multipart uploads in the response. - # 1,000 multipart uploads is the maximum number of uploads a response - # can include, which is also the default value. You can further limit - # the number of uploads in a response by specifying the `max-uploads` - # parameter in the response. If additional multipart uploads satisfy the - # list criteria, the response will contain an `IsTruncated` element with - # the value true. To list the additional multipart uploads, use the - # `key-marker` and `upload-id-marker` request parameters. - # - # In the response, the uploads are sorted by key. If your application - # has initiated more than one multipart upload using the same object - # key, then uploads in the response are first sorted by key. - # Additionally, uploads are sorted in ascending order within each key by - # the upload initiation time. + # Returns a list of all Amazon S3 directory buckets owned by the + # authenticated sender of the request. For more information about + # directory buckets, see [Directory buckets][1] in the *Amazon S3 User + # Guide*. # - # For more information on multipart uploads, see [Uploading Objects - # Using Multipart Upload][1]. + # Directory buckets - For directory buckets, you must make + # requests for this API operation to the Regional endpoint. These + # endpoints support path-style requests in the format + # `https://s3express-control.region_code.amazonaws.com/bucket-name `. + # Virtual-hosted-style requests aren't supported. For more information, + # see [Regional and Zonal endpoints][2] in the *Amazon S3 User Guide*. + # + # + # + # Permissions + # + # : You must have the `s3express:ListAllMyDirectoryBuckets` permission + # in an IAM identity-based policy instead of a bucket policy. + # Cross-account access to this API operation isn't supported. This + # operation can only be performed by the Amazon Web Services account + # that owns the resource. For more information about directory bucket + # policies and permissions, see [Amazon Web Services Identity and + # Access Management (IAM) for S3 Express One Zone][3] in the *Amazon + # S3 User Guide*. + # + # HTTP Host header syntax + # + # : Directory buckets - The HTTP Host header syntax is + # `s3express-control.region.amazonaws.com`. + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html + # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html + # [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html + # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # + # @example Request syntax with placeholder values + # + # resp = client.list_directory_buckets({ + # continuation_token: "DirectoryBucketToken", + # max_directory_buckets: 1, + # }) + # @example Response structure + # + # resp.buckets #=> Array + # resp.buckets[0].name #=> String + # resp.buckets[0].creation_date #=> Time + # resp.continuation_token #=> String + # @option params + # @option params + # @overload list_directory_buckets + # @param params [Hash] ({}) + # @return [Types::ListDirectoryBucketsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::ListDirectoryBucketsOutput#buckets #buckets} => Array<Types::Bucket> + # * {Types::ListDirectoryBucketsOutput#continuation_token #continuation_token} => String + # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListDirectoryBuckets AWS API Documentation + # + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#10203 + def list_directory_buckets(params = T.unsafe(nil), options = T.unsafe(nil)); end + + # This operation lists in-progress multipart uploads in a bucket. An + # in-progress multipart upload is a multipart upload that has been + # initiated by the `CreateMultipartUpload` request, but has not yet been + # completed or aborted. + # + # **Directory buckets** - If multipart uploads in a directory bucket are + # in progress, you can't delete the bucket until all the in-progress + # multipart uploads are aborted or completed. + # + # + # + # The `ListMultipartUploads` operation returns a maximum of 1,000 + # multipart uploads in the response. The limit of 1,000 multipart + # uploads is also the default value. You can further limit the number of + # uploads in a response by specifying the `max-uploads` request + # parameter. If there are more than 1,000 multipart uploads that satisfy + # your `ListMultipartUploads` request, the response returns an + # `IsTruncated` element with the value of `true`, a `NextKeyMarker` + # element, and a `NextUploadIdMarker` element. To list the remaining + # multipart uploads, you need to make subsequent `ListMultipartUploads` + # requests. In these requests, include two query parameters: + # `key-marker` and `upload-id-marker`. Set the value of `key-marker` to + # the `NextKeyMarker` value from the previous response. Similarly, set + # the value of `upload-id-marker` to the `NextUploadIdMarker` value from + # the previous response. + # + # **Directory buckets** - The `upload-id-marker` element and the + # `NextUploadIdMarker` element aren't supported by directory buckets. + # To list the additional multipart uploads, you only need to set the + # value of `key-marker` to the `NextKeyMarker` value from the previous + # response. + # + # + # + # For more information about multipart uploads, see [Uploading Objects + # Using Multipart Upload][1] in the *Amazon S3 User Guide*. + # + # **Directory buckets** - For directory buckets, you must make requests + # for this API operation to the Zonal endpoint. These endpoints support + # virtual-hosted-style requests in the format + # `https://bucket_name.s3express-az_id.region.amazonaws.com/key-name `. + # Path-style requests are not supported. For more information, see + # [Regional and Zonal endpoints][2] in the *Amazon S3 User Guide*. # - # For information on permissions required to use the multipart upload - # API, see [Multipart Upload and Permissions][2]. + # + # + # Permissions + # : * **General purpose bucket permissions** - For information about + # permissions required to use the multipart upload API, see + # [Multipart Upload and Permissions][3] in the *Amazon S3 User + # Guide*. + # + # * **Directory bucket permissions** - To grant access to this API + # operation on a directory bucket, we recommend that you use the [ + # `CreateSession` ][4] API operation for session-based + # authorization. Specifically, you grant the + # `s3express:CreateSession` permission to the directory bucket in a + # bucket policy or an IAM identity-based policy. Then, you make the + # `CreateSession` API call on the bucket to obtain a session token. + # With the session token in your request header, you can make API + # requests to this operation. After the session token expires, you + # make another `CreateSession` API call to generate a new session + # token for use. Amazon Web Services CLI or SDKs create session and + # refresh the session token automatically to avoid service + # interruptions when a session expires. For more information about + # authorization, see [ `CreateSession` ][4]. + # + # Sorting of multipart uploads in response + # : * **General purpose bucket** - In the `ListMultipartUploads` + # response, the multipart uploads are sorted based on two criteria: + # + # * Key-based sorting - Multipart uploads are initially sorted in + # ascending order based on their object keys. + # + # * Time-based sorting - For uploads that share the same object key, + # they are further sorted in ascending order based on the upload + # initiation time. Among uploads with the same key, the one that + # was initiated first will appear before the ones that were + # initiated later. + # + # * **Directory bucket** - In the `ListMultipartUploads` response, the + # multipart uploads aren't sorted lexicographically based on the + # object keys. + # + # HTTP Host header syntax + # + # : Directory buckets - The HTTP Host header syntax is ` + # Bucket_name.s3express-az_id.region.amazonaws.com`. # # The following operations are related to `ListMultipartUploads`: # - # * [CreateMultipartUpload][3] + # * [CreateMultipartUpload][5] # - # * [UploadPart][4] + # * [UploadPart][6] # - # * [CompleteMultipartUpload][5] + # * [CompleteMultipartUpload][7] # - # * [ListParts][6] + # * [ListParts][8] # - # * [AbortMultipartUpload][7] + # * [AbortMultipartUpload][9] # # # # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html - # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html - # [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html - # [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html - # [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html - # [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html - # [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html + # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html + # [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html + # [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html + # [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html + # [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html + # [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html + # [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html + # [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # @@ -8822,7 +9795,7 @@ class Aws::S3::Client < ::Seahorse::Client::Base # resp.uploads[0].upload_id #=> String # resp.uploads[0].key #=> String # resp.uploads[0].initiated #=> Time - # resp.uploads[0].storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW" + # resp.uploads[0].storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW", "EXPRESS_ONEZONE" # resp.uploads[0].owner.display_name #=> String # resp.uploads[0].owner.id #=> String # resp.uploads[0].initiator.id #=> String @@ -8860,9 +9833,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::ListMultipartUploadsOutput#request_charged #request_charged} => String # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListMultipartUploads AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#8222 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#10625 def list_multipart_uploads(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Returns metadata about all versions of the objects in a bucket. You # can also use request parameters as selection criteria to return # metadata about a subset of all the object versions. @@ -8878,8 +9855,6 @@ class Aws::S3::Client < ::Seahorse::Client::Base # # To use this operation, you must have READ access to the bucket. # - # This action is not supported by Amazon S3 on Outposts. - # # The following operations are related to `ListObjectVersions`: # # * [ListObjectsV2][1] @@ -8901,9 +9876,7 @@ class Aws::S3::Client < ::Seahorse::Client::Base # # @example Example: To list object versions # - # # The following example return versions of an object with specific key name prefix. The request limits the number of items - # # returned to two. If there are are more than two object version, S3 returns NextToken in the response. You can specify - # # this token value in your next request to fetch next set of object versions. + # # The following example returns versions of an object with specific key name prefix. # # resp = client.list_object_versions({ # bucket: "examplebucket", @@ -9021,9 +9994,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::ListObjectVersionsOutput#request_charged #request_charged} => String # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectVersions AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#8441 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#10850 def list_object_versions(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Returns some or all (up to 1,000) of the objects in a bucket. You can # use the request parameters as selection criteria to return a subset of # the objects in a bucket. A 200 OK response can contain valid or @@ -9118,7 +10095,7 @@ class Aws::S3::Client < ::Seahorse::Client::Base # resp.contents[0].checksum_algorithm #=> Array # resp.contents[0].checksum_algorithm[0] #=> String, one of "CRC32", "CRC32C", "SHA1", "SHA256" # resp.contents[0].size #=> Integer - # resp.contents[0].storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW" + # resp.contents[0].storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW", "EXPRESS_ONEZONE" # resp.contents[0].owner.display_name #=> String # resp.contents[0].owner.id #=> String # resp.contents[0].restore_status.is_restore_in_progress #=> Boolean @@ -9157,54 +10134,89 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::ListObjectsOutput#request_charged #request_charged} => String # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjects AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#8638 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#11070 def list_objects(params = T.unsafe(nil), options = T.unsafe(nil)); end # Returns some or all (up to 1,000) of the objects in a bucket with each # request. You can use the request parameters as selection criteria to # return a subset of the objects in a bucket. A `200 OK` response can # contain valid or invalid XML. Make sure to design your application to - # parse the contents of the response and handle it appropriately. - # Objects are returned sorted in an ascending order of the respective - # key names in the list. For more information about listing objects, see - # [Listing object keys programmatically][1] in the *Amazon S3 User - # Guide*. + # parse the contents of the response and handle it appropriately. For + # more information about listing objects, see [Listing object keys + # programmatically][1] in the *Amazon S3 User Guide*. To get a list of + # your buckets, see [ListBuckets][2]. + # + # **Directory buckets** - For directory buckets, you must make requests + # for this API operation to the Zonal endpoint. These endpoints support + # virtual-hosted-style requests in the format + # `https://bucket_name.s3express-az_id.region.amazonaws.com/key-name `. + # Path-style requests are not supported. For more information, see + # [Regional and Zonal endpoints][3] in the *Amazon S3 User Guide*. # - # To use this operation, you must have READ access to the bucket. + # # - # To use this action in an Identity and Access Management (IAM) policy, - # you must have permission to perform the `s3:ListBucket` action. The - # bucket owner has this permission by default and can grant this - # permission to others. For more information about permissions, see - # [Permissions Related to Bucket Subresource Operations][2] and - # [Managing Access Permissions to Your Amazon S3 Resources][3] in the - # *Amazon S3 User Guide*. + # Permissions + # : * **General purpose bucket permissions** - To use this operation, + # you must have READ access to the bucket. You must have permission + # to perform the `s3:ListBucket` action. The bucket owner has this + # permission by default and can grant this permission to others. For + # more information about permissions, see [Permissions Related to + # Bucket Subresource Operations][4] and [Managing Access Permissions + # to Your Amazon S3 Resources][5] in the *Amazon S3 User Guide*. + # + # * **Directory bucket permissions** - To grant access to this API + # operation on a directory bucket, we recommend that you use the [ + # `CreateSession` ][6] API operation for session-based + # authorization. Specifically, you grant the + # `s3express:CreateSession` permission to the directory bucket in a + # bucket policy or an IAM identity-based policy. Then, you make the + # `CreateSession` API call on the bucket to obtain a session token. + # With the session token in your request header, you can make API + # requests to this operation. After the session token expires, you + # make another `CreateSession` API call to generate a new session + # token for use. Amazon Web Services CLI or SDKs create session and + # refresh the session token automatically to avoid service + # interruptions when a session expires. For more information about + # authorization, see [ `CreateSession` ][6]. + # + # Sorting order of returned objects + # : * **General purpose bucket** - For general purpose buckets, + # `ListObjectsV2` returns objects in lexicographical order based on + # their key names. + # + # * **Directory bucket** - For directory buckets, `ListObjectsV2` does + # not return objects in lexicographical order. + # + # HTTP Host header syntax + # + # : Directory buckets - The HTTP Host header syntax is ` + # Bucket_name.s3express-az_id.region.amazonaws.com`. # # This section describes the latest revision of this action. We # recommend that you use this revised API operation for application # development. For backward compatibility, Amazon S3 continues to - # support the prior version of this API operation, [ListObjects][4]. - # - # To get a list of your buckets, see [ListBuckets][5]. + # support the prior version of this API operation, [ListObjects][7]. # # The following operations are related to `ListObjectsV2`: # - # * [GetObject][6] + # * [GetObject][8] # - # * [PutObject][7] + # * [PutObject][9] # - # * [CreateBucket][8] + # * [CreateBucket][10] # # # # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html - # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources - # [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html - # [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html - # [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html - # [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html - # [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html - # [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html + # [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html + # [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html + # [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources + # [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html + # [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html + # [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html + # [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html + # [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html + # [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # @@ -9268,7 +10280,7 @@ class Aws::S3::Client < ::Seahorse::Client::Base # resp.contents[0].checksum_algorithm #=> Array # resp.contents[0].checksum_algorithm[0] #=> String, one of "CRC32", "CRC32C", "SHA1", "SHA256" # resp.contents[0].size #=> Integer - # resp.contents[0].storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW" + # resp.contents[0].storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "GLACIER", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW", "EXPRESS_ONEZONE" # resp.contents[0].owner.display_name #=> String # resp.contents[0].owner.id #=> String # resp.contents[0].restore_status.is_restore_in_progress #=> Boolean @@ -9315,56 +10327,96 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::ListObjectsV2Output#request_charged #request_charged} => String # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsV2 AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#8860 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#11386 def list_objects_v2(params = T.unsafe(nil), options = T.unsafe(nil)); end # Lists the parts that have been uploaded for a specific multipart - # upload. This operation must include the upload ID, which you obtain by - # sending the initiate multipart upload request (see - # [CreateMultipartUpload][1]). This request returns a maximum of 1,000 - # uploaded parts. The default number of parts returned is 1,000 parts. - # You can restrict the number of parts returned by specifying the - # `max-parts` request parameter. If your multipart upload consists of - # more than 1,000 parts, the response returns an `IsTruncated` field - # with the value of true, and a `NextPartNumberMarker` element. In - # subsequent `ListParts` requests you can include the part-number-marker - # query string parameter and set its value to the `NextPartNumberMarker` - # field value from the previous response. - # - # If the upload was created using a checksum algorithm, you will need to - # have permission to the `kms:Decrypt` action for the request to - # succeed. + # upload. + # + # To use this operation, you must provide the `upload ID` in the + # request. You obtain this uploadID by sending the initiate multipart + # upload request through [CreateMultipartUpload][1]. + # + # The `ListParts` request returns a maximum of 1,000 uploaded parts. The + # limit of 1,000 parts is also the default value. You can restrict the + # number of parts in a response by specifying the `max-parts` request + # parameter. If your multipart upload consists of more than 1,000 parts, + # the response returns an `IsTruncated` field with the value of `true`, + # and a `NextPartNumberMarker` element. To list remaining uploaded + # parts, in subsequent `ListParts` requests, include the + # `part-number-marker` query string parameter and set its value to the + # `NextPartNumberMarker` field value from the previous response. # # For more information on multipart uploads, see [Uploading Objects - # Using Multipart Upload][2]. + # Using Multipart Upload][2] in the *Amazon S3 User Guide*. + # + # **Directory buckets** - For directory buckets, you must make requests + # for this API operation to the Zonal endpoint. These endpoints support + # virtual-hosted-style requests in the format + # `https://bucket_name.s3express-az_id.region.amazonaws.com/key-name `. + # Path-style requests are not supported. For more information, see + # [Regional and Zonal endpoints][3] in the *Amazon S3 User Guide*. + # + # # - # For information on permissions required to use the multipart upload - # API, see [Multipart Upload and Permissions][3]. + # Permissions + # : * **General purpose bucket permissions** - For information about + # permissions required to use the multipart upload API, see + # [Multipart Upload and Permissions][4] in the *Amazon S3 User + # Guide*. + # + # If the upload was created using server-side encryption with Key + # Management Service (KMS) keys (SSE-KMS) or dual-layer server-side + # encryption with Amazon Web Services KMS keys (DSSE-KMS), you must + # have permission to the `kms:Decrypt` action for the `ListParts` + # request to succeed. + # + # * **Directory bucket permissions** - To grant access to this API + # operation on a directory bucket, we recommend that you use the [ + # `CreateSession` ][5] API operation for session-based + # authorization. Specifically, you grant the + # `s3express:CreateSession` permission to the directory bucket in a + # bucket policy or an IAM identity-based policy. Then, you make the + # `CreateSession` API call on the bucket to obtain a session token. + # With the session token in your request header, you can make API + # requests to this operation. After the session token expires, you + # make another `CreateSession` API call to generate a new session + # token for use. Amazon Web Services CLI or SDKs create session and + # refresh the session token automatically to avoid service + # interruptions when a session expires. For more information about + # authorization, see [ `CreateSession` ][5]. + # + # HTTP Host header syntax + # + # : Directory buckets - The HTTP Host header syntax is ` + # Bucket_name.s3express-az_id.region.amazonaws.com`. # # The following operations are related to `ListParts`: # # * [CreateMultipartUpload][1] # - # * [UploadPart][4] + # * [UploadPart][6] # - # * [CompleteMultipartUpload][5] + # * [CompleteMultipartUpload][7] # - # * [AbortMultipartUpload][6] + # * [AbortMultipartUpload][8] # - # * [GetObjectAttributes][7] + # * [GetObjectAttributes][9] # - # * [ListMultipartUploads][8] + # * [ListMultipartUploads][10] # # # # [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html - # [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html - # [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html - # [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html - # [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html - # [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html - # [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html + # [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html + # [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html + # [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html + # [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html + # [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html + # [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html + # [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAttributes.html + # [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # @@ -9442,7 +10494,7 @@ class Aws::S3::Client < ::Seahorse::Client::Base # resp.initiator.display_name #=> String # resp.owner.display_name #=> String # resp.owner.id #=> String - # resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW" + # resp.storage_class #=> String, one of "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS", "GLACIER_IR", "SNOW", "EXPRESS_ONEZONE" # resp.request_charged #=> String, one of "requester" # resp.checksum_algorithm #=> String, one of "CRC32", "CRC32C", "SHA1", "SHA256" # @option params @@ -9476,9 +10528,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::ListPartsOutput#checksum_algorithm #checksum_algorithm} => String # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListParts AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#9103 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#11706 def list_parts(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Sets the accelerate configuration of an existing bucket. Amazon S3 # Transfer Acceleration is a bucket-level feature that enables you to # perform faster data transfers to Amazon S3. @@ -9544,12 +10600,16 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketAccelerateConfiguration AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#9198 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#11805 def put_bucket_accelerate_configuration(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Sets the permissions on an existing bucket using access control lists # (ACL). For more information, see [Using ACLs][1]. To set the ACL of a - # bucket, you must have `WRITE_ACP` permission. + # bucket, you must have the `WRITE_ACP` permission. # # You can use one of the following two ways to set a bucket's # permissions: @@ -9776,9 +10836,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketAcl AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#9488 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#12099 def put_bucket_acl(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Sets an analytics configuration for the bucket (specified by the # analytics configuration ID). You can have up to 1,000 analytics # configurations per bucket. @@ -9896,9 +10960,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketAnalyticsConfiguration AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#9622 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#12237 def put_bucket_analytics_configuration(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Sets the `cors` configuration for your bucket. If the configuration # exists, Amazon S3 replaces it. # @@ -10024,9 +11092,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketCors AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#9797 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#12416 def put_bucket_cors(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # This action uses the `encryption` subresource to configure default # encryption and Amazon S3 Bucket Keys for an existing bucket. # @@ -10034,13 +11106,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # uses server-side encryption with Amazon S3 managed keys (SSE-S3). You # can optionally configure default encryption for a bucket by using # server-side encryption with Key Management Service (KMS) keys - # (SSE-KMS), dual-layer server-side encryption with Amazon Web Services - # KMS keys (DSSE-KMS), or server-side encryption with customer-provided - # keys (SSE-C). If you specify default encryption by using SSE-KMS, you - # can also configure Amazon S3 Bucket Keys. For information about bucket - # default encryption, see [Amazon S3 bucket default encryption][1] in - # the *Amazon S3 User Guide*. For more information about S3 Bucket Keys, - # see [Amazon S3 Bucket Keys][2] in the *Amazon S3 User Guide*. + # (SSE-KMS) or dual-layer server-side encryption with Amazon Web + # Services KMS keys (DSSE-KMS). If you specify default encryption by + # using SSE-KMS, you can also configure [Amazon S3 Bucket Keys][1]. If + # you use PutBucketEncryption to set your [default bucket encryption][2] + # to SSE-KMS, you should verify that your KMS key ID is correct. Amazon + # S3 does not validate the KMS key ID provided in PutBucketEncryption + # requests. # # This action requires Amazon Web Services Signature Version 4. For more # information, see [ Authenticating Requests (Amazon Web Services @@ -10062,8 +11134,8 @@ class Aws::S3::Client < ::Seahorse::Client::Base # # # - # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html - # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html + # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html + # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html # [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html # [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources # [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html @@ -10099,9 +11171,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketEncryption AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#9917 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#12540 def put_bucket_encryption(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Puts a S3 Intelligent-Tiering configuration to the specified bucket. # You can have up to 1,000 S3 Intelligent-Tiering configurations per # bucket. @@ -10209,9 +11285,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketIntelligentTieringConfiguration AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#10038 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#12665 def put_bucket_intelligent_tiering_configuration(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # This implementation of the `PUT` action adds an inventory # configuration (identified by the inventory ID) to the bucket. You can # have up to 1,000 inventory configurations per bucket. @@ -10342,9 +11422,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketInventoryConfiguration AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#10186 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#12817 def put_bucket_inventory_configuration(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # For an updated version of this API, see # [PutBucketLifecycleConfiguration][1]. This version has been # deprecated. Existing lifecycle configurations will work. For new @@ -10460,9 +11544,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketLifecycle AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#10333 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#12968 def put_bucket_lifecycle(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Creates a new lifecycle configuration for the bucket or replaces an # existing lifecycle configuration. Keep in mind that this will # overwrite an existing lifecycle configuration, so if you want to @@ -10471,11 +11559,11 @@ class Aws::S3::Client < ::Seahorse::Client::Base # configuration, see [Managing your storage lifecycle][1]. # # Bucket lifecycle configuration now supports specifying a lifecycle - # rule using an object key name prefix, one or more object tags, or a - # combination of both. Accordingly, this section describes the latest - # API. The previous version of the API supported filtering based only on - # an object key name prefix, which is supported for backward - # compatibility. For the related API description, see + # rule using an object key name prefix, one or more object tags, object + # size, or any combination of these. Accordingly, this section describes + # the latest API. The previous version of the API supported filtering + # based only on an object key name prefix, which is supported for + # backward compatibility. For the related API description, see # [PutBucketLifecycle][2]. # # @@ -10490,7 +11578,7 @@ class Aws::S3::Client < ::Seahorse::Client::Base # # * A filter identifying a subset of objects to which the rule # applies. The filter can be based on a key name prefix, object - # tags, or a combination of both. + # tags, object size, or any combination of these. # # * A status indicating whether the rule is in effect. # @@ -10648,9 +11736,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketLifecycleConfiguration AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#10550 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#13189 def put_bucket_lifecycle_configuration(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Set the logging parameters for a bucket and to specify permissions for # who can view and modify the logging parameters. All logs are saved to # buckets in the same Amazon Web Services Region as the source bucket. @@ -10769,6 +11861,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # }, # ], # target_prefix: "TargetPrefix", # required + # target_object_key_format: { + # simple_prefix: { + # }, + # partitioned_prefix: { + # partition_date_source: "EventTime", # accepts EventTime, DeliveryTime + # }, + # }, # }, # }, # content_md5: "ContentMD5", @@ -10785,9 +11884,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketLogging AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#10722 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#13372 def put_bucket_logging(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Sets a metrics configuration (specified by the metrics configuration # ID) for the bucket. You can have up to 1,000 metrics configurations # per bucket. If you're updating an existing metrics configuration, @@ -10869,9 +11972,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketMetricsConfiguration AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#10822 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#13476 def put_bucket_metrics_configuration(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # No longer used, see the [PutBucketNotificationConfiguration][1] # operation. # @@ -10918,9 +12025,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketNotification AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#10904 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#13562 def put_bucket_notification(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Enables notifications of specified events for a bucket. For more # information about event notifications, see [Configuring Event # Notifications][1]. @@ -11079,9 +12190,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketNotificationConfiguration AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#11084 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#13746 def put_bucket_notification_configuration(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Creates or modifies `OwnershipControls` for an Amazon S3 bucket. To # use this operation, you must have the `s3:PutBucketOwnershipControls` # permission. For more information about Amazon S3 permissions, see @@ -11124,42 +12239,86 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketOwnershipControls AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#11149 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#13815 def put_bucket_ownership_controls(params = T.unsafe(nil), options = T.unsafe(nil)); end - # Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are - # using an identity other than the root user of the Amazon Web Services - # account that owns the bucket, the calling identity must have the - # `PutBucketPolicy` permissions on the specified bucket and belong to - # the bucket owner's account in order to use this operation. + # Applies an Amazon S3 bucket policy to an Amazon S3 bucket. + # + # Directory buckets - For directory buckets, you must make + # requests for this API operation to the Regional endpoint. These + # endpoints support path-style requests in the format + # `https://s3express-control.region_code.amazonaws.com/bucket-name `. + # Virtual-hosted-style requests aren't supported. For more information, + # see [Regional and Zonal endpoints][1] in the *Amazon S3 User Guide*. # - # If you don't have `PutBucketPolicy` permissions, Amazon S3 returns a - # `403 Access Denied` error. If you have the correct permissions, but - # you're not using an identity that belongs to the bucket owner's - # account, Amazon S3 returns a `405 Method Not Allowed` error. + # # - # To ensure that bucket owners don't inadvertently lock themselves out - # of their own buckets, the root principal in a bucket owner's Amazon - # Web Services account can perform the `GetBucketPolicy`, - # `PutBucketPolicy`, and `DeleteBucketPolicy` API actions, even if their - # bucket policy explicitly denies the root principal's access. Bucket - # owner root principals can only be blocked from performing these API - # actions by VPC endpoint policies and Amazon Web Services Organizations - # policies. + # Permissions # - # For more information, see [Bucket policy examples][1]. + # : If you are using an identity other than the root user of the Amazon + # Web Services account that owns the bucket, the calling identity must + # both have the `PutBucketPolicy` permissions on the specified bucket + # and belong to the bucket owner's account in order to use this + # operation. + # + # If you don't have `PutBucketPolicy` permissions, Amazon S3 returns + # a `403 Access Denied` error. If you have the correct permissions, + # but you're not using an identity that belongs to the bucket + # owner's account, Amazon S3 returns a `405 Method Not Allowed` + # error. + # + # To ensure that bucket owners don't inadvertently lock themselves + # out of their own buckets, the root principal in a bucket owner's + # Amazon Web Services account can perform the `GetBucketPolicy`, + # `PutBucketPolicy`, and `DeleteBucketPolicy` API actions, even if + # their bucket policy explicitly denies the root principal's access. + # Bucket owner root principals can only be blocked from performing + # these API actions by VPC endpoint policies and Amazon Web Services + # Organizations policies. + # + # * **General purpose bucket permissions** - The `s3:PutBucketPolicy` + # permission is required in a policy. For more information about + # general purpose buckets bucket policies, see [Using Bucket + # Policies and User Policies][2] in the *Amazon S3 User Guide*. + # + # * **Directory bucket permissions** - To grant access to this API + # operation, you must have the `s3express:PutBucketPolicy` + # permission in an IAM identity-based policy instead of a bucket + # policy. Cross-account access to this API operation isn't + # supported. This operation can only be performed by the Amazon Web + # Services account that owns the resource. For more information + # about directory bucket policies and permissions, see [Amazon Web + # Services Identity and Access Management (IAM) for S3 Express One + # Zone][3] in the *Amazon S3 User Guide*. + # + # Example bucket policies + # + # : **General purpose buckets example bucket policies** - See [Bucket + # policy examples][4] in the *Amazon S3 User Guide*. + # + # **Directory bucket example bucket policies** - See [Example bucket + # policies for S3 Express One Zone][5] in the *Amazon S3 User Guide*. + # + # HTTP Host header syntax + # + # : Directory buckets - The HTTP Host header syntax is + # `s3express-control.region.amazonaws.com`. # # The following operations are related to `PutBucketPolicy`: # - # * [CreateBucket][2] + # * [CreateBucket][6] # - # * [DeleteBucket][3] + # * [DeleteBucket][7] # # # - # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html - # [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html - # [3]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html + # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html + # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html + # [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html + # [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html + # [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html + # [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html + # [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html # # @example Example: Set bucket policy # @@ -11190,9 +12349,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketPolicy AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#11253 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#14015 def put_bucket_policy(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Creates a replication configuration or replaces an existing one. For # more information, see [Replication][1] in the *Amazon S3 User Guide*. # @@ -11200,7 +12363,9 @@ class Aws::S3::Client < ::Seahorse::Client::Base # replication configuration, you provide the name of the destination # bucket or buckets where you want Amazon S3 to replicate objects, the # IAM role that Amazon S3 can assume to replicate objects on your - # behalf, and other relevant information. + # behalf, and other relevant information. You can invoke this request + # for a specific Amazon Web Services Region by using the [ + # `aws:RequestedRegion` ][2] condition key. # # A replication configuration must include at least one rule, and can # contain a maximum of 1,000. Each rule identifies a subset of objects @@ -11217,12 +12382,12 @@ class Aws::S3::Client < ::Seahorse::Client::Base # # If you are using an earlier version of the replication configuration, # Amazon S3 handles replication of delete markers differently. For more - # information, see [Backward Compatibility][2]. + # information, see [Backward Compatibility][3]. # # # # For information about enabling versioning on a bucket, see [Using - # Versioning][3]. + # Versioning][4]. # # Handling Replication of Encrypted Objects # @@ -11232,10 +12397,10 @@ class Aws::S3::Client < ::Seahorse::Client::Base # `SourceSelectionCriteria`, `SseKmsEncryptedObjects`, `Status`, # `EncryptionConfiguration`, and `ReplicaKmsKeyID`. For information # about replication configuration, see [Replicating Objects Created - # with SSE Using KMS keys][4]. + # with SSE Using KMS keys][5]. # # For information on `PutBucketReplication` errors, see [List of - # replication-related error codes][5] + # replication-related error codes][6] # # Permissions # @@ -11246,32 +12411,33 @@ class Aws::S3::Client < ::Seahorse::Client::Base # account that created the bucket, can perform this operation. The # resource owner can also grant others permissions to perform the # operation. For more information about permissions, see [Specifying - # Permissions in a Policy][6] and [Managing Access Permissions to Your - # Amazon S3 Resources][7]. + # Permissions in a Policy][7] and [Managing Access Permissions to Your + # Amazon S3 Resources][8]. # # To perform this operation, the user or role performing the action - # must have the [iam:PassRole][8] permission. + # must have the [iam:PassRole][9] permission. # # # # The following operations are related to `PutBucketReplication`: # - # * [GetBucketReplication][9] + # * [GetBucketReplication][10] # - # * [DeleteBucketReplication][10] + # * [DeleteBucketReplication][11] # # # # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html - # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations - # [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html - # [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html - # [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList - # [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html - # [7]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html - # [8]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html - # [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html - # [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html + # [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requestedregion + # [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations + # [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html + # [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html + # [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList + # [7]: https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html + # [8]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html + # [9]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html + # [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html + # [11]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html # # @example Example: Set replication configuration on a bucket # @@ -11337,7 +12503,7 @@ class Aws::S3::Client < ::Seahorse::Client::Base # destination: { # required # bucket: "BucketName", # required # account: "AccountId", - # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW + # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW, EXPRESS_ONEZONE # access_control_translation: { # owner: "Destination", # required, accepts Destination # }, @@ -11377,9 +12543,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketReplication AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#11484 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#14253 def put_bucket_replication(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Sets the request payment configuration for a bucket. By default, the # bucket owner pays for downloads from the bucket. This configuration # parameter enables the bucket owner (only) to specify that the person @@ -11429,9 +12599,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketRequestPayment AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#11577 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#14350 def put_bucket_request_payment(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Sets the tags for a bucket. # # Use tags to organize your Amazon Web Services bill to reflect your own @@ -11458,54 +12632,37 @@ class Aws::S3::Client < ::Seahorse::Client::Base # Operations][3] and [Managing Access Permissions to Your Amazon S3 # Resources][4]. # - # `PutBucketTagging` has the following special errors: + # `PutBucketTagging` has the following special errors. For more Amazon + # S3 errors see, [Error Responses][5]. # - # * Error code: `InvalidTagError` + # * `InvalidTag` - The tag provided was not a valid tag. This error can + # occur if the tag did not pass input validation. For more + # information, see [Using Cost Allocation in Amazon S3 Bucket + # Tags][2]. # - # * Description: The tag provided was not a valid tag. This error can - # occur if the tag did not pass input validation. For information - # about tag restrictions, see [User-Defined Tag Restrictions][5] and - # [Amazon Web Services-Generated Cost Allocation Tag - # Restrictions][6]. + # * `MalformedXML` - The XML provided does not match the schema. # - # ^ - # - # * Error code: `MalformedXMLError` - # - # * Description: The XML provided does not match the schema. - # - # ^ - # - # * Error code: `OperationAbortedError ` - # - # * Description: A conflicting conditional action is currently in - # progress against this resource. Please try again. - # - # ^ - # - # * Error code: `InternalError` + # * `OperationAborted` - A conflicting conditional action is currently + # in progress against this resource. Please try again. # - # * Description: The service was unable to apply the provided tag to - # the bucket. - # - # ^ + # * `InternalError` - The service was unable to apply the provided tag + # to the bucket. # # The following operations are related to `PutBucketTagging`: # - # * [GetBucketTagging][7] + # * [GetBucketTagging][6] # - # * [DeleteBucketTagging][8] + # * [DeleteBucketTagging][7] # # # # [1]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html - # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/CostAllocTagging.html + # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/CostAllocTagging.html # [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources # [4]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html - # [5]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html - # [6]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html - # [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html - # [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html + # [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html + # [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html + # [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html # # @example Example: Set tags on a bucket # @@ -11552,9 +12709,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketTagging AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#11741 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#14501 def put_bucket_tagging(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Sets the versioning state of an existing bucket. # # You can set the versioning state with one of the following values: @@ -11634,9 +12795,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketVersioning AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#11868 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#14632 def put_bucket_versioning(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Sets the configuration of the website that is specified in the # `website` subresource. To configure a bucket as a website, you can add # this subresource on the bucket with website configuration information @@ -11705,6 +12870,8 @@ class Aws::S3::Client < ::Seahorse::Client::Base # object redirect. For more information, see [Configuring an Object # Redirect][2] in the *Amazon S3 User Guide*. # + # The maximum request length is limited to 128 KB. + # # # # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html @@ -11771,120 +12938,123 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketWebsite AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#12046 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#14816 def put_bucket_website(params = T.unsafe(nil), options = T.unsafe(nil)); end - # Adds an object to a bucket. You must have WRITE permissions on a - # bucket to add an object to it. + # Adds an object to a bucket. + # + # * Amazon S3 never adds partial objects; if you receive a success + # response, Amazon S3 added the entire object to the bucket. You + # cannot use `PutObject` to only update a single piece of metadata for + # an existing object. You must put the entire object with updated + # metadata if you want to update some values. # - # Amazon S3 never adds partial objects; if you receive a success - # response, Amazon S3 added the entire object to the bucket. You cannot - # use `PutObject` to only update a single piece of metadata for an - # existing object. You must put the entire object with updated metadata - # if you want to update some values. + # * If your bucket uses the bucket owner enforced setting for Object + # Ownership, ACLs are disabled and no longer affect permissions. All + # objects written to the bucket by any account will be owned by the + # bucket owner. + # + # * **Directory buckets** - For directory buckets, you must make + # requests for this API operation to the Zonal endpoint. These + # endpoints support virtual-hosted-style requests in the format + # `https://bucket_name.s3express-az_id.region.amazonaws.com/key-name + # `. Path-style requests are not supported. For more information, see + # [Regional and Zonal endpoints][1] in the *Amazon S3 User Guide*. # # # # Amazon S3 is a distributed system. If it receives multiple write # requests for the same object simultaneously, it overwrites all but the - # last object written. To prevent objects from being deleted or - # overwritten, you can use [Amazon S3 Object Lock][1]. - # - # To ensure that data is not corrupted traversing the network, use the - # `Content-MD5` header. When you use this header, Amazon S3 checks the - # object against the provided MD5 value and, if they do not match, - # returns an error. Additionally, you can calculate the MD5 while - # putting an object to Amazon S3 and compare the returned ETag to the - # calculated MD5 value. - # - # * To successfully complete the `PutObject` request, you must have the - # `s3:PutObject` in your IAM permissions. - # - # * To successfully change the objects acl of your `PutObject` request, - # you must have the `s3:PutObjectAcl` in your IAM permissions. + # last object written. However, Amazon S3 provides features that can + # modify this behavior: # - # * To successfully set the tag-set with your `PutObject` request, you - # must have the `s3:PutObjectTagging` in your IAM permissions. - # - # * The `Content-MD5` header is required for any request to upload an - # object with a retention period configured using Amazon S3 Object - # Lock. For more information about Amazon S3 Object Lock, see [Amazon - # S3 Object Lock Overview][2] in the *Amazon S3 User Guide*. + # * **S3 Object Lock** - To prevent objects from being deleted or + # overwritten, you can use [Amazon S3 Object Lock][2] in the *Amazon + # S3 User Guide*. # - # + # This functionality is not supported for directory buckets. # - # You have four mutually exclusive options to protect data using - # server-side encryption in Amazon S3, depending on how you choose to - # manage the encryption keys. Specifically, the encryption key options - # are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys - # (SSE-KMS or DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 - # encrypts data with server-side encryption by using Amazon S3 managed - # keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt - # data at rest by using server-side encryption with other key options. - # For more information, see [Using Server-Side Encryption][3]. - # - # When adding a new object, you can use headers to grant ACL-based - # permissions to individual Amazon Web Services accounts or to - # predefined groups defined by Amazon S3. These permissions are then - # added to the ACL on the object. By default, all objects are private. - # Only the owner has full access control. For more information, see - # [Access Control List (ACL) Overview][4] and [Managing ACLs Using the - # REST API][5]. - # - # If the bucket that you're uploading objects to uses the bucket owner - # enforced setting for S3 Object Ownership, ACLs are disabled and no - # longer affect permissions. Buckets that use this setting only accept - # PUT requests that don't specify an ACL or PUT requests that specify - # bucket owner full control ACLs, such as the - # `bucket-owner-full-control` canned ACL or an equivalent form of this - # ACL expressed in the XML format. PUT requests that contain other ACLs - # (for example, custom grants to certain Amazon Web Services accounts) - # fail and return a `400` error with the error code - # `AccessControlListNotSupported`. For more information, see [ - # Controlling ownership of objects and disabling ACLs][6] in the *Amazon - # S3 User Guide*. + # # - # If your bucket uses the bucket owner enforced setting for Object - # Ownership, all objects written to the bucket by any account will be - # owned by the bucket owner. + # * **S3 Versioning** - When you enable versioning for a bucket, if + # Amazon S3 receives multiple write requests for the same object + # simultaneously, it stores all versions of the objects. For each + # write request that is made to the same object, Amazon S3 + # automatically generates a unique version ID of that object being + # stored in Amazon S3. You can retrieve, replace, or delete any + # version of the object. For more information about versioning, see + # [Adding Objects to Versioning-Enabled Buckets][3] in the *Amazon S3 + # User Guide*. For information about returning the versioning state of + # a bucket, see [GetBucketVersioning][4]. # - # + # This functionality is not supported for directory buckets. # - # By default, Amazon S3 uses the STANDARD Storage Class to store newly - # created objects. The STANDARD storage class provides high durability - # and high availability. Depending on performance needs, you can specify - # a different Storage Class. Amazon S3 on Outposts only uses the - # OUTPOSTS Storage Class. For more information, see [Storage Classes][7] - # in the *Amazon S3 User Guide*. + # # - # If you enable versioning for a bucket, Amazon S3 automatically - # generates a unique version ID for the object being stored. Amazon S3 - # returns this ID in the response. When you enable versioning for a - # bucket, if Amazon S3 receives multiple write requests for the same - # object simultaneously, it stores all of the objects. For more - # information about versioning, see [Adding Objects to - # Versioning-Enabled Buckets][8]. For information about returning the - # versioning state of a bucket, see [GetBucketVersioning][9]. + # Permissions + # : * **General purpose bucket permissions** - The following permissions + # are required in your policies when your `PutObject` request + # includes specific headers. + # + # * s3:PutObject - To successfully complete + # the `PutObject` request, you must always have the `s3:PutObject` + # permission on a bucket to add an object to it. + # + # * s3:PutObjectAcl - To successfully change + # the objects ACL of your `PutObject` request, you must have the + # `s3:PutObjectAcl`. + # + # * s3:PutObjectTagging - To successfully set + # the tag-set with your `PutObject` request, you must have the + # `s3:PutObjectTagging`. + # + # * **Directory bucket permissions** - To grant access to this API + # operation on a directory bucket, we recommend that you use the [ + # `CreateSession` ][5] API operation for session-based + # authorization. Specifically, you grant the + # `s3express:CreateSession` permission to the directory bucket in a + # bucket policy or an IAM identity-based policy. Then, you make the + # `CreateSession` API call on the bucket to obtain a session token. + # With the session token in your request header, you can make API + # requests to this operation. After the session token expires, you + # make another `CreateSession` API call to generate a new session + # token for use. Amazon Web Services CLI or SDKs create session and + # refresh the session token automatically to avoid service + # interruptions when a session expires. For more information about + # authorization, see [ `CreateSession` ][5]. + # + # Data integrity with Content-MD5 + # : * **General purpose bucket** - To ensure that data is not corrupted + # traversing the network, use the `Content-MD5` header. When you use + # this header, Amazon S3 checks the object against the provided MD5 + # value and, if they do not match, Amazon S3 returns an error. + # Alternatively, when the object's ETag is its MD5 digest, you can + # calculate the MD5 while putting the object to Amazon S3 and + # compare the returned ETag to the calculated MD5 value. + # + # * **Directory bucket** - This functionality is not supported for + # directory buckets. + # + # HTTP Host header syntax + # + # : Directory buckets - The HTTP Host header syntax is ` + # Bucket_name.s3express-az_id.region.amazonaws.com`. # # For more information about related Amazon S3 APIs, see the following: # - # * [CopyObject][10] + # * [CopyObject][6] # - # * [DeleteObject][11] + # * [DeleteObject][7] # # # - # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html - # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html - # [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html - # [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html - # [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html - # [6]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html - # [7]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html - # [8]: https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html - # [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html - # [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html - # [11]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html + # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html + # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html + # [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html + # [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html + # [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html + # [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html + # [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html # # @example Example: To upload an object # @@ -11902,25 +13072,24 @@ class Aws::S3::Client < ::Seahorse::Client::Base # etag: "\"6805f2cfc46c0f04559748bb039d69ae\"", # version_id: "tpf3zF08nBplQK1XLOefGskR7mGDwcDk", # } - # @example Example: To upload object and specify user-defined metadata + # @example Example: To upload an object and specify server-side encryption and object tags # - # # The following example creates an object. The request also specifies optional metadata. If the bucket is versioning - # # enabled, S3 returns version ID in response. + # # The following example uploads an object. The request specifies the optional server-side encryption option. The request + # # also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response. # # resp = client.put_object({ # body: "filetoupload", # bucket: "examplebucket", # key: "exampleobject", - # metadata: { - # "metadata1" => "value1", - # "metadata2" => "value2", - # }, + # server_side_encryption: "AES256", + # tagging: "key1=value1&key2=value2", # }) # # resp.to_h outputs the following: # { # etag: "\"6805f2cfc46c0f04559748bb039d69ae\"", - # version_id: "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0", + # server_side_encryption: "AES256", + # version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt", # } # @example Example: To upload an object (specify optional headers) # @@ -11941,39 +13110,25 @@ class Aws::S3::Client < ::Seahorse::Client::Base # server_side_encryption: "AES256", # version_id: "CG612hodqujkf8FaaNfp8U..FIhLROcp", # } - # @example Example: To create an object. - # - # # The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response. - # - # resp = client.put_object({ - # body: "filetoupload", - # bucket: "examplebucket", - # key: "objectkey", - # }) - # - # resp.to_h outputs the following: - # { - # etag: "\"6805f2cfc46c0f04559748bb039d69ae\"", - # version_id: "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ", - # } - # @example Example: To upload an object and specify server-side encryption and object tags + # @example Example: To upload object and specify user-defined metadata # - # # The following example uploads an object. The request specifies the optional server-side encryption option. The request - # # also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response. + # # The following example creates an object. The request also specifies optional metadata. If the bucket is versioning + # # enabled, S3 returns version ID in response. # # resp = client.put_object({ # body: "filetoupload", # bucket: "examplebucket", # key: "exampleobject", - # server_side_encryption: "AES256", - # tagging: "key1=value1&key2=value2", + # metadata: { + # "metadata1" => "value1", + # "metadata2" => "value2", + # }, # }) # # resp.to_h outputs the following: # { # etag: "\"6805f2cfc46c0f04559748bb039d69ae\"", - # server_side_encryption: "AES256", - # version_id: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt", + # version_id: "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0", # } # @example Example: To upload an object and specify optional tags # @@ -12009,6 +13164,21 @@ class Aws::S3::Client < ::Seahorse::Client::Base # etag: "\"6805f2cfc46c0f04559748bb039d69ae\"", # version_id: "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr", # } + # @example Example: To create an object. + # + # # The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response. + # + # resp = client.put_object({ + # body: "filetoupload", + # bucket: "examplebucket", + # key: "objectkey", + # }) + # + # resp.to_h outputs the following: + # { + # etag: "\"6805f2cfc46c0f04559748bb039d69ae\"", + # version_id: "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ", + # } # @example Streaming a file from disk # # upload file from disk in a single request, may not exceed 5GB # File.open('/source/file/path', 'rb') do |file| @@ -12042,7 +13212,7 @@ class Aws::S3::Client < ::Seahorse::Client::Base # "MetadataKey" => "MetadataValue", # }, # server_side_encryption: "AES256", # accepts AES256, aws:kms, aws:kms:dsse - # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW + # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW, EXPRESS_ONEZONE # website_redirect_location: "WebsiteRedirectLocation", # sse_customer_algorithm: "SSECustomerAlgorithm", # sse_customer_key: "SSECustomerKey", @@ -12130,16 +13300,20 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::PutObjectOutput#request_charged #request_charged} => String # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObject AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#12699 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#15649 def put_object(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Uses the `acl` subresource to set the access control list (ACL) # permissions for a new or existing object in an S3 bucket. You must - # have `WRITE_ACP` permission to set the ACL of an object. For more + # have the `WRITE_ACP` permission to set the ACL of an object. For more # information, see [What permissions can I grant?][1] in the *Amazon S3 # User Guide*. # - # This action is not supported by Amazon S3 on Outposts. + # This functionality is not supported for Amazon S3 on Outposts. # # Depending on your application needs, you can choose to set the ACL on # an object using either the request body or the headers. For example, @@ -12373,13 +13547,17 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::PutObjectAclOutput#request_charged #request_charged} => String # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectAcl AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#13064 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#16019 def put_object_acl(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Applies a legal hold configuration to the specified object. For more # information, see [Locking Objects][1]. # - # This action is not supported by Amazon S3 on Outposts. + # This functionality is not supported for Amazon S3 on Outposts. # # # @@ -12417,9 +13595,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::PutObjectLegalHoldOutput#request_charged #request_charged} => String # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectLegalHold AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#13170 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#16138 def put_object_legal_hold(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Places an Object Lock configuration on the specified bucket. The rule # specified in the Object Lock configuration will be applied by default # to every new object placed in the specified bucket. For more @@ -12431,15 +13613,15 @@ class Aws::S3::Client < ::Seahorse::Client::Base # you must select one. You cannot specify `Days` and `Years` at the # same time. # - # * You can only enable Object Lock for new buckets. If you want to turn - # on Object Lock for an existing bucket, contact Amazon Web Services - # Support. + # * You can enable Object Lock for new or existing buckets. For more + # information, see [Configuring Object Lock][2]. # # # # # # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html + # [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-configure.html # # @example Request syntax with placeholder values # @@ -12478,16 +13660,20 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::PutObjectLockConfigurationOutput#request_charged #request_charged} => String # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectLockConfiguration AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#13279 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#16257 def put_object_lock_configuration(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Places an Object Retention configuration on an object. For more # information, see [Locking Objects][1]. Users or accounts require the # `s3:PutObjectRetention` permission in order to place an Object # Retention configuration on objects. Bypassing a Governance Retention # configuration requires the `s3:BypassGovernanceRetention` permission. # - # This action is not supported by Amazon S3 on Outposts. + # This functionality is not supported for Amazon S3 on Outposts. # # # @@ -12528,19 +13714,24 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::PutObjectRetentionOutput#request_charged #request_charged} => String # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectRetention AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#13395 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#16386 def put_object_retention(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Sets the supplied tag-set to an object that already exists in a - # bucket. + # bucket. A tag is a key-value pair. For more information, see [Object + # Tagging][1]. # - # A tag is a key-value pair. You can associate tags with an object by - # sending a PUT request against the tagging subresource that is - # associated with the object. You can retrieve tags by sending a GET - # request. For more information, see [GetObjectTagging][1]. + # You can associate tags with an object by sending a PUT request against + # the tagging subresource that is associated with the object. You can + # retrieve tags by sending a GET request. For more information, see + # [GetObjectTagging][2]. # # For tagging-related restrictions related to characters and encodings, - # see [Tag Restrictions][2]. Note that Amazon S3 limits the maximum + # see [Tag Restrictions][3]. Note that Amazon S3 limits the maximum # number of tags to 10 tags per object. # # To use this operation, you must have permission to perform the @@ -12550,43 +13741,34 @@ class Aws::S3::Client < ::Seahorse::Client::Base # To put tags of any other version, use the `versionId` query parameter. # You also need permission for the `s3:PutObjectVersionTagging` action. # - # For information about the Amazon S3 object tagging feature, see - # [Object Tagging][3]. - # - # `PutObjectTagging` has the following special errors: - # - # * * Code: InvalidTagError + # `PutObjectTagging` has the following special errors. For more Amazon + # S3 errors see, [Error Responses][4]. # - # * *Cause: The tag provided was not a valid tag. This error can occur - # if the tag did not pass input validation. For more information, - # see [Object Tagging][3].* + # * `InvalidTag` - The tag provided was not a valid tag. This error can + # occur if the tag did not pass input validation. For more + # information, see [Object Tagging][1]. # - # * * Code: MalformedXMLError + # * `MalformedXML` - The XML provided does not match the schema. # - # * *Cause: The XML provided does not match the schema.* + # * `OperationAborted` - A conflicting conditional action is currently + # in progress against this resource. Please try again. # - # * * Code: OperationAbortedError - # - # * *Cause: A conflicting conditional action is currently in progress - # against this resource. Please try again.* - # - # * * *Code: InternalError* - # - # * *Cause: The service was unable to apply the provided tag to the - # object.* + # * `InternalError` - The service was unable to apply the provided tag + # to the object. # # The following operations are related to `PutObjectTagging`: # - # * [GetObjectTagging][1] + # * [GetObjectTagging][2] # - # * [DeleteObjectTagging][4] + # * [DeleteObjectTagging][5] # # # - # [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html - # [2]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html - # [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html - # [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html + # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-tagging.html + # [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html + # [3]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html + # [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html + # [5]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html # # @example Example: To add tags to an existing object # @@ -12650,9 +13832,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::PutObjectTaggingOutput#version_id #version_id} => String # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectTagging AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#13589 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#16585 def put_object_tagging(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Creates or modifies the `PublicAccessBlock` configuration for an # Amazon S3 bucket. To use this operation, you must have the # `s3:PutBucketPublicAccessBlock` permission. For more information about @@ -12712,19 +13898,23 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutPublicAccessBlock AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#13693 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#16693 def put_public_access_block(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # Restores an archived copy of an object back into Amazon S3 # - # This action is not supported by Amazon S3 on Outposts. + # This functionality is not supported for Amazon S3 on Outposts. # # This action performs the following types of requests: # - # * `select` - Perform a select query on an archived object - # # * `restore an archive` - Restore an archived object # + # ^ + # # For more information about the `S3` structure in the request body, see # the following: # @@ -12735,51 +13925,6 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * [Protecting Data Using Server-Side Encryption][3] in the *Amazon S3 # User Guide* # - # Define the SQL expression for the `SELECT` type of restoration for - # your query in the request body's `SelectParameters` structure. You - # can use expressions like the following examples. - # - # * The following expression returns all records from the specified - # object. - # - # `SELECT * FROM Object` - # - # * Assuming that you are not using any headers for data stored in the - # object, you can specify columns with positional headers. - # - # `SELECT s._1, s._2 FROM Object s WHERE s._3 > 100` - # - # * If you have headers and you set the `fileHeaderInfo` in the `CSV` - # structure in the request body to `USE`, you can specify headers in - # the query. (If you set the `fileHeaderInfo` field to `IGNORE`, the - # first row is skipped for the query.) You cannot mix ordinal - # positions with header column names. - # - # `SELECT s.Id, s.FirstName, s.SSN FROM S3Object s` - # - # When making a select request, you can also do the following: - # - # * To expedite your queries, specify the `Expedited` tier. For more - # information about tiers, see "Restoring Archives," later in this - # topic. - # - # * Specify details about the data serialization format of both the - # input object that is being queried and the serialization of the - # CSV-encoded query results. - # - # The following are additional important facts about the select feature: - # - # * The output results are new Amazon S3 objects. Unlike archive - # retrievals, they are stored until explicitly deleted-manually or - # through a lifecycle configuration. - # - # * You can issue more than one select request on the same Amazon S3 - # object. Amazon S3 doesn't duplicate requests, so avoid issuing - # duplicate requests. - # - # * Amazon S3 accepts a select request even if the object has already - # been restored. A select request doesn’t return error response `409`. - # # Permissions # # : To use this operation, you must have permissions to perform the @@ -12897,8 +14042,7 @@ class Aws::S3::Client < ::Seahorse::Client::Base # # * *Code: RestoreAlreadyInProgress* # - # * *Cause: Object restore is already in progress. (This error does - # not apply to SELECT type requests.)* + # * *Cause: Object restore is already in progress.* # # * *HTTP Status Code: 409 Conflict* # @@ -13037,7 +14181,7 @@ class Aws::S3::Client < ::Seahorse::Client::Base # value: "MetadataValue", # }, # ], - # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW + # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW, EXPRESS_ONEZONE # }, # }, # }, @@ -13064,9 +14208,13 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::RestoreObjectOutput#restore_output_path #restore_output_path} => String # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/RestoreObject AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#14111 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#17078 def restore_object(params = T.unsafe(nil), options = T.unsafe(nil)); end + # This operation is not supported by directory buckets. + # + # + # # This action filters the contents of an Amazon S3 object based on a # simple structured query language (SQL) statement. In the request, # along with the SQL expression, you must also specify a data @@ -13075,7 +14223,7 @@ class Aws::S3::Client < ::Seahorse::Client::Base # returns only records that match the specified SQL expression. You must # also specify the data serialization format for the response. # - # This action is not supported by Amazon S3 on Outposts. + # This functionality is not supported for Amazon S3 on Outposts. # # For more information about Amazon S3 Select, see [Selecting Content # from Objects][1] and [SELECT Command][2] in the *Amazon S3 User @@ -13085,10 +14233,10 @@ class Aws::S3::Client < ::Seahorse::Client::Base # # Permissions # - # : You must have `s3:GetObject` permission for this operation. Amazon - # S3 Select does not support anonymous access. For more information - # about permissions, see [Specifying Permissions in a Policy][3] in - # the *Amazon S3 User Guide*. + # : You must have the `s3:GetObject` permission for this + # operation. Amazon S3 Select does not support anonymous access. For + # more information about permissions, see [Specifying Permissions in a + # Policy][3] in the *Amazon S3 User Guide*. # # Object Data Formats # @@ -13181,22 +14329,22 @@ class Aws::S3::Client < ::Seahorse::Client::Base # # @example EventStream Operation Example # - # You can process event once it arrives immediately, or wait until - # full response complete and iterate through eventstream enumerator. + # You can process the event once it arrives immediately, or wait until the + # full response is complete and iterate through the eventstream enumerator. # # To interact with event immediately, you need to register #select_object_content - # with callbacks, callbacks can be register for specifc events or for all events, - # callback for errors in the event stream is also available for register. + # with callbacks. Callbacks can be registered for specific events or for all + # events, including error events. # - # Callbacks can be passed in by `:event_stream_handler` option or within block - # statement attached to #select_object_content call directly. Hybrid pattern of both - # is also supported. + # Callbacks can be passed into the `:event_stream_handler` option or within a + # block statement attached to the #select_object_content call directly. Hybrid + # pattern of both is also supported. # - # `:event_stream_handler` option takes in either Proc object or + # `:event_stream_handler` option takes in either a Proc object or # Aws::S3::EventStreams::SelectObjectContentEventStream object. # - # Usage pattern a): callbacks with a block attached to #select_object_content - # Example for registering callbacks for all event types and error event + # Usage pattern a): Callbacks with a block attached to #select_object_content + # Example for registering callbacks for all event types and an error event # # client.select_object_content( # params input# ) do |stream| # stream.on_error_event do |event| @@ -13216,9 +14364,9 @@ class Aws::S3::Client < ::Seahorse::Client::Base # # end # - # Usage pattern b): pass in `:event_stream_handler` for #select_object_content + # Usage pattern b): Pass in `:event_stream_handler` for #select_object_content # - # 1) create a Aws::S3::EventStreams::SelectObjectContentEventStream object + # 1) Create a Aws::S3::EventStreams::SelectObjectContentEventStream object # Example for registering callbacks with specific events # # handler = Aws::S3::EventStreams::SelectObjectContentEventStream.new @@ -13240,7 +14388,7 @@ class Aws::S3::Client < ::Seahorse::Client::Base # # client.select_object_content( # params input #, event_stream_handler: handler) # - # 2) use a Ruby Proc object + # 2) Use a Ruby Proc object # Example for registering callbacks with specific events # # handler = Proc.new do |stream| @@ -13263,7 +14411,7 @@ class Aws::S3::Client < ::Seahorse::Client::Base # # client.select_object_content( # params input #, event_stream_handler: handler) # - # Usage pattern c): hybird pattern of a) and b) + # Usage pattern c): Hybrid pattern of a) and b) # # handler = Aws::S3::EventStreams::SelectObjectContentEventStream.new # handler.on_records_event do |event| @@ -13293,8 +14441,7 @@ class Aws::S3::Client < ::Seahorse::Client::Base # end # end # - # Besides above usage patterns for process events when they arrive immediately, you can also - # iterate through events after response complete. + # You can also iterate through events after the response complete. # # Events are available at resp.payload # => Enumerator # For parameter input example, please refer to following request syntax @@ -13389,21 +14536,22 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/SelectObjectContent AWS API Documentation # @yield [event_stream_handler] # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#14505 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#17475 def select_object_content(params = T.unsafe(nil), options = T.unsafe(nil), &block); end # Uploads a part in a multipart upload. # - # In this operation, you provide part data in your request. However, you - # have an option to specify your existing Amazon S3 object as a data - # source for the part you are uploading. To upload a part from an - # existing object, you use the [UploadPartCopy][1] operation. + # In this operation, you provide new data as a part of an object in your + # request. However, you have an option to specify your existing Amazon + # S3 object as a data source for the part you are uploading. To upload a + # part from an existing object, you use the [UploadPartCopy][1] + # operation. # # # # You must initiate a multipart upload (see [CreateMultipartUpload][2]) # before you can upload any part. In response to your initiate request, - # Amazon S3 returns an upload ID, a unique identifier, that you must + # Amazon S3 returns an upload ID, a unique identifier that you must # include in your upload part request. # # Part numbers can be any number from 1 to 10,000, inclusive. A part @@ -13416,103 +14564,148 @@ class Aws::S3::Client < ::Seahorse::Client::Base # multipart upload specifications, see [Multipart upload limits][3] in # the *Amazon S3 User Guide*. # - # To ensure that data is not corrupted when traversing the network, - # specify the `Content-MD5` header in the upload part request. Amazon S3 - # checks the part data against the provided MD5 value. If they do not - # match, Amazon S3 returns an error. - # - # If the upload request is signed with Signature Version 4, then Amazon - # Web Services S3 uses the `x-amz-content-sha256` header as a checksum - # instead of `Content-MD5`. For more information see [Authenticating - # Requests: Using the Authorization Header (Amazon Web Services - # Signature Version 4)][4]. - # - # **Note:** After you initiate multipart upload and upload one or more - # parts, you must either complete or abort multipart upload in order to - # stop getting charged for storage of the uploaded parts. Only after you + # After you initiate multipart upload and upload one or more parts, you + # must either complete or abort multipart upload in order to stop + # getting charged for storage of the uploaded parts. Only after you # either complete or abort multipart upload, Amazon S3 frees up the # parts storage and stops charging you for the parts storage. # + # + # # For more information on multipart uploads, go to [Multipart Upload - # Overview][5] in the Amazon S3 User Guide . + # Overview][4] in the Amazon S3 User Guide . # - # For information on the permissions required to use the multipart - # upload API, go to [Multipart Upload and Permissions][6] in the *Amazon - # S3 User Guide*. + # **Directory buckets** - For directory buckets, you must make requests + # for this API operation to the Zonal endpoint. These endpoints support + # virtual-hosted-style requests in the format + # `https://bucket_name.s3express-az_id.region.amazonaws.com/key-name `. + # Path-style requests are not supported. For more information, see + # [Regional and Zonal endpoints][5] in the *Amazon S3 User Guide*. # - # Server-side encryption is for data encryption at rest. Amazon S3 - # encrypts your data as it writes it to disks in its data centers and - # decrypts it when you access it. You have three mutually exclusive - # options to protect data using server-side encryption in Amazon S3, - # depending on how you choose to manage the encryption keys. - # Specifically, the encryption key options are Amazon S3 managed keys - # (SSE-S3), Amazon Web Services KMS keys (SSE-KMS), and - # Customer-Provided Keys (SSE-C). Amazon S3 encrypts data with - # server-side encryption using Amazon S3 managed keys (SSE-S3) by - # default. You can optionally tell Amazon S3 to encrypt data at rest - # using server-side encryption with other key options. The option you - # use depends on whether you want to use KMS keys (SSE-KMS) or provide - # your own encryption key (SSE-C). If you choose to provide your own - # encryption key, the request headers you provide in the request must - # match the headers you used in the request to initiate the upload by - # using [CreateMultipartUpload][2]. For more information, go to [Using - # Server-Side Encryption][7] in the *Amazon S3 User Guide*. + # # - # Server-side encryption is supported by the S3 Multipart Upload - # actions. Unless you are using a customer-provided encryption key - # (SSE-C), you don't need to specify the encryption parameters in each - # UploadPart request. Instead, you only need to specify the server-side - # encryption parameters in the initial Initiate Multipart request. For - # more information, see [CreateMultipartUpload][2]. + # Permissions + # : * **General purpose bucket permissions** - For information on the + # permissions required to use the multipart upload API, see + # [Multipart Upload and Permissions][6] in the *Amazon S3 User + # Guide*. # - # If you requested server-side encryption using a customer-provided - # encryption key (SSE-C) in your initiate multipart upload request, you - # must provide identical encryption information in each part upload - # using the following headers. + # * **Directory bucket permissions** - To grant access to this API + # operation on a directory bucket, we recommend that you use the [ + # `CreateSession` ][7] API operation for session-based + # authorization. Specifically, you grant the + # `s3express:CreateSession` permission to the directory bucket in a + # bucket policy or an IAM identity-based policy. Then, you make the + # `CreateSession` API call on the bucket to obtain a session token. + # With the session token in your request header, you can make API + # requests to this operation. After the session token expires, you + # make another `CreateSession` API call to generate a new session + # token for use. Amazon Web Services CLI or SDKs create session and + # refresh the session token automatically to avoid service + # interruptions when a session expires. For more information about + # authorization, see [ `CreateSession` ][7]. + # + # Data integrity + # + # : **General purpose bucket** - To ensure that data is not corrupted + # traversing the network, specify the `Content-MD5` header in the + # upload part request. Amazon S3 checks the part data against the + # provided MD5 value. If they do not match, Amazon S3 returns an + # error. If the upload request is signed with Signature Version 4, + # then Amazon Web Services S3 uses the `x-amz-content-sha256` header + # as a checksum instead of `Content-MD5`. For more information see + # [Authenticating Requests: Using the Authorization Header (Amazon Web + # Services Signature Version 4)][8]. + # + # **Directory buckets** - MD5 is not supported by directory buckets. + # You can use checksum algorithms to check object integrity. # - # * x-amz-server-side-encryption-customer-algorithm + # # - # * x-amz-server-side-encryption-customer-key + # Encryption + # : * **General purpose bucket** - Server-side encryption is for data + # encryption at rest. Amazon S3 encrypts your data as it writes it + # to disks in its data centers and decrypts it when you access it. + # You have mutually exclusive options to protect data using + # server-side encryption in Amazon S3, depending on how you choose + # to manage the encryption keys. Specifically, the encryption key + # options are Amazon S3 managed keys (SSE-S3), Amazon Web Services + # KMS keys (SSE-KMS), and Customer-Provided Keys (SSE-C). Amazon S3 + # encrypts data with server-side encryption using Amazon S3 managed + # keys (SSE-S3) by default. You can optionally tell Amazon S3 to + # encrypt data at rest using server-side encryption with other key + # options. The option you use depends on whether you want to use KMS + # keys (SSE-KMS) or provide your own encryption key (SSE-C). + # + # Server-side encryption is supported by the S3 Multipart Upload + # operations. Unless you are using a customer-provided encryption + # key (SSE-C), you don't need to specify the encryption parameters + # in each UploadPart request. Instead, you only need to specify the + # server-side encryption parameters in the initial Initiate + # Multipart request. For more information, see + # [CreateMultipartUpload][2]. + # + # If you request server-side encryption using a customer-provided + # encryption key (SSE-C) in your initiate multipart upload request, + # you must provide identical encryption information in each part + # upload using the following request headers. + # + # * x-amz-server-side-encryption-customer-algorithm + # + # * x-amz-server-side-encryption-customer-key + # + # * x-amz-server-side-encryption-customer-key-MD5 + # + # * **Directory bucket** - For directory buckets, only server-side + # encryption with Amazon S3 managed keys (SSE-S3) (`AES256`) is + # supported. + # + # For more information, see [Using Server-Side Encryption][9] in the + # *Amazon S3 User Guide*. # - # * x-amz-server-side-encryption-customer-key-MD5 + # Special errors + # : * Error Code: `NoSuchUpload` # - # `UploadPart` has the following special errors: + # * Description: The specified multipart upload does not exist. The + # upload ID might be invalid, or the multipart upload might have + # been aborted or completed. # - # * * *Code: NoSuchUpload* + # * HTTP Status Code: 404 Not Found # - # * *Cause: The specified multipart upload does not exist. The upload - # ID might be invalid, or the multipart upload might have been - # aborted or completed.* + # * SOAP Fault Code Prefix: Client # - # * HTTP Status Code: 404 Not Found + # HTTP Host header syntax # - # * *SOAP Fault Code Prefix: Client* + # : Directory buckets - The HTTP Host header syntax is ` + # Bucket_name.s3express-az_id.region.amazonaws.com`. # # The following operations are related to `UploadPart`: # # * [CreateMultipartUpload][2] # - # * [CompleteMultipartUpload][8] + # * [CompleteMultipartUpload][10] # - # * [AbortMultipartUpload][9] + # * [AbortMultipartUpload][11] # - # * [ListParts][10] + # * [ListParts][12] # - # * [ListMultipartUploads][11] + # * [ListMultipartUploads][13] # # # # [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html # [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html # [3]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html - # [4]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-auth-using-authorization-header.html - # [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html + # [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html + # [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html # [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html - # [7]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html - # [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html - # [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html - # [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html - # [11]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html + # [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html + # [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-auth-using-authorization-header.html + # [9]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html + # [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html + # [11]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html + # [12]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html + # [13]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html # # @example Example: To upload a part # @@ -13599,176 +14792,204 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::UploadPartOutput#request_charged #request_charged} => String # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/UploadPart AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#14868 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#17925 def upload_part(params = T.unsafe(nil), options = T.unsafe(nil)); end # Uploads a part by copying data from an existing object as data source. - # You specify the data source by adding the request header - # `x-amz-copy-source` in your request and a byte range by adding the - # request header `x-amz-copy-source-range` in your request. + # To specify the data source, you add the request header + # `x-amz-copy-source` in your request. To specify a byte range, you add + # the request header `x-amz-copy-source-range` in your request. # # For information about maximum and minimum part sizes and other # multipart upload specifications, see [Multipart upload limits][1] in # the *Amazon S3 User Guide*. # - # Instead of using an existing object as part data, you might use the - # [UploadPart][2] action and provide data in your request. + # Instead of copying data from an existing object as part data, you + # might use the [UploadPart][2] action to upload new data as a part of + # an object in your request. # # # # You must initiate a multipart upload before you can upload any part. - # In response to your initiate request. Amazon S3 returns a unique - # identifier, the upload ID, that you must include in your upload part - # request. - # - # For more information about using the `UploadPartCopy` operation, see - # the following: - # - # * For conceptual information about multipart uploads, see [Uploading - # Objects Using Multipart Upload][3] in the *Amazon S3 User Guide*. - # - # * For information about permissions required to use the multipart - # upload API, see [Multipart Upload and Permissions][4] in the *Amazon - # S3 User Guide*. - # - # * For information about copying objects using a single atomic action - # vs. a multipart upload, see [Operations on Objects][5] in the - # *Amazon S3 User Guide*. - # - # * For information about using server-side encryption with - # customer-provided encryption keys with the `UploadPartCopy` - # operation, see [CopyObject][6] and [UploadPart][2]. - # - # Note the following additional considerations about the request headers - # `x-amz-copy-source-if-match`, `x-amz-copy-source-if-none-match`, - # `x-amz-copy-source-if-unmodified-since`, and - # `x-amz-copy-source-if-modified-since`: - # - # - # - # * **Consideration 1** - If both of the `x-amz-copy-source-if-match` - # and `x-amz-copy-source-if-unmodified-since` headers are present in - # the request as follows: + # In response to your initiate request, Amazon S3 returns the upload ID, + # a unique identifier that you must include in your upload part request. # - # `x-amz-copy-source-if-match` condition evaluates to `true`, and; - # - # `x-amz-copy-source-if-unmodified-since` condition evaluates to - # `false`; - # - # Amazon S3 returns `200 OK` and copies the data. + # For conceptual information about multipart uploads, see [Uploading + # Objects Using Multipart Upload][3] in the *Amazon S3 User Guide*. For + # information about copying objects using a single atomic action vs. a + # multipart upload, see [Operations on Objects][4] in the *Amazon S3 + # User Guide*. # - # * **Consideration 2** - If both of the - # `x-amz-copy-source-if-none-match` and - # `x-amz-copy-source-if-modified-since` headers are present in the - # request as follows: + # **Directory buckets** - For directory buckets, you must make requests + # for this API operation to the Zonal endpoint. These endpoints support + # virtual-hosted-style requests in the format + # `https://bucket_name.s3express-az_id.region.amazonaws.com/key-name `. + # Path-style requests are not supported. For more information, see + # [Regional and Zonal endpoints][5] in the *Amazon S3 User Guide*. # - # `x-amz-copy-source-if-none-match` condition evaluates to `false`, - # and; + # # - # `x-amz-copy-source-if-modified-since` condition evaluates to `true`; + # Authentication and authorization # - # Amazon S3 returns `412 Precondition Failed` response code. + # : All `UploadPartCopy` requests must be authenticated and signed by + # using IAM credentials (access key ID and secret access key for the + # IAM identities). All headers with the `x-amz-` prefix, including + # `x-amz-copy-source`, must be signed. For more information, see [REST + # Authentication][6]. # - # Versioning + # **Directory buckets** - You must use IAM credentials to authenticate + # and authorize your access to the `UploadPartCopy` API operation, + # instead of using the temporary security credentials through the + # `CreateSession` API operation. # - # : If your bucket has versioning enabled, you could have multiple - # versions of the same object. By default, `x-amz-copy-source` - # identifies the current version of the object to copy. If the current - # version is a delete marker and you don't specify a versionId in the - # `x-amz-copy-source`, Amazon S3 returns a 404 error, because the - # object does not exist. If you specify versionId in the - # `x-amz-copy-source` and the versionId is a delete marker, Amazon S3 - # returns an HTTP 400 error, because you are not allowed to specify a - # delete marker as a version for the `x-amz-copy-source`. + # Amazon Web Services CLI or SDKs handles authentication and + # authorization on your behalf. # - # You can optionally specify a specific version of the source object - # to copy by adding the `versionId` subresource as shown in the - # following example: + # Permissions # - # `x-amz-copy-source: /bucket/object?versionId=version id` + # : You must have `READ` access to the source object and `WRITE` access + # to the destination bucket. + # + # * **General purpose bucket permissions** - You must have the + # permissions in a policy based on the bucket types of your source + # bucket and destination bucket in an `UploadPartCopy` operation. + # + # * If the source object is in a general purpose bucket, you must + # have the s3:GetObject permission to read + # the source object that is being copied. + # + # * If the destination bucket is a general purpose bucket, you must + # have the s3:PutObject permission to write + # the object copy to the destination bucket. + # + # For information about permissions required to use the multipart + # upload API, see [Multipart upload API and permissions][7] in the + # *Amazon S3 User Guide*. + # + # * **Directory bucket permissions** - You must have permissions in a + # bucket policy or an IAM identity-based policy based on the source + # and destination bucket types in an `UploadPartCopy` operation. + # + # * If the source object that you want to copy is in a directory + # bucket, you must have the + # s3express:CreateSession permission in the + # `Action` element of a policy to read the object. By default, the + # session is in the `ReadWrite` mode. If you want to restrict the + # access, you can explicitly set the `s3express:SessionMode` + # condition key to `ReadOnly` on the copy source bucket. + # + # * If the copy destination is a directory bucket, you must have the + # s3express:CreateSession permission in the + # `Action` element of a policy to write the object to the + # destination. The `s3express:SessionMode` condition key cannot be + # set to `ReadOnly` on the copy destination. + # + # For example policies, see [Example bucket policies for S3 Express + # One Zone][8] and [Amazon Web Services Identity and Access + # Management (IAM) identity-based policies for S3 Express One + # Zone][9] in the *Amazon S3 User Guide*. + # + # Encryption + # : * General purpose buckets - For information about using + # server-side encryption with customer-provided encryption keys with + # the `UploadPartCopy` operation, see [CopyObject][10] and + # [UploadPart][2]. + # + # * Directory buckets - For directory buckets, only + # server-side encryption with Amazon S3 managed keys (SSE-S3) + # (`AES256`) is supported. # # Special errors - # : * * *Code: NoSuchUpload* + # : * Error Code: `NoSuchUpload` # - # * *Cause: The specified multipart upload does not exist. The + # * Description: The specified multipart upload does not exist. The # upload ID might be invalid, or the multipart upload might have - # been aborted or completed.* + # been aborted or completed. + # + # * HTTP Status Code: 404 Not Found + # + # * Error Code: `InvalidRequest` # - # * *HTTP Status Code: 404 Not Found* + # * Description: The specified copy source is not supported as a + # byte-range copy source. # - # * * *Code: InvalidRequest* + # * HTTP Status Code: 400 Bad Request # - # * *Cause: The specified copy source is not supported as a - # byte-range copy source.* + # HTTP Host header syntax # - # * *HTTP Status Code: 400 Bad Request* + # : Directory buckets - The HTTP Host header syntax is ` + # Bucket_name.s3express-az_id.region.amazonaws.com`. # # The following operations are related to `UploadPartCopy`: # - # * [CreateMultipartUpload][7] + # * [CreateMultipartUpload][11] # # * [UploadPart][2] # - # * [CompleteMultipartUpload][8] + # * [CompleteMultipartUpload][12] # - # * [AbortMultipartUpload][9] + # * [AbortMultipartUpload][13] # - # * [ListParts][10] + # * [ListParts][14] # - # * [ListMultipartUploads][11] + # * [ListMultipartUploads][15] # # # # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html # [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html # [3]: https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html - # [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html - # [5]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectOperations.html - # [6]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html - # [7]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html - # [8]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html - # [9]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html - # [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html - # [11]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html + # [4]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectOperations.html + # [5]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-Regions-and-Zones.html + # [6]: https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html + # [7]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions + # [8]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-example-bucket-policies.html + # [9]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam-identity-policies.html + # [10]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html + # [11]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html + # [12]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html + # [13]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html + # [14]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html + # [15]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html # - # @example Example: To upload a part by copying byte range from an existing object as data source + # @example Example: To upload a part by copying data from an existing object as data source # - # # The following example uploads a part of a multipart upload by copying a specified byte range from an existing object as - # # data source. + # # The following example uploads a part of a multipart upload by copying data from an existing object as data source. # # resp = client.upload_part_copy({ # bucket: "examplebucket", # copy_source: "/bucketname/sourceobjectkey", - # copy_source_range: "bytes=1-100000", # key: "examplelargeobject", - # part_number: 2, + # part_number: 1, # upload_id: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--", # }) # # resp.to_h outputs the following: # { # copy_part_result: { - # etag: "\"65d16d19e65a7508a51f043180edcc36\"", - # last_modified: Time.parse("2016-12-29T21:44:28.000Z"), + # etag: "\"b0c6f0e7e054ab8fa2536a2677f8734d\"", + # last_modified: Time.parse("2016-12-29T21:24:43.000Z"), # }, # } - # @example Example: To upload a part by copying data from an existing object as data source + # @example Example: To upload a part by copying byte range from an existing object as data source # - # # The following example uploads a part of a multipart upload by copying data from an existing object as data source. + # # The following example uploads a part of a multipart upload by copying a specified byte range from an existing object as + # # data source. # # resp = client.upload_part_copy({ # bucket: "examplebucket", # copy_source: "/bucketname/sourceobjectkey", + # copy_source_range: "bytes=1-100000", # key: "examplelargeobject", - # part_number: 1, + # part_number: 2, # upload_id: "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--", # }) # # resp.to_h outputs the following: # { # copy_part_result: { - # etag: "\"b0c6f0e7e054ab8fa2536a2677f8734d\"", - # last_modified: Time.parse("2016-12-29T21:24:43.000Z"), + # etag: "\"65d16d19e65a7508a51f043180edcc36\"", + # last_modified: Time.parse("2016-12-29T21:44:28.000Z"), # }, # } # @example Request syntax with placeholder values @@ -13842,7 +15063,7 @@ class Aws::S3::Client < ::Seahorse::Client::Base # * {Types::UploadPartCopyOutput#request_charged #request_charged} => String # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/UploadPartCopy AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#15256 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#18457 def upload_part_copy(params = T.unsafe(nil), options = T.unsafe(nil)); end # Polls an API operation until a resource enters a desired state. @@ -13934,15 +15155,19 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Boolean] Returns `true` if the waiter was successful. # @yield [w.waiter] # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#15751 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#18961 def wait_until(waiter_name, params = T.unsafe(nil), options = T.unsafe(nil)); end # @api private # @deprecated # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#15759 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#18969 def waiter_names; end + # This operation is not supported by directory buckets. + # + # + # # Passes transformed objects to a `GetObject` operation when using # Object Lambda access points. For information about Object Lambda # access points, see [Transforming objects with Object Lambda access @@ -14034,14 +15259,14 @@ class Aws::S3::Client < ::Seahorse::Client::Base # object_lock_legal_hold_status: "ON", # accepts ON, OFF # object_lock_retain_until_date: Time.now, # parts_count: 1, - # replication_status: "COMPLETE", # accepts COMPLETE, PENDING, FAILED, REPLICA + # replication_status: "COMPLETE", # accepts COMPLETE, PENDING, FAILED, REPLICA, COMPLETED # request_charged: "requester", # accepts requester # restore: "Restore", # server_side_encryption: "AES256", # accepts AES256, aws:kms, aws:kms:dsse # sse_customer_algorithm: "SSECustomerAlgorithm", # ssekms_key_id: "SSEKMSKeyId", # sse_customer_key_md5: "SSECustomerKeyMD5", - # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW + # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW, EXPRESS_ONEZONE # tag_count: 1, # version_id: "ObjectVersionId", # bucket_key_enabled: false, @@ -14091,7 +15316,7 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/WriteGetObjectResponse AWS API Documentation # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#15638 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#18848 def write_get_object_response(params = T.unsafe(nil), options = T.unsafe(nil)); end private @@ -14099,21 +15324,21 @@ class Aws::S3::Client < ::Seahorse::Client::Base # @param waiter_name [Symbol] # @param options [Hash] ({}) # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#15767 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#18977 def waiter(waiter_name, options = T.unsafe(nil)); end - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#15776 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#18986 def waiters; end class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#15791 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#19001 def errors_module; end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#15788 + # source://aws-sdk-s3//lib/aws-sdk-s3/client.rb#18998 def identifier; end end end @@ -14127,7 +15352,7 @@ end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#2685 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#2763 Aws::S3::ClientApi::API = T.let(T.unsafe(nil), Seahorse::Model::Api) # @api private @@ -14178,2856 +15403,2981 @@ Aws::S3::ClientApi::AccessControlTranslation = T.let(T.unsafe(nil), Seahorse::Mo # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#25 -Aws::S3::ClientApi::AccessPointArn = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::AccessKeyIdValue = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#26 -Aws::S3::ClientApi::AccountId = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::AccessPointAlias = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#27 -Aws::S3::ClientApi::AllowQuotedRecordDelimiter = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) +Aws::S3::ClientApi::AccessPointArn = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#28 -Aws::S3::ClientApi::AllowedHeader = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::AccountId = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#29 -Aws::S3::ClientApi::AllowedHeaders = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::AllowQuotedRecordDelimiter = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#30 -Aws::S3::ClientApi::AllowedMethod = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::AllowedHeader = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#31 -Aws::S3::ClientApi::AllowedMethods = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::AllowedHeaders = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#32 -Aws::S3::ClientApi::AllowedOrigin = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::AllowedMethod = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#33 -Aws::S3::ClientApi::AllowedOrigins = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::AllowedMethods = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#34 -Aws::S3::ClientApi::AnalyticsAndOperator = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::AllowedOrigin = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#35 -Aws::S3::ClientApi::AnalyticsConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::AllowedOrigins = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#36 -Aws::S3::ClientApi::AnalyticsConfigurationList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::AnalyticsAndOperator = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#37 -Aws::S3::ClientApi::AnalyticsExportDestination = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::AnalyticsConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#38 -Aws::S3::ClientApi::AnalyticsFilter = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::AnalyticsConfigurationList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#39 -Aws::S3::ClientApi::AnalyticsId = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::AnalyticsExportDestination = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#40 -Aws::S3::ClientApi::AnalyticsS3BucketDestination = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::AnalyticsFilter = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#41 -Aws::S3::ClientApi::AnalyticsS3ExportFileFormat = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::AnalyticsId = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#42 -Aws::S3::ClientApi::ArchiveStatus = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::AnalyticsS3BucketDestination = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#43 -Aws::S3::ClientApi::Body = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BlobShape) +Aws::S3::ClientApi::AnalyticsS3ExportFileFormat = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#44 -Aws::S3::ClientApi::Bucket = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::ArchiveStatus = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#45 -Aws::S3::ClientApi::BucketAccelerateStatus = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::Body = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BlobShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#46 -Aws::S3::ClientApi::BucketAlreadyExists = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::Bucket = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#47 -Aws::S3::ClientApi::BucketAlreadyOwnedByYou = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::BucketAccelerateStatus = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#48 -Aws::S3::ClientApi::BucketCannedACL = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::BucketAlreadyExists = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#49 -Aws::S3::ClientApi::BucketKeyEnabled = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) +Aws::S3::ClientApi::BucketAlreadyOwnedByYou = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#50 -Aws::S3::ClientApi::BucketLifecycleConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::BucketCannedACL = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#51 -Aws::S3::ClientApi::BucketLocationConstraint = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::BucketInfo = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#52 -Aws::S3::ClientApi::BucketLoggingStatus = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::BucketKeyEnabled = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#53 -Aws::S3::ClientApi::BucketLogsPermission = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::BucketLifecycleConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#54 -Aws::S3::ClientApi::BucketName = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::BucketLocationConstraint = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#55 -Aws::S3::ClientApi::BucketVersioningStatus = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::BucketLocationName = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#56 -Aws::S3::ClientApi::Buckets = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::BucketLoggingStatus = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#57 -Aws::S3::ClientApi::BypassGovernanceRetention = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) +Aws::S3::ClientApi::BucketLogsPermission = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#58 -Aws::S3::ClientApi::BytesProcessed = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) +Aws::S3::ClientApi::BucketName = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#59 -Aws::S3::ClientApi::BytesReturned = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) +Aws::S3::ClientApi::BucketType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#60 -Aws::S3::ClientApi::BytesScanned = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) +Aws::S3::ClientApi::BucketVersioningStatus = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#61 -Aws::S3::ClientApi::CORSConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::Buckets = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#62 -Aws::S3::ClientApi::CORSRule = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::BypassGovernanceRetention = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#63 -Aws::S3::ClientApi::CORSRules = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::BytesProcessed = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#64 -Aws::S3::ClientApi::CSVInput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::BytesReturned = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#65 -Aws::S3::ClientApi::CSVOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::BytesScanned = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#66 -Aws::S3::ClientApi::CacheControl = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::CORSConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#67 -Aws::S3::ClientApi::Checksum = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::CORSRule = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#68 -Aws::S3::ClientApi::ChecksumAlgorithm = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::CORSRules = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#69 -Aws::S3::ClientApi::ChecksumAlgorithmList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::CSVInput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#70 -Aws::S3::ClientApi::ChecksumCRC32 = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::CSVOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#71 -Aws::S3::ClientApi::ChecksumCRC32C = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::CacheControl = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#72 -Aws::S3::ClientApi::ChecksumMode = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::Checksum = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#73 -Aws::S3::ClientApi::ChecksumSHA1 = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ChecksumAlgorithm = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#74 -Aws::S3::ClientApi::ChecksumSHA256 = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ChecksumAlgorithmList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#75 -Aws::S3::ClientApi::CloudFunction = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ChecksumCRC32 = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#76 -Aws::S3::ClientApi::CloudFunctionConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::ChecksumCRC32C = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#77 -Aws::S3::ClientApi::CloudFunctionInvocationRole = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ChecksumMode = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#78 -Aws::S3::ClientApi::Code = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ChecksumSHA1 = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#79 -Aws::S3::ClientApi::Comments = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ChecksumSHA256 = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#80 -Aws::S3::ClientApi::CommonPrefix = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::CloudFunction = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#81 -Aws::S3::ClientApi::CommonPrefixList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::CloudFunctionConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#82 -Aws::S3::ClientApi::CompleteMultipartUploadOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::CloudFunctionInvocationRole = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#83 -Aws::S3::ClientApi::CompleteMultipartUploadRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::Code = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#84 -Aws::S3::ClientApi::CompletedMultipartUpload = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::Comments = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#85 -Aws::S3::ClientApi::CompletedPart = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::CommonPrefix = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#86 -Aws::S3::ClientApi::CompletedPartList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::CommonPrefixList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#87 -Aws::S3::ClientApi::CompressionType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::CompleteMultipartUploadOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#88 -Aws::S3::ClientApi::Condition = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::CompleteMultipartUploadRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#89 -Aws::S3::ClientApi::ConfirmRemoveSelfBucketAccess = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) +Aws::S3::ClientApi::CompletedMultipartUpload = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#90 -Aws::S3::ClientApi::ContentDisposition = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::CompletedPart = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#91 -Aws::S3::ClientApi::ContentEncoding = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::CompletedPartList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#92 -Aws::S3::ClientApi::ContentLanguage = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::CompressionType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#93 -Aws::S3::ClientApi::ContentLength = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) +Aws::S3::ClientApi::Condition = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#94 -Aws::S3::ClientApi::ContentMD5 = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ConfirmRemoveSelfBucketAccess = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#95 -Aws::S3::ClientApi::ContentRange = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ContentDisposition = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#96 -Aws::S3::ClientApi::ContentType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ContentEncoding = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#97 -Aws::S3::ClientApi::ContinuationEvent = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::ContentLanguage = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#98 -Aws::S3::ClientApi::CopyObjectOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::ContentLength = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#99 -Aws::S3::ClientApi::CopyObjectRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::ContentMD5 = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#100 -Aws::S3::ClientApi::CopyObjectResult = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::ContentRange = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#101 -Aws::S3::ClientApi::CopyPartResult = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::ContentType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#102 -Aws::S3::ClientApi::CopySource = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ContinuationEvent = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#103 -Aws::S3::ClientApi::CopySourceIfMatch = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::CopyObjectOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#104 -Aws::S3::ClientApi::CopySourceIfModifiedSince = T.let(T.unsafe(nil), Seahorse::Model::Shapes::TimestampShape) +Aws::S3::ClientApi::CopyObjectRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#105 -Aws::S3::ClientApi::CopySourceIfNoneMatch = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::CopyObjectResult = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#106 -Aws::S3::ClientApi::CopySourceIfUnmodifiedSince = T.let(T.unsafe(nil), Seahorse::Model::Shapes::TimestampShape) +Aws::S3::ClientApi::CopyPartResult = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#107 -Aws::S3::ClientApi::CopySourceRange = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::CopySource = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#108 -Aws::S3::ClientApi::CopySourceSSECustomerAlgorithm = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::CopySourceIfMatch = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#109 -Aws::S3::ClientApi::CopySourceSSECustomerKey = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::CopySourceIfModifiedSince = T.let(T.unsafe(nil), Seahorse::Model::Shapes::TimestampShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#110 -Aws::S3::ClientApi::CopySourceSSECustomerKeyMD5 = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::CopySourceIfNoneMatch = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#111 -Aws::S3::ClientApi::CopySourceVersionId = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::CopySourceIfUnmodifiedSince = T.let(T.unsafe(nil), Seahorse::Model::Shapes::TimestampShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#112 -Aws::S3::ClientApi::CreateBucketConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::CopySourceRange = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#113 -Aws::S3::ClientApi::CreateBucketOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::CopySourceSSECustomerAlgorithm = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#114 -Aws::S3::ClientApi::CreateBucketRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::CopySourceSSECustomerKey = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#115 -Aws::S3::ClientApi::CreateMultipartUploadOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::CopySourceSSECustomerKeyMD5 = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#116 -Aws::S3::ClientApi::CreateMultipartUploadRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::CopySourceVersionId = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#117 -Aws::S3::ClientApi::CreationDate = T.let(T.unsafe(nil), Seahorse::Model::Shapes::TimestampShape) +Aws::S3::ClientApi::CreateBucketConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#118 -Aws::S3::ClientApi::Date = T.let(T.unsafe(nil), Seahorse::Model::Shapes::TimestampShape) +Aws::S3::ClientApi::CreateBucketOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#119 -Aws::S3::ClientApi::Days = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) +Aws::S3::ClientApi::CreateBucketRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#120 -Aws::S3::ClientApi::DaysAfterInitiation = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) +Aws::S3::ClientApi::CreateMultipartUploadOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#121 -Aws::S3::ClientApi::DefaultRetention = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::CreateMultipartUploadRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#122 -Aws::S3::ClientApi::Delete = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::CreateSessionOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#123 -Aws::S3::ClientApi::DeleteBucketAnalyticsConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::CreateSessionRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#124 -Aws::S3::ClientApi::DeleteBucketCorsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::CreationDate = T.let(T.unsafe(nil), Seahorse::Model::Shapes::TimestampShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#125 -Aws::S3::ClientApi::DeleteBucketEncryptionRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::DataRedundancy = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#126 -Aws::S3::ClientApi::DeleteBucketIntelligentTieringConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::Date = T.let(T.unsafe(nil), Seahorse::Model::Shapes::TimestampShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#127 -Aws::S3::ClientApi::DeleteBucketInventoryConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::Days = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#128 -Aws::S3::ClientApi::DeleteBucketLifecycleRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::DaysAfterInitiation = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#129 -Aws::S3::ClientApi::DeleteBucketMetricsConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::DefaultRetention = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#130 -Aws::S3::ClientApi::DeleteBucketOwnershipControlsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::Delete = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#131 -Aws::S3::ClientApi::DeleteBucketPolicyRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::DeleteBucketAnalyticsConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#132 -Aws::S3::ClientApi::DeleteBucketReplicationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::DeleteBucketCorsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#133 -Aws::S3::ClientApi::DeleteBucketRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::DeleteBucketEncryptionRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#134 -Aws::S3::ClientApi::DeleteBucketTaggingRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::DeleteBucketIntelligentTieringConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#135 -Aws::S3::ClientApi::DeleteBucketWebsiteRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::DeleteBucketInventoryConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#136 -Aws::S3::ClientApi::DeleteMarker = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) +Aws::S3::ClientApi::DeleteBucketLifecycleRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#137 -Aws::S3::ClientApi::DeleteMarkerEntry = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::DeleteBucketMetricsConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#138 -Aws::S3::ClientApi::DeleteMarkerReplication = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::DeleteBucketOwnershipControlsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#139 -Aws::S3::ClientApi::DeleteMarkerReplicationStatus = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::DeleteBucketPolicyRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#140 -Aws::S3::ClientApi::DeleteMarkerVersionId = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::DeleteBucketReplicationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#141 -Aws::S3::ClientApi::DeleteMarkers = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::DeleteBucketRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#142 -Aws::S3::ClientApi::DeleteObjectOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::DeleteBucketTaggingRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#143 -Aws::S3::ClientApi::DeleteObjectRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::DeleteBucketWebsiteRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#144 -Aws::S3::ClientApi::DeleteObjectTaggingOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::DeleteMarker = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#145 -Aws::S3::ClientApi::DeleteObjectTaggingRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::DeleteMarkerEntry = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#146 -Aws::S3::ClientApi::DeleteObjectsOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::DeleteMarkerReplication = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#147 -Aws::S3::ClientApi::DeleteObjectsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::DeleteMarkerReplicationStatus = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#148 -Aws::S3::ClientApi::DeletePublicAccessBlockRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::DeleteMarkerVersionId = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#149 -Aws::S3::ClientApi::DeletedObject = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::DeleteMarkers = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#150 -Aws::S3::ClientApi::DeletedObjects = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::DeleteObjectOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#151 -Aws::S3::ClientApi::Delimiter = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::DeleteObjectRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#152 -Aws::S3::ClientApi::Description = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::DeleteObjectTaggingOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#153 -Aws::S3::ClientApi::Destination = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::DeleteObjectTaggingRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#154 -Aws::S3::ClientApi::DisplayName = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::DeleteObjectsOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#155 -Aws::S3::ClientApi::ETag = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::DeleteObjectsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#156 -Aws::S3::ClientApi::EmailAddress = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::DeletePublicAccessBlockRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#157 -Aws::S3::ClientApi::EnableRequestProgress = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) +Aws::S3::ClientApi::DeletedObject = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#158 -Aws::S3::ClientApi::EncodingType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::DeletedObjects = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#159 -Aws::S3::ClientApi::Encryption = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::Delimiter = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#160 -Aws::S3::ClientApi::EncryptionConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::Description = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#161 -Aws::S3::ClientApi::End = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) +Aws::S3::ClientApi::Destination = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#162 -Aws::S3::ClientApi::EndEvent = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::DirectoryBucketToken = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#163 -Aws::S3::ClientApi::Error = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::DisplayName = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#164 -Aws::S3::ClientApi::ErrorCode = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ETag = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#165 -Aws::S3::ClientApi::ErrorDocument = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::EmailAddress = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#166 -Aws::S3::ClientApi::ErrorMessage = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::EnableRequestProgress = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#167 -Aws::S3::ClientApi::Errors = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::EncodingType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#168 -Aws::S3::ClientApi::Event = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::Encryption = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#169 -Aws::S3::ClientApi::EventBridgeConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::EncryptionConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#170 -Aws::S3::ClientApi::EventList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::End = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#171 -Aws::S3::ClientApi::ExistingObjectReplication = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::EndEvent = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#172 -Aws::S3::ClientApi::ExistingObjectReplicationStatus = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::Error = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#173 -Aws::S3::ClientApi::Expiration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ErrorCode = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#174 -Aws::S3::ClientApi::ExpirationStatus = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ErrorDocument = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#175 -Aws::S3::ClientApi::ExpiredObjectDeleteMarker = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) +Aws::S3::ClientApi::ErrorMessage = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#176 -Aws::S3::ClientApi::Expires = T.let(T.unsafe(nil), Seahorse::Model::Shapes::TimestampShape) +Aws::S3::ClientApi::Errors = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#177 -Aws::S3::ClientApi::ExpiresString = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::Event = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#178 -Aws::S3::ClientApi::ExposeHeader = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::EventBridgeConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#179 -Aws::S3::ClientApi::ExposeHeaders = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::EventList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#180 -Aws::S3::ClientApi::Expression = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ExistingObjectReplication = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#181 -Aws::S3::ClientApi::ExpressionType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ExistingObjectReplicationStatus = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#182 -Aws::S3::ClientApi::FetchOwner = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) +Aws::S3::ClientApi::Expiration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#183 -Aws::S3::ClientApi::FieldDelimiter = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ExpirationStatus = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#184 -Aws::S3::ClientApi::FileHeaderInfo = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ExpiredObjectDeleteMarker = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#185 -Aws::S3::ClientApi::FilterRule = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::Expires = T.let(T.unsafe(nil), Seahorse::Model::Shapes::TimestampShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#186 -Aws::S3::ClientApi::FilterRuleList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::ExpiresString = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#187 -Aws::S3::ClientApi::FilterRuleName = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ExposeHeader = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#188 -Aws::S3::ClientApi::FilterRuleValue = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ExposeHeaders = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#189 -Aws::S3::ClientApi::GetBucketAccelerateConfigurationOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::Expression = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#190 -Aws::S3::ClientApi::GetBucketAccelerateConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::ExpressionType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#191 -Aws::S3::ClientApi::GetBucketAclOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::FetchOwner = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#192 -Aws::S3::ClientApi::GetBucketAclRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::FieldDelimiter = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#193 -Aws::S3::ClientApi::GetBucketAnalyticsConfigurationOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::FileHeaderInfo = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#194 -Aws::S3::ClientApi::GetBucketAnalyticsConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::FilterRule = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#195 -Aws::S3::ClientApi::GetBucketCorsOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::FilterRuleList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#196 -Aws::S3::ClientApi::GetBucketCorsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::FilterRuleName = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#197 -Aws::S3::ClientApi::GetBucketEncryptionOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::FilterRuleValue = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#198 -Aws::S3::ClientApi::GetBucketEncryptionRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketAccelerateConfigurationOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#199 -Aws::S3::ClientApi::GetBucketIntelligentTieringConfigurationOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketAccelerateConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#200 -Aws::S3::ClientApi::GetBucketIntelligentTieringConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketAclOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#201 -Aws::S3::ClientApi::GetBucketInventoryConfigurationOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketAclRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#202 -Aws::S3::ClientApi::GetBucketInventoryConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketAnalyticsConfigurationOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#203 -Aws::S3::ClientApi::GetBucketLifecycleConfigurationOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketAnalyticsConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#204 -Aws::S3::ClientApi::GetBucketLifecycleConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketCorsOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#205 -Aws::S3::ClientApi::GetBucketLifecycleOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketCorsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#206 -Aws::S3::ClientApi::GetBucketLifecycleRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketEncryptionOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#207 -Aws::S3::ClientApi::GetBucketLocationOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketEncryptionRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#208 -Aws::S3::ClientApi::GetBucketLocationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketIntelligentTieringConfigurationOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#209 -Aws::S3::ClientApi::GetBucketLoggingOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketIntelligentTieringConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#210 -Aws::S3::ClientApi::GetBucketLoggingRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketInventoryConfigurationOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#211 -Aws::S3::ClientApi::GetBucketMetricsConfigurationOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketInventoryConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#212 -Aws::S3::ClientApi::GetBucketMetricsConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketLifecycleConfigurationOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#213 -Aws::S3::ClientApi::GetBucketNotificationConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketLifecycleConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#214 -Aws::S3::ClientApi::GetBucketOwnershipControlsOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketLifecycleOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#215 -Aws::S3::ClientApi::GetBucketOwnershipControlsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketLifecycleRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#216 -Aws::S3::ClientApi::GetBucketPolicyOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketLocationOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#217 -Aws::S3::ClientApi::GetBucketPolicyRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketLocationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#218 -Aws::S3::ClientApi::GetBucketPolicyStatusOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketLoggingOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#219 -Aws::S3::ClientApi::GetBucketPolicyStatusRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketLoggingRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#220 -Aws::S3::ClientApi::GetBucketReplicationOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketMetricsConfigurationOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#221 -Aws::S3::ClientApi::GetBucketReplicationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketMetricsConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#222 -Aws::S3::ClientApi::GetBucketRequestPaymentOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketNotificationConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#223 -Aws::S3::ClientApi::GetBucketRequestPaymentRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketOwnershipControlsOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#224 -Aws::S3::ClientApi::GetBucketTaggingOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketOwnershipControlsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#225 -Aws::S3::ClientApi::GetBucketTaggingRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketPolicyOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#226 -Aws::S3::ClientApi::GetBucketVersioningOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketPolicyRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#227 -Aws::S3::ClientApi::GetBucketVersioningRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketPolicyStatusOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#228 -Aws::S3::ClientApi::GetBucketWebsiteOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketPolicyStatusRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#229 -Aws::S3::ClientApi::GetBucketWebsiteRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketReplicationOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#230 -Aws::S3::ClientApi::GetObjectAclOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketReplicationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#231 -Aws::S3::ClientApi::GetObjectAclRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketRequestPaymentOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#232 -Aws::S3::ClientApi::GetObjectAttributesOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketRequestPaymentRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#233 -Aws::S3::ClientApi::GetObjectAttributesParts = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketTaggingOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#234 -Aws::S3::ClientApi::GetObjectAttributesRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketTaggingRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#235 -Aws::S3::ClientApi::GetObjectLegalHoldOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketVersioningOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#236 -Aws::S3::ClientApi::GetObjectLegalHoldRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketVersioningRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#237 -Aws::S3::ClientApi::GetObjectLockConfigurationOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketWebsiteOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#238 -Aws::S3::ClientApi::GetObjectLockConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetBucketWebsiteRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#239 -Aws::S3::ClientApi::GetObjectOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetObjectAclOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#240 -Aws::S3::ClientApi::GetObjectRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetObjectAclRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#241 -Aws::S3::ClientApi::GetObjectResponseStatusCode = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) +Aws::S3::ClientApi::GetObjectAttributesOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#242 -Aws::S3::ClientApi::GetObjectRetentionOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetObjectAttributesParts = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#243 -Aws::S3::ClientApi::GetObjectRetentionRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetObjectAttributesRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#244 -Aws::S3::ClientApi::GetObjectTaggingOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetObjectLegalHoldOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#245 -Aws::S3::ClientApi::GetObjectTaggingRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetObjectLegalHoldRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#246 -Aws::S3::ClientApi::GetObjectTorrentOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetObjectLockConfigurationOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#247 -Aws::S3::ClientApi::GetObjectTorrentRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetObjectLockConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#248 -Aws::S3::ClientApi::GetPublicAccessBlockOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetObjectOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#249 -Aws::S3::ClientApi::GetPublicAccessBlockRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetObjectRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#250 -Aws::S3::ClientApi::GlacierJobParameters = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetObjectResponseStatusCode = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#251 -Aws::S3::ClientApi::Grant = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetObjectRetentionOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#252 -Aws::S3::ClientApi::GrantFullControl = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::GetObjectRetentionRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#253 -Aws::S3::ClientApi::GrantRead = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::GetObjectTaggingOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#254 -Aws::S3::ClientApi::GrantReadACP = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::GetObjectTaggingRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#255 -Aws::S3::ClientApi::GrantWrite = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::GetObjectTorrentOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#256 -Aws::S3::ClientApi::GrantWriteACP = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::GetObjectTorrentRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#257 -Aws::S3::ClientApi::Grantee = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GetPublicAccessBlockOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#258 -Aws::S3::ClientApi::Grants = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::GetPublicAccessBlockRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#259 -Aws::S3::ClientApi::HeadBucketRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GlacierJobParameters = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#260 -Aws::S3::ClientApi::HeadObjectOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::Grant = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#261 -Aws::S3::ClientApi::HeadObjectRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::GrantFullControl = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#262 -Aws::S3::ClientApi::HostName = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::GrantRead = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#263 -Aws::S3::ClientApi::HttpErrorCodeReturnedEquals = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::GrantReadACP = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#264 -Aws::S3::ClientApi::HttpRedirectCode = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::GrantWrite = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#265 -Aws::S3::ClientApi::ID = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::GrantWriteACP = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#266 -Aws::S3::ClientApi::IfMatch = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::Grantee = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#267 -Aws::S3::ClientApi::IfModifiedSince = T.let(T.unsafe(nil), Seahorse::Model::Shapes::TimestampShape) +Aws::S3::ClientApi::Grants = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#268 -Aws::S3::ClientApi::IfNoneMatch = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::HeadBucketOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#269 -Aws::S3::ClientApi::IfUnmodifiedSince = T.let(T.unsafe(nil), Seahorse::Model::Shapes::TimestampShape) +Aws::S3::ClientApi::HeadBucketRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#270 -Aws::S3::ClientApi::IndexDocument = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::HeadObjectOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#271 -Aws::S3::ClientApi::Initiated = T.let(T.unsafe(nil), Seahorse::Model::Shapes::TimestampShape) +Aws::S3::ClientApi::HeadObjectRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#272 -Aws::S3::ClientApi::Initiator = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::HostName = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#273 -Aws::S3::ClientApi::InputSerialization = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::HttpErrorCodeReturnedEquals = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#274 -Aws::S3::ClientApi::IntelligentTieringAccessTier = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::HttpRedirectCode = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#275 -Aws::S3::ClientApi::IntelligentTieringAndOperator = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::ID = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#276 -Aws::S3::ClientApi::IntelligentTieringConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::IfMatch = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#277 -Aws::S3::ClientApi::IntelligentTieringConfigurationList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::IfModifiedSince = T.let(T.unsafe(nil), Seahorse::Model::Shapes::TimestampShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#278 -Aws::S3::ClientApi::IntelligentTieringDays = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) +Aws::S3::ClientApi::IfNoneMatch = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#279 -Aws::S3::ClientApi::IntelligentTieringFilter = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::IfUnmodifiedSince = T.let(T.unsafe(nil), Seahorse::Model::Shapes::TimestampShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#280 -Aws::S3::ClientApi::IntelligentTieringId = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::IndexDocument = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#281 -Aws::S3::ClientApi::IntelligentTieringStatus = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::Initiated = T.let(T.unsafe(nil), Seahorse::Model::Shapes::TimestampShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#282 -Aws::S3::ClientApi::InvalidObjectState = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::Initiator = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#283 -Aws::S3::ClientApi::InventoryConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::InputSerialization = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#284 -Aws::S3::ClientApi::InventoryConfigurationList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::IntelligentTieringAccessTier = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#285 -Aws::S3::ClientApi::InventoryDestination = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::IntelligentTieringAndOperator = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#286 -Aws::S3::ClientApi::InventoryEncryption = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::IntelligentTieringConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#287 -Aws::S3::ClientApi::InventoryFilter = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::IntelligentTieringConfigurationList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#288 -Aws::S3::ClientApi::InventoryFormat = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::IntelligentTieringDays = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#289 -Aws::S3::ClientApi::InventoryFrequency = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::IntelligentTieringFilter = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#290 -Aws::S3::ClientApi::InventoryId = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::IntelligentTieringId = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#291 -Aws::S3::ClientApi::InventoryIncludedObjectVersions = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::IntelligentTieringStatus = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#292 -Aws::S3::ClientApi::InventoryOptionalField = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::InvalidObjectState = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#293 -Aws::S3::ClientApi::InventoryOptionalFields = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::InventoryConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#294 -Aws::S3::ClientApi::InventoryS3BucketDestination = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::InventoryConfigurationList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#295 -Aws::S3::ClientApi::InventorySchedule = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::InventoryDestination = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#296 -Aws::S3::ClientApi::IsEnabled = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) +Aws::S3::ClientApi::InventoryEncryption = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#297 -Aws::S3::ClientApi::IsLatest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) +Aws::S3::ClientApi::InventoryFilter = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#298 -Aws::S3::ClientApi::IsPublic = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) +Aws::S3::ClientApi::InventoryFormat = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#299 -Aws::S3::ClientApi::IsRestoreInProgress = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) +Aws::S3::ClientApi::InventoryFrequency = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#300 -Aws::S3::ClientApi::IsTruncated = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) +Aws::S3::ClientApi::InventoryId = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#301 -Aws::S3::ClientApi::JSONInput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::InventoryIncludedObjectVersions = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#302 -Aws::S3::ClientApi::JSONOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::InventoryOptionalField = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#303 -Aws::S3::ClientApi::JSONType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::InventoryOptionalFields = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#304 -Aws::S3::ClientApi::KMSContext = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::InventoryS3BucketDestination = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#305 -Aws::S3::ClientApi::KeyCount = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) +Aws::S3::ClientApi::InventorySchedule = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#306 -Aws::S3::ClientApi::KeyMarker = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::IsEnabled = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#307 -Aws::S3::ClientApi::KeyPrefixEquals = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::IsLatest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#308 -Aws::S3::ClientApi::LambdaFunctionArn = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::IsPublic = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#309 -Aws::S3::ClientApi::LambdaFunctionConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::IsRestoreInProgress = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#310 -Aws::S3::ClientApi::LambdaFunctionConfigurationList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::IsTruncated = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#311 -Aws::S3::ClientApi::LastModified = T.let(T.unsafe(nil), Seahorse::Model::Shapes::TimestampShape) +Aws::S3::ClientApi::JSONInput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#312 -Aws::S3::ClientApi::LifecycleConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::JSONOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#313 -Aws::S3::ClientApi::LifecycleExpiration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::JSONType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#314 -Aws::S3::ClientApi::LifecycleRule = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::KMSContext = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#315 -Aws::S3::ClientApi::LifecycleRuleAndOperator = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::KeyCount = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#316 -Aws::S3::ClientApi::LifecycleRuleFilter = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::KeyMarker = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#317 -Aws::S3::ClientApi::LifecycleRules = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::KeyPrefixEquals = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#318 -Aws::S3::ClientApi::ListBucketAnalyticsConfigurationsOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::LambdaFunctionArn = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#319 -Aws::S3::ClientApi::ListBucketAnalyticsConfigurationsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::LambdaFunctionConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#320 -Aws::S3::ClientApi::ListBucketIntelligentTieringConfigurationsOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::LambdaFunctionConfigurationList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#321 -Aws::S3::ClientApi::ListBucketIntelligentTieringConfigurationsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::LastModified = T.let(T.unsafe(nil), Seahorse::Model::Shapes::TimestampShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#322 -Aws::S3::ClientApi::ListBucketInventoryConfigurationsOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::LifecycleConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#323 -Aws::S3::ClientApi::ListBucketInventoryConfigurationsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::LifecycleExpiration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#324 -Aws::S3::ClientApi::ListBucketMetricsConfigurationsOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::LifecycleRule = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#325 -Aws::S3::ClientApi::ListBucketMetricsConfigurationsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::LifecycleRuleAndOperator = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#326 -Aws::S3::ClientApi::ListBucketsOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::LifecycleRuleFilter = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#327 -Aws::S3::ClientApi::ListMultipartUploadsOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::LifecycleRules = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#328 -Aws::S3::ClientApi::ListMultipartUploadsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::ListBucketAnalyticsConfigurationsOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#329 -Aws::S3::ClientApi::ListObjectVersionsOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::ListBucketAnalyticsConfigurationsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#330 -Aws::S3::ClientApi::ListObjectVersionsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::ListBucketIntelligentTieringConfigurationsOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#331 -Aws::S3::ClientApi::ListObjectsOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::ListBucketIntelligentTieringConfigurationsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#332 -Aws::S3::ClientApi::ListObjectsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::ListBucketInventoryConfigurationsOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#333 -Aws::S3::ClientApi::ListObjectsV2Output = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::ListBucketInventoryConfigurationsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#334 -Aws::S3::ClientApi::ListObjectsV2Request = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::ListBucketMetricsConfigurationsOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#335 -Aws::S3::ClientApi::ListPartsOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::ListBucketMetricsConfigurationsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#336 -Aws::S3::ClientApi::ListPartsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::ListBucketsOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#337 -Aws::S3::ClientApi::Location = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ListDirectoryBucketsOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#338 -Aws::S3::ClientApi::LocationPrefix = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ListDirectoryBucketsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#339 -Aws::S3::ClientApi::LoggingEnabled = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::ListMultipartUploadsOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#340 -Aws::S3::ClientApi::MFA = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ListMultipartUploadsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#341 -Aws::S3::ClientApi::MFADelete = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ListObjectVersionsOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#342 -Aws::S3::ClientApi::MFADeleteStatus = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ListObjectVersionsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#343 -Aws::S3::ClientApi::Marker = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ListObjectsOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#344 -Aws::S3::ClientApi::MaxAgeSeconds = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) +Aws::S3::ClientApi::ListObjectsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#345 -Aws::S3::ClientApi::MaxKeys = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) +Aws::S3::ClientApi::ListObjectsV2Output = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#346 -Aws::S3::ClientApi::MaxParts = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) +Aws::S3::ClientApi::ListObjectsV2Request = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#347 -Aws::S3::ClientApi::MaxUploads = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) +Aws::S3::ClientApi::ListPartsOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#348 -Aws::S3::ClientApi::Message = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ListPartsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#349 -Aws::S3::ClientApi::Metadata = T.let(T.unsafe(nil), Seahorse::Model::Shapes::MapShape) +Aws::S3::ClientApi::Location = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#350 -Aws::S3::ClientApi::MetadataDirective = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::LocationInfo = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#351 -Aws::S3::ClientApi::MetadataEntry = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::LocationNameAsString = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#352 -Aws::S3::ClientApi::MetadataKey = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::LocationPrefix = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#353 -Aws::S3::ClientApi::MetadataValue = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::LocationType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#354 -Aws::S3::ClientApi::Metrics = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::LoggingEnabled = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#355 -Aws::S3::ClientApi::MetricsAndOperator = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::MFA = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#356 -Aws::S3::ClientApi::MetricsConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::MFADelete = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#357 -Aws::S3::ClientApi::MetricsConfigurationList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::MFADeleteStatus = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#358 -Aws::S3::ClientApi::MetricsFilter = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::Marker = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#359 -Aws::S3::ClientApi::MetricsId = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::MaxAgeSeconds = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#360 -Aws::S3::ClientApi::MetricsStatus = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::MaxDirectoryBuckets = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#361 -Aws::S3::ClientApi::Minutes = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) +Aws::S3::ClientApi::MaxKeys = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#362 -Aws::S3::ClientApi::MissingMeta = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) +Aws::S3::ClientApi::MaxParts = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#363 -Aws::S3::ClientApi::MultipartUpload = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::MaxUploads = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#364 -Aws::S3::ClientApi::MultipartUploadId = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::Message = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#365 -Aws::S3::ClientApi::MultipartUploadList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::Metadata = T.let(T.unsafe(nil), Seahorse::Model::Shapes::MapShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#366 -Aws::S3::ClientApi::NextKeyMarker = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::MetadataDirective = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#367 -Aws::S3::ClientApi::NextMarker = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::MetadataEntry = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#368 -Aws::S3::ClientApi::NextPartNumberMarker = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) +Aws::S3::ClientApi::MetadataKey = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#369 -Aws::S3::ClientApi::NextToken = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::MetadataValue = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#370 -Aws::S3::ClientApi::NextUploadIdMarker = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::Metrics = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#371 -Aws::S3::ClientApi::NextVersionIdMarker = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::MetricsAndOperator = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#372 -Aws::S3::ClientApi::NoSuchBucket = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::MetricsConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#373 -Aws::S3::ClientApi::NoSuchKey = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::MetricsConfigurationList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#374 -Aws::S3::ClientApi::NoSuchUpload = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::MetricsFilter = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#375 -Aws::S3::ClientApi::NoncurrentVersionExpiration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::MetricsId = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#376 -Aws::S3::ClientApi::NoncurrentVersionTransition = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::MetricsStatus = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#377 -Aws::S3::ClientApi::NoncurrentVersionTransitionList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::Minutes = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#378 -Aws::S3::ClientApi::NotificationConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::MissingMeta = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#379 -Aws::S3::ClientApi::NotificationConfigurationDeprecated = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::MultipartUpload = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#380 -Aws::S3::ClientApi::NotificationConfigurationFilter = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::MultipartUploadId = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#381 -Aws::S3::ClientApi::NotificationId = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::MultipartUploadList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#382 -Aws::S3::ClientApi::Object = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::NextKeyMarker = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#383 -Aws::S3::ClientApi::ObjectAlreadyInActiveTierError = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::NextMarker = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#384 -Aws::S3::ClientApi::ObjectAttributes = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::NextPartNumberMarker = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#385 -Aws::S3::ClientApi::ObjectAttributesList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::NextToken = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#386 -Aws::S3::ClientApi::ObjectCannedACL = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::NextUploadIdMarker = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#387 -Aws::S3::ClientApi::ObjectIdentifier = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::NextVersionIdMarker = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#388 -Aws::S3::ClientApi::ObjectIdentifierList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::NoSuchBucket = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#389 -Aws::S3::ClientApi::ObjectKey = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::NoSuchKey = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#390 -Aws::S3::ClientApi::ObjectList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::NoSuchUpload = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#391 -Aws::S3::ClientApi::ObjectLockConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::NoncurrentVersionExpiration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#392 -Aws::S3::ClientApi::ObjectLockEnabled = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::NoncurrentVersionTransition = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#393 -Aws::S3::ClientApi::ObjectLockEnabledForBucket = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) +Aws::S3::ClientApi::NoncurrentVersionTransitionList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#394 -Aws::S3::ClientApi::ObjectLockLegalHold = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::NotificationConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#395 -Aws::S3::ClientApi::ObjectLockLegalHoldStatus = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::NotificationConfigurationDeprecated = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#396 -Aws::S3::ClientApi::ObjectLockMode = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::NotificationConfigurationFilter = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#397 -Aws::S3::ClientApi::ObjectLockRetainUntilDate = T.let(T.unsafe(nil), Seahorse::Model::Shapes::TimestampShape) +Aws::S3::ClientApi::NotificationId = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#398 -Aws::S3::ClientApi::ObjectLockRetention = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::Object = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#399 -Aws::S3::ClientApi::ObjectLockRetentionMode = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ObjectAlreadyInActiveTierError = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#400 -Aws::S3::ClientApi::ObjectLockRule = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::ObjectAttributes = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#401 -Aws::S3::ClientApi::ObjectLockToken = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ObjectAttributesList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#402 -Aws::S3::ClientApi::ObjectNotInActiveTierError = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::ObjectCannedACL = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#403 -Aws::S3::ClientApi::ObjectOwnership = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ObjectIdentifier = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#404 -Aws::S3::ClientApi::ObjectPart = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::ObjectIdentifierList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#405 -Aws::S3::ClientApi::ObjectSize = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) +Aws::S3::ClientApi::ObjectKey = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#406 -Aws::S3::ClientApi::ObjectSizeGreaterThanBytes = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) +Aws::S3::ClientApi::ObjectList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#407 -Aws::S3::ClientApi::ObjectSizeLessThanBytes = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) +Aws::S3::ClientApi::ObjectLockConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#408 -Aws::S3::ClientApi::ObjectStorageClass = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ObjectLockEnabled = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#409 -Aws::S3::ClientApi::ObjectVersion = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::ObjectLockEnabledForBucket = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#410 -Aws::S3::ClientApi::ObjectVersionId = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ObjectLockLegalHold = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#411 -Aws::S3::ClientApi::ObjectVersionList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::ObjectLockLegalHoldStatus = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#412 -Aws::S3::ClientApi::ObjectVersionStorageClass = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ObjectLockMode = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#413 -Aws::S3::ClientApi::OptionalObjectAttributes = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ObjectLockRetainUntilDate = T.let(T.unsafe(nil), Seahorse::Model::Shapes::TimestampShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#414 -Aws::S3::ClientApi::OptionalObjectAttributesList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::ObjectLockRetention = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#415 -Aws::S3::ClientApi::OutputLocation = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::ObjectLockRetentionMode = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#416 -Aws::S3::ClientApi::OutputSerialization = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::ObjectLockRule = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#417 -Aws::S3::ClientApi::Owner = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::ObjectLockToken = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#418 -Aws::S3::ClientApi::OwnerOverride = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::ObjectNotInActiveTierError = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#419 -Aws::S3::ClientApi::OwnershipControls = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::ObjectOwnership = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#420 -Aws::S3::ClientApi::OwnershipControlsRule = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::ObjectPart = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#421 -Aws::S3::ClientApi::OwnershipControlsRules = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::ObjectSize = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#422 -Aws::S3::ClientApi::ParquetInput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::ObjectSizeGreaterThanBytes = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#423 -Aws::S3::ClientApi::Part = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::ObjectSizeLessThanBytes = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#424 -Aws::S3::ClientApi::PartNumber = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) +Aws::S3::ClientApi::ObjectStorageClass = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#425 -Aws::S3::ClientApi::PartNumberMarker = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) +Aws::S3::ClientApi::ObjectVersion = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#426 -Aws::S3::ClientApi::Parts = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::ObjectVersionId = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#427 -Aws::S3::ClientApi::PartsCount = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) +Aws::S3::ClientApi::ObjectVersionList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#428 -Aws::S3::ClientApi::PartsList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::ObjectVersionStorageClass = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#429 -Aws::S3::ClientApi::Payer = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::OptionalObjectAttributes = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#430 -Aws::S3::ClientApi::Permission = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::OptionalObjectAttributesList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#431 -Aws::S3::ClientApi::Policy = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::OutputLocation = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#432 -Aws::S3::ClientApi::PolicyStatus = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::OutputSerialization = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#433 -Aws::S3::ClientApi::Prefix = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::Owner = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#434 -Aws::S3::ClientApi::Priority = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) +Aws::S3::ClientApi::OwnerOverride = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#435 -Aws::S3::ClientApi::Progress = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::OwnershipControls = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#436 -Aws::S3::ClientApi::ProgressEvent = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::OwnershipControlsRule = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#437 -Aws::S3::ClientApi::Protocol = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::OwnershipControlsRules = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#438 -Aws::S3::ClientApi::PublicAccessBlockConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::ParquetInput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#439 -Aws::S3::ClientApi::PutBucketAccelerateConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::Part = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#440 -Aws::S3::ClientApi::PutBucketAclRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::PartNumber = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#441 -Aws::S3::ClientApi::PutBucketAnalyticsConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::PartNumberMarker = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#442 -Aws::S3::ClientApi::PutBucketCorsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::PartitionDateSource = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#443 -Aws::S3::ClientApi::PutBucketEncryptionRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::PartitionedPrefix = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#444 -Aws::S3::ClientApi::PutBucketIntelligentTieringConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::Parts = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#445 -Aws::S3::ClientApi::PutBucketInventoryConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::PartsCount = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#446 -Aws::S3::ClientApi::PutBucketLifecycleConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::PartsList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#447 -Aws::S3::ClientApi::PutBucketLifecycleRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::Payer = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#448 -Aws::S3::ClientApi::PutBucketLoggingRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::Permission = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#449 -Aws::S3::ClientApi::PutBucketMetricsConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::Policy = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#450 -Aws::S3::ClientApi::PutBucketNotificationConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::PolicyStatus = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#451 -Aws::S3::ClientApi::PutBucketNotificationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::Prefix = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#452 -Aws::S3::ClientApi::PutBucketOwnershipControlsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::Priority = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#453 -Aws::S3::ClientApi::PutBucketPolicyRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::Progress = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#454 -Aws::S3::ClientApi::PutBucketReplicationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::ProgressEvent = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#455 -Aws::S3::ClientApi::PutBucketRequestPaymentRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::Protocol = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#456 -Aws::S3::ClientApi::PutBucketTaggingRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::PublicAccessBlockConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#457 -Aws::S3::ClientApi::PutBucketVersioningRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::PutBucketAccelerateConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#458 -Aws::S3::ClientApi::PutBucketWebsiteRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::PutBucketAclRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#459 -Aws::S3::ClientApi::PutObjectAclOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::PutBucketAnalyticsConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#460 -Aws::S3::ClientApi::PutObjectAclRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::PutBucketCorsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#461 -Aws::S3::ClientApi::PutObjectLegalHoldOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::PutBucketEncryptionRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#462 -Aws::S3::ClientApi::PutObjectLegalHoldRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::PutBucketIntelligentTieringConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#463 -Aws::S3::ClientApi::PutObjectLockConfigurationOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::PutBucketInventoryConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#464 -Aws::S3::ClientApi::PutObjectLockConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::PutBucketLifecycleConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#465 -Aws::S3::ClientApi::PutObjectOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::PutBucketLifecycleRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#466 -Aws::S3::ClientApi::PutObjectRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::PutBucketLoggingRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#467 -Aws::S3::ClientApi::PutObjectRetentionOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::PutBucketMetricsConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#468 -Aws::S3::ClientApi::PutObjectRetentionRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::PutBucketNotificationConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#469 -Aws::S3::ClientApi::PutObjectTaggingOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::PutBucketNotificationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#470 -Aws::S3::ClientApi::PutObjectTaggingRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::PutBucketOwnershipControlsRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#471 -Aws::S3::ClientApi::PutPublicAccessBlockRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::PutBucketPolicyRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#472 -Aws::S3::ClientApi::QueueArn = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::PutBucketReplicationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#473 -Aws::S3::ClientApi::QueueConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::PutBucketRequestPaymentRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#474 -Aws::S3::ClientApi::QueueConfigurationDeprecated = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) +Aws::S3::ClientApi::PutBucketTaggingRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#475 -Aws::S3::ClientApi::QueueConfigurationList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) +Aws::S3::ClientApi::PutBucketVersioningRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#476 -Aws::S3::ClientApi::Quiet = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) +Aws::S3::ClientApi::PutBucketWebsiteRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#477 -Aws::S3::ClientApi::QuoteCharacter = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::PutObjectAclOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#478 -Aws::S3::ClientApi::QuoteEscapeCharacter = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::PutObjectAclRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#479 -Aws::S3::ClientApi::QuoteFields = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::PutObjectLegalHoldOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#480 -Aws::S3::ClientApi::Range = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::PutObjectLegalHoldRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#481 -Aws::S3::ClientApi::RecordDelimiter = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) +Aws::S3::ClientApi::PutObjectLockConfigurationOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#482 +Aws::S3::ClientApi::PutObjectLockConfigurationRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) + +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#483 +Aws::S3::ClientApi::PutObjectOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) + +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#484 +Aws::S3::ClientApi::PutObjectRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) + +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#485 +Aws::S3::ClientApi::PutObjectRetentionOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) + +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#486 +Aws::S3::ClientApi::PutObjectRetentionRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) + +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#487 +Aws::S3::ClientApi::PutObjectTaggingOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) + +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#488 +Aws::S3::ClientApi::PutObjectTaggingRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) + +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#489 +Aws::S3::ClientApi::PutPublicAccessBlockRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) + +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#490 +Aws::S3::ClientApi::QueueArn = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) + +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#491 +Aws::S3::ClientApi::QueueConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) + +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#492 +Aws::S3::ClientApi::QueueConfigurationDeprecated = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) + +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#493 +Aws::S3::ClientApi::QueueConfigurationList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) + +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#494 +Aws::S3::ClientApi::Quiet = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) + +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#495 +Aws::S3::ClientApi::QuoteCharacter = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) + +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#496 +Aws::S3::ClientApi::QuoteEscapeCharacter = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) + +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#497 +Aws::S3::ClientApi::QuoteFields = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) + +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#498 +Aws::S3::ClientApi::Range = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) + +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#499 +Aws::S3::ClientApi::RecordDelimiter = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) + +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#500 Aws::S3::ClientApi::RecordsEvent = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#483 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#501 Aws::S3::ClientApi::Redirect = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#484 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#502 Aws::S3::ClientApi::RedirectAllRequestsTo = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#485 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#503 +Aws::S3::ClientApi::Region = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) + +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#504 Aws::S3::ClientApi::ReplaceKeyPrefixWith = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#486 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#505 Aws::S3::ClientApi::ReplaceKeyWith = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#487 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#506 Aws::S3::ClientApi::ReplicaKmsKeyID = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#488 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#507 Aws::S3::ClientApi::ReplicaModifications = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#489 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#508 Aws::S3::ClientApi::ReplicaModificationsStatus = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#490 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#509 Aws::S3::ClientApi::ReplicationConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#491 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#510 Aws::S3::ClientApi::ReplicationRule = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#492 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#511 Aws::S3::ClientApi::ReplicationRuleAndOperator = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#493 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#512 Aws::S3::ClientApi::ReplicationRuleFilter = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#494 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#513 Aws::S3::ClientApi::ReplicationRuleStatus = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#495 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#514 Aws::S3::ClientApi::ReplicationRules = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#496 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#515 Aws::S3::ClientApi::ReplicationStatus = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#497 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#516 Aws::S3::ClientApi::ReplicationTime = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#498 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#517 Aws::S3::ClientApi::ReplicationTimeStatus = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#499 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#518 Aws::S3::ClientApi::ReplicationTimeValue = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#500 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#519 Aws::S3::ClientApi::RequestCharged = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#501 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#520 Aws::S3::ClientApi::RequestPayer = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#502 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#521 Aws::S3::ClientApi::RequestPaymentConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#503 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#522 Aws::S3::ClientApi::RequestProgress = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#504 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#523 Aws::S3::ClientApi::RequestRoute = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#505 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#524 Aws::S3::ClientApi::RequestToken = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#506 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#525 Aws::S3::ClientApi::ResponseCacheControl = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#507 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#526 Aws::S3::ClientApi::ResponseContentDisposition = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#508 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#527 Aws::S3::ClientApi::ResponseContentEncoding = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#509 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#528 Aws::S3::ClientApi::ResponseContentLanguage = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#510 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#529 Aws::S3::ClientApi::ResponseContentType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#511 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#530 Aws::S3::ClientApi::ResponseExpires = T.let(T.unsafe(nil), Seahorse::Model::Shapes::TimestampShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#512 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#531 Aws::S3::ClientApi::Restore = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#513 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#532 Aws::S3::ClientApi::RestoreExpiryDate = T.let(T.unsafe(nil), Seahorse::Model::Shapes::TimestampShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#514 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#533 Aws::S3::ClientApi::RestoreObjectOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#515 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#534 Aws::S3::ClientApi::RestoreObjectRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#516 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#535 Aws::S3::ClientApi::RestoreOutputPath = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#517 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#536 Aws::S3::ClientApi::RestoreRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#518 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#537 Aws::S3::ClientApi::RestoreRequestType = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#519 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#538 Aws::S3::ClientApi::RestoreStatus = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#520 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#539 Aws::S3::ClientApi::Role = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#521 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#540 Aws::S3::ClientApi::RoutingRule = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#522 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#541 Aws::S3::ClientApi::RoutingRules = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#523 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#542 Aws::S3::ClientApi::Rule = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#524 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#543 Aws::S3::ClientApi::Rules = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#525 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#544 Aws::S3::ClientApi::S3KeyFilter = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#526 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#545 Aws::S3::ClientApi::S3Location = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#527 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#546 Aws::S3::ClientApi::SSECustomerAlgorithm = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#528 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#547 Aws::S3::ClientApi::SSECustomerKey = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#529 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#548 Aws::S3::ClientApi::SSECustomerKeyMD5 = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#530 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#549 Aws::S3::ClientApi::SSEKMS = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#531 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#550 Aws::S3::ClientApi::SSEKMSEncryptionContext = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#532 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#551 Aws::S3::ClientApi::SSEKMSKeyId = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#533 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#552 Aws::S3::ClientApi::SSES3 = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#534 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#553 Aws::S3::ClientApi::ScanRange = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#535 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#554 Aws::S3::ClientApi::SelectObjectContentEventStream = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#536 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#555 Aws::S3::ClientApi::SelectObjectContentOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#537 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#556 Aws::S3::ClientApi::SelectObjectContentRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#538 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#557 Aws::S3::ClientApi::SelectParameters = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#539 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#558 Aws::S3::ClientApi::ServerSideEncryption = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#540 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#559 Aws::S3::ClientApi::ServerSideEncryptionByDefault = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#541 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#560 Aws::S3::ClientApi::ServerSideEncryptionConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#542 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#561 Aws::S3::ClientApi::ServerSideEncryptionRule = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#543 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#562 Aws::S3::ClientApi::ServerSideEncryptionRules = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#544 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#563 +Aws::S3::ClientApi::SessionCredentialValue = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) + +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#564 +Aws::S3::ClientApi::SessionCredentials = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) + +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#565 +Aws::S3::ClientApi::SessionExpiration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::TimestampShape) + +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#566 +Aws::S3::ClientApi::SessionMode = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) + +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#567 Aws::S3::ClientApi::Setting = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#545 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#568 +Aws::S3::ClientApi::SimplePrefix = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) + +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#569 Aws::S3::ClientApi::Size = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#546 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#570 Aws::S3::ClientApi::SkipValidation = T.let(T.unsafe(nil), Seahorse::Model::Shapes::BooleanShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#547 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#571 Aws::S3::ClientApi::SourceSelectionCriteria = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#548 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#572 Aws::S3::ClientApi::SseKmsEncryptedObjects = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#549 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#573 Aws::S3::ClientApi::SseKmsEncryptedObjectsStatus = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#550 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#574 Aws::S3::ClientApi::Start = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#551 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#575 Aws::S3::ClientApi::StartAfter = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#552 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#576 Aws::S3::ClientApi::Stats = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#553 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#577 Aws::S3::ClientApi::StatsEvent = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#554 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#578 Aws::S3::ClientApi::StorageClass = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#555 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#579 Aws::S3::ClientApi::StorageClassAnalysis = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#556 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#580 Aws::S3::ClientApi::StorageClassAnalysisDataExport = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#557 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#581 Aws::S3::ClientApi::StorageClassAnalysisSchemaVersion = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#558 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#582 Aws::S3::ClientApi::Suffix = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#559 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#583 Aws::S3::ClientApi::Tag = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#560 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#584 Aws::S3::ClientApi::TagCount = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#561 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#585 Aws::S3::ClientApi::TagSet = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#562 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#586 Aws::S3::ClientApi::Tagging = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#563 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#587 Aws::S3::ClientApi::TaggingDirective = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#564 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#588 Aws::S3::ClientApi::TaggingHeader = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#565 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#589 Aws::S3::ClientApi::TargetBucket = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#566 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#590 Aws::S3::ClientApi::TargetGrant = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#567 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#591 Aws::S3::ClientApi::TargetGrants = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#568 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#592 +Aws::S3::ClientApi::TargetObjectKeyFormat = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) + +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#593 Aws::S3::ClientApi::TargetPrefix = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#569 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#594 Aws::S3::ClientApi::Tier = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#570 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#595 Aws::S3::ClientApi::Tiering = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#571 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#596 Aws::S3::ClientApi::TieringList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#572 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#597 Aws::S3::ClientApi::Token = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#573 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#598 Aws::S3::ClientApi::TopicArn = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#574 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#599 Aws::S3::ClientApi::TopicConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#575 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#600 Aws::S3::ClientApi::TopicConfigurationDeprecated = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#576 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#601 Aws::S3::ClientApi::TopicConfigurationList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#577 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#602 Aws::S3::ClientApi::Transition = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#578 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#603 Aws::S3::ClientApi::TransitionList = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#579 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#604 Aws::S3::ClientApi::TransitionStorageClass = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#580 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#605 Aws::S3::ClientApi::Type = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#581 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#606 Aws::S3::ClientApi::URI = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#582 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#607 Aws::S3::ClientApi::UploadIdMarker = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#583 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#608 Aws::S3::ClientApi::UploadPartCopyOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#584 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#609 Aws::S3::ClientApi::UploadPartCopyRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#585 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#610 Aws::S3::ClientApi::UploadPartOutput = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#586 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#611 Aws::S3::ClientApi::UploadPartRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#587 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#612 Aws::S3::ClientApi::UserMetadata = T.let(T.unsafe(nil), Seahorse::Model::Shapes::ListShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#588 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#613 Aws::S3::ClientApi::Value = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#589 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#614 Aws::S3::ClientApi::VersionCount = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#590 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#615 Aws::S3::ClientApi::VersionIdMarker = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#591 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#616 Aws::S3::ClientApi::VersioningConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#592 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#617 Aws::S3::ClientApi::WebsiteConfiguration = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#593 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#618 Aws::S3::ClientApi::WebsiteRedirectLocation = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StringShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#594 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#619 Aws::S3::ClientApi::WriteGetObjectResponseRequest = T.let(T.unsafe(nil), Seahorse::Model::Shapes::StructureShape) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#595 +# source://aws-sdk-s3//lib/aws-sdk-s3/client_api.rb#620 Aws::S3::ClientApi::Years = T.let(T.unsafe(nil), Seahorse::Model::Shapes::IntegerShape) # source://aws-sdk-s3//lib/aws-sdk-s3/encryption.rb#21 @@ -17237,7 +18587,7 @@ class Aws::S3::Encryption::Client # @param options [Hash] a customizable set of options # @return [Client] a new instance of Client # - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core/deprecations.rb#65 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core/deprecations.rb#65 def initialize(*args, &block); end # source://forwardable/1.3.3/forwardable.rb#231 @@ -19061,13 +20411,13 @@ end # Endpoint parameters used to influence endpoints per request. # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoint_parameters.rb#73 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoint_parameters.rb#98 class Aws::S3::EndpointParameters < ::Struct include ::Aws::Structure # @return [EndpointParameters] a new instance of EndpointParameters # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoint_parameters.rb#107 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoint_parameters.rb#142 def initialize(options = T.unsafe(nil)); end # When true, use S3 Accelerate. NOTE: Not all regions support S3 accelerate. @@ -19090,6 +20440,16 @@ class Aws::S3::EndpointParameters < ::Struct # @return [String] def bucket=(_); end + # The Copy Source used for Copy Object request. This is an optional parameter that will be set automatically for operations that are scoped to Copy Source. + # + # @return [String] + def copy_source; end + + # The Copy Source used for Copy Object request. This is an optional parameter that will be set automatically for operations that are scoped to Copy Source. + # + # @return [String] + def copy_source=(_); end + # Internal parameter to disable Access Point Buckets # # @return [Boolean] @@ -19110,6 +20470,16 @@ class Aws::S3::EndpointParameters < ::Struct # @return [Boolean] def disable_multi_region_access_points=(_); end + # Parameter to indicate whether S3Express session auth should be disabled + # + # @return [Boolean] + def disable_s3_express_session_auth; end + + # Parameter to indicate whether S3Express session auth should be disabled + # + # @return [Boolean] + def disable_s3_express_session_auth=(_); end + # Override the endpoint used to send this request # # @return [String] @@ -19127,8 +20497,28 @@ class Aws::S3::EndpointParameters < ::Struct # When true, force a path-style endpoint to be used where the bucket name is part of the path. # - # @return [Boolean] - def force_path_style=(_); end + # @return [Boolean] + def force_path_style=(_); end + + # The S3 Key used to send the request. This is an optional parameter that will be set automatically for operations that are scoped to an S3 Key. + # + # @return [String] + def key; end + + # The S3 Key used to send the request. This is an optional parameter that will be set automatically for operations that are scoped to an S3 Key. + # + # @return [String] + def key=(_); end + + # The S3 Prefix used to send the request. This is an optional parameter that will be set automatically for operations that are scoped to an S3 Prefix. + # + # @return [String] + def prefix; end + + # The S3 Prefix used to send the request. This is an optional parameter that will be set automatically for operations that are scoped to an S3 Prefix. + # + # @return [String] + def prefix=(_); end # The AWS region used to dispatch the request. # @@ -19190,6 +20580,16 @@ class Aws::S3::EndpointParameters < ::Struct # @return [Boolean] def use_object_lambda_endpoint=(_); end + # Internal parameter to indicate whether S3Express operation should use control plane, (ex. CreateBucket) + # + # @return [Boolean] + def use_s3_express_control_endpoint; end + + # Internal parameter to indicate whether S3Express operation should use control plane, (ex. CreateBucket) + # + # @return [Boolean] + def use_s3_express_control_endpoint=(_); end + class << self def [](*_arg0); end def inspect; end @@ -19226,1152 +20626,1176 @@ end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#37 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#42 class Aws::S3::Endpoints::CompleteMultipartUpload class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#38 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#43 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#59 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#69 class Aws::S3::Endpoints::CopyObject class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#60 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#70 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#81 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#96 class Aws::S3::Endpoints::CreateBucket class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#82 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#97 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#103 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#123 class Aws::S3::Endpoints::CreateMultipartUpload class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#104 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#124 + def build(context); end + end +end + +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#150 +class Aws::S3::Endpoints::CreateSession + class << self + # @api private + # + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#151 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#125 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#177 class Aws::S3::Endpoints::DeleteBucket class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#126 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#178 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#147 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#204 class Aws::S3::Endpoints::DeleteBucketAnalyticsConfiguration class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#148 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#205 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#169 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#231 class Aws::S3::Endpoints::DeleteBucketCors class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#170 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#232 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#191 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#258 class Aws::S3::Endpoints::DeleteBucketEncryption class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#192 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#259 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#213 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#285 class Aws::S3::Endpoints::DeleteBucketIntelligentTieringConfiguration class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#214 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#286 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#235 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#312 class Aws::S3::Endpoints::DeleteBucketInventoryConfiguration class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#236 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#313 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#257 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#339 class Aws::S3::Endpoints::DeleteBucketLifecycle class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#258 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#340 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#279 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#366 class Aws::S3::Endpoints::DeleteBucketMetricsConfiguration class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#280 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#367 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#301 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#393 class Aws::S3::Endpoints::DeleteBucketOwnershipControls class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#302 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#394 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#323 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#420 class Aws::S3::Endpoints::DeleteBucketPolicy class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#324 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#421 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#345 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#447 class Aws::S3::Endpoints::DeleteBucketReplication class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#346 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#448 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#367 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#474 class Aws::S3::Endpoints::DeleteBucketTagging class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#368 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#475 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#389 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#501 class Aws::S3::Endpoints::DeleteBucketWebsite class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#390 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#502 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#411 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#528 class Aws::S3::Endpoints::DeleteObject class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#412 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#529 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#433 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#555 class Aws::S3::Endpoints::DeleteObjectTagging class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#434 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#556 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#455 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#582 class Aws::S3::Endpoints::DeleteObjects class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#456 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#583 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#477 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#609 class Aws::S3::Endpoints::DeletePublicAccessBlock class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#478 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#610 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#499 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#636 class Aws::S3::Endpoints::GetBucketAccelerateConfiguration class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#500 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#637 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#521 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#663 class Aws::S3::Endpoints::GetBucketAcl class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#522 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#664 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#543 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#690 class Aws::S3::Endpoints::GetBucketAnalyticsConfiguration class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#544 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#691 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#565 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#717 class Aws::S3::Endpoints::GetBucketCors class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#566 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#718 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#587 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#744 class Aws::S3::Endpoints::GetBucketEncryption class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#588 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#745 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#609 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#771 class Aws::S3::Endpoints::GetBucketIntelligentTieringConfiguration class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#610 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#772 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#631 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#798 class Aws::S3::Endpoints::GetBucketInventoryConfiguration class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#632 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#799 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#653 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#825 class Aws::S3::Endpoints::GetBucketLifecycle class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#654 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#826 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#675 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#852 class Aws::S3::Endpoints::GetBucketLifecycleConfiguration class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#676 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#853 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#697 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#879 class Aws::S3::Endpoints::GetBucketLocation class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#698 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#880 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#719 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#906 class Aws::S3::Endpoints::GetBucketLogging class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#720 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#907 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#741 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#933 class Aws::S3::Endpoints::GetBucketMetricsConfiguration class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#742 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#934 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#763 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#960 class Aws::S3::Endpoints::GetBucketNotification class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#764 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#961 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#785 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#987 class Aws::S3::Endpoints::GetBucketNotificationConfiguration class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#786 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#988 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#807 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1014 class Aws::S3::Endpoints::GetBucketOwnershipControls class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#808 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1015 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#829 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1041 class Aws::S3::Endpoints::GetBucketPolicy class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#830 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1042 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#851 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1068 class Aws::S3::Endpoints::GetBucketPolicyStatus class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#852 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1069 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#873 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1095 class Aws::S3::Endpoints::GetBucketReplication class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#874 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1096 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#895 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1122 class Aws::S3::Endpoints::GetBucketRequestPayment class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#896 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1123 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#917 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1149 class Aws::S3::Endpoints::GetBucketTagging class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#918 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1150 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#939 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1176 class Aws::S3::Endpoints::GetBucketVersioning class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#940 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1177 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#961 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1203 class Aws::S3::Endpoints::GetBucketWebsite class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#962 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1204 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#983 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1230 class Aws::S3::Endpoints::GetObject class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#984 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1231 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1005 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1257 class Aws::S3::Endpoints::GetObjectAcl class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1006 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1258 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1027 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1284 class Aws::S3::Endpoints::GetObjectAttributes class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1028 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1285 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1049 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1311 class Aws::S3::Endpoints::GetObjectLegalHold class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1050 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1312 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1071 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1338 class Aws::S3::Endpoints::GetObjectLockConfiguration class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1072 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1339 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1093 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1365 class Aws::S3::Endpoints::GetObjectRetention class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1094 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1366 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1115 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1392 class Aws::S3::Endpoints::GetObjectTagging class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1116 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1393 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1137 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1419 class Aws::S3::Endpoints::GetObjectTorrent class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1138 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1420 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1159 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1446 class Aws::S3::Endpoints::GetPublicAccessBlock class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1160 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1447 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1181 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1473 class Aws::S3::Endpoints::HeadBucket class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1182 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1474 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1203 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1500 class Aws::S3::Endpoints::HeadObject class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1204 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1501 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1225 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1527 class Aws::S3::Endpoints::ListBucketAnalyticsConfigurations class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1226 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1528 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1247 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1554 class Aws::S3::Endpoints::ListBucketIntelligentTieringConfigurations class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1248 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1555 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1269 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1581 class Aws::S3::Endpoints::ListBucketInventoryConfigurations class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1270 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1582 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1291 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1608 class Aws::S3::Endpoints::ListBucketMetricsConfigurations class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1292 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1609 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1313 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1635 class Aws::S3::Endpoints::ListBuckets class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1314 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1636 + def build(context); end + end +end + +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1662 +class Aws::S3::Endpoints::ListDirectoryBuckets + class << self + # @api private + # + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1663 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1335 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1689 class Aws::S3::Endpoints::ListMultipartUploads class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1336 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1690 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1357 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1716 class Aws::S3::Endpoints::ListObjectVersions class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1358 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1717 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1379 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1743 class Aws::S3::Endpoints::ListObjects class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1380 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1744 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1401 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1770 class Aws::S3::Endpoints::ListObjectsV2 class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1402 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1771 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1423 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1797 class Aws::S3::Endpoints::ListParts class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1424 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1798 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1445 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1824 class Aws::S3::Endpoints::PutBucketAccelerateConfiguration class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1446 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1825 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1467 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1851 class Aws::S3::Endpoints::PutBucketAcl class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1468 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1852 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1489 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1878 class Aws::S3::Endpoints::PutBucketAnalyticsConfiguration class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1490 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1879 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1511 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1905 class Aws::S3::Endpoints::PutBucketCors class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1512 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1906 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1533 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1932 class Aws::S3::Endpoints::PutBucketEncryption class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1534 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1933 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1555 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1959 class Aws::S3::Endpoints::PutBucketIntelligentTieringConfiguration class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1556 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1960 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1577 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1986 class Aws::S3::Endpoints::PutBucketInventoryConfiguration class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1578 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1987 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1599 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2013 class Aws::S3::Endpoints::PutBucketLifecycle class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1600 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2014 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1621 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2040 class Aws::S3::Endpoints::PutBucketLifecycleConfiguration class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1622 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2041 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1643 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2067 class Aws::S3::Endpoints::PutBucketLogging class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1644 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2068 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1665 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2094 class Aws::S3::Endpoints::PutBucketMetricsConfiguration class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1666 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2095 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1687 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2121 class Aws::S3::Endpoints::PutBucketNotification class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1688 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2122 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1709 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2148 class Aws::S3::Endpoints::PutBucketNotificationConfiguration class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1710 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2149 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1731 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2175 class Aws::S3::Endpoints::PutBucketOwnershipControls class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1732 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2176 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1753 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2202 class Aws::S3::Endpoints::PutBucketPolicy class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1754 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2203 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1775 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2229 class Aws::S3::Endpoints::PutBucketReplication class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1776 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2230 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1797 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2256 class Aws::S3::Endpoints::PutBucketRequestPayment class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1798 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2257 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1819 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2283 class Aws::S3::Endpoints::PutBucketTagging class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1820 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2284 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1841 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2310 class Aws::S3::Endpoints::PutBucketVersioning class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1842 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2311 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1863 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2337 class Aws::S3::Endpoints::PutBucketWebsite class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1864 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2338 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1885 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2364 class Aws::S3::Endpoints::PutObject class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1886 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2365 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1907 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2391 class Aws::S3::Endpoints::PutObjectAcl class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1908 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2392 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1929 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2418 class Aws::S3::Endpoints::PutObjectLegalHold class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1930 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2419 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1951 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2445 class Aws::S3::Endpoints::PutObjectLockConfiguration class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1952 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2446 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1973 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2472 class Aws::S3::Endpoints::PutObjectRetention class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1974 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2473 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1995 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2499 class Aws::S3::Endpoints::PutObjectTagging class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#1996 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2500 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2017 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2526 class Aws::S3::Endpoints::PutPublicAccessBlock class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2018 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2527 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2039 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2553 class Aws::S3::Endpoints::RestoreObject class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2040 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2554 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2061 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2580 class Aws::S3::Endpoints::SelectObjectContent class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2062 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2581 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2083 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2607 class Aws::S3::Endpoints::UploadPart class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2084 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2608 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2105 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2634 class Aws::S3::Endpoints::UploadPartCopy class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2106 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2635 def build(context); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2127 +# source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2661 class Aws::S3::Endpoints::WriteGetObjectResponse class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2128 + # source://aws-sdk-s3//lib/aws-sdk-s3/endpoints.rb#2662 def build(context); end end end @@ -20433,6 +21857,20 @@ class Aws::S3::Errors::BucketAlreadyOwnedByYou < ::Aws::S3::Errors::ServiceError def initialize(context, message, data = T.unsafe(nil)); end end +# Hijack PermanentRedirect (HeadBucket case - no body) dynamic error to +# include the region. +# +# source://aws-sdk-s3//lib/aws-sdk-s3/customizations/errors.rb#28 +class Aws::S3::Errors::Http301Error < ::Aws::S3::Errors::ServiceError + # @param context [Seahorse::Client::RequestContext] + # @param message [String] + # @param _data [Aws::S3::Types::PermanentRedirect] + # @return [Http301Error] a new instance of Http301Error + # + # source://aws-sdk-s3//lib/aws-sdk-s3/customizations/errors.rb#32 + def initialize(context, message, _data = T.unsafe(nil)); end +end + # source://aws-sdk-s3//lib/aws-sdk-s3/errors.rb#65 class Aws::S3::Errors::InvalidObjectState < ::Aws::S3::Errors::ServiceError # @param context [Seahorse::Client::RequestContext] @@ -20509,8 +21947,8 @@ class Aws::S3::Errors::ObjectNotInActiveTierError < ::Aws::S3::Errors::ServiceEr def initialize(context, message, data = T.unsafe(nil)); end end -# Hijack PermanentRedirect dynamic error to also include endpoint -# and bucket. +# Hijack PermanentRedirect dynamic error to include the bucket, region, +# and endpoint. # # source://aws-sdk-s3//lib/aws-sdk-s3/customizations/errors.rb#8 class Aws::S3::Errors::PermanentRedirect < ::Aws::S3::Errors::ServiceError @@ -20570,6 +22008,93 @@ class Aws::S3::EventStreams::SelectObjectContentEventStream def on_unknown_event(&block); end end +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/express_credentials.rb#8 +class Aws::S3::ExpressCredentials + include ::Aws::CredentialProvider + include ::Aws::RefreshingCredentials + + # @api private + # @return [ExpressCredentials] a new instance of ExpressCredentials + # + # source://aws-sdk-s3//lib/aws-sdk-s3/express_credentials.rb#15 + def initialize(options = T.unsafe(nil)); end + + # @api private + # @return [S3::Client] + # + # source://aws-sdk-s3//lib/aws-sdk-s3/express_credentials.rb#28 + def client; end + + private + + # @api private + # + # source://aws-sdk-s3//lib/aws-sdk-s3/express_credentials.rb#32 + def refresh; end + + class << self + # @api private + # + # source://aws-sdk-s3//lib/aws-sdk-s3/express_credentials.rb#45 + def create_session_options; end + end +end + +# 2 minutes +# +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/express_credentials.rb#13 +Aws::S3::ExpressCredentials::ASYNC_EXPIRATION_LENGTH = T.let(T.unsafe(nil), Integer) + +# 1 minute +# +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/express_credentials.rb#12 +Aws::S3::ExpressCredentials::SYNC_EXPIRATION_LENGTH = T.let(T.unsafe(nil), Integer) + +# Returns Credentials class for S3 Express. Accepts CreateSession +# params as options. See {Client#create_session} for details. +# +# source://aws-sdk-s3//lib/aws-sdk-s3/express_credentials_provider.rb#12 +class Aws::S3::ExpressCredentialsProvider + # @option options + # @option options + # @option options + # @option options + # @param options [Hash] + # @return [ExpressCredentialsProvider] a new instance of ExpressCredentialsProvider + # + # source://aws-sdk-s3//lib/aws-sdk-s3/express_credentials_provider.rb#21 + def initialize(options = T.unsafe(nil)); end + + # Returns the value of attribute client. + # + # source://aws-sdk-s3//lib/aws-sdk-s3/express_credentials_provider.rb#38 + def client; end + + # Sets the attribute client + # + # @param value the value to set the attribute client to. + # + # source://aws-sdk-s3//lib/aws-sdk-s3/express_credentials_provider.rb#38 + def client=(_arg0); end + + # source://aws-sdk-s3//lib/aws-sdk-s3/express_credentials_provider.rb#30 + def express_credentials_for(bucket); end + + private + + # source://aws-sdk-s3//lib/aws-sdk-s3/express_credentials_provider.rb#42 + def cached_credentials_for(bucket); end + + # source://aws-sdk-s3//lib/aws-sdk-s3/express_credentials_provider.rb#50 + def new_credentials_for(bucket); end +end + # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#11 @@ -20595,57 +22120,62 @@ class Aws::S3::FileDownloader # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#131 + # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#133 def batches(chunks, mode); end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#121 + # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#123 def compute_chunk(file_size); end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#98 + # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#100 def compute_mode(file_size, count); end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#108 + # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#110 def construct_chunks(file_size); end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#78 + # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#165 + def download_in_threads(pending, total_size); end + + # @api private + # + # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#80 def multipart_download; end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#140 - def multithreaded_get_by_parts(parts); end + # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#158 + def multithreaded_get_by_parts(n_parts, total_size); end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#136 - def multithreaded_get_by_ranges(chunks); end + # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#138 + def multithreaded_get_by_ranges(file_size); end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#168 - def single_request; end + # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#218 + def single_part_progress; end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#144 - def thread_batches(chunks, param); end + # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#204 + def single_request; end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#67 + # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#69 def validate!; end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#162 + # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#198 def write(resp); end end @@ -20659,6 +22189,62 @@ Aws::S3::FileDownloader::MAX_PARTS = T.let(T.unsafe(nil), Integer) # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#13 Aws::S3::FileDownloader::MIN_CHUNK_SIZE = T.let(T.unsafe(nil), Integer) +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#254 +class Aws::S3::FileDownloader::MultipartProgress + # @api private + # @return [MultipartProgress] a new instance of MultipartProgress + # + # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#255 + def initialize(parts, total_size, progress_callback); end + + # @api private + # + # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#262 + def call(part_number, bytes_received, total); end +end + +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#224 +class Aws::S3::FileDownloader::Part < ::Struct + include ::Aws::Structure +end + +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#229 +class Aws::S3::FileDownloader::PartList + include ::Enumerable + + # @api private + # @return [PartList] a new instance of PartList + # + # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#231 + def initialize(parts = T.unsafe(nil)); end + + # @api private + # + # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#244 + def clear!; end + + # @api private + # + # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#248 + def each(&block); end + + # @api private + # + # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#236 + def shift; end + + # @api private + # + # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#240 + def size; end +end + # @api private # # source://aws-sdk-s3//lib/aws-sdk-s3/file_downloader.rb#15 @@ -20952,7 +22538,7 @@ class Aws::S3::MultipartFileUploader # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_file_uploader.rb#130 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_file_uploader.rb#131 def complete_opts(options); end # @api private @@ -20967,12 +22553,12 @@ class Aws::S3::MultipartFileUploader # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_file_uploader.rb#101 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_file_uploader.rb#102 def compute_parts(upload_id, source, options); end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_file_uploader.rb#123 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_file_uploader.rb#124 def create_opts(options); end # @api private @@ -20987,12 +22573,12 @@ class Aws::S3::MultipartFileUploader # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_file_uploader.rb#144 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_file_uploader.rb#145 def upload_in_threads(pending, completed, options); end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_file_uploader.rb#137 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_file_uploader.rb#138 def upload_part_opts(options); end # @api private @@ -21116,57 +22702,58 @@ class Aws::S3::MultipartStreamUploader # @api private # @option options # @option options + # @option options # @param options [Hash] a customizable set of options # @return [Seahorse::Client::Response] - the CompleteMultipartUploadResponse # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_stream_uploader.rb#47 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_stream_uploader.rb#48 def upload(options = T.unsafe(nil), &block); end private # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_stream_uploader.rb#98 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_stream_uploader.rb#99 def abort_upload(upload_id, options, errors); end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_stream_uploader.rb#127 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_stream_uploader.rb#129 def complete_opts(options); end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_stream_uploader.rb#61 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_stream_uploader.rb#62 def complete_upload(upload_id, parts, options); end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_stream_uploader.rb#113 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_stream_uploader.rb#115 def create_opts(options); end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_stream_uploader.rb#57 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_stream_uploader.rb#58 def initiate_upload(options); end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_stream_uploader.rb#134 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_stream_uploader.rb#136 def read_to_part_body(read_pipe); end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_stream_uploader.rb#151 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_stream_uploader.rb#153 def upload_in_threads(read_pipe, completed, options, thread_errors); end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_stream_uploader.rb#120 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_stream_uploader.rb#122 def upload_part_opts(options); end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_stream_uploader.rb#70 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_stream_uploader.rb#71 def upload_parts(upload_id, options, &block); end end @@ -21228,10 +22815,10 @@ class Aws::S3::MultipartUpload # @param options [Hash] ({}) # @return [Types::AbortMultipartUploadOutput] # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#249 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#265 def abort(options = T.unsafe(nil)); end - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#371 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#406 def basic_complete(options = T.unsafe(nil)); end # @return [String] @@ -21243,12 +22830,12 @@ class Aws::S3::MultipartUpload # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#92 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#102 def checksum_algorithm; end # @return [Client] # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#99 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#109 def client; end # @example Request syntax with placeholder values @@ -21295,16 +22882,16 @@ class Aws::S3::MultipartUpload # @raise [NotImplementedError] Raises when {#data_loaded?} is `false`. # @return [Types::MultipartUpload] Returns the data for this {MultipartUpload}. # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#114 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#124 def data; end # @return [Boolean] Returns `true` if this resource is loaded. Accessing attributes or # {#data} on an unloaded resource will trigger a call to {#load}. # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#122 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#132 def data_loaded?; end - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#492 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#545 def deprecated_identifiers; end # @return [String] @@ -21315,7 +22902,7 @@ class Aws::S3::MultipartUpload # @api private # @deprecated # - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core/deprecations.rb#65 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core/deprecations.rb#65 def identifiers(*args, &block); end # Date and time at which the multipart upload was initiated. @@ -21329,7 +22916,7 @@ class Aws::S3::MultipartUpload # # @return [Types::Initiator] # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#86 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#96 def initiator; end # Key of the object for which the multipart upload was initiated. @@ -21342,12 +22929,12 @@ class Aws::S3::MultipartUpload # @api private # @raise [NotImplementedError] # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#105 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#115 def load; end # @return [Object] # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#390 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#425 def object; end # @return [String] @@ -21358,15 +22945,20 @@ class Aws::S3::MultipartUpload # Specifies the owner of the object that is part of the multipart # upload. # + # **Directory buckets** - The bucket owner is returned as the object + # owner for all the objects. + # + # + # # @return [Types::Owner] # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#80 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#90 def owner; end # @param part_number [String] # @return [MultipartUploadPart] # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#400 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#435 def part(part_number); end # @example Request syntax with placeholder values @@ -21386,20 +22978,25 @@ class Aws::S3::MultipartUpload # @param options [Hash] ({}) # @return [MultipartUploadPart::Collection] # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#462 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#515 def parts(options = T.unsafe(nil)); end # @api private # @raise [NotImplementedError] # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#105 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#115 def reload; end # The class of storage used to store the object. # + # **Directory buckets** - Only the S3 Express One Zone storage class is + # supported by directory buckets to store objects. + # + # + # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#73 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#78 def storage_class; end # Upload ID that identifies the multipart upload. @@ -21486,7 +23083,7 @@ class Aws::S3::MultipartUpload # @return [Resource] if the waiter was successful # @yieldparam resource [Resource] to be used in the waiting condition. # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#206 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#216 def wait_until(options = T.unsafe(nil), &block); end private @@ -21494,17 +23091,17 @@ class Aws::S3::MultipartUpload # source://aws-sdk-s3//lib/aws-sdk-s3/customizations/multipart_upload.rb#36 def compute_parts; end - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#503 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#556 def extract_bucket_name(args, options); end - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#525 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#578 def extract_id(args, options); end - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#514 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#567 def extract_object_key(args, options); end end -# source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#536 +# source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload.rb#589 class Aws::S3::MultipartUpload::Collection < ::Aws::Resources::Collection; end # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_error.rb#5 @@ -21553,10 +23150,13 @@ class Aws::S3::MultipartUploadPart def checksum_crc32; end # The base64-encoded, 32-bit CRC32C checksum of the object. This will - # only be present if it was uploaded with the object. With multipart - # uploads, this may not be a checksum value of the object. For more - # information about how checksums are calculated with multipart uploads, - # see [ Checking object integrity][1] in the *Amazon S3 User Guide*. + # only be present if it was uploaded with the object. When you use an + # API operation on an object that was uploaded using multipart uploads, + # this value may not be a direct checksum value of the full object. + # Instead, it's a calculation based on the checksum values of each + # individual part. For more information about how checksums are + # calculated with multipart uploads, see [ Checking object integrity][1] + # in the *Amazon S3 User Guide*. # # # @@ -21564,14 +23164,17 @@ class Aws::S3::MultipartUploadPart # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#103 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#106 def checksum_crc32c; end # The base64-encoded, 160-bit SHA-1 digest of the object. This will only - # be present if it was uploaded with the object. With multipart uploads, - # this may not be a checksum value of the object. For more information - # about how checksums are calculated with multipart uploads, see [ - # Checking object integrity][1] in the *Amazon S3 User Guide*. + # be present if it was uploaded with the object. When you use the API + # operation on an object that was uploaded using multipart uploads, this + # value may not be a direct checksum value of the full object. Instead, + # it's a calculation based on the checksum values of each individual + # part. For more information about how checksums are calculated with + # multipart uploads, see [ Checking object integrity][1] in the *Amazon + # S3 User Guide*. # # # @@ -21579,7 +23182,7 @@ class Aws::S3::MultipartUploadPart # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#117 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#123 def checksum_sha1; end # This header can be used as a data integrity check to verify that the @@ -21594,12 +23197,12 @@ class Aws::S3::MultipartUploadPart # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#131 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#137 def checksum_sha256; end # @return [Client] # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#138 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#144 def client; end # @example Request syntax with placeholder values @@ -21639,22 +23242,22 @@ class Aws::S3::MultipartUploadPart # @param options [Hash] ({}) # @return [Types::UploadPartCopyOutput] # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#393 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#496 def copy_from(options = T.unsafe(nil)); end # @raise [NotImplementedError] Raises when {#data_loaded?} is `false`. # @return [Types::Part] Returns the data for this {MultipartUploadPart}. # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#153 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#159 def data; end # @return [Boolean] Returns `true` if this resource is loaded. Accessing attributes or # {#data} on an unloaded resource will trigger a call to {#load}. # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#161 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#167 def data_loaded?; end - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#548 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#673 def deprecated_identifiers; end # Entity tag returned when the part was uploaded. @@ -21667,7 +23270,7 @@ class Aws::S3::MultipartUploadPart # @api private # @deprecated # - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core/deprecations.rb#65 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core/deprecations.rb#65 def identifiers(*args, &block); end # Date and time at which the part was uploaded. @@ -21680,12 +23283,12 @@ class Aws::S3::MultipartUploadPart # @api private # @raise [NotImplementedError] # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#144 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#150 def load; end # @return [MultipartUpload] # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#537 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#662 def multipart_upload; end # @return [String] @@ -21706,7 +23309,7 @@ class Aws::S3::MultipartUploadPart # @api private # @raise [NotImplementedError] # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#144 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#150 def reload; end # Size in bytes of the uploaded part data. @@ -21749,7 +23352,7 @@ class Aws::S3::MultipartUploadPart # @param options [Hash] ({}) # @return [Types::UploadPartOutput] # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#521 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#646 def upload(options = T.unsafe(nil)); end # Waiter polls an API operation until a resource enters a desired @@ -21829,25 +23432,25 @@ class Aws::S3::MultipartUploadPart # @return [Resource] if the waiter was successful # @yieldparam resource [Resource] to be used in the waiting condition. # - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#245 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#251 def wait_until(options = T.unsafe(nil), &block); end private - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#560 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#685 def extract_bucket_name(args, options); end - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#582 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#707 def extract_multipart_upload_id(args, options); end - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#571 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#696 def extract_object_key(args, options); end - # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#593 + # source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#718 def extract_part_number(args, options); end end -# source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#604 +# source://aws-sdk-s3//lib/aws-sdk-s3/multipart_upload_part.rb#729 class Aws::S3::MultipartUploadPart::Collection < ::Aws::Resources::Collection; end # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#12 @@ -21865,32 +23468,40 @@ class Aws::S3::Object # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#55 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#59 def accept_ranges; end # @return [ObjectAcl] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#1722 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#2966 def acl; end # The archive state of the head object. # + # This functionality is not supported for directory buckets. + # + # + # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#96 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#119 def archive_status; end # @return [Bucket] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#1731 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#2975 def bucket; end # Indicates whether the object uses an S3 Bucket Key for server-side # encryption with Key Management Service (KMS) keys (SSE-KMS). # + # This functionality is not supported for directory buckets. + # + # + # # @return [Boolean] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#283 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#351 def bucket_key_enabled; end # @return [String] @@ -21902,14 +23513,17 @@ class Aws::S3::Object # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#193 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#236 def cache_control; end # The base64-encoded, 32-bit CRC32 checksum of the object. This will - # only be present if it was uploaded with the object. With multipart - # uploads, this may not be a checksum value of the object. For more - # information about how checksums are calculated with multipart uploads, - # see [ Checking object integrity][1] in the *Amazon S3 User Guide*. + # only be present if it was uploaded with the object. When you use an + # API operation on an object that was uploaded using multipart uploads, + # this value may not be a direct checksum value of the full object. + # Instead, it's a calculation based on the checksum values of each + # individual part. For more information about how checksums are + # calculated with multipart uploads, see [ Checking object integrity][1] + # in the *Amazon S3 User Guide*. # # # @@ -21917,14 +23531,17 @@ class Aws::S3::Object # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#122 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#148 def checksum_crc32; end # The base64-encoded, 32-bit CRC32C checksum of the object. This will - # only be present if it was uploaded with the object. With multipart - # uploads, this may not be a checksum value of the object. For more - # information about how checksums are calculated with multipart uploads, - # see [ Checking object integrity][1] in the *Amazon S3 User Guide*. + # only be present if it was uploaded with the object. When you use an + # API operation on an object that was uploaded using multipart uploads, + # this value may not be a direct checksum value of the full object. + # Instead, it's a calculation based on the checksum values of each + # individual part. For more information about how checksums are + # calculated with multipart uploads, see [ Checking object integrity][1] + # in the *Amazon S3 User Guide*. # # # @@ -21932,14 +23549,17 @@ class Aws::S3::Object # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#136 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#165 def checksum_crc32c; end # The base64-encoded, 160-bit SHA-1 digest of the object. This will only - # be present if it was uploaded with the object. With multipart uploads, - # this may not be a checksum value of the object. For more information - # about how checksums are calculated with multipart uploads, see [ - # Checking object integrity][1] in the *Amazon S3 User Guide*. + # be present if it was uploaded with the object. When you use the API + # operation on an object that was uploaded using multipart uploads, this + # value may not be a direct checksum value of the full object. Instead, + # it's a calculation based on the checksum values of each individual + # part. For more information about how checksums are calculated with + # multipart uploads, see [ Checking object integrity][1] in the *Amazon + # S3 User Guide*. # # # @@ -21947,14 +23567,17 @@ class Aws::S3::Object # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#150 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#182 def checksum_sha1; end # The base64-encoded, 256-bit SHA-256 digest of the object. This will - # only be present if it was uploaded with the object. With multipart - # uploads, this may not be a checksum value of the object. For more - # information about how checksums are calculated with multipart uploads, - # see [ Checking object integrity][1] in the *Amazon S3 User Guide*. + # only be present if it was uploaded with the object. When you use an + # API operation on an object that was uploaded using multipart uploads, + # this value may not be a direct checksum value of the full object. + # Instead, it's a calculation based on the checksum values of each + # individual part. For more information about how checksums are + # calculated with multipart uploads, see [ Checking object integrity][1] + # in the *Amazon S3 User Guide*. # # # @@ -21962,49 +23585,49 @@ class Aws::S3::Object # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#164 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#199 def checksum_sha256; end # @return [Client] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#399 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#492 def client; end # Specifies presentational information for the object. # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#199 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#242 def content_disposition; end - # Specifies what content encodings have been applied to the object and + # Indicates what content encodings have been applied to the object and # thus what decoding mechanisms must be applied to obtain the media-type # referenced by the Content-Type header field. # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#207 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#250 def content_encoding; end # The language the content is in. # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#213 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#256 def content_language; end # Size of the body in bytes. # # @return [Integer] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#108 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#131 def content_length; end # A standard MIME type describing the format of the object data. # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#219 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#262 def content_type; end # @example Request syntax with placeholder values @@ -22033,7 +23656,7 @@ class Aws::S3::Object # metadata_directive: "COPY", # accepts COPY, REPLACE # tagging_directive: "COPY", # accepts COPY, REPLACE # server_side_encryption: "AES256", # accepts AES256, aws:kms, aws:kms:dsse - # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW + # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW, EXPRESS_ONEZONE # website_redirect_location: "WebsiteRedirectLocation", # sse_customer_algorithm: "SSECustomerAlgorithm", # sse_customer_key: "SSECustomerKey", @@ -22132,13 +23755,13 @@ class Aws::S3::Object # @return [Types::HeadObjectOutput] Returns the data for this {Object}. Calls # {Client#head_object} if {#data_loaded?} is `false`. # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#424 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#517 def data; end # @return [Boolean] Returns `true` if this resource is loaded. Accessing attributes or # {#data} on an unloaded resource will trigger a call to {#load}. # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#432 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#525 def data_loaded?; end # @example Request syntax with placeholder values @@ -22158,19 +23781,23 @@ class Aws::S3::Object # @param options [Hash] ({}) # @return [Types::DeleteObjectOutput] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#891 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#1410 def delete(options = T.unsafe(nil)); end # Specifies whether the object retrieved was (true) or was not (false) a # Delete Marker. If false, this response header does not appear in the # response. # + # This functionality is not supported for directory buckets. + # + # + # # @return [Boolean] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#49 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#53 def delete_marker; end - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#1762 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#3006 def deprecated_identifiers; end # Downloads a file in S3 to a path on disk. @@ -22184,6 +23811,16 @@ class Aws::S3::Object # # and the parts are downloaded in parallel # obj.download_file('/path/to/very_large_file') # + # You can provide a callback to monitor progress of the download: + # + # # bytes and part_sizes are each an array with 1 entry per part + # # part_sizes may not be known until the first bytes are retrieved + # progress = Proc.new do |bytes, part_sizes, file_size| + # puts bytes.map.with_index { |b, i| "Part #{i+1}: #{b} / #{part_sizes[i]}"}.join(' ') + "Total: #{100.0 * bytes.sum / file_size}%" } + # end + # obj.download_file('/path/to/file', progress_callback: progress) + # + # @option options # @option options # @option options # @option options @@ -22191,11 +23828,14 @@ class Aws::S3::Object # @option options # @option options # @param destination [String] Where to download the file to. - # @param options [Hash] a customizable set of options + # @param options [Hash] Additional options for {Client#get_object} and #{Client#head_object} + # may be provided. # @return [Boolean] Returns `true` when the file is downloaded without # any errors. + # @see Client#get_object + # @see Client#head_object # - # source://aws-sdk-s3//lib/aws-sdk-s3/customizations/object.rb#510 + # source://aws-sdk-s3//lib/aws-sdk-s3/customizations/object.rb#552 def download_file(destination, options = T.unsafe(nil)); end # An entity tag (ETag) is an opaque identifier assigned by a web server @@ -22203,35 +23843,44 @@ class Aws::S3::Object # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#171 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#206 def etag; end # @param options [Hash] ({}) # @return [Boolean] Returns `true` if the Object exists. # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#439 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#532 def exists?(options = T.unsafe(nil)); end - # If the object expiration is configured (see PUT Bucket lifecycle), the - # response includes this header. It includes the `expiry-date` and - # `rule-id` key-value pairs providing object expiration information. The - # value of the `rule-id` is URL-encoded. + # If the object expiration is configured (see [ + # `PutBucketLifecycleConfiguration` ][1]), the response includes this + # header. It includes the `expiry-date` and `rule-id` key-value pairs + # providing object expiration information. The value of the `rule-id` is + # URL-encoded. + # + # This functionality is not supported for directory buckets. + # + # + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#64 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#77 def expiration; end # The date and time at which the object is no longer cacheable. # # @return [Time] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#225 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#268 def expires; end # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#230 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#273 def expires_string; end # @example Request syntax with placeholder values @@ -22279,7 +23928,7 @@ class Aws::S3::Object # @param options [Hash] ({}) # @return [Types::GetObjectOutput] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#1000 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#1666 def get(options = T.unsafe(nil), &block); end # @example Request syntax with placeholder values @@ -22290,6 +23939,12 @@ class Aws::S3::Object # if_none_match: "IfNoneMatch", # if_unmodified_since: Time.now, # range: "Range", + # response_cache_control: "ResponseCacheControl", + # response_content_disposition: "ResponseContentDisposition", + # response_content_encoding: "ResponseContentEncoding", + # response_content_language: "ResponseContentLanguage", + # response_content_type: "ResponseContentType", + # response_expires: Time.now, # version_id: "ObjectVersionId", # sse_customer_algorithm: "SSECustomerAlgorithm", # sse_customer_key: "SSECustomerKey", @@ -22312,16 +23967,22 @@ class Aws::S3::Object # @option options # @option options # @option options + # @option options + # @option options + # @option options + # @option options + # @option options + # @option options # @param options [Hash] ({}) # @return [Types::HeadObjectOutput] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#1708 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#2952 def head(options = T.unsafe(nil)); end # @api private # @deprecated # - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core/deprecations.rb#65 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core/deprecations.rb#65 def identifiers(*args, &block); end # @example Request syntax with placeholder values @@ -22342,7 +24003,7 @@ class Aws::S3::Object # "MetadataKey" => "MetadataValue", # }, # server_side_encryption: "AES256", # accepts AES256, aws:kms, aws:kms:dsse - # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW + # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW, EXPRESS_ONEZONE # website_redirect_location: "WebsiteRedirectLocation", # sse_customer_algorithm: "SSECustomerAlgorithm", # sse_customer_key: "SSECustomerKey", @@ -22389,7 +24050,7 @@ class Aws::S3::Object # @param options [Hash] ({}) # @return [MultipartUpload] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#1172 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#2151 def initiate_multipart_upload(options = T.unsafe(nil)); end # @return [String] @@ -22397,11 +24058,11 @@ class Aws::S3::Object # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#41 def key; end - # Creation date of the object. + # Date and time when the object was last modified. # # @return [Time] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#102 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#125 def last_modified; end # Loads, or reloads {#data} for the current {Object}. @@ -22411,14 +24072,14 @@ class Aws::S3::Object # # @return [self] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#409 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#502 def load; end # A map of metadata to store with the object in S3. # # @return [Hash] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#251 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#303 def metadata; end # This is set to the number of metadata entries not returned in @@ -22427,9 +24088,13 @@ class Aws::S3::Object # For example, using SOAP, you can create metadata whose values are not # legal HTTP headers. # + # This functionality is not supported for directory buckets. + # + # + # # @return [Integer] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#181 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#220 def missing_meta; end # Copies and deletes the current object. The object will only be deleted @@ -22451,7 +24116,7 @@ class Aws::S3::Object # @param id [String] # @return [MultipartUpload] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#1740 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#2984 def multipart_upload(id); end # Specifies whether a legal hold is in effect for this object. This @@ -22460,13 +24125,17 @@ class Aws::S3::Object # specified version of this object has never had a legal hold applied. # For more information about S3 Object Lock, see [Object Lock][1]. # + # This functionality is not supported for directory buckets. + # + # + # # # # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#392 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#485 def object_lock_legal_hold_status; end # The Object Lock mode, if any, that's in effect for this object. This @@ -22474,22 +24143,30 @@ class Aws::S3::Object # `s3:GetObjectRetention` permission. For more information about S3 # Object Lock, see [Object Lock][1]. # + # This functionality is not supported for directory buckets. + # + # + # # # # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#370 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#455 def object_lock_mode; end # The date and time when the Object Lock retention period expires. This # header is only returned if the requester has the # `s3:GetObjectRetention` permission. # + # This functionality is not supported for directory buckets. + # + # + # # @return [Time] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#378 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#467 def object_lock_retain_until_date; end # The count of parts this object has. This value is only returned if you @@ -22498,7 +24175,7 @@ class Aws::S3::Object # # @return [Integer] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#357 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#438 def parts_count; end # Creates a {PresignedPost} that makes it easy to upload a file from @@ -22680,7 +24357,7 @@ class Aws::S3::Object # "MetadataKey" => "MetadataValue", # }, # server_side_encryption: "AES256", # accepts AES256, aws:kms, aws:kms:dsse - # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW + # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW, EXPRESS_ONEZONE # website_redirect_location: "WebsiteRedirectLocation", # sse_customer_algorithm: "SSECustomerAlgorithm", # sse_customer_key: "SSECustomerKey", @@ -22733,7 +24410,7 @@ class Aws::S3::Object # @param options [Hash] ({}) # @return [Types::PutObjectOutput] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#1485 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#2622 def put(options = T.unsafe(nil)); end # Loads, or reloads {#data} for the current {Object}. @@ -22743,7 +24420,7 @@ class Aws::S3::Object # # @return [self] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#409 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#502 def reload; end # Amazon S3 can return this header if your request involves a bucket @@ -22783,21 +24460,29 @@ class Aws::S3::Object # # For more information, see [Replication][1]. # + # This functionality is not supported for directory buckets. + # + # + # # # # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#349 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#430 def replication_status; end # If present, indicates that the requester was successfully charged for # the request. # + # This functionality is not supported for directory buckets. + # + # + # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#304 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#381 def request_charged; end # If the object is an archived object (an object whose storage class is @@ -22817,6 +24502,12 @@ class Aws::S3::Object # For more information about archiving objects, see [Transitioning # Objects: General Considerations][2]. # + # This functionality is not supported for directory buckets. Only the S3 + # Express One Zone storage class is supported by directory buckets to + # store objects. + # + # + # # # # [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html @@ -22824,7 +24515,7 @@ class Aws::S3::Object # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#90 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#109 def restore; end # @example Request syntax with placeholder values @@ -22908,7 +24599,7 @@ class Aws::S3::Object # value: "MetadataValue", # }, # ], - # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW + # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW, EXPRESS_ONEZONE # }, # }, # }, @@ -22924,46 +24615,63 @@ class Aws::S3::Object # @param options [Hash] ({}) # @return [Types::RestoreObjectOutput] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#1620 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#2763 def restore_object(options = T.unsafe(nil)); end - # The server-side encryption algorithm used when storing this object in - # Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`). + # The server-side encryption algorithm used when you store this object + # in Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`). + # + # For directory buckets, only server-side encryption with Amazon S3 + # managed keys (SSE-S3) (`AES256`) is supported. + # + # # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#245 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#297 def server_side_encryption; end - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#108 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#131 def size; end # If server-side encryption with a customer-provided encryption key was - # requested, the response will include this header confirming the - # encryption algorithm used. + # requested, the response will include this header to confirm the + # encryption algorithm that's used. + # + # This functionality is not supported for directory buckets. + # + # # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#259 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#315 def sse_customer_algorithm; end # If server-side encryption with a customer-provided encryption key was - # requested, the response will include this header to provide round-trip - # message integrity verification of the customer-provided encryption - # key. + # requested, the response will include this header to provide the + # round-trip message integrity verification of the customer-provided + # encryption key. + # + # This functionality is not supported for directory buckets. + # + # # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#268 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#328 def sse_customer_key_md5; end - # If present, specifies the ID of the Key Management Service (KMS) + # If present, indicates the ID of the Key Management Service (KMS) # symmetric encryption customer managed key that was used for the # object. # + # This functionality is not supported for directory buckets. + # + # + # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#276 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#340 def ssekms_key_id; end # Provides storage class information of the object. Amazon S3 returns @@ -22972,13 +24680,18 @@ class Aws::S3::Object # # For more information, see [Storage Classes][1]. # + # Directory buckets - Only the S3 Express One Zone storage class + # is supported by directory buckets to store objects. + # + # + # # # # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#297 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#370 def storage_class; end # Uploads a file from disk to the current object in S3. @@ -23018,7 +24731,11 @@ class Aws::S3::Object # you are responsible for closing it after the upload completes. When # using an open Tempfile, rewind it before uploading or else the object # will be empty. - # @param options [Hash] a customizable set of options + # @param options [Hash] Additional options for {Client#put_object} + # when file sizes below the multipart threshold. For files larger than + # the multipart threshold, options for {Client#create_multipart_upload}, + # {Client#complete_multipart_upload}, + # and {Client#upload_part} can be provided. # @raise [MultipartUploadError] If an object is being uploaded in # parts, and the upload can not be completed, then the upload is # aborted and this error is raised. The raised error has a `#errors` @@ -23026,9 +24743,13 @@ class Aws::S3::Object # aborted. # @return [Boolean] Returns `true` when the object is uploaded # without any errors. + # @see Client#put_object + # @see Client#create_multipart_upload + # @see Client#complete_multipart_upload + # @see Client#upload_part # @yield [response] # - # source://aws-sdk-s3//lib/aws-sdk-s3/customizations/object.rb#451 + # source://aws-sdk-s3//lib/aws-sdk-s3/customizations/object.rb#470 def upload_file(source, options = T.unsafe(nil)); end # Uploads a stream in a streaming fashion to the current object in S3. @@ -23055,7 +24776,9 @@ class Aws::S3::Object # @option options # @option options # @option options - # @param options [Hash] a customizable set of options + # @param options [Hash] Additional options for {Client#create_multipart_upload}, + # {Client#complete_multipart_upload}, + # and {Client#upload_part} can be provided. # @raise [MultipartUploadError] If an object is being uploaded in # parts, and the upload can not be completed, then the upload is # aborted and this error is raised. The raised error has a `#errors` @@ -23063,21 +24786,28 @@ class Aws::S3::Object # aborted. # @return [Boolean] Returns `true` when the object is uploaded # without any errors. + # @see Client#create_multipart_upload + # @see Client#complete_multipart_upload + # @see Client#upload_part # - # source://aws-sdk-s3//lib/aws-sdk-s3/customizations/object.rb#378 + # source://aws-sdk-s3//lib/aws-sdk-s3/customizations/object.rb#385 def upload_stream(options = T.unsafe(nil), &block); end # @param id [String] # @return [ObjectVersion] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#1751 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#2995 def version(id); end - # Version of the object. + # Version ID of the object. + # + # This functionality is not supported for directory buckets. + # + # # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#187 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#230 def version_id; end # Waiter polls an API operation until a resource enters a desired @@ -23157,7 +24887,7 @@ class Aws::S3::Object # @return [Resource] if the waiter was successful # @yieldparam resource [Resource] to be used in the waiting condition. # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#572 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#665 def wait_until(options = T.unsafe(nil), &block); end # @option options @@ -23167,7 +24897,7 @@ class Aws::S3::Object # @param options [Hash] ({}) # @return [Object] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#456 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#549 def wait_until_exists(options = T.unsafe(nil), &block); end # @option options @@ -23177,36 +24907,40 @@ class Aws::S3::Object # @param options [Hash] ({}) # @return [Object] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#477 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#570 def wait_until_not_exists(options = T.unsafe(nil), &block); end # If the bucket is configured as a website, redirects requests for this # object to another object in the same bucket or to an external URL. # Amazon S3 stores the value of this header in the object metadata. # + # This functionality is not supported for directory buckets. + # + # + # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#238 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#285 def website_redirect_location; end private - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#1772 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#3016 def extract_bucket_name(args, options); end - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#1783 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#3027 def extract_key(args, options); end - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#1804 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#3048 def separate_params_and_options(options); end # @yield [waiter.waiter] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#1794 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#3038 def yield_waiter_and_warn(waiter, &block); end end -# source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#1821 +# source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#3065 class Aws::S3::Object::Collection < ::Aws::Resources::Collection # @example Request syntax with placeholder values # @@ -23225,13 +24959,13 @@ class Aws::S3::Object::Collection < ::Aws::Resources::Collection # @param options [{}] # @return [void] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#1877 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#3164 def batch_delete!(options = T.unsafe(nil)); end - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core/deprecations.rb#65 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core/deprecations.rb#65 def delete(*args, &block); end - # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#1877 + # source://aws-sdk-s3//lib/aws-sdk-s3/object.rb#3164 def deprecated_delete(options = T.unsafe(nil)); end end @@ -23253,22 +24987,22 @@ class Aws::S3::ObjectAcl # @return [Client] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_acl.rb#67 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_acl.rb#71 def client; end # @return [Types::GetObjectAclOutput] Returns the data for this {ObjectAcl}. Calls # {Client#get_object_acl} if {#data_loaded?} is `false`. # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_acl.rb#92 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_acl.rb#96 def data; end # @return [Boolean] Returns `true` if this resource is loaded. Accessing attributes or # {#data} on an unloaded resource will trigger a call to {#load}. # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_acl.rb#100 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_acl.rb#104 def data_loaded?; end - # source://aws-sdk-s3//lib/aws-sdk-s3/object_acl.rb#340 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_acl.rb#354 def deprecated_identifiers; end # A list of grants. @@ -23281,7 +25015,7 @@ class Aws::S3::ObjectAcl # @api private # @deprecated # - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core/deprecations.rb#65 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core/deprecations.rb#65 def identifiers(*args, &block); end # Loads, or reloads {#data} for the current {ObjectAcl}. @@ -23291,12 +25025,12 @@ class Aws::S3::ObjectAcl # # @return [self] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_acl.rb#77 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_acl.rb#81 def load; end # @return [Object] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_acl.rb#330 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_acl.rb#344 def object; end # @return [String] @@ -23359,7 +25093,7 @@ class Aws::S3::ObjectAcl # @param options [Hash] ({}) # @return [Types::PutObjectAclOutput] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_acl.rb#316 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_acl.rb#330 def put(options = T.unsafe(nil)); end # Loads, or reloads {#data} for the current {ObjectAcl}. @@ -23369,15 +25103,19 @@ class Aws::S3::ObjectAcl # # @return [self] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_acl.rb#77 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_acl.rb#81 def reload; end # If present, indicates that the requester was successfully charged for # the request. # + # This functionality is not supported for directory buckets. + # + # + # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_acl.rb#60 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_acl.rb#64 def request_charged; end # Waiter polls an API operation until a resource enters a desired @@ -23457,19 +25195,19 @@ class Aws::S3::ObjectAcl # @return [Resource] if the waiter was successful # @yieldparam resource [Resource] to be used in the waiting condition. # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_acl.rb#184 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_acl.rb#188 def wait_until(options = T.unsafe(nil), &block); end private - # source://aws-sdk-s3//lib/aws-sdk-s3/object_acl.rb#350 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_acl.rb#364 def extract_bucket_name(args, options); end - # source://aws-sdk-s3//lib/aws-sdk-s3/object_acl.rb#361 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_acl.rb#375 def extract_object_key(args, options); end end -# source://aws-sdk-s3//lib/aws-sdk-s3/object_acl.rb#372 +# source://aws-sdk-s3//lib/aws-sdk-s3/object_acl.rb#386 class Aws::S3::ObjectAcl::Collection < ::Aws::Resources::Collection; end # @api private @@ -23638,7 +25376,7 @@ class Aws::S3::ObjectMultipartCopier # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_multipart_copier.rb#160 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_multipart_copier.rb#162 def default_part_size(source_size); end # @api private @@ -23648,7 +25386,7 @@ class Aws::S3::ObjectMultipartCopier # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_multipart_copier.rb#168 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_multipart_copier.rb#170 def options_for(operation_name, options); end # @api private @@ -23664,14 +25402,14 @@ class Aws::S3::ObjectMultipartCopier class << self # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_multipart_copier.rb#176 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_multipart_copier.rb#178 def options_for(shape_name); end end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/object_multipart_copier.rb#180 +# source://aws-sdk-s3//lib/aws-sdk-s3/object_multipart_copier.rb#182 Aws::S3::ObjectMultipartCopier::API_OPTIONS = T.let(T.unsafe(nil), Hash) # @api private @@ -23693,22 +25431,22 @@ Aws::S3::ObjectMultipartCopier::MAX_PARTS = T.let(T.unsafe(nil), Integer) # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/object_multipart_copier.rb#186 +# source://aws-sdk-s3//lib/aws-sdk-s3/object_multipart_copier.rb#188 class Aws::S3::ObjectMultipartCopier::PartQueue # @api private # @return [PartQueue] a new instance of PartQueue # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_multipart_copier.rb#188 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_multipart_copier.rb#190 def initialize(parts = T.unsafe(nil)); end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_multipart_copier.rb#197 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_multipart_copier.rb#199 def clear!; end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_multipart_copier.rb#193 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_multipart_copier.rb#195 def shift; end end @@ -23725,12 +25463,12 @@ class Aws::S3::ObjectSummary # @return [ObjectAcl] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#1343 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#2413 def acl; end # @return [Bucket] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#1352 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#2422 def bucket; end # @return [String] @@ -23742,15 +25480,15 @@ class Aws::S3::ObjectSummary # # @return [Array] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#79 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#83 def checksum_algorithm; end # @return [Client] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#118 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#138 def client; end - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#85 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#89 def content_length; end # @example Request syntax with placeholder values @@ -23779,7 +25517,7 @@ class Aws::S3::ObjectSummary # metadata_directive: "COPY", # accepts COPY, REPLACE # tagging_directive: "COPY", # accepts COPY, REPLACE # server_side_encryption: "AES256", # accepts AES256, aws:kms, aws:kms:dsse - # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW + # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW, EXPRESS_ONEZONE # website_redirect_location: "WebsiteRedirectLocation", # sse_customer_algorithm: "SSECustomerAlgorithm", # sse_customer_key: "SSECustomerKey", @@ -23857,13 +25595,13 @@ class Aws::S3::ObjectSummary # @raise [NotImplementedError] Raises when {#data_loaded?} is `false`. # @return [Types::Object] Returns the data for this {ObjectSummary}. # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#133 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#153 def data; end # @return [Boolean] Returns `true` if this resource is loaded. Accessing attributes or # {#data} on an unloaded resource will trigger a call to {#load}. # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#141 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#161 def data_loaded?; end # @example Request syntax with placeholder values @@ -23883,14 +25621,15 @@ class Aws::S3::ObjectSummary # @param options [Hash] ({}) # @return [Types::DeleteObjectOutput] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#600 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#1046 def delete(options = T.unsafe(nil)); end - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#1392 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#2462 def deprecated_identifiers; end # @param destination [String] Where to download the file to. - # @param options [Hash] a customizable set of options + # @param options [Hash] Additional options for {Client#get_object} and #{Client#head_object} + # may be provided. # @return [Boolean] Returns `true` when the file is downloaded without # any errors. # @see Object#download_file @@ -23920,15 +25659,19 @@ class Aws::S3::ObjectSummary # Services Management Console will upload or copy that object as a # Multipart Upload, and therefore the ETag will not be an MD5 digest. # + # **Directory buckets** - MD5 is not supported by directory buckets. + # + # + # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#73 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#77 def etag; end # @param options [Hash] ({}) # @return [Boolean] Returns `true` if the ObjectSummary exists. # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#148 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#168 def exists?(options = T.unsafe(nil)); end # @example Request syntax with placeholder values @@ -23976,13 +25719,13 @@ class Aws::S3::ObjectSummary # @param options [Hash] ({}) # @return [Types::GetObjectOutput] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#709 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#1302 def get(options = T.unsafe(nil), &block); end # @api private # @deprecated # - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core/deprecations.rb#65 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core/deprecations.rb#65 def identifiers(*args, &block); end # @example Request syntax with placeholder values @@ -24003,7 +25746,7 @@ class Aws::S3::ObjectSummary # "MetadataKey" => "MetadataValue", # }, # server_side_encryption: "AES256", # accepts AES256, aws:kms, aws:kms:dsse - # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW + # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW, EXPRESS_ONEZONE # website_redirect_location: "WebsiteRedirectLocation", # sse_customer_algorithm: "SSECustomerAlgorithm", # sse_customer_key: "SSECustomerKey", @@ -24050,7 +25793,7 @@ class Aws::S3::ObjectSummary # @param options [Hash] ({}) # @return [MultipartUpload] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#881 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#1787 def initiate_multipart_upload(options = T.unsafe(nil)); end # @return [String] @@ -24068,7 +25811,7 @@ class Aws::S3::ObjectSummary # @api private # @raise [NotImplementedError] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#124 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#144 def load; end # @param target [S3::Object, String, Hash] Where to copy the object @@ -24086,19 +25829,24 @@ class Aws::S3::ObjectSummary # @param id [String] # @return [MultipartUpload] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#1361 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#2431 def multipart_upload(id); end # @return [Object] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#1371 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#2441 def object; end # The owner of the object # + # **Directory buckets** - The bucket owner is returned as the object + # owner. + # + # + # # @return [Types::Owner] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#97 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#111 def owner; end # @return [PresignedPost] @@ -24166,7 +25914,7 @@ class Aws::S3::ObjectSummary # "MetadataKey" => "MetadataValue", # }, # server_side_encryption: "AES256", # accepts AES256, aws:kms, aws:kms:dsse - # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW + # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW, EXPRESS_ONEZONE # website_redirect_location: "WebsiteRedirectLocation", # sse_customer_algorithm: "SSECustomerAlgorithm", # sse_customer_key: "SSECustomerKey", @@ -24219,13 +25967,13 @@ class Aws::S3::ObjectSummary # @param options [Hash] ({}) # @return [Types::PutObjectOutput] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#1194 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#2258 def put(options = T.unsafe(nil)); end # @api private # @raise [NotImplementedError] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#124 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#144 def reload; end # @example Request syntax with placeholder values @@ -24309,7 +26057,7 @@ class Aws::S3::ObjectSummary # value: "MetadataValue", # }, # ], - # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW + # storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS, GLACIER_IR, SNOW, EXPRESS_ONEZONE # }, # }, # }, @@ -24325,7 +26073,7 @@ class Aws::S3::ObjectSummary # @param options [Hash] ({}) # @return [Types::RestoreObjectOutput] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#1329 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#2399 def restore_object(options = T.unsafe(nil)); end # Specifies the restoration status of an object. Objects in certain @@ -24334,27 +26082,38 @@ class Aws::S3::ObjectSummary # archived objects, see [ Working with archived objects][1] in the # *Amazon S3 User Guide*. # + # This functionality is not supported for directory buckets. Only the S3 + # Express One Zone storage class is supported by directory buckets to + # store objects. + # + # + # # # # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html # # @return [Types::RestoreStatus] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#111 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#131 def restore_status; end # Size in bytes of the object # # @return [Integer] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#85 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#89 def size; end # The class of storage used to store the object. # + # **Directory buckets** - Only the S3 Express One Zone storage class is + # supported by directory buckets to store objects. + # + # + # # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#91 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#100 def storage_class; end # @param source [String, Pathname, File, Tempfile] A file on the local @@ -24364,7 +26123,11 @@ class Aws::S3::ObjectSummary # you are responsible for closing it after the upload completes. When # using an open Tempfile, rewind it before uploading or else the object # will be empty. - # @param options [Hash] a customizable set of options + # @param options [Hash] Additional options for {Client#put_object} + # when file sizes below the multipart threshold. For files larger than + # the multipart threshold, options for {Client#create_multipart_upload}, + # {Client#complete_multipart_upload}, + # and {Client#upload_part} can be provided. # @return [Boolean] Returns `true` when the object is uploaded # without any errors. # @see Object#upload_file @@ -24382,7 +26145,7 @@ class Aws::S3::ObjectSummary # @param id [String] # @return [ObjectVersion] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#1381 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#2451 def version(id); end # Waiter polls an API operation until a resource enters a desired @@ -24462,7 +26225,7 @@ class Aws::S3::ObjectSummary # @return [Resource] if the waiter was successful # @yieldparam resource [Resource] to be used in the waiting condition. # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#281 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#301 def wait_until(options = T.unsafe(nil), &block); end # @option options @@ -24472,7 +26235,7 @@ class Aws::S3::ObjectSummary # @param options [Hash] ({}) # @return [ObjectSummary] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#165 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#185 def wait_until_exists(options = T.unsafe(nil), &block); end # @option options @@ -24482,27 +26245,27 @@ class Aws::S3::ObjectSummary # @param options [Hash] ({}) # @return [ObjectSummary] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#186 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#206 def wait_until_not_exists(options = T.unsafe(nil), &block); end private - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#1402 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#2472 def extract_bucket_name(args, options); end - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#1413 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#2483 def extract_key(args, options); end - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#1434 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#2504 def separate_params_and_options(options); end # @yield [waiter.waiter] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#1424 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#2494 def yield_waiter_and_warn(waiter, &block); end end -# source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#1451 +# source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#2521 class Aws::S3::ObjectSummary::Collection < ::Aws::Resources::Collection # @example Request syntax with placeholder values # @@ -24521,13 +26284,13 @@ class Aws::S3::ObjectSummary::Collection < ::Aws::Resources::Collection # @param options [{}] # @return [void] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#1507 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#2620 def batch_delete!(options = T.unsafe(nil)); end - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core/deprecations.rb#65 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core/deprecations.rb#65 def delete(*args, &block); end - # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#1507 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_summary.rb#2620 def deprecated_delete(options = T.unsafe(nil)); end end @@ -24586,10 +26349,10 @@ class Aws::S3::ObjectVersion # @param options [Hash] ({}) # @return [Types::DeleteObjectOutput] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_version.rb#286 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_version.rb#300 def delete(options = T.unsafe(nil)); end - # source://aws-sdk-s3//lib/aws-sdk-s3/object_version.rb#504 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_version.rb#734 def deprecated_identifiers; end # The entity tag is an MD5 hash of that version of the object. @@ -24642,7 +26405,7 @@ class Aws::S3::ObjectVersion # @param options [Hash] ({}) # @return [Types::GetObjectOutput] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_version.rb#393 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_version.rb#527 def get(options = T.unsafe(nil), &block); end # @example Request syntax with placeholder values @@ -24653,6 +26416,12 @@ class Aws::S3::ObjectVersion # if_none_match: "IfNoneMatch", # if_unmodified_since: Time.now, # range: "Range", + # response_cache_control: "ResponseCacheControl", + # response_content_disposition: "ResponseContentDisposition", + # response_content_encoding: "ResponseContentEncoding", + # response_content_language: "ResponseContentLanguage", + # response_content_type: "ResponseContentType", + # response_expires: Time.now, # sse_customer_algorithm: "SSECustomerAlgorithm", # sse_customer_key: "SSECustomerKey", # sse_customer_key_md5: "SSECustomerKeyMD5", @@ -24673,10 +26442,16 @@ class Aws::S3::ObjectVersion # @option options # @option options # @option options + # @option options + # @option options + # @option options + # @option options + # @option options + # @option options # @param options [Hash] ({}) # @return [Types::HeadObjectOutput] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_version.rb#479 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_version.rb#709 def head(options = T.unsafe(nil)); end # @return [String] @@ -24687,7 +26462,7 @@ class Aws::S3::ObjectVersion # @api private # @deprecated # - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core/deprecations.rb#65 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core/deprecations.rb#65 def identifiers(*args, &block); end # Specifies whether the object is (true) or is not (false) the latest @@ -24705,7 +26480,7 @@ class Aws::S3::ObjectVersion # source://aws-sdk-s3//lib/aws-sdk-s3/object_version.rb#79 def key; end - # Date and time the object was last modified. + # Date and time when the object was last modified. # # @return [Time] # @@ -24720,7 +26495,7 @@ class Aws::S3::ObjectVersion # @return [Object] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_version.rb#494 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_version.rb#724 def object; end # @return [String] @@ -24859,17 +26634,17 @@ class Aws::S3::ObjectVersion private - # source://aws-sdk-s3//lib/aws-sdk-s3/object_version.rb#515 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_version.rb#745 def extract_bucket_name(args, options); end - # source://aws-sdk-s3//lib/aws-sdk-s3/object_version.rb#537 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_version.rb#767 def extract_id(args, options); end - # source://aws-sdk-s3//lib/aws-sdk-s3/object_version.rb#526 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_version.rb#756 def extract_object_key(args, options); end end -# source://aws-sdk-s3//lib/aws-sdk-s3/object_version.rb#548 +# source://aws-sdk-s3//lib/aws-sdk-s3/object_version.rb#778 class Aws::S3::ObjectVersion::Collection < ::Aws::Resources::Collection # @example Request syntax with placeholder values # @@ -24888,13 +26663,13 @@ class Aws::S3::ObjectVersion::Collection < ::Aws::Resources::Collection # @param options [{}] # @return [void] # - # source://aws-sdk-s3//lib/aws-sdk-s3/object_version.rb#604 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_version.rb#877 def batch_delete!(options = T.unsafe(nil)); end - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core/deprecations.rb#65 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core/deprecations.rb#65 def delete(*args, &block); end - # source://aws-sdk-s3//lib/aws-sdk-s3/object_version.rb#604 + # source://aws-sdk-s3//lib/aws-sdk-s3/object_version.rb#877 def deprecated_delete(options = T.unsafe(nil)); end end @@ -24945,6 +26720,63 @@ class Aws::S3::Plugins::Accelerate::OptionHandler < ::Seahorse::Client::Handler def call(context); end end +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/plugins/access_grants.rb#7 +class Aws::S3::Plugins::AccessGrants < ::Seahorse::Client::Plugin + # @api private + # + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/access_grants.rb#93 + def add_handlers(handlers, config); end + + # @api private + # + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/access_grants.rb#99 + def after_initialize(client); end + + class << self + # @api private + # @return [Boolean] + # + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/access_grants.rb#107 + def s3control?; end + end +end + +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/plugins/access_grants.rb#38 +class Aws::S3::Plugins::AccessGrants::Handler < ::Seahorse::Client::Handler + # @api private + # + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/access_grants.rb#56 + def call(context); end + + private + + # @api private + # @return [Boolean] + # + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/access_grants.rb#83 + def access_grants_operation?(context); end + + # @api private + # @return [Boolean] + # + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/access_grants.rb#88 + def s3_express_endpoint?(context); end + + # @api private + # + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/access_grants.rb#77 + def with_metric(credentials, &block); end +end + +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/plugins/access_grants.rb#39 +Aws::S3::Plugins::AccessGrants::Handler::PERMISSION_MAP = T.let(T.unsafe(nil), Hash) + # Amazon S3 requires DNS style addressing for buckets outside of # the classic region when possible. # @@ -25014,29 +26846,29 @@ end # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/endpoints.rb#13 class Aws::S3::Plugins::Endpoints < ::Seahorse::Client::Plugin - # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/endpoints.rb#257 + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/endpoints.rb#269 def add_handlers(handlers, _config); end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/plugins/endpoints.rb#26 +# source://aws-sdk-s3//lib/aws-sdk-s3/plugins/endpoints.rb#33 class Aws::S3::Plugins::Endpoints::Handler < ::Seahorse::Client::Handler # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/endpoints.rb#27 + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/endpoints.rb#34 def call(context); end private # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/endpoints.rb#46 + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/endpoints.rb#54 def apply_endpoint_headers(context, headers); end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/endpoints.rb#57 + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/endpoints.rb#65 def parameters_for_operation(context); end end @@ -25056,6 +26888,50 @@ class Aws::S3::Plugins::Expect100Continue::Handler < ::Seahorse::Client::Handler def call(context); end end +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/plugins/express_session_auth.rb#7 +class Aws::S3::Plugins::ExpressSessionAuth < ::Seahorse::Client::Plugin + # Optimization - sets this client as the client to create sessions. + # + # @api private + # + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/express_session_auth.rb#71 + def after_initialize(client); end + + class << self + private + + # @api private + # + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/express_session_auth.rb#79 + def resolve_disable_s3_express_session_auth(cfg); end + end +end + +# @api private +# +# source://aws-sdk-s3//lib/aws-sdk-s3/plugins/express_session_auth.rb#30 +class Aws::S3::Plugins::ExpressSessionAuth::Handler < ::Seahorse::Client::Handler + # @api private + # + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/express_session_auth.rb#31 + def call(context); end + + private + + # @api private + # @return [Boolean] + # + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/express_session_auth.rb#61 + def checksum_required?(context); end + + # @api private + # + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/express_session_auth.rb#55 + def with_metric(credentials, &block); end +end + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/get_bucket_location_fix.rb#6 class Aws::S3::Plugins::GetBucketLocationFix < ::Seahorse::Client::Plugin; end @@ -25084,10 +26960,47 @@ class Aws::S3::Plugins::Http200Errors::Handler < ::Seahorse::Client::Handler # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/http_200_errors.rb#16 def call(context); end + private + # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/http_200_errors.rb#26 + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/http_200_errors.rb#72 def check_for_error(context); end + + # Must have a member in the body and have the start of an XML Tag. + # Other incomplete xml bodies will result in an XML ParsingError. + # + # @api private + # @return [Boolean] + # + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/http_200_errors.rb#68 + def incomplete_xml_body?(xml, output); end + + # Checks if the output shape is a structure shape and has members that + # are in the body for the case of a payload and a normal structure. A + # non-structure shape will not have members in the body. In the case + # of a string or blob, the body contents would have been checked first + # before this method is called in incomplete_xml_body?. + # + # @api private + # @return [Boolean] + # + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/http_200_errors.rb#47 + def members_in_body?(output); end + + # Streaming outputs are not subject to 200 errors. + # + # @api private + # @return [Boolean] + # + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/http_200_errors.rb#32 + def streaming_output?(output); end + + # @api private + # @return [Boolean] + # + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/http_200_errors.rb#62 + def structure_shape?(shape); end end # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/iad_regional_endpoint.rb#7 @@ -25125,7 +27038,7 @@ end class Aws::S3::Plugins::Md5s < ::Seahorse::Client::Plugin # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/md5s.rb#72 + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/md5s.rb#73 def add_handlers(handlers, config); end end @@ -25144,12 +27057,12 @@ class Aws::S3::Plugins::Md5s::Handler < ::Seahorse::Client::Handler # @param value [File, Tempfile, IO#read, String] # @return [String] # - # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/md5s.rb#38 + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/md5s.rb#39 def md5(value); end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/md5s.rb#50 + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/md5s.rb#51 def update_in_chunks(digest, io); end end @@ -25296,33 +27209,33 @@ end # # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#12 +# source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#17 class Aws::S3::Plugins::S3Signer < ::Seahorse::Client::Plugin # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#15 + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#20 def add_handlers(handlers, cfg); end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#30 + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#35 def add_legacy_handler(handlers); end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#25 + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#30 def add_v4_handlers(handlers); end class << self # @api private # @return [Boolean] # - # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#165 + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#170 def custom_endpoint?(context); end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#156 + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#161 def new_hostname(context, region); end end end @@ -25335,11 +27248,11 @@ end # # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#71 +# source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#76 class Aws::S3::Plugins::S3Signer::BucketRegionErrorHandler < ::Seahorse::Client::Handler # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#72 + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#77 def call(context); end private @@ -25347,49 +27260,49 @@ class Aws::S3::Plugins::S3Signer::BucketRegionErrorHandler < ::Seahorse::Client: # @api private # @return [Boolean] # - # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#107 + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#112 def expired_credentials?(resp); end # @api private # @return [Boolean] # - # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#103 + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#108 def fips_region?(resp); end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#90 + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#95 def get_region_and_retry(context); end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#79 + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#84 def handle_region_errors(response); end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#142 + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#147 def log_warning(context, actual_region); end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#133 + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#138 def region_from_body(body); end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#117 + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#122 def resign_with_new_region(context, actual_region); end # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#99 + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#104 def update_bucket_cache(context, actual_region); end # @api private # @return [Boolean] # - # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#111 + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#116 def wrong_sigv4_region?(resp); end end @@ -25398,28 +27311,28 @@ end # # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#44 +# source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#49 class Aws::S3::Plugins::S3Signer::CachedBucketRegionHandler < ::Seahorse::Client::Handler # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#45 + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#50 def call(context); end private # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#53 + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#58 def check_for_cached_region(context, bucket); end end # @api private # -# source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#35 +# source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#40 class Aws::S3::Plugins::S3Signer::LegacyHandler < ::Seahorse::Client::Handler # @api private # - # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#36 + # source://aws-sdk-s3//lib/aws-sdk-s3/plugins/s3_signer.rb#41 def call(context); end end @@ -26239,7 +28152,7 @@ class Aws::S3::Resource # @param name [String] # @return [Bucket] # - # source://aws-sdk-s3//lib/aws-sdk-s3/resource.rb#110 + # source://aws-sdk-s3//lib/aws-sdk-s3/resource.rb#182 def bucket(name); end # @example Request syntax with placeholder values @@ -26248,7 +28161,7 @@ class Aws::S3::Resource # @param options [Hash] ({}) # @return [Bucket::Collection] # - # source://aws-sdk-s3//lib/aws-sdk-s3/resource.rb#122 + # source://aws-sdk-s3//lib/aws-sdk-s3/resource.rb#194 def buckets(options = T.unsafe(nil)); end # @return [Client] @@ -26262,7 +28175,15 @@ class Aws::S3::Resource # acl: "private", # accepts private, public-read, public-read-write, authenticated-read # bucket: "BucketName", # required # create_bucket_configuration: { - # location_constraint: "af-south-1", # accepts af-south-1, ap-east-1, ap-northeast-1, ap-northeast-2, ap-northeast-3, ap-south-1, ap-southeast-1, ap-southeast-2, ap-southeast-3, ca-central-1, cn-north-1, cn-northwest-1, EU, eu-central-1, eu-north-1, eu-south-1, eu-west-1, eu-west-2, eu-west-3, me-south-1, sa-east-1, us-east-2, us-gov-east-1, us-gov-west-1, us-west-1, us-west-2, ap-south-2, eu-south-2 + # location_constraint: "af-south-1", # accepts af-south-1, ap-east-1, ap-northeast-1, ap-northeast-2, ap-northeast-3, ap-south-1, ap-south-2, ap-southeast-1, ap-southeast-2, ap-southeast-3, ca-central-1, cn-north-1, cn-northwest-1, EU, eu-central-1, eu-north-1, eu-south-1, eu-south-2, eu-west-1, eu-west-2, eu-west-3, me-south-1, sa-east-1, us-east-2, us-gov-east-1, us-gov-west-1, us-west-1, us-west-2 + # location: { + # type: "AvailabilityZone", # accepts AvailabilityZone + # name: "LocationNameAsString", + # }, + # bucket: { + # data_redundancy: "SingleAvailabilityZone", # accepts SingleAvailabilityZone + # type: "Directory", # accepts Directory + # }, # }, # grant_full_control: "GrantFullControl", # grant_read: "GrantRead", @@ -26285,7 +28206,7 @@ class Aws::S3::Resource # @param options [Hash] ({}) # @return [Bucket] # - # source://aws-sdk-s3//lib/aws-sdk-s3/resource.rb#96 + # source://aws-sdk-s3//lib/aws-sdk-s3/resource.rb#168 def create_bucket(options = T.unsafe(nil)); end end @@ -26317,22 +28238,22 @@ Aws::S3::Types::AbortIncompleteMultipartUpload::SENSITIVE = T.let(T.unsafe(nil), # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/AbortMultipartUploadOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#44 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#48 class Aws::S3::Types::AbortMultipartUploadOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#45 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#49 Aws::S3::Types::AbortMultipartUploadOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/AbortMultipartUploadRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#109 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#138 class Aws::S3::Types::AbortMultipartUploadRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#110 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#139 Aws::S3::Types::AbortMultipartUploadRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # Configures the transfer acceleration state for an Amazon S3 bucket. @@ -26345,12 +28266,12 @@ Aws::S3::Types::AbortMultipartUploadRequest::SENSITIVE = T.let(T.unsafe(nil), Ar # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/AccelerateConfiguration AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#129 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#158 class Aws::S3::Types::AccelerateConfiguration < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#130 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#159 Aws::S3::Types::AccelerateConfiguration::SENSITIVE = T.let(T.unsafe(nil), Array) # Contains the elements that set the ACL permissions for an object per @@ -26358,24 +28279,24 @@ Aws::S3::Types::AccelerateConfiguration::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/AccessControlPolicy AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#149 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#178 class Aws::S3::Types::AccessControlPolicy < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#150 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#179 Aws::S3::Types::AccessControlPolicy::SENSITIVE = T.let(T.unsafe(nil), Array) # A container for information about access control for replicas. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/AccessControlTranslation AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#168 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#197 class Aws::S3::Types::AccessControlTranslation < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#169 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#198 Aws::S3::Types::AccessControlTranslation::SENSITIVE = T.let(T.unsafe(nil), Array) # A conjunction (logical AND) of predicates, which is used in evaluating @@ -26385,12 +28306,12 @@ Aws::S3::Types::AccessControlTranslation::SENSITIVE = T.let(T.unsafe(nil), Array # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/AnalyticsAndOperator AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#191 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#220 class Aws::S3::Types::AnalyticsAndOperator < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#192 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#221 Aws::S3::Types::AnalyticsAndOperator::SENSITIVE = T.let(T.unsafe(nil), Array) # Specifies the configuration and any analyses for the analytics filter @@ -26398,24 +28319,24 @@ Aws::S3::Types::AnalyticsAndOperator::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/AnalyticsConfiguration AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#221 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#250 class Aws::S3::Types::AnalyticsConfiguration < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#222 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#251 Aws::S3::Types::AnalyticsConfiguration::SENSITIVE = T.let(T.unsafe(nil), Array) # Where to publish the analytics results. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/AnalyticsExportDestination AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#235 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#264 class Aws::S3::Types::AnalyticsExportDestination < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#236 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#265 Aws::S3::Types::AnalyticsExportDestination::SENSITIVE = T.let(T.unsafe(nil), Array) # The filter used to describe a set of objects for analyses. A filter @@ -26425,38 +28346,36 @@ Aws::S3::Types::AnalyticsExportDestination::SENSITIVE = T.let(T.unsafe(nil), Arr # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/AnalyticsFilter AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#264 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#293 class Aws::S3::Types::AnalyticsFilter < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#265 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#294 Aws::S3::Types::AnalyticsFilter::SENSITIVE = T.let(T.unsafe(nil), Array) # Contains information about where to publish the analytics results. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/AnalyticsS3BucketDestination AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#302 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#331 class Aws::S3::Types::AnalyticsS3BucketDestination < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#303 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#332 Aws::S3::Types::AnalyticsS3BucketDestination::SENSITIVE = T.let(T.unsafe(nil), Array) -# In terms of implementation, a Bucket is a resource. An Amazon S3 -# bucket name is globally unique, and the namespace is shared by all -# Amazon Web Services accounts. +# In terms of implementation, a Bucket is a resource. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Bucket AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#324 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#351 class Aws::S3::Types::Bucket < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#325 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#352 Aws::S3::Types::Bucket::SENSITIVE = T.let(T.unsafe(nil), Array) # The requested bucket name is not available. The bucket namespace is @@ -26465,7 +28384,7 @@ Aws::S3::Types::Bucket::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/BucketAlreadyExists AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#335 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#362 class Aws::S3::Types::BucketAlreadyExists < ::Aws::EmptyStructure; end # The bucket you tried to create already exists, and you own it. Amazon @@ -26477,9 +28396,31 @@ class Aws::S3::Types::BucketAlreadyExists < ::Aws::EmptyStructure; end # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/BucketAlreadyOwnedByYou AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#346 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#373 class Aws::S3::Types::BucketAlreadyOwnedByYou < ::Aws::EmptyStructure; end +# Specifies the information about the bucket that will be created. For +# more information about directory buckets, see [Directory buckets][1] +# in the *Amazon S3 User Guide*. +# +# This functionality is only supported by directory buckets. +# +# +# +# +# +# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html +# +# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/BucketInfo AWS API Documentation +# +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#400 +class Aws::S3::Types::BucketInfo < ::Struct + include ::Aws::Structure +end + +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#401 +Aws::S3::Types::BucketInfo::SENSITIVE = T.let(T.unsafe(nil), Array) + # Specifies the lifecycle configuration for objects in an Amazon S3 # bucket. For more information, see [Object Lifecycle Management][1] in # the *Amazon S3 User Guide*. @@ -26490,24 +28431,24 @@ class Aws::S3::Types::BucketAlreadyOwnedByYou < ::Aws::EmptyStructure; end # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/BucketLifecycleConfiguration AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#363 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#420 class Aws::S3::Types::BucketLifecycleConfiguration < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#364 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#421 Aws::S3::Types::BucketLifecycleConfiguration::SENSITIVE = T.let(T.unsafe(nil), Array) # Container for logging status information. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/BucketLoggingStatus AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#383 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#440 class Aws::S3::Types::BucketLoggingStatus < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#384 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#441 Aws::S3::Types::BucketLoggingStatus::SENSITIVE = T.let(T.unsafe(nil), Array) # Describes the cross-origin access configuration for objects in an @@ -26520,24 +28461,24 @@ Aws::S3::Types::BucketLoggingStatus::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CORSConfiguration AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#404 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#461 class Aws::S3::Types::CORSConfiguration < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#405 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#462 Aws::S3::Types::CORSConfiguration::SENSITIVE = T.let(T.unsafe(nil), Array) # Specifies a cross-origin access rule for an Amazon S3 bucket. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CORSRule AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#452 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#509 class Aws::S3::Types::CORSRule < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#453 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#510 Aws::S3::Types::CORSRule::SENSITIVE = T.let(T.unsafe(nil), Array) # Describes how an uncompressed comma-separated values (CSV)-formatted @@ -26545,12 +28486,12 @@ Aws::S3::Types::CORSRule::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CSVInput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#527 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#584 class Aws::S3::Types::CSVInput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#528 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#585 Aws::S3::Types::CSVInput::SENSITIVE = T.let(T.unsafe(nil), Array) # Describes how uncompressed comma-separated values (CSV)-formatted @@ -26558,36 +28499,36 @@ Aws::S3::Types::CSVInput::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CSVOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#572 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#629 class Aws::S3::Types::CSVOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#573 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#630 Aws::S3::Types::CSVOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # Contains all the possible checksum or digest values for an object. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Checksum AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#637 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#702 class Aws::S3::Types::Checksum < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#638 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#703 Aws::S3::Types::Checksum::SENSITIVE = T.let(T.unsafe(nil), Array) # Container for specifying the Lambda notification configuration. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CloudFunctionConfiguration AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#674 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#739 class Aws::S3::Types::CloudFunctionConfiguration < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#675 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#740 Aws::S3::Types::CloudFunctionConfiguration::SENSITIVE = T.let(T.unsafe(nil), Array) # Container for all (if there are any) keys between Prefix and the next @@ -26598,56 +28539,56 @@ Aws::S3::Types::CloudFunctionConfiguration::SENSITIVE = T.let(T.unsafe(nil), Arr # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CommonPrefix AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#692 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#757 class Aws::S3::Types::CommonPrefix < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#693 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#758 Aws::S3::Types::CommonPrefix::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CompleteMultipartUploadOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#850 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#929 class Aws::S3::Types::CompleteMultipartUploadOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#851 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#930 Aws::S3::Types::CompleteMultipartUploadOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CompleteMultipartUploadRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1008 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1125 class Aws::S3::Types::CompleteMultipartUploadRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1009 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1126 Aws::S3::Types::CompleteMultipartUploadRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # The container for the completed multipart upload details. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CompletedMultipartUpload AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1025 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1142 class Aws::S3::Types::CompletedMultipartUpload < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1026 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1143 Aws::S3::Types::CompletedMultipartUpload::SENSITIVE = T.let(T.unsafe(nil), Array) # Details of the parts that were uploaded. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CompletedPart AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1101 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1240 class Aws::S3::Types::CompletedPart < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1102 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1241 Aws::S3::Types::CompletedPart::SENSITIVE = T.let(T.unsafe(nil), Array) # A container for describing a condition that must be met for the @@ -26658,120 +28599,140 @@ Aws::S3::Types::CompletedPart::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Condition AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1144 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1283 class Aws::S3::Types::Condition < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1145 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1284 Aws::S3::Types::Condition::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ContinuationEvent AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1152 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1291 class Aws::S3::Types::ContinuationEvent < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1153 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1292 Aws::S3::Types::ContinuationEvent::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CopyObjectOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1229 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1410 class Aws::S3::Types::CopyObjectOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1230 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1411 Aws::S3::Types::CopyObjectOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CopyObjectRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1593 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2211 class Aws::S3::Types::CopyObjectRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1594 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2212 Aws::S3::Types::CopyObjectRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # Container for all response elements. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CopyObjectResult AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1669 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2279 class Aws::S3::Types::CopyObjectResult < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1670 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2280 Aws::S3::Types::CopyObjectResult::SENSITIVE = T.let(T.unsafe(nil), Array) # Container for all response elements. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CopyPartResult AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1744 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2362 class Aws::S3::Types::CopyPartResult < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1745 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2363 Aws::S3::Types::CopyPartResult::SENSITIVE = T.let(T.unsafe(nil), Array) # The configuration information for the bucket. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CreateBucketConfiguration AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1760 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2412 class Aws::S3::Types::CreateBucketConfiguration < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1761 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2413 Aws::S3::Types::CreateBucketConfiguration::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CreateBucketOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1772 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2424 class Aws::S3::Types::CreateBucketOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1773 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2425 Aws::S3::Types::CreateBucketOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CreateBucketRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1849 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2566 class Aws::S3::Types::CreateBucketRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1850 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2567 Aws::S3::Types::CreateBucketRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CreateMultipartUploadOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1975 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2710 class Aws::S3::Types::CreateMultipartUploadOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#1976 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2711 Aws::S3::Types::CreateMultipartUploadOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CreateMultipartUploadRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2226 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3295 class Aws::S3::Types::CreateMultipartUploadRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2227 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3296 Aws::S3::Types::CreateMultipartUploadRequest::SENSITIVE = T.let(T.unsafe(nil), Array) +# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CreateSessionOutput AWS API Documentation +# +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3308 +class Aws::S3::Types::CreateSessionOutput < ::Struct + include ::Aws::Structure +end + +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3309 +Aws::S3::Types::CreateSessionOutput::SENSITIVE = T.let(T.unsafe(nil), Array) + +# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CreateSessionRequest AWS API Documentation +# +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3331 +class Aws::S3::Types::CreateSessionRequest < ::Struct + include ::Aws::Structure +end + +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3332 +Aws::S3::Types::CreateSessionRequest::SENSITIVE = T.let(T.unsafe(nil), Array) + # The container element for specifying the default Object Lock retention # settings for new objects placed in the specified bucket. # @@ -26785,166 +28746,166 @@ Aws::S3::Types::CreateMultipartUploadRequest::SENSITIVE = T.let(T.unsafe(nil), A # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DefaultRetention AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2263 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3368 class Aws::S3::Types::DefaultRetention < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2264 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3369 Aws::S3::Types::DefaultRetention::SENSITIVE = T.let(T.unsafe(nil), Array) # Container for the objects to delete. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Delete AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2283 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3396 class Aws::S3::Types::Delete < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2284 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3397 Aws::S3::Types::Delete::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketAnalyticsConfigurationRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2308 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3422 class Aws::S3::Types::DeleteBucketAnalyticsConfigurationRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2309 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3423 Aws::S3::Types::DeleteBucketAnalyticsConfigurationRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketCorsRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2327 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3442 class Aws::S3::Types::DeleteBucketCorsRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2328 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3443 Aws::S3::Types::DeleteBucketCorsRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketEncryptionRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2347 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3463 class Aws::S3::Types::DeleteBucketEncryptionRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2348 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3464 Aws::S3::Types::DeleteBucketEncryptionRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketIntelligentTieringConfigurationRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2365 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3481 class Aws::S3::Types::DeleteBucketIntelligentTieringConfigurationRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2366 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3482 Aws::S3::Types::DeleteBucketIntelligentTieringConfigurationRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketInventoryConfigurationRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2390 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3507 class Aws::S3::Types::DeleteBucketInventoryConfigurationRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2391 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3508 Aws::S3::Types::DeleteBucketInventoryConfigurationRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketLifecycleRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2409 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3527 class Aws::S3::Types::DeleteBucketLifecycleRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2410 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3528 Aws::S3::Types::DeleteBucketLifecycleRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketMetricsConfigurationRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2436 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3555 class Aws::S3::Types::DeleteBucketMetricsConfigurationRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2437 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3556 Aws::S3::Types::DeleteBucketMetricsConfigurationRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketOwnershipControlsRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2455 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3575 class Aws::S3::Types::DeleteBucketOwnershipControlsRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2456 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3576 Aws::S3::Types::DeleteBucketOwnershipControlsRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketPolicyRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2474 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3615 class Aws::S3::Types::DeleteBucketPolicyRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2475 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3616 Aws::S3::Types::DeleteBucketPolicyRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketReplicationRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2493 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3635 class Aws::S3::Types::DeleteBucketReplicationRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2494 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3636 Aws::S3::Types::DeleteBucketReplicationRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2512 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3675 class Aws::S3::Types::DeleteBucketRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2513 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3676 Aws::S3::Types::DeleteBucketRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketTaggingRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2531 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3695 class Aws::S3::Types::DeleteBucketTaggingRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2532 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3696 Aws::S3::Types::DeleteBucketTaggingRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteBucketWebsiteRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2551 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3716 class Aws::S3::Types::DeleteBucketWebsiteRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2552 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3717 Aws::S3::Types::DeleteBucketWebsiteRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # Information about the delete marker. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteMarkerEntry AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2586 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3751 class Aws::S3::Types::DeleteMarkerEntry < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2587 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3752 Aws::S3::Types::DeleteMarkerEntry::SENSITIVE = T.let(T.unsafe(nil), Array) # Specifies whether Amazon S3 replicates delete markers. If you specify @@ -26972,94 +28933,94 @@ Aws::S3::Types::DeleteMarkerEntry::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteMarkerReplication AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2625 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3790 class Aws::S3::Types::DeleteMarkerReplication < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2626 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3791 Aws::S3::Types::DeleteMarkerReplication::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObjectOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2650 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3829 class Aws::S3::Types::DeleteObjectOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2651 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3830 Aws::S3::Types::DeleteObjectOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObjectRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2730 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3947 class Aws::S3::Types::DeleteObjectRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2731 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3948 Aws::S3::Types::DeleteObjectRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObjectTaggingOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2742 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3959 class Aws::S3::Types::DeleteObjectTaggingOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2743 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3960 Aws::S3::Types::DeleteObjectTaggingOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObjectTaggingRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2796 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4016 class Aws::S3::Types::DeleteObjectTaggingRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2797 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4017 Aws::S3::Types::DeleteObjectTaggingRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObjectsOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2821 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4045 class Aws::S3::Types::DeleteObjectsOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2822 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4046 Aws::S3::Types::DeleteObjectsOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeleteObjectsRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2917 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4205 class Aws::S3::Types::DeleteObjectsRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2918 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4206 Aws::S3::Types::DeleteObjectsRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeletePublicAccessBlockRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2937 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4226 class Aws::S3::Types::DeletePublicAccessBlockRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2938 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4227 Aws::S3::Types::DeletePublicAccessBlockRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # Information about the deleted object. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/DeletedObject AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2972 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4273 class Aws::S3::Types::DeletedObject < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#2973 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4274 Aws::S3::Types::DeletedObject::SENSITIVE = T.let(T.unsafe(nil), Array) # Specifies information about where to publish analysis or configuration @@ -27068,24 +29029,24 @@ Aws::S3::Types::DeletedObject::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Destination AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3049 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4350 class Aws::S3::Types::Destination < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3050 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4351 Aws::S3::Types::Destination::SENSITIVE = T.let(T.unsafe(nil), Array) # Contains the type of server-side encryption used. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Encryption AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3084 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4385 class Aws::S3::Types::Encryption < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3085 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4386 Aws::S3::Types::Encryption::SENSITIVE = T.let(T.unsafe(nil), Array) # Specifies encryption-related information for an Amazon S3 bucket that @@ -27093,12 +29054,12 @@ Aws::S3::Types::Encryption::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/EncryptionConfiguration AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3109 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4410 class Aws::S3::Types::EncryptionConfiguration < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3110 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4411 Aws::S3::Types::EncryptionConfiguration::SENSITIVE = T.let(T.unsafe(nil), Array) # A message that indicates the request is complete and no more messages @@ -27107,36 +29068,36 @@ Aws::S3::Types::EncryptionConfiguration::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/EndEvent AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3121 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4422 class Aws::S3::Types::EndEvent < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3122 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4423 Aws::S3::Types::EndEvent::SENSITIVE = T.let(T.unsafe(nil), Array) # Container for all error elements. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Error AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3957 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5262 class Aws::S3::Types::Error < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3958 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5263 Aws::S3::Types::Error::SENSITIVE = T.let(T.unsafe(nil), Array) # The error information. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ErrorDocument AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3979 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5284 class Aws::S3::Types::ErrorDocument < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3980 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5285 Aws::S3::Types::ErrorDocument::SENSITIVE = T.let(T.unsafe(nil), Array) # A container for specifying the configuration for Amazon EventBridge. @@ -27144,7 +29105,7 @@ Aws::S3::Types::ErrorDocument::SENSITIVE = T.let(T.unsafe(nil), Array) # @api private # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/EventBridgeConfiguration AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#3990 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5295 class Aws::S3::Types::EventBridgeConfiguration < ::Aws::EmptyStructure; end # Optional configuration to replicate existing source bucket objects. @@ -27157,729 +29118,747 @@ class Aws::S3::Types::EventBridgeConfiguration < ::Aws::EmptyStructure; end # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ExistingObjectReplication AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4008 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5313 class Aws::S3::Types::ExistingObjectReplication < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4009 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5314 Aws::S3::Types::ExistingObjectReplication::SENSITIVE = T.let(T.unsafe(nil), Array) -# Specifies the Amazon S3 object key name to filter on and whether to -# filter on the suffix or prefix of the key name. +# Specifies the Amazon S3 object key name to filter on. An object key +# name is the name assigned to an object in your Amazon S3 bucket. You +# specify whether to filter on the suffix or prefix of the object key +# name. A prefix is a specific string of characters at the beginning of +# an object key name, which you can use to organize objects. For +# example, you can start the key names of related objects with a prefix, +# such as `2023-` or `engineering/`. Then, you can use `FilterRule` to +# find objects in a bucket with key names that have the same prefix. A +# suffix is similar to a prefix, but it is at the end of the object key +# name instead of at the beginning. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/FilterRule AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4036 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5349 class Aws::S3::Types::FilterRule < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4037 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5350 Aws::S3::Types::FilterRule::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAccelerateConfigurationOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4054 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5371 class Aws::S3::Types::GetBucketAccelerateConfigurationOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4055 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5372 Aws::S3::Types::GetBucketAccelerateConfigurationOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAccelerateConfigurationRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4087 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5411 class Aws::S3::Types::GetBucketAccelerateConfigurationRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4088 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5412 Aws::S3::Types::GetBucketAccelerateConfigurationRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAclOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4104 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5428 class Aws::S3::Types::GetBucketAclOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4105 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5429 Aws::S3::Types::GetBucketAclOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAclRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4137 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5462 class Aws::S3::Types::GetBucketAclRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4138 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5463 Aws::S3::Types::GetBucketAclRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAnalyticsConfigurationOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4149 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5474 class Aws::S3::Types::GetBucketAnalyticsConfigurationOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4150 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5475 Aws::S3::Types::GetBucketAnalyticsConfigurationOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketAnalyticsConfigurationRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4174 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5500 class Aws::S3::Types::GetBucketAnalyticsConfigurationRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4175 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5501 Aws::S3::Types::GetBucketAnalyticsConfigurationRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketCorsOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4187 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5513 class Aws::S3::Types::GetBucketCorsOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4188 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5514 Aws::S3::Types::GetBucketCorsOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketCorsRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4220 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5547 class Aws::S3::Types::GetBucketCorsRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4221 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5548 Aws::S3::Types::GetBucketCorsRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketEncryptionOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4232 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5559 class Aws::S3::Types::GetBucketEncryptionOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4233 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5560 Aws::S3::Types::GetBucketEncryptionOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketEncryptionRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4252 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5580 class Aws::S3::Types::GetBucketEncryptionRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4253 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5581 Aws::S3::Types::GetBucketEncryptionRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketIntelligentTieringConfigurationOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4264 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5592 class Aws::S3::Types::GetBucketIntelligentTieringConfigurationOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4265 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5593 Aws::S3::Types::GetBucketIntelligentTieringConfigurationOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketIntelligentTieringConfigurationRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4282 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5610 class Aws::S3::Types::GetBucketIntelligentTieringConfigurationRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4283 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5611 Aws::S3::Types::GetBucketIntelligentTieringConfigurationRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketInventoryConfigurationOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4294 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5622 class Aws::S3::Types::GetBucketInventoryConfigurationOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4295 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5623 Aws::S3::Types::GetBucketInventoryConfigurationOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketInventoryConfigurationRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4319 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5648 class Aws::S3::Types::GetBucketInventoryConfigurationRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4320 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5649 Aws::S3::Types::GetBucketInventoryConfigurationRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLifecycleConfigurationOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4331 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5660 class Aws::S3::Types::GetBucketLifecycleConfigurationOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4332 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5661 Aws::S3::Types::GetBucketLifecycleConfigurationOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLifecycleConfigurationRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4350 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5680 class Aws::S3::Types::GetBucketLifecycleConfigurationRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4351 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5681 Aws::S3::Types::GetBucketLifecycleConfigurationRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLifecycleOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4362 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5692 class Aws::S3::Types::GetBucketLifecycleOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4363 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5693 Aws::S3::Types::GetBucketLifecycleOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLifecycleRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4381 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5712 class Aws::S3::Types::GetBucketLifecycleRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4382 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5713 Aws::S3::Types::GetBucketLifecycleRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLocationOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4400 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5731 class Aws::S3::Types::GetBucketLocationOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4401 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5732 Aws::S3::Types::GetBucketLocationOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLocationRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4433 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5765 class Aws::S3::Types::GetBucketLocationRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4434 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5766 Aws::S3::Types::GetBucketLocationRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLoggingOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4451 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5783 class Aws::S3::Types::GetBucketLoggingOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4452 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5784 Aws::S3::Types::GetBucketLoggingOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketLoggingRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4470 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5803 class Aws::S3::Types::GetBucketLoggingRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4471 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5804 Aws::S3::Types::GetBucketLoggingRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketMetricsConfigurationOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4482 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5815 class Aws::S3::Types::GetBucketMetricsConfigurationOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4483 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5816 Aws::S3::Types::GetBucketMetricsConfigurationOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketMetricsConfigurationRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4509 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5843 class Aws::S3::Types::GetBucketMetricsConfigurationRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4510 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5844 Aws::S3::Types::GetBucketMetricsConfigurationRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketNotificationConfigurationRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4543 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5878 class Aws::S3::Types::GetBucketNotificationConfigurationRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4544 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5879 Aws::S3::Types::GetBucketNotificationConfigurationRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketOwnershipControlsOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4556 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5891 class Aws::S3::Types::GetBucketOwnershipControlsOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4557 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5892 Aws::S3::Types::GetBucketOwnershipControlsOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketOwnershipControlsRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4576 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5912 class Aws::S3::Types::GetBucketOwnershipControlsRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4577 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5913 Aws::S3::Types::GetBucketOwnershipControlsRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketPolicyOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4588 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5924 class Aws::S3::Types::GetBucketPolicyOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4589 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5925 Aws::S3::Types::GetBucketPolicyOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketPolicyRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4621 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5981 class Aws::S3::Types::GetBucketPolicyRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4622 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5982 Aws::S3::Types::GetBucketPolicyRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketPolicyStatusOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4633 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5993 class Aws::S3::Types::GetBucketPolicyStatusOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4634 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5994 Aws::S3::Types::GetBucketPolicyStatusOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketPolicyStatusRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4653 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6014 class Aws::S3::Types::GetBucketPolicyStatusRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4654 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6015 Aws::S3::Types::GetBucketPolicyStatusRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketReplicationOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4666 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6027 class Aws::S3::Types::GetBucketReplicationOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4667 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6028 Aws::S3::Types::GetBucketReplicationOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketReplicationRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4685 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6047 class Aws::S3::Types::GetBucketReplicationRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4686 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6048 Aws::S3::Types::GetBucketReplicationRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketRequestPaymentOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4697 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6059 class Aws::S3::Types::GetBucketRequestPaymentOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4698 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6060 Aws::S3::Types::GetBucketRequestPaymentOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketRequestPaymentRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4717 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6080 class Aws::S3::Types::GetBucketRequestPaymentRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4718 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6081 Aws::S3::Types::GetBucketRequestPaymentRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketTaggingOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4729 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6092 class Aws::S3::Types::GetBucketTaggingOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4730 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6093 Aws::S3::Types::GetBucketTaggingOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketTaggingRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4748 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6112 class Aws::S3::Types::GetBucketTaggingRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4749 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6113 Aws::S3::Types::GetBucketTaggingRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketVersioningOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4768 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6132 class Aws::S3::Types::GetBucketVersioningOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4769 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6133 Aws::S3::Types::GetBucketVersioningOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketVersioningRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4787 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6152 class Aws::S3::Types::GetBucketVersioningRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4788 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6153 Aws::S3::Types::GetBucketVersioningRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketWebsiteOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4818 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6183 class Aws::S3::Types::GetBucketWebsiteOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4819 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6184 Aws::S3::Types::GetBucketWebsiteOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetBucketWebsiteRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4837 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6203 class Aws::S3::Types::GetBucketWebsiteRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4838 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6204 Aws::S3::Types::GetBucketWebsiteRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectAclOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4860 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6230 class Aws::S3::Types::GetObjectAclOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4861 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6231 Aws::S3::Types::GetObjectAclOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectAclRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4916 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6299 class Aws::S3::Types::GetObjectAclRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4917 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6300 Aws::S3::Types::GetObjectAclRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectAttributesOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4980 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6380 class Aws::S3::Types::GetObjectAttributesOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#4981 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6381 Aws::S3::Types::GetObjectAttributesOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # A collection of parts associated with a multipart upload. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectAttributesParts AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5025 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6437 class Aws::S3::Types::GetObjectAttributesParts < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5026 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6438 Aws::S3::Types::GetObjectAttributesParts::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectAttributesRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5129 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6585 class Aws::S3::Types::GetObjectAttributesRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5130 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6586 Aws::S3::Types::GetObjectAttributesRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectLegalHoldOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5141 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6597 class Aws::S3::Types::GetObjectLegalHoldOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5142 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6598 Aws::S3::Types::GetObjectLegalHoldOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectLegalHoldRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5199 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6664 class Aws::S3::Types::GetObjectLegalHoldRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5200 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6665 Aws::S3::Types::GetObjectLegalHoldRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectLockConfigurationOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5211 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6676 class Aws::S3::Types::GetObjectLockConfigurationOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5212 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6677 Aws::S3::Types::GetObjectLockConfigurationOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectLockConfigurationRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5243 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6711 class Aws::S3::Types::GetObjectLockConfigurationRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5244 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6712 Aws::S3::Types::GetObjectLockConfigurationRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5503 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7063 class Aws::S3::Types::GetObjectOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5504 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7064 Aws::S3::Types::GetObjectOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5676 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7409 class Aws::S3::Types::GetObjectRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5677 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7410 Aws::S3::Types::GetObjectRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectRetentionOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5688 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7421 class Aws::S3::Types::GetObjectRetentionOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5689 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7422 Aws::S3::Types::GetObjectRetentionOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectRetentionRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5746 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7488 class Aws::S3::Types::GetObjectRetentionRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5747 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7489 Aws::S3::Types::GetObjectRetentionRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectTaggingOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5764 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7506 class Aws::S3::Types::GetObjectTaggingOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5765 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7507 Aws::S3::Types::GetObjectTaggingOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectTaggingRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5831 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7582 class Aws::S3::Types::GetObjectTaggingRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5832 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7583 Aws::S3::Types::GetObjectTaggingRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectTorrentOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5849 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7604 class Aws::S3::Types::GetObjectTorrentOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5850 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7605 Aws::S3::Types::GetObjectTorrentOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectTorrentRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5887 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7649 class Aws::S3::Types::GetObjectTorrentRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5888 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7650 Aws::S3::Types::GetObjectTorrentRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetPublicAccessBlockOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5900 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7662 class Aws::S3::Types::GetPublicAccessBlockOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5901 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7663 Aws::S3::Types::GetPublicAccessBlockOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetPublicAccessBlockRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5920 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7683 class Aws::S3::Types::GetPublicAccessBlockRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5921 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7684 Aws::S3::Types::GetPublicAccessBlockRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # Container for S3 Glacier job parameters. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GlacierJobParameters AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5934 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7697 class Aws::S3::Types::GlacierJobParameters < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5935 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7698 Aws::S3::Types::GlacierJobParameters::SENSITIVE = T.let(T.unsafe(nil), Array) # Container for grant information. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Grant AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5953 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7716 class Aws::S3::Types::Grant < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#5954 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7717 Aws::S3::Types::Grant::SENSITIVE = T.let(T.unsafe(nil), Array) # Container for the person being granted permissions. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Grantee AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6016 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7779 class Aws::S3::Types::Grantee < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6017 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7780 Aws::S3::Types::Grantee::SENSITIVE = T.let(T.unsafe(nil), Array) +# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/HeadBucketOutput AWS API Documentation +# +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7826 +class Aws::S3::Types::HeadBucketOutput < ::Struct + include ::Aws::Structure +end + +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7827 +Aws::S3::Types::HeadBucketOutput::SENSITIVE = T.let(T.unsafe(nil), Array) + # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/HeadBucketRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6066 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7895 class Aws::S3::Types::HeadBucketRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6067 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7896 Aws::S3::Types::HeadBucketRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/HeadObjectOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6396 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8314 class Aws::S3::Types::HeadObjectOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6397 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8315 Aws::S3::Types::HeadObjectOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/HeadObjectRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6533 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8583 class Aws::S3::Types::HeadObjectRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6534 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8584 Aws::S3::Types::HeadObjectRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # Container for the `Suffix` element. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/IndexDocument AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6559 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8610 class Aws::S3::Types::IndexDocument < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6560 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8611 Aws::S3::Types::IndexDocument::SENSITIVE = T.let(T.unsafe(nil), Array) # Container element that identifies who initiated the multipart upload. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Initiator AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6580 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8641 class Aws::S3::Types::Initiator < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6581 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8642 Aws::S3::Types::Initiator::SENSITIVE = T.let(T.unsafe(nil), Array) # Describes the serialization format of the object. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/InputSerialization AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6610 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8671 class Aws::S3::Types::InputSerialization < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6611 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8672 Aws::S3::Types::InputSerialization::SENSITIVE = T.let(T.unsafe(nil), Array) # A container for specifying S3 Intelligent-Tiering filters. The filters @@ -27887,12 +29866,12 @@ Aws::S3::Types::InputSerialization::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/IntelligentTieringAndOperator AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6632 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8693 class Aws::S3::Types::IntelligentTieringAndOperator < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6633 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8694 Aws::S3::Types::IntelligentTieringAndOperator::SENSITIVE = T.let(T.unsafe(nil), Array) # Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 @@ -27908,12 +29887,12 @@ Aws::S3::Types::IntelligentTieringAndOperator::SENSITIVE = T.let(T.unsafe(nil), # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/IntelligentTieringConfiguration AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6672 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8733 class Aws::S3::Types::IntelligentTieringConfiguration < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6673 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8734 Aws::S3::Types::IntelligentTieringConfiguration::SENSITIVE = T.let(T.unsafe(nil), Array) # The `Filter` is used to identify objects that the S3 @@ -27921,24 +29900,38 @@ Aws::S3::Types::IntelligentTieringConfiguration::SENSITIVE = T.let(T.unsafe(nil) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/IntelligentTieringFilter AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6709 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8770 class Aws::S3::Types::IntelligentTieringFilter < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6710 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8771 Aws::S3::Types::IntelligentTieringFilter::SENSITIVE = T.let(T.unsafe(nil), Array) # Object is archived and inaccessible until restored. # +# If the object you are retrieving is stored in the S3 Glacier Flexible +# Retrieval storage class, the S3 Glacier Deep Archive storage class, +# the S3 Intelligent-Tiering Archive Access tier, or the S3 +# Intelligent-Tiering Deep Archive Access tier, before you can retrieve +# the object you must first restore a copy using [RestoreObject][1]. +# Otherwise, this operation returns an `InvalidObjectState` error. For +# information about restoring archived objects, see [Restoring Archived +# Objects][2] in the *Amazon S3 User Guide*. +# +# +# +# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html +# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html +# # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/InvalidObjectState AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6726 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8801 class Aws::S3::Types::InvalidObjectState < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6727 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8802 Aws::S3::Types::InvalidObjectState::SENSITIVE = T.let(T.unsafe(nil), Array) # Specifies the inventory configuration for an Amazon S3 bucket. For @@ -27951,24 +29944,24 @@ Aws::S3::Types::InvalidObjectState::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/InventoryConfiguration AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6784 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8859 class Aws::S3::Types::InventoryConfiguration < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6785 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8860 Aws::S3::Types::InventoryConfiguration::SENSITIVE = T.let(T.unsafe(nil), Array) # Specifies the inventory configuration for an Amazon S3 bucket. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/InventoryDestination AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6799 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8874 class Aws::S3::Types::InventoryDestination < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6800 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8875 Aws::S3::Types::InventoryDestination::SENSITIVE = T.let(T.unsafe(nil), Array) # Contains the type of server-side encryption used to encrypt the @@ -27976,12 +29969,12 @@ Aws::S3::Types::InventoryDestination::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/InventoryEncryption AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6819 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8894 class Aws::S3::Types::InventoryEncryption < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6820 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8895 Aws::S3::Types::InventoryEncryption::SENSITIVE = T.let(T.unsafe(nil), Array) # Specifies an inventory filter. The inventory only includes objects @@ -27989,12 +29982,12 @@ Aws::S3::Types::InventoryEncryption::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/InventoryFilter AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6835 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8910 class Aws::S3::Types::InventoryFilter < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6836 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8911 Aws::S3::Types::InventoryFilter::SENSITIVE = T.let(T.unsafe(nil), Array) # Contains the bucket name, file format, bucket owner (optional), and @@ -28002,60 +29995,60 @@ Aws::S3::Types::InventoryFilter::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/InventoryS3BucketDestination AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6879 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8954 class Aws::S3::Types::InventoryS3BucketDestination < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6880 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8955 Aws::S3::Types::InventoryS3BucketDestination::SENSITIVE = T.let(T.unsafe(nil), Array) # Specifies the schedule for generating inventory results. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/InventorySchedule AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6893 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8968 class Aws::S3::Types::InventorySchedule < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6894 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8969 Aws::S3::Types::InventorySchedule::SENSITIVE = T.let(T.unsafe(nil), Array) # Specifies JSON as object's input serialization format. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/JSONInput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6907 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8982 class Aws::S3::Types::JSONInput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6908 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8983 Aws::S3::Types::JSONInput::SENSITIVE = T.let(T.unsafe(nil), Array) # Specifies JSON as request's output serialization format. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/JSONOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6922 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8997 class Aws::S3::Types::JSONOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6923 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8998 Aws::S3::Types::JSONOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # A container for specifying the configuration for Lambda notifications. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/LambdaFunctionConfiguration AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6966 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9041 class Aws::S3::Types::LambdaFunctionConfiguration < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6967 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9042 Aws::S3::Types::LambdaFunctionConfiguration::SENSITIVE = T.let(T.unsafe(nil), Array) # Container for lifecycle rules. You can add as many as 1000 rules. @@ -28069,12 +30062,12 @@ Aws::S3::Types::LambdaFunctionConfiguration::SENSITIVE = T.let(T.unsafe(nil), Ar # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/LifecycleConfiguration AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6987 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9062 class Aws::S3::Types::LifecycleConfiguration < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#6988 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9063 Aws::S3::Types::LifecycleConfiguration::SENSITIVE = T.let(T.unsafe(nil), Array) # Container for the expiration for the lifecycle of the object. @@ -28088,12 +30081,12 @@ Aws::S3::Types::LifecycleConfiguration::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/LifecycleExpiration AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7024 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9099 class Aws::S3::Types::LifecycleExpiration < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7025 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9100 Aws::S3::Types::LifecycleExpiration::SENSITIVE = T.let(T.unsafe(nil), Array) # A lifecycle rule for individual objects in an Amazon S3 bucket. @@ -28107,12 +30100,12 @@ Aws::S3::Types::LifecycleExpiration::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/LifecycleRule AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7119 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9194 class Aws::S3::Types::LifecycleRule < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7120 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9195 Aws::S3::Types::LifecycleRule::SENSITIVE = T.let(T.unsafe(nil), Array) # This is used in a Lifecycle Rule Filter to apply a logical AND to two @@ -28121,141 +30114,163 @@ Aws::S3::Types::LifecycleRule::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/LifecycleRuleAndOperator AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7151 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9226 class Aws::S3::Types::LifecycleRuleAndOperator < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7152 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9227 Aws::S3::Types::LifecycleRuleAndOperator::SENSITIVE = T.let(T.unsafe(nil), Array) # The `Filter` is used to identify objects that a Lifecycle Rule applies -# to. A `Filter` must have exactly one of `Prefix`, `Tag`, or `And` -# specified. +# to. A `Filter` can have exactly one of `Prefix`, `Tag`, +# `ObjectSizeGreaterThan`, `ObjectSizeLessThan`, or `And` specified. If +# the `Filter` element is left empty, the Lifecycle Rule applies to all +# objects in the bucket. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/LifecycleRuleFilter AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7198 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9275 class Aws::S3::Types::LifecycleRuleFilter < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7199 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9276 Aws::S3::Types::LifecycleRuleFilter::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketAnalyticsConfigurationsOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7233 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9310 class Aws::S3::Types::ListBucketAnalyticsConfigurationsOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7234 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9311 Aws::S3::Types::ListBucketAnalyticsConfigurationsOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketAnalyticsConfigurationsRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7259 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9337 class Aws::S3::Types::ListBucketAnalyticsConfigurationsRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7260 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9338 Aws::S3::Types::ListBucketAnalyticsConfigurationsRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketIntelligentTieringConfigurationsOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7293 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9371 class Aws::S3::Types::ListBucketIntelligentTieringConfigurationsOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7294 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9372 Aws::S3::Types::ListBucketIntelligentTieringConfigurationsOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketIntelligentTieringConfigurationsRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7312 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9390 class Aws::S3::Types::ListBucketIntelligentTieringConfigurationsRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7313 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9391 Aws::S3::Types::ListBucketIntelligentTieringConfigurationsRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketInventoryConfigurationsOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7345 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9423 class Aws::S3::Types::ListBucketInventoryConfigurationsOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7346 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9424 Aws::S3::Types::ListBucketInventoryConfigurationsOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketInventoryConfigurationsRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7373 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9452 class Aws::S3::Types::ListBucketInventoryConfigurationsRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7374 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9453 Aws::S3::Types::ListBucketInventoryConfigurationsRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketMetricsConfigurationsOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7408 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9487 class Aws::S3::Types::ListBucketMetricsConfigurationsOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7409 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9488 Aws::S3::Types::ListBucketMetricsConfigurationsOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketMetricsConfigurationsRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7436 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9516 class Aws::S3::Types::ListBucketMetricsConfigurationsRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7437 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9517 Aws::S3::Types::ListBucketMetricsConfigurationsRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListBucketsOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7453 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9533 class Aws::S3::Types::ListBucketsOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7454 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9534 Aws::S3::Types::ListBucketsOutput::SENSITIVE = T.let(T.unsafe(nil), Array) +# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListDirectoryBucketsOutput AWS API Documentation +# +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9552 +class Aws::S3::Types::ListDirectoryBucketsOutput < ::Struct + include ::Aws::Structure +end + +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9553 +Aws::S3::Types::ListDirectoryBucketsOutput::SENSITIVE = T.let(T.unsafe(nil), Array) + +# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListDirectoryBucketsRequest AWS API Documentation +# +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9574 +class Aws::S3::Types::ListDirectoryBucketsRequest < ::Struct + include ::Aws::Structure +end + +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9575 +Aws::S3::Types::ListDirectoryBucketsRequest::SENSITIVE = T.let(T.unsafe(nil), Array) + # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListMultipartUploadsOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7550 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9703 class Aws::S3::Types::ListMultipartUploadsOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7551 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9704 Aws::S3::Types::ListMultipartUploadsOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListMultipartUploadsRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7668 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9876 class Aws::S3::Types::ListMultipartUploadsRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7669 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9877 Aws::S3::Types::ListMultipartUploadsRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectVersionsOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7770 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9982 class Aws::S3::Types::ListObjectVersionsOutput < ::Struct include ::Aws::Structure @@ -28269,79 +30284,103 @@ class Aws::S3::Types::ListObjectVersionsOutput < ::Struct def versions_delete_markers; end end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7771 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9983 Aws::S3::Types::ListObjectVersionsOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectVersionsRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7859 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10078 class Aws::S3::Types::ListObjectVersionsRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7860 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10079 Aws::S3::Types::ListObjectVersionsRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7956 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10181 class Aws::S3::Types::ListObjectsOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#7957 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10182 Aws::S3::Types::ListObjectsOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8045 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10289 class Aws::S3::Types::ListObjectsRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8046 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10290 Aws::S3::Types::ListObjectsRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsV2Output AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8182 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10440 class Aws::S3::Types::ListObjectsV2Output < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8183 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10441 Aws::S3::Types::ListObjectsV2Output::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsV2Request AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8281 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10597 class Aws::S3::Types::ListObjectsV2Request < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8282 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10598 Aws::S3::Types::ListObjectsV2Request::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListPartsOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8397 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10733 class Aws::S3::Types::ListPartsOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8398 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10734 Aws::S3::Types::ListPartsOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListPartsRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8510 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10883 class Aws::S3::Types::ListPartsRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8511 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10884 Aws::S3::Types::ListPartsRequest::SENSITIVE = T.let(T.unsafe(nil), Array) +# Specifies the location where the bucket will be created. +# +# For directory buckets, the location type is Availability Zone. For +# more information about directory buckets, see [Directory buckets][1] +# in the *Amazon S3 User Guide*. +# +# This functionality is only supported by directory buckets. +# +# +# +# +# +# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-buckets-overview.html +# +# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/LocationInfo AWS API Documentation +# +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10918 +class Aws::S3::Types::LocationInfo < ::Struct + include ::Aws::Structure +end + +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10919 +Aws::S3::Types::LocationInfo::SENSITIVE = T.let(T.unsafe(nil), Array) + # Describes where logs are stored and the prefix that Amazon S3 assigns # to all log object keys for a bucket. For more information, see [PUT # Bucket logging][1] in the *Amazon S3 API Reference*. @@ -28352,24 +30391,24 @@ Aws::S3::Types::ListPartsRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/LoggingEnabled AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8557 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10970 class Aws::S3::Types::LoggingEnabled < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8558 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10971 Aws::S3::Types::LoggingEnabled::SENSITIVE = T.let(T.unsafe(nil), Array) # A metadata key-value pair to store with an object. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/MetadataEntry AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8576 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10989 class Aws::S3::Types::MetadataEntry < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8577 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10990 Aws::S3::Types::MetadataEntry::SENSITIVE = T.let(T.unsafe(nil), Array) # A container specifying replication metrics-related settings enabling @@ -28377,12 +30416,12 @@ Aws::S3::Types::MetadataEntry::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Metrics AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8597 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11010 class Aws::S3::Types::Metrics < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8598 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11011 Aws::S3::Types::Metrics::SENSITIVE = T.let(T.unsafe(nil), Array) # A conjunction (logical AND) of predicates, which is used in evaluating @@ -28392,12 +30431,12 @@ Aws::S3::Types::Metrics::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/MetricsAndOperator AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8624 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11037 class Aws::S3::Types::MetricsAndOperator < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8625 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11038 Aws::S3::Types::MetricsAndOperator::SENSITIVE = T.let(T.unsafe(nil), Array) # Specifies a metrics configuration for the CloudWatch request metrics @@ -28413,12 +30452,12 @@ Aws::S3::Types::MetricsAndOperator::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/MetricsConfiguration AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8657 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11070 class Aws::S3::Types::MetricsConfiguration < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8658 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11071 Aws::S3::Types::MetricsConfiguration::SENSITIVE = T.let(T.unsafe(nil), Array) # Specifies a metrics configuration filter. The metrics configuration @@ -28433,45 +30472,45 @@ Aws::S3::Types::MetricsConfiguration::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/MetricsFilter AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8697 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11110 class Aws::S3::Types::MetricsFilter < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8698 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11111 Aws::S3::Types::MetricsFilter::SENSITIVE = T.let(T.unsafe(nil), Array) # Container for the `MultipartUpload` for the Amazon S3 object. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/MultipartUpload AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8742 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11165 class Aws::S3::Types::MultipartUpload < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8743 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11166 Aws::S3::Types::MultipartUpload::SENSITIVE = T.let(T.unsafe(nil), Array) # The specified bucket does not exist. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/NoSuchBucket AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8751 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11174 class Aws::S3::Types::NoSuchBucket < ::Aws::EmptyStructure; end # The specified key does not exist. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/NoSuchKey AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8757 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11180 class Aws::S3::Types::NoSuchKey < ::Aws::EmptyStructure; end # The specified multipart upload does not exist. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/NoSuchUpload AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8763 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11186 class Aws::S3::Types::NoSuchUpload < ::Aws::EmptyStructure; end # Specifies when noncurrent object versions expire. Upon expiration, @@ -28482,12 +30521,12 @@ class Aws::S3::Types::NoSuchUpload < ::Aws::EmptyStructure; end # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/NoncurrentVersionExpiration AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8799 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11223 class Aws::S3::Types::NoncurrentVersionExpiration < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8800 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11224 Aws::S3::Types::NoncurrentVersionExpiration::SENSITIVE = T.let(T.unsafe(nil), Array) # Container for the transition rule that describes when noncurrent @@ -28502,12 +30541,12 @@ Aws::S3::Types::NoncurrentVersionExpiration::SENSITIVE = T.let(T.unsafe(nil), Ar # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/NoncurrentVersionTransition AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8846 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11271 class Aws::S3::Types::NoncurrentVersionTransition < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8847 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11272 Aws::S3::Types::NoncurrentVersionTransition::SENSITIVE = T.let(T.unsafe(nil), Array) # A container for specifying the notification configuration of the @@ -28516,22 +30555,22 @@ Aws::S3::Types::NoncurrentVersionTransition::SENSITIVE = T.let(T.unsafe(nil), Ar # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/NotificationConfiguration AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8880 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11305 class Aws::S3::Types::NotificationConfiguration < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8881 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11306 Aws::S3::Types::NotificationConfiguration::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/NotificationConfigurationDeprecated AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8907 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11332 class Aws::S3::Types::NotificationConfigurationDeprecated < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8908 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11333 Aws::S3::Types::NotificationConfigurationDeprecated::SENSITIVE = T.let(T.unsafe(nil), Array) # Specifies object key name filtering rules. For information about key @@ -28544,91 +30583,91 @@ Aws::S3::Types::NotificationConfigurationDeprecated::SENSITIVE = T.let(T.unsafe( # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/NotificationConfigurationFilter AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8927 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11352 class Aws::S3::Types::NotificationConfigurationFilter < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#8928 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11353 Aws::S3::Types::NotificationConfigurationFilter::SENSITIVE = T.let(T.unsafe(nil), Array) # An object consists of data and its descriptive metadata. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Object AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9006 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11451 class Aws::S3::Types::Object < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9007 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11452 Aws::S3::Types::Object::SENSITIVE = T.let(T.unsafe(nil), Array) # This action is not allowed against this storage tier. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ObjectAlreadyInActiveTierError AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9015 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11460 class Aws::S3::Types::ObjectAlreadyInActiveTierError < ::Aws::EmptyStructure; end # Object Identifier is unique value to identify objects. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ObjectIdentifier AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9039 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11488 class Aws::S3::Types::ObjectIdentifier < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9040 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11489 Aws::S3::Types::ObjectIdentifier::SENSITIVE = T.let(T.unsafe(nil), Array) # The container element for Object Lock configuration parameters. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ObjectLockConfiguration AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9064 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11513 class Aws::S3::Types::ObjectLockConfiguration < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9065 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11514 Aws::S3::Types::ObjectLockConfiguration::SENSITIVE = T.let(T.unsafe(nil), Array) # A legal hold configuration for an object. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ObjectLockLegalHold AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9078 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11527 class Aws::S3::Types::ObjectLockLegalHold < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9079 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11528 Aws::S3::Types::ObjectLockLegalHold::SENSITIVE = T.let(T.unsafe(nil), Array) # A Retention configuration for an object. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ObjectLockRetention AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9097 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11546 class Aws::S3::Types::ObjectLockRetention < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9098 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11547 Aws::S3::Types::ObjectLockRetention::SENSITIVE = T.let(T.unsafe(nil), Array) # The container element for an Object Lock rule. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ObjectLockRule AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9115 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11564 class Aws::S3::Types::ObjectLockRule < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9116 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11565 Aws::S3::Types::ObjectLockRule::SENSITIVE = T.let(T.unsafe(nil), Array) # The source object of the COPY action is not in the active tier and is @@ -28636,91 +30675,91 @@ Aws::S3::Types::ObjectLockRule::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ObjectNotInActiveTierError AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9125 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11574 class Aws::S3::Types::ObjectNotInActiveTierError < ::Aws::EmptyStructure; end # A container for elements related to an individual part. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ObjectPart AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9197 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11652 class Aws::S3::Types::ObjectPart < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9198 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11653 Aws::S3::Types::ObjectPart::SENSITIVE = T.let(T.unsafe(nil), Array) # The version of an object. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ObjectVersion AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9265 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11720 class Aws::S3::Types::ObjectVersion < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9266 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11721 Aws::S3::Types::ObjectVersion::SENSITIVE = T.let(T.unsafe(nil), Array) # Describes the location where the restore job's output is stored. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/OutputLocation AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9280 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11735 class Aws::S3::Types::OutputLocation < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9281 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11736 Aws::S3::Types::OutputLocation::SENSITIVE = T.let(T.unsafe(nil), Array) # Describes how results of the Select job are serialized. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/OutputSerialization AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9299 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11754 class Aws::S3::Types::OutputSerialization < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9300 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11755 Aws::S3::Types::OutputSerialization::SENSITIVE = T.let(T.unsafe(nil), Array) # Container for the owner's display name and ID. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Owner AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9335 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11794 class Aws::S3::Types::Owner < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9336 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11795 Aws::S3::Types::Owner::SENSITIVE = T.let(T.unsafe(nil), Array) # The container element for a bucket's ownership controls. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/OwnershipControls AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9349 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11808 class Aws::S3::Types::OwnershipControls < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9350 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11809 Aws::S3::Types::OwnershipControls::SENSITIVE = T.let(T.unsafe(nil), Array) # The container element for an ownership control rule. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/OwnershipControlsRule AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9378 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11855 class Aws::S3::Types::OwnershipControlsRule < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9379 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11856 Aws::S3::Types::OwnershipControlsRule::SENSITIVE = T.let(T.unsafe(nil), Array) # Container for Parquet. @@ -28728,21 +30767,39 @@ Aws::S3::Types::OwnershipControlsRule::SENSITIVE = T.let(T.unsafe(nil), Array) # @api private # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ParquetInput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9389 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11866 class Aws::S3::Types::ParquetInput < ::Aws::EmptyStructure; end # Container for elements related to a part. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Part AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9470 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11951 class Aws::S3::Types::Part < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9471 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11952 Aws::S3::Types::Part::SENSITIVE = T.let(T.unsafe(nil), Array) +# Amazon S3 keys for log objects are partitioned in the following +# format: +# +# `[DestinationPrefix][SourceAccountId]/[SourceRegion]/[SourceBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]` +# +# PartitionedPrefix defaults to EventTime delivery when server access +# logs are delivered. +# +# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PartitionedPrefix AWS API Documentation +# +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11972 +class Aws::S3::Types::PartitionedPrefix < ::Struct + include ::Aws::Structure +end + +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11973 +Aws::S3::Types::PartitionedPrefix::SENSITIVE = T.let(T.unsafe(nil), Array) + # This error is not modeled. # # The bucket you are attempting to access must be addressed using the @@ -28760,24 +30817,24 @@ Aws::S3::Types::PermanentRedirect::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PolicyStatus AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9485 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11987 class Aws::S3::Types::PolicyStatus < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9486 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11988 Aws::S3::Types::PolicyStatus::SENSITIVE = T.let(T.unsafe(nil), Array) # This data type contains information about progress of an operation. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Progress AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9509 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12011 class Aws::S3::Types::Progress < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9510 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12012 Aws::S3::Types::Progress::SENSITIVE = T.let(T.unsafe(nil), Array) # This data type contains information about the progress event of an @@ -28785,12 +30842,12 @@ Aws::S3::Types::Progress::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ProgressEvent AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9525 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12027 class Aws::S3::Types::ProgressEvent < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9526 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12028 Aws::S3::Types::ProgressEvent::SENSITIVE = T.let(T.unsafe(nil), Array) # The PublicAccessBlock configuration that you want to apply to this @@ -28805,342 +30862,342 @@ Aws::S3::Types::ProgressEvent::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PublicAccessBlockConfiguration AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9592 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12094 class Aws::S3::Types::PublicAccessBlockConfiguration < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9593 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12095 Aws::S3::Types::PublicAccessBlockConfiguration::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketAccelerateConfigurationRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9635 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12138 class Aws::S3::Types::PutBucketAccelerateConfigurationRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9636 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12139 Aws::S3::Types::PutBucketAccelerateConfigurationRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketAclRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9728 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12232 class Aws::S3::Types::PutBucketAclRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9729 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12233 Aws::S3::Types::PutBucketAclRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketAnalyticsConfigurationRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9758 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12263 class Aws::S3::Types::PutBucketAnalyticsConfigurationRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9759 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12264 Aws::S3::Types::PutBucketAnalyticsConfigurationRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketCorsRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9822 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12328 class Aws::S3::Types::PutBucketCorsRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9823 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12329 Aws::S3::Types::PutBucketCorsRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketEncryptionRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9886 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12393 class Aws::S3::Types::PutBucketEncryptionRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9887 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12394 Aws::S3::Types::PutBucketEncryptionRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketIntelligentTieringConfigurationRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9909 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12416 class Aws::S3::Types::PutBucketIntelligentTieringConfigurationRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9910 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12417 Aws::S3::Types::PutBucketIntelligentTieringConfigurationRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketInventoryConfigurationRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9939 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12447 class Aws::S3::Types::PutBucketInventoryConfigurationRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9940 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12448 Aws::S3::Types::PutBucketInventoryConfigurationRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketLifecycleConfigurationRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9981 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12490 class Aws::S3::Types::PutBucketLifecycleConfigurationRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#9982 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12491 Aws::S3::Types::PutBucketLifecycleConfigurationRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketLifecycleRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10028 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12538 class Aws::S3::Types::PutBucketLifecycleRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10029 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12539 Aws::S3::Types::PutBucketLifecycleRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketLoggingRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10079 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12590 class Aws::S3::Types::PutBucketLoggingRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10080 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12591 Aws::S3::Types::PutBucketLoggingRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketMetricsConfigurationRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10110 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12622 class Aws::S3::Types::PutBucketMetricsConfigurationRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10111 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12623 Aws::S3::Types::PutBucketMetricsConfigurationRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketNotificationConfigurationRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10142 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12655 class Aws::S3::Types::PutBucketNotificationConfigurationRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10143 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12656 Aws::S3::Types::PutBucketNotificationConfigurationRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketNotificationRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10193 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12707 class Aws::S3::Types::PutBucketNotificationRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10194 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12708 Aws::S3::Types::PutBucketNotificationRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketOwnershipControlsRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10228 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12743 class Aws::S3::Types::PutBucketOwnershipControlsRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10229 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12744 Aws::S3::Types::PutBucketOwnershipControlsRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketPolicyRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10285 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12855 class Aws::S3::Types::PutBucketPolicyRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10286 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12856 Aws::S3::Types::PutBucketPolicyRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketReplicationRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10349 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12920 class Aws::S3::Types::PutBucketReplicationRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10350 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12921 Aws::S3::Types::PutBucketReplicationRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketRequestPaymentRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10407 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12979 class Aws::S3::Types::PutBucketRequestPaymentRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10408 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12980 Aws::S3::Types::PutBucketRequestPaymentRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketTaggingRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10465 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13038 class Aws::S3::Types::PutBucketTaggingRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10466 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13039 Aws::S3::Types::PutBucketTaggingRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketVersioningRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10530 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13104 class Aws::S3::Types::PutBucketVersioningRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10531 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13105 Aws::S3::Types::PutBucketVersioningRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutBucketWebsiteRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10588 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13163 class Aws::S3::Types::PutBucketWebsiteRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10589 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13164 Aws::S3::Types::PutBucketWebsiteRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectAclOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10601 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13180 class Aws::S3::Types::PutObjectAclOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10602 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13181 Aws::S3::Types::PutObjectAclOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectAclRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10767 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13346 class Aws::S3::Types::PutObjectAclRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10768 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13347 Aws::S3::Types::PutObjectAclRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectLegalHoldOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10780 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13363 class Aws::S3::Types::PutObjectLegalHoldOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10781 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13364 Aws::S3::Types::PutObjectLegalHoldOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectLegalHoldRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10869 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13461 class Aws::S3::Types::PutObjectLegalHoldRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10870 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13462 Aws::S3::Types::PutObjectLegalHoldRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectLockConfigurationOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10882 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13478 class Aws::S3::Types::PutObjectLockConfigurationOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10883 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13479 Aws::S3::Types::PutObjectLockConfigurationOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectLockConfigurationRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10953 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13556 class Aws::S3::Types::PutObjectLockConfigurationRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#10954 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13557 Aws::S3::Types::PutObjectLockConfigurationRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11091 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13763 class Aws::S3::Types::PutObjectOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11092 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13764 Aws::S3::Types::PutObjectOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11494 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#14343 class Aws::S3::Types::PutObjectRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11495 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#14344 Aws::S3::Types::PutObjectRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectRetentionOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11507 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#14360 class Aws::S3::Types::PutObjectRetentionOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11508 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#14361 Aws::S3::Types::PutObjectRetentionOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectRetentionRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11603 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#14465 class Aws::S3::Types::PutObjectRetentionRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11604 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#14466 Aws::S3::Types::PutObjectRetentionRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectTaggingOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11615 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#14477 class Aws::S3::Types::PutObjectTaggingOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11616 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#14478 Aws::S3::Types::PutObjectTaggingOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutObjectTaggingRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11712 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#14583 class Aws::S3::Types::PutObjectTaggingRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11713 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#14584 Aws::S3::Types::PutObjectTaggingRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/PutPublicAccessBlockRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11772 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#14644 class Aws::S3::Types::PutPublicAccessBlockRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11773 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#14645 Aws::S3::Types::PutPublicAccessBlockRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # Specifies the configuration for publishing messages to an Amazon @@ -29149,12 +31206,12 @@ Aws::S3::Types::PutPublicAccessBlockRequest::SENSITIVE = T.let(T.unsafe(nil), Ar # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/QueueConfiguration AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11813 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#14685 class Aws::S3::Types::QueueConfiguration < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11814 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#14686 Aws::S3::Types::QueueConfiguration::SENSITIVE = T.let(T.unsafe(nil), Array) # This data type is deprecated. Use [QueueConfiguration][1] for the same @@ -29168,24 +31225,24 @@ Aws::S3::Types::QueueConfiguration::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/QueueConfigurationDeprecated AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11853 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#14725 class Aws::S3::Types::QueueConfigurationDeprecated < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11854 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#14726 Aws::S3::Types::QueueConfigurationDeprecated::SENSITIVE = T.let(T.unsafe(nil), Array) # The container for the records event. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/RecordsEvent AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11868 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#14740 class Aws::S3::Types::RecordsEvent < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11869 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#14741 Aws::S3::Types::RecordsEvent::SENSITIVE = T.let(T.unsafe(nil), Array) # Specifies how requests are redirected. In the event of an error, you @@ -29193,12 +31250,12 @@ Aws::S3::Types::RecordsEvent::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Redirect AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11930 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#14802 class Aws::S3::Types::Redirect < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11931 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#14803 Aws::S3::Types::Redirect::SENSITIVE = T.let(T.unsafe(nil), Array) # Specifies the redirect behavior of all requests to a website endpoint @@ -29206,12 +31263,12 @@ Aws::S3::Types::Redirect::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/RedirectAllRequestsTo AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11951 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#14823 class Aws::S3::Types::RedirectAllRequestsTo < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11952 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#14824 Aws::S3::Types::RedirectAllRequestsTo::SENSITIVE = T.let(T.unsafe(nil), Array) # A filter that you can specify for selection for modifications on @@ -29228,12 +31285,12 @@ Aws::S3::Types::RedirectAllRequestsTo::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ReplicaModifications AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11975 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#14847 class Aws::S3::Types::ReplicaModifications < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#11976 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#14848 Aws::S3::Types::ReplicaModifications::SENSITIVE = T.let(T.unsafe(nil), Array) # A container for replication rules. You can add up to 1,000 rules. The @@ -29241,12 +31298,12 @@ Aws::S3::Types::ReplicaModifications::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ReplicationConfiguration AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12004 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#14876 class Aws::S3::Types::ReplicationConfiguration < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12005 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#14877 Aws::S3::Types::ReplicationConfiguration::SENSITIVE = T.let(T.unsafe(nil), Array) # Specifies which Amazon S3 objects to replicate and where to store the @@ -29254,12 +31311,12 @@ Aws::S3::Types::ReplicationConfiguration::SENSITIVE = T.let(T.unsafe(nil), Array # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ReplicationRule AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12119 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#14991 class Aws::S3::Types::ReplicationRule < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12120 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#14992 Aws::S3::Types::ReplicationRule::SENSITIVE = T.let(T.unsafe(nil), Array) # A container for specifying rule filters. The filters determine the @@ -29276,12 +31333,12 @@ Aws::S3::Types::ReplicationRule::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ReplicationRuleAndOperator AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12149 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15021 class Aws::S3::Types::ReplicationRuleAndOperator < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12150 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15022 Aws::S3::Types::ReplicationRuleAndOperator::SENSITIVE = T.let(T.unsafe(nil), Array) # A filter that identifies the subset of objects to which the @@ -29290,12 +31347,12 @@ Aws::S3::Types::ReplicationRuleAndOperator::SENSITIVE = T.let(T.unsafe(nil), Arr # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ReplicationRuleFilter AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12194 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15066 class Aws::S3::Types::ReplicationRuleFilter < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12195 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15067 Aws::S3::Types::ReplicationRuleFilter::SENSITIVE = T.let(T.unsafe(nil), Array) # A container specifying S3 Replication Time Control (S3 RTC) related @@ -29305,12 +31362,12 @@ Aws::S3::Types::ReplicationRuleFilter::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ReplicationTime AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12217 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15089 class Aws::S3::Types::ReplicationTime < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12218 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15090 Aws::S3::Types::ReplicationTime::SENSITIVE = T.let(T.unsafe(nil), Array) # A container specifying the time value for S3 Replication Time Control @@ -29318,24 +31375,24 @@ Aws::S3::Types::ReplicationTime::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ReplicationTimeValue AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12234 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15106 class Aws::S3::Types::ReplicationTimeValue < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12235 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15107 Aws::S3::Types::ReplicationTimeValue::SENSITIVE = T.let(T.unsafe(nil), Array) # Container for Payer. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/RequestPaymentConfiguration AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12248 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15120 class Aws::S3::Types::RequestPaymentConfiguration < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12249 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15121 Aws::S3::Types::RequestPaymentConfiguration::SENSITIVE = T.let(T.unsafe(nil), Array) # Container for specifying if periodic `QueryProgress` messages should @@ -29343,44 +31400,44 @@ Aws::S3::Types::RequestPaymentConfiguration::SENSITIVE = T.let(T.unsafe(nil), Ar # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/RequestProgress AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12264 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15136 class Aws::S3::Types::RequestProgress < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12265 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15137 Aws::S3::Types::RequestProgress::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/RestoreObjectOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12283 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15159 class Aws::S3::Types::RestoreObjectOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12284 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15160 Aws::S3::Types::RestoreObjectOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/RestoreObjectRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12371 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15256 class Aws::S3::Types::RestoreObjectRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12372 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15257 Aws::S3::Types::RestoreObjectRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # Container for restore job parameters. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/RestoreRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12420 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15305 class Aws::S3::Types::RestoreRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12421 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15306 Aws::S3::Types::RestoreRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # Specifies the restoration status of an object. Objects in certain @@ -29389,18 +31446,24 @@ Aws::S3::Types::RestoreRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # archived objects, see [ Working with archived objects][1] in the # *Amazon S3 User Guide*. # +# This functionality is not supported for directory buckets. Only the S3 +# Express One Zone storage class is supported by directory buckets to +# store objects. +# +# +# # # # [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/RestoreStatus AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12463 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15354 class Aws::S3::Types::RestoreStatus < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12464 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15355 Aws::S3::Types::RestoreStatus::SENSITIVE = T.let(T.unsafe(nil), Array) # Specifies the redirect behavior and when a redirect is applied. For @@ -29413,12 +31476,12 @@ Aws::S3::Types::RestoreStatus::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/RoutingRule AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12494 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15385 class Aws::S3::Types::RoutingRule < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12495 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15386 Aws::S3::Types::RoutingRule::SENSITIVE = T.let(T.unsafe(nil), Array) # Specifies lifecycle rules for an Amazon S3 bucket. For more @@ -29433,24 +31496,24 @@ Aws::S3::Types::RoutingRule::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Rule AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12590 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15481 class Aws::S3::Types::Rule < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12591 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15482 Aws::S3::Types::Rule::SENSITIVE = T.let(T.unsafe(nil), Array) # A container for object key name prefix and suffix filtering rules. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/S3KeyFilter AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12605 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15496 class Aws::S3::Types::S3KeyFilter < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12606 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15497 Aws::S3::Types::S3KeyFilter::SENSITIVE = T.let(T.unsafe(nil), Array) # Describes an Amazon S3 location that will receive the results of the @@ -29458,24 +31521,24 @@ Aws::S3::Types::S3KeyFilter::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/S3Location AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12656 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15547 class Aws::S3::Types::S3Location < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12657 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15548 Aws::S3::Types::S3Location::SENSITIVE = T.let(T.unsafe(nil), Array) # Specifies the use of SSE-KMS to encrypt delivered inventory reports. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/SSEKMS AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12672 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15563 class Aws::S3::Types::SSEKMS < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12673 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15564 Aws::S3::Types::SSEKMS::SENSITIVE = T.let(T.unsafe(nil), Array) # Specifies the use of SSE-S3 to encrypt delivered inventory reports. @@ -29483,7 +31546,7 @@ Aws::S3::Types::SSEKMS::SENSITIVE = T.let(T.unsafe(nil), Array) # @api private # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/SSES3 AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12683 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15574 class Aws::S3::Types::SSES3 < ::Aws::EmptyStructure; end # Specifies the byte range of the object to get the records from. A @@ -29494,12 +31557,12 @@ class Aws::S3::Types::SSES3 < ::Aws::EmptyStructure; end # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ScanRange AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12712 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15603 class Aws::S3::Types::ScanRange < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12713 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15604 Aws::S3::Types::ScanRange::SENSITIVE = T.let(T.unsafe(nil), Array) # The container for selecting objects from a content event stream. @@ -29509,20 +31572,20 @@ Aws::S3::Types::ScanRange::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/SelectObjectContentEventStream AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#14311 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#17510 class Aws::S3::Types::SelectObjectContentEventStream < ::Enumerator - # source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#14313 + # source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#17512 def event_types; end end # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/SelectObjectContentOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12724 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15615 class Aws::S3::Types::SelectObjectContentOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12725 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15616 Aws::S3::Types::SelectObjectContentOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # Request to filter the contents of an Amazon S3 object based on a @@ -29540,24 +31603,24 @@ Aws::S3::Types::SelectObjectContentOutput::SENSITIVE = T.let(T.unsafe(nil), Arra # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/SelectObjectContentRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12846 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15738 class Aws::S3::Types::SelectObjectContentRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12847 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15739 Aws::S3::Types::SelectObjectContentRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # Describes the parameters for Select job types. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/SelectParameters AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12875 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15767 class Aws::S3::Types::SelectParameters < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12876 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15768 Aws::S3::Types::SelectParameters::SENSITIVE = T.let(T.unsafe(nil), Array) # Describes the default server-side encryption to apply to new objects @@ -29576,38 +31639,67 @@ Aws::S3::Types::SelectParameters::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ServerSideEncryptionByDefault AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12932 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15828 class Aws::S3::Types::ServerSideEncryptionByDefault < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12933 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15829 Aws::S3::Types::ServerSideEncryptionByDefault::SENSITIVE = T.let(T.unsafe(nil), Array) # Specifies the default server-side-encryption configuration. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ServerSideEncryptionConfiguration AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12947 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15843 class Aws::S3::Types::ServerSideEncryptionConfiguration < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12948 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15844 Aws::S3::Types::ServerSideEncryptionConfiguration::SENSITIVE = T.let(T.unsafe(nil), Array) # Specifies the default server-side encryption configuration. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ServerSideEncryptionRule AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12979 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15875 class Aws::S3::Types::ServerSideEncryptionRule < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#12980 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15876 Aws::S3::Types::ServerSideEncryptionRule::SENSITIVE = T.let(T.unsafe(nil), Array) +# The established temporary security credentials of the session. +# +# **Directory buckets** - These session credentials are only supported +# for the authentication and authorization of Zonal endpoint APIs on +# directory buckets. +# +# +# +# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/SessionCredentials AWS API Documentation +# +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15919 +class Aws::S3::Types::SessionCredentials < ::Struct + include ::Aws::Structure +end + +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15920 +Aws::S3::Types::SessionCredentials::SENSITIVE = T.let(T.unsafe(nil), Array) + +# To use simple format for S3 keys for log objects, set SimplePrefix to +# an empty object. +# +# `[DestinationPrefix][YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]` +# +# @api private +# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/SimplePrefix AWS API Documentation +# +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15933 +class Aws::S3::Types::SimplePrefix < ::Aws::EmptyStructure; end + # A container that describes additional filters for identifying the # source objects that you want to replicate. You can choose to enable or # disable the replication of these objects. Currently, Amazon S3 @@ -29617,12 +31709,12 @@ Aws::S3::Types::ServerSideEncryptionRule::SENSITIVE = T.let(T.unsafe(nil), Array # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/SourceSelectionCriteria AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13016 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15967 class Aws::S3::Types::SourceSelectionCriteria < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13017 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15968 Aws::S3::Types::SourceSelectionCriteria::SENSITIVE = T.let(T.unsafe(nil), Array) # A container for filter information for the selection of S3 objects @@ -29630,36 +31722,36 @@ Aws::S3::Types::SourceSelectionCriteria::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/SseKmsEncryptedObjects AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13033 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15984 class Aws::S3::Types::SseKmsEncryptedObjects < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13034 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#15985 Aws::S3::Types::SseKmsEncryptedObjects::SENSITIVE = T.let(T.unsafe(nil), Array) # Container for the stats details. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Stats AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13057 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#16008 class Aws::S3::Types::Stats < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13058 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#16009 Aws::S3::Types::Stats::SENSITIVE = T.let(T.unsafe(nil), Array) # Container for the Stats Event. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/StatsEvent AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13072 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#16023 class Aws::S3::Types::StatsEvent < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13073 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#16024 Aws::S3::Types::StatsEvent::SENSITIVE = T.let(T.unsafe(nil), Array) # Specifies data related to access patterns to be collected and made @@ -29668,12 +31760,12 @@ Aws::S3::Types::StatsEvent::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/StorageClassAnalysis AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13089 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#16040 class Aws::S3::Types::StorageClassAnalysis < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13090 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#16041 Aws::S3::Types::StorageClassAnalysis::SENSITIVE = T.let(T.unsafe(nil), Array) # Container for data related to the storage class analysis for an Amazon @@ -29681,36 +31773,36 @@ Aws::S3::Types::StorageClassAnalysis::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/StorageClassAnalysisDataExport AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13110 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#16061 class Aws::S3::Types::StorageClassAnalysisDataExport < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13111 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#16062 Aws::S3::Types::StorageClassAnalysisDataExport::SENSITIVE = T.let(T.unsafe(nil), Array) # A container of a key value name pair. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Tag AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13129 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#16080 class Aws::S3::Types::Tag < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13130 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#16081 Aws::S3::Types::Tag::SENSITIVE = T.let(T.unsafe(nil), Array) # Container for `TagSet` elements. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Tagging AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13143 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#16094 class Aws::S3::Types::Tagging < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13144 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#16095 Aws::S3::Types::Tagging::SENSITIVE = T.let(T.unsafe(nil), Array) # Container for granting information. @@ -29726,26 +31818,39 @@ Aws::S3::Types::Tagging::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/TargetGrant AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13171 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#16122 class Aws::S3::Types::TargetGrant < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13172 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#16123 Aws::S3::Types::TargetGrant::SENSITIVE = T.let(T.unsafe(nil), Array) +# Amazon S3 key format for log objects. Only one format, +# PartitionedPrefix or SimplePrefix, is allowed. +# +# @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/TargetObjectKeyFormat AWS API Documentation +# +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#16143 +class Aws::S3::Types::TargetObjectKeyFormat < ::Struct + include ::Aws::Structure +end + +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#16144 +Aws::S3::Types::TargetObjectKeyFormat::SENSITIVE = T.let(T.unsafe(nil), Array) + # The S3 Intelligent-Tiering storage class is designed to optimize # storage costs by automatically moving data to the most cost-effective # storage access tier, without additional operational overhead. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Tiering AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13203 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#16175 class Aws::S3::Types::Tiering < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13204 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#16176 Aws::S3::Types::Tiering::SENSITIVE = T.let(T.unsafe(nil), Array) # A container for specifying the configuration for publication of @@ -29754,12 +31859,12 @@ Aws::S3::Types::Tiering::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/TopicConfiguration AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13250 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#16222 class Aws::S3::Types::TopicConfiguration < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13251 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#16223 Aws::S3::Types::TopicConfiguration::SENSITIVE = T.let(T.unsafe(nil), Array) # A container for specifying the configuration for publication of @@ -29773,12 +31878,12 @@ Aws::S3::Types::TopicConfiguration::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/TopicConfigurationDeprecated AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13289 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#16261 class Aws::S3::Types::TopicConfigurationDeprecated < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13290 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#16262 Aws::S3::Types::TopicConfigurationDeprecated::SENSITIVE = T.let(T.unsafe(nil), Array) # Specifies when an object transitions to a specified storage class. For @@ -29792,52 +31897,52 @@ Aws::S3::Types::TopicConfigurationDeprecated::SENSITIVE = T.let(T.unsafe(nil), A # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Transition AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13324 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#16296 class Aws::S3::Types::Transition < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13325 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#16297 Aws::S3::Types::Transition::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/UploadPartCopyOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13383 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#16385 class Aws::S3::Types::UploadPartCopyOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13384 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#16386 Aws::S3::Types::UploadPartCopyOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/UploadPartCopyRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13587 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#16706 class Aws::S3::Types::UploadPartCopyRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13588 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#16707 Aws::S3::Types::UploadPartCopyRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/UploadPartOutput AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13695 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#16848 class Aws::S3::Types::UploadPartOutput < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13696 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#16849 Aws::S3::Types::UploadPartOutput::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/UploadPartRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13882 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#17076 class Aws::S3::Types::UploadPartRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13883 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#17077 Aws::S3::Types::UploadPartRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # Describes the versioning state of an Amazon S3 bucket. For more @@ -29850,34 +31955,34 @@ Aws::S3::Types::UploadPartRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/VersioningConfiguration AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13910 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#17104 class Aws::S3::Types::VersioningConfiguration < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13911 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#17105 Aws::S3::Types::VersioningConfiguration::SENSITIVE = T.let(T.unsafe(nil), Array) # Specifies website configuration parameters for an Amazon S3 bucket. # # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/WebsiteConfiguration AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13943 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#17137 class Aws::S3::Types::WebsiteConfiguration < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#13944 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#17138 Aws::S3::Types::WebsiteConfiguration::SENSITIVE = T.let(T.unsafe(nil), Array) # @see http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/WriteGetObjectResponseRequest AWS API Documentation # -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#14299 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#17498 class Aws::S3::Types::WriteGetObjectResponseRequest < ::Struct include ::Aws::Structure end -# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#14300 +# source://aws-sdk-s3//lib/aws-sdk-s3/types.rb#17499 Aws::S3::Types::WriteGetObjectResponseRequest::SENSITIVE = T.let(T.unsafe(nil), Array) # Waiters are utility methods that poll for a particular state to occur @@ -29963,7 +32068,12 @@ class Aws::S3::Waiters::BucketExists # @option params # @option params # @param params [Hash] a customizable set of options - # @return [Struct] Returns an empty {Seahorse::Client::Response response}. + # @return [Types::HeadBucketOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::HeadBucketOutput#bucket_location_type #bucket_location_type} => String + # * {Types::HeadBucketOutput#bucket_location_name #bucket_location_name} => String + # * {Types::HeadBucketOutput#bucket_region #bucket_region} => String + # * {Types::HeadBucketOutput#access_point_alias #access_point_alias} => Boolean # # source://aws-sdk-s3//lib/aws-sdk-s3/waiters.rb#122 def wait(params = T.unsafe(nil)); end @@ -29990,7 +32100,12 @@ class Aws::S3::Waiters::BucketNotExists # @option params # @option params # @param params [Hash] a customizable set of options - # @return [Struct] Returns an empty {Seahorse::Client::Response response}. + # @return [Types::HeadBucketOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::HeadBucketOutput#bucket_location_type #bucket_location_type} => String + # * {Types::HeadBucketOutput#bucket_location_name #bucket_location_name} => String + # * {Types::HeadBucketOutput#bucket_region #bucket_region} => String + # * {Types::HeadBucketOutput#access_point_alias #access_point_alias} => Boolean # # source://aws-sdk-s3//lib/aws-sdk-s3/waiters.rb#157 def wait(params = T.unsafe(nil)); end @@ -30029,6 +32144,12 @@ class Aws::S3::Waiters::ObjectExists # @option params # @option params # @option params + # @option params + # @option params + # @option params + # @option params + # @option params + # @option params # @param params [Hash] a customizable set of options # @return [Types::HeadObjectOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -30105,6 +32226,12 @@ class Aws::S3::Waiters::ObjectNotExists # @option params # @option params # @option params + # @option params + # @option params + # @option params + # @option params + # @option params + # @option params # @param params [Hash] a customizable set of options # @return [Types::HeadObjectOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # diff --git a/sorbet/rbi/gems/aws-sigv4@1.6.0.rbi b/sorbet/rbi/gems/aws-sigv4@1.9.0.rbi similarity index 75% rename from sorbet/rbi/gems/aws-sigv4@1.6.0.rbi rename to sorbet/rbi/gems/aws-sigv4@1.9.0.rbi index 3735801fe..e1f59e080 100644 --- a/sorbet/rbi/gems/aws-sigv4@1.6.0.rbi +++ b/sorbet/rbi/gems/aws-sigv4@1.9.0.rbi @@ -5,38 +5,85 @@ # Please instead update this file by running `bin/tapioca gem aws-sigv4`. -# source://aws-sigv4//lib/aws-sigv4/credentials.rb#3 +# source://aws-sigv4//lib/aws-sigv4/asymmetric_credentials.rb#3 module Aws class << self - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core.rb#133 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core.rb#138 def config; end - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core.rb#136 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core.rb#141 def config=(config); end - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core.rb#195 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core.rb#200 def eager_autoload!(*args); end - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core.rb#188 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core.rb#193 def empty_connection_pools!; end - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core.rb#145 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core.rb#150 def partition(partition_name); end - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core.rb#150 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core.rb#155 def partitions; end - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core.rb#126 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core.rb#131 def shared_config; end - # source://aws-sdk-core/3.180.3/lib/aws-sdk-core.rb#165 + # source://aws-sdk-core/3.201.3/lib/aws-sdk-core.rb#170 def use_bundled_cert!; end end end -# source://aws-sigv4//lib/aws-sigv4/credentials.rb#4 +# source://aws-sigv4//lib/aws-sigv4/asymmetric_credentials.rb#4 module Aws::Sigv4; end +# To make it easier to support mixed mode, we have created an asymmetric +# key derivation mechanism. This module derives +# asymmetric keys from the current secret for use with +# Asymmetric signatures. +# +# @api private +# +# source://aws-sigv4//lib/aws-sigv4/asymmetric_credentials.rb#10 +module Aws::Sigv4::AsymmetricCredentials + class << self + # unsigned integer. + # + # @api private + # @return [Number] The value of the bytes interpreted as a big-endian + # + # source://aws-sigv4//lib/aws-sigv4/asymmetric_credentials.rb#57 + def be_bytes_to_num(bytes); end + + # @api private + # + # source://aws-sigv4//lib/aws-sigv4/asymmetric_credentials.rb#80 + def check_openssl_support!; end + + # @api private + # @param :access_key_id [String] + # @param :secret_access_key [String] + # @return [OpenSSL::PKey::EC, Hash] + # + # source://aws-sigv4//lib/aws-sigv4/asymmetric_credentials.rb#17 + def derive_asymmetric_key(access_key_id, secret_access_key); end + + # Prior to openssl3 we could directly set public and private key on EC + # However, openssl3 deprecated those methods and we must now construct + # a der with the keys and load the EC from it. + # + # @api private + # + # source://aws-sigv4//lib/aws-sigv4/asymmetric_credentials.rb#66 + def generate_ec(public_key, d); end + end +end + +# @api private +# +# source://aws-sigv4//lib/aws-sigv4/asymmetric_credentials.rb#12 +Aws::Sigv4::AsymmetricCredentials::N_MINUS_2 = T.let(T.unsafe(nil), Integer) + # Users that wish to configure static credentials can use the # `:access_key_id` and `:secret_access_key` constructor options. # @@ -129,12 +176,12 @@ class Aws::Sigv4::Signature # @return [Hash] Internal data for debugging purposes. # - # source://aws-sigv4//lib/aws-sigv4/signature.rb#36 + # source://aws-sigv4//lib/aws-sigv4/signature.rb#39 def extra; end # @return [Hash] Internal data for debugging purposes. # - # source://aws-sigv4//lib/aws-sigv4/signature.rb#36 + # source://aws-sigv4//lib/aws-sigv4/signature.rb#39 def extra=(_arg0); end # @return [Hash] A hash of headers that should @@ -163,6 +210,16 @@ class Aws::Sigv4::Signature # source://aws-sigv4//lib/aws-sigv4/signature.rb#24 def headers=(_arg0); end + # @return [String] For debugging purposes. + # + # source://aws-sigv4//lib/aws-sigv4/signature.rb#36 + def signature; end + + # @return [String] For debugging purposes. + # + # source://aws-sigv4//lib/aws-sigv4/signature.rb#36 + def signature=(_arg0); end + # @return [String] For debugging purposes. # # source://aws-sigv4//lib/aws-sigv4/signature.rb#30 @@ -249,13 +306,13 @@ class Aws::Sigv4::Signer # @param options [Hash] a customizable set of options # @return [Signer] a new instance of Signer # - # source://aws-sigv4//lib/aws-sigv4/signer.rb#141 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#143 def initialize(options = T.unsafe(nil)); end # @return [Boolean] When `true` the `x-amz-content-sha256` header will be signed and # returned in the signature headers. # - # source://aws-sigv4//lib/aws-sigv4/signer.rb#185 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#188 def apply_checksum_header; end # @return [#credentials] Returns an object that responds to @@ -267,7 +324,7 @@ class Aws::Sigv4::Signer # * `#session_token` => String, nil # * `#set?` => Boolean # - # source://aws-sigv4//lib/aws-sigv4/signer.rb#177 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#180 def credentials_provider; end # Signs a URL with query authentication. Using query parameters @@ -318,17 +375,17 @@ class Aws::Sigv4::Signer # @param options [Hash] a customizable set of options # @return [HTTPS::URI, HTTP::URI] # - # source://aws-sigv4//lib/aws-sigv4/signer.rb#402 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#432 def presign_url(options); end # @return [String] # - # source://aws-sigv4//lib/aws-sigv4/signer.rb#166 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#169 def region; end # @return [String] # - # source://aws-sigv4//lib/aws-sigv4/signer.rb#163 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#166 def service; end # Signs a event and returns signature headers and prior signature @@ -367,7 +424,7 @@ class Aws::Sigv4::Signer # signature value (a binary string) used at ':chunk-signature' needs to converted to # hex-encoded string using #unpack # - # source://aws-sigv4//lib/aws-sigv4/signer.rb#315 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#345 def sign_event(prior_signature, payload, encoder); end # Computes a version 4 signature signature. Returns the resultant @@ -406,30 +463,33 @@ class Aws::Sigv4::Signer # @return [Signature] Return an instance of {Signature} that has # a `#headers` method. The headers must be applied to your request. # - # source://aws-sigv4//lib/aws-sigv4/signer.rb#234 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#237 def sign_request(request); end # @return [Set] Returns a set of header names that should not be signed. # All header names have been downcased. # - # source://aws-sigv4//lib/aws-sigv4/signer.rb#181 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#184 def unsigned_headers; end private - # source://aws-sigv4//lib/aws-sigv4/signer.rb#590 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#565 + def asymmetric_signature(creds, string_to_sign); end + + # source://aws-sigv4//lib/aws-sigv4/signer.rb#653 def canonical_header_value(value); end - # source://aws-sigv4//lib/aws-sigv4/signer.rb#578 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#641 def canonical_headers(headers); end - # source://aws-sigv4//lib/aws-sigv4/signer.rb#448 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#501 def canonical_request(http_method, url, headers, content_sha256); end - # source://aws-sigv4//lib/aws-sigv4/signer.rb#500 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#553 def credential(credentials, date); end - # source://aws-sigv4//lib/aws-sigv4/signer.rb#491 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#544 def credential_scope(date); end # Returns true if credentials are set (not nil or empty) @@ -439,22 +499,22 @@ class Aws::Sigv4::Signer # # @return [Boolean] # - # source://aws-sigv4//lib/aws-sigv4/signer.rb#718 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#781 def credentials_set?(credentials); end # the credentials used by CRT must be a # CRT StaticCredentialsProvider object # - # source://aws-sigv4//lib/aws-sigv4/signer.rb#737 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#807 def crt_fetch_credentials; end - # source://aws-sigv4//lib/aws-sigv4/signer.rb#806 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#876 def crt_presign_url(options); end - # source://aws-sigv4//lib/aws-sigv4/signer.rb#747 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#817 def crt_sign_request(request); end - # source://aws-sigv4//lib/aws-sigv4/signer.rb#675 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#738 def downcase_headers(headers); end # Comparing to original signature v4 algorithm, @@ -467,7 +527,7 @@ class Aws::Sigv4::Signer # string is handled at #sign_event instead. (Will be used # as next prior signature for event signing) # - # source://aws-sigv4//lib/aws-sigv4/signer.rb#521 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#584 def event_signature(secret_access_key, date, string_to_sign); end # Compared to original #string_to_sign at signature v4 algorithm @@ -480,83 +540,91 @@ class Aws::Sigv4::Signer # payload used is already eventstream encoded (event without signature), # thus no extra encoding is needed. # - # source://aws-sigv4//lib/aws-sigv4/signer.rb#477 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#530 def event_string_to_sign(datetime, headers, payload, prior_signature, encoder); end - # source://aws-sigv4//lib/aws-sigv4/signer.rb#647 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#710 def extract_credentials_provider(options); end - # source://aws-sigv4//lib/aws-sigv4/signer.rb#682 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#745 def extract_expires_in(options); end - # source://aws-sigv4//lib/aws-sigv4/signer.rb#657 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#720 def extract_http_method(request); end - # source://aws-sigv4//lib/aws-sigv4/signer.rb#639 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#702 def extract_region(options); end - # source://aws-sigv4//lib/aws-sigv4/signer.rb#630 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#693 def extract_service(options); end - # source://aws-sigv4//lib/aws-sigv4/signer.rb#666 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#729 def extract_url(request); end - # source://aws-sigv4//lib/aws-sigv4/signer.rb#700 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#763 def fetch_credentials; end - # source://aws-sigv4//lib/aws-sigv4/signer.rb#626 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#689 def hexhmac(key, value); end - # source://aws-sigv4//lib/aws-sigv4/signer.rb#622 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#685 def hmac(key, value); end - # source://aws-sigv4//lib/aws-sigv4/signer.rb#594 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#657 def host(uri); end - # source://aws-sigv4//lib/aws-sigv4/signer.rb#539 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#602 def normalized_querystring(querystring); end - # source://aws-sigv4//lib/aws-sigv4/signer.rb#529 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#592 def path(url); end - # source://aws-sigv4//lib/aws-sigv4/signer.rb#725 - def presigned_url_expiration(options, expiration); end + # source://aws-sigv4//lib/aws-sigv4/signer.rb#788 + def presigned_url_expiration(options, expiration, datetime); end # @param value [File, Tempfile, IO#read, String] # @return [String] # - # source://aws-sigv4//lib/aws-sigv4/signer.rb#605 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#668 def sha256_hexdigest(value); end - # source://aws-sigv4//lib/aws-sigv4/signer.rb#504 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#557 def signature(secret_access_key, date, string_to_sign); end - # source://aws-sigv4//lib/aws-sigv4/signer.rb#568 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#631 def signed_headers(headers); end - # source://aws-sigv4//lib/aws-sigv4/signer.rb#459 - def string_to_sign(datetime, canonical_request); end + # source://aws-sigv4//lib/aws-sigv4/signer.rb#512 + def string_to_sign(datetime, canonical_request, algorithm); end + + # source://aws-sigv4//lib/aws-sigv4/signer.rb#497 + def sts_algorithm; end - # source://aws-sigv4//lib/aws-sigv4/signer.rb#692 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#755 def uri_escape(string); end - # source://aws-sigv4//lib/aws-sigv4/signer.rb#696 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#759 def uri_escape_path(string); end class << self # @api private # - # source://aws-sigv4//lib/aws-sigv4/signer.rb#864 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#943 + def normalize_path(uri); end + + # @api private + # + # source://aws-sigv4//lib/aws-sigv4/signer.rb#934 def uri_escape(string); end # @api private # - # source://aws-sigv4//lib/aws-sigv4/signer.rb#859 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#929 def uri_escape_path(path); end # @return [Boolean] # - # source://aws-sigv4//lib/aws-sigv4/signer.rb#854 + # source://aws-sigv4//lib/aws-sigv4/signer.rb#924 def use_crt?; end end end @@ -592,5 +660,5 @@ class Aws::Sigv4::StaticCredentialsProvider def set?; end end -# source://aws-sigv4//lib/aws-sigv4.rb#10 +# source://aws-sigv4//lib/aws-sigv4.rb#11 Aws::Sigv4::VERSION = T.let(T.unsafe(nil), String) diff --git a/sorbet/rbi/gems/axe-core-api@4.8.0.rbi b/sorbet/rbi/gems/axe-core-api@4.9.1.rbi similarity index 100% rename from sorbet/rbi/gems/axe-core-api@4.8.0.rbi rename to sorbet/rbi/gems/axe-core-api@4.9.1.rbi diff --git a/sorbet/rbi/gems/axe-core-capybara@4.8.0.rbi b/sorbet/rbi/gems/axe-core-capybara@4.9.1.rbi similarity index 100% rename from sorbet/rbi/gems/axe-core-capybara@4.8.0.rbi rename to sorbet/rbi/gems/axe-core-capybara@4.9.1.rbi diff --git a/sorbet/rbi/gems/axe-core-rspec@4.8.0.rbi b/sorbet/rbi/gems/axe-core-rspec@4.9.1.rbi similarity index 100% rename from sorbet/rbi/gems/axe-core-rspec@4.8.0.rbi rename to sorbet/rbi/gems/axe-core-rspec@4.9.1.rbi diff --git a/sorbet/rbi/gems/bcp47_spec@0.2.1.rbi b/sorbet/rbi/gems/bcp47_spec@0.2.1.rbi new file mode 100644 index 000000000..11ef0a6e7 --- /dev/null +++ b/sorbet/rbi/gems/bcp47_spec@0.2.1.rbi @@ -0,0 +1,159 @@ +# typed: true + +# DO NOT EDIT MANUALLY +# This is an autogenerated file for types exported from the `bcp47_spec` gem. +# Please instead update this file by running `bin/tapioca gem bcp47_spec`. + + +# source://bcp47_spec//lib/bcp47_spec/parser.rb#3 +module BCP47 + class << self + # @raise [InvalidLanguageTag] + # + # source://bcp47_spec//lib/bcp47_spec.rb#16 + def parse(language_tag); end + + # @return [Boolean] + # + # source://bcp47_spec//lib/bcp47_spec.rb#12 + def valid?(language_tag); end + end +end + +# source://bcp47_spec//lib/bcp47_spec.rb#7 +class BCP47::InvalidLanguageTag < ::StandardError; end + +# source://bcp47_spec//lib/bcp47_spec/parser.rb#4 +module BCP47::Parser + class << self + # source://bcp47_spec//lib/bcp47_spec/parser.rb#109 + def parse(language_tag); end + + private + + # source://bcp47_spec//lib/bcp47_spec/parser.rb#121 + def named_captures(match); end + + # source://bcp47_spec//lib/bcp47_spec/parser.rb#127 + def split_extensions(extensions); end + end +end + +# Simplified check. Not implementing high level privateuse / grandfathered. +# Should replace with a proper check at some point. +# +# source://bcp47_spec//lib/bcp47_spec/parser.rb#83 +BCP47::Parser::ALPHANUM = T.let(T.unsafe(nil), Regexp) + +# source://bcp47_spec//lib/bcp47_spec/parser.rb#92 +BCP47::Parser::EXTENSION = T.let(T.unsafe(nil), Regexp) + +# source://bcp47_spec//lib/bcp47_spec/parser.rb#86 +BCP47::Parser::EXTLANG = T.let(T.unsafe(nil), Regexp) + +# Ruby .match only keeps the first captured group, so expressions like variants/extensions we need to keep everything +# in one captured group, then break them down in multipe groups separately +# +# source://bcp47_spec//lib/bcp47_spec/parser.rb#97 +BCP47::Parser::LANGTAG = T.let(T.unsafe(nil), Regexp) + +# source://bcp47_spec//lib/bcp47_spec/parser.rb#88 +BCP47::Parser::LANGUAGE = T.let(T.unsafe(nil), Regexp) + +# source://bcp47_spec//lib/bcp47_spec/parser.rb#106 +BCP47::Parser::LANGUAGE_TAG = T.let(T.unsafe(nil), Regexp) + +# source://bcp47_spec//lib/bcp47_spec/parser.rb#93 +BCP47::Parser::PRIVATEUSE = T.let(T.unsafe(nil), Regexp) + +# source://bcp47_spec//lib/bcp47_spec/parser.rb#90 +BCP47::Parser::REGION = T.let(T.unsafe(nil), Regexp) + +# source://bcp47_spec//lib/bcp47_spec/parser.rb#89 +BCP47::Parser::SCRIPT = T.let(T.unsafe(nil), Regexp) + +# source://bcp47_spec//lib/bcp47_spec/parser.rb#84 +BCP47::Parser::SINGLETON = T.let(T.unsafe(nil), Regexp) + +# source://bcp47_spec//lib/bcp47_spec/parser.rb#91 +BCP47::Parser::VARIANT = T.let(T.unsafe(nil), Regexp) + +# source://bcp47_spec//lib/bcp47_spec.rb#9 +class BCP47::Tag < ::Struct + # Returns the value of attribute extensions + # + # @return [Object] the current value of extensions + def extensions; end + + # Sets the attribute extensions + # + # @param value [Object] the value to set the attribute extensions to. + # @return [Object] the newly set value + def extensions=(_); end + + # Returns the value of attribute language + # + # @return [Object] the current value of language + def language; end + + # Sets the attribute language + # + # @param value [Object] the value to set the attribute language to. + # @return [Object] the newly set value + def language=(_); end + + # Returns the value of attribute private + # + # @return [Object] the current value of private + def private; end + + # Sets the attribute private + # + # @param value [Object] the value to set the attribute private to. + # @return [Object] the newly set value + def private=(_); end + + # Returns the value of attribute region + # + # @return [Object] the current value of region + def region; end + + # Sets the attribute region + # + # @param value [Object] the value to set the attribute region to. + # @return [Object] the newly set value + def region=(_); end + + # Returns the value of attribute script + # + # @return [Object] the current value of script + def script; end + + # Sets the attribute script + # + # @param value [Object] the value to set the attribute script to. + # @return [Object] the newly set value + def script=(_); end + + # Returns the value of attribute variants + # + # @return [Object] the current value of variants + def variants; end + + # Sets the attribute variants + # + # @param value [Object] the value to set the attribute variants to. + # @return [Object] the newly set value + def variants=(_); end + + class << self + def [](*_arg0); end + def inspect; end + def keyword_init?; end + def members; end + def new(*_arg0); end + end +end + +# source://bcp47_spec//lib/bcp47_spec/version.rb#4 +BCP47::VERSION = T.let(T.unsafe(nil), String) diff --git a/sorbet/rbi/gems/bcrypt@3.1.19.rbi b/sorbet/rbi/gems/bcrypt@3.1.20.rbi similarity index 100% rename from sorbet/rbi/gems/bcrypt@3.1.19.rbi rename to sorbet/rbi/gems/bcrypt@3.1.20.rbi diff --git a/sorbet/rbi/gems/bigdecimal@3.1.8.rbi b/sorbet/rbi/gems/bigdecimal@3.1.8.rbi new file mode 100644 index 000000000..c275b2f77 --- /dev/null +++ b/sorbet/rbi/gems/bigdecimal@3.1.8.rbi @@ -0,0 +1,78 @@ +# typed: true + +# DO NOT EDIT MANUALLY +# This is an autogenerated file for types exported from the `bigdecimal` gem. +# Please instead update this file by running `bin/tapioca gem bigdecimal`. + + +# source://bigdecimal//lib/bigdecimal/util.rb#78 +class BigDecimal < ::Numeric + # call-seq: + # a.to_d -> bigdecimal + # + # Returns self. + # + # require 'bigdecimal/util' + # + # d = BigDecimal("3.14") + # d.to_d # => 0.314e1 + # + # source://bigdecimal//lib/bigdecimal/util.rb#110 + def to_d; end + + # call-seq: + # a.to_digits -> string + # + # Converts a BigDecimal to a String of the form "nnnnnn.mmm". + # This method is deprecated; use BigDecimal#to_s("F") instead. + # + # require 'bigdecimal/util' + # + # d = BigDecimal("3.14") + # d.to_digits # => "3.14" + # + # source://bigdecimal//lib/bigdecimal/util.rb#90 + def to_digits; end +end + +BigDecimal::VERSION = T.let(T.unsafe(nil), String) + +# source://bigdecimal//lib/bigdecimal/util.rb#138 +class Complex < ::Numeric + # call-seq: + # cmp.to_d -> bigdecimal + # cmp.to_d(precision) -> bigdecimal + # + # Returns the value as a BigDecimal. + # + # The +precision+ parameter is required for a rational complex number. + # This parameter is used to determine the number of significant digits + # for the result. + # + # require 'bigdecimal' + # require 'bigdecimal/util' + # + # Complex(0.1234567, 0).to_d(4) # => 0.1235e0 + # Complex(Rational(22, 7), 0).to_d(3) # => 0.314e1 + # + # See also Kernel.BigDecimal. + # + # source://bigdecimal//lib/bigdecimal/util.rb#157 + def to_d(*args); end +end + +# source://bigdecimal//lib/bigdecimal/util.rb#171 +class NilClass + # call-seq: + # nil.to_d -> bigdecimal + # + # Returns nil represented as a BigDecimal. + # + # require 'bigdecimal' + # require 'bigdecimal/util' + # + # nil.to_d # => 0.0 + # + # source://bigdecimal//lib/bigdecimal/util.rb#182 + def to_d; end +end diff --git a/sorbet/rbi/gems/binding_of_caller@1.0.0.rbi b/sorbet/rbi/gems/binding_of_caller@1.0.1.rbi similarity index 100% rename from sorbet/rbi/gems/binding_of_caller@1.0.0.rbi rename to sorbet/rbi/gems/binding_of_caller@1.0.1.rbi diff --git a/sorbet/rbi/gems/brakeman@6.0.1.rbi b/sorbet/rbi/gems/brakeman@6.1.2.rbi similarity index 86% rename from sorbet/rbi/gems/brakeman@6.0.1.rbi rename to sorbet/rbi/gems/brakeman@6.1.2.rbi index 397f46177..fcc65de46 100644 --- a/sorbet/rbi/gems/brakeman@6.0.1.rbi +++ b/sorbet/rbi/gems/brakeman@6.1.2.rbi @@ -8,62 +8,62 @@ # source://brakeman//lib/brakeman/version.rb#1 module Brakeman class << self - # source://brakeman//lib/brakeman.rb#572 + # source://brakeman//lib/brakeman.rb#571 def add_external_checks(options); end - # source://brakeman//lib/brakeman.rb#578 + # source://brakeman//lib/brakeman.rb#577 def check_for_missing_checks(included_checks, excluded_checks, enabled_checks); end # Compare JSON output from a previous scan and return the diff of the two scans # # @raise [ArgumentError] # - # source://brakeman//lib/brakeman.rb#483 + # source://brakeman//lib/brakeman.rb#482 def compare(options); end - # source://brakeman//lib/brakeman.rb#173 + # source://brakeman//lib/brakeman.rb#172 def config_file(custom_location, app_path); end - # source://brakeman//lib/brakeman.rb#478 + # source://brakeman//lib/brakeman.rb#477 def debug(message); end - # source://brakeman//lib/brakeman.rb#588 + # source://brakeman//lib/brakeman.rb#587 def debug=(val); end # Default set of options # - # source://brakeman//lib/brakeman.rb#180 + # source://brakeman//lib/brakeman.rb#179 def default_options; end # Output configuration to YAML # - # source://brakeman//lib/brakeman.rb#338 + # source://brakeman//lib/brakeman.rb#337 def dump_config(options); end - # source://brakeman//lib/brakeman.rb#364 + # source://brakeman//lib/brakeman.rb#363 def ensure_latest; end - # source://brakeman//lib/brakeman.rb#544 + # source://brakeman//lib/brakeman.rb#543 def filter_warnings(tracker, options); end # Determine output formats based on options[:output_formats] # or options[:output_files] # - # source://brakeman//lib/brakeman.rb#210 + # source://brakeman//lib/brakeman.rb#209 def get_output_formats(options); end # Returns an array of alert fingerprints for any ignored warnings without # notes found in the specified ignore file (if it exists). # - # source://brakeman//lib/brakeman.rb#534 + # source://brakeman//lib/brakeman.rb#533 def ignore_file_entries_with_empty_notes(file); end # Output list of checks (for `-k` option) # - # source://brakeman//lib/brakeman.rb#316 + # source://brakeman//lib/brakeman.rb#315 def list_checks(options); end - # source://brakeman//lib/brakeman.rb#506 + # source://brakeman//lib/brakeman.rb#505 def load_brakeman_dependency(name, allow_fail = T.unsafe(nil)); end # Load options from YAML file @@ -71,10 +71,10 @@ module Brakeman # source://brakeman//lib/brakeman.rb#124 def load_options(line_options); end - # source://brakeman//lib/brakeman.rb#474 + # source://brakeman//lib/brakeman.rb#473 def notify(message); end - # source://brakeman//lib/brakeman.rb#592 + # source://brakeman//lib/brakeman.rb#591 def quiet=(val); end # Rescan a subset of files in a Rails application. @@ -89,7 +89,7 @@ module Brakeman # This method returns a RescanReport object with information about the scan. # However, the Tracker object will also be modified as the scan is run. # - # source://brakeman//lib/brakeman.rb#463 + # source://brakeman//lib/brakeman.rb#462 def rescan(tracker, files, options = T.unsafe(nil)); end # Run Brakeman scan. Returns Tracker object. @@ -142,7 +142,7 @@ module Brakeman # Run a scan. Generally called from Brakeman.run instead of directly. # - # source://brakeman//lib/brakeman.rb#373 + # source://brakeman//lib/brakeman.rb#372 def scan(options); end # Sets up options for run, checks given application path @@ -152,27 +152,27 @@ module Brakeman private - # source://brakeman//lib/brakeman.rb#263 + # source://brakeman//lib/brakeman.rb#262 def get_formats_from_output_files(output_files); end - # source://brakeman//lib/brakeman.rb#229 + # source://brakeman//lib/brakeman.rb#228 def get_formats_from_output_format(output_format); end - # source://brakeman//lib/brakeman.rb#299 + # source://brakeman//lib/brakeman.rb#298 def get_github_url(options); end - # source://brakeman//lib/brakeman.rb#417 + # source://brakeman//lib/brakeman.rb#416 def write_report_to_files(tracker, output_files); end - # source://brakeman//lib/brakeman.rb#435 + # source://brakeman//lib/brakeman.rb#434 def write_report_to_formats(tracker, output_formats); end end end -# source://brakeman//lib/brakeman.rb#161 +# source://brakeman//lib/brakeman.rb#160 Brakeman::CONFIG_FILES = T.let(T.unsafe(nil), Array) -# source://brakeman//lib/brakeman.rb#596 +# source://brakeman//lib/brakeman.rb#595 class Brakeman::DependencyError < ::RuntimeError; end # Exit code returned when an ignored warning has no note and @@ -187,7 +187,7 @@ Brakeman::Empty_Ignore_Note_Exit_Code = T.let(T.unsafe(nil), Integer) # source://brakeman//lib/brakeman.rb#21 Brakeman::Errors_Found_Exit_Code = T.let(T.unsafe(nil), Integer) -# source://brakeman//lib/brakeman.rb#599 +# source://brakeman//lib/brakeman.rb#598 class Brakeman::MissingChecksError < ::RuntimeError; end # Exit code returned when user requests non-existent checks @@ -195,10 +195,10 @@ class Brakeman::MissingChecksError < ::RuntimeError; end # source://brakeman//lib/brakeman.rb#17 Brakeman::Missing_Checks_Exit_Code = T.let(T.unsafe(nil), Integer) -# source://brakeman//lib/brakeman.rb#598 +# source://brakeman//lib/brakeman.rb#597 class Brakeman::NoApplication < ::RuntimeError; end -# source://brakeman//lib/brakeman.rb#597 +# source://brakeman//lib/brakeman.rb#596 class Brakeman::NoBrakemanError < ::RuntimeError; end # Exit code returned when no Rails application is detected diff --git a/sorbet/rbi/gems/capistrano-aws@1.3.0.rbi b/sorbet/rbi/gems/capistrano-aws@1.4.0.rbi similarity index 100% rename from sorbet/rbi/gems/capistrano-aws@1.3.0.rbi rename to sorbet/rbi/gems/capistrano-aws@1.4.0.rbi diff --git a/sorbet/rbi/gems/capistrano@3.17.3.rbi b/sorbet/rbi/gems/capistrano@3.19.1.rbi similarity index 100% rename from sorbet/rbi/gems/capistrano@3.17.3.rbi rename to sorbet/rbi/gems/capistrano@3.19.1.rbi diff --git a/sorbet/rbi/gems/capybara@3.39.2.rbi b/sorbet/rbi/gems/capybara@3.40.0.rbi similarity index 89% rename from sorbet/rbi/gems/capybara@3.39.2.rbi rename to sorbet/rbi/gems/capybara@3.40.0.rbi index dc1c69c35..28894b36f 100644 --- a/sorbet/rbi/gems/capybara@3.39.2.rbi +++ b/sorbet/rbi/gems/capybara@3.40.0.rbi @@ -15,7 +15,7 @@ module Capybara # @param html [String] The raw html # @return [Nokogiri::HTML::Document] HTML document # - # source://capybara//lib/capybara.rb#389 + # source://capybara//lib/capybara.rb#390 def HTML(html); end # Add a new selector to Capybara. Selectors can be used by various methods in Capybara @@ -406,10 +406,10 @@ module Capybara # source://capybara//lib/capybara.rb#337 def session_name; end - # source://capybara//lib/capybara.rb#345 + # source://capybara//lib/capybara.rb#346 def session_name=(name); end - # source://capybara//lib/capybara.rb#409 + # source://capybara//lib/capybara.rb#410 def session_options; end # Wraps the given string, which should contain an HTML document or fragment @@ -475,7 +475,7 @@ module Capybara # Yield a block using a specific session name or {Capybara::Session} instance. # - # source://capybara//lib/capybara.rb#357 + # source://capybara//lib/capybara.rb#358 def using_session(name_or_session, &block); end # Yield a block using a specific wait time @@ -497,16 +497,16 @@ module Capybara private - # source://capybara//lib/capybara.rb#415 + # source://capybara//lib/capybara.rb#416 def config; end - # source://capybara//lib/capybara.rb#419 + # source://capybara//lib/capybara.rb#420 def session_pool; end - # source://capybara//lib/capybara.rb#425 + # source://capybara//lib/capybara.rb#426 def specified_session; end - # source://capybara//lib/capybara.rb#433 + # source://capybara//lib/capybara.rb#434 def specified_session=(session); end end end @@ -943,6 +943,9 @@ module Capybara::DSL # source://capybara//lib/capybara/dsl.rb#51 def has_current_path?(*_arg0, **_arg1, &_arg2); end + # source://capybara//lib/capybara/dsl.rb#51 + def has_element?(*_arg0, **_arg1, &_arg2); end + # source://capybara//lib/capybara/dsl.rb#51 def has_field?(*_arg0, **_arg1, &_arg2); end @@ -964,6 +967,9 @@ module Capybara::DSL # source://capybara//lib/capybara/dsl.rb#51 def has_no_current_path?(*_arg0, **_arg1, &_arg2); end + # source://capybara//lib/capybara/dsl.rb#51 + def has_no_element?(*_arg0, **_arg1, &_arg2); end + # source://capybara//lib/capybara/dsl.rb#51 def has_no_field?(*_arg0, **_arg1, &_arg2); end @@ -1150,7 +1156,7 @@ module Capybara::DSL end end -# source://capybara//lib/capybara.rb#446 +# source://capybara//lib/capybara.rb#447 module Capybara::Driver; end # source://capybara//lib/capybara/driver/base.rb#3 @@ -1746,12 +1752,12 @@ module Capybara::Minitest::Assertions # See {Capybara::Node::Matchers#has_button?} # - # source://capybara//lib/capybara/minitest.rb#285 + # source://capybara//lib/capybara/minitest.rb#298 def assert_button(*args, &optional_filter_block); end # See {Capybara::Node::Matchers#has_checked_field?} # - # source://capybara//lib/capybara/minitest.rb#302 + # source://capybara//lib/capybara/minitest.rb#315 def assert_checked_field(*args, &optional_filter_block); end # See {Capybara::Node::Matchers#assert_text} @@ -1761,7 +1767,7 @@ module Capybara::Minitest::Assertions # See {Capybara::Node::Matchers#has_css?} # - # source://capybara//lib/capybara/minitest.rb#285 + # source://capybara//lib/capybara/minitest.rb#298 def assert_css(*args, &optional_filter_block); end # See {Capybara::SessionMatchers#assert_current_path} @@ -1769,19 +1775,24 @@ module Capybara::Minitest::Assertions # source://capybara//lib/capybara/minitest.rb#53 def assert_current_path(*args, **kwargs, &optional_filter_block); end + # See {Capybara::Node::Matchers#has_element?} + # + # source://capybara//lib/capybara/minitest.rb#298 + def assert_element(*args, &optional_filter_block); end + # See {Capybara::Node::Matchers#has_field?} # - # source://capybara//lib/capybara/minitest.rb#285 + # source://capybara//lib/capybara/minitest.rb#298 def assert_field(*args, &optional_filter_block); end # See {Capybara::Node::Matchers#has_link?} # - # source://capybara//lib/capybara/minitest.rb#285 + # source://capybara//lib/capybara/minitest.rb#298 def assert_link(*args, &optional_filter_block); end # See {Capybara::Node::Matchers#matches_css?} # - # source://capybara//lib/capybara/minitest.rb#351 + # source://capybara//lib/capybara/minitest.rb#364 def assert_matches_css(*args, &optional_filter_block); end # See {Capybara::Node::Matchers#assert_matches_selector} @@ -1796,7 +1807,7 @@ module Capybara::Minitest::Assertions # See {Capybara::Node::Matchers#matches_xpath?} # - # source://capybara//lib/capybara/minitest.rb#351 + # source://capybara//lib/capybara/minitest.rb#364 def assert_matches_xpath(*args, &optional_filter_block); end # See {Capybara::Node::Matchers#assert_no_ancestor} @@ -1806,12 +1817,12 @@ module Capybara::Minitest::Assertions # See {Capybara::Node::Matchers#has_no_button?} # - # source://capybara//lib/capybara/minitest.rb#292 + # source://capybara//lib/capybara/minitest.rb#305 def assert_no_button(*args, &optional_filter_block); end # Assert that provided checked_field does not exist # - # source://capybara//lib/capybara/minitest.rb#309 + # source://capybara//lib/capybara/minitest.rb#322 def assert_no_checked_field(*args, &optional_filter_block); end # See {Capybara::Node::Matchers#assert_no_text} @@ -1821,7 +1832,7 @@ module Capybara::Minitest::Assertions # See {Capybara::Node::Matchers#has_no_css?} # - # source://capybara//lib/capybara/minitest.rb#292 + # source://capybara//lib/capybara/minitest.rb#305 def assert_no_css(*args, &optional_filter_block); end # See {Capybara::SessionMatchers#assert_no_current_path} @@ -1829,19 +1840,24 @@ module Capybara::Minitest::Assertions # source://capybara//lib/capybara/minitest.rb#53 def assert_no_current_path(*args, **kwargs, &optional_filter_block); end + # Assert that provided element does not exist + # + # source://capybara//lib/capybara/minitest.rb#305 + def assert_no_element(*args, &optional_filter_block); end + # See {Capybara::Node::Matchers#has_no_field?} # - # source://capybara//lib/capybara/minitest.rb#292 + # source://capybara//lib/capybara/minitest.rb#305 def assert_no_field(*args, &optional_filter_block); end # Assert that provided link does not exist # - # source://capybara//lib/capybara/minitest.rb#292 + # source://capybara//lib/capybara/minitest.rb#305 def assert_no_link(*args, &optional_filter_block); end # See {Capybara::Node::Matchers#has_no_select?} # - # source://capybara//lib/capybara/minitest.rb#292 + # source://capybara//lib/capybara/minitest.rb#305 def assert_no_select(*args, &optional_filter_block); end # See {Capybara::Node::Matchers#assert_no_selector} @@ -1856,7 +1872,7 @@ module Capybara::Minitest::Assertions # See {Capybara::Node::Matchers#has_no_table?} # - # source://capybara//lib/capybara/minitest.rb#292 + # source://capybara//lib/capybara/minitest.rb#305 def assert_no_table(*args, &optional_filter_block); end # See {Capybara::Node::Matchers#assert_no_text} @@ -1871,12 +1887,12 @@ module Capybara::Minitest::Assertions # Assert that provided unchecked field does not exist # - # source://capybara//lib/capybara/minitest.rb#309 + # source://capybara//lib/capybara/minitest.rb#322 def assert_no_unchecked_field(*args, &optional_filter_block); end # See {Capybara::Node::Matchers#has_no_xpath?} # - # source://capybara//lib/capybara/minitest.rb#292 + # source://capybara//lib/capybara/minitest.rb#305 def assert_no_xpath(*args, &optional_filter_block); end # See {Capybara::Node::Matchers#assert_none_of_selectors} @@ -1886,7 +1902,7 @@ module Capybara::Minitest::Assertions # See {Capybara::Node::Matchers#not_matches_css?} # - # source://capybara//lib/capybara/minitest.rb#357 + # source://capybara//lib/capybara/minitest.rb#370 def assert_not_matches_css(*args, &optional_filter_block); end # See {Capybara::Node::Matchers#assert_not_matches_selector} @@ -1896,12 +1912,12 @@ module Capybara::Minitest::Assertions # See {Capybara::Node::Matchers#not_matches_xpath?} # - # source://capybara//lib/capybara/minitest.rb#357 + # source://capybara//lib/capybara/minitest.rb#370 def assert_not_matches_xpath(*args, &optional_filter_block); end # See {Capybara::Node::Matchers#has_select?} # - # source://capybara//lib/capybara/minitest.rb#285 + # source://capybara//lib/capybara/minitest.rb#298 def assert_select(*args, &optional_filter_block); end # See {Capybara::Node::Matchers#assert_selector} @@ -1916,7 +1932,7 @@ module Capybara::Minitest::Assertions # See {Capybara::Node::Matchers#has_table?} # - # source://capybara//lib/capybara/minitest.rb#285 + # source://capybara//lib/capybara/minitest.rb#298 def assert_table(*args, &optional_filter_block); end # See {Capybara::Node::Matchers#assert_text} @@ -1931,12 +1947,12 @@ module Capybara::Minitest::Assertions # See {Capybara::Node::Matchers#has_unchecked_field?} # - # source://capybara//lib/capybara/minitest.rb#302 + # source://capybara//lib/capybara/minitest.rb#315 def assert_unchecked_field(*args, &optional_filter_block); end # See {Capybara::Node::Matchers#has_xpath?} # - # source://capybara//lib/capybara/minitest.rb#285 + # source://capybara//lib/capybara/minitest.rb#298 def assert_xpath(*args, &optional_filter_block); end # See {Capybara::Node::Matchers#assert_no_ancestor} @@ -1946,12 +1962,12 @@ module Capybara::Minitest::Assertions # Assert that provided button does not exist # - # source://capybara//lib/capybara/minitest.rb#292 + # source://capybara//lib/capybara/minitest.rb#305 def refute_button(*args, &optional_filter_block); end # See {Capybara::Node::Matchers#has_no_checked_field?} # - # source://capybara//lib/capybara/minitest.rb#309 + # source://capybara//lib/capybara/minitest.rb#322 def refute_checked_field(*args, &optional_filter_block); end # See {Capybara::Node::Matchers#assert_no_text} @@ -1961,7 +1977,7 @@ module Capybara::Minitest::Assertions # Assert that provided css does not exist # - # source://capybara//lib/capybara/minitest.rb#292 + # source://capybara//lib/capybara/minitest.rb#305 def refute_css(*args, &optional_filter_block); end # See {Capybara::SessionMatchers#assert_no_current_path} @@ -1969,19 +1985,24 @@ module Capybara::Minitest::Assertions # source://capybara//lib/capybara/minitest.rb#53 def refute_current_path(*args, **kwargs, &optional_filter_block); end + # See {Capybara::Node::Matchers#has_no_element?} + # + # source://capybara//lib/capybara/minitest.rb#305 + def refute_element(*args, &optional_filter_block); end + # Assert that provided field does not exist # - # source://capybara//lib/capybara/minitest.rb#292 + # source://capybara//lib/capybara/minitest.rb#305 def refute_field(*args, &optional_filter_block); end # See {Capybara::Node::Matchers#has_no_link?} # - # source://capybara//lib/capybara/minitest.rb#292 + # source://capybara//lib/capybara/minitest.rb#305 def refute_link(*args, &optional_filter_block); end # Assert that element matches css # - # source://capybara//lib/capybara/minitest.rb#357 + # source://capybara//lib/capybara/minitest.rb#370 def refute_matches_css(*args, &optional_filter_block); end # See {Capybara::Node::Matchers#assert_not_matches_selector} @@ -1991,12 +2012,12 @@ module Capybara::Minitest::Assertions # Assert that element does not match xpath # - # source://capybara//lib/capybara/minitest.rb#357 + # source://capybara//lib/capybara/minitest.rb#370 def refute_matches_xpath(*args, &optional_filter_block); end # Assert that provided select does not exist # - # source://capybara//lib/capybara/minitest.rb#292 + # source://capybara//lib/capybara/minitest.rb#305 def refute_select(*args, &optional_filter_block); end # See {Capybara::Node::Matchers#assert_no_selector} @@ -2011,7 +2032,7 @@ module Capybara::Minitest::Assertions # Assert that provided table does not exist # - # source://capybara//lib/capybara/minitest.rb#292 + # source://capybara//lib/capybara/minitest.rb#305 def refute_table(*args, &optional_filter_block); end # See {Capybara::Node::Matchers#assert_no_text} @@ -2026,20 +2047,20 @@ module Capybara::Minitest::Assertions # See {Capybara::Node::Matchers#has_no_unchecked_field?} # - # source://capybara//lib/capybara/minitest.rb#309 + # source://capybara//lib/capybara/minitest.rb#322 def refute_unchecked_field(*args, &optional_filter_block); end # Assert that provide xpath does not exist # - # source://capybara//lib/capybara/minitest.rb#292 + # source://capybara//lib/capybara/minitest.rb#305 def refute_xpath(*args, &optional_filter_block); end private - # source://capybara//lib/capybara/minitest.rb#367 + # source://capybara//lib/capybara/minitest.rb#380 def determine_subject(args); end - # source://capybara//lib/capybara/minitest.rb#378 + # source://capybara//lib/capybara/minitest.rb#391 def extract_locator(args); end end @@ -3158,7 +3179,7 @@ end # source://capybara//lib/capybara/node/matchers.rb#5 module Capybara::Node::Matchers - # source://capybara//lib/capybara/node/matchers.rb#816 + # source://capybara//lib/capybara/node/matchers.rb#841 def ==(other); end # Asserts that all of the provided selectors are present on the given page @@ -3191,7 +3212,7 @@ module Capybara::Node::Matchers # @param options [Hash] a customizable set of options # @raise [Capybara::ExpectationNotMet] If the selector does not exist # - # source://capybara//lib/capybara/node/matchers.rb#741 + # source://capybara//lib/capybara/node/matchers.rb#766 def assert_ancestor(*args, &optional_filter_block); end # Asserts that any of the provided selectors are present on the given page @@ -3228,7 +3249,7 @@ module Capybara::Node::Matchers # @param options [Hash] a customizable set of options # @raise [Capybara::ExpectationNotMet] If the selector does not match # - # source://capybara//lib/capybara/node/matchers.rb#561 + # source://capybara//lib/capybara/node/matchers.rb#586 def assert_matches_selector(*args, &optional_filter_block); end # Asserts that an element has the specified CSS styles. @@ -3241,7 +3262,7 @@ module Capybara::Node::Matchers # source://capybara//lib/capybara/node/matchers.rb#126 def assert_matches_style(styles = T.unsafe(nil), **options); end - # source://capybara//lib/capybara/node/matchers.rb#749 + # source://capybara//lib/capybara/node/matchers.rb#774 def assert_no_ancestor(*args, &optional_filter_block); end # Asserts that a given selector is not on the page or a descendant of the current node. @@ -3263,7 +3284,7 @@ module Capybara::Node::Matchers # source://capybara//lib/capybara/node/matchers.rb#233 def assert_no_selector(*args, &optional_filter_block); end - # source://capybara//lib/capybara/node/matchers.rb#792 + # source://capybara//lib/capybara/node/matchers.rb#817 def assert_no_sibling(*args, &optional_filter_block); end # Asserts that the page or current node doesn't have the given text content, @@ -3274,7 +3295,7 @@ module Capybara::Node::Matchers # @raise [Capybara::ExpectationNotMet] if the assertion hasn't succeeded during wait time # @return [true] # - # source://capybara//lib/capybara/node/matchers.rb#691 + # source://capybara//lib/capybara/node/matchers.rb#716 def assert_no_text(type_or_text, *args, **opts); end # Asserts that none of the provided selectors are present on the given page @@ -3303,7 +3324,7 @@ module Capybara::Node::Matchers # @param options [Hash] a customizable set of options # @raise [Capybara::ExpectationNotMet] If the selector matches # - # source://capybara//lib/capybara/node/matchers.rb#575 + # source://capybara//lib/capybara/node/matchers.rb#600 def assert_not_matches_selector(*args, &optional_filter_block); end # Asserts that a given selector is on the page or a descendant of the current node. @@ -3354,7 +3375,7 @@ module Capybara::Node::Matchers # @param options [Hash] a customizable set of options # @raise [Capybara::ExpectationNotMet] If the selector does not exist # - # source://capybara//lib/capybara/node/matchers.rb#784 + # source://capybara//lib/capybara/node/matchers.rb#809 def assert_sibling(*args, &optional_filter_block); end # @deprecated Use {#assert_matches_style} instead. @@ -3370,14 +3391,14 @@ module Capybara::Node::Matchers # @raise [Capybara::ExpectationNotMet] if the assertion hasn't succeeded during wait time # @return [true] # - # source://capybara//lib/capybara/node/matchers.rb#675 + # source://capybara//lib/capybara/node/matchers.rb#700 def assert_text(type_or_text, *args, **opts); end # Predicate version of {#assert_ancestor} # # @return [Boolean] # - # source://capybara//lib/capybara/node/matchers.rb#761 + # source://capybara//lib/capybara/node/matchers.rb#786 def has_ancestor?(*args, **options, &optional_filter_block); end # Checks if the page or current node has a button with the given @@ -3386,7 +3407,7 @@ module Capybara::Node::Matchers # @param locator [String] The text, value or id of a button to check for # @return [Boolean] Whether it exists # - # source://capybara//lib/capybara/node/matchers.rb#358 + # source://capybara//lib/capybara/node/matchers.rb#383 def has_button?(locator = T.unsafe(nil), **options, &optional_filter_block); end # Checks if the page or current node has a radio button or @@ -3396,7 +3417,7 @@ module Capybara::Node::Matchers # @param locator [String] The label, name or id of a checked field # @return [Boolean] Whether it exists # - # source://capybara//lib/capybara/node/matchers.rb#423 + # source://capybara//lib/capybara/node/matchers.rb#448 def has_checked_field?(locator = T.unsafe(nil), **options, &optional_filter_block); end # Checks if the page or current node has the given text content, @@ -3413,7 +3434,7 @@ module Capybara::Node::Matchers # @overload has_text? # @return [Boolean] Whether it exists # - # source://capybara//lib/capybara/node/matchers.rb#713 + # source://capybara//lib/capybara/node/matchers.rb#738 def has_content?(*args, **options); end # Checks if a given CSS selector is on the page or a descendant of the current node. @@ -3440,6 +3461,17 @@ module Capybara::Node::Matchers # source://capybara//lib/capybara/node/matchers.rb#309 def has_css?(path, **options, &optional_filter_block); end + # Checks if the page or current node has a element with the given + # local name. + # + # @option options + # @param locator [String] The local name of a element to check for + # @param options [Hash] a customizable set of options + # @return [Boolean] Whether it exists + # + # source://capybara//lib/capybara/node/matchers.rb#334 + def has_element?(locator = T.unsafe(nil), **options, &optional_filter_block); end + # Checks if the page or current node has a form field with the given # label, name or id. # @@ -3461,7 +3493,7 @@ module Capybara::Node::Matchers # @param options [Hash] a customizable set of options # @return [Boolean] Whether it exists # - # source://capybara//lib/capybara/node/matchers.rb#396 + # source://capybara//lib/capybara/node/matchers.rb#421 def has_field?(locator = T.unsafe(nil), **options, &optional_filter_block); end # Checks if the page or current node has a link with the given @@ -3472,14 +3504,14 @@ module Capybara::Node::Matchers # @param options [Hash] a customizable set of options # @return [Boolean] Whether it exists # - # source://capybara//lib/capybara/node/matchers.rb#334 + # source://capybara//lib/capybara/node/matchers.rb#359 def has_link?(locator = T.unsafe(nil), **options, &optional_filter_block); end # Predicate version of {#assert_no_ancestor} # # @return [Boolean] # - # source://capybara//lib/capybara/node/matchers.rb#769 + # source://capybara//lib/capybara/node/matchers.rb#794 def has_no_ancestor?(*args, **options, &optional_filter_block); end # Checks if the page or current node has no button with the given @@ -3488,7 +3520,7 @@ module Capybara::Node::Matchers # @param locator [String] The text, value or id of a button to check for # @return [Boolean] Whether it doesn't exist # - # source://capybara//lib/capybara/node/matchers.rb#370 + # source://capybara//lib/capybara/node/matchers.rb#395 def has_no_button?(locator = T.unsafe(nil), **options, &optional_filter_block); end # Checks if the page or current node has no radio button or @@ -3498,7 +3530,7 @@ module Capybara::Node::Matchers # @param locator [String] The label, name or id of a checked field # @return [Boolean] Whether it doesn't exist # - # source://capybara//lib/capybara/node/matchers.rb#436 + # source://capybara//lib/capybara/node/matchers.rb#461 def has_no_checked_field?(locator = T.unsafe(nil), **options, &optional_filter_block); end # Checks if the page or current node does not have the given text @@ -3508,7 +3540,7 @@ module Capybara::Node::Matchers # @overload has_no_text? # @return [Boolean] Whether it doesn't exist # - # source://capybara//lib/capybara/node/matchers.rb#725 + # source://capybara//lib/capybara/node/matchers.rb#750 def has_no_content?(*args, **options); end # Checks if a given CSS selector is not on the page or a descendant of the current node. @@ -3521,6 +3553,16 @@ module Capybara::Node::Matchers # source://capybara//lib/capybara/node/matchers.rb#321 def has_no_css?(path, **options, &optional_filter_block); end + # Checks if the page or current node has no element with the given + # local name. + # + # @param locator [String] The local name of a element to check for + # @param options [Hash] a customizable set of options + # @return [Boolean] Whether it doesn't exist + # + # source://capybara//lib/capybara/node/matchers.rb#346 + def has_no_element?(locator = T.unsafe(nil), **options, &optional_filter_block); end + # Checks if the page or current node has no form field with the given # label, name or id. See {#has_field?}. # @@ -3530,7 +3572,7 @@ module Capybara::Node::Matchers # @param options [Hash] a customizable set of options # @return [Boolean] Whether it doesn't exist # - # source://capybara//lib/capybara/node/matchers.rb#410 + # source://capybara//lib/capybara/node/matchers.rb#435 def has_no_field?(locator = T.unsafe(nil), **options, &optional_filter_block); end # Checks if the page or current node has no link with the given @@ -3540,7 +3582,7 @@ module Capybara::Node::Matchers # @param options [Hash] a customizable set of options # @return [Boolean] Whether it doesn't exist # - # source://capybara//lib/capybara/node/matchers.rb#346 + # source://capybara//lib/capybara/node/matchers.rb#371 def has_no_link?(locator = T.unsafe(nil), **options, &optional_filter_block); end # Checks if the page or current node has no select field with the @@ -3550,7 +3592,7 @@ module Capybara::Node::Matchers # @param options [Hash] a customizable set of options # @return [Boolean] Whether it doesn't exist # - # source://capybara//lib/capybara/node/matchers.rb#507 + # source://capybara//lib/capybara/node/matchers.rb#532 def has_no_select?(locator = T.unsafe(nil), **options, &optional_filter_block); end # Checks if a given selector is not on the page or a descendant of the current node. @@ -3568,7 +3610,7 @@ module Capybara::Node::Matchers # # @return [Boolean] # - # source://capybara//lib/capybara/node/matchers.rb#812 + # source://capybara//lib/capybara/node/matchers.rb#837 def has_no_sibling?(*args, **options, &optional_filter_block); end # Checks if the page or current node has no table with the given id @@ -3578,7 +3620,7 @@ module Capybara::Node::Matchers # @param options [Hash] a customizable set of options # @return [Boolean] Whether it doesn't exist # - # source://capybara//lib/capybara/node/matchers.rb#541 + # source://capybara//lib/capybara/node/matchers.rb#566 def has_no_table?(locator = T.unsafe(nil), **options, &optional_filter_block); end # Checks if the page or current node does not have the given text @@ -3588,7 +3630,7 @@ module Capybara::Node::Matchers # @overload has_no_text? # @return [Boolean] Whether it doesn't exist # - # source://capybara//lib/capybara/node/matchers.rb#725 + # source://capybara//lib/capybara/node/matchers.rb#750 def has_no_text?(*args, **options); end # Checks if the page or current node has no radio button or @@ -3598,7 +3640,7 @@ module Capybara::Node::Matchers # @param locator [String] The label, name or id of an unchecked field # @return [Boolean] Whether it doesn't exist # - # source://capybara//lib/capybara/node/matchers.rb#462 + # source://capybara//lib/capybara/node/matchers.rb#487 def has_no_unchecked_field?(locator = T.unsafe(nil), **options, &optional_filter_block); end # Checks if a given XPath expression is not on the page or a descendant of the current node. @@ -3639,7 +3681,7 @@ module Capybara::Node::Matchers # @param options [Hash] a customizable set of options # @return [Boolean] Whether it exists # - # source://capybara//lib/capybara/node/matchers.rb#495 + # source://capybara//lib/capybara/node/matchers.rb#520 def has_select?(locator = T.unsafe(nil), **options, &optional_filter_block); end # Checks if a given selector is on the page or a descendant of the current node. @@ -3681,7 +3723,7 @@ module Capybara::Node::Matchers # # @return [Boolean] # - # source://capybara//lib/capybara/node/matchers.rb#804 + # source://capybara//lib/capybara/node/matchers.rb#829 def has_sibling?(*args, **options, &optional_filter_block); end # @deprecated Use {#matches_style?} instead. @@ -3703,7 +3745,7 @@ module Capybara::Node::Matchers # @param options [Hash] a customizable set of options # @return [Boolean] Whether it exists # - # source://capybara//lib/capybara/node/matchers.rb#529 + # source://capybara//lib/capybara/node/matchers.rb#554 def has_table?(locator = T.unsafe(nil), **options, &optional_filter_block); end # Checks if the page or current node has the given text content, @@ -3720,7 +3762,7 @@ module Capybara::Node::Matchers # @overload has_text? # @return [Boolean] Whether it exists # - # source://capybara//lib/capybara/node/matchers.rb#713 + # source://capybara//lib/capybara/node/matchers.rb#738 def has_text?(*args, **options); end # Checks if the page or current node has a radio button or @@ -3730,7 +3772,7 @@ module Capybara::Node::Matchers # @param locator [String] The label, name or id of an unchecked field # @return [Boolean] Whether it exists # - # source://capybara//lib/capybara/node/matchers.rb#449 + # source://capybara//lib/capybara/node/matchers.rb#474 def has_unchecked_field?(locator = T.unsafe(nil), **options, &optional_filter_block); end # Checks if a given XPath expression is on the page or a descendant of the current node. @@ -3768,7 +3810,7 @@ module Capybara::Node::Matchers # @param css [String] The CSS selector to match against the current code # @return [Boolean] # - # source://capybara//lib/capybara/node/matchers.rb#610 + # source://capybara//lib/capybara/node/matchers.rb#635 def matches_css?(css, **options, &optional_filter_block); end # Checks if the current node matches given selector. @@ -3778,7 +3820,7 @@ module Capybara::Node::Matchers # @param options [Hash] a customizable set of options # @return [Boolean] # - # source://capybara//lib/capybara/node/matchers.rb#588 + # source://capybara//lib/capybara/node/matchers.rb#613 def matches_selector?(*args, **options, &optional_filter_block); end # Checks if a an element has the specified CSS styles. @@ -3796,7 +3838,7 @@ module Capybara::Node::Matchers # @param xpath [String, XPath::Expression] The XPath expression to match against the current code # @return [Boolean] # - # source://capybara//lib/capybara/node/matchers.rb#599 + # source://capybara//lib/capybara/node/matchers.rb#624 def matches_xpath?(xpath, **options, &optional_filter_block); end # Checks if the current node does not match given CSS selector. @@ -3804,7 +3846,7 @@ module Capybara::Node::Matchers # @param css [String] The CSS selector to match against the current code # @return [Boolean] # - # source://capybara//lib/capybara/node/matchers.rb#644 + # source://capybara//lib/capybara/node/matchers.rb#669 def not_matches_css?(css, **options, &optional_filter_block); end # Checks if the current node does not match given selector. @@ -3815,7 +3857,7 @@ module Capybara::Node::Matchers # @param options [Hash] a customizable set of options # @return [Boolean] # - # source://capybara//lib/capybara/node/matchers.rb#622 + # source://capybara//lib/capybara/node/matchers.rb#647 def not_matches_selector?(*args, **options, &optional_filter_block); end # Checks if the current node does not match given XPath expression. @@ -3823,30 +3865,30 @@ module Capybara::Node::Matchers # @param xpath [String, XPath::Expression] The XPath expression to match against the current code # @return [Boolean] # - # source://capybara//lib/capybara/node/matchers.rb#633 + # source://capybara//lib/capybara/node/matchers.rb#658 def not_matches_xpath?(xpath, **options, &optional_filter_block); end private - # source://capybara//lib/capybara/node/matchers.rb#867 + # source://capybara//lib/capybara/node/matchers.rb#892 def _set_query_session_options(*query_args); end - # source://capybara//lib/capybara/node/matchers.rb#849 + # source://capybara//lib/capybara/node/matchers.rb#874 def _verify_match_result(query_args, optional_filter_block); end - # source://capybara//lib/capybara/node/matchers.rb#826 + # source://capybara//lib/capybara/node/matchers.rb#851 def _verify_multiple(*args, wait: T.unsafe(nil), **options); end - # source://capybara//lib/capybara/node/matchers.rb#834 + # source://capybara//lib/capybara/node/matchers.rb#859 def _verify_selector_result(query_args, optional_filter_block, query_type = T.unsafe(nil)); end - # source://capybara//lib/capybara/node/matchers.rb#858 + # source://capybara//lib/capybara/node/matchers.rb#883 def _verify_text(type = T.unsafe(nil), expected_text, **query_options); end - # source://capybara//lib/capybara/node/matchers.rb#822 + # source://capybara//lib/capybara/node/matchers.rb#847 def extract_selector(args); end - # source://capybara//lib/capybara/node/matchers.rb#875 + # source://capybara//lib/capybara/node/matchers.rb#900 def make_predicate(options); end end @@ -4293,12 +4335,12 @@ class Capybara::Queries::SelectorQuery < ::Capybara::Queries::BaseQuery # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#113 + # source://capybara//lib/capybara/queries/selector_query.rb#114 def applied_description; end # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#154 + # source://capybara//lib/capybara/queries/selector_query.rb#155 def css; end # @api private @@ -4309,7 +4351,7 @@ class Capybara::Queries::SelectorQuery < ::Capybara::Queries::BaseQuery # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#137 + # source://capybara//lib/capybara/queries/selector_query.rb#138 def exact?; end # @api private @@ -4319,7 +4361,7 @@ class Capybara::Queries::SelectorQuery < ::Capybara::Queries::BaseQuery # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#178 + # source://capybara//lib/capybara/queries/selector_query.rb#179 def failure_message; end # @api private @@ -4334,13 +4376,13 @@ class Capybara::Queries::SelectorQuery < ::Capybara::Queries::BaseQuery # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#141 + # source://capybara//lib/capybara/queries/selector_query.rb#142 def match; end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#117 + # source://capybara//lib/capybara/queries/selector_query.rb#118 def matches_filters?(node, node_filter_errors = T.unsafe(nil)); end # @api private @@ -4350,7 +4392,7 @@ class Capybara::Queries::SelectorQuery < ::Capybara::Queries::BaseQuery # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#182 + # source://capybara//lib/capybara/queries/selector_query.rb#183 def negative_failure_message; end # @api private @@ -4360,7 +4402,7 @@ class Capybara::Queries::SelectorQuery < ::Capybara::Queries::BaseQuery # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#159 + # source://capybara//lib/capybara/queries/selector_query.rb#160 def resolve_for(node, exact = T.unsafe(nil)); end # @api private @@ -4371,392 +4413,392 @@ class Capybara::Queries::SelectorQuery < ::Capybara::Queries::BaseQuery # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#172 + # source://capybara//lib/capybara/queries/selector_query.rb#173 def supports_exact?; end # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#129 + # source://capybara//lib/capybara/queries/selector_query.rb#130 def visible; end # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#145 + # source://capybara//lib/capybara/queries/selector_query.rb#146 def xpath(exact = T.unsafe(nil)); end private # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#230 + # source://capybara//lib/capybara/queries/selector_query.rb#231 def applied_filters; end # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#390 + # source://capybara//lib/capybara/queries/selector_query.rb#391 def apply_expression_filters(expression); end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#433 + # source://capybara//lib/capybara/queries/selector_query.rb#434 def apply_filter?(filter); end # @api private # @raise [ArgumentError] # - # source://capybara//lib/capybara/queries/selector_query.rb#344 + # source://capybara//lib/capybara/queries/selector_query.rb#345 def assert_valid_keys; end # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#613 + # source://capybara//lib/capybara/queries/selector_query.rb#614 def builder(expr); end # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#340 + # source://capybara//lib/capybara/queries/selector_query.rb#341 def custom_keys; end # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#609 + # source://capybara//lib/capybara/queries/selector_query.rb#610 def default_visibility; end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#421 + # source://capybara//lib/capybara/queries/selector_query.rb#422 def describe_within?; end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#425 + # source://capybara//lib/capybara/queries/selector_query.rb#426 def document?(node); end # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#417 + # source://capybara//lib/capybara/queries/selector_query.rb#418 def exact_text; end # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#325 + # source://capybara//lib/capybara/queries/selector_query.rb#326 def expression_filters; end # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#313 + # source://capybara//lib/capybara/queries/selector_query.rb#314 def filter_set(name); end # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#362 + # source://capybara//lib/capybara/queries/selector_query.rb#363 def filtered_expression(expr); end # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#241 + # source://capybara//lib/capybara/queries/selector_query.rb#242 def find_nodes_by_selector_format(node, exact); end # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#234 + # source://capybara//lib/capybara/queries/selector_query.rb#235 def find_selector(locator); end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#220 + # source://capybara//lib/capybara/queries/selector_query.rb#221 def first_try?; end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#497 + # source://capybara//lib/capybara/queries/selector_query.rb#498 def matches_class_filter?(node); end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#556 + # source://capybara//lib/capybara/queries/selector_query.rb#557 def matches_exact_text_filter?(node); end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#303 + # source://capybara//lib/capybara/queries/selector_query.rb#304 def matches_filter_block?(node); end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#510 + # source://capybara//lib/capybara/queries/selector_query.rb#511 def matches_focused_filter?(node); end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#491 + # source://capybara//lib/capybara/queries/selector_query.rb#492 def matches_id_filter?(node); end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#437 + # source://capybara//lib/capybara/queries/selector_query.rb#438 def matches_locator_filter?(node); end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#278 + # source://capybara//lib/capybara/queries/selector_query.rb#279 def matches_node_filters?(node, errors); end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#455 + # source://capybara//lib/capybara/queries/selector_query.rb#456 def matches_spatial_filters?(node); end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#536 + # source://capybara//lib/capybara/queries/selector_query.rb#537 def matches_style?(node, styles); end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#525 + # source://capybara//lib/capybara/queries/selector_query.rb#526 def matches_style_filter?(node); end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#443 + # source://capybara//lib/capybara/queries/selector_query.rb#444 def matches_system_filters?(node); end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#590 + # source://capybara//lib/capybara/queries/selector_query.rb#591 def matches_text_exactly?(node, value); end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#547 + # source://capybara//lib/capybara/queries/selector_query.rb#548 def matches_text_filter?(node); end # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#599 + # source://capybara//lib/capybara/queries/selector_query.rb#600 def matches_text_regexp(node, regexp); end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#605 + # source://capybara//lib/capybara/queries/selector_query.rb#606 def matches_text_regexp?(node, regexp); end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#565 + # source://capybara//lib/capybara/queries/selector_query.rb#566 def matches_visibility_filters?(node); end # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#192 + # source://capybara//lib/capybara/queries/selector_query.rb#193 def matching_text; end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#516 + # source://capybara//lib/capybara/queries/selector_query.rb#517 def need_to_process_classes?; end # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#317 + # source://capybara//lib/capybara/queries/selector_query.rb#318 def node_filters; end # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#595 + # source://capybara//lib/capybara/queries/selector_query.rb#596 def normalize_ws; end # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#331 + # source://capybara//lib/capybara/queries/selector_query.rb#332 def ordered_results(results); end # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#617 + # source://capybara//lib/capybara/queries/selector_query.rb#618 def position_cache(key); end # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#621 + # source://capybara//lib/capybara/queries/selector_query.rb#622 def rect_cache(key); end # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#188 + # source://capybara//lib/capybara/queries/selector_query.rb#189 def selector_format; end # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#224 + # source://capybara//lib/capybara/queries/selector_query.rb#225 def show_for_stage(only_applied); end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#429 + # source://capybara//lib/capybara/queries/selector_query.rb#430 def simple_root?(node); end # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#196 + # source://capybara//lib/capybara/queries/selector_query.rb#197 def text_fragments; end # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#266 + # source://capybara//lib/capybara/queries/selector_query.rb#267 def to_element(node); end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#213 + # source://capybara//lib/capybara/queries/selector_query.rb#214 def try_text_match_in_expression?; end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#374 + # source://capybara//lib/capybara/queries/selector_query.rb#375 def use_default_class_filter?; end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#382 + # source://capybara//lib/capybara/queries/selector_query.rb#383 def use_default_focused_filter?; end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#370 + # source://capybara//lib/capybara/queries/selector_query.rb#371 def use_default_id_filter?; end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#378 + # source://capybara//lib/capybara/queries/selector_query.rb#379 def use_default_style_filter?; end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#386 + # source://capybara//lib/capybara/queries/selector_query.rb#387 def use_spatial_filter?; end # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#274 + # source://capybara//lib/capybara/queries/selector_query.rb#275 def valid_keys; end # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#411 + # source://capybara//lib/capybara/queries/selector_query.rb#412 def warn_exact_usage; end # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#200 + # source://capybara//lib/capybara/queries/selector_query.rb#201 def xpath_text_conditions; end end # @api private # -# source://capybara//lib/capybara/queries/selector_query.rb#625 +# source://capybara//lib/capybara/queries/selector_query.rb#626 class Capybara::Queries::SelectorQuery::Rectangle # @api private # @return [Rectangle] a new instance of Rectangle # - # source://capybara//lib/capybara/queries/selector_query.rb#628 + # source://capybara//lib/capybara/queries/selector_query.rb#629 def initialize(position); end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#652 + # source://capybara//lib/capybara/queries/selector_query.rb#653 def above?(other); end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#656 + # source://capybara//lib/capybara/queries/selector_query.rb#657 def below?(other); end # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#626 + # source://capybara//lib/capybara/queries/selector_query.rb#627 def bottom; end # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#637 + # source://capybara//lib/capybara/queries/selector_query.rb#638 def distance(other); end # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#626 + # source://capybara//lib/capybara/queries/selector_query.rb#627 def left; end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#660 + # source://capybara//lib/capybara/queries/selector_query.rb#661 def left_of?(other); end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#668 + # source://capybara//lib/capybara/queries/selector_query.rb#669 def near?(other); end # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#626 + # source://capybara//lib/capybara/queries/selector_query.rb#627 def right; end # @api private # @return [Boolean] # - # source://capybara//lib/capybara/queries/selector_query.rb#664 + # source://capybara//lib/capybara/queries/selector_query.rb#665 def right_of?(other); end # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#626 + # source://capybara//lib/capybara/queries/selector_query.rb#627 def top; end protected # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#674 + # source://capybara//lib/capybara/queries/selector_query.rb#675 def line_segments; end private # @api private # - # source://capybara//lib/capybara/queries/selector_query.rb#685 + # source://capybara//lib/capybara/queries/selector_query.rb#686 def distance_segment_segment(l1p1, l1p2, l2p1, l2p2); end end @@ -4950,7 +4992,7 @@ class Capybara::Queries::TitleQuery < ::Capybara::Queries::BaseQuery def valid_keys; end end -# source://capybara//lib/capybara.rb#447 +# source://capybara//lib/capybara.rb#448 module Capybara::RackTest; end # source://capybara//lib/capybara/rack_test/browser.rb#3 @@ -4965,7 +5007,7 @@ class Capybara::RackTest::Browser # source://capybara//lib/capybara/rack_test/browser.rb#14 def app; end - # source://capybara//lib/capybara/rack_test/browser.rb#83 + # source://capybara//lib/capybara/rack_test/browser.rb#84 def build_uri(path); end # Returns the value of attribute current_host. @@ -4980,10 +5022,10 @@ class Capybara::RackTest::Browser # source://capybara//lib/capybara/rack_test/browser.rb#7 def current_host=(_arg0); end - # source://capybara//lib/capybara/rack_test/browser.rb#99 + # source://capybara//lib/capybara/rack_test/browser.rb#100 def current_url; end - # source://capybara//lib/capybara/rack_test/browser.rb#116 + # source://capybara//lib/capybara/rack_test/browser.rb#117 def dom; end # Returns the value of attribute driver. @@ -4991,47 +5033,47 @@ class Capybara::RackTest::Browser # source://capybara//lib/capybara/rack_test/browser.rb#6 def driver; end - # source://capybara//lib/capybara/rack_test/browser.rb#120 + # source://capybara//lib/capybara/rack_test/browser.rb#121 def find(format, selector); end - # source://capybara//lib/capybara/rack_test/browser.rb#47 + # source://capybara//lib/capybara/rack_test/browser.rb#48 def follow(method, path, **attributes); end - # source://capybara//lib/capybara/rack_test/browser.rb#128 + # source://capybara//lib/capybara/rack_test/browser.rb#129 def html; end # @raise [Rack::Test::Error] # - # source://capybara//lib/capybara/rack_test/browser.rb#138 + # source://capybara//lib/capybara/rack_test/browser.rb#139 def last_request; end # @raise [Rack::Test::Error] # - # source://capybara//lib/capybara/rack_test/browser.rb#144 + # source://capybara//lib/capybara/rack_test/browser.rb#145 def last_response; end # source://capybara//lib/capybara/rack_test/browser.rb#18 def options; end - # source://capybara//lib/capybara/rack_test/browser.rb#73 + # source://capybara//lib/capybara/rack_test/browser.rb#74 def process(method, path, attributes = T.unsafe(nil), env = T.unsafe(nil)); end - # source://capybara//lib/capybara/rack_test/browser.rb#53 + # source://capybara//lib/capybara/rack_test/browser.rb#54 def process_and_follow_redirects(method, path, attributes = T.unsafe(nil), env = T.unsafe(nil)); end # source://capybara//lib/capybara/rack_test/browser.rb#29 def refresh; end - # source://capybara//lib/capybara/rack_test/browser.rb#112 + # source://capybara//lib/capybara/rack_test/browser.rb#113 def reset_cache!; end - # source://capybara//lib/capybara/rack_test/browser.rb#107 + # source://capybara//lib/capybara/rack_test/browser.rb#108 def reset_host!; end # source://capybara//lib/capybara/rack_test/browser.rb#34 def submit(method, path, attributes, content_type: T.unsafe(nil)); end - # source://capybara//lib/capybara/rack_test/browser.rb#134 + # source://capybara//lib/capybara/rack_test/browser.rb#135 def title; end # source://capybara//lib/capybara/rack_test/browser.rb#22 @@ -5039,29 +5081,29 @@ class Capybara::RackTest::Browser protected - # source://capybara//lib/capybara/rack_test/browser.rb#152 + # source://capybara//lib/capybara/rack_test/browser.rb#153 def base_href; end - # source://capybara//lib/capybara/rack_test/browser.rb#156 + # source://capybara//lib/capybara/rack_test/browser.rb#157 def base_relative_uri_for(uri); end - # source://capybara//lib/capybara/rack_test/browser.rb#171 + # source://capybara//lib/capybara/rack_test/browser.rb#172 def build_rack_mock_session; end - # source://capybara//lib/capybara/rack_test/browser.rb#176 + # source://capybara//lib/capybara/rack_test/browser.rb#177 def request_path; end - # source://capybara//lib/capybara/rack_test/browser.rb#182 + # source://capybara//lib/capybara/rack_test/browser.rb#183 def safe_last_request; end private # @return [Boolean] # - # source://capybara//lib/capybara/rack_test/browser.rb#190 + # source://capybara//lib/capybara/rack_test/browser.rb#191 def fragment_or_script?(path); end - # source://capybara//lib/capybara/rack_test/browser.rb#194 + # source://capybara//lib/capybara/rack_test/browser.rb#195 def referer_url; end end @@ -5264,181 +5306,181 @@ end class Capybara::RackTest::Node < ::Capybara::Driver::Node include ::Capybara::Node::WhitespaceNormalizer - # source://capybara//lib/capybara/rack_test/node.rb#130 + # source://capybara//lib/capybara/rack_test/node.rb#129 def [](*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/rack_test/node.rb#130 + # source://capybara//lib/capybara/rack_test/node.rb#129 def all_text(*_arg0, **_arg1, &_arg2); end # @return [Boolean] # - # source://capybara//lib/capybara/rack_test/node.rb#130 + # source://capybara//lib/capybara/rack_test/node.rb#129 def checked?(*_arg0, **_arg1, &_arg2); end # @raise [ArgumentError] # - # source://capybara//lib/capybara/rack_test/node.rb#130 + # source://capybara//lib/capybara/rack_test/node.rb#129 def click(*_arg0, **_arg1, &_arg2); end # @return [Boolean] # - # source://capybara//lib/capybara/rack_test/node.rb#130 + # source://capybara//lib/capybara/rack_test/node.rb#129 def disabled?(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/rack_test/node.rb#130 + # source://capybara//lib/capybara/rack_test/node.rb#129 def find_css(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/rack_test/node.rb#130 + # source://capybara//lib/capybara/rack_test/node.rb#129 def find_xpath(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/rack_test/node.rb#130 + # source://capybara//lib/capybara/rack_test/node.rb#129 def path(*_arg0, **_arg1, &_arg2); end # @return [Boolean] # - # source://capybara//lib/capybara/rack_test/node.rb#130 + # source://capybara//lib/capybara/rack_test/node.rb#129 def readonly?(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/rack_test/node.rb#130 + # source://capybara//lib/capybara/rack_test/node.rb#129 def select_option(*_arg0, **_arg1, &_arg2); end # @return [Boolean] # - # source://capybara//lib/capybara/rack_test/node.rb#130 + # source://capybara//lib/capybara/rack_test/node.rb#129 def selected?(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/rack_test/node.rb#130 + # source://capybara//lib/capybara/rack_test/node.rb#129 def set(*_arg0, **_arg1, &_arg2); end # @raise [NotImplementedError] # - # source://capybara//lib/capybara/rack_test/node.rb#130 + # source://capybara//lib/capybara/rack_test/node.rb#129 def style(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/rack_test/node.rb#130 + # source://capybara//lib/capybara/rack_test/node.rb#129 def tag_name(*_arg0, **_arg1, &_arg2); end # @raise [Capybara::UnselectNotAllowed] # - # source://capybara//lib/capybara/rack_test/node.rb#130 + # source://capybara//lib/capybara/rack_test/node.rb#129 def unselect_option(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/rack_test/node.rb#130 + # source://capybara//lib/capybara/rack_test/node.rb#129 def value(*_arg0, **_arg1, &_arg2); end # @return [Boolean] # - # source://capybara//lib/capybara/rack_test/node.rb#130 + # source://capybara//lib/capybara/rack_test/node.rb#129 def visible?(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/rack_test/node.rb#130 + # source://capybara//lib/capybara/rack_test/node.rb#129 def visible_text(*_arg0, **_arg1, &_arg2); end protected # @return [Boolean] # - # source://capybara//lib/capybara/rack_test/node.rb#294 + # source://capybara//lib/capybara/rack_test/node.rb#287 def checkbox?; end # @return [Boolean] # - # source://capybara//lib/capybara/rack_test/node.rb#290 + # source://capybara//lib/capybara/rack_test/node.rb#283 def checkbox_or_radio?(field = T.unsafe(nil)); end # @api private # - # source://capybara//lib/capybara/rack_test/node.rb#146 + # source://capybara//lib/capybara/rack_test/node.rb#139 def displayed_text(check_ancestor: T.unsafe(nil)); end # @return [Boolean] # - # source://capybara//lib/capybara/rack_test/node.rb#306 + # source://capybara//lib/capybara/rack_test/node.rb#299 def input_field?; end # @return [Boolean] # - # source://capybara//lib/capybara/rack_test/node.rb#298 + # source://capybara//lib/capybara/rack_test/node.rb#291 def radio?; end # @return [Boolean] # - # source://capybara//lib/capybara/rack_test/node.rb#314 + # source://capybara//lib/capybara/rack_test/node.rb#307 def range?; end # @return [Boolean] # - # source://capybara//lib/capybara/rack_test/node.rb#302 + # source://capybara//lib/capybara/rack_test/node.rb#295 def text_or_password?; end # @return [Boolean] # - # source://capybara//lib/capybara/rack_test/node.rb#310 + # source://capybara//lib/capybara/rack_test/node.rb#303 def textarea?; end private # @return [Boolean] # - # source://capybara//lib/capybara/rack_test/node.rb#245 + # source://capybara//lib/capybara/rack_test/node.rb#238 def attribute_is_not_blank?(attribute); end # @return [Boolean] # - # source://capybara//lib/capybara/rack_test/node.rb#284 + # source://capybara//lib/capybara/rack_test/node.rb#277 def checkable?; end - # source://capybara//lib/capybara/rack_test/node.rb#255 + # source://capybara//lib/capybara/rack_test/node.rb#248 def click_label; end - # source://capybara//lib/capybara/rack_test/node.rb#172 + # source://capybara//lib/capybara/rack_test/node.rb#165 def deselect_options; end - # source://capybara//lib/capybara/rack_test/node.rb#249 + # source://capybara//lib/capybara/rack_test/node.rb#242 def follow_link; end - # source://capybara//lib/capybara/rack_test/node.rb#189 + # source://capybara//lib/capybara/rack_test/node.rb#182 def form; end # @return [Boolean] # - # source://capybara//lib/capybara/rack_test/node.rb#276 + # source://capybara//lib/capybara/rack_test/node.rb#269 def link?; end # a reference to the select node if this is an option node # - # source://capybara//lib/capybara/rack_test/node.rb#181 + # source://capybara//lib/capybara/rack_test/node.rb#174 def select_node; end - # source://capybara//lib/capybara/rack_test/node.rb#203 + # source://capybara//lib/capybara/rack_test/node.rb#196 def set_checkbox(value); end - # source://capybara//lib/capybara/rack_test/node.rb#219 + # source://capybara//lib/capybara/rack_test/node.rb#212 def set_input(value); end - # source://capybara//lib/capybara/rack_test/node.rb#197 + # source://capybara//lib/capybara/rack_test/node.rb#190 def set_radio(_value); end - # source://capybara//lib/capybara/rack_test/node.rb#211 + # source://capybara//lib/capybara/rack_test/node.rb#204 def set_range(value); end # @raise [Capybara::RackTest::Errors::StaleElementReferenceError] # - # source://capybara//lib/capybara/rack_test/node.rb#168 + # source://capybara//lib/capybara/rack_test/node.rb#161 def stale_check; end - # source://capybara//lib/capybara/rack_test/node.rb#176 + # source://capybara//lib/capybara/rack_test/node.rb#169 def string_node; end # @return [Boolean] # - # source://capybara//lib/capybara/rack_test/node.rb#280 + # source://capybara//lib/capybara/rack_test/node.rb#273 def submits?; end - # source://capybara//lib/capybara/rack_test/node.rb#265 + # source://capybara//lib/capybara/rack_test/node.rb#258 def toggle_details(details = T.unsafe(nil)); end - # source://capybara//lib/capybara/rack_test/node.rb#185 + # source://capybara//lib/capybara/rack_test/node.rb#178 def type; end # source://capybara//lib/capybara/rack_test/node.rb#11 @@ -5496,10 +5538,10 @@ end # source://capybara//lib/capybara/rack_test/node.rb#9 Capybara::RackTest::Node::BLOCK_ELEMENTS = T.let(T.unsafe(nil), Array) -# source://capybara//lib/capybara/rack_test/node.rb#319 +# source://capybara//lib/capybara/rack_test/node.rb#312 Capybara::RackTest::Node::DISABLED_BY_FIELDSET_XPATH = T.let(T.unsafe(nil), String) -# source://capybara//lib/capybara/rack_test/node.rb#318 +# source://capybara//lib/capybara/rack_test/node.rb#311 Capybara::RackTest::Node::OPTION_OWNER_XPATH = T.let(T.unsafe(nil), String) # source://capybara//lib/capybara.rb#24 @@ -5615,7 +5657,7 @@ class Capybara::RegistrationContainer # @api private # # source://capybara//lib/capybara/registration_container.rb#19 - def method_missing(method_name, *args, **options, &block); end + def method_missing(method_name, *_arg1, **_arg2, &_arg3); end # @api private # @@ -5713,6 +5755,9 @@ class Capybara::Result # source://forwardable/1.3.3/forwardable.rb#231 def size(*args, **_arg1, &block); end + # source://forwardable/1.3.3/forwardable.rb#231 + def to_ary(*args, **_arg1, &block); end + # source://capybara//lib/capybara/result.rb#133 def unfiltered_size; end @@ -5763,12 +5808,30 @@ class Capybara::ScopeError < ::Capybara::CapybaraError; end # * **:xpath** - Select elements by XPath expression # * Locator: An XPath expression # +# ```ruby +# page.html # => '' +# +# page.find :xpath, './/input' +# ``` +# # * **:css** - Select elements by CSS selector # * Locator: A CSS selector # +# ```ruby +# page.html # => '' +# +# page.find :css, 'input' +# ``` +# # * **:id** - Select element by id # * Locator: (String, Regexp, XPath::Expression) The id of the element to match # +# ```ruby +# page.html # => '' +# +# page.find :id, 'content' +# ``` +# # * **:field** - Select field elements (input [not of type submit, image, or hidden], textarea, select) # * Locator: Matches against the id, {Capybara.configure test_id} attribute, name, placeholder, or # associated label text @@ -5785,12 +5848,30 @@ class Capybara::ScopeError < ::Capybara::CapybaraError; end # * :valid (Boolean) - Match fields that are valid/invalid according to HTML5 form validation # * :validation_message (String, Regexp) - Matches the elements current validationMessage # +# ```ruby +# page.html # => ' +# ' +# +# page.find :field, 'article_title' +# page.find :field, 'article[title]' +# page.find :field, 'Title' +# page.find :field, 'Title', type: 'text', with: 'Hello world' +# ``` +# # * **:fieldset** - Select fieldset elements # * Locator: Matches id, {Capybara.configure test_id}, or contents of wrapped legend # * Filters: # * :legend (String) - Matches contents of wrapped legend # * :disabled (Boolean) - Match disabled fieldset? # +# ```ruby +# page.html # => '
+# Fields (disabled) +#
' +# +# page.find :fieldset, 'Fields (disabled)', disabled: true +# ``` +# # * **:link** - Find links (`` elements with an href attribute) # * Locator: Matches the id, {Capybara.configure test_id}, or title attributes, or the string content of the link, # or the alt attribute of a contained img element. By default this selector requires a link to have an href attribute. @@ -5799,6 +5880,17 @@ class Capybara::ScopeError < ::Capybara::CapybaraError; end # * :alt (String) - Matches the alt attribute of a contained img element # * :href (String, Regexp, nil, false) - Matches the normalized href of the link, if nil will find `` elements with no href attribute, if false ignores href presence # +# ```ruby +# page.html # => 'Home' +# +# page.find :link, 'Home', href: '/' +# +# page.html # => 'The logo' +# +# page.find :link, 'The logo', href: '/' +# page.find :link, alt: 'The logo', href: '/' +# ``` +# # * **:button** - Find buttons ( input [of type submit, reset, image, button] or button elements ) # * Locator: Matches the id, {Capybara.configure test_id} attribute, name, value, or title attributes, string content of a button, or the alt attribute of an image type button or of a descendant image of a button # * Filters: @@ -5808,11 +5900,31 @@ class Capybara::ScopeError < ::Capybara::CapybaraError; end # * :type (String) - Matches the type attribute # * :disabled (Boolean, :all) - Match disabled buttons (Default: false) # +# ```ruby +# page.html # => '' +# +# page.find :button, 'Submit' +# +# page.html # => '' +# +# page.find :button, 'Save as draft', name: 'article[state]', value: 'draft' +# ``` +# # * **:link_or_button** - Find links or buttons # * Locator: See :link and :button selectors # * Filters: # * :disabled (Boolean, :all) - Match disabled buttons? (Default: false) # +# ```ruby +# page.html # => 'Home' +# +# page.find :link_or_button, 'Home' +# +# page.html # => '' +# +# page.find :link_or_button, 'Submit' +# ``` +# # * **:fillable_field** - Find text fillable fields ( textarea, input [not of type submit, image, radio, checkbox, hidden, file] ) # * Locator: Matches against the id, {Capybara.configure test_id} attribute, name, placeholder, or associated label text # * Filters: @@ -5825,6 +5937,16 @@ class Capybara::ScopeError < ::Capybara::CapybaraError; end # * :valid (Boolean) - Match fields that are valid/invalid according to HTML5 form validation # * :validation_message (String, Regexp) - Matches the elements current validationMessage # +# ```ruby +# page.html # => ' +# ' +# +# page.find :fillable_field, 'article_body' +# page.find :fillable_field, 'article[body]' +# page.find :fillable_field, 'Body' +# page.find :field, 'Body', type: 'textarea' +# ``` +# # * **:radio_button** - Find radio buttons # * Locator: Match id, {Capybara.configure test_id} attribute, name, or associated label text # * Filters: @@ -5835,6 +5957,18 @@ class Capybara::ScopeError < ::Capybara::CapybaraError; end # * :option (String, Regexp) - Match the current value # * :with - Alias of :option # +# ```ruby +# page.html # => ' +# +# +# ' +# +# page.find :radio_button, 'article_state_published' +# page.find :radio_button, 'article[state]', option: 'published' +# page.find :radio_button, 'Published', checked: true +# page.find :radio_button, 'Draft', unchecked: true +# ``` +# # * **:checkbox** - Find checkboxes # * Locator: Match id, {Capybara.configure test_id} attribute, name, or associated label text # * Filters: @@ -5845,6 +5979,15 @@ class Capybara::ScopeError < ::Capybara::CapybaraError; end # * :with (String, Regexp) - Match the current value # * :option - Alias of :with # +# ```ruby +# page.html # => ' +# ' +# +# page.find :checkbox, 'registration_terms' +# page.find :checkbox, 'registration[terms]' +# page.find :checkbox, 'I agree to terms and conditions', unchecked: true +# ``` +# # * **:select** - Find select elements # * Locator: Match id, {Capybara.configure test_id} attribute, name, placeholder, or associated label text # * Filters: @@ -5859,12 +6002,40 @@ class Capybara::ScopeError < ::Capybara::CapybaraError; end # * :selected (String, Array) - Match the selection(s) # * :with_selected (String, Array) - Partial match the selection(s) # +# ```ruby +# page.html # => ' +# ' +# +# page.find :select, 'article_category' +# page.find :select, 'article[category]' +# page.find :select, 'Category' +# page.find :select, 'Category', selected: 'General' +# page.find :select, with_options: ['General'] +# page.find :select, with_options: ['Other'] +# page.find :select, options: ['General', 'Other'] +# page.find :select, options: ['General'] # => raises Capybara::ElementNotFound +# ``` +# # * **:option** - Find option elements # * Locator: Match text of option # * Filters: # * :disabled (Boolean) - Match disabled option # * :selected (Boolean) - Match selected option # +# ```ruby +# page.html # => ' +# +# ' +# +# page.find :option, 'General' +# page.find :option, 'General', selected: true +# page.find :option, 'Disabled', disabled: true +# page.find :option, 'Other', selected: false +# ``` +# # * **:datalist_input** - Find input field with datalist completion # * Locator: Matches against the id, {Capybara.configure test_id} attribute, name, # placeholder, or associated label text @@ -5875,11 +6046,42 @@ class Capybara::ScopeError < ::Capybara::CapybaraError; end # * :options (Array) - Exact match options # * :with_options (Array) - Partial match options # +# ```ruby +# page.html # => ' +# +# +# +# +# +# ' +# +# page.find :datalist_input, 'ice_cream_flavor' +# page.find :datalist_input, 'ice_cream[flavor]' +# page.find :datalist_input, 'Flavor' +# page.find :datalist_input, with_options: ['Chocolate', 'Strawberry'] +# page.find :datalist_input, options: ['Chocolate', 'Strawberry', 'Vanilla'] +# page.find :datalist_input, options: ['Chocolate'] # => raises Capybara::ElementNotFound +# ``` +# # * **:datalist_option** - Find datalist option # * Locator: Match text or value of option # * Filters: # * :disabled (Boolean) - Match disabled option # +# ```ruby +# page.html # => ' +# +# +# +# +# ' +# +# page.find :datalist_option, 'Chocolate' +# page.find :datalist_option, 'Strawberry' +# page.find :datalist_option, 'Vanilla' +# page.find :datalist_option, 'Forbidden', disabled: true +# ``` +# # * **:file_field** - Find file input elements # * Locator: Match id, {Capybara.configure test_id} attribute, name, or associated label text # * Filters: @@ -5887,11 +6089,31 @@ class Capybara::ScopeError < ::Capybara::CapybaraError; end # * :disabled (Boolean, :all) - Match disabled field? (Default: false) # * :multiple (Boolean) - Match field that accepts multiple values # +# ```ruby +# page.html # => ' +# ' +# +# page.find :file_field, 'article_banner_image' +# page.find :file_field, 'article[banner_image]' +# page.find :file_field, 'Banner Image' +# page.find :file_field, 'Banner Image', name: 'article[banner_image]' +# page.find :field, 'Banner Image', type: 'file' +# ``` +# # * **:label** - Find label elements # * Locator: Match id, {Capybara.configure test_id}, or text contents # * Filters: # * :for (Element, String, Regexp) - The element or id of the element associated with the label # +# ```ruby +# page.html # => ' +# ' +# +# page.find :label, 'Title' +# page.find :label, 'Title', for: 'article_title' +# page.find :label, 'Title', for: page.find('article[title]') +# ``` +# # * **:table** - Find table elements # * Locator: id, {Capybara.configure test_id}, or caption text of table # * Filters: @@ -5901,19 +6123,93 @@ class Capybara::ScopeError < ::Capybara::CapybaraError; end # * :with_cols (Array>, Array>) - Partial match `` data - visibility of `` elements is not considered # * :cols (Array>) - Match all ``s - visibility of `` elements is not considered # +# ```ruby +# page.html # => ' +# +# +# +# +# +# +# +# +# +# +# +# +# +#
A table
AB
12
34
' +# +# page.find :table, 'A table' +# page.find :table, with_rows: [ +# { 'A' => '1', 'B' => '2' }, +# { 'A' => '3', 'B' => '4' }, +# ] +# page.find :table, with_rows: [ +# ['1', '2'], +# ['3', '4'], +# ] +# page.find :table, rows: [ +# { 'A' => '1', 'B' => '2' }, +# { 'A' => '3', 'B' => '4' }, +# ] +# page.find :table, rows: [ +# ['1', '2'], +# ['3', '4'], +# ] +# page.find :table, rows: [ ['1', '2'] ] # => raises Capybara::ElementNotFound +# ``` +# # * **:table_row** - Find table row # * Locator: Array, Hash table row `` contents - visibility of `` elements is not considered # +# ```ruby +# page.html # => ' +# +# +# +# +# +# +# +# +# +# +# +# +#
AB
12
34
' +# +# page.find :table_row, 'A' => '1', 'B' => '2' +# page.find :table_row, 'A' => '3', 'B' => '4' +# ``` +# # * **:frame** - Find frame/iframe elements # * Locator: Match id, {Capybara.configure test_id} attribute, or name # * Filters: # * :name (String) - Match name attribute # +# ```ruby +# page.html # => '' +# +# page.find :frame, 'embed_frame' +# page.find :frame, 'embed' +# page.find :frame, name: 'embed' +# ``` +# # * **:element** # * Locator: Type of element ('div', 'a', etc) - if not specified defaults to '*' # * Filters: # * :\ (String, Regexp) - Match on any specified element attribute # +# ```ruby +# page.html # => ' +# +# page.find :element, 'button' +# page.find :element, type: 'button', text: 'Check me' +# page.find :element, role: 'menuitemcheckbox' +# page.find :element, role: /checkbox/, 'aria-checked': 'true' +# ``` +# # source://capybara//lib/capybara/selector/selector.rb#4 class Capybara::Selector < ::SimpleDelegator # @return [Selector] a new instance of Selector @@ -6660,7 +6956,7 @@ class Capybara::Selector::XPathBuilder def regexp_to_xpath_conditions(regexp); end end -# source://capybara//lib/capybara.rb#448 +# source://capybara//lib/capybara.rb#449 module Capybara::Selenium; end # source://capybara//lib/capybara/selenium/patches/logs.rb#5 @@ -6686,21 +6982,21 @@ class Capybara::Selenium::ChromeNode < ::Capybara::Selenium::Node include ::Capybara::Selenium::Node::Html5Drag include ::Capybara::Selenium::Node::FileInputClickEmulation - # source://capybara//lib/capybara/selenium/nodes/chrome_node.rb#39 + # source://capybara//lib/capybara/selenium/nodes/chrome_node.rb#33 def click(*_arg0, **_arg1); end # @return [Boolean] # - # source://capybara//lib/capybara/selenium/nodes/chrome_node.rb#52 + # source://capybara//lib/capybara/selenium/nodes/chrome_node.rb#46 def disabled?; end - # source://capybara//lib/capybara/selenium/nodes/chrome_node.rb#35 + # source://capybara//lib/capybara/selenium/nodes/chrome_node.rb#29 def drop(*args); end - # source://capybara//lib/capybara/selenium/nodes/chrome_node.rb#56 + # source://capybara//lib/capybara/selenium/nodes/chrome_node.rb#50 def select_option; end - # source://capybara//lib/capybara/selenium/nodes/chrome_node.rb#76 + # source://capybara//lib/capybara/selenium/nodes/chrome_node.rb#70 def send_keys(*args); end # source://capybara//lib/capybara/selenium/nodes/chrome_node.rb#17 @@ -6711,38 +7007,35 @@ class Capybara::Selenium::ChromeNode < ::Capybara::Selenium::Node # @return [Boolean] # - # source://capybara//lib/capybara/selenium/nodes/chrome_node.rb#64 + # source://capybara//lib/capybara/selenium/nodes/chrome_node.rb#58 def visible?; end private - # source://capybara//lib/capybara/selenium/nodes/chrome_node.rb#117 + # source://capybara//lib/capybara/selenium/nodes/chrome_node.rb#101 def browser_version(to_float: T.unsafe(nil)); end # @return [Boolean] # - # source://capybara//lib/capybara/selenium/nodes/chrome_node.rb#124 + # source://capybara//lib/capybara/selenium/nodes/chrome_node.rb#108 def chromedriver_fixed_actions_key_state?; end # @return [Boolean] # - # source://capybara//lib/capybara/selenium/nodes/chrome_node.rb#128 + # source://capybara//lib/capybara/selenium/nodes/chrome_node.rb#112 def chromedriver_supports_displayed_endpoint?; end - # source://capybara//lib/capybara/selenium/nodes/chrome_node.rb#132 + # source://capybara//lib/capybara/selenium/nodes/chrome_node.rb#116 def chromedriver_version; end - # source://capybara//lib/capybara/selenium/nodes/chrome_node.rb#107 - def file_errors; end - # @return [Boolean] # - # source://capybara//lib/capybara/selenium/nodes/chrome_node.rb#136 + # source://capybara//lib/capybara/selenium/nodes/chrome_node.rb#120 def native_displayed?; end # @raise [ArgumentError] # - # source://capybara//lib/capybara/selenium/nodes/chrome_node.rb#96 + # source://capybara//lib/capybara/selenium/nodes/chrome_node.rb#90 def perform_legacy_drag(element, drop_modifiers); end end @@ -6752,13 +7045,13 @@ class Capybara::Selenium::Driver < ::Capybara::Driver::Base # @return [Driver] a new instance of Driver # - # source://capybara//lib/capybara/selenium/driver.rb#92 + # source://capybara//lib/capybara/selenium/driver.rb#83 def initialize(app, **options); end - # source://capybara//lib/capybara/selenium/driver.rb#273 + # source://capybara//lib/capybara/selenium/driver.rb#264 def accept_modal(_type, **options); end - # source://capybara//lib/capybara/selenium/driver.rb#151 + # source://capybara//lib/capybara/selenium/driver.rb#142 def active_element; end # Returns the value of attribute app. @@ -6766,64 +7059,64 @@ class Capybara::Selenium::Driver < ::Capybara::Driver::Base # source://capybara//lib/capybara/selenium/driver.rb#17 def app; end - # source://capybara//lib/capybara/selenium/driver.rb#65 + # source://capybara//lib/capybara/selenium/driver.rb#63 def browser; end # @raise [ArgumentError] # - # source://capybara//lib/capybara/selenium/driver.rb#244 + # source://capybara//lib/capybara/selenium/driver.rb#235 def close_window(handle); end - # source://capybara//lib/capybara/selenium/driver.rb#129 + # source://capybara//lib/capybara/selenium/driver.rb#120 def current_url; end - # source://capybara//lib/capybara/selenium/driver.rb#214 + # source://capybara//lib/capybara/selenium/driver.rb#205 def current_window_handle; end - # source://capybara//lib/capybara/selenium/driver.rb#284 + # source://capybara//lib/capybara/selenium/driver.rb#275 def dismiss_modal(_type, **options); end - # source://capybara//lib/capybara/selenium/driver.rb#145 + # source://capybara//lib/capybara/selenium/driver.rb#136 def evaluate_async_script(script, *args); end - # source://capybara//lib/capybara/selenium/driver.rb#140 + # source://capybara//lib/capybara/selenium/driver.rb#131 def evaluate_script(script, *args); end - # source://capybara//lib/capybara/selenium/driver.rb#136 + # source://capybara//lib/capybara/selenium/driver.rb#127 def execute_script(script, *args); end # @return [Boolean] # - # source://capybara//lib/capybara/selenium/driver.rb#187 + # source://capybara//lib/capybara/selenium/driver.rb#178 def frame_obscured_at?(x:, y:); end - # source://capybara//lib/capybara/selenium/driver.rb#238 + # source://capybara//lib/capybara/selenium/driver.rb#229 def fullscreen_window(handle); end - # source://capybara//lib/capybara/selenium/driver.rb#111 + # source://capybara//lib/capybara/selenium/driver.rb#102 def go_back; end - # source://capybara//lib/capybara/selenium/driver.rb#115 + # source://capybara//lib/capybara/selenium/driver.rb#106 def go_forward; end - # source://capybara//lib/capybara/selenium/driver.rb#119 + # source://capybara//lib/capybara/selenium/driver.rb#110 def html; end - # source://capybara//lib/capybara/selenium/driver.rb#306 + # source://capybara//lib/capybara/selenium/driver.rb#297 def invalid_element_errors; end - # source://capybara//lib/capybara/selenium/driver.rb#231 + # source://capybara//lib/capybara/selenium/driver.rb#222 def maximize_window(handle); end # @return [Boolean] # - # source://capybara//lib/capybara/selenium/driver.rb#134 + # source://capybara//lib/capybara/selenium/driver.rb#125 def needs_server?; end - # source://capybara//lib/capybara/selenium/driver.rb#332 + # source://capybara//lib/capybara/selenium/driver.rb#313 def no_such_window_error; end - # source://capybara//lib/capybara/selenium/driver.rb#256 + # source://capybara//lib/capybara/selenium/driver.rb#247 def open_new_window(kind = T.unsafe(nil)); end # Returns the value of attribute options. @@ -6831,139 +7124,131 @@ class Capybara::Selenium::Driver < ::Capybara::Driver::Base # source://capybara//lib/capybara/selenium/driver.rb#17 def options; end - # source://capybara//lib/capybara/selenium/driver.rb#292 + # source://capybara//lib/capybara/selenium/driver.rb#283 def quit; end - # source://capybara//lib/capybara/selenium/driver.rb#107 + # source://capybara//lib/capybara/selenium/driver.rb#98 def refresh; end - # source://capybara//lib/capybara/selenium/driver.rb#164 + # source://capybara//lib/capybara/selenium/driver.rb#155 def reset!; end - # source://capybara//lib/capybara/selenium/driver.rb#225 + # source://capybara//lib/capybara/selenium/driver.rb#216 def resize_window_to(handle, width, height); end - # source://capybara//lib/capybara/selenium/driver.rb#160 - def save_screenshot(path, **_options); end + # source://capybara//lib/capybara/selenium/driver.rb#151 + def save_screenshot(path, **options); end - # source://capybara//lib/capybara/selenium/driver.rb#155 + # source://capybara//lib/capybara/selenium/driver.rb#146 def send_keys(*args); end - # source://capybara//lib/capybara/selenium/driver.rb#199 + # source://capybara//lib/capybara/selenium/driver.rb#190 def switch_to_frame(frame); end - # source://capybara//lib/capybara/selenium/driver.rb#269 + # source://capybara//lib/capybara/selenium/driver.rb#260 def switch_to_window(handle); end - # source://capybara//lib/capybara/selenium/driver.rb#125 + # source://capybara//lib/capybara/selenium/driver.rb#116 def title; end - # source://capybara//lib/capybara/selenium/driver.rb#103 + # source://capybara//lib/capybara/selenium/driver.rb#94 def visit(path); end # @return [Boolean] # - # source://capybara//lib/capybara/selenium/driver.rb#133 + # source://capybara//lib/capybara/selenium/driver.rb#124 def wait?; end - # source://capybara//lib/capybara/selenium/driver.rb#252 + # source://capybara//lib/capybara/selenium/driver.rb#243 def window_handles; end - # source://capybara//lib/capybara/selenium/driver.rb#218 + # source://capybara//lib/capybara/selenium/driver.rb#209 def window_size(handle); end private - # source://capybara//lib/capybara/selenium/driver.rb#542 + # source://capybara//lib/capybara/selenium/driver.rb#502 def accept_unhandled_reset_alert; end - # source://capybara//lib/capybara/selenium/driver.rb#503 + # source://capybara//lib/capybara/selenium/driver.rb#463 def bridge; end - # source://capybara//lib/capybara/selenium/driver.rb#499 + # source://capybara//lib/capybara/selenium/driver.rb#459 def build_node(native_node, initial_cache = T.unsafe(nil)); end - # source://capybara//lib/capybara/selenium/driver.rb#350 + # source://capybara//lib/capybara/selenium/driver.rb#327 def clear_browser_state; end - # source://capybara//lib/capybara/selenium/driver.rb#359 + # source://capybara//lib/capybara/selenium/driver.rb#336 def clear_browser_state_errors; end - # source://capybara//lib/capybara/selenium/driver.rb#395 + # source://capybara//lib/capybara/selenium/driver.rb#369 def clear_local_storage; end - # source://capybara//lib/capybara/selenium/driver.rb#381 + # source://capybara//lib/capybara/selenium/driver.rb#355 def clear_session_storage; end - # source://capybara//lib/capybara/selenium/driver.rb#374 + # source://capybara//lib/capybara/selenium/driver.rb#348 def clear_storage; end - # source://capybara//lib/capybara/selenium/driver.rb#370 + # source://capybara//lib/capybara/selenium/driver.rb#344 def delete_all_cookies; end - # source://capybara//lib/capybara/selenium/driver.rb#495 + # source://capybara//lib/capybara/selenium/driver.rb#455 def find_context; end - # source://capybara//lib/capybara/selenium/driver.rb#433 + # source://capybara//lib/capybara/selenium/driver.rb#407 def find_modal(text: T.unsafe(nil), **options); end - # source://capybara//lib/capybara/selenium/driver.rb#456 + # source://capybara//lib/capybara/selenium/driver.rb#430 def find_modal_errors; end - # source://capybara//lib/capybara/selenium/driver.rb#417 + # source://capybara//lib/capybara/selenium/driver.rb#391 def modal_error; end - # source://capybara//lib/capybara/selenium/driver.rb#346 + # source://capybara//lib/capybara/selenium/driver.rb#323 def native_active_element; end - # source://capybara//lib/capybara/selenium/driver.rb#342 + # source://capybara//lib/capybara/selenium/driver.rb#319 def native_args(args); end - # source://capybara//lib/capybara/selenium/driver.rb#409 + # source://capybara//lib/capybara/selenium/driver.rb#383 def navigate_with_accept(url); end - # source://capybara//lib/capybara/selenium/driver.rb#524 + # source://capybara//lib/capybara/selenium/driver.rb#484 def reset_browser_state; end - # @return [Boolean] - # - # source://capybara//lib/capybara/selenium/driver.rb#338 - def selenium_4?; end - - # source://capybara//lib/capybara/selenium/driver.rb#514 + # source://capybara//lib/capybara/selenium/driver.rb#474 def setup_exit_handler; end # @return [Boolean] # - # source://capybara//lib/capybara/selenium/driver.rb#470 + # source://capybara//lib/capybara/selenium/driver.rb#434 def silenced_unknown_error_message?(msg); end - # source://capybara//lib/capybara/selenium/driver.rb#474 + # source://capybara//lib/capybara/selenium/driver.rb#438 def silenced_unknown_error_messages; end - # source://capybara//lib/capybara/selenium/driver.rb#507 + # source://capybara//lib/capybara/selenium/driver.rb#467 def specialize_driver; end - # source://capybara//lib/capybara/selenium/driver.rb#363 + # source://capybara//lib/capybara/selenium/driver.rb#340 def unhandled_alert_errors; end - # source://capybara//lib/capybara/selenium/driver.rb#478 + # source://capybara//lib/capybara/selenium/driver.rb#442 def unwrap_script_result(arg); end - # source://capybara//lib/capybara/selenium/driver.rb#529 + # source://capybara//lib/capybara/selenium/driver.rb#489 def wait_for_empty_page(timer); end - # source://capybara//lib/capybara/selenium/driver.rb#460 - def with_legacy_error(errors, legacy_error); end - - # source://capybara//lib/capybara/selenium/driver.rb#421 + # source://capybara//lib/capybara/selenium/driver.rb#395 def within_given_window(handle); end class << self # source://capybara//lib/capybara/selenium/driver.rb#22 def load_selenium; end - # source://capybara//lib/capybara/selenium/driver.rb#59 + # source://capybara//lib/capybara/selenium/driver.rb#57 def register_specialization(browser_name, specialization); end # Returns the value of attribute selenium_webdriver_version. @@ -6973,7 +7258,7 @@ class Capybara::Selenium::Driver < ::Capybara::Driver::Base # Returns the value of attribute specializations. # - # source://capybara//lib/capybara/selenium/driver.rb#57 + # source://capybara//lib/capybara/selenium/driver.rb#55 def specializations; end end end @@ -7104,11 +7389,6 @@ module Capybara::Selenium::Driver::FirefoxDriver # # source://capybara//lib/capybara/selenium/driver_specializations/firefox_driver.rb#6 def extended(driver); end - - # @return [Boolean] - # - # source://capybara//lib/capybara/selenium/driver_specializations/firefox_driver.rb#12 - def w3c?(driver); end end end @@ -7137,37 +7417,37 @@ module Capybara::Selenium::Driver::SafariDriver def build_node(native_node, initial_cache = T.unsafe(nil)); end end -# source://capybara//lib/capybara/selenium/driver_specializations/firefox_driver.rb#18 +# source://capybara//lib/capybara/selenium/driver_specializations/firefox_driver.rb#13 module Capybara::Selenium::Driver::W3CFirefoxDriver - # source://capybara//lib/capybara/selenium/driver_specializations/firefox_driver.rb#59 + # source://capybara//lib/capybara/selenium/driver_specializations/firefox_driver.rb#54 def refresh; end - # source://capybara//lib/capybara/selenium/driver_specializations/firefox_driver.rb#41 + # source://capybara//lib/capybara/selenium/driver_specializations/firefox_driver.rb#36 def reset!; end - # source://capybara//lib/capybara/selenium/driver_specializations/firefox_driver.rb#30 + # source://capybara//lib/capybara/selenium/driver_specializations/firefox_driver.rb#25 def resize_window_to(handle, width, height); end - # source://capybara//lib/capybara/selenium/driver_specializations/firefox_driver.rb#68 + # source://capybara//lib/capybara/selenium/driver_specializations/firefox_driver.rb#63 def switch_to_frame(frame); end private - # source://capybara//lib/capybara/selenium/driver_specializations/firefox_driver.rb#84 + # source://capybara//lib/capybara/selenium/driver_specializations/firefox_driver.rb#79 def browser_version; end - # source://capybara//lib/capybara/selenium/driver_specializations/firefox_driver.rb#80 + # source://capybara//lib/capybara/selenium/driver_specializations/firefox_driver.rb#75 def build_node(native_node, initial_cache = T.unsafe(nil)); end class << self # @private # - # source://capybara//lib/capybara/selenium/driver_specializations/firefox_driver.rb#20 + # source://capybara//lib/capybara/selenium/driver_specializations/firefox_driver.rb#15 def extended(driver); end # @return [Boolean] # - # source://capybara//lib/capybara/selenium/driver_specializations/firefox_driver.rb#25 + # source://capybara//lib/capybara/selenium/driver_specializations/firefox_driver.rb#20 def pause_broken?(sel_driver); end end end @@ -7176,21 +7456,21 @@ end class Capybara::Selenium::EdgeNode < ::Capybara::Selenium::Node include ::Capybara::Selenium::Node::Html5Drag - # source://capybara//lib/capybara/selenium/nodes/edge_node.rb#41 + # source://capybara//lib/capybara/selenium/nodes/edge_node.rb#35 def click(*_arg0, **_arg1); end # @return [Boolean] # - # source://capybara//lib/capybara/selenium/nodes/edge_node.rb#52 + # source://capybara//lib/capybara/selenium/nodes/edge_node.rb#46 def disabled?; end - # source://capybara//lib/capybara/selenium/nodes/edge_node.rb#35 + # source://capybara//lib/capybara/selenium/nodes/edge_node.rb#29 def drop(*args); end - # source://capybara//lib/capybara/selenium/nodes/edge_node.rb#58 + # source://capybara//lib/capybara/selenium/nodes/edge_node.rb#52 def select_option; end - # source://capybara//lib/capybara/selenium/nodes/edge_node.rb#80 + # source://capybara//lib/capybara/selenium/nodes/edge_node.rb#74 def send_keys(*args); end # source://capybara//lib/capybara/selenium/nodes/edge_node.rb#17 @@ -7201,25 +7481,22 @@ class Capybara::Selenium::EdgeNode < ::Capybara::Selenium::Node # @return [Boolean] # - # source://capybara//lib/capybara/selenium/nodes/edge_node.rb#68 + # source://capybara//lib/capybara/selenium/nodes/edge_node.rb#62 def visible?; end private - # source://capybara//lib/capybara/selenium/nodes/edge_node.rb#110 + # source://capybara//lib/capybara/selenium/nodes/edge_node.rb#94 def browser_version; end # @return [Boolean] # - # source://capybara//lib/capybara/selenium/nodes/edge_node.rb#117 + # source://capybara//lib/capybara/selenium/nodes/edge_node.rb#101 def chrome_edge?; end - # source://capybara//lib/capybara/selenium/nodes/edge_node.rb#100 - def file_errors; end - # @return [Boolean] # - # source://capybara//lib/capybara/selenium/nodes/edge_node.rb#121 + # source://capybara//lib/capybara/selenium/nodes/edge_node.rb#105 def native_displayed?; end end @@ -7334,7 +7611,7 @@ class Capybara::Selenium::Node < ::Capybara::Driver::Node # @return [Boolean] # - # source://capybara//lib/capybara/selenium/node.rb#192 + # source://capybara//lib/capybara/selenium/node.rb#190 def checked?; end # source://capybara//lib/capybara/selenium/node.rb#106 @@ -7342,49 +7619,49 @@ class Capybara::Selenium::Node < ::Capybara::Driver::Node # @return [Boolean] # - # source://capybara//lib/capybara/selenium/node.rb#202 + # source://capybara//lib/capybara/selenium/node.rb#200 def content_editable?; end # @return [Boolean] # - # source://capybara//lib/capybara/selenium/node.rb#195 + # source://capybara//lib/capybara/selenium/node.rb#193 def disabled?; end # @raise [ArgumentError] # - # source://capybara//lib/capybara/selenium/node.rb#146 + # source://capybara//lib/capybara/selenium/node.rb#144 def double_click(keys = T.unsafe(nil), **options); end - # source://capybara//lib/capybara/selenium/node.rb#163 + # source://capybara//lib/capybara/selenium/node.rb#161 def drag_to(element, drop_modifiers: T.unsafe(nil), **_arg2); end # @raise [NotImplementedError] # - # source://capybara//lib/capybara/selenium/node.rb#176 + # source://capybara//lib/capybara/selenium/node.rb#174 def drop(*_); end - # source://capybara//lib/capybara/selenium/node.rb#159 + # source://capybara//lib/capybara/selenium/node.rb#157 def hover; end # @return [Boolean] # - # source://capybara//lib/capybara/selenium/node.rb#191 + # source://capybara//lib/capybara/selenium/node.rb#189 def multiple?; end # @return [Boolean] # - # source://capybara//lib/capybara/selenium/node.rb#210 + # source://capybara//lib/capybara/selenium/node.rb#208 def obscured?(x: T.unsafe(nil), y: T.unsafe(nil)); end - # source://capybara//lib/capybara/selenium/node.rb#206 + # source://capybara//lib/capybara/selenium/node.rb#204 def path; end # @return [Boolean] # - # source://capybara//lib/capybara/selenium/node.rb#190 + # source://capybara//lib/capybara/selenium/node.rb#188 def readonly?; end - # source://capybara//lib/capybara/selenium/node.rb#217 + # source://capybara//lib/capybara/selenium/node.rb#215 def rect; end # source://capybara//lib/capybara/selenium/node.rb#129 @@ -7395,10 +7672,10 @@ class Capybara::Selenium::Node < ::Capybara::Driver::Node # @return [Boolean] # - # source://capybara//lib/capybara/selenium/node.rb#192 + # source://capybara//lib/capybara/selenium/node.rb#190 def selected?; end - # source://capybara//lib/capybara/selenium/node.rb#155 + # source://capybara//lib/capybara/selenium/node.rb#153 def send_keys(*args); end # Set the value of the form element to the given value. @@ -7411,13 +7688,13 @@ class Capybara::Selenium::Node < ::Capybara::Driver::Node # source://capybara//lib/capybara/selenium/node.rb#59 def set(value, **options); end - # source://capybara//lib/capybara/selenium/node.rb#221 + # source://capybara//lib/capybara/selenium/node.rb#219 def shadow_root; end # source://capybara//lib/capybara/selenium/node.rb#39 def style(styles); end - # source://capybara//lib/capybara/selenium/node.rb#180 + # source://capybara//lib/capybara/selenium/node.rb#178 def tag_name; end # @raise [Capybara::UnselectNotAllowed] @@ -7430,7 +7707,7 @@ class Capybara::Selenium::Node < ::Capybara::Driver::Node # @return [Boolean] # - # source://capybara//lib/capybara/selenium/node.rb#189 + # source://capybara//lib/capybara/selenium/node.rb#187 def visible?; end # @raise [NotImplementedError] @@ -7440,154 +7717,149 @@ class Capybara::Selenium::Node < ::Capybara::Driver::Node protected - # source://capybara//lib/capybara/selenium/node.rb#230 + # source://capybara//lib/capybara/selenium/node.rb#226 def scroll_if_needed; end - # source://capybara//lib/capybara/selenium/node.rb#237 + # source://capybara//lib/capybara/selenium/node.rb#233 def scroll_to_center; end private - # source://capybara//lib/capybara/selenium/node.rb#483 + # source://capybara//lib/capybara/selenium/node.rb#464 def action_pause(action, duration); end - # source://capybara//lib/capybara/selenium/node.rb#415 + # source://capybara//lib/capybara/selenium/node.rb#411 def action_with_modifiers(click_options); end - # source://capybara//lib/capybara/selenium/node.rb#518 + # source://capybara//lib/capybara/selenium/node.rb#491 def attrs(*attr_names); end - # source://capybara//lib/capybara/selenium/node.rb#299 + # source://capybara//lib/capybara/selenium/node.rb#295 def auto_rapid_set_length; end - # source://capybara//lib/capybara/selenium/node.rb#268 + # source://capybara//lib/capybara/selenium/node.rb#264 def boolean_attr(val); end - # source://capybara//lib/capybara/selenium/node.rb#466 + # source://capybara//lib/capybara/selenium/node.rb#452 def bridge; end - # source://capybara//lib/capybara/selenium/node.rb#462 + # source://capybara//lib/capybara/selenium/node.rb#448 def browser; end - # source://capybara//lib/capybara/selenium/node.rb#470 + # source://capybara//lib/capybara/selenium/node.rb#456 def browser_action; end - # source://capybara//lib/capybara/selenium/node.rb#514 + # source://capybara//lib/capybara/selenium/node.rb#487 def build_node(native_node, initial_cache = T.unsafe(nil)); end - # source://capybara//lib/capybara/selenium/node.rb#474 + # source://capybara//lib/capybara/selenium/node.rb#460 def capabilities; end - # source://capybara//lib/capybara/selenium/node.rb#506 + # source://capybara//lib/capybara/selenium/node.rb#479 def each_key(keys, &block); end - # source://capybara//lib/capybara/selenium/node.rb#510 + # source://capybara//lib/capybara/selenium/node.rb#483 def find_context; end - # source://capybara//lib/capybara/selenium/node.rb#452 + # source://capybara//lib/capybara/selenium/node.rb#438 def modifiers_down(actions, keys); end - # source://capybara//lib/capybara/selenium/node.rb#457 + # source://capybara//lib/capybara/selenium/node.rb#443 def modifiers_up(actions, keys); end - # source://capybara//lib/capybara/selenium/node.rb#530 + # source://capybara//lib/capybara/selenium/node.rb#503 def native_id; end - # source://capybara//lib/capybara/selenium/node.rb#495 + # source://capybara//lib/capybara/selenium/node.rb#468 def normalize_keys(keys); end # @raise [ArgumentError] # - # source://capybara//lib/capybara/selenium/node.rb#303 + # source://capybara//lib/capybara/selenium/node.rb#299 def perform_with_options(click_options, &block); end # a reference to the select node if this is an option node # - # source://capybara//lib/capybara/selenium/node.rb#273 + # source://capybara//lib/capybara/selenium/node.rb#269 def select_node; end - # source://capybara//lib/capybara/selenium/node.rb#341 + # source://capybara//lib/capybara/selenium/node.rb#337 def set_color(value); end - # source://capybara//lib/capybara/selenium/node.rb#391 + # source://capybara//lib/capybara/selenium/node.rb#387 def set_content_editable(value); end - # source://capybara//lib/capybara/selenium/node.rb#317 + # source://capybara//lib/capybara/selenium/node.rb#313 def set_date(value); end - # source://capybara//lib/capybara/selenium/node.rb#333 + # source://capybara//lib/capybara/selenium/node.rb#329 def set_datetime_local(value); end - # source://capybara//lib/capybara/selenium/node.rb#363 + # source://capybara//lib/capybara/selenium/node.rb#359 def set_file(value); end - # source://capybara//lib/capybara/selenium/node.rb#345 + # source://capybara//lib/capybara/selenium/node.rb#341 def set_range(value); end - # source://capybara//lib/capybara/selenium/node.rb#277 + # source://capybara//lib/capybara/selenium/node.rb#273 def set_text(value, clear: T.unsafe(nil), rapid: T.unsafe(nil), **_unused); end - # source://capybara//lib/capybara/selenium/node.rb#325 + # source://capybara//lib/capybara/selenium/node.rb#321 def set_time(value); end # @return [Boolean] # - # source://capybara//lib/capybara/selenium/node.rb#536 + # source://capybara//lib/capybara/selenium/node.rb#509 def shadow_root?; end - # source://capybara//lib/capybara/selenium/node.rb#254 + # source://capybara//lib/capybara/selenium/node.rb#250 def sibling_index(parent, node, selector); end - # source://capybara//lib/capybara/selenium/node.rb#349 + # source://capybara//lib/capybara/selenium/node.rb#345 def update_value_js(value); end - # @return [Boolean] - # - # source://capybara//lib/capybara/selenium/node.rb#478 - def w3c?; end - - # source://capybara//lib/capybara/selenium/node.rb#373 + # source://capybara//lib/capybara/selenium/node.rb#369 def with_file_detector; end end # ClickOptions encapsulates click option logic # -# source://capybara//lib/capybara/selenium/node.rb#634 +# source://capybara//lib/capybara/selenium/node.rb#607 class Capybara::Selenium::Node::ClickOptions # @return [ClickOptions] a new instance of ClickOptions # - # source://capybara//lib/capybara/selenium/node.rb#637 + # source://capybara//lib/capybara/selenium/node.rb#610 def initialize(keys, options); end # @return [Boolean] # - # source://capybara//lib/capybara/selenium/node.rb#650 + # source://capybara//lib/capybara/selenium/node.rb#623 def center_offset?; end - # source://capybara//lib/capybara/selenium/node.rb#646 + # source://capybara//lib/capybara/selenium/node.rb#619 def coords; end # @return [Boolean] # - # source://capybara//lib/capybara/selenium/node.rb#642 + # source://capybara//lib/capybara/selenium/node.rb#615 def coords?; end - # source://capybara//lib/capybara/selenium/node.rb#658 + # source://capybara//lib/capybara/selenium/node.rb#631 def delay; end # @return [Boolean] # - # source://capybara//lib/capybara/selenium/node.rb#654 + # source://capybara//lib/capybara/selenium/node.rb#627 def empty?; end # Returns the value of attribute keys. # - # source://capybara//lib/capybara/selenium/node.rb#635 + # source://capybara//lib/capybara/selenium/node.rb#608 def keys; end # Returns the value of attribute options. # - # source://capybara//lib/capybara/selenium/node.rb#635 + # source://capybara//lib/capybara/selenium/node.rb#608 def options; end end @@ -7612,7 +7884,7 @@ module Capybara::Selenium::Node::FileInputClickEmulation def visible_file_field?; end end -# source://capybara//lib/capybara/selenium/node.rb#540 +# source://capybara//lib/capybara/selenium/node.rb#513 Capybara::Selenium::Node::GET_XPATH_SCRIPT = T.let(T.unsafe(nil), String) # source://capybara//lib/capybara/selenium/extensions/html5_drag.rb#4 @@ -7684,46 +7956,46 @@ class Capybara::Selenium::Node::ModifierKeysStack def push; end end -# source://capybara//lib/capybara/selenium/node.rb#572 +# source://capybara//lib/capybara/selenium/node.rb#545 Capybara::Selenium::Node::OBSCURED_OR_OFFSET_SCRIPT = T.let(T.unsafe(nil), String) -# source://capybara//lib/capybara/selenium/node.rb#589 +# source://capybara//lib/capybara/selenium/node.rb#562 Capybara::Selenium::Node::RAPID_APPEND_TEXT = T.let(T.unsafe(nil), String) # SettableValue encapsulates time/date field formatting # -# source://capybara//lib/capybara/selenium/node.rb#600 +# source://capybara//lib/capybara/selenium/node.rb#573 class Capybara::Selenium::Node::SettableValue # @return [SettableValue] a new instance of SettableValue # - # source://capybara//lib/capybara/selenium/node.rb#603 + # source://capybara//lib/capybara/selenium/node.rb#576 def initialize(value); end # @return [Boolean] # - # source://capybara//lib/capybara/selenium/node.rb#611 + # source://capybara//lib/capybara/selenium/node.rb#584 def dateable?; end # @return [Boolean] # - # source://capybara//lib/capybara/selenium/node.rb#619 + # source://capybara//lib/capybara/selenium/node.rb#592 def timeable?; end - # source://capybara//lib/capybara/selenium/node.rb#615 + # source://capybara//lib/capybara/selenium/node.rb#588 def to_date_str; end - # source://capybara//lib/capybara/selenium/node.rb#627 + # source://capybara//lib/capybara/selenium/node.rb#600 def to_datetime_str; end - # source://capybara//lib/capybara/selenium/node.rb#607 + # source://capybara//lib/capybara/selenium/node.rb#580 def to_s; end - # source://capybara//lib/capybara/selenium/node.rb#623 + # source://capybara//lib/capybara/selenium/node.rb#596 def to_time_str; end # Returns the value of attribute value. # - # source://capybara//lib/capybara/selenium/node.rb#601 + # source://capybara//lib/capybara/selenium/node.rb#574 def value; end end @@ -8047,7 +8319,7 @@ class Capybara::Session # @return [Session] a new instance of Session # - # source://capybara//lib/capybara/session.rb#78 + # source://capybara//lib/capybara/session.rb#79 def initialize(mode, app = T.unsafe(nil)); end # Execute the block, accepting a alert. @@ -8063,7 +8335,7 @@ class Capybara::Session # @raise [Capybara::ModalNotFound] if modal dialog hasn't been found # @return [String] the message shown in the modal # - # source://capybara//lib/capybara/session.rb#658 + # source://capybara//lib/capybara/session.rb#659 def accept_alert(text = T.unsafe(nil), **options, &blk); end # Execute the block, accepting a confirm. @@ -8079,7 +8351,7 @@ class Capybara::Session # @raise [Capybara::ModalNotFound] if modal dialog hasn't been found # @return [String] the message shown in the modal # - # source://capybara//lib/capybara/session.rb#668 + # source://capybara//lib/capybara/session.rb#669 def accept_confirm(text = T.unsafe(nil), **options, &blk); end # Execute the block, accepting a prompt, optionally responding to the prompt. @@ -8097,63 +8369,63 @@ class Capybara::Session # @raise [Capybara::ModalNotFound] if modal dialog hasn't been found # @return [String] the message shown in the modal # - # source://capybara//lib/capybara/session.rb#689 + # source://capybara//lib/capybara/session.rb#690 def accept_prompt(text = T.unsafe(nil), **options, &blk); end # Returns the element with focus. # # Not supported by Rack Test # - # source://capybara//lib/capybara/session.rb#322 + # source://capybara//lib/capybara/session.rb#323 def active_element; end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def all(*_arg0, **_arg1, &_arg2); end # Returns the value of attribute app. # - # source://capybara//lib/capybara/session.rb#75 + # source://capybara//lib/capybara/session.rb#76 def app; end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def assert_all_of_selectors(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def assert_any_of_selectors(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def assert_no_selector(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def assert_no_text(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#780 + # source://capybara//lib/capybara/session.rb#781 def assert_no_title(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def assert_none_of_selectors(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def assert_selector(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def assert_text(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#780 + # source://capybara//lib/capybara/session.rb#781 def assert_title(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def attach_file(*_arg0, **_arg1, &_arg2); end # @return [String] A snapshot of the DOM of the current document, as it looks right now (potentially modified by JavaScript). # - # source://capybara//lib/capybara/session.rb#196 + # source://capybara//lib/capybara/session.rb#197 def body; end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def check(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def choose(*_arg0, **_arg1, &_arg2); end # Reset the session (i.e. remove cookies and navigate to blank page). @@ -8172,25 +8444,25 @@ class Capybara::Session # * monkeypatch this method # * use Ruby's `prepend` method # - # source://capybara//lib/capybara/session.rb#129 + # source://capybara//lib/capybara/session.rb#130 def cleanup!; end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def click(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def click_button(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def click_link(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def click_link_or_button(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def click_on(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#828 + # source://capybara//lib/capybara/session.rb#829 def config; end # Accepts a block to set the configuration options if {Capybara.configure threadsafe} is `true`. Note that some options only have an effect @@ -8198,30 +8470,30 @@ class Capybara::Session # # @yield [config] # - # source://capybara//lib/capybara/session.rb#818 + # source://capybara//lib/capybara/session.rb#819 def configure; end # @return [String] Host of the current page # - # source://capybara//lib/capybara/session.rb#221 + # source://capybara//lib/capybara/session.rb#222 def current_host; end # @return [String] Path of the current page, without any domain information # - # source://capybara//lib/capybara/session.rb#206 + # source://capybara//lib/capybara/session.rb#207 def current_path; end - # source://capybara//lib/capybara/session.rb#790 + # source://capybara//lib/capybara/session.rb#791 def current_scope; end # @return [String] Fully qualified URL of the current page # - # source://capybara//lib/capybara/session.rb#230 + # source://capybara//lib/capybara/session.rb#231 def current_url; end # @return [Capybara::Window] current window # - # source://capybara//lib/capybara/session.rb#459 + # source://capybara//lib/capybara/session.rb#460 def current_window; end # Execute the block, dismissing a confirm. @@ -8237,7 +8509,7 @@ class Capybara::Session # @raise [Capybara::ModalNotFound] if modal dialog hasn't been found # @return [String] the message shown in the modal # - # source://capybara//lib/capybara/session.rb#678 + # source://capybara//lib/capybara/session.rb#679 def dismiss_confirm(text = T.unsafe(nil), **options, &blk); end # Execute the block, dismissing a prompt. @@ -8253,16 +8525,16 @@ class Capybara::Session # @raise [Capybara::ModalNotFound] if modal dialog hasn't been found # @return [String] the message shown in the modal # - # source://capybara//lib/capybara/session.rb#699 + # source://capybara//lib/capybara/session.rb#700 def dismiss_prompt(text = T.unsafe(nil), **options, &blk); end - # source://capybara//lib/capybara/session.rb#765 + # source://capybara//lib/capybara/session.rb#766 def document; end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def double_click(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#99 + # source://capybara//lib/capybara/session.rb#100 def driver; end # Evaluate the given JavaScript and obtain the result from a callback function which will be passed as the last argument to the script. @@ -8271,7 +8543,7 @@ class Capybara::Session # @param args Optional arguments that will be passed to the script # @return [Object] The result of the evaluated JavaScript (may be driver specific) # - # source://capybara//lib/capybara/session.rb#632 + # source://capybara//lib/capybara/session.rb#633 def evaluate_async_script(script, *args); end # Evaluate the given JavaScript and return the result. Be careful when using this with @@ -8282,7 +8554,7 @@ class Capybara::Session # @param args Optional arguments that will be passed to the script # @return [Object] The result of the evaluated JavaScript (may be driver specific) # - # source://capybara//lib/capybara/session.rb#618 + # source://capybara//lib/capybara/session.rb#619 def evaluate_script(script, *args); end # Execute the given script, not returning a result. This is useful for scripts that return @@ -8292,132 +8564,138 @@ class Capybara::Session # @param script [String] A string of JavaScript to execute # @param args Optional arguments that will be passed to the script. Driver support for this is optional and types of objects supported may differ between drivers # - # source://capybara//lib/capybara/session.rb#603 + # source://capybara//lib/capybara/session.rb#604 def execute_script(script, *args); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def fill_in(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def find(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def find_all(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def find_button(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def find_by_id(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def find_field(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def find_link(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def first(*_arg0, **_arg1, &_arg2); end # Move back a single entry in the browser's history. # - # source://capybara//lib/capybara/session.rb#296 + # source://capybara//lib/capybara/session.rb#297 def go_back; end # Move forward a single entry in the browser's history. # - # source://capybara//lib/capybara/session.rb#304 + # source://capybara//lib/capybara/session.rb#305 def go_forward; end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def has_button?(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def has_checked_field?(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def has_content?(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def has_css?(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 + def has_element?(*_arg0, **_arg1, &_arg2); end + + # source://capybara//lib/capybara/session.rb#772 def has_field?(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def has_link?(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def has_no_button?(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def has_no_checked_field?(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def has_no_content?(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def has_no_css?(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 + def has_no_element?(*_arg0, **_arg1, &_arg2); end + + # source://capybara//lib/capybara/session.rb#772 def has_no_field?(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def has_no_link?(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def has_no_select?(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def has_no_selector?(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def has_no_table?(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def has_no_text?(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#780 + # source://capybara//lib/capybara/session.rb#781 def has_no_title?(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def has_no_unchecked_field?(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def has_no_xpath?(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def has_select?(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def has_selector?(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def has_table?(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def has_text?(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#780 + # source://capybara//lib/capybara/session.rb#781 def has_title?(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def has_unchecked_field?(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def has_xpath?(*_arg0, **_arg1, &_arg2); end # @return [String] A snapshot of the DOM of the current document, as it looks right now (potentially modified by JavaScript). # - # source://capybara//lib/capybara/session.rb#196 + # source://capybara//lib/capybara/session.rb#197 def html; end - # source://capybara//lib/capybara/session.rb#786 + # source://capybara//lib/capybara/session.rb#787 def inspect; end # Returns the value of attribute mode. # - # source://capybara//lib/capybara/session.rb#75 + # source://capybara//lib/capybara/session.rb#76 def mode; end # Open a new window. @@ -8426,28 +8704,28 @@ class Capybara::Session # # @return [Capybara::Window] window that has been opened # - # source://capybara//lib/capybara/session.rb#483 + # source://capybara//lib/capybara/session.rb#484 def open_new_window(kind = T.unsafe(nil)); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def query(*_arg0, **_arg1, &_arg2); end # Disconnect from the current driver. A new driver will be instantiated on the next interaction. # - # source://capybara//lib/capybara/session.rb#146 + # source://capybara//lib/capybara/session.rb#147 def quit; end # Raise errors encountered in the server. # - # source://capybara//lib/capybara/session.rb#157 + # source://capybara//lib/capybara/session.rb#158 def raise_server_error!; end # Refresh the page. # - # source://capybara//lib/capybara/session.rb#287 + # source://capybara//lib/capybara/session.rb#288 def refresh; end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def refute_selector(*_arg0, **_arg1, &_arg2); end # Reset the session (i.e. remove cookies and navigate to blank page). @@ -8466,7 +8744,7 @@ class Capybara::Session # * monkeypatch this method # * use Ruby's `prepend` method # - # source://capybara//lib/capybara/session.rb#129 + # source://capybara//lib/capybara/session.rb#130 def reset!; end # Reset the session (i.e. remove cookies and navigate to blank page). @@ -8485,17 +8763,17 @@ class Capybara::Session # * monkeypatch this method # * use Ruby's `prepend` method # - # source://capybara//lib/capybara/session.rb#129 + # source://capybara//lib/capybara/session.rb#130 def reset_session!; end # Returns a hash of response headers. Not supported by all drivers (e.g. Selenium). # # @return [Hash] A hash of response headers. # - # source://capybara//lib/capybara/session.rb#178 + # source://capybara//lib/capybara/session.rb#179 def response_headers; end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def right_click(*_arg0, **_arg1, &_arg2); end # Save a snapshot of the page and open it in a browser for inspection. @@ -8506,7 +8784,7 @@ class Capybara::Session # # @param path [String] the path to where it should be saved # - # source://capybara//lib/capybara/session.rb#731 + # source://capybara//lib/capybara/session.rb#732 def save_and_open_page(path = T.unsafe(nil)); end # Save a screenshot of the page and open it for inspection. @@ -8518,7 +8796,7 @@ class Capybara::Session # @param path [String] the path to where it should be saved # @param options [Hash] a customizable set of options # - # source://capybara//lib/capybara/session.rb#761 + # source://capybara//lib/capybara/session.rb#762 def save_and_open_screenshot(path = T.unsafe(nil), **options); end # Save a snapshot of the page. If {Capybara.configure asset_host} is set it will inject `base` tag @@ -8531,7 +8809,7 @@ class Capybara::Session # @param path [String] the path to where it should be saved # @return [String] the path to which the file was saved # - # source://capybara//lib/capybara/session.rb#715 + # source://capybara//lib/capybara/session.rb#716 def save_page(path = T.unsafe(nil)); end # Save a screenshot of page. @@ -8544,39 +8822,39 @@ class Capybara::Session # @param options [Hash] a customizable set of options # @return [String] the path to which the file was saved # - # source://capybara//lib/capybara/session.rb#746 + # source://capybara//lib/capybara/session.rb#747 def save_screenshot(path = T.unsafe(nil), **options); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def scroll_by(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def scroll_to(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def select(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#312 - def send_keys(*args, **kw_args); end + # source://capybara//lib/capybara/session.rb#313 + def send_keys(*_arg0, **_arg1, &_arg2); end # Returns the value of attribute server. # - # source://capybara//lib/capybara/session.rb#75 + # source://capybara//lib/capybara/session.rb#76 def server; end - # source://capybara//lib/capybara/session.rb#836 + # source://capybara//lib/capybara/session.rb#837 def server_url; end # @return [String] A snapshot of the DOM of the current document, as it looks right now (potentially modified by JavaScript). # - # source://capybara//lib/capybara/session.rb#196 + # source://capybara//lib/capybara/session.rb#197 def source; end # Returns the current HTTP status code as an integer. Not supported by all drivers (e.g. Selenium). # # @return [Integer] Current HTTP status code # - # source://capybara//lib/capybara/session.rb#188 + # source://capybara//lib/capybara/session.rb#189 def status_code; end # Switch to the given frame. @@ -8588,7 +8866,7 @@ class Capybara::Session # @overload switch_to_frame # @overload switch_to_frame # - # source://capybara//lib/capybara/session.rb#407 + # source://capybara//lib/capybara/session.rb#408 def switch_to_frame(frame); end # Switch to the given window. @@ -8600,36 +8878,36 @@ class Capybara::Session # @raise [ArgumentError] if both or neither arguments were provided # @return [Capybara::Window] window that has been switched to # - # source://capybara//lib/capybara/session.rb#511 + # source://capybara//lib/capybara/session.rb#512 def switch_to_window(window = T.unsafe(nil), **options, &window_locator); end # Returns the value of attribute synchronized. # - # source://capybara//lib/capybara/session.rb#76 + # source://capybara//lib/capybara/session.rb#77 def synchronized; end # Sets the attribute synchronized # # @param value the value to set the attribute synchronized to. # - # source://capybara//lib/capybara/session.rb#76 + # source://capybara//lib/capybara/session.rb#77 def synchronized=(_arg0); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def text(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#780 + # source://capybara//lib/capybara/session.rb#781 def title(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def uncheck(*_arg0, **_arg1, &_arg2); end - # source://capybara//lib/capybara/session.rb#771 + # source://capybara//lib/capybara/session.rb#772 def unselect(*_arg0, **_arg1, &_arg2); end # Yield a block using a specific maximum wait time. # - # source://capybara//lib/capybara/session.rb#799 + # source://capybara//lib/capybara/session.rb#800 def using_wait_time(seconds, &block); end # Navigate to the given URL. The URL can either be a relative URL or an absolute URL @@ -8656,7 +8934,7 @@ class Capybara::Session # # @param visit_uri [#to_s] The URL to navigate to. The parameter will be cast to a String. # - # source://capybara//lib/capybara/session.rb#260 + # source://capybara//lib/capybara/session.rb#261 def visit(visit_uri); end # Get the window that has been opened by the passed block. @@ -8666,7 +8944,7 @@ class Capybara::Session # # @overload window_opened_by # - # source://capybara//lib/capybara/session.rb#580 + # source://capybara//lib/capybara/session.rb#581 def window_opened_by(**options); end # Get all opened windows. @@ -8675,7 +8953,7 @@ class Capybara::Session # # @return [Array] an array of all windows # - # source://capybara//lib/capybara/session.rb#470 + # source://capybara//lib/capybara/session.rb#471 def windows; end # Executes the given block within the context of a node. {#within} takes the @@ -8707,7 +8985,7 @@ class Capybara::Session # @overload within # @raise [Capybara::ElementNotFound] If the scope can't be found before time expires # - # source://capybara//lib/capybara/session.rb#361 + # source://capybara//lib/capybara/session.rb#362 def within(*args, **kw_args); end # Executes the given block within the context of a node. {#within} takes the @@ -8739,14 +9017,14 @@ class Capybara::Session # @overload within # @raise [Capybara::ElementNotFound] If the scope can't be found before time expires # - # source://capybara//lib/capybara/session.rb#361 + # source://capybara//lib/capybara/session.rb#362 def within_element(*args, **kw_args); end # Execute the given block within the a specific fieldset given the id or legend of that fieldset. # # @param locator [String] Id or legend of the fieldset # - # source://capybara//lib/capybara/session.rb#378 + # source://capybara//lib/capybara/session.rb#379 def within_fieldset(locator, &block); end # Execute the given block within the given iframe using given frame, frame name/id or index. @@ -8756,14 +9034,14 @@ class Capybara::Session # @overload within_frame # @overload within_frame # - # source://capybara//lib/capybara/session.rb#447 + # source://capybara//lib/capybara/session.rb#448 def within_frame(*args, **kw_args); end # Execute the given block within the a specific table given the id or caption of that table. # # @param locator [String] Id or caption of the table # - # source://capybara//lib/capybara/session.rb#388 + # source://capybara//lib/capybara/session.rb#389 def within_table(locator, &block); end # This method does the following: @@ -8777,80 +9055,80 @@ class Capybara::Session # @raise [Capybara::ScopeError] if this method is invoked inside {#within_frame} method # @return value returned by the block # - # source://capybara//lib/capybara/session.rb#544 + # source://capybara//lib/capybara/session.rb#545 def within_window(window_or_proc); end private - # source://capybara//lib/capybara/session.rb#901 + # source://capybara//lib/capybara/session.rb#902 def _find_frame(*args, **kw_args); end # @raise [Capybara::ScopeError] # - # source://capybara//lib/capybara/session.rb#917 + # source://capybara//lib/capybara/session.rb#918 def _switch_to_window(window = T.unsafe(nil), **options, &window_locator); end # @raise [Capybara::WindowError] # - # source://capybara//lib/capybara/session.rb#937 + # source://capybara//lib/capybara/session.rb#938 def _switch_to_window_by_locator; end - # source://capybara//lib/capybara/session.rb#848 + # source://capybara//lib/capybara/session.rb#849 def accept_modal(type, text_or_options, options, &blk); end - # source://capybara//lib/capybara/session.rb#897 + # source://capybara//lib/capybara/session.rb#898 def adjust_server_port(uri); end - # source://capybara//lib/capybara/session.rb#875 + # source://capybara//lib/capybara/session.rb#876 def default_fn(extension); end - # source://capybara//lib/capybara/session.rb#852 + # source://capybara//lib/capybara/session.rb#853 def dismiss_modal(type, text_or_options, options, &blk); end - # source://capybara//lib/capybara/session.rb#844 + # source://capybara//lib/capybara/session.rb#845 def driver_args(args); end - # source://capybara//lib/capybara/session.rb#884 + # source://capybara//lib/capybara/session.rb#885 def element_script_result(arg); end - # source://capybara//lib/capybara/session.rb#856 + # source://capybara//lib/capybara/session.rb#857 def modal_options(text = T.unsafe(nil), **options); end - # source://capybara//lib/capybara/session.rb#862 + # source://capybara//lib/capybara/session.rb#863 def open_file(path); end - # source://capybara//lib/capybara/session.rb#869 + # source://capybara//lib/capybara/session.rb#870 def prepare_path(path, extension); end - # source://capybara//lib/capybara/session.rb#880 + # source://capybara//lib/capybara/session.rb#881 def scopes; end - # source://capybara//lib/capybara/session.rb#945 + # source://capybara//lib/capybara/session.rb#946 def synchronize_windows(options, &block); end class << self # @return [Boolean] # - # source://capybara//lib/capybara/session.rb#824 + # source://capybara//lib/capybara/session.rb#825 def instance_created?; end end end # @api private # -# source://capybara//lib/capybara/session.rb#57 +# source://capybara//lib/capybara/session.rb#58 Capybara::Session::DOCUMENT_METHODS = T.let(T.unsafe(nil), Array) -# source://capybara//lib/capybara/session.rb#73 +# source://capybara//lib/capybara/session.rb#74 Capybara::Session::DSL_METHODS = T.let(T.unsafe(nil), Array) -# source://capybara//lib/capybara/session.rb#70 +# source://capybara//lib/capybara/session.rb#71 Capybara::Session::MODAL_METHODS = T.let(T.unsafe(nil), Array) # source://capybara//lib/capybara/session.rb#41 Capybara::Session::NODE_METHODS = T.let(T.unsafe(nil), Array) -# source://capybara//lib/capybara/session.rb#60 +# source://capybara//lib/capybara/session.rb#61 Capybara::Session::SESSION_METHODS = T.let(T.unsafe(nil), Array) # source://capybara//lib/capybara/session/config.rb#6 diff --git a/sorbet/rbi/gems/counter_culture@3.4.0.rbi b/sorbet/rbi/gems/counter_culture@3.7.0.rbi similarity index 88% rename from sorbet/rbi/gems/counter_culture@3.4.0.rbi rename to sorbet/rbi/gems/counter_culture@3.7.0.rbi index b792bf5fb..5909b62f5 100644 --- a/sorbet/rbi/gems/counter_culture@3.4.0.rbi +++ b/sorbet/rbi/gems/counter_culture@3.7.0.rbi @@ -14,6 +14,9 @@ module CounterCulture def batch_size=(val); end class << self + # source://counter_culture//lib/counter_culture.rb#19 + def aggregate_counter_updates; end + # source://counter_culture//lib/counter_culture.rb#11 def batch_size; end @@ -37,7 +40,7 @@ class CounterCulture::Counter # @return [Boolean] # - # source://counter_culture//lib/counter_culture/counter.rb#248 + # source://counter_culture//lib/counter_culture/counter.rb#263 def attribute_changed?(obj, attr); end # increments or decrements a counter cache @@ -66,14 +69,14 @@ class CounterCulture::Counter # obj: object to calculate the counter cache name for # cache_name_finder: object used to calculate the cache name # - # source://counter_culture//lib/counter_culture/counter.rb#142 + # source://counter_culture//lib/counter_culture/counter.rb#157 def counter_cache_name_for(obj); end # Gets the delta magnitude of the counter cache for a specific object # # obj: object to calculate the counter cache name for # - # source://counter_culture//lib/counter_culture/counter.rb#130 + # source://counter_culture//lib/counter_culture/counter.rb#145 def counter_delta_magnitude_for(obj); end # source://counter_culture//lib/counter_culture/counter.rb#6 @@ -85,12 +88,12 @@ class CounterCulture::Counter # source://counter_culture//lib/counter_culture/counter.rb#6 def execute_after_commit; end - # source://counter_culture//lib/counter_culture/counter.rb#323 + # source://counter_culture//lib/counter_culture/counter.rb#340 def execute_now_or_after_commit(obj, &block); end # @return [Boolean] # - # source://counter_culture//lib/counter_culture/counter.rb#240 + # source://counter_culture//lib/counter_culture/counter.rb#255 def first_level_relation_changed?(instance); end # gets the foreign key name of the relation. will look at the first @@ -100,10 +103,10 @@ class CounterCulture::Counter # relation: a symbol or array of symbols; specifies the relation # that has the counter cache column # - # source://counter_culture//lib/counter_culture/counter.rb#300 + # source://counter_culture//lib/counter_culture/counter.rb#315 def first_level_relation_foreign_key; end - # source://counter_culture//lib/counter_culture/counter.rb#305 + # source://counter_culture//lib/counter_culture/counter.rb#320 def first_level_relation_foreign_type; end # gets the value of the foreign key on the given relation @@ -114,7 +117,7 @@ class CounterCulture::Counter # pass true to get the past value, false or nothing to get the # current value # - # source://counter_culture//lib/counter_culture/counter.rb#165 + # source://counter_culture//lib/counter_culture/counter.rb#180 def foreign_key_value(obj, relation, was = T.unsafe(nil)); end # source://counter_culture//lib/counter_culture/counter.rb#6 @@ -122,7 +125,7 @@ class CounterCulture::Counter # the string to pass to order() in order to sort by primary key # - # source://counter_culture//lib/counter_culture/counter.rb#154 + # source://counter_culture//lib/counter_culture/counter.rb#169 def full_primary_key(klass); end # source://counter_culture//lib/counter_culture/counter.rb#6 @@ -130,10 +133,10 @@ class CounterCulture::Counter # @return [Boolean] # - # source://counter_culture//lib/counter_culture/counter.rb#256 + # source://counter_culture//lib/counter_culture/counter.rb#271 def polymorphic?; end - # source://counter_culture//lib/counter_culture/counter.rb#311 + # source://counter_culture//lib/counter_culture/counter.rb#326 def previous_model(obj); end # source://counter_culture//lib/counter_culture/counter.rb#6 @@ -144,7 +147,7 @@ class CounterCulture::Counter # relation: a symbol or array of symbols; specifies the relation # that has the counter cache column # - # source://counter_culture//lib/counter_culture/counter.rb#268 + # source://counter_culture//lib/counter_culture/counter.rb#283 def relation_foreign_key(relation); end # gets the class of the given relation @@ -157,7 +160,7 @@ class CounterCulture::Counter # was: boolean # we're actually looking for the old value -- only can change for polymorphic relations # - # source://counter_culture//lib/counter_culture/counter.rb#222 + # source://counter_culture//lib/counter_culture/counter.rb#237 def relation_klass(relation, source: T.unsafe(nil), was: T.unsafe(nil)); end # gets the primary key name of the given relation @@ -170,7 +173,7 @@ class CounterCulture::Counter # was: boolean # we're actually looking for the old value -- only can change for polymorphic relations # - # source://counter_culture//lib/counter_culture/counter.rb#281 + # source://counter_culture//lib/counter_culture/counter.rb#296 def relation_primary_key(relation, source: T.unsafe(nil), was: T.unsafe(nil)); end # gets the reflect object on the given relation @@ -178,7 +181,7 @@ class CounterCulture::Counter # relation: a symbol or array of symbols; specifies the relation # that has the counter cache column # - # source://counter_culture//lib/counter_culture/counter.rb#192 + # source://counter_culture//lib/counter_culture/counter.rb#207 def relation_reflect(relation); end # source://counter_culture//lib/counter_culture/counter.rb#6 @@ -186,8 +189,26 @@ class CounterCulture::Counter private - # source://counter_culture//lib/counter_culture/counter.rb#334 + # source://counter_culture//lib/counter_culture/counter.rb#372 + def assemble_counter_update(klass, id_to_change, quoted_column, operator, delta_magnitude); end + + # source://counter_culture//lib/counter_culture/counter.rb#362 + def assemble_money_counter_update(klass, id_to_change, quoted_column, operator, delta_magnitude); end + + # source://counter_culture//lib/counter_culture/counter.rb#382 + def assemble_timestamp_update(klass, id_to_change, timestamp_column, value); end + + # source://counter_culture//lib/counter_culture/counter.rb#352 def attribute_was(obj, attr); end + + # source://counter_culture//lib/counter_culture/counter.rb#392 + def counter_update_snippet(update, klass, id_to_change, operator, delta_magnitude); end + + # source://counter_culture//lib/counter_culture/counter.rb#405 + def remember_counter_update(klass, id, operation, value); end + + # source://counter_culture//lib/counter_culture/counter.rb#413 + def remember_timestamp_update(klass, id, operation, value); end end # source://counter_culture//lib/counter_culture/counter.rb#4 @@ -403,48 +424,48 @@ class CounterCulture::Reconciler::Reconciliation private - # source://counter_culture//lib/counter_culture/reconciler.rb#202 + # source://counter_culture//lib/counter_culture/reconciler.rb#206 def count_select; end - # source://counter_culture//lib/counter_culture/reconciler.rb#228 + # source://counter_culture//lib/counter_culture/reconciler.rb#232 def join_clauses(where); end - # source://counter_culture//lib/counter_culture/reconciler.rb#175 + # source://counter_culture//lib/counter_culture/reconciler.rb#179 def log(message); end # @return [Boolean] # - # source://counter_culture//lib/counter_culture/reconciler.rb#187 + # source://counter_culture//lib/counter_culture/reconciler.rb#191 def log?; end - # source://counter_culture//lib/counter_culture/reconciler.rb#181 + # source://counter_culture//lib/counter_culture/reconciler.rb#185 def log_without_newline(message); end - # source://counter_culture//lib/counter_culture/reconciler.rb#314 + # source://counter_culture//lib/counter_culture/reconciler.rb#318 def parameterize(string); end # This is only needed in relatively unusal cases, for example if you are # using Postgres with schema-namespaced tables. But then it's required, # and otherwise it's just a no-op, so why not do it? # - # source://counter_culture//lib/counter_culture/reconciler.rb#310 + # source://counter_culture//lib/counter_culture/reconciler.rb#314 def quote_table_name(table_name); end - # source://counter_culture//lib/counter_culture/reconciler.rb#217 + # source://counter_culture//lib/counter_culture/reconciler.rb#221 def self_table_name; end # keep track of what we fixed, e.g. for a notification email # - # source://counter_culture//lib/counter_culture/reconciler.rb#192 + # source://counter_culture//lib/counter_culture/reconciler.rb#196 def track_change(record, column_name, count); end - # source://counter_culture//lib/counter_culture/reconciler.rb#143 + # source://counter_culture//lib/counter_culture/reconciler.rb#147 def update_count_for_batch(column_name, records); end - # source://counter_culture//lib/counter_culture/reconciler.rb#322 + # source://counter_culture//lib/counter_culture/reconciler.rb#326 def with_reading_db_connection(&block); end - # source://counter_culture//lib/counter_culture/reconciler.rb#330 + # source://counter_culture//lib/counter_culture/reconciler.rb#334 def with_writing_db_connection(&block); end end diff --git a/sorbet/rbi/gems/crack@0.4.5.rbi b/sorbet/rbi/gems/crack@1.0.0.rbi similarity index 100% rename from sorbet/rbi/gems/crack@0.4.5.rbi rename to sorbet/rbi/gems/crack@1.0.0.rbi diff --git a/sorbet/rbi/gems/csv@3.3.0.rbi b/sorbet/rbi/gems/csv@3.3.0.rbi new file mode 100644 index 000000000..fcafb7d2d --- /dev/null +++ b/sorbet/rbi/gems/csv@3.3.0.rbi @@ -0,0 +1,4696 @@ +# typed: false + +# DO NOT EDIT MANUALLY +# This is an autogenerated file for types exported from the `csv` gem. +# Please instead update this file by running `bin/tapioca gem csv`. + + +# source://csv//lib/csv/core_ext/array.rb#1 +class Array + include ::Enumerable + + # Equivalent to CSV::generate_line(self, options) + # + # ["CSV", "data"].to_csv + # #=> "CSV,data\n" + # + # source://csv//lib/csv/core_ext/array.rb#6 + def to_csv(**options); end +end + +# == \CSV +# +# === \CSV Data +# +# \CSV (comma-separated values) data is a text representation of a table: +# - A _row_ _separator_ delimits table rows. +# A common row separator is the newline character "\n". +# - A _column_ _separator_ delimits fields in a row. +# A common column separator is the comma character ",". +# +# This \CSV \String, with row separator "\n" +# and column separator ",", +# has three rows and two columns: +# "foo,0\nbar,1\nbaz,2\n" +# +# Despite the name \CSV, a \CSV representation can use different separators. +# +# For more about tables, see the Wikipedia article +# "{Table (information)}[https://en.wikipedia.org/wiki/Table_(information)]", +# especially its section +# "{Simple table}[https://en.wikipedia.org/wiki/Table_(information)#Simple_table]" +# +# == \Class \CSV +# +# Class \CSV provides methods for: +# - Parsing \CSV data from a \String object, a \File (via its file path), or an \IO object. +# - Generating \CSV data to a \String object. +# +# To make \CSV available: +# require 'csv' +# +# All examples here assume that this has been done. +# +# == Keeping It Simple +# +# A \CSV object has dozens of instance methods that offer fine-grained control +# of parsing and generating \CSV data. +# For many needs, though, simpler approaches will do. +# +# This section summarizes the singleton methods in \CSV +# that allow you to parse and generate without explicitly +# creating \CSV objects. +# For details, follow the links. +# +# === Simple Parsing +# +# Parsing methods commonly return either of: +# - An \Array of Arrays of Strings: +# - The outer \Array is the entire "table". +# - Each inner \Array is a row. +# - Each \String is a field. +# - A CSV::Table object. For details, see +# {\CSV with Headers}[#class-CSV-label-CSV+with+Headers]. +# +# ==== Parsing a \String +# +# The input to be parsed can be a string: +# string = "foo,0\nbar,1\nbaz,2\n" +# +# \Method CSV.parse returns the entire \CSV data: +# CSV.parse(string) # => [["foo", "0"], ["bar", "1"], ["baz", "2"]] +# +# \Method CSV.parse_line returns only the first row: +# CSV.parse_line(string) # => ["foo", "0"] +# +# \CSV extends class \String with instance method String#parse_csv, +# which also returns only the first row: +# string.parse_csv # => ["foo", "0"] +# +# ==== Parsing Via a \File Path +# +# The input to be parsed can be in a file: +# string = "foo,0\nbar,1\nbaz,2\n" +# path = 't.csv' +# File.write(path, string) +# +# \Method CSV.read returns the entire \CSV data: +# CSV.read(path) # => [["foo", "0"], ["bar", "1"], ["baz", "2"]] +# +# \Method CSV.foreach iterates, passing each row to the given block: +# CSV.foreach(path) do |row| +# p row +# end +# Output: +# ["foo", "0"] +# ["bar", "1"] +# ["baz", "2"] +# +# \Method CSV.table returns the entire \CSV data as a CSV::Table object: +# CSV.table(path) # => # +# +# ==== Parsing from an Open \IO Stream +# +# The input to be parsed can be in an open \IO stream: +# +# \Method CSV.read returns the entire \CSV data: +# File.open(path) do |file| +# CSV.read(file) +# end # => [["foo", "0"], ["bar", "1"], ["baz", "2"]] +# +# As does method CSV.parse: +# File.open(path) do |file| +# CSV.parse(file) +# end # => [["foo", "0"], ["bar", "1"], ["baz", "2"]] +# +# \Method CSV.parse_line returns only the first row: +# File.open(path) do |file| +# CSV.parse_line(file) +# end # => ["foo", "0"] +# +# \Method CSV.foreach iterates, passing each row to the given block: +# File.open(path) do |file| +# CSV.foreach(file) do |row| +# p row +# end +# end +# Output: +# ["foo", "0"] +# ["bar", "1"] +# ["baz", "2"] +# +# \Method CSV.table returns the entire \CSV data as a CSV::Table object: +# File.open(path) do |file| +# CSV.table(file) +# end # => # +# +# === Simple Generating +# +# \Method CSV.generate returns a \String; +# this example uses method CSV#<< to append the rows +# that are to be generated: +# output_string = CSV.generate do |csv| +# csv << ['foo', 0] +# csv << ['bar', 1] +# csv << ['baz', 2] +# end +# output_string # => "foo,0\nbar,1\nbaz,2\n" +# +# \Method CSV.generate_line returns a \String containing the single row +# constructed from an \Array: +# CSV.generate_line(['foo', '0']) # => "foo,0\n" +# +# \CSV extends class \Array with instance method Array#to_csv, +# which forms an \Array into a \String: +# ['foo', '0'].to_csv # => "foo,0\n" +# +# === "Filtering" \CSV +# +# \Method CSV.filter provides a Unix-style filter for \CSV data. +# The input data is processed to form the output data: +# in_string = "foo,0\nbar,1\nbaz,2\n" +# out_string = '' +# CSV.filter(in_string, out_string) do |row| +# row[0] = row[0].upcase +# row[1] *= 4 +# end +# out_string # => "FOO,0000\nBAR,1111\nBAZ,2222\n" +# +# == \CSV Objects +# +# There are three ways to create a \CSV object: +# - \Method CSV.new returns a new \CSV object. +# - \Method CSV.instance returns a new or cached \CSV object. +# - \Method \CSV() also returns a new or cached \CSV object. +# +# === Instance Methods +# +# \CSV has three groups of instance methods: +# - Its own internally defined instance methods. +# - Methods included by module Enumerable. +# - Methods delegated to class IO. See below. +# +# ==== Delegated Methods +# +# For convenience, a CSV object will delegate to many methods in class IO. +# (A few have wrapper "guard code" in \CSV.) You may call: +# * IO#binmode +# * #binmode? +# * IO#close +# * IO#close_read +# * IO#close_write +# * IO#closed? +# * #eof +# * #eof? +# * IO#external_encoding +# * IO#fcntl +# * IO#fileno +# * #flock +# * IO#flush +# * IO#fsync +# * IO#internal_encoding +# * #ioctl +# * IO#isatty +# * #path +# * IO#pid +# * IO#pos +# * IO#pos= +# * IO#reopen +# * #rewind +# * IO#seek +# * #stat +# * IO#string +# * IO#sync +# * IO#sync= +# * IO#tell +# * #to_i +# * #to_io +# * IO#truncate +# * IO#tty? +# +# === Options +# +# The default values for options are: +# DEFAULT_OPTIONS = { +# # For both parsing and generating. +# col_sep: ",", +# row_sep: :auto, +# quote_char: '"', +# # For parsing. +# field_size_limit: nil, +# converters: nil, +# unconverted_fields: nil, +# headers: false, +# return_headers: false, +# header_converters: nil, +# skip_blanks: false, +# skip_lines: nil, +# liberal_parsing: false, +# nil_value: nil, +# empty_value: "", +# strip: false, +# # For generating. +# write_headers: nil, +# quote_empty: true, +# force_quotes: false, +# write_converters: nil, +# write_nil_value: nil, +# write_empty_value: "", +# } +# +# ==== Options for Parsing +# +# Options for parsing, described in detail below, include: +# - +row_sep+: Specifies the row separator; used to delimit rows. +# - +col_sep+: Specifies the column separator; used to delimit fields. +# - +quote_char+: Specifies the quote character; used to quote fields. +# - +field_size_limit+: Specifies the maximum field size + 1 allowed. +# Deprecated since 3.2.3. Use +max_field_size+ instead. +# - +max_field_size+: Specifies the maximum field size allowed. +# - +converters+: Specifies the field converters to be used. +# - +unconverted_fields+: Specifies whether unconverted fields are to be available. +# - +headers+: Specifies whether data contains headers, +# or specifies the headers themselves. +# - +return_headers+: Specifies whether headers are to be returned. +# - +header_converters+: Specifies the header converters to be used. +# - +skip_blanks+: Specifies whether blanks lines are to be ignored. +# - +skip_lines+: Specifies how comments lines are to be recognized. +# - +strip+: Specifies whether leading and trailing whitespace are to be +# stripped from fields. This must be compatible with +col_sep+; if it is not, +# then an +ArgumentError+ exception will be raised. +# - +liberal_parsing+: Specifies whether \CSV should attempt to parse +# non-compliant data. +# - +nil_value+: Specifies the object that is to be substituted for each null (no-text) field. +# - +empty_value+: Specifies the object that is to be substituted for each empty field. +# +# :include: ../doc/csv/options/common/row_sep.rdoc +# +# :include: ../doc/csv/options/common/col_sep.rdoc +# +# :include: ../doc/csv/options/common/quote_char.rdoc +# +# :include: ../doc/csv/options/parsing/field_size_limit.rdoc +# +# :include: ../doc/csv/options/parsing/converters.rdoc +# +# :include: ../doc/csv/options/parsing/unconverted_fields.rdoc +# +# :include: ../doc/csv/options/parsing/headers.rdoc +# +# :include: ../doc/csv/options/parsing/return_headers.rdoc +# +# :include: ../doc/csv/options/parsing/header_converters.rdoc +# +# :include: ../doc/csv/options/parsing/skip_blanks.rdoc +# +# :include: ../doc/csv/options/parsing/skip_lines.rdoc +# +# :include: ../doc/csv/options/parsing/strip.rdoc +# +# :include: ../doc/csv/options/parsing/liberal_parsing.rdoc +# +# :include: ../doc/csv/options/parsing/nil_value.rdoc +# +# :include: ../doc/csv/options/parsing/empty_value.rdoc +# +# ==== Options for Generating +# +# Options for generating, described in detail below, include: +# - +row_sep+: Specifies the row separator; used to delimit rows. +# - +col_sep+: Specifies the column separator; used to delimit fields. +# - +quote_char+: Specifies the quote character; used to quote fields. +# - +write_headers+: Specifies whether headers are to be written. +# - +force_quotes+: Specifies whether each output field is to be quoted. +# - +quote_empty+: Specifies whether each empty output field is to be quoted. +# - +write_converters+: Specifies the field converters to be used in writing. +# - +write_nil_value+: Specifies the object that is to be substituted for each +nil+-valued field. +# - +write_empty_value+: Specifies the object that is to be substituted for each empty field. +# +# :include: ../doc/csv/options/common/row_sep.rdoc +# +# :include: ../doc/csv/options/common/col_sep.rdoc +# +# :include: ../doc/csv/options/common/quote_char.rdoc +# +# :include: ../doc/csv/options/generating/write_headers.rdoc +# +# :include: ../doc/csv/options/generating/force_quotes.rdoc +# +# :include: ../doc/csv/options/generating/quote_empty.rdoc +# +# :include: ../doc/csv/options/generating/write_converters.rdoc +# +# :include: ../doc/csv/options/generating/write_nil_value.rdoc +# +# :include: ../doc/csv/options/generating/write_empty_value.rdoc +# +# === \CSV with Headers +# +# CSV allows to specify column names of CSV file, whether they are in data, or +# provided separately. If headers are specified, reading methods return an instance +# of CSV::Table, consisting of CSV::Row. +# +# # Headers are part of data +# data = CSV.parse(<<~ROWS, headers: true) +# Name,Department,Salary +# Bob,Engineering,1000 +# Jane,Sales,2000 +# John,Management,5000 +# ROWS +# +# data.class #=> CSV::Table +# data.first #=> # +# data.first.to_h #=> {"Name"=>"Bob", "Department"=>"Engineering", "Salary"=>"1000"} +# +# # Headers provided by developer +# data = CSV.parse('Bob,Engineering,1000', headers: %i[name department salary]) +# data.first #=> # +# +# === \Converters +# +# By default, each value (field or header) parsed by \CSV is formed into a \String. +# You can use a _field_ _converter_ or _header_ _converter_ +# to intercept and modify the parsed values: +# - See {Field Converters}[#class-CSV-label-Field+Converters]. +# - See {Header Converters}[#class-CSV-label-Header+Converters]. +# +# Also by default, each value to be written during generation is written 'as-is'. +# You can use a _write_ _converter_ to modify values before writing. +# - See {Write Converters}[#class-CSV-label-Write+Converters]. +# +# ==== Specifying \Converters +# +# You can specify converters for parsing or generating in the +options+ +# argument to various \CSV methods: +# - Option +converters+ for converting parsed field values. +# - Option +header_converters+ for converting parsed header values. +# - Option +write_converters+ for converting values to be written (generated). +# +# There are three forms for specifying converters: +# - A converter proc: executable code to be used for conversion. +# - A converter name: the name of a stored converter. +# - A converter list: an array of converter procs, converter names, and converter lists. +# +# ===== Converter Procs +# +# This converter proc, +strip_converter+, accepts a value +field+ +# and returns field.strip: +# strip_converter = proc {|field| field.strip } +# In this call to CSV.parse, +# the keyword argument converters: string_converter +# specifies that: +# - \Proc +string_converter+ is to be called for each parsed field. +# - The converter's return value is to replace the +field+ value. +# Example: +# string = " foo , 0 \n bar , 1 \n baz , 2 \n" +# array = CSV.parse(string, converters: strip_converter) +# array # => [["foo", "0"], ["bar", "1"], ["baz", "2"]] +# +# A converter proc can receive a second argument, +field_info+, +# that contains details about the field. +# This modified +strip_converter+ displays its arguments: +# strip_converter = proc do |field, field_info| +# p [field, field_info] +# field.strip +# end +# string = " foo , 0 \n bar , 1 \n baz , 2 \n" +# array = CSV.parse(string, converters: strip_converter) +# array # => [["foo", "0"], ["bar", "1"], ["baz", "2"]] +# Output: +# [" foo ", #] +# [" 0 ", #] +# [" bar ", #] +# [" 1 ", #] +# [" baz ", #] +# [" 2 ", #] +# Each CSV::FieldInfo object shows: +# - The 0-based field index. +# - The 1-based line index. +# - The field header, if any. +# +# ===== Stored \Converters +# +# A converter may be given a name and stored in a structure where +# the parsing methods can find it by name. +# +# The storage structure for field converters is the \Hash CSV::Converters. +# It has several built-in converter procs: +# - :integer: converts each \String-embedded integer into a true \Integer. +# - :float: converts each \String-embedded float into a true \Float. +# - :date: converts each \String-embedded date into a true \Date. +# - :date_time: converts each \String-embedded date-time into a true \DateTime +# . +# This example creates a converter proc, then stores it: +# strip_converter = proc {|field| field.strip } +# CSV::Converters[:strip] = strip_converter +# Then the parsing method call can refer to the converter +# by its name, :strip: +# string = " foo , 0 \n bar , 1 \n baz , 2 \n" +# array = CSV.parse(string, converters: :strip) +# array # => [["foo", "0"], ["bar", "1"], ["baz", "2"]] +# +# The storage structure for header converters is the \Hash CSV::HeaderConverters, +# which works in the same way. +# It also has built-in converter procs: +# - :downcase: Downcases each header. +# - :symbol: Converts each header to a \Symbol. +# +# There is no such storage structure for write headers. +# +# In order for the parsing methods to access stored converters in non-main-Ractors, the +# storage structure must be made shareable first. +# Therefore, Ractor.make_shareable(CSV::Converters) and +# Ractor.make_shareable(CSV::HeaderConverters) must be called before the creation +# of Ractors that use the converters stored in these structures. (Since making the storage +# structures shareable involves freezing them, any custom converters that are to be used +# must be added first.) +# +# ===== Converter Lists +# +# A _converter_ _list_ is an \Array that may include any assortment of: +# - Converter procs. +# - Names of stored converters. +# - Nested converter lists. +# +# Examples: +# numeric_converters = [:integer, :float] +# date_converters = [:date, :date_time] +# [numeric_converters, strip_converter] +# [strip_converter, date_converters, :float] +# +# Like a converter proc, a converter list may be named and stored in either +# \CSV::Converters or CSV::HeaderConverters: +# CSV::Converters[:custom] = [strip_converter, date_converters, :float] +# CSV::HeaderConverters[:custom] = [:downcase, :symbol] +# +# There are two built-in converter lists: +# CSV::Converters[:numeric] # => [:integer, :float] +# CSV::Converters[:all] # => [:date_time, :numeric] +# +# ==== Field \Converters +# +# With no conversion, all parsed fields in all rows become Strings: +# string = "foo,0\nbar,1\nbaz,2\n" +# ary = CSV.parse(string) +# ary # => # => [["foo", "0"], ["bar", "1"], ["baz", "2"]] +# +# When you specify a field converter, each parsed field is passed to the converter; +# its return value becomes the stored value for the field. +# A converter might, for example, convert an integer embedded in a \String +# into a true \Integer. +# (In fact, that's what built-in field converter +:integer+ does.) +# +# There are three ways to use field \converters. +# +# - Using option {converters}[#class-CSV-label-Option+converters] with a parsing method: +# ary = CSV.parse(string, converters: :integer) +# ary # => [0, 1, 2] # => [["foo", 0], ["bar", 1], ["baz", 2]] +# - Using option {converters}[#class-CSV-label-Option+converters] with a new \CSV instance: +# csv = CSV.new(string, converters: :integer) +# # Field converters in effect: +# csv.converters # => [:integer] +# csv.read # => [["foo", 0], ["bar", 1], ["baz", 2]] +# - Using method #convert to add a field converter to a \CSV instance: +# csv = CSV.new(string) +# # Add a converter. +# csv.convert(:integer) +# csv.converters # => [:integer] +# csv.read # => [["foo", 0], ["bar", 1], ["baz", 2]] +# +# Installing a field converter does not affect already-read rows: +# csv = CSV.new(string) +# csv.shift # => ["foo", "0"] +# # Add a converter. +# csv.convert(:integer) +# csv.converters # => [:integer] +# csv.read # => [["bar", 1], ["baz", 2]] +# +# There are additional built-in \converters, and custom \converters are also supported. +# +# ===== Built-In Field \Converters +# +# The built-in field converters are in \Hash CSV::Converters: +# - Each key is a field converter name. +# - Each value is one of: +# - A \Proc field converter. +# - An \Array of field converter names. +# +# Display: +# CSV::Converters.each_pair do |name, value| +# if value.kind_of?(Proc) +# p [name, value.class] +# else +# p [name, value] +# end +# end +# Output: +# [:integer, Proc] +# [:float, Proc] +# [:numeric, [:integer, :float]] +# [:date, Proc] +# [:date_time, Proc] +# [:all, [:date_time, :numeric]] +# +# Each of these converters transcodes values to UTF-8 before attempting conversion. +# If a value cannot be transcoded to UTF-8 the conversion will +# fail and the value will remain unconverted. +# +# Converter +:integer+ converts each field that Integer() accepts: +# data = '0,1,2,x' +# # Without the converter +# csv = CSV.parse_line(data) +# csv # => ["0", "1", "2", "x"] +# # With the converter +# csv = CSV.parse_line(data, converters: :integer) +# csv # => [0, 1, 2, "x"] +# +# Converter +:float+ converts each field that Float() accepts: +# data = '1.0,3.14159,x' +# # Without the converter +# csv = CSV.parse_line(data) +# csv # => ["1.0", "3.14159", "x"] +# # With the converter +# csv = CSV.parse_line(data, converters: :float) +# csv # => [1.0, 3.14159, "x"] +# +# Converter +:numeric+ converts with both +:integer+ and +:float+.. +# +# Converter +:date+ converts each field that Date::parse accepts: +# data = '2001-02-03,x' +# # Without the converter +# csv = CSV.parse_line(data) +# csv # => ["2001-02-03", "x"] +# # With the converter +# csv = CSV.parse_line(data, converters: :date) +# csv # => [#, "x"] +# +# Converter +:date_time+ converts each field that DateTime::parse accepts: +# data = '2020-05-07T14:59:00-05:00,x' +# # Without the converter +# csv = CSV.parse_line(data) +# csv # => ["2020-05-07T14:59:00-05:00", "x"] +# # With the converter +# csv = CSV.parse_line(data, converters: :date_time) +# csv # => [#, "x"] +# +# Converter +:numeric+ converts with both +:date_time+ and +:numeric+.. +# +# As seen above, method #convert adds \converters to a \CSV instance, +# and method #converters returns an \Array of the \converters in effect: +# csv = CSV.new('0,1,2') +# csv.converters # => [] +# csv.convert(:integer) +# csv.converters # => [:integer] +# csv.convert(:date) +# csv.converters # => [:integer, :date] +# +# ===== Custom Field \Converters +# +# You can define a custom field converter: +# strip_converter = proc {|field| field.strip } +# string = " foo , 0 \n bar , 1 \n baz , 2 \n" +# array = CSV.parse(string, converters: strip_converter) +# array # => [["foo", "0"], ["bar", "1"], ["baz", "2"]] +# You can register the converter in \Converters \Hash, +# which allows you to refer to it by name: +# CSV::Converters[:strip] = strip_converter +# string = " foo , 0 \n bar , 1 \n baz , 2 \n" +# array = CSV.parse(string, converters: :strip) +# array # => [["foo", "0"], ["bar", "1"], ["baz", "2"]] +# +# ==== Header \Converters +# +# Header converters operate only on headers (and not on other rows). +# +# There are three ways to use header \converters; +# these examples use built-in header converter +:downcase+, +# which downcases each parsed header. +# +# - Option +header_converters+ with a singleton parsing method: +# string = "Name,Count\nFoo,0\n,Bar,1\nBaz,2" +# tbl = CSV.parse(string, headers: true, header_converters: :downcase) +# tbl.class # => CSV::Table +# tbl.headers # => ["name", "count"] +# +# - Option +header_converters+ with a new \CSV instance: +# csv = CSV.new(string, header_converters: :downcase) +# # Header converters in effect: +# csv.header_converters # => [:downcase] +# tbl = CSV.parse(string, headers: true) +# tbl.headers # => ["Name", "Count"] +# +# - Method #header_convert adds a header converter to a \CSV instance: +# csv = CSV.new(string) +# # Add a header converter. +# csv.header_convert(:downcase) +# csv.header_converters # => [:downcase] +# tbl = CSV.parse(string, headers: true) +# tbl.headers # => ["Name", "Count"] +# +# ===== Built-In Header \Converters +# +# The built-in header \converters are in \Hash CSV::HeaderConverters. +# The keys there are the names of the \converters: +# CSV::HeaderConverters.keys # => [:downcase, :symbol] +# +# Converter +:downcase+ converts each header by downcasing it: +# string = "Name,Count\nFoo,0\n,Bar,1\nBaz,2" +# tbl = CSV.parse(string, headers: true, header_converters: :downcase) +# tbl.class # => CSV::Table +# tbl.headers # => ["name", "count"] +# +# Converter +:symbol+ converts each header by making it into a \Symbol: +# string = "Name,Count\nFoo,0\n,Bar,1\nBaz,2" +# tbl = CSV.parse(string, headers: true, header_converters: :symbol) +# tbl.headers # => [:name, :count] +# Details: +# - Strips leading and trailing whitespace. +# - Downcases the header. +# - Replaces embedded spaces with underscores. +# - Removes non-word characters. +# - Makes the string into a \Symbol. +# +# ===== Custom Header \Converters +# +# You can define a custom header converter: +# upcase_converter = proc {|header| header.upcase } +# string = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" +# table = CSV.parse(string, headers: true, header_converters: upcase_converter) +# table # => # +# table.headers # => ["NAME", "VALUE"] +# You can register the converter in \HeaderConverters \Hash, +# which allows you to refer to it by name: +# CSV::HeaderConverters[:upcase] = upcase_converter +# table = CSV.parse(string, headers: true, header_converters: :upcase) +# table # => # +# table.headers # => ["NAME", "VALUE"] +# +# ===== Write \Converters +# +# When you specify a write converter for generating \CSV, +# each field to be written is passed to the converter; +# its return value becomes the new value for the field. +# A converter might, for example, strip whitespace from a field. +# +# Using no write converter (all fields unmodified): +# output_string = CSV.generate do |csv| +# csv << [' foo ', 0] +# csv << [' bar ', 1] +# csv << [' baz ', 2] +# end +# output_string # => " foo ,0\n bar ,1\n baz ,2\n" +# Using option +write_converters+ with two custom write converters: +# strip_converter = proc {|field| field.respond_to?(:strip) ? field.strip : field } +# upcase_converter = proc {|field| field.respond_to?(:upcase) ? field.upcase : field } +# write_converters = [strip_converter, upcase_converter] +# output_string = CSV.generate(write_converters: write_converters) do |csv| +# csv << [' foo ', 0] +# csv << [' bar ', 1] +# csv << [' baz ', 2] +# end +# output_string # => "FOO,0\nBAR,1\nBAZ,2\n" +# +# === Character Encodings (M17n or Multilingualization) +# +# This new CSV parser is m17n savvy. The parser works in the Encoding of the IO +# or String object being read from or written to. Your data is never transcoded +# (unless you ask Ruby to transcode it for you) and will literally be parsed in +# the Encoding it is in. Thus CSV will return Arrays or Rows of Strings in the +# Encoding of your data. This is accomplished by transcoding the parser itself +# into your Encoding. +# +# Some transcoding must take place, of course, to accomplish this multiencoding +# support. For example, :col_sep, :row_sep, and +# :quote_char must be transcoded to match your data. Hopefully this +# makes the entire process feel transparent, since CSV's defaults should just +# magically work for your data. However, you can set these values manually in +# the target Encoding to avoid the translation. +# +# It's also important to note that while all of CSV's core parser is now +# Encoding agnostic, some features are not. For example, the built-in +# converters will try to transcode data to UTF-8 before making conversions. +# Again, you can provide custom converters that are aware of your Encodings to +# avoid this translation. It's just too hard for me to support native +# conversions in all of Ruby's Encodings. +# +# Anyway, the practical side of this is simple: make sure IO and String objects +# passed into CSV have the proper Encoding set and everything should just work. +# CSV methods that allow you to open IO objects (CSV::foreach(), CSV::open(), +# CSV::read(), and CSV::readlines()) do allow you to specify the Encoding. +# +# One minor exception comes when generating CSV into a String with an Encoding +# that is not ASCII compatible. There's no existing data for CSV to use to +# prepare itself and thus you will probably need to manually specify the desired +# Encoding for most of those cases. It will try to guess using the fields in a +# row of output though, when using CSV::generate_line() or Array#to_csv(). +# +# I try to point out any other Encoding issues in the documentation of methods +# as they come up. +# +# This has been tested to the best of my ability with all non-"dummy" Encodings +# Ruby ships with. However, it is brave new code and may have some bugs. +# Please feel free to {report}[mailto:james@grayproductions.net] any issues you +# find with it. +# +# source://csv//lib/csv/fields_converter.rb#3 +class CSV + include ::Enumerable + extend ::Forwardable + + # :call-seq: + # CSV.new(string) + # CSV.new(io) + # CSV.new(string, **options) + # CSV.new(io, **options) + # + # Returns the new \CSV object created using +string+ or +io+ + # and the specified +options+. + # + # - Argument +string+ should be a \String object; + # it will be put into a new StringIO object positioned at the beginning. + # :include: ../doc/csv/arguments/io.rdoc + # - Argument +options+: See: + # * {Options for Parsing}[#class-CSV-label-Options+for+Parsing] + # * {Options for Generating}[#class-CSV-label-Options+for+Generating] + # For performance reasons, the options cannot be overridden + # in a \CSV object, so those specified here will endure. + # + # In addition to the \CSV instance methods, several \IO methods are delegated. + # See {Delegated Methods}[#class-CSV-label-Delegated+Methods]. + # + # --- + # + # Create a \CSV object from a \String object: + # csv = CSV.new('foo,0') + # + # Create a \CSV object from a \File object: + # File.write('t.csv', 'foo,0') + # csv = CSV.new(File.open('t.csv')) + # + # --- + # + # Raises an exception if the argument is +nil+: + # # Raises ArgumentError (Cannot parse nil as CSV): + # CSV.new(nil) + # + # @raise [ArgumentError] + # @return [CSV] a new instance of CSV + # + # source://csv//lib/csv.rb#1905 + def initialize(data, col_sep: T.unsafe(nil), row_sep: T.unsafe(nil), quote_char: T.unsafe(nil), field_size_limit: T.unsafe(nil), max_field_size: T.unsafe(nil), converters: T.unsafe(nil), unconverted_fields: T.unsafe(nil), headers: T.unsafe(nil), return_headers: T.unsafe(nil), write_headers: T.unsafe(nil), header_converters: T.unsafe(nil), skip_blanks: T.unsafe(nil), force_quotes: T.unsafe(nil), skip_lines: T.unsafe(nil), liberal_parsing: T.unsafe(nil), internal_encoding: T.unsafe(nil), external_encoding: T.unsafe(nil), encoding: T.unsafe(nil), nil_value: T.unsafe(nil), empty_value: T.unsafe(nil), strip: T.unsafe(nil), quote_empty: T.unsafe(nil), write_converters: T.unsafe(nil), write_nil_value: T.unsafe(nil), write_empty_value: T.unsafe(nil)); end + + # :call-seq: + # csv << row -> self + # + # Appends a row to +self+. + # + # - Argument +row+ must be an \Array object or a CSV::Row object. + # - The output stream must be open for writing. + # + # --- + # + # Append Arrays: + # CSV.generate do |csv| + # csv << ['foo', 0] + # csv << ['bar', 1] + # csv << ['baz', 2] + # end # => "foo,0\nbar,1\nbaz,2\n" + # + # Append CSV::Rows: + # headers = [] + # CSV.generate do |csv| + # csv << CSV::Row.new(headers, ['foo', 0]) + # csv << CSV::Row.new(headers, ['bar', 1]) + # csv << CSV::Row.new(headers, ['baz', 2]) + # end # => "foo,0\nbar,1\nbaz,2\n" + # + # Headers in CSV::Row objects are not appended: + # headers = ['Name', 'Count'] + # CSV.generate do |csv| + # csv << CSV::Row.new(headers, ['foo', 0]) + # csv << CSV::Row.new(headers, ['bar', 1]) + # csv << CSV::Row.new(headers, ['baz', 2]) + # end # => "foo,0\nbar,1\nbaz,2\n" + # + # --- + # + # Raises an exception if +row+ is not an \Array or \CSV::Row: + # CSV.generate do |csv| + # # Raises NoMethodError (undefined method `collect' for :foo:Symbol) + # csv << :foo + # end + # + # Raises an exception if the output stream is not opened for writing: + # path = 't.csv' + # File.write(path, '') + # File.open(path) do |file| + # CSV.open(file) do |csv| + # # Raises IOError (not opened for writing) + # csv << ['foo', 0] + # end + # end + # + # source://csv//lib/csv.rb#2372 + def <<(row); end + + # :call-seq: + # csv << row -> self + # + # Appends a row to +self+. + # + # - Argument +row+ must be an \Array object or a CSV::Row object. + # - The output stream must be open for writing. + # + # --- + # + # Append Arrays: + # CSV.generate do |csv| + # csv << ['foo', 0] + # csv << ['bar', 1] + # csv << ['baz', 2] + # end # => "foo,0\nbar,1\nbaz,2\n" + # + # Append CSV::Rows: + # headers = [] + # CSV.generate do |csv| + # csv << CSV::Row.new(headers, ['foo', 0]) + # csv << CSV::Row.new(headers, ['bar', 1]) + # csv << CSV::Row.new(headers, ['baz', 2]) + # end # => "foo,0\nbar,1\nbaz,2\n" + # + # Headers in CSV::Row objects are not appended: + # headers = ['Name', 'Count'] + # CSV.generate do |csv| + # csv << CSV::Row.new(headers, ['foo', 0]) + # csv << CSV::Row.new(headers, ['bar', 1]) + # csv << CSV::Row.new(headers, ['baz', 2]) + # end # => "foo,0\nbar,1\nbaz,2\n" + # + # --- + # + # Raises an exception if +row+ is not an \Array or \CSV::Row: + # CSV.generate do |csv| + # # Raises NoMethodError (undefined method `collect' for :foo:Symbol) + # csv << :foo + # end + # + # Raises an exception if the output stream is not opened for writing: + # path = 't.csv' + # File.write(path, '') + # File.open(path) do |file| + # CSV.open(file) do |csv| + # # Raises IOError (not opened for writing) + # csv << ['foo', 0] + # end + # end + # + # source://csv//lib/csv.rb#2372 + def add_row(row); end + + # @return [Boolean] + # + # source://csv//lib/csv.rb#2261 + def binmode?; end + + # :call-seq: + # csv.col_sep -> string + # + # Returns the encoded column separator; used for parsing and writing; + # see {Option +col_sep+}[#class-CSV-label-Option+col_sep]: + # CSV.new('').col_sep # => "," + # + # source://csv//lib/csv.rb#2009 + def col_sep; end + + # :call-seq: + # convert(converter_name) -> array_of_procs + # convert {|field, field_info| ... } -> array_of_procs + # + # - With no block, installs a field converter (a \Proc). + # - With a block, defines and installs a custom field converter. + # - Returns the \Array of installed field converters. + # + # - Argument +converter_name+, if given, should be the name + # of an existing field converter. + # + # See {Field Converters}[#class-CSV-label-Field+Converters]. + # --- + # + # With no block, installs a field converter: + # csv = CSV.new('') + # csv.convert(:integer) + # csv.convert(:float) + # csv.convert(:date) + # csv.converters # => [:integer, :float, :date] + # + # --- + # + # The block, if given, is called for each field: + # - Argument +field+ is the field value. + # - Argument +field_info+ is a CSV::FieldInfo object + # containing details about the field. + # + # The examples here assume the prior execution of: + # string = "foo,0\nbar,1\nbaz,2\n" + # path = 't.csv' + # File.write(path, string) + # + # Example giving a block: + # csv = CSV.open(path) + # csv.convert {|field, field_info| p [field, field_info]; field.upcase } + # csv.read # => [["FOO", "0"], ["BAR", "1"], ["BAZ", "2"]] + # + # Output: + # ["foo", #] + # ["0", #] + # ["bar", #] + # ["1", #] + # ["baz", #] + # ["2", #] + # + # The block need not return a \String object: + # csv = CSV.open(path) + # csv.convert {|field, field_info| field.to_sym } + # csv.read # => [[:foo, :"0"], [:bar, :"1"], [:baz, :"2"]] + # + # If +converter_name+ is given, the block is not called: + # csv = CSV.open(path) + # csv.convert(:integer) {|field, field_info| fail 'Cannot happen' } + # csv.read # => [["foo", 0], ["bar", 1], ["baz", 2]] + # + # --- + # + # Raises a parse-time exception if +converter_name+ is not the name of a built-in + # field converter: + # csv = CSV.open(path) + # csv.convert(:nosuch) => [nil] + # # Raises NoMethodError (undefined method `arity' for nil:NilClass) + # csv.read + # + # source://csv//lib/csv.rb#2443 + def convert(name = T.unsafe(nil), &converter); end + + # :call-seq: + # csv.converters -> array + # + # Returns an \Array containing field converters; + # see {Field Converters}[#class-CSV-label-Field+Converters]: + # csv = CSV.new('') + # csv.converters # => [] + # csv.convert(:integer) + # csv.converters # => [:integer] + # csv.convert(proc {|x| x.to_s }) + # csv.converters + # + # Notes that you need to call + # +Ractor.make_shareable(CSV::Converters)+ on the main Ractor to use + # this method. + # + # source://csv//lib/csv.rb#2082 + def converters; end + + # :call-seq: + # csv.each -> enumerator + # csv.each {|row| ...} + # + # Calls the block with each successive row. + # The data source must be opened for reading. + # + # Without headers: + # string = "foo,0\nbar,1\nbaz,2\n" + # csv = CSV.new(string) + # csv.each do |row| + # p row + # end + # Output: + # ["foo", "0"] + # ["bar", "1"] + # ["baz", "2"] + # + # With headers: + # string = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # csv = CSV.new(string, headers: true) + # csv.each do |row| + # p row + # end + # Output: + # + # + # + # + # --- + # + # Raises an exception if the source is not opened for reading: + # string = "foo,0\nbar,1\nbaz,2\n" + # csv = CSV.new(string) + # csv.close + # # Raises IOError (not opened for reading) + # csv.each do |row| + # p row + # end + # + # source://csv//lib/csv.rb#2554 + def each(&block); end + + # :call-seq: + # csv.encoding -> encoding + # + # Returns the encoding used for parsing and generating; + # see {Character Encodings (M17n or Multilingualization)}[#class-CSV-label-Character+Encodings+-28M17n+or+Multilingualization-29]: + # CSV.new('').encoding # => # + # + # source://csv//lib/csv.rb#2192 + def encoding; end + + # @return [Boolean] + # + # source://csv//lib/csv.rb#2297 + def eof; end + + # @return [Boolean] + # + # source://csv//lib/csv.rb#2297 + def eof?; end + + # :call-seq: + # csv.field_size_limit -> integer or nil + # + # Returns the limit for field size; used for parsing; + # see {Option +field_size_limit+}[#class-CSV-label-Option+field_size_limit]: + # CSV.new('').field_size_limit # => nil + # + # Deprecated since 3.2.3. Use +max_field_size+ instead. + # + # source://csv//lib/csv.rb#2041 + def field_size_limit; end + + # @raise [NotImplementedError] + # + # source://csv//lib/csv.rb#2269 + def flock(*args); end + + # :call-seq: + # csv.force_quotes? -> true or false + # + # Returns the value that determines whether all output fields are to be quoted; + # used for generating; + # see {Option +force_quotes+}[#class-CSV-label-Option+force_quotes]: + # CSV.new('').force_quotes? # => false + # + # @return [Boolean] + # + # source://csv//lib/csv.rb#2172 + def force_quotes?; end + + # :call-seq: + # csv.shift -> array, csv_row, or nil + # + # Returns the next row of data as: + # - An \Array if no headers are used. + # - A CSV::Row object if headers are used. + # + # The data source must be opened for reading. + # + # Without headers: + # string = "foo,0\nbar,1\nbaz,2\n" + # csv = CSV.new(string) + # csv.shift # => ["foo", "0"] + # csv.shift # => ["bar", "1"] + # csv.shift # => ["baz", "2"] + # csv.shift # => nil + # + # With headers: + # string = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # csv = CSV.new(string, headers: true) + # csv.shift # => # + # csv.shift # => # + # csv.shift # => # + # csv.shift # => nil + # + # --- + # + # Raises an exception if the source is not opened for reading: + # string = "foo,0\nbar,1\nbaz,2\n" + # csv = CSV.new(string) + # csv.close + # # Raises IOError (not opened for reading) + # csv.shift + # + # source://csv//lib/csv.rb#2668 + def gets; end + + # The block need not return a \String object: + # csv = CSV.open(path, headers: true) + # csv.header_convert {|header, field_info| header.to_sym } + # table = csv.read + # table.headers # => [:Name, :Value] + # + # If +converter_name+ is given, the block is not called: + # csv = CSV.open(path, headers: true) + # csv.header_convert(:downcase) {|header, field_info| fail 'Cannot happen' } + # table = csv.read + # table.headers # => ["name", "value"] + # --- + # + # Raises a parse-time exception if +converter_name+ is not the name of a built-in + # field converter: + # csv = CSV.open(path, headers: true) + # csv.header_convert(:nosuch) + # # Raises NoMethodError (undefined method `arity' for nil:NilClass) + # csv.read + # + # source://csv//lib/csv.rb#2509 + def header_convert(name = T.unsafe(nil), &converter); end + + # :call-seq: + # csv.header_converters -> array + # + # Returns an \Array containing header converters; used for parsing; + # see {Header Converters}[#class-CSV-label-Header+Converters]: + # CSV.new('').header_converters # => [] + # + # Notes that you need to call + # +Ractor.make_shareable(CSV::HeaderConverters)+ on the main Ractor + # to use this method. + # + # source://csv//lib/csv.rb#2148 + def header_converters; end + + # :call-seq: + # csv.header_row? -> true or false + # + # Returns +true+ if the next row to be read is a header row\; + # +false+ otherwise. + # + # Without headers: + # string = "foo,0\nbar,1\nbaz,2\n" + # csv = CSV.new(string) + # csv.header_row? # => false + # + # With headers: + # string = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # csv = CSV.new(string, headers: true) + # csv.header_row? # => true + # csv.shift # => # + # csv.header_row? # => false + # + # --- + # + # Raises an exception if the source is not opened for reading: + # string = "foo,0\nbar,1\nbaz,2\n" + # csv = CSV.new(string) + # csv.close + # # Raises IOError (not opened for reading) + # csv.header_row? + # + # @return [Boolean] + # + # source://csv//lib/csv.rb#2631 + def header_row?; end + + # :call-seq: + # csv.headers -> object + # + # Returns the value that determines whether headers are used; used for parsing; + # see {Option +headers+}[#class-CSV-label-Option+headers]: + # CSV.new('').headers # => nil + # + # source://csv//lib/csv.rb#2106 + def headers; end + + # :call-seq: + # csv.inspect -> string + # + # Returns a \String showing certain properties of +self+: + # string = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # csv = CSV.new(string, headers: true) + # s = csv.inspect + # + # source://csv//lib/csv.rb#2690 + def inspect; end + + # @raise [NotImplementedError] + # + # source://csv//lib/csv.rb#2274 + def ioctl(*args); end + + # :call-seq: + # csv.liberal_parsing? -> true or false + # + # Returns the value that determines whether illegal input is to be handled; used for parsing; + # see {Option +liberal_parsing+}[#class-CSV-label-Option+liberal_parsing]: + # CSV.new('').liberal_parsing? # => false + # + # @return [Boolean] + # + # source://csv//lib/csv.rb#2182 + def liberal_parsing?; end + + # :call-seq: + # csv.line -> array + # + # Returns the line most recently read: + # string = "foo,0\nbar,1\nbaz,2\n" + # path = 't.csv' + # File.write(path, string) + # CSV.open(path) do |csv| + # csv.each do |row| + # p [csv.lineno, csv.line] + # end + # end + # Output: + # [1, "foo,0\n"] + # [2, "bar,1\n"] + # [3, "baz,2\n"] + # + # source://csv//lib/csv.rb#2247 + def line; end + + # :call-seq: + # csv.line_no -> integer + # + # Returns the count of the rows parsed or generated. + # + # Parsing: + # string = "foo,0\nbar,1\nbaz,2\n" + # path = 't.csv' + # File.write(path, string) + # CSV.open(path) do |csv| + # csv.each do |row| + # p [csv.lineno, row] + # end + # end + # Output: + # [1, ["foo", "0"]] + # [2, ["bar", "1"]] + # [3, ["baz", "2"]] + # + # Generating: + # CSV.generate do |csv| + # p csv.lineno; csv << ['foo', 0] + # p csv.lineno; csv << ['bar', 1] + # p csv.lineno; csv << ['baz', 2] + # end + # Output: + # 0 + # 1 + # 2 + # + # source://csv//lib/csv.rb#2223 + def lineno; end + + # :call-seq: + # csv.max_field_size -> integer or nil + # + # Returns the limit for field size; used for parsing; + # see {Option +max_field_size+}[#class-CSV-label-Option+max_field_size]: + # CSV.new('').max_field_size # => nil + # + # Since 3.2.3. + # + # source://csv//lib/csv.rb#2053 + def max_field_size; end + + # source://csv//lib/csv.rb#2279 + def path; end + + # :call-seq: + # csv << row -> self + # + # Appends a row to +self+. + # + # - Argument +row+ must be an \Array object or a CSV::Row object. + # - The output stream must be open for writing. + # + # --- + # + # Append Arrays: + # CSV.generate do |csv| + # csv << ['foo', 0] + # csv << ['bar', 1] + # csv << ['baz', 2] + # end # => "foo,0\nbar,1\nbaz,2\n" + # + # Append CSV::Rows: + # headers = [] + # CSV.generate do |csv| + # csv << CSV::Row.new(headers, ['foo', 0]) + # csv << CSV::Row.new(headers, ['bar', 1]) + # csv << CSV::Row.new(headers, ['baz', 2]) + # end # => "foo,0\nbar,1\nbaz,2\n" + # + # Headers in CSV::Row objects are not appended: + # headers = ['Name', 'Count'] + # CSV.generate do |csv| + # csv << CSV::Row.new(headers, ['foo', 0]) + # csv << CSV::Row.new(headers, ['bar', 1]) + # csv << CSV::Row.new(headers, ['baz', 2]) + # end # => "foo,0\nbar,1\nbaz,2\n" + # + # --- + # + # Raises an exception if +row+ is not an \Array or \CSV::Row: + # CSV.generate do |csv| + # # Raises NoMethodError (undefined method `collect' for :foo:Symbol) + # csv << :foo + # end + # + # Raises an exception if the output stream is not opened for writing: + # path = 't.csv' + # File.write(path, '') + # File.open(path) do |file| + # CSV.open(file) do |csv| + # # Raises IOError (not opened for writing) + # csv << ['foo', 0] + # end + # end + # + # source://csv//lib/csv.rb#2372 + def puts(row); end + + # :call-seq: + # csv.quote_char -> character + # + # Returns the encoded quote character; used for parsing and writing; + # see {Option +quote_char+}[#class-CSV-label-Option+quote_char]: + # CSV.new('').quote_char # => "\"" + # + # source://csv//lib/csv.rb#2029 + def quote_char; end + + # :call-seq: + # csv.read -> array or csv_table + # + # Forms the remaining rows from +self+ into: + # - A CSV::Table object, if headers are in use. + # - An \Array of Arrays, otherwise. + # + # The data source must be opened for reading. + # + # Without headers: + # string = "foo,0\nbar,1\nbaz,2\n" + # path = 't.csv' + # File.write(path, string) + # csv = CSV.open(path) + # csv.read # => [["foo", "0"], ["bar", "1"], ["baz", "2"]] + # + # With headers: + # string = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # path = 't.csv' + # File.write(path, string) + # csv = CSV.open(path, headers: true) + # csv.read # => # + # + # --- + # + # Raises an exception if the source is not opened for reading: + # string = "foo,0\nbar,1\nbaz,2\n" + # csv = CSV.new(string) + # csv.close + # # Raises IOError (not opened for reading) + # csv.read + # + # source://csv//lib/csv.rb#2595 + def read; end + + # :call-seq: + # csv.shift -> array, csv_row, or nil + # + # Returns the next row of data as: + # - An \Array if no headers are used. + # - A CSV::Row object if headers are used. + # + # The data source must be opened for reading. + # + # Without headers: + # string = "foo,0\nbar,1\nbaz,2\n" + # csv = CSV.new(string) + # csv.shift # => ["foo", "0"] + # csv.shift # => ["bar", "1"] + # csv.shift # => ["baz", "2"] + # csv.shift # => nil + # + # With headers: + # string = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # csv = CSV.new(string, headers: true) + # csv.shift # => # + # csv.shift # => # + # csv.shift # => # + # csv.shift # => nil + # + # --- + # + # Raises an exception if the source is not opened for reading: + # string = "foo,0\nbar,1\nbaz,2\n" + # csv = CSV.new(string) + # csv.close + # # Raises IOError (not opened for reading) + # csv.shift + # + # source://csv//lib/csv.rb#2668 + def readline; end + + # :call-seq: + # csv.read -> array or csv_table + # + # Forms the remaining rows from +self+ into: + # - A CSV::Table object, if headers are in use. + # - An \Array of Arrays, otherwise. + # + # The data source must be opened for reading. + # + # Without headers: + # string = "foo,0\nbar,1\nbaz,2\n" + # path = 't.csv' + # File.write(path, string) + # csv = CSV.open(path) + # csv.read # => [["foo", "0"], ["bar", "1"], ["baz", "2"]] + # + # With headers: + # string = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # path = 't.csv' + # File.write(path, string) + # csv = CSV.open(path, headers: true) + # csv.read # => # + # + # --- + # + # Raises an exception if the source is not opened for reading: + # string = "foo,0\nbar,1\nbaz,2\n" + # csv = CSV.new(string) + # csv.close + # # Raises IOError (not opened for reading) + # csv.read + # + # source://csv//lib/csv.rb#2595 + def readlines; end + + # :call-seq: + # csv.return_headers? -> true or false + # + # Returns the value that determines whether headers are to be returned; used for parsing; + # see {Option +return_headers+}[#class-CSV-label-Option+return_headers]: + # CSV.new('').return_headers? # => false + # + # @return [Boolean] + # + # source://csv//lib/csv.rb#2124 + def return_headers?; end + + # Rewinds the underlying IO object and resets CSV's lineno() counter. + # + # source://csv//lib/csv.rb#2312 + def rewind; end + + # :call-seq: + # csv.row_sep -> string + # + # Returns the encoded row separator; used for parsing and writing; + # see {Option +row_sep+}[#class-CSV-label-Option+row_sep]: + # CSV.new('').row_sep # => "\n" + # + # source://csv//lib/csv.rb#2019 + def row_sep; end + + # :call-seq: + # csv.shift -> array, csv_row, or nil + # + # Returns the next row of data as: + # - An \Array if no headers are used. + # - A CSV::Row object if headers are used. + # + # The data source must be opened for reading. + # + # Without headers: + # string = "foo,0\nbar,1\nbaz,2\n" + # csv = CSV.new(string) + # csv.shift # => ["foo", "0"] + # csv.shift # => ["bar", "1"] + # csv.shift # => ["baz", "2"] + # csv.shift # => nil + # + # With headers: + # string = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # csv = CSV.new(string, headers: true) + # csv.shift # => # + # csv.shift # => # + # csv.shift # => # + # csv.shift # => nil + # + # --- + # + # Raises an exception if the source is not opened for reading: + # string = "foo,0\nbar,1\nbaz,2\n" + # csv = CSV.new(string) + # csv.close + # # Raises IOError (not opened for reading) + # csv.shift + # + # source://csv//lib/csv.rb#2668 + def shift; end + + # :call-seq: + # csv.skip_blanks? -> true or false + # + # Returns the value that determines whether blank lines are to be ignored; used for parsing; + # see {Option +skip_blanks+}[#class-CSV-label-Option+skip_blanks]: + # CSV.new('').skip_blanks? # => false + # + # @return [Boolean] + # + # source://csv//lib/csv.rb#2161 + def skip_blanks?; end + + # :call-seq: + # csv.skip_lines -> regexp or nil + # + # Returns the \Regexp used to identify comment lines; used for parsing; + # see {Option +skip_lines+}[#class-CSV-label-Option+skip_lines]: + # CSV.new('').skip_lines # => nil + # + # source://csv//lib/csv.rb#2063 + def skip_lines; end + + # @raise [NotImplementedError] + # + # source://csv//lib/csv.rb#2283 + def stat(*args); end + + # @raise [NotImplementedError] + # + # source://csv//lib/csv.rb#2288 + def to_i; end + + # source://csv//lib/csv.rb#2293 + def to_io; end + + # :call-seq: + # csv.unconverted_fields? -> object + # + # Returns the value that determines whether unconverted fields are to be + # available; used for parsing; + # see {Option +unconverted_fields+}[#class-CSV-label-Option+unconverted_fields]: + # CSV.new('').unconverted_fields? # => nil + # + # @return [Boolean] + # + # source://csv//lib/csv.rb#2096 + def unconverted_fields?; end + + # :call-seq: + # csv.write_headers? -> true or false + # + # Returns the value that determines whether headers are to be written; used for generating; + # see {Option +write_headers+}[#class-CSV-label-Option+write_headers]: + # CSV.new('').write_headers? # => nil + # + # @return [Boolean] + # + # source://csv//lib/csv.rb#2134 + def write_headers?; end + + private + + # source://csv//lib/csv.rb#2822 + def build_fields_converter(initial_converters, options); end + + # source://csv//lib/csv.rb#2804 + def build_header_fields_converter; end + + # source://csv//lib/csv.rb#2792 + def build_parser_fields_converter; end + + # source://csv//lib/csv.rb#2817 + def build_writer_fields_converter; end + + # Processes +fields+ with @converters, or @header_converters + # if +headers+ is passed as +true+, returning the converted field set. Any + # converter that changes the field into something other than a String halts + # the pipeline of conversion for that field. This is primarily an efficiency + # shortcut. + # + # source://csv//lib/csv.rb#2767 + def convert_fields(fields, headers = T.unsafe(nil)); end + + # source://csv//lib/csv.rb#2730 + def determine_encoding(encoding, internal_encoding); end + + # source://csv//lib/csv.rb#2800 + def header_fields_converter; end + + # source://csv//lib/csv.rb#2745 + def normalize_converters(converters); end + + # source://csv//lib/csv.rb#2830 + def parser; end + + # source://csv//lib/csv.rb#2839 + def parser_enumerator; end + + # source://csv//lib/csv.rb#2788 + def parser_fields_converter; end + + # source://csv//lib/csv.rb#2834 + def parser_options; end + + # Returns the encoding of the internal IO object. + # + # source://csv//lib/csv.rb#2778 + def raw_encoding; end + + # source://csv//lib/csv.rb#2843 + def writer; end + + # source://csv//lib/csv.rb#2813 + def writer_fields_converter; end + + # source://csv//lib/csv.rb#2847 + def writer_options; end + + class << self + # :call-seq: + # filter(in_string_or_io, **options) {|row| ... } -> array_of_arrays or csv_table + # filter(in_string_or_io, out_string_or_io, **options) {|row| ... } -> array_of_arrays or csv_table + # filter(**options) {|row| ... } -> array_of_arrays or csv_table + # + # - Parses \CSV from a source (\String, \IO stream, or ARGF). + # - Calls the given block with each parsed row: + # - Without headers, each row is an \Array. + # - With headers, each row is a CSV::Row. + # - Generates \CSV to an output (\String, \IO stream, or STDOUT). + # - Returns the parsed source: + # - Without headers, an \Array of \Arrays. + # - With headers, a CSV::Table. + # + # When +in_string_or_io+ is given, but not +out_string_or_io+, + # parses from the given +in_string_or_io+ + # and generates to STDOUT. + # + # \String input without headers: + # + # in_string = "foo,0\nbar,1\nbaz,2" + # CSV.filter(in_string) do |row| + # row[0].upcase! + # row[1] = - row[1].to_i + # end # => [["FOO", 0], ["BAR", -1], ["BAZ", -2]] + # + # Output (to STDOUT): + # + # FOO,0 + # BAR,-1 + # BAZ,-2 + # + # \String input with headers: + # + # in_string = "Name,Value\nfoo,0\nbar,1\nbaz,2" + # CSV.filter(in_string, headers: true) do |row| + # row[0].upcase! + # row[1] = - row[1].to_i + # end # => # + # + # Output (to STDOUT): + # + # Name,Value + # FOO,0 + # BAR,-1 + # BAZ,-2 + # + # \IO stream input without headers: + # + # File.write('t.csv', "foo,0\nbar,1\nbaz,2") + # File.open('t.csv') do |in_io| + # CSV.filter(in_io) do |row| + # row[0].upcase! + # row[1] = - row[1].to_i + # end + # end # => [["FOO", 0], ["BAR", -1], ["BAZ", -2]] + # + # Output (to STDOUT): + # + # FOO,0 + # BAR,-1 + # BAZ,-2 + # + # \IO stream input with headers: + # + # File.write('t.csv', "Name,Value\nfoo,0\nbar,1\nbaz,2") + # File.open('t.csv') do |in_io| + # CSV.filter(in_io, headers: true) do |row| + # row[0].upcase! + # row[1] = - row[1].to_i + # end + # end # => # + # + # Output (to STDOUT): + # + # Name,Value + # FOO,0 + # BAR,-1 + # BAZ,-2 + # + # When both +in_string_or_io+ and +out_string_or_io+ are given, + # parses from +in_string_or_io+ and generates to +out_string_or_io+. + # + # \String output without headers: + # + # in_string = "foo,0\nbar,1\nbaz,2" + # out_string = '' + # CSV.filter(in_string, out_string) do |row| + # row[0].upcase! + # row[1] = - row[1].to_i + # end # => [["FOO", 0], ["BAR", -1], ["BAZ", -2]] + # out_string # => "FOO,0\nBAR,-1\nBAZ,-2\n" + # + # \String output with headers: + # + # in_string = "Name,Value\nfoo,0\nbar,1\nbaz,2" + # out_string = '' + # CSV.filter(in_string, out_string, headers: true) do |row| + # row[0].upcase! + # row[1] = - row[1].to_i + # end # => # + # out_string # => "Name,Value\nFOO,0\nBAR,-1\nBAZ,-2\n" + # + # \IO stream output without headers: + # + # in_string = "foo,0\nbar,1\nbaz,2" + # File.open('t.csv', 'w') do |out_io| + # CSV.filter(in_string, out_io) do |row| + # row[0].upcase! + # row[1] = - row[1].to_i + # end + # end # => [["FOO", 0], ["BAR", -1], ["BAZ", -2]] + # File.read('t.csv') # => "FOO,0\nBAR,-1\nBAZ,-2\n" + # + # \IO stream output with headers: + # + # in_string = "Name,Value\nfoo,0\nbar,1\nbaz,2" + # File.open('t.csv', 'w') do |out_io| + # CSV.filter(in_string, out_io, headers: true) do |row| + # row[0].upcase! + # row[1] = - row[1].to_i + # end + # end # => # + # File.read('t.csv') # => "Name,Value\nFOO,0\nBAR,-1\nBAZ,-2\n" + # + # When neither +in_string_or_io+ nor +out_string_or_io+ given, + # parses from {ARGF}[rdoc-ref:ARGF] + # and generates to STDOUT. + # + # Without headers: + # + # # Put Ruby code into a file. + # ruby = <<-EOT + # require 'csv' + # CSV.filter do |row| + # row[0].upcase! + # row[1] = - row[1].to_i + # end + # EOT + # File.write('t.rb', ruby) + # # Put some CSV into a file. + # File.write('t.csv', "foo,0\nbar,1\nbaz,2") + # # Run the Ruby code with CSV filename as argument. + # system(Gem.ruby, "t.rb", "t.csv") + # + # Output (to STDOUT): + # + # FOO,0 + # BAR,-1 + # BAZ,-2 + # + # With headers: + # + # # Put Ruby code into a file. + # ruby = <<-EOT + # require 'csv' + # CSV.filter(headers: true) do |row| + # row[0].upcase! + # row[1] = - row[1].to_i + # end + # EOT + # File.write('t.rb', ruby) + # # Put some CSV into a file. + # File.write('t.csv', "Name,Value\nfoo,0\nbar,1\nbaz,2") + # # Run the Ruby code with CSV filename as argument. + # system(Gem.ruby, "t.rb", "t.csv") + # + # Output (to STDOUT): + # + # Name,Value + # FOO,0 + # BAR,-1 + # BAZ,-2 + # + # Arguments: + # + # * Argument +in_string_or_io+ must be a \String or an \IO stream. + # * Argument +out_string_or_io+ must be a \String or an \IO stream. + # * Arguments **options must be keyword options. + # See {Options for Parsing}[#class-CSV-label-Options+for+Parsing]. + # + # source://csv//lib/csv.rb#1202 + def filter(input = T.unsafe(nil), output = T.unsafe(nil), **options); end + + # :call-seq: + # foreach(path_or_io, mode='r', **options) {|row| ... ) + # foreach(path_or_io, mode='r', **options) -> new_enumerator + # + # Calls the block with each row read from source +path_or_io+. + # + # \Path input without headers: + # + # string = "foo,0\nbar,1\nbaz,2\n" + # in_path = 't.csv' + # File.write(in_path, string) + # CSV.foreach(in_path) {|row| p row } + # + # Output: + # + # ["foo", "0"] + # ["bar", "1"] + # ["baz", "2"] + # + # \Path input with headers: + # + # string = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # in_path = 't.csv' + # File.write(in_path, string) + # CSV.foreach(in_path, headers: true) {|row| p row } + # + # Output: + # + # + # + # + # + # \IO stream input without headers: + # + # string = "foo,0\nbar,1\nbaz,2\n" + # path = 't.csv' + # File.write(path, string) + # File.open('t.csv') do |in_io| + # CSV.foreach(in_io) {|row| p row } + # end + # + # Output: + # + # ["foo", "0"] + # ["bar", "1"] + # ["baz", "2"] + # + # \IO stream input with headers: + # + # string = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # path = 't.csv' + # File.write(path, string) + # File.open('t.csv') do |in_io| + # CSV.foreach(in_io, headers: true) {|row| p row } + # end + # + # Output: + # + # + # + # + # + # With no block given, returns an \Enumerator: + # + # string = "foo,0\nbar,1\nbaz,2\n" + # path = 't.csv' + # File.write(path, string) + # CSV.foreach(path) # => # + # + # Arguments: + # * Argument +path_or_io+ must be a file path or an \IO stream. + # * Argument +mode+, if given, must be a \File mode. + # See {Access Modes}[https://docs.ruby-lang.org/en/master/File.html#class-File-label-Access+Modes]. + # * Arguments **options must be keyword options. + # See {Options for Parsing}[#class-CSV-label-Options+for+Parsing]. + # * This method optionally accepts an additional :encoding option + # that you can use to specify the Encoding of the data read from +path+ or +io+. + # You must provide this unless your data is in the encoding + # given by Encoding::default_external. + # Parsing will use this to determine how to parse the data. + # You may provide a second Encoding to + # have the data transcoded as it is read. For example, + # would read +UTF-32BE+ data from the file + # but transcode it to +UTF-8+ before parsing. + # + # source://csv//lib/csv.rb#1332 + def foreach(path, mode = T.unsafe(nil), **options, &block); end + + # :call-seq: + # generate(csv_string, **options) {|csv| ... } + # generate(**options) {|csv| ... } + # + # * Argument +csv_string+, if given, must be a \String object; + # defaults to a new empty \String. + # * Arguments +options+, if given, should be generating options. + # See {Options for Generating}[#class-CSV-label-Options+for+Generating]. + # + # --- + # + # Creates a new \CSV object via CSV.new(csv_string, **options); + # calls the block with the \CSV object, which the block may modify; + # returns the \String generated from the \CSV object. + # + # Note that a passed \String *is* modified by this method. + # Pass csv_string.dup if the \String must be preserved. + # + # This method has one additional option: :encoding, + # which sets the base Encoding for the output if no no +str+ is specified. + # CSV needs this hint if you plan to output non-ASCII compatible data. + # + # --- + # + # Add lines: + # input_string = "foo,0\nbar,1\nbaz,2\n" + # output_string = CSV.generate(input_string) do |csv| + # csv << ['bat', 3] + # csv << ['bam', 4] + # end + # output_string # => "foo,0\nbar,1\nbaz,2\nbat,3\nbam,4\n" + # input_string # => "foo,0\nbar,1\nbaz,2\nbat,3\nbam,4\n" + # output_string.equal?(input_string) # => true # Same string, modified + # + # Add lines into new string, preserving old string: + # input_string = "foo,0\nbar,1\nbaz,2\n" + # output_string = CSV.generate(input_string.dup) do |csv| + # csv << ['bat', 3] + # csv << ['bam', 4] + # end + # output_string # => "foo,0\nbar,1\nbaz,2\nbat,3\nbam,4\n" + # input_string # => "foo,0\nbar,1\nbaz,2\n" + # output_string.equal?(input_string) # => false # Different strings + # + # Create lines from nothing: + # output_string = CSV.generate do |csv| + # csv << ['foo', 0] + # csv << ['bar', 1] + # csv << ['baz', 2] + # end + # output_string # => "foo,0\nbar,1\nbaz,2\n" + # + # --- + # + # Raises an exception if +csv_string+ is not a \String object: + # # Raises TypeError (no implicit conversion of Integer into String) + # CSV.generate(0) + # + # @yield [csv] + # + # source://csv//lib/csv.rb#1398 + def generate(str = T.unsafe(nil), **options); end + + # :call-seq: + # CSV.generate_line(ary) + # CSV.generate_line(ary, **options) + # + # Returns the \String created by generating \CSV from +ary+ + # using the specified +options+. + # + # Argument +ary+ must be an \Array. + # + # Special options: + # * Option :row_sep defaults to "\n"> on Ruby 3.0 or later + # and $INPUT_RECORD_SEPARATOR ($/) otherwise.: + # $INPUT_RECORD_SEPARATOR # => "\n" + # * This method accepts an additional option, :encoding, which sets the base + # Encoding for the output. This method will try to guess your Encoding from + # the first non-+nil+ field in +row+, if possible, but you may need to use + # this parameter as a backup plan. + # + # For other +options+, + # see {Options for Generating}[#class-CSV-label-Options+for+Generating]. + # + # --- + # + # Returns the \String generated from an \Array: + # CSV.generate_line(['foo', '0']) # => "foo,0\n" + # + # --- + # + # Raises an exception if +ary+ is not an \Array: + # # Raises NoMethodError (undefined method `find' for :foo:Symbol) + # CSV.generate_line(:foo) + # + # source://csv//lib/csv.rb#1446 + def generate_line(row, **options); end + + # :call-seq: + # CSV.generate_lines(rows) + # CSV.generate_lines(rows, **options) + # + # Returns the \String created by generating \CSV from + # using the specified +options+. + # + # Argument +rows+ must be an \Array of row. Row is \Array of \String or \CSV::Row. + # + # Special options: + # * Option :row_sep defaults to "\n" on Ruby 3.0 or later + # and $INPUT_RECORD_SEPARATOR ($/) otherwise.: + # $INPUT_RECORD_SEPARATOR # => "\n" + # * This method accepts an additional option, :encoding, which sets the base + # Encoding for the output. This method will try to guess your Encoding from + # the first non-+nil+ field in +row+, if possible, but you may need to use + # this parameter as a backup plan. + # + # For other +options+, + # see {Options for Generating}[#class-CSV-label-Options+for+Generating]. + # + # --- + # + # Returns the \String generated from an + # CSV.generate_lines([['foo', '0'], ['bar', '1'], ['baz', '2']]) # => "foo,0\nbar,1\nbaz,2\n" + # + # --- + # + # Raises an exception + # # Raises NoMethodError (undefined method `each' for :foo:Symbol) + # CSV.generate_lines(:foo) + # + # source://csv//lib/csv.rb#1501 + def generate_lines(rows, **options); end + + # :call-seq: + # instance(string, **options) + # instance(io = $stdout, **options) + # instance(string, **options) {|csv| ... } + # instance(io = $stdout, **options) {|csv| ... } + # + # Creates or retrieves cached \CSV objects. + # For arguments and options, see CSV.new. + # + # This API is not Ractor-safe. + # + # --- + # + # With no block given, returns a \CSV object. + # + # The first call to +instance+ creates and caches a \CSV object: + # s0 = 's0' + # csv0 = CSV.instance(s0) + # csv0.class # => CSV + # + # Subsequent calls to +instance+ with that _same_ +string+ or +io+ + # retrieve that same cached object: + # csv1 = CSV.instance(s0) + # csv1.class # => CSV + # csv1.equal?(csv0) # => true # Same CSV object + # + # A subsequent call to +instance+ with a _different_ +string+ or +io+ + # creates and caches a _different_ \CSV object. + # s1 = 's1' + # csv2 = CSV.instance(s1) + # csv2.equal?(csv0) # => false # Different CSV object + # + # All the cached objects remains available: + # csv3 = CSV.instance(s0) + # csv3.equal?(csv0) # true # Same CSV object + # csv4 = CSV.instance(s1) + # csv4.equal?(csv2) # true # Same CSV object + # + # --- + # + # When a block is given, calls the block with the created or retrieved + # \CSV object; returns the block's return value: + # CSV.instance(s0) {|csv| :foo } # => :foo + # + # source://csv//lib/csv.rb#1006 + def instance(data = T.unsafe(nil), **options); end + + # :call-seq: + # open(file_path, mode = "rb", **options ) -> new_csv + # open(io, mode = "rb", **options ) -> new_csv + # open(file_path, mode = "rb", **options ) { |csv| ... } -> object + # open(io, mode = "rb", **options ) { |csv| ... } -> object + # + # possible options elements: + # keyword form: + # :invalid => nil # raise error on invalid byte sequence (default) + # :invalid => :replace # replace invalid byte sequence + # :undef => :replace # replace undefined conversion + # :replace => string # replacement string ("?" or "\uFFFD" if not specified) + # + # * Argument +path+, if given, must be the path to a file. + # :include: ../doc/csv/arguments/io.rdoc + # * Argument +mode+, if given, must be a \File mode. + # See {Access Modes}[https://docs.ruby-lang.org/en/master/File.html#class-File-label-Access+Modes]. + # * Arguments **options must be keyword options. + # See {Options for Generating}[#class-CSV-label-Options+for+Generating]. + # * This method optionally accepts an additional :encoding option + # that you can use to specify the Encoding of the data read from +path+ or +io+. + # You must provide this unless your data is in the encoding + # given by Encoding::default_external. + # Parsing will use this to determine how to parse the data. + # You may provide a second Encoding to + # have the data transcoded as it is read. For example, + # would read +UTF-32BE+ data from the file + # but transcode it to +UTF-8+ before parsing. + # + # --- + # + # These examples assume prior execution of: + # string = "foo,0\nbar,1\nbaz,2\n" + # path = 't.csv' + # File.write(path, string) + # + # --- + # + # With no block given, returns a new \CSV object. + # + # Create a \CSV object using a file path: + # csv = CSV.open(path) + # + # Create a \CSV object using an open \File: + # csv = CSV.open(File.open(path)) + # + # --- + # + # With a block given, calls the block with the created \CSV object; + # returns the block's return value: + # + # Using a file path: + # csv = CSV.open(path) {|csv| p csv} + # Output: + # + # Using an open \File: + # csv = CSV.open(File.open(path)) {|csv| p csv} + # Output: + # + # --- + # + # Raises an exception if the argument is not a \String object or \IO object: + # # Raises TypeError (no implicit conversion of Symbol into String) + # CSV.open(:foo) + # + # source://csv//lib/csv.rb#1581 + def open(filename, mode = T.unsafe(nil), **options); end + + # :call-seq: + # parse(string) -> array_of_arrays + # parse(io) -> array_of_arrays + # parse(string, headers: ..., **options) -> csv_table + # parse(io, headers: ..., **options) -> csv_table + # parse(string, **options) {|row| ... } + # parse(io, **options) {|row| ... } + # + # Parses +string+ or +io+ using the specified +options+. + # + # - Argument +string+ should be a \String object; + # it will be put into a new StringIO object positioned at the beginning. + # :include: ../doc/csv/arguments/io.rdoc + # - Argument +options+: see {Options for Parsing}[#class-CSV-label-Options+for+Parsing] + # + # ====== Without Option +headers+ + # + # Without {option +headers+}[#class-CSV-label-Option+headers] case. + # + # These examples assume prior execution of: + # string = "foo,0\nbar,1\nbaz,2\n" + # path = 't.csv' + # File.write(path, string) + # + # --- + # + # With no block given, returns an \Array of Arrays formed from the source. + # + # Parse a \String: + # a_of_a = CSV.parse(string) + # a_of_a # => [["foo", "0"], ["bar", "1"], ["baz", "2"]] + # + # Parse an open \File: + # a_of_a = File.open(path) do |file| + # CSV.parse(file) + # end + # a_of_a # => [["foo", "0"], ["bar", "1"], ["baz", "2"]] + # + # --- + # + # With a block given, calls the block with each parsed row: + # + # Parse a \String: + # CSV.parse(string) {|row| p row } + # + # Output: + # ["foo", "0"] + # ["bar", "1"] + # ["baz", "2"] + # + # Parse an open \File: + # File.open(path) do |file| + # CSV.parse(file) {|row| p row } + # end + # + # Output: + # ["foo", "0"] + # ["bar", "1"] + # ["baz", "2"] + # + # ====== With Option +headers+ + # + # With {option +headers+}[#class-CSV-label-Option+headers] case. + # + # These examples assume prior execution of: + # string = "Name,Count\nfoo,0\nbar,1\nbaz,2\n" + # path = 't.csv' + # File.write(path, string) + # + # --- + # + # With no block given, returns a CSV::Table object formed from the source. + # + # Parse a \String: + # csv_table = CSV.parse(string, headers: ['Name', 'Count']) + # csv_table # => # + # + # Parse an open \File: + # csv_table = File.open(path) do |file| + # CSV.parse(file, headers: ['Name', 'Count']) + # end + # csv_table # => # + # + # --- + # + # With a block given, calls the block with each parsed row, + # which has been formed into a CSV::Row object: + # + # Parse a \String: + # CSV.parse(string, headers: ['Name', 'Count']) {|row| p row } + # + # Output: + # # + # # + # # + # + # Parse an open \File: + # File.open(path) do |file| + # CSV.parse(file, headers: ['Name', 'Count']) {|row| p row } + # end + # + # Output: + # # + # # + # # + # + # --- + # + # Raises an exception if the argument is not a \String object or \IO object: + # # Raises NoMethodError (undefined method `close' for :foo:Symbol) + # CSV.parse(:foo) + # + # source://csv//lib/csv.rb#1732 + def parse(str, **options, &block); end + + # :call-seq: + # CSV.parse_line(string) -> new_array or nil + # CSV.parse_line(io) -> new_array or nil + # CSV.parse_line(string, **options) -> new_array or nil + # CSV.parse_line(io, **options) -> new_array or nil + # CSV.parse_line(string, headers: true, **options) -> csv_row or nil + # CSV.parse_line(io, headers: true, **options) -> csv_row or nil + # + # Returns the data created by parsing the first line of +string+ or +io+ + # using the specified +options+. + # + # - Argument +string+ should be a \String object; + # it will be put into a new StringIO object positioned at the beginning. + # :include: ../doc/csv/arguments/io.rdoc + # - Argument +options+: see {Options for Parsing}[#class-CSV-label-Options+for+Parsing] + # + # ====== Without Option +headers+ + # + # Without option +headers+, returns the first row as a new \Array. + # + # These examples assume prior execution of: + # string = "foo,0\nbar,1\nbaz,2\n" + # path = 't.csv' + # File.write(path, string) + # + # Parse the first line from a \String object: + # CSV.parse_line(string) # => ["foo", "0"] + # + # Parse the first line from a File object: + # File.open(path) do |file| + # CSV.parse_line(file) # => ["foo", "0"] + # end # => ["foo", "0"] + # + # Returns +nil+ if the argument is an empty \String: + # CSV.parse_line('') # => nil + # + # ====== With Option +headers+ + # + # With {option +headers+}[#class-CSV-label-Option+headers], + # returns the first row as a CSV::Row object. + # + # These examples assume prior execution of: + # string = "Name,Count\nfoo,0\nbar,1\nbaz,2\n" + # path = 't.csv' + # File.write(path, string) + # + # Parse the first line from a \String object: + # CSV.parse_line(string, headers: true) # => # + # + # Parse the first line from a File object: + # File.open(path) do |file| + # CSV.parse_line(file, headers: true) + # end # => # + # + # --- + # + # Raises an exception if the argument is +nil+: + # # Raises ArgumentError (Cannot parse nil as CSV): + # CSV.parse_line(nil) + # + # source://csv//lib/csv.rb#1805 + def parse_line(line, **options); end + + # :call-seq: + # read(source, **options) -> array_of_arrays + # read(source, headers: true, **options) -> csv_table + # + # Opens the given +source+ with the given +options+ (see CSV.open), + # reads the source (see CSV#read), and returns the result, + # which will be either an \Array of Arrays or a CSV::Table. + # + # Without headers: + # string = "foo,0\nbar,1\nbaz,2\n" + # path = 't.csv' + # File.write(path, string) + # CSV.read(path) # => [["foo", "0"], ["bar", "1"], ["baz", "2"]] + # + # With headers: + # string = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # path = 't.csv' + # File.write(path, string) + # CSV.read(path, headers: true) # => # + # + # source://csv//lib/csv.rb#1829 + def read(path, **options); end + + # :call-seq: + # CSV.readlines(source, **options) + # + # Alias for CSV.read. + # + # source://csv//lib/csv.rb#1837 + def readlines(path, **options); end + + # :call-seq: + # CSV.table(source, **options) + # + # Calls CSV.read with +source+, +options+, and certain default options: + # - +headers+: +true+ + # - +converters+: +:numeric+ + # - +header_converters+: +:symbol+ + # + # Returns a CSV::Table object. + # + # Example: + # string = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # path = 't.csv' + # File.write(path, string) + # CSV.table(path) # => # + # + # source://csv//lib/csv.rb#1856 + def table(path, **options); end + end +end + +# The encoding used by all converters. +# +# source://csv//lib/csv.rb#883 +CSV::ConverterEncoding = T.let(T.unsafe(nil), Encoding) + +# A \Hash containing the names and \Procs for the built-in field converters. +# See {Built-In Field Converters}[#class-CSV-label-Built-In+Field+Converters]. +# +# This \Hash is intentionally left unfrozen, and may be extended with +# custom field converters. +# See {Custom Field Converters}[#class-CSV-label-Custom+Field+Converters]. +# +# source://csv//lib/csv.rb#891 +CSV::Converters = T.let(T.unsafe(nil), Hash) + +# A Regexp used to find and convert some common Date formats. +# +# source://csv//lib/csv.rb#872 +CSV::DateMatcher = T.let(T.unsafe(nil), Regexp) + +# A Regexp used to find and convert some common DateTime formats. +# +# source://csv//lib/csv.rb#875 +CSV::DateTimeMatcher = T.let(T.unsafe(nil), Regexp) + +# Note: Don't use this class directly. This is an internal class. +# +# source://csv//lib/csv/fields_converter.rb#5 +class CSV::FieldsConverter + include ::Enumerable + + # A CSV::FieldsConverter is a data structure for storing the + # fields converter properties to be passed as a parameter + # when parsing a new file (e.g. CSV::Parser.new(@io, parser_options)) + # + # @return [FieldsConverter] a new instance of FieldsConverter + # + # source://csv//lib/csv/fields_converter.rb#13 + def initialize(options = T.unsafe(nil)); end + + # source://csv//lib/csv/fields_converter.rb#23 + def add_converter(name = T.unsafe(nil), &converter); end + + # source://csv//lib/csv/fields_converter.rb#47 + def convert(fields, headers, lineno, quoted_fields); end + + # source://csv//lib/csv/fields_converter.rb#39 + def each(&block); end + + # @return [Boolean] + # + # source://csv//lib/csv/fields_converter.rb#43 + def empty?; end + + private + + # source://csv//lib/csv/fields_converter.rb#85 + def builtin_converters; end + + # @return [Boolean] + # + # source://csv//lib/csv/fields_converter.rb#80 + def need_convert?; end + + # @return [Boolean] + # + # source://csv//lib/csv/fields_converter.rb#76 + def need_static_convert?; end +end + +# A \Hash containing the names and \Procs for the built-in header converters. +# See {Built-In Header Converters}[#class-CSV-label-Built-In+Header+Converters]. +# +# This \Hash is intentionally left unfrozen, and may be extended with +# custom field converters. +# See {Custom Header Converters}[#class-CSV-label-Custom+Header+Converters]. +# +# source://csv//lib/csv.rb#924 +CSV::HeaderConverters = T.let(T.unsafe(nil), Hash) + +# source://csv//lib/csv/input_record_separator.rb#5 +module CSV::InputRecordSeparator + class << self + # source://csv//lib/csv/input_record_separator.rb#8 + def value; end + end +end + +# The error thrown when the parser encounters invalid encoding in CSV. +# +# source://csv//lib/csv.rb#850 +class CSV::InvalidEncodingError < ::CSV::MalformedCSVError + # @return [InvalidEncodingError] a new instance of InvalidEncodingError + # + # source://csv//lib/csv.rb#852 + def initialize(encoding, line_number); end + + # Returns the value of attribute encoding. + # + # source://csv//lib/csv.rb#851 + def encoding; end +end + +# The error thrown when the parser encounters illegal CSV formatting. +# +# source://csv//lib/csv.rb#840 +class CSV::MalformedCSVError < ::RuntimeError + # @return [MalformedCSVError] a new instance of MalformedCSVError + # + # source://csv//lib/csv.rb#843 + def initialize(message, line_number); end + + # Returns the value of attribute line_number. + # + # source://csv//lib/csv.rb#841 + def line_number; end + + # Returns the value of attribute line_number. + # + # source://csv//lib/csv.rb#841 + def lineno; end +end + +# Note: Don't use this class directly. This is an internal class. +# +# source://csv//lib/csv/parser.rb#11 +class CSV::Parser + # @return [Parser] a new instance of Parser + # + # source://csv//lib/csv/parser.rb#335 + def initialize(input, options); end + + # source://csv//lib/csv/parser.rb#343 + def column_separator; end + + # source://csv//lib/csv/parser.rb#355 + def field_size_limit; end + + # @return [Boolean] + # + # source://csv//lib/csv/parser.rb#375 + def header_row?; end + + # source://csv//lib/csv/parser.rb#371 + def headers; end + + # @return [Boolean] + # + # source://csv//lib/csv/parser.rb#387 + def liberal_parsing?; end + + # source://csv//lib/csv/parser.rb#395 + def line; end + + # source://csv//lib/csv/parser.rb#391 + def lineno; end + + # source://csv//lib/csv/parser.rb#359 + def max_field_size; end + + # source://csv//lib/csv/parser.rb#399 + def parse(&block); end + + # source://csv//lib/csv/parser.rb#351 + def quote_character; end + + # @return [Boolean] + # + # source://csv//lib/csv/parser.rb#379 + def return_headers?; end + + # source://csv//lib/csv/parser.rb#347 + def row_separator; end + + # @return [Boolean] + # + # source://csv//lib/csv/parser.rb#383 + def skip_blanks?; end + + # source://csv//lib/csv/parser.rb#363 + def skip_lines; end + + # @return [Boolean] + # + # source://csv//lib/csv/parser.rb#367 + def unconverted_fields?; end + + # @return [Boolean] + # + # source://csv//lib/csv/parser.rb#440 + def use_headers?; end + + private + + # This method injects an instance variable unconverted_fields into + # +row+ and an accessor method for +row+ called unconverted_fields(). The + # variable is set to the contents of +fields+. + # + # source://csv//lib/csv/parser.rb#1289 + def add_unconverted_fields(row, fields); end + + # source://csv//lib/csv/parser.rb#803 + def adjust_headers(headers, quoted_fields); end + + # source://csv//lib/csv/parser.rb#871 + def build_scanner; end + + # source://csv//lib/csv/parser.rb#725 + def detect_row_separator(sample, cr, lf); end + + # @yield [row] + # + # source://csv//lib/csv/parser.rb#1260 + def emit_row(row, quoted_fields, &block); end + + # source://csv//lib/csv/parser.rb#1245 + def ignore_broken_line; end + + # source://csv//lib/csv/parser.rb#755 + def last_line; end + + # @return [Boolean] + # + # source://csv//lib/csv/parser.rb#813 + def may_quoted?; end + + # source://csv//lib/csv/parser.rb#1200 + def parse_column_end; end + + # source://csv//lib/csv/parser.rb#1100 + def parse_column_value; end + + # source://csv//lib/csv/parser.rb#789 + def parse_headers(row); end + + # source://csv//lib/csv/parser.rb#938 + def parse_no_quote(&block); end + + # source://csv//lib/csv/parser.rb#969 + def parse_quotable_loose(&block); end + + # source://csv//lib/csv/parser.rb#1030 + def parse_quotable_robust(&block); end + + # source://csv//lib/csv/parser.rb#1158 + def parse_quoted_column_value; end + + # source://csv//lib/csv/parser.rb#1214 + def parse_row_end; end + + # source://csv//lib/csv/parser.rb#1130 + def parse_unquoted_column_value; end + + # A set of tasks to prepare the file in order to parse it + # + # source://csv//lib/csv/parser.rb#446 + def prepare; end + + # source://csv//lib/csv/parser.rb#503 + def prepare_backslash; end + + # source://csv//lib/csv/parser.rb#763 + def prepare_header; end + + # source://csv//lib/csv/parser.rb#749 + def prepare_line; end + + # source://csv//lib/csv/parser.rb#809 + def prepare_parser; end + + # source://csv//lib/csv/parser.rb#487 + def prepare_quote_character; end + + # source://csv//lib/csv/parser.rb#645 + def prepare_quoted; end + + # source://csv//lib/csv/parser.rb#577 + def prepare_separators; end + + # source://csv//lib/csv/parser.rb#518 + def prepare_skip_lines; end + + # source://csv//lib/csv/parser.rb#535 + def prepare_strip; end + + # source://csv//lib/csv/parser.rb#672 + def prepare_unquoted; end + + # source://csv//lib/csv/parser.rb#461 + def prepare_variable; end + + # source://csv//lib/csv/parser.rb#685 + def resolve_row_separator(separator); end + + # @return [Boolean] + # + # source://csv//lib/csv/parser.rb#918 + def skip_line?(line); end + + # source://csv//lib/csv/parser.rb#901 + def skip_needless_lines; end + + # source://csv//lib/csv/parser.rb#1251 + def start_row; end + + # source://csv//lib/csv/parser.rb#1227 + def strip_value(value); end + + # @raise [MalformedCSVError] + # + # source://csv//lib/csv/parser.rb#930 + def validate_field_size(field); end + + # This method verifies that there are no (obvious) ambiguities with the + # provided +col_sep+ and +strip+ parsing options. For example, if +col_sep+ + # and +strip+ were both equal to +\t+, then there would be no clear way to + # parse the input. + # + # source://csv//lib/csv/parser.rb#627 + def validate_strip_and_col_sep_options; end +end + +# CSV::InputsScanner receives IO inputs, encoding and the chunk_size. +# It also controls the life cycle of the object with its methods +keep_start+, +# +keep_end+, +keep_back+, +keep_drop+. +# +# CSV::InputsScanner.scan() tries to match with pattern at the current position. +# If there's a match, the scanner advances the "scan pointer" and returns the matched string. +# Otherwise, the scanner returns nil. +# +# CSV::InputsScanner.rest() returns the "rest" of the string (i.e. everything after the scan pointer). +# If there is no more data (eos? = true), it returns "". +# +# source://csv//lib/csv/parser.rb#86 +class CSV::Parser::InputsScanner + # @return [InputsScanner] a new instance of InputsScanner + # + # source://csv//lib/csv/parser.rb#87 + def initialize(inputs, encoding, row_separator, chunk_size: T.unsafe(nil)); end + + # source://csv//lib/csv/parser.rb#257 + def check(pattern); end + + # @yield [buffer] + # + # source://csv//lib/csv/parser.rb#97 + def each_line(row_separator); end + + # @return [Boolean] + # + # source://csv//lib/csv/parser.rb#170 + def eos?; end + + # source://csv//lib/csv/parser.rb#197 + def keep_back; end + + # source://csv//lib/csv/parser.rb#236 + def keep_drop; end + + # source://csv//lib/csv/parser.rb#181 + def keep_end; end + + # source://csv//lib/csv/parser.rb#174 + def keep_start; end + + # source://csv//lib/csv/parser.rb#253 + def rest; end + + # source://csv//lib/csv/parser.rb#143 + def scan(pattern); end + + # source://csv//lib/csv/parser.rb#154 + def scan_all(pattern); end + + private + + # source://csv//lib/csv/parser.rb#266 + def adjust_last_keep; end + + # source://csv//lib/csv/parser.rb#294 + def read_chunk; end + + # source://csv//lib/csv/parser.rb#262 + def trace(*args); end +end + +# Raised when encoding is invalid. +# +# source://csv//lib/csv/parser.rb#22 +class CSV::Parser::InvalidEncoding < ::StandardError; end + +# source://csv//lib/csv/parser.rb#845 +CSV::Parser::SCANNER_TEST = T.let(T.unsafe(nil), FalseClass) + +# source://csv//lib/csv/parser.rb#574 +CSV::Parser::STRING_SCANNER_SCAN_ACCEPT_STRING = T.let(T.unsafe(nil), TrueClass) + +# CSV::Scanner receives a CSV output, scans it and return the content. +# It also controls the life cycle of the object with its methods +keep_start+, +# +keep_end+, +keep_back+, +keep_drop+. +# +# Uses StringScanner (the official strscan gem). Strscan provides lexical +# scanning operations on a String. We inherit its object and take advantage +# on the methods. For more information, please visit: +# https://ruby-doc.org/stdlib-2.6.1/libdoc/strscan/rdoc/StringScanner.html +# +# source://csv//lib/csv/parser.rb#39 +class CSV::Parser::Scanner < ::StringScanner + # @return [Scanner] a new instance of Scanner + # + # source://csv//lib/csv/parser.rb#42 + def initialize(*args); end + + # source://csv//lib/csv/parser.rb#47 + def each_line(row_separator); end + + # source://csv//lib/csv/parser.rb#65 + def keep_back; end + + # source://csv//lib/csv/parser.rb#69 + def keep_drop; end + + # source://csv//lib/csv/parser.rb#60 + def keep_end; end + + # source://csv//lib/csv/parser.rb#56 + def keep_start; end + + def scan_all(_arg0); end +end + +# Raised when unexpected case is happen. +# +# source://csv//lib/csv/parser.rb#26 +class CSV::Parser::UnexpectedError < ::StandardError; end + +# source://csv//lib/csv/parser.rb#827 +class CSV::Parser::UnoptimizedStringIO + # @return [UnoptimizedStringIO] a new instance of UnoptimizedStringIO + # + # source://csv//lib/csv/parser.rb#828 + def initialize(string); end + + # source://csv//lib/csv/parser.rb#836 + def each_line(*args, &block); end + + # @return [Boolean] + # + # source://csv//lib/csv/parser.rb#840 + def eof?; end + + # source://csv//lib/csv/parser.rb#832 + def gets(*args); end +end + +# = \CSV::Row +# A \CSV::Row instance represents a \CSV table row. +# (see {class CSV}[../CSV.html]). +# +# The instance may have: +# - Fields: each is an object, not necessarily a \String. +# - Headers: each serves a key, and also need not be a \String. +# +# === Instance Methods +# +# \CSV::Row has three groups of instance methods: +# - Its own internally defined instance methods. +# - Methods included by module Enumerable. +# - Methods delegated to class Array.: +# * Array#empty? +# * Array#length +# * Array#size +# +# == Creating a \CSV::Row Instance +# +# Commonly, a new \CSV::Row instance is created by parsing \CSV source +# that has headers: +# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" +# table = CSV.parse(source, headers: true) +# table.each {|row| p row } +# Output: +# # +# # +# # +# +# You can also create a row directly. See ::new. +# +# == Headers +# +# Like a \CSV::Table, a \CSV::Row has headers. +# +# A \CSV::Row that was created by parsing \CSV source +# inherits its headers from the table: +# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" +# table = CSV.parse(source, headers: true) +# row = table.first +# row.headers # => ["Name", "Value"] +# +# You can also create a new row with headers; +# like the keys in a \Hash, the headers need not be Strings: +# row = CSV::Row.new([:name, :value], ['foo', 0]) +# row.headers # => [:name, :value] +# +# The new row retains its headers even if added to a table +# that has headers: +# table << row # => # +# row.headers # => [:name, :value] +# row[:name] # => "foo" +# row['Name'] # => nil +# +# +# +# == Accessing Fields +# +# You may access a field in a \CSV::Row with either its \Integer index +# (\Array-style) or its header (\Hash-style). +# +# Fetch a field using method #[]: +# row = CSV::Row.new(['Name', 'Value'], ['foo', 0]) +# row[1] # => 0 +# row['Value'] # => 0 +# +# Set a field using method #[]=: +# row = CSV::Row.new(['Name', 'Value'], ['foo', 0]) +# row # => # +# row[0] = 'bar' +# row['Value'] = 1 +# row # => # +# +# source://csv//lib/csv/row.rb#80 +class CSV::Row + include ::Enumerable + extend ::Forwardable + + # :call-seq: + # CSV::Row.new(headers, fields, header_row = false) -> csv_row + # + # Returns the new \CSV::Row instance constructed from + # arguments +headers+ and +fields+; both should be Arrays; + # note that the fields need not be Strings: + # row = CSV::Row.new(['Name', 'Value'], ['foo', 0]) + # row # => # + # + # If the \Array lengths are different, the shorter is +nil+-filled: + # row = CSV::Row.new(['Name', 'Value', 'Date', 'Size'], ['foo', 0]) + # row # => # + # + # Each \CSV::Row object is either a field row or a header row; + # by default, a new row is a field row; for the row created above: + # row.field_row? # => true + # row.header_row? # => false + # + # If the optional argument +header_row+ is given as +true+, + # the created row is a header row: + # row = CSV::Row.new(['Name', 'Value'], ['foo', 0], header_row = true) + # row # => # + # row.field_row? # => false + # row.header_row? # => true + # + # @return [Row] a new instance of Row + # + # source://csv//lib/csv/row.rb#105 + def initialize(headers, fields, header_row = T.unsafe(nil)); end + + # :call-seq: + # row << [header, value] -> self + # row << hash -> self + # row << value -> self + # + # Adds a field to +self+; returns +self+: + # + # If the argument is a 2-element \Array [header, value], + # a field is added with the given +header+ and +value+: + # source = "Name,Name,Name\nFoo,Bar,Baz\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row << ['NAME', 'Bat'] + # row # => # + # + # If the argument is a \Hash, each key-value pair is added + # as a field with header +key+ and value +value+. + # source = "Name,Name,Name\nFoo,Bar,Baz\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row << {NAME: 'Bat', name: 'Bam'} + # row # => # + # + # Otherwise, the given +value+ is added as a field with no header. + # source = "Name,Name,Name\nFoo,Bar,Baz\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row << 'Bag' + # row # => # + # + # source://csv//lib/csv/row.rb#389 + def <<(arg); end + + # :call-seq: + # row == other -> true or false + # + # Returns +true+ if +other+ is a /CSV::Row that has the same + # fields (headers and values) in the same order as +self+; + # otherwise returns +false+: + # source = "Name,Name,Name\nFoo,Bar,Baz\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # other_row = table[0] + # row == other_row # => true + # other_row = table[1] + # row == other_row # => false + # + # source://csv//lib/csv/row.rb#633 + def ==(other); end + + # :call-seq: + # field(index) -> value + # field(header) -> value + # field(header, offset) -> value + # + # Returns the field value for the given +index+ or +header+. + # + # --- + # + # Fetch field value by \Integer index: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row.field(0) # => "foo" + # row.field(1) # => "bar" + # + # Counts backward from the last column if +index+ is negative: + # row.field(-1) # => "0" + # row.field(-2) # => "foo" + # + # Returns +nil+ if +index+ is out of range: + # row.field(2) # => nil + # row.field(-3) # => nil + # + # --- + # + # Fetch field value by header (first found): + # source = "Name,Name,Name\nFoo,Bar,Baz\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row.field('Name') # => "Foo" + # + # Fetch field value by header, ignoring +offset+ leading fields: + # source = "Name,Name,Name\nFoo,Bar,Baz\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row.field('Name', 2) # => "Baz" + # + # Returns +nil+ if the header does not exist. + # + # source://csv//lib/csv/row.rb#203 + def [](header_or_index, minimum_index = T.unsafe(nil)); end + + # :call-seq: + # row[index] = value -> value + # row[header, offset] = value -> value + # row[header] = value -> value + # + # Assigns the field value for the given +index+ or +header+; + # returns +value+. + # + # --- + # + # Assign field value by \Integer index: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row[0] = 'Bat' + # row[1] = 3 + # row # => # + # + # Counts backward from the last column if +index+ is negative: + # row[-1] = 4 + # row[-2] = 'Bam' + # row # => # + # + # Extends the row with nil:nil if positive +index+ is not in the row: + # row[4] = 5 + # row # => # + # + # Raises IndexError if negative +index+ is too small (too far from zero). + # + # --- + # + # Assign field value by header (first found): + # source = "Name,Name,Name\nFoo,Bar,Baz\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row['Name'] = 'Bat' + # row # => # + # + # Assign field value by header, ignoring +offset+ leading fields: + # source = "Name,Name,Name\nFoo,Bar,Baz\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row['Name', 2] = 4 + # row # => # + # + # Append new field by (new) header: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row['New'] = 6 + # row# => # + # + # source://csv//lib/csv/row.rb#339 + def []=(*args); end + + # :call-seq: + # row.deconstruct -> array + # + # Returns the new \Array suitable for pattern matching containing the values + # of the row. + # + # source://csv//lib/csv/row.rb#682 + def deconstruct; end + + # :call-seq: + # row.deconstruct_keys(keys) -> hash + # + # Returns the new \Hash suitable for pattern matching containing only the + # keys specified as an argument. + # + # source://csv//lib/csv/row.rb#667 + def deconstruct_keys(keys); end + + # :call-seq: + # delete(index) -> [header, value] or nil + # delete(header) -> [header, value] or empty_array + # delete(header, offset) -> [header, value] or empty_array + # + # Removes a specified field from +self+; returns the 2-element \Array + # [header, value] if the field exists. + # + # If an \Integer argument +index+ is given, + # removes and returns the field at offset +index+, + # or returns +nil+ if the field does not exist: + # source = "Name,Name,Name\nFoo,Bar,Baz\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row.delete(1) # => ["Name", "Bar"] + # row.delete(50) # => nil + # + # Otherwise, if the single argument +header+ is given, + # removes and returns the first-found field with the given header, + # of returns a new empty \Array if the field does not exist: + # source = "Name,Name,Name\nFoo,Bar,Baz\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row.delete('Name') # => ["Name", "Foo"] + # row.delete('NAME') # => [] + # + # If argument +header+ and \Integer argument +offset+ are given, + # removes and returns the first-found field with the given header + # whose +index+ is at least as large as +offset+: + # source = "Name,Name,Name\nFoo,Bar,Baz\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row.delete('Name', 1) # => ["Name", "Bar"] + # row.delete('NAME', 1) # => [] + # + # source://csv//lib/csv/row.rb#451 + def delete(header_or_index, minimum_index = T.unsafe(nil)); end + + # :call-seq: + # row.delete_if {|header, value| ... } -> self + # + # Removes fields from +self+ as selected by the block; returns +self+. + # + # Removes each field for which the block returns a truthy value: + # source = "Name,Name,Name\nFoo,Bar,Baz\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row.delete_if {|header, value| value.start_with?('B') } # => true + # row # => # + # row.delete_if {|header, value| header.start_with?('B') } # => false + # + # If no block is given, returns a new Enumerator: + # row.delete_if # => #:delete_if> + # + # source://csv//lib/csv/row.rb#476 + def delete_if(&block); end + + # :call-seq: + # row.dig(index_or_header, *identifiers) -> object + # + # Finds and returns the object in nested object that is specified + # by +index_or_header+ and +specifiers+. + # + # The nested objects may be instances of various classes. + # See {Dig Methods}[rdoc-ref:dig_methods.rdoc]. + # + # Examples: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row.dig(1) # => "0" + # row.dig('Value') # => "0" + # row.dig(5) # => nil + # + # source://csv//lib/csv/row.rb#715 + def dig(index_or_header, *indexes); end + + # :call-seq: + # row.each {|header, value| ... } -> self + # + # Calls the block with each header-value pair; returns +self+: + # source = "Name,Name,Name\nFoo,Bar,Baz\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row.each {|header, value| p [header, value] } + # Output: + # ["Name", "Foo"] + # ["Name", "Bar"] + # ["Name", "Baz"] + # + # If no block is given, returns a new Enumerator: + # row.each # => #:each> + # + # source://csv//lib/csv/row.rb#610 + def each(&block); end + + # :call-seq: + # row.each {|header, value| ... } -> self + # + # Calls the block with each header-value pair; returns +self+: + # source = "Name,Name,Name\nFoo,Bar,Baz\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row.each {|header, value| p [header, value] } + # Output: + # ["Name", "Foo"] + # ["Name", "Bar"] + # ["Name", "Baz"] + # + # If no block is given, returns a new Enumerator: + # row.each # => #:each> + # + # source://csv//lib/csv/row.rb#610 + def each_pair(&block); end + + # :call-seq: + # fetch(header) -> value + # fetch(header, default) -> value + # fetch(header) {|row| ... } -> value + # + # Returns the field value as specified by +header+. + # + # --- + # + # With the single argument +header+, returns the field value + # for that header (first found): + # source = "Name,Name,Name\nFoo,Bar,Baz\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row.fetch('Name') # => "Foo" + # + # Raises exception +KeyError+ if the header does not exist. + # + # --- + # + # With arguments +header+ and +default+ given, + # returns the field value for the header (first found) + # if the header exists, otherwise returns +default+: + # source = "Name,Name,Name\nFoo,Bar,Baz\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row.fetch('Name', '') # => "Foo" + # row.fetch(:nosuch, '') # => "" + # + # --- + # + # With argument +header+ and a block given, + # returns the field value for the header (first found) + # if the header exists; otherwise calls the block + # and returns its return value: + # source = "Name,Name,Name\nFoo,Bar,Baz\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row.fetch('Name') {|header| fail 'Cannot happen' } # => "Foo" + # row.fetch(:nosuch) {|header| "Header '#{header} not found'" } # => "Header 'nosuch not found'" + # + # @raise [ArgumentError] + # + # source://csv//lib/csv/row.rb#258 + def fetch(header, *varargs); end + + # :call-seq: + # field(index) -> value + # field(header) -> value + # field(header, offset) -> value + # + # Returns the field value for the given +index+ or +header+. + # + # --- + # + # Fetch field value by \Integer index: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row.field(0) # => "foo" + # row.field(1) # => "bar" + # + # Counts backward from the last column if +index+ is negative: + # row.field(-1) # => "0" + # row.field(-2) # => "foo" + # + # Returns +nil+ if +index+ is out of range: + # row.field(2) # => nil + # row.field(-3) # => nil + # + # --- + # + # Fetch field value by header (first found): + # source = "Name,Name,Name\nFoo,Bar,Baz\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row.field('Name') # => "Foo" + # + # Fetch field value by header, ignoring +offset+ leading fields: + # source = "Name,Name,Name\nFoo,Bar,Baz\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row.field('Name', 2) # => "Baz" + # + # Returns +nil+ if the header does not exist. + # + # source://csv//lib/csv/row.rb#203 + def field(header_or_index, minimum_index = T.unsafe(nil)); end + + # :call-seq: + # row.field?(value) -> true or false + # + # Returns +true+ if +value+ is a field in this row, +false+ otherwise: + # source = "Name,Name,Name\nFoo,Bar,Baz\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row.field?('Bar') # => true + # row.field?('BAR') # => false + # + # @return [Boolean] + # + # source://csv//lib/csv/row.rb#589 + def field?(data); end + + # :call-seq: + # row.field_row? -> true or false + # + # Returns +true+ if this is a field row, +false+ otherwise. + # + # @return [Boolean] + # + # source://csv//lib/csv/row.rb#148 + def field_row?; end + + # :call-seq: + # self.fields(*specifiers) -> array_of_fields + # + # Returns field values per the given +specifiers+, which may be any mixture of: + # - \Integer index. + # - \Range of \Integer indexes. + # - 2-element \Array containing a header and offset. + # - Header. + # - \Range of headers. + # + # For +specifier+ in one of the first four cases above, + # returns the result of self.field(specifier); see #field. + # + # Although there may be any number of +specifiers+, + # the examples here will illustrate one at a time. + # + # When the specifier is an \Integer +index+, + # returns self.field(index)L + # source = "Name,Name,Name\nFoo,Bar,Baz\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row.fields(1) # => ["Bar"] + # + # When the specifier is a \Range of \Integers +range+, + # returns self.field(range): + # row.fields(1..2) # => ["Bar", "Baz"] + # + # When the specifier is a 2-element \Array +array+, + # returns self.field(array)L + # row.fields('Name', 1) # => ["Foo", "Bar"] + # + # When the specifier is a header +header+, + # returns self.field(header)L + # row.fields('Name') # => ["Foo"] + # + # When the specifier is a \Range of headers +range+, + # forms a new \Range +new_range+ from the indexes of + # range.start and range.end, + # and returns self.field(new_range): + # source = "Name,NAME,name\nFoo,Bar,Baz\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row.fields('Name'..'NAME') # => ["Foo", "Bar"] + # + # Returns all fields if no argument given: + # row.fields # => ["Foo", "Bar", "Baz"] + # + # source://csv//lib/csv/row.rb#530 + def fields(*headers_and_or_indices); end + + # :call-seq: + # row.has_key?(header) -> true or false + # + # Returns +true+ if there is a field with the given +header+, + # +false+ otherwise. + # + # @return [Boolean] + # + # source://csv//lib/csv/row.rb#279 + def has_key?(header); end + + # :call-seq: + # row.has_key?(header) -> true or false + # + # Returns +true+ if there is a field with the given +header+, + # +false+ otherwise. + # + # @return [Boolean] + # + # source://csv//lib/csv/row.rb#279 + def header?(header); end + + # :call-seq: + # row.header_row? -> true or false + # + # Returns +true+ if this is a header row, +false+ otherwise. + # + # @return [Boolean] + # + # source://csv//lib/csv/row.rb#140 + def header_row?; end + + # :call-seq: + # row.headers -> array_of_headers + # + # Returns the headers for this row: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # row = table.first + # row.headers # => ["Name", "Value"] + # + # source://csv//lib/csv/row.rb#160 + def headers; end + + # :call-seq: + # row.has_key?(header) -> true or false + # + # Returns +true+ if there is a field with the given +header+, + # +false+ otherwise. + # + # @return [Boolean] + # + # source://csv//lib/csv/row.rb#279 + def include?(header); end + + # :call-seq: + # index(header) -> index + # index(header, offset) -> index + # + # Returns the index for the given header, if it exists; + # otherwise returns +nil+. + # + # With the single argument +header+, returns the index + # of the first-found field with the given +header+: + # source = "Name,Name,Name\nFoo,Bar,Baz\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row.index('Name') # => 0 + # row.index('NAME') # => nil + # + # With arguments +header+ and +offset+, + # returns the index of the first-found field with given +header+, + # but ignoring the first +offset+ fields: + # row.index('Name', 1) # => 1 + # row.index('Name', 3) # => nil + # + # source://csv//lib/csv/row.rb#573 + def index(header, minimum_index = T.unsafe(nil)); end + + # :call-seq: + # row.inspect -> string + # + # Returns an ASCII-compatible \String showing: + # - Class \CSV::Row. + # - Header-value pairs. + # Example: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row.inspect # => "#" + # + # source://csv//lib/csv/row.rb#740 + def inspect; end + + # :call-seq: + # row.has_key?(header) -> true or false + # + # Returns +true+ if there is a field with the given +header+, + # +false+ otherwise. + # + # @return [Boolean] + # + # source://csv//lib/csv/row.rb#279 + def key?(header); end + + # :call-seq: + # row.has_key?(header) -> true or false + # + # Returns +true+ if there is a field with the given +header+, + # +false+ otherwise. + # + # @return [Boolean] + # + # source://csv//lib/csv/row.rb#279 + def member?(header); end + + # :call-seq: + # row.push(*values) -> self + # + # Appends each of the given +values+ to +self+ as a field; returns +self+: + # source = "Name,Name,Name\nFoo,Bar,Baz\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row.push('Bat', 'Bam') + # row # => # + # + # source://csv//lib/csv/row.rb#410 + def push(*args); end + + # :call-seq: + # row.to_csv -> csv_string + # + # Returns the row as a \CSV String. Headers are not included: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row.to_csv # => "foo,0\n" + # + # source://csv//lib/csv/row.rb#694 + def to_csv(**options); end + + # :call-seq: + # row.to_h -> hash + # + # Returns the new \Hash formed by adding each header-value pair in +self+ + # as a key-value pair in the \Hash. + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row.to_h # => {"Name"=>"foo", "Value"=>"0"} + # + # Header order is preserved, but repeated headers are ignored: + # source = "Name,Name,Name\nFoo,Bar,Baz\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row.to_h # => {"Name"=>"Foo"} + # + # source://csv//lib/csv/row.rb#653 + def to_h; end + + # :call-seq: + # row.to_h -> hash + # + # Returns the new \Hash formed by adding each header-value pair in +self+ + # as a key-value pair in the \Hash. + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row.to_h # => {"Name"=>"foo", "Value"=>"0"} + # + # Header order is preserved, but repeated headers are ignored: + # source = "Name,Name,Name\nFoo,Bar,Baz\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row.to_h # => {"Name"=>"Foo"} + # + # source://csv//lib/csv/row.rb#653 + def to_hash; end + + # :call-seq: + # row.to_csv -> csv_string + # + # Returns the row as a \CSV String. Headers are not included: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row.to_csv # => "foo,0\n" + # + # source://csv//lib/csv/row.rb#694 + def to_s(**options); end + + # :call-seq: + # self.fields(*specifiers) -> array_of_fields + # + # Returns field values per the given +specifiers+, which may be any mixture of: + # - \Integer index. + # - \Range of \Integer indexes. + # - 2-element \Array containing a header and offset. + # - Header. + # - \Range of headers. + # + # For +specifier+ in one of the first four cases above, + # returns the result of self.field(specifier); see #field. + # + # Although there may be any number of +specifiers+, + # the examples here will illustrate one at a time. + # + # When the specifier is an \Integer +index+, + # returns self.field(index)L + # source = "Name,Name,Name\nFoo,Bar,Baz\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row.fields(1) # => ["Bar"] + # + # When the specifier is a \Range of \Integers +range+, + # returns self.field(range): + # row.fields(1..2) # => ["Bar", "Baz"] + # + # When the specifier is a 2-element \Array +array+, + # returns self.field(array)L + # row.fields('Name', 1) # => ["Foo", "Bar"] + # + # When the specifier is a header +header+, + # returns self.field(header)L + # row.fields('Name') # => ["Foo"] + # + # When the specifier is a \Range of headers +range+, + # forms a new \Range +new_range+ from the indexes of + # range.start and range.end, + # and returns self.field(new_range): + # source = "Name,NAME,name\nFoo,Bar,Baz\n" + # table = CSV.parse(source, headers: true) + # row = table[0] + # row.fields('Name'..'NAME') # => ["Foo", "Bar"] + # + # Returns all fields if no argument given: + # row.fields # => ["Foo", "Bar", "Baz"] + # + # source://csv//lib/csv/row.rb#530 + def values_at(*headers_and_or_indices); end + + protected + + # Internal data format used to compare equality. + # + # source://csv//lib/csv/row.rb#118 + def row; end + + private + + # :call-seq: + # row.initialize_copy(other_row) -> self + # + # Calls superclass method. + # + # source://csv//lib/csv/row.rb#130 + def initialize_copy(other); end +end + +# = \CSV::Table +# A \CSV::Table instance represents \CSV data. +# (see {class CSV}[../CSV.html]). +# +# The instance may have: +# - Rows: each is a Table::Row object. +# - Headers: names for the columns. +# +# === Instance Methods +# +# \CSV::Table has three groups of instance methods: +# - Its own internally defined instance methods. +# - Methods included by module Enumerable. +# - Methods delegated to class Array.: +# * Array#empty? +# * Array#length +# * Array#size +# +# == Creating a \CSV::Table Instance +# +# Commonly, a new \CSV::Table instance is created by parsing \CSV source +# using headers: +# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" +# table = CSV.parse(source, headers: true) +# table.class # => CSV::Table +# +# You can also create an instance directly. See ::new. +# +# == Headers +# +# If a table has headers, the headers serve as labels for the columns of data. +# Each header serves as the label for its column. +# +# The headers for a \CSV::Table object are stored as an \Array of Strings. +# +# Commonly, headers are defined in the first row of \CSV source: +# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" +# table = CSV.parse(source, headers: true) +# table.headers # => ["Name", "Value"] +# +# If no headers are defined, the \Array is empty: +# table = CSV::Table.new([]) +# table.headers # => [] +# +# == Access Modes +# +# \CSV::Table provides three modes for accessing table data: +# - \Row mode. +# - Column mode. +# - Mixed mode (the default for a new table). +# +# The access mode for a\CSV::Table instance affects the behavior +# of some of its instance methods: +# - #[] +# - #[]= +# - #delete +# - #delete_if +# - #each +# - #values_at +# +# === \Row Mode +# +# Set a table to row mode with method #by_row!: +# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" +# table = CSV.parse(source, headers: true) +# table.by_row! # => # +# +# Specify a single row by an \Integer index: +# # Get a row. +# table[1] # => # +# # Set a row, then get it. +# table[1] = CSV::Row.new(['Name', 'Value'], ['bam', 3]) +# table[1] # => # +# +# Specify a sequence of rows by a \Range: +# # Get rows. +# table[1..2] # => [#, #] +# # Set rows, then get them. +# table[1..2] = [ +# CSV::Row.new(['Name', 'Value'], ['bat', 4]), +# CSV::Row.new(['Name', 'Value'], ['bad', 5]), +# ] +# table[1..2] # => [["Name", #], ["Value", #]] +# +# === Column Mode +# +# Set a table to column mode with method #by_col!: +# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" +# table = CSV.parse(source, headers: true) +# table.by_col! # => # +# +# Specify a column by an \Integer index: +# # Get a column. +# table[0] +# # Set a column, then get it. +# table[0] = ['FOO', 'BAR', 'BAZ'] +# table[0] # => ["FOO", "BAR", "BAZ"] +# +# Specify a column by its \String header: +# # Get a column. +# table['Name'] # => ["FOO", "BAR", "BAZ"] +# # Set a column, then get it. +# table['Name'] = ['Foo', 'Bar', 'Baz'] +# table['Name'] # => ["Foo", "Bar", "Baz"] +# +# === Mixed Mode +# +# In mixed mode, you can refer to either rows or columns: +# - An \Integer index refers to a row. +# - A \Range index refers to multiple rows. +# - A \String index refers to a column. +# +# Set a table to mixed mode with method #by_col_or_row!: +# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" +# table = CSV.parse(source, headers: true) +# table.by_col_or_row! # => # +# +# Specify a single row by an \Integer index: +# # Get a row. +# table[1] # => # +# # Set a row, then get it. +# table[1] = CSV::Row.new(['Name', 'Value'], ['bam', 3]) +# table[1] # => # +# +# Specify a sequence of rows by a \Range: +# # Get rows. +# table[1..2] # => [#, #] +# # Set rows, then get them. +# table[1] = CSV::Row.new(['Name', 'Value'], ['bat', 4]) +# table[2] = CSV::Row.new(['Name', 'Value'], ['bad', 5]) +# table[1..2] # => [["Name", #], ["Value", #]] +# +# Specify a column by its \String header: +# # Get a column. +# table['Name'] # => ["foo", "bat", "bad"] +# # Set a column, then get it. +# table['Name'] = ['Foo', 'Bar', 'Baz'] +# table['Name'] # => ["Foo", "Bar", "Baz"] +# +# source://csv//lib/csv/table.rb#144 +class CSV::Table + include ::Enumerable + extend ::Forwardable + + # :call-seq: + # CSV::Table.new(array_of_rows, headers = nil) -> csv_table + # + # Returns a new \CSV::Table object. + # + # - Argument +array_of_rows+ must be an \Array of CSV::Row objects. + # - Argument +headers+, if given, may be an \Array of Strings. + # + # --- + # + # Create an empty \CSV::Table object: + # table = CSV::Table.new([]) + # table # => # + # + # Create a non-empty \CSV::Table object: + # rows = [ + # CSV::Row.new([], []), + # CSV::Row.new([], []), + # CSV::Row.new([], []), + # ] + # table = CSV::Table.new(rows) + # table # => # + # + # --- + # + # If argument +headers+ is an \Array of Strings, + # those Strings become the table's headers: + # table = CSV::Table.new([], headers: ['Name', 'Age']) + # table.headers # => ["Name", "Age"] + # + # If argument +headers+ is not given and the table has rows, + # the headers are taken from the first row: + # rows = [ + # CSV::Row.new(['Foo', 'Bar'], []), + # CSV::Row.new(['foo', 'bar'], []), + # CSV::Row.new(['FOO', 'BAR'], []), + # ] + # table = CSV::Table.new(rows) + # table.headers # => ["Foo", "Bar"] + # + # If argument +headers+ is not given and the table is empty (has no rows), + # the headers are also empty: + # table = CSV::Table.new([]) + # table.headers # => [] + # + # --- + # + # Raises an exception if argument +array_of_rows+ is not an \Array object: + # # Raises NoMethodError (undefined method `first' for :foo:Symbol): + # CSV::Table.new(:foo) + # + # Raises an exception if an element of +array_of_rows+ is not a \CSV::Table object: + # # Raises NoMethodError (undefined method `headers' for :foo:Symbol): + # CSV::Table.new([:foo]) + # + # @return [Table] a new instance of Table + # + # source://csv//lib/csv/table.rb#199 + def initialize(array_of_rows, headers: T.unsafe(nil)); end + + # :call-seq: + # table << row_or_array -> self + # + # If +row_or_array+ is a \CSV::Row object, + # it is appended to the table: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # table << CSV::Row.new(table.headers, ['bat', 3]) + # table[3] # => # + # + # If +row_or_array+ is an \Array, it is used to create a new + # \CSV::Row object which is then appended to the table: + # table << ['bam', 4] + # table[4] # => # + # + # source://csv//lib/csv/table.rb#762 + def <<(row_or_array); end + + # :call-seq: + # table == other_table -> true or false + # + # Returns +true+ if all each row of +self+ == + # the corresponding row of +other_table+, otherwise, +false+. + # + # The access mode does no affect the result. + # + # Equal tables: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # other_table = CSV.parse(source, headers: true) + # table == other_table # => true + # + # Different row count: + # other_table.delete(2) + # table == other_table # => false + # + # Different last row: + # other_table << ['bat', 3] + # table == other_table # => false + # + # source://csv//lib/csv/table.rb#965 + def ==(other); end + + # :call-seq: + # table[n] -> row or column_data + # table[range] -> array_of_rows or array_of_column_data + # table[header] -> array_of_column_data + # + # Returns data from the table; does not modify the table. + # + # --- + # + # Fetch a \Row by Its \Integer Index:: + # - Form: table[n], +n+ an integer. + # - Access mode: :row or :col_or_row. + # - Return value: _nth_ row of the table, if that row exists; + # otherwise +nil+. + # + # Returns the _nth_ row of the table if that row exists: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # table.by_row! # => # + # table[1] # => # + # table.by_col_or_row! # => # + # table[1] # => # + # + # Counts backward from the last row if +n+ is negative: + # table[-1] # => # + # + # Returns +nil+ if +n+ is too large or too small: + # table[4] # => nil + # table[-4] # => nil + # + # Raises an exception if the access mode is :row + # and +n+ is not an \Integer: + # table.by_row! # => # + # # Raises TypeError (no implicit conversion of String into Integer): + # table['Name'] + # + # --- + # + # Fetch a Column by Its \Integer Index:: + # - Form: table[n], +n+ an \Integer. + # - Access mode: :col. + # - Return value: _nth_ column of the table, if that column exists; + # otherwise an \Array of +nil+ fields of length self.size. + # + # Returns the _nth_ column of the table if that column exists: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # table.by_col! # => # + # table[1] # => ["0", "1", "2"] + # + # Counts backward from the last column if +n+ is negative: + # table[-2] # => ["foo", "bar", "baz"] + # + # Returns an \Array of +nil+ fields if +n+ is too large or too small: + # table[4] # => [nil, nil, nil] + # table[-4] # => [nil, nil, nil] + # + # --- + # + # Fetch Rows by \Range:: + # - Form: table[range], +range+ a \Range object. + # - Access mode: :row or :col_or_row. + # - Return value: rows from the table, beginning at row range.start, + # if those rows exists. + # + # Returns rows from the table, beginning at row range.first, + # if those rows exist: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # table.by_row! # => # + # rows = table[1..2] # => # + # rows # => [#, #] + # table.by_col_or_row! # => # + # rows = table[1..2] # => # + # rows # => [#, #] + # + # If there are too few rows, returns all from range.start to the end: + # rows = table[1..50] # => # + # rows # => [#, #] + # + # Special case: if range.start == table.size, returns an empty \Array: + # table[table.size..50] # => [] + # + # If range.end is negative, calculates the ending index from the end: + # rows = table[0..-1] + # rows # => [#, #, #] + # + # If range.start is negative, calculates the starting index from the end: + # rows = table[-1..2] + # rows # => [#] + # + # If range.start is larger than table.size, returns +nil+: + # table[4..4] # => nil + # + # --- + # + # Fetch Columns by \Range:: + # - Form: table[range], +range+ a \Range object. + # - Access mode: :col. + # - Return value: column data from the table, beginning at column range.start, + # if those columns exist. + # + # Returns column values from the table, if the column exists; + # the values are arranged by row: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # table.by_col! + # table[0..1] # => [["foo", "0"], ["bar", "1"], ["baz", "2"]] + # + # Special case: if range.start == headers.size, + # returns an \Array (size: table.size) of empty \Arrays: + # table[table.headers.size..50] # => [[], [], []] + # + # If range.end is negative, calculates the ending index from the end: + # table[0..-1] # => [["foo", "0"], ["bar", "1"], ["baz", "2"]] + # + # If range.start is negative, calculates the starting index from the end: + # table[-2..2] # => [["foo", "0"], ["bar", "1"], ["baz", "2"]] + # + # If range.start is larger than table.size, + # returns an \Array of +nil+ values: + # table[4..4] # => [nil, nil, nil] + # + # --- + # + # Fetch a Column by Its \String Header:: + # - Form: table[header], +header+ a \String header. + # - Access mode: :col or :col_or_row + # - Return value: column data from the table, if that +header+ exists. + # + # Returns column values from the table, if the column exists: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # table.by_col! # => # + # table['Name'] # => ["foo", "bar", "baz"] + # table.by_col_or_row! # => # + # col = table['Name'] + # col # => ["foo", "bar", "baz"] + # + # Modifying the returned column values does not modify the table: + # col[0] = 'bat' + # col # => ["bat", "bar", "baz"] + # table['Name'] # => ["foo", "bar", "baz"] + # + # Returns an \Array of +nil+ values if there is no such column: + # table['Nosuch'] # => [nil, nil, nil] + # + # source://csv//lib/csv/table.rb#514 + def [](index_or_header); end + + # :call-seq: + # table[n] = row -> row + # table[n] = field_or_array_of_fields -> field_or_array_of_fields + # table[header] = field_or_array_of_fields -> field_or_array_of_fields + # + # Puts data onto the table. + # + # --- + # + # Set a \Row by Its \Integer Index:: + # - Form: table[n] = row, +n+ an \Integer, + # +row+ a \CSV::Row instance or an \Array of fields. + # - Access mode: :row or :col_or_row. + # - Return value: +row+. + # + # If the row exists, it is replaced: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # new_row = CSV::Row.new(['Name', 'Value'], ['bat', 3]) + # table.by_row! # => # + # return_value = table[0] = new_row + # return_value.equal?(new_row) # => true # Returned the row + # table[0].to_h # => {"Name"=>"bat", "Value"=>3} + # + # With access mode :col_or_row: + # table.by_col_or_row! # => # + # table[0] = CSV::Row.new(['Name', 'Value'], ['bam', 4]) + # table[0].to_h # => {"Name"=>"bam", "Value"=>4} + # + # With an \Array instead of a \CSV::Row, inherits headers from the table: + # array = ['bad', 5] + # return_value = table[0] = array + # return_value.equal?(array) # => true # Returned the array + # table[0].to_h # => {"Name"=>"bad", "Value"=>5} + # + # If the row does not exist, extends the table by adding rows: + # assigns rows with +nil+ as needed: + # table.size # => 3 + # table[5] = ['bag', 6] + # table.size # => 6 + # table[3] # => nil + # table[4]# => nil + # table[5].to_h # => {"Name"=>"bag", "Value"=>6} + # + # Note that the +nil+ rows are actually +nil+, not a row of +nil+ fields. + # + # --- + # + # Set a Column by Its \Integer Index:: + # - Form: table[n] = array_of_fields, +n+ an \Integer, + # +array_of_fields+ an \Array of \String fields. + # - Access mode: :col. + # - Return value: +array_of_fields+. + # + # If the column exists, it is replaced: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # new_col = [3, 4, 5] + # table.by_col! # => # + # return_value = table[1] = new_col + # return_value.equal?(new_col) # => true # Returned the column + # table[1] # => [3, 4, 5] + # # The rows, as revised: + # table.by_row! # => # + # table[0].to_h # => {"Name"=>"foo", "Value"=>3} + # table[1].to_h # => {"Name"=>"bar", "Value"=>4} + # table[2].to_h # => {"Name"=>"baz", "Value"=>5} + # table.by_col! # => # + # + # If there are too few values, fills with +nil+ values: + # table[1] = [0] + # table[1] # => [0, nil, nil] + # + # If there are too many values, ignores the extra values: + # table[1] = [0, 1, 2, 3, 4] + # table[1] # => [0, 1, 2] + # + # If a single value is given, replaces all fields in the column with that value: + # table[1] = 'bat' + # table[1] # => ["bat", "bat", "bat"] + # + # --- + # + # Set a Column by Its \String Header:: + # - Form: table[header] = field_or_array_of_fields, + # +header+ a \String header, +field_or_array_of_fields+ a field value + # or an \Array of \String fields. + # - Access mode: :col or :col_or_row. + # - Return value: +field_or_array_of_fields+. + # + # If the column exists, it is replaced: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # new_col = [3, 4, 5] + # table.by_col! # => # + # return_value = table['Value'] = new_col + # return_value.equal?(new_col) # => true # Returned the column + # table['Value'] # => [3, 4, 5] + # # The rows, as revised: + # table.by_row! # => # + # table[0].to_h # => {"Name"=>"foo", "Value"=>3} + # table[1].to_h # => {"Name"=>"bar", "Value"=>4} + # table[2].to_h # => {"Name"=>"baz", "Value"=>5} + # table.by_col! # => # + # + # If there are too few values, fills with +nil+ values: + # table['Value'] = [0] + # table['Value'] # => [0, nil, nil] + # + # If there are too many values, ignores the extra values: + # table['Value'] = [0, 1, 2, 3, 4] + # table['Value'] # => [0, 1, 2] + # + # If the column does not exist, extends the table by adding columns: + # table['Note'] = ['x', 'y', 'z'] + # table['Note'] # => ["x", "y", "z"] + # # The rows, as revised: + # table.by_row! + # table[0].to_h # => {"Name"=>"foo", "Value"=>0, "Note"=>"x"} + # table[1].to_h # => {"Name"=>"bar", "Value"=>1, "Note"=>"y"} + # table[2].to_h # => {"Name"=>"baz", "Value"=>2, "Note"=>"z"} + # table.by_col! + # + # If a single value is given, replaces all fields in the column with that value: + # table['Value'] = 'bat' + # table['Value'] # => ["bat", "bat", "bat"] + # + # source://csv//lib/csv/table.rb#649 + def []=(index_or_header, value); end + + # :call-seq: + # table.by_col -> table_dup + # + # Returns a duplicate of +self+, in column mode + # (see {Column Mode}[#class-CSV::Table-label-Column+Mode]): + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # table.mode # => :col_or_row + # dup_table = table.by_col + # dup_table.mode # => :col + # dup_table.equal?(table) # => false # It's a dup + # + # This may be used to chain method calls without changing the mode + # (but also will affect performance and memory usage): + # dup_table.by_col['Name'] + # + # Also note that changes to the duplicate table will not affect the original. + # + # source://csv//lib/csv/table.rb#242 + def by_col; end + + # :call-seq: + # table.by_col! -> self + # + # Sets the mode for +self+ to column mode + # (see {Column Mode}[#class-CSV::Table-label-Column+Mode]); returns +self+: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # table.mode # => :col_or_row + # table1 = table.by_col! + # table.mode # => :col + # table1.equal?(table) # => true # Returned self + # + # source://csv//lib/csv/table.rb#257 + def by_col!; end + + # :call-seq: + # table.by_col_or_row -> table_dup + # + # Returns a duplicate of +self+, in mixed mode + # (see {Mixed Mode}[#class-CSV::Table-label-Mixed+Mode]): + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true).by_col! + # table.mode # => :col + # dup_table = table.by_col_or_row + # dup_table.mode # => :col_or_row + # dup_table.equal?(table) # => false # It's a dup + # + # This may be used to chain method calls without changing the mode + # (but also will affect performance and memory usage): + # dup_table.by_col_or_row['Name'] + # + # Also note that changes to the duplicate table will not affect the original. + # + # source://csv//lib/csv/table.rb#280 + def by_col_or_row; end + + # :call-seq: + # table.by_col_or_row! -> self + # + # Sets the mode for +self+ to mixed mode + # (see {Mixed Mode}[#class-CSV::Table-label-Mixed+Mode]); returns +self+: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true).by_col! + # table.mode # => :col + # table1 = table.by_col_or_row! + # table.mode # => :col_or_row + # table1.equal?(table) # => true # Returned self + # + # source://csv//lib/csv/table.rb#295 + def by_col_or_row!; end + + # :call-seq: + # table.by_row -> table_dup + # + # Returns a duplicate of +self+, in row mode + # (see {Row Mode}[#class-CSV::Table-label-Row+Mode]): + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # table.mode # => :col_or_row + # dup_table = table.by_row + # dup_table.mode # => :row + # dup_table.equal?(table) # => false # It's a dup + # + # This may be used to chain method calls without changing the mode + # (but also will affect performance and memory usage): + # dup_table.by_row[1] + # + # Also note that changes to the duplicate table will not affect the original. + # + # source://csv//lib/csv/table.rb#318 + def by_row; end + + # :call-seq: + # table.by_row! -> self + # + # Sets the mode for +self+ to row mode + # (see {Row Mode}[#class-CSV::Table-label-Row+Mode]); returns +self+: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # table.mode # => :col_or_row + # table1 = table.by_row! + # table.mode # => :row + # table1.equal?(table) # => true # Returned self + # + # source://csv//lib/csv/table.rb#333 + def by_row!; end + + # :call-seq: + # table.delete(*indexes) -> deleted_values + # table.delete(*headers) -> deleted_values + # + # If the access mode is :row or :col_or_row, + # and each argument is either an \Integer or a \Range, + # returns deleted rows. + # Otherwise, returns deleted columns data. + # + # In either case, the returned values are in the order + # specified by the arguments. Arguments may be repeated. + # + # --- + # + # Returns rows as an \Array of \CSV::Row objects. + # + # One index: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # deleted_values = table.delete(0) + # deleted_values # => [#] + # + # Two indexes: + # table = CSV.parse(source, headers: true) + # deleted_values = table.delete(2, 0) + # deleted_values # => [#, #] + # + # --- + # + # Returns columns data as column Arrays. + # + # One header: + # table = CSV.parse(source, headers: true) + # deleted_values = table.delete('Name') + # deleted_values # => ["foo", "bar", "baz"] + # + # Two headers: + # table = CSV.parse(source, headers: true) + # deleted_values = table.delete('Value', 'Name') + # deleted_values # => [["0", "1", "2"], ["foo", "bar", "baz"]] + # + # source://csv//lib/csv/table.rb#834 + def delete(*indexes_or_headers); end + + # :call-seq: + # table.delete_if {|row_or_column| ... } -> self + # + # Removes rows or columns for which the block returns a truthy value; + # returns +self+. + # + # Removes rows when the access mode is :row or :col_or_row; + # calls the block with each \CSV::Row object: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # table.by_row! # => # + # table.size # => 3 + # table.delete_if {|row| row['Name'].start_with?('b') } + # table.size # => 1 + # + # Removes columns when the access mode is :col; + # calls the block with each column as a 2-element array + # containing the header and an \Array of column fields: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # table.by_col! # => # + # table.headers.size # => 2 + # table.delete_if {|column_data| column_data[1].include?('2') } + # table.headers.size # => 1 + # + # Returns a new \Enumerator if no block is given: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # table.delete_if # => #:delete_if> + # + # source://csv//lib/csv/table.rb#887 + def delete_if(&block); end + + # Extracts the nested value specified by the sequence of +index+ or +header+ objects by calling dig at each step, + # returning nil if any intermediate step is nil. + # + # source://csv//lib/csv/table.rb#1021 + def dig(index_or_header, *index_or_headers); end + + # :call-seq: + # table.each {|row_or_column| ... ) -> self + # + # Calls the block with each row or column; returns +self+. + # + # When the access mode is :row or :col_or_row, + # calls the block with each \CSV::Row object: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # table.by_row! # => # + # table.each {|row| p row } + # Output: + # # + # # + # # + # + # When the access mode is :col, + # calls the block with each column as a 2-element array + # containing the header and an \Array of column fields: + # table.by_col! # => # + # table.each {|column_data| p column_data } + # Output: + # ["Name", ["foo", "bar", "baz"]] + # ["Value", ["0", "1", "2"]] + # + # Returns a new \Enumerator if no block is given: + # table.each # => #:each> + # + # source://csv//lib/csv/table.rb#930 + def each(&block); end + + # :call-seq: + # table.headers -> array_of_headers + # + # Returns a new \Array containing the \String headers for the table. + # + # If the table is not empty, returns the headers from the first row: + # rows = [ + # CSV::Row.new(['Foo', 'Bar'], []), + # CSV::Row.new(['FOO', 'BAR'], []), + # CSV::Row.new(['foo', 'bar'], []), + # ] + # table = CSV::Table.new(rows) + # table.headers # => ["Foo", "Bar"] + # table.delete(0) + # table.headers # => ["FOO", "BAR"] + # table.delete(0) + # table.headers # => ["foo", "bar"] + # + # If the table is empty, returns a copy of the headers in the table itself: + # table.delete(0) + # table.headers # => ["Foo", "Bar"] + # + # source://csv//lib/csv/table.rb#360 + def headers; end + + # :call-seq: + # table.inspect => string + # + # Returns a US-ASCII-encoded \String showing table: + # - Class: CSV::Table. + # - Access mode: :row, :col, or :col_or_row. + # - Size: Row count, including the header row. + # + # Example: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # table.inspect # => "#\nName,Value\nfoo,0\nbar,1\nbaz,2\n" + # + # source://csv//lib/csv/table.rb#1048 + def inspect; end + + # The current access mode for indexing and iteration. + # + # source://csv//lib/csv/table.rb#214 + def mode; end + + # :call-seq: + # table.push(*rows_or_arrays) -> self + # + # A shortcut for appending multiple rows. Equivalent to: + # rows.each {|row| self << row } + # + # Each argument may be either a \CSV::Row object or an \Array: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # rows = [ + # CSV::Row.new(table.headers, ['bat', 3]), + # ['bam', 4] + # ] + # table.push(*rows) + # table[3..4] # => [#, #] + # + # source://csv//lib/csv/table.rb#788 + def push(*rows); end + + # :call-seq: + # table.to_a -> array_of_arrays + # + # Returns the table as an \Array of \Arrays; + # the headers are in the first row: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # table.to_a # => [["Name", "Value"], ["foo", "0"], ["bar", "1"], ["baz", "2"]] + # + # source://csv//lib/csv/table.rb#978 + def to_a; end + + # :call-seq: + # table.to_csv(**options) -> csv_string + # + # Returns the table as \CSV string. + # See {Options for Generating}[../CSV.html#class-CSV-label-Options+for+Generating]. + # + # Defaults option +write_headers+ to +true+: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # table.to_csv # => "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # + # Omits the headers if option +write_headers+ is given as +false+ + # (see {Option +write_headers+}[../CSV.html#class-CSV-label-Option+write_headers]): + # table.to_csv(write_headers: false) # => "foo,0\nbar,1\nbaz,2\n" + # + # Limit rows if option +limit+ is given like +2+: + # table.to_csv(limit: 2) # => "Name,Value\nfoo,0\nbar,1\n" + # + # source://csv//lib/csv/table.rb#1004 + def to_csv(write_headers: T.unsafe(nil), limit: T.unsafe(nil), **options); end + + # :call-seq: + # table.to_csv(**options) -> csv_string + # + # Returns the table as \CSV string. + # See {Options for Generating}[../CSV.html#class-CSV-label-Options+for+Generating]. + # + # Defaults option +write_headers+ to +true+: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # table.to_csv # => "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # + # Omits the headers if option +write_headers+ is given as +false+ + # (see {Option +write_headers+}[../CSV.html#class-CSV-label-Option+write_headers]): + # table.to_csv(write_headers: false) # => "foo,0\nbar,1\nbaz,2\n" + # + # Limit rows if option +limit+ is given like +2+: + # table.to_csv(limit: 2) # => "Name,Value\nfoo,0\nbar,1\n" + # + # source://csv//lib/csv/table.rb#1004 + def to_s(write_headers: T.unsafe(nil), limit: T.unsafe(nil), **options); end + + # :call-seq: + # table.values_at(*indexes) -> array_of_rows + # table.values_at(*headers) -> array_of_columns_data + # + # If the access mode is :row or :col_or_row, + # and each argument is either an \Integer or a \Range, + # returns rows. + # Otherwise, returns columns data. + # + # In either case, the returned values are in the order + # specified by the arguments. Arguments may be repeated. + # + # --- + # + # Returns rows as an \Array of \CSV::Row objects. + # + # No argument: + # source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" + # table = CSV.parse(source, headers: true) + # table.values_at # => [] + # + # One index: + # values = table.values_at(0) + # values # => [#] + # + # Two indexes: + # values = table.values_at(2, 0) + # values # => [#, #] + # + # One \Range: + # values = table.values_at(1..2) + # values # => [#, #] + # + # \Ranges and indexes: + # values = table.values_at(0..1, 1..2, 0, 2) + # pp values + # Output: + # [#, + # #, + # #, + # #, + # #, + # #] + # + # --- + # + # Returns columns data as row Arrays, + # each consisting of the specified columns data for that row: + # values = table.values_at('Name') + # values # => [["foo"], ["bar"], ["baz"]] + # values = table.values_at('Value', 'Name') + # values # => [["0", "foo"], ["1", "bar"], ["2", "baz"]] + # + # source://csv//lib/csv/table.rb#734 + def values_at(*indices_or_headers); end + + protected + + # Internal data format used to compare equality. + # + # source://csv//lib/csv/table.rb#217 + def table; end +end + +# Note: Don't use this class directly. This is an internal class. +# +# source://csv//lib/csv/writer.rb#8 +class CSV::Writer + # @return [Writer] a new instance of Writer + # + # source://csv//lib/csv/writer.rb#16 + def initialize(output, options); end + + # Adds a new row + # + # source://csv//lib/csv/writer.rb#31 + def <<(row); end + + # Returns the value of attribute headers. + # + # source://csv//lib/csv/writer.rb#14 + def headers; end + + # A CSV::Writer receives an output, prepares the header, format and output. + # It allows us to write new rows in the object and rewind it. + # + # source://csv//lib/csv/writer.rb#13 + def lineno; end + + # Winds back to the beginning + # + # source://csv//lib/csv/writer.rb#64 + def rewind; end + + private + + # source://csv//lib/csv/writer.rb#70 + def prepare; end + + # source://csv//lib/csv/writer.rb#106 + def prepare_force_quotes_fields(force_quotes); end + + # source://csv//lib/csv/writer.rb#133 + def prepare_format; end + + # source://csv//lib/csv/writer.rb#78 + def prepare_header; end + + # source://csv//lib/csv/writer.rb#163 + def prepare_output; end + + # source://csv//lib/csv/writer.rb#190 + def quote(field, i); end + + # source://csv//lib/csv/writer.rb#181 + def quote_field(field); end +end + +class Object < ::BasicObject + include ::Kernel + include ::PP::ObjectMixin + + private + + # source://csv//lib/csv.rb#2876 + def CSV(*args, **options, &block); end +end + +# source://csv//lib/csv/core_ext/string.rb#1 +class String + include ::Comparable + + # Equivalent to CSV::parse_line(self, options) + # + # "CSV,data".parse_csv + # #=> ["CSV", "data"] + # + # source://csv//lib/csv/core_ext/string.rb#6 + def parse_csv(**options); end +end diff --git a/sorbet/rbi/gems/dalli@3.2.5.rbi b/sorbet/rbi/gems/dalli@3.2.8.rbi similarity index 99% rename from sorbet/rbi/gems/dalli@3.2.5.rbi rename to sorbet/rbi/gems/dalli@3.2.8.rbi index 782e737f7..9d9e527ce 100644 --- a/sorbet/rbi/gems/dalli@3.2.5.rbi +++ b/sorbet/rbi/gems/dalli@3.2.8.rbi @@ -621,7 +621,7 @@ class Dalli::PipelinedGetter def setup_requests(keys); end end -# source://dalli//lib/dalli/protocol.rb#4 +# source://dalli//lib/dalli/protocol.rb#6 module Dalli::Protocol; end # Base class for a single Memcached server, containing logic common to all @@ -1481,18 +1481,18 @@ end # memcached supports the use of base64 hashes for keys containing # whitespace or non-ASCII characters, provided the 'b' flag is included in the request. # -# source://dalli//lib/dalli/protocol/meta/key_regularizer.rb#14 +# source://dalli//lib/dalli/protocol/meta/key_regularizer.rb#12 class Dalli::Protocol::Meta::KeyRegularizer class << self - # source://dalli//lib/dalli/protocol/meta/key_regularizer.rb#23 + # source://dalli//lib/dalli/protocol/meta/key_regularizer.rb#22 def decode(encoded_key, base64_encoded); end - # source://dalli//lib/dalli/protocol/meta/key_regularizer.rb#17 + # source://dalli//lib/dalli/protocol/meta/key_regularizer.rb#15 def encode(key); end end end -# source://dalli//lib/dalli/protocol/meta/key_regularizer.rb#15 +# source://dalli//lib/dalli/protocol/meta/key_regularizer.rb#13 Dalli::Protocol::Meta::KeyRegularizer::WHITESPACE = T.let(T.unsafe(nil), Regexp) # Class that encapsulates logic for formatting meta protocol requests @@ -1682,7 +1682,7 @@ Dalli::Protocol::Meta::TERMINATOR = T.let(T.unsafe(nil), String) # Preserved for backwards compatibility. Should be removed in 4.0 # -# source://dalli//lib/dalli/protocol.rb#6 +# source://dalli//lib/dalli/protocol.rb#8 Dalli::Protocol::NOT_FOUND = T.let(T.unsafe(nil), Dalli::NilObject) # Manages the buffer for responses from memcached. @@ -1785,6 +1785,12 @@ Dalli::Protocol::ServerConfigParser::MEMCACHED_URI_PROTOCOL = T.let(T.unsafe(nil # source://dalli//lib/dalli/protocol/server_config_parser.rb#19 Dalli::Protocol::ServerConfigParser::SERVER_CONFIG_REGEXP = T.let(T.unsafe(nil), Regexp) +# Ruby 3.2 raises IO::TimeoutError on blocking reads/writes, but +# it is not defined in earlier Ruby versions. +# +# source://dalli//lib/dalli/protocol.rb#12 +Dalli::Protocol::TIMEOUT_ERRORS = T.let(T.unsafe(nil), Array) + # Utility class for sanitizing TTL arguments based on Memcached rules. # TTLs are either expirations times in seconds (with a maximum value of # 30 days) or expiration timestamps. This class sanitizes TTLs to ensure @@ -2230,13 +2236,16 @@ class Dalli::Socket::TCP < ::TCPSocket def options=(_arg0); end class << self - # source://dalli//lib/dalli/socket.rb#101 + # source://dalli//lib/dalli/socket.rb#100 + def create_socket_with_timeout(host, port, options); end + + # source://dalli//lib/dalli/socket.rb#119 def init_socket_options(sock, options); end # source://dalli//lib/dalli/socket.rb#91 def open(host, port, options = T.unsafe(nil)); end - # source://dalli//lib/dalli/socket.rb#108 + # source://dalli//lib/dalli/socket.rb#135 def wrapping_ssl_socket(tcp_socket, host, ssl_context); end end end @@ -2245,24 +2254,24 @@ end # mechanism between processes on the same host. Used when the Memcached server # is running on the same machine as the Dalli client. # -# source://dalli//lib/dalli/socket.rb#133 +# source://dalli//lib/dalli/socket.rb#160 class Dalli::Socket::UNIX < ::UNIXSocket include ::Dalli::Socket::InstanceMethods # options - supports enhanced logging in the case of a timeout # server - used to support IO.select in the pipelined getter # - # source://dalli//lib/dalli/socket.rb#138 + # source://dalli//lib/dalli/socket.rb#165 def options; end # options - supports enhanced logging in the case of a timeout # server - used to support IO.select in the pipelined getter # - # source://dalli//lib/dalli/socket.rb#138 + # source://dalli//lib/dalli/socket.rb#165 def options=(_arg0); end class << self - # source://dalli//lib/dalli/socket.rb#140 + # source://dalli//lib/dalli/socket.rb#167 def open(path, options = T.unsafe(nil)); end end end diff --git a/sorbet/rbi/gems/dbf@4.2.4.rbi b/sorbet/rbi/gems/dbf@4.3.2.rbi similarity index 94% rename from sorbet/rbi/gems/dbf@4.2.4.rbi rename to sorbet/rbi/gems/dbf@4.3.2.rbi index 137ac3173..b94a322e6 100644 --- a/sorbet/rbi/gems/dbf@4.2.4.rbi +++ b/sorbet/rbi/gems/dbf@4.3.2.rbi @@ -21,7 +21,7 @@ class DBF::Column # @param decimal [Integer] # @return [Column] a new instance of Column # - # source://dbf//lib/dbf/column.rb#37 + # source://dbf//lib/dbf/column.rb#40 def initialize(table, name, type, length, decimal); end # Returns the value of attribute decimal. @@ -38,7 +38,7 @@ class DBF::Column # # @return [Boolean] # - # source://dbf//lib/dbf/column.rb#53 + # source://dbf//lib/dbf/column.rb#56 def memo?; end # Returns the value of attribute name. @@ -55,7 +55,7 @@ class DBF::Column # # @return [Hash] # - # source://dbf//lib/dbf/column.rb#60 + # source://dbf//lib/dbf/column.rb#63 def to_hash; end # Returns the value of attribute type. @@ -73,34 +73,34 @@ class DBF::Column # # @return [String] # - # source://dbf//lib/dbf/column.rb#70 + # source://dbf//lib/dbf/column.rb#73 def underscored_name; end private - # source://dbf//lib/dbf/column.rb#82 + # source://dbf//lib/dbf/column.rb#80 def clean(value); end - # source://dbf//lib/dbf/column.rb#86 - def encode(value, strip_output = T.unsafe(nil)); end + # source://dbf//lib/dbf/column.rb#84 + def encode(value, strip_output: T.unsafe(nil)); end - # source://dbf//lib/dbf/column.rb#100 + # source://dbf//lib/dbf/column.rb#98 def encode_string(string); end - # source://dbf//lib/dbf/column.rb#93 + # source://dbf//lib/dbf/column.rb#91 def encoding_args; end - # source://dbf//lib/dbf/column.rb#104 + # source://dbf//lib/dbf/column.rb#102 def type_cast_class; end # @raise [LengthError] # - # source://dbf//lib/dbf/column.rb#111 + # source://dbf//lib/dbf/column.rb#109 def validate_length; end # @raise [NameError] # - # source://dbf//lib/dbf/column.rb#115 + # source://dbf//lib/dbf/column.rb#113 def validate_name; end end @@ -110,7 +110,7 @@ class DBF::Column::LengthError < ::StandardError; end # source://dbf//lib/dbf/column.rb#8 class DBF::Column::NameError < ::StandardError; end -# source://dbf//lib/dbf/column.rb#14 +# source://dbf//lib/dbf/column.rb#16 DBF::Column::TYPE_CAST_CLASS = T.let(T.unsafe(nil), Hash) # source://dbf//lib/dbf/column_type.rb#2 @@ -346,35 +346,35 @@ class DBF::FileNotFoundError < ::StandardError; end class DBF::Header # @return [Header] a new instance of Header # - # source://dbf//lib/dbf/header.rb#10 + # source://dbf//lib/dbf/header.rb#5 def initialize(data); end # Returns the value of attribute encoding. # - # source://dbf//lib/dbf/header.rb#8 + # source://dbf//lib/dbf/header.rb#3 def encoding; end # Returns the value of attribute encoding_key. # - # source://dbf//lib/dbf/header.rb#7 + # source://dbf//lib/dbf/header.rb#3 def encoding_key; end # Returns the value of attribute header_length. # - # source://dbf//lib/dbf/header.rb#5 + # source://dbf//lib/dbf/header.rb#3 def header_length; end # Returns the value of attribute record_count. # - # source://dbf//lib/dbf/header.rb#4 + # source://dbf//lib/dbf/header.rb#3 def record_count; end # Returns the value of attribute record_length. # - # source://dbf//lib/dbf/header.rb#6 + # source://dbf//lib/dbf/header.rb#3 def record_length; end - # source://dbf//lib/dbf/header.rb#15 + # source://dbf//lib/dbf/header.rb#10 def unpack_header; end # Returns the value of attribute version. @@ -545,7 +545,7 @@ end # source://dbf//lib/dbf/schema.rb#3 module DBF::Schema # source://dbf//lib/dbf/schema.rb#49 - def activerecord_schema(_table_only = T.unsafe(nil)); end + def activerecord_schema(*_arg0); end # ActiveRecord schema definition # @@ -556,7 +556,7 @@ module DBF::Schema def activerecord_schema_definition(column); end # source://dbf//lib/dbf/schema.rb#73 - def json_schema(_table_only = T.unsafe(nil)); end + def json_schema(*_arg0); end # source://dbf//lib/dbf/schema.rb#104 def number_data_type(column); end @@ -586,7 +586,7 @@ module DBF::Schema # @return [String] # # source://dbf//lib/dbf/schema.rb#38 - def schema(format = T.unsafe(nil), table_only = T.unsafe(nil)); end + def schema(format = T.unsafe(nil), table_only: T.unsafe(nil)); end # source://dbf//lib/dbf/schema.rb#93 def schema_data_type(column, format = T.unsafe(nil)); end @@ -595,7 +595,7 @@ module DBF::Schema def schema_name(format); end # source://dbf//lib/dbf/schema.rb#59 - def sequel_schema(table_only = T.unsafe(nil)); end + def sequel_schema(table_only: T.unsafe(nil)); end # Sequel schema definition # @@ -833,22 +833,22 @@ class DBF::Table # source://dbf//lib/dbf/table.rb#280 def memo_class; end - # source://dbf//lib/dbf/table.rb#290 + # source://dbf//lib/dbf/table.rb#289 def memo_search_path(io); end - # source://dbf//lib/dbf/table.rb#296 + # source://dbf//lib/dbf/table.rb#295 def open_data(data); end - # source://dbf//lib/dbf/table.rb#302 + # source://dbf//lib/dbf/table.rb#301 def open_memo(data, memo = T.unsafe(nil)); end - # source://dbf//lib/dbf/table.rb#312 + # source://dbf//lib/dbf/table.rb#311 def safe_seek; end - # source://dbf//lib/dbf/table.rb#317 + # source://dbf//lib/dbf/table.rb#316 def seek(offset); end - # source://dbf//lib/dbf/table.rb#321 + # source://dbf//lib/dbf/table.rb#320 def seek_to_record(index); end end diff --git a/sorbet/rbi/gems/debug_inspector@1.1.0.rbi b/sorbet/rbi/gems/debug_inspector@1.2.0.rbi similarity index 61% rename from sorbet/rbi/gems/debug_inspector@1.1.0.rbi rename to sorbet/rbi/gems/debug_inspector@1.2.0.rbi index 9e5f0a5dc..d4e06545e 100644 --- a/sorbet/rbi/gems/debug_inspector@1.1.0.rbi +++ b/sorbet/rbi/gems/debug_inspector@1.2.0.rbi @@ -5,8 +5,8 @@ # Please instead update this file by running `bin/tapioca gem debug_inspector`. -# source://debug_inspector//lib/rubyvm/debug_inspector/version.rb#1 -class RubyVM::DebugInspector +# source://debug_inspector//lib/debug_inspector/version.rb#1 +class DebugInspector def backtrace_locations; end def frame_binding(_arg0); end def frame_class(_arg0); end @@ -20,5 +20,8 @@ end # Don't forget to update the version string in the gemspec file. # -# source://debug_inspector//lib/rubyvm/debug_inspector/version.rb#3 -RubyVM::DebugInspector::VERSION = T.let(T.unsafe(nil), String) +# source://debug_inspector//lib/debug_inspector/version.rb#3 +DebugInspector::VERSION = T.let(T.unsafe(nil), String) + +# source://debug_inspector//lib/debug_inspector.rb#20 +RubyVM::DebugInspector = DebugInspector diff --git a/sorbet/rbi/gems/devise@4.9.2.rbi b/sorbet/rbi/gems/devise@4.9.4.rbi similarity index 97% rename from sorbet/rbi/gems/devise@4.9.2.rbi rename to sorbet/rbi/gems/devise@4.9.4.rbi index 4a2b8bbe8..87de91642 100644 --- a/sorbet/rbi/gems/devise@4.9.2.rbi +++ b/sorbet/rbi/gems/devise@4.9.4.rbi @@ -861,7 +861,7 @@ module Devise class << self # @return [Boolean] # - # source://devise//lib/devise.rb#524 + # source://devise//lib/devise.rb#528 def activerecord51?; end # Small method that adds a mapping to Devise. @@ -948,6 +948,9 @@ module Devise # source://devise//lib/devise.rb#209 def default_scope=(val); end + # source://devise//lib/devise.rb#524 + def deprecator; end + # source://devise//lib/devise.rb#117 def email_regexp; end @@ -1346,7 +1349,7 @@ module Devise::Controllers::Helpers # end # end # - # source://devise//lib/devise/controllers/helpers.rb#215 + # source://devise//lib/devise/controllers/helpers.rb#217 def after_sign_in_path_for(resource_or_scope); end # Method used by sessions controller to sign out a user. You can overwrite @@ -1356,12 +1359,12 @@ module Devise::Controllers::Helpers # # By default it is the root_path. # - # source://devise//lib/devise/controllers/helpers.rb#225 + # source://devise//lib/devise/controllers/helpers.rb#227 def after_sign_out_path_for(resource_or_scope); end # Tell warden that params authentication is allowed for that specific page. # - # source://devise//lib/devise/controllers/helpers.rb#163 + # source://devise//lib/devise/controllers/helpers.rb#165 def allow_params_authentication!; end # Return true if it's a devise_controller. false to all controllers unless @@ -1372,20 +1375,20 @@ module Devise::Controllers::Helpers # # @return [Boolean] # - # source://devise//lib/devise/controllers/helpers.rb#151 + # source://devise//lib/devise/controllers/helpers.rb#153 def devise_controller?; end # Set up a param sanitizer to filter parameters using strong_parameters. See # lib/devise/parameter_sanitizer.rb for more info. Override this # method in your application controller to use your own parameter sanitizer. # - # source://devise//lib/devise/controllers/helpers.rb#158 + # source://devise//lib/devise/controllers/helpers.rb#160 def devise_parameter_sanitizer; end # Overwrite Rails' handle unverified request to sign out all scopes, # clear run strategies and remove cached variables. # - # source://devise//lib/devise/controllers/helpers.rb#254 + # source://devise//lib/devise/controllers/helpers.rb#256 def handle_unverified_request; end # Check if flash messages should be emitted. Default is to do it on @@ -1393,44 +1396,44 @@ module Devise::Controllers::Helpers # # @return [Boolean] # - # source://devise//lib/devise/controllers/helpers.rb#270 + # source://devise//lib/devise/controllers/helpers.rb#272 def is_flashing_format?; end # @return [Boolean] # - # source://devise//lib/devise/controllers/helpers.rb#264 + # source://devise//lib/devise/controllers/helpers.rb#266 def is_navigational_format?; end - # source://devise//lib/devise/controllers/helpers.rb#260 + # source://devise//lib/devise/controllers/helpers.rb#262 def request_format; end # Sign in a user and tries to redirect first to the stored location and # then to the url specified by after_sign_in_path_for. It accepts the same # parameters as the sign_in method. # - # source://devise//lib/devise/controllers/helpers.rb#235 + # source://devise//lib/devise/controllers/helpers.rb#237 def sign_in_and_redirect(resource_or_scope, *args); end # Sign out a user and tries to redirect to the url specified by # after_sign_out_path_for. # - # source://devise//lib/devise/controllers/helpers.rb#245 + # source://devise//lib/devise/controllers/helpers.rb#247 def sign_out_and_redirect(resource_or_scope); end # The scope root url to be used when they're signed in. By default, it first # tries to find a resource_root_path, otherwise it uses the root_path. # - # source://devise//lib/devise/controllers/helpers.rb#169 + # source://devise//lib/devise/controllers/helpers.rb#171 def signed_in_root_path(resource_or_scope); end # The main accessor for the warden proxy instance # - # source://devise//lib/devise/controllers/helpers.rb#142 + # source://devise//lib/devise/controllers/helpers.rb#144 def warden; end private - # source://devise//lib/devise/controllers/helpers.rb#276 + # source://devise//lib/devise/controllers/helpers.rb#278 def expire_data_after_sign_out!; end class << self @@ -1458,7 +1461,7 @@ module Devise::Controllers::Helpers # before_action :authenticate_user! # Tell devise to use :user map # before_action :authenticate_admin! # Tell devise to use :admin map # - # source://devise//lib/devise/controllers/helpers.rb#112 + # source://devise//lib/devise/controllers/helpers.rb#113 def define_helpers(mapping); end end end @@ -1489,7 +1492,7 @@ module Devise::Controllers::Helpers::ClassMethods # source://devise//lib/devise/controllers/helpers.rb#39 def devise_group(group_name, opts = T.unsafe(nil)); end - # source://devise//lib/devise/controllers/helpers.rb#82 + # source://devise//lib/devise/controllers/helpers.rb#83 def log_process_action(payload); end end @@ -1543,10 +1546,10 @@ class Devise::Controllers::Responder < ::ActionController::Responder # and/or responders. It won't allow configuring a custom response, but it allows Devise # to use these methods and defaults across the implementation more easily. # - # source://responders/3.1.0/lib/action_controller/responder.rb#123 + # source://responders/3.1.1/lib/action_controller/responder.rb#123 def error_status; end - # source://responders/3.1.0/lib/action_controller/responder.rb#124 + # source://responders/3.1.1/lib/action_controller/responder.rb#124 def redirect_status; end end end @@ -1861,7 +1864,23 @@ class Devise::FailureApp < ::ActionController::Metal include ::ActionController::Redirecting include ::ActionDispatch::Routing::RouteSet::MountedHelpers include ::Devise::Controllers::StoreLocation + include ::ActiveSupport::Callbacks + include ::AbstractController::Callbacks extend ::AbstractController::UrlFor::ClassMethods + extend ::ActiveSupport::Callbacks::ClassMethods + extend ::AbstractController::Callbacks::ClassMethods + + # source://activesupport/7.0.8.4/lib/active_support/callbacks.rb#68 + def __callbacks; end + + # source://activesupport/7.0.8.4/lib/active_support/callbacks.rb#68 + def __callbacks?; end + + # source://activesupport/7.0.8.4/lib/active_support/callbacks.rb#940 + def _process_action_callbacks; end + + # source://activesupport/7.0.8.4/lib/active_support/callbacks.rb#928 + def _run_process_action_callbacks(&block); end # source://actionpack/7.0.8.4/lib/action_dispatch/routing/url_for.rb#95 def default_url_options; end @@ -1875,7 +1894,7 @@ class Devise::FailureApp < ::ActionController::Metal # source://devise//lib/devise/failure_app.rb#19 def flash(*_arg0, **_arg1, &_arg2); end - # source://devise//lib/devise/failure_app.rb#47 + # source://devise//lib/devise/failure_app.rb#52 def http_auth; end # source://activesupport/7.0.8.4/lib/active_support/configurable.rb#113 @@ -1890,18 +1909,18 @@ class Devise::FailureApp < ::ActionController::Metal # source://actionpack/7.0.8.4/lib/action_controller/metal/redirecting.rb#15 def raise_on_open_redirects=(val); end - # source://devise//lib/devise/failure_app.rb#54 + # source://devise//lib/devise/failure_app.rb#59 def recall; end - # source://devise//lib/devise/failure_app.rb#81 + # source://devise//lib/devise/failure_app.rb#86 def redirect; end - # source://devise//lib/devise/failure_app.rb#37 + # source://devise//lib/devise/failure_app.rb#42 def respond; end protected - # source://devise//lib/devise/failure_app.rb#238 + # source://devise//lib/devise/failure_app.rb#247 def attempted_path; end # Choose whether we should respond in an HTTP authentication fashion, @@ -1915,10 +1934,10 @@ class Devise::FailureApp < ::ActionController::Metal # # @return [Boolean] # - # source://devise//lib/devise/failure_app.rb#185 + # source://devise//lib/devise/failure_app.rb#194 def http_auth?; end - # source://devise//lib/devise/failure_app.rb#199 + # source://devise//lib/devise/failure_app.rb#208 def http_auth_body; end # It doesn't make sense to send authenticate headers in AJAX requests @@ -1926,13 +1945,16 @@ class Devise::FailureApp < ::ActionController::Metal # # @return [Boolean] # - # source://devise//lib/devise/failure_app.rb#195 + # source://devise//lib/devise/failure_app.rb#204 def http_auth_header?; end - # source://devise//lib/devise/failure_app.rb#100 + # source://devise//lib/devise/failure_app.rb#124 + def i18n_locale; end + + # source://devise//lib/devise/failure_app.rb#105 def i18n_message(default = T.unsafe(nil)); end - # source://devise//lib/devise/failure_app.rb#96 + # source://devise//lib/devise/failure_app.rb#101 def i18n_options(options); end # Check if flash messages should be emitted. Default is to do it on @@ -1940,46 +1962,46 @@ class Devise::FailureApp < ::ActionController::Metal # # @return [Boolean] # - # source://devise//lib/devise/failure_app.rb#256 + # source://devise//lib/devise/failure_app.rb#265 def is_flashing_format?; end # @return [Boolean] # - # source://devise//lib/devise/failure_app.rb#250 + # source://devise//lib/devise/failure_app.rb#259 def is_navigational_format?; end - # source://devise//lib/devise/failure_app.rb#211 + # source://devise//lib/devise/failure_app.rb#220 def recall_app(app); end - # source://devise//lib/devise/failure_app.rb#119 + # source://devise//lib/devise/failure_app.rb#128 def redirect_url; end - # source://devise//lib/devise/failure_app.rb#264 + # source://devise//lib/devise/failure_app.rb#273 def relative_url_root; end # @return [Boolean] # - # source://devise//lib/devise/failure_app.rb#272 + # source://devise//lib/devise/failure_app.rb#281 def relative_url_root?; end - # source://devise//lib/devise/failure_app.rb#260 + # source://devise//lib/devise/failure_app.rb#269 def request_format; end - # source://devise//lib/devise/failure_app.rb#135 + # source://devise//lib/devise/failure_app.rb#144 def route(scope); end - # source://devise//lib/devise/failure_app.rb#230 + # source://devise//lib/devise/failure_app.rb#239 def scope; end - # source://devise//lib/devise/failure_app.rb#234 + # source://devise//lib/devise/failure_app.rb#243 def scope_class; end - # source://devise//lib/devise/failure_app.rb#139 + # source://devise//lib/devise/failure_app.rb#148 def scope_url; end # @return [Boolean] # - # source://devise//lib/devise/failure_app.rb#173 + # source://devise//lib/devise/failure_app.rb#182 def skip_format?; end # Stores requested URI to redirect the user after signing in. We can't use @@ -1987,42 +2009,57 @@ class Devise::FailureApp < ::ActionController::Metal # authenticated yet, but we still need to store the URI based on scope, so # different scopes would never use the same URI to redirect. # - # source://devise//lib/devise/failure_app.rb#246 + # source://devise//lib/devise/failure_app.rb#255 def store_location!; end - # source://devise//lib/devise/failure_app.rb#218 + # source://devise//lib/devise/failure_app.rb#227 def warden; end - # source://devise//lib/devise/failure_app.rb#226 + # source://devise//lib/devise/failure_app.rb#235 def warden_message; end - # source://devise//lib/devise/failure_app.rb#222 + # source://devise//lib/devise/failure_app.rb#231 def warden_options; end private # @return [Boolean] # - # source://devise//lib/devise/failure_app.rb#284 + # source://devise//lib/devise/failure_app.rb#293 def rails_51_and_up?; end # @return [Boolean] # - # source://devise//lib/devise/failure_app.rb#280 + # source://devise//lib/devise/failure_app.rb#289 def root_path_defined?(context); end class << self + # source://activesupport/7.0.8.4/lib/active_support/callbacks.rb#68 + def __callbacks; end + + # source://activesupport/7.0.8.4/lib/active_support/callbacks.rb#68 + def __callbacks=(value); end + + # source://activesupport/7.0.8.4/lib/active_support/callbacks.rb#68 + def __callbacks?; end + + # source://activesupport/7.0.8.4/lib/active_support/callbacks.rb#932 + def _process_action_callbacks; end + + # source://activesupport/7.0.8.4/lib/active_support/callbacks.rb#936 + def _process_action_callbacks=(value); end + # source://actionpack/7.0.8.4/lib/action_dispatch/routing/route_set.rb#564 def _routes; end - # source://devise//lib/devise/failure_app.rb#21 + # source://devise//lib/devise/failure_app.rb#26 def call(env); end # Try retrieving the URL options from the parent controller (usually # ApplicationController). Instance methods are not supported at the moment, # so only the class-level attribute is used. # - # source://devise//lib/devise/failure_app.rb#29 + # source://devise//lib/devise/failure_app.rb#34 def default_url_options(*args); end # source://actionpack/7.0.8.4/lib/action_dispatch/routing/url_for.rb#95 @@ -2346,11 +2383,11 @@ class Devise::Mapping end end -# source://devise//lib/devise/controllers/helpers.rb#283 +# source://devise//lib/devise/controllers/helpers.rb#285 class Devise::MissingWarden < ::StandardError # @return [MissingWarden] a new instance of MissingWarden # - # source://devise//lib/devise/controllers/helpers.rb#284 + # source://devise//lib/devise/controllers/helpers.rb#286 def initialize; end end diff --git a/sorbet/rbi/gems/docile@1.4.0.rbi b/sorbet/rbi/gems/docile@1.4.1.rbi similarity index 100% rename from sorbet/rbi/gems/docile@1.4.0.rbi rename to sorbet/rbi/gems/docile@1.4.1.rbi diff --git a/sorbet/rbi/gems/domain_name@0.5.20190701.rbi b/sorbet/rbi/gems/domain_name@0.6.20240107.rbi similarity index 84% rename from sorbet/rbi/gems/domain_name@0.5.20190701.rbi rename to sorbet/rbi/gems/domain_name@0.6.20240107.rbi index 28f5e923c..017cf7672 100644 --- a/sorbet/rbi/gems/domain_name@0.5.20190701.rbi +++ b/sorbet/rbi/gems/domain_name@0.6.20240107.rbi @@ -15,25 +15,25 @@ class DomainName # # @return [DomainName] a new instance of DomainName # - # source://domain_name//lib/domain_name.rb#78 + # source://domain_name//lib/domain_name.rb#77 def initialize(hostname); end - # source://domain_name//lib/domain_name.rb#195 + # source://domain_name//lib/domain_name.rb#194 def <(other); end - # source://domain_name//lib/domain_name.rb#217 + # source://domain_name//lib/domain_name.rb#216 def <=(other); end - # source://domain_name//lib/domain_name.rb#179 + # source://domain_name//lib/domain_name.rb#178 def <=>(other); end - # source://domain_name//lib/domain_name.rb#174 + # source://domain_name//lib/domain_name.rb#173 def ==(other); end - # source://domain_name//lib/domain_name.rb#206 + # source://domain_name//lib/domain_name.rb#205 def >(other); end - # source://domain_name//lib/domain_name.rb#228 + # source://domain_name//lib/domain_name.rb#227 def >=(other); end # Returns true if this domain name has a canonical registered @@ -41,14 +41,14 @@ class DomainName # # @return [Boolean] # - # source://domain_name//lib/domain_name.rb#70 + # source://domain_name//lib/domain_name.rb#69 def canonical?; end # Returns true if this domain name has a canonical TLD. # # @return [Boolean] # - # source://domain_name//lib/domain_name.rb#64 + # source://domain_name//lib/domain_name.rb#63 def canonical_tld?; end # Checks if the server represented by this domain is qualified to @@ -59,7 +59,7 @@ class DomainName # # @return [Boolean] # - # source://domain_name//lib/domain_name.rb#150 + # source://domain_name//lib/domain_name.rb#149 def cookie_domain?(domain, host_only = T.unsafe(nil)); end # The least "universally original" domain part of this domain name. @@ -68,10 +68,10 @@ class DomainName # IP address, an effective TLD or higher itself, or of a # non-canonical domain. # - # source://domain_name//lib/domain_name.rb#32 + # source://domain_name//lib/domain_name.rb#31 def domain; end - # source://domain_name//lib/domain_name.rb#256 + # source://domain_name//lib/domain_name.rb#255 def domain_idn; end # The full host name normalized, ASCII-ized and downcased using the @@ -79,21 +79,21 @@ class DomainName # an IP address, the string representation of the IP address # suitable for opening a connection to. # - # source://domain_name//lib/domain_name.rb#21 + # source://domain_name//lib/domain_name.rb#20 def hostname; end - # source://domain_name//lib/domain_name.rb#245 + # source://domain_name//lib/domain_name.rb#244 def hostname_idn; end - # source://domain_name//lib/domain_name.rb#245 + # source://domain_name//lib/domain_name.rb#244 def idn; end - # source://domain_name//lib/domain_name.rb#274 + # source://domain_name//lib/domain_name.rb#273 def inspect; end # Returns an IPAddr object if this is an IP address. # - # source://domain_name//lib/domain_name.rb#50 + # source://domain_name//lib/domain_name.rb#49 def ipaddr; end # Returns true if this is an IP address, such as "192.168.0.1" and @@ -101,12 +101,12 @@ class DomainName # # @return [Boolean] # - # source://domain_name//lib/domain_name.rb#54 + # source://domain_name//lib/domain_name.rb#53 def ipaddr?; end # Returns the superdomain of this domain name. # - # source://domain_name//lib/domain_name.rb#168 + # source://domain_name//lib/domain_name.rb#167 def superdomain; end # The TLD part of this domain name. For example, if the hostname is @@ -115,30 +115,31 @@ class DomainName # does not have one, like when it is an IP address or of a # non-canonical domain. # - # source://domain_name//lib/domain_name.rb#43 + # source://domain_name//lib/domain_name.rb#42 def tld; end - # source://domain_name//lib/domain_name.rb#265 + # source://domain_name//lib/domain_name.rb#264 def tld_idn; end - # source://domain_name//lib/domain_name.rb#239 + # source://domain_name//lib/domain_name.rb#238 def to_s; end - # source://domain_name//lib/domain_name.rb#239 + # source://domain_name//lib/domain_name.rb#238 def to_str; end # Returns a host name representation suitable for use in the host # name part of a URI. A host name, an IPv4 address, or a IPv6 # address enclosed in square brackets. # - # source://domain_name//lib/domain_name.rb#61 + # source://domain_name//lib/domain_name.rb#60 def uri_host; end class << self - # source://domain_name//lib/domain_name/etld_data.rb#8784 + # source://domain_name//lib/domain_name/etld_data.rb#9572 def etld_data; end # Normalizes a _domain_ using the Punycode algorithm as necessary. + # Input must be strictly ASCII-only or unicode. # The result will be a downcased, ASCII-only string. # # source://domain_name//lib/domain_name.rb#288 @@ -146,7 +147,7 @@ class DomainName end end -# source://domain_name//lib/domain_name.rb#74 +# source://domain_name//lib/domain_name.rb#73 DomainName::DOT = T.let(T.unsafe(nil), String) # source://domain_name//lib/domain_name/etld_data.rb#4 @@ -256,6 +257,6 @@ class Object < ::BasicObject private - # source://domain_name//lib/domain_name.rb#295 + # source://domain_name//lib/domain_name.rb#298 def DomainName(hostname); end end diff --git a/sorbet/rbi/gems/dotenv-rails@2.8.1.rbi b/sorbet/rbi/gems/dotenv-rails@2.8.1.rbi deleted file mode 100644 index bcac5fb6d..000000000 --- a/sorbet/rbi/gems/dotenv-rails@2.8.1.rbi +++ /dev/null @@ -1,114 +0,0 @@ -# typed: true - -# DO NOT EDIT MANUALLY -# This is an autogenerated file for types exported from the `dotenv-rails` gem. -# Please instead update this file by running `bin/tapioca gem dotenv-rails`. - - -# source://dotenv-rails//lib/dotenv/rails.rb#32 -module Dotenv - private - - # source://dotenv/2.8.1/lib/dotenv.rb#82 - def ignoring_nonexistent_files; end - - # source://dotenv/2.8.1/lib/dotenv.rb#68 - def instrument(name, payload = T.unsafe(nil), &block); end - - # source://dotenv/2.8.1/lib/dotenv.rb#13 - def load(*filenames); end - - # source://dotenv/2.8.1/lib/dotenv.rb#23 - def load!(*filenames); end - - # source://dotenv/2.8.1/lib/dotenv.rb#31 - def overload(*filenames); end - - # source://dotenv/2.8.1/lib/dotenv.rb#41 - def overload!(*filenames); end - - # source://dotenv/2.8.1/lib/dotenv.rb#49 - def parse(*filenames); end - - # source://dotenv/2.8.1/lib/dotenv.rb#76 - def require_keys(*keys); end - - # source://dotenv/2.8.1/lib/dotenv.rb#60 - def with(*filenames); end - - class << self - # source://dotenv/2.8.1/lib/dotenv.rb#82 - def ignoring_nonexistent_files; end - - # source://dotenv/2.8.1/lib/dotenv.rb#68 - def instrument(name, payload = T.unsafe(nil), &block); end - - # source://dotenv/2.8.1/lib/dotenv.rb#8 - def instrumenter; end - - # source://dotenv/2.8.1/lib/dotenv.rb#8 - def instrumenter=(_arg0); end - - # source://dotenv/2.8.1/lib/dotenv.rb#13 - def load(*filenames); end - - # source://dotenv/2.8.1/lib/dotenv.rb#23 - def load!(*filenames); end - - # source://dotenv/2.8.1/lib/dotenv.rb#31 - def overload(*filenames); end - - # source://dotenv/2.8.1/lib/dotenv.rb#41 - def overload!(*filenames); end - - # source://dotenv/2.8.1/lib/dotenv.rb#49 - def parse(*filenames); end - - # source://dotenv/2.8.1/lib/dotenv.rb#76 - def require_keys(*keys); end - - # source://dotenv/2.8.1/lib/dotenv.rb#60 - def with(*filenames); end - end -end - -# Dotenv Railtie for using Dotenv to load environment from a file into -# Rails applications -# -# source://dotenv-rails//lib/dotenv/rails.rb#35 -class Dotenv::Railtie < ::Rails::Railtie - # Public: Load dotenv - # - # This will get called during the `before_configuration` callback, but you - # can manually call `Dotenv::Railtie.load` if you needed it sooner. - # - # source://dotenv-rails//lib/dotenv/rails.rb#40 - def load; end - - # Public: Reload dotenv - # - # Same as `load`, but will override existing values in `ENV` - # - # source://dotenv-rails//lib/dotenv/rails.rb#47 - def overload; end - - # Internal: `Rails.root` is nil in Rails 4.1 before the application is - # initialized, so this falls back to the `RAILS_ROOT` environment variable, - # or the current working directory. - # - # source://dotenv-rails//lib/dotenv/rails.rb#54 - def root; end - - private - - # source://dotenv-rails//lib/dotenv/rails.rb#66 - def dotenv_files; end - - class << self - # Rails uses `#method_missing` to delegate all class methods to the - # instance, which means `Kernel#load` gets called here. We don't want that. - # - # source://dotenv-rails//lib/dotenv/rails.rb#60 - def load; end - end -end diff --git a/sorbet/rbi/gems/dotenv-rails@3.1.2.rbi b/sorbet/rbi/gems/dotenv-rails@3.1.2.rbi new file mode 100644 index 000000000..ecb79a0b0 --- /dev/null +++ b/sorbet/rbi/gems/dotenv-rails@3.1.2.rbi @@ -0,0 +1,9 @@ +# typed: true + +# DO NOT EDIT MANUALLY +# This is an autogenerated file for types exported from the `dotenv-rails` gem. +# Please instead update this file by running `bin/tapioca gem dotenv-rails`. + + +# THIS IS AN EMPTY RBI FILE. +# see https://github.com/Shopify/tapioca#manually-requiring-parts-of-a-gem diff --git a/sorbet/rbi/gems/dotenv@2.8.1.rbi b/sorbet/rbi/gems/dotenv@2.8.1.rbi deleted file mode 100644 index e92c2f053..000000000 --- a/sorbet/rbi/gems/dotenv@2.8.1.rbi +++ /dev/null @@ -1,235 +0,0 @@ -# typed: true - -# DO NOT EDIT MANUALLY -# This is an autogenerated file for types exported from the `dotenv` gem. -# Please instead update this file by running `bin/tapioca gem dotenv`. - - -# The top level Dotenv module. The entrypoint for the application logic. -# -# source://dotenv//lib/dotenv/substitutions/variable.rb#3 -module Dotenv - private - - # source://dotenv//lib/dotenv.rb#82 - def ignoring_nonexistent_files; end - - # source://dotenv//lib/dotenv.rb#68 - def instrument(name, payload = T.unsafe(nil), &block); end - - # source://dotenv//lib/dotenv.rb#13 - def load(*filenames); end - - # same as `load`, but raises Errno::ENOENT if any files don't exist - # - # source://dotenv//lib/dotenv.rb#23 - def load!(*filenames); end - - # same as `load`, but will override existing values in `ENV` - # - # source://dotenv//lib/dotenv.rb#31 - def overload(*filenames); end - - # same as `overload`, but raises Errno::ENOENT if any files don't exist - # - # source://dotenv//lib/dotenv.rb#41 - def overload!(*filenames); end - - # returns a hash of parsed key/value pairs but does not modify ENV - # - # source://dotenv//lib/dotenv.rb#49 - def parse(*filenames); end - - # source://dotenv//lib/dotenv.rb#76 - def require_keys(*keys); end - - # Internal: Helper to expand list of filenames. - # - # Returns a hash of all the loaded environment variables. - # - # source://dotenv//lib/dotenv.rb#60 - def with(*filenames); end - - class << self - # source://dotenv//lib/dotenv.rb#82 - def ignoring_nonexistent_files; end - - # source://dotenv//lib/dotenv.rb#68 - def instrument(name, payload = T.unsafe(nil), &block); end - - # Returns the value of attribute instrumenter. - # - # source://dotenv//lib/dotenv.rb#8 - def instrumenter; end - - # Sets the attribute instrumenter - # - # @param value the value to set the attribute instrumenter to. - # - # source://dotenv//lib/dotenv.rb#8 - def instrumenter=(_arg0); end - - # source://dotenv//lib/dotenv.rb#13 - def load(*filenames); end - - # same as `load`, but raises Errno::ENOENT if any files don't exist - # - # source://dotenv//lib/dotenv.rb#23 - def load!(*filenames); end - - # same as `load`, but will override existing values in `ENV` - # - # source://dotenv//lib/dotenv.rb#31 - def overload(*filenames); end - - # same as `overload`, but raises Errno::ENOENT if any files don't exist - # - # source://dotenv//lib/dotenv.rb#41 - def overload!(*filenames); end - - # returns a hash of parsed key/value pairs but does not modify ENV - # - # source://dotenv//lib/dotenv.rb#49 - def parse(*filenames); end - - # @raise [MissingKeys] - # - # source://dotenv//lib/dotenv.rb#76 - def require_keys(*keys); end - - # Internal: Helper to expand list of filenames. - # - # Returns a hash of all the loaded environment variables. - # - # source://dotenv//lib/dotenv.rb#60 - def with(*filenames); end - end -end - -# This class inherits from Hash and represents the environment into which -# Dotenv will load key value pairs from a file. -# -# source://dotenv//lib/dotenv/environment.rb#4 -class Dotenv::Environment < ::Hash - # @return [Environment] a new instance of Environment - # - # source://dotenv//lib/dotenv/environment.rb#7 - def initialize(filename, is_load = T.unsafe(nil)); end - - # source://dotenv//lib/dotenv/environment.rb#20 - def apply; end - - # source://dotenv//lib/dotenv/environment.rb#24 - def apply!; end - - # Returns the value of attribute filename. - # - # source://dotenv//lib/dotenv/environment.rb#5 - def filename; end - - # source://dotenv//lib/dotenv/environment.rb#12 - def load(is_load = T.unsafe(nil)); end - - # source://dotenv//lib/dotenv/environment.rb#16 - def read; end -end - -# source://dotenv//lib/dotenv/missing_keys.rb#2 -class Dotenv::Error < ::StandardError; end - -# source://dotenv//lib/dotenv/parser.rb#5 -class Dotenv::FormatError < ::SyntaxError; end - -# source://dotenv//lib/dotenv/missing_keys.rb#4 -class Dotenv::MissingKeys < ::Dotenv::Error - # @return [MissingKeys] a new instance of MissingKeys - # - # source://dotenv//lib/dotenv/missing_keys.rb#5 - def initialize(keys); end -end - -# This class enables parsing of a string for key value pairs to be returned -# and stored in the Environment. It allows for variable substitutions and -# exporting of variables. -# -# source://dotenv//lib/dotenv/parser.rb#10 -class Dotenv::Parser - # @return [Parser] a new instance of Parser - # - # source://dotenv//lib/dotenv/parser.rb#40 - def initialize(string, is_load = T.unsafe(nil)); end - - # source://dotenv//lib/dotenv/parser.rb#46 - def call; end - - private - - # source://dotenv//lib/dotenv/parser.rb#82 - def expand_newlines(value); end - - # source://dotenv//lib/dotenv/parser.rb#62 - def parse_line(line); end - - # source://dotenv//lib/dotenv/parser.rb#70 - def parse_value(value); end - - # source://dotenv//lib/dotenv/parser.rb#100 - def perform_substitutions(value, maybe_quote); end - - # source://dotenv//lib/dotenv/parser.rb#78 - def unescape_characters(value); end - - # source://dotenv//lib/dotenv/parser.rb#90 - def unescape_value(value, maybe_quote); end - - # @return [Boolean] - # - # source://dotenv//lib/dotenv/parser.rb#86 - def variable_not_set?(line); end - - class << self - # source://dotenv//lib/dotenv/parser.rb#35 - def call(string, is_load = T.unsafe(nil)); end - - # Returns the value of attribute substitutions. - # - # source://dotenv//lib/dotenv/parser.rb#33 - def substitutions; end - end -end - -# source://dotenv//lib/dotenv/parser.rb#14 -Dotenv::Parser::LINE = T.let(T.unsafe(nil), Regexp) - -# source://dotenv//lib/dotenv/substitutions/variable.rb#4 -module Dotenv::Substitutions; end - -# Substitute shell commands in a value. -# -# SHA=$(git rev-parse HEAD) -# -# source://dotenv//lib/dotenv/substitutions/command.rb#9 -module Dotenv::Substitutions::Command - class << self - # source://dotenv//lib/dotenv/substitutions/command.rb#23 - def call(value, _env, _is_load); end - end -end - -# Substitute variables in a value. -# -# HOST=example.com -# URL="https://$HOST" -# -# source://dotenv//lib/dotenv/substitutions/variable.rb#10 -module Dotenv::Substitutions::Variable - class << self - # source://dotenv//lib/dotenv/substitutions/variable.rb#21 - def call(value, env, is_load); end - - private - - # source://dotenv//lib/dotenv/substitutions/variable.rb#31 - def substitute(match, variable, env); end - end -end diff --git a/sorbet/rbi/gems/dotenv@3.1.2.rbi b/sorbet/rbi/gems/dotenv@3.1.2.rbi new file mode 100644 index 000000000..11364f386 --- /dev/null +++ b/sorbet/rbi/gems/dotenv@3.1.2.rbi @@ -0,0 +1,441 @@ +# typed: true + +# DO NOT EDIT MANUALLY +# This is an autogenerated file for types exported from the `dotenv` gem. +# Please instead update this file by running `bin/tapioca gem dotenv`. + + +# Shim to load environment variables from `.env files into `ENV`. +# +# source://dotenv//lib/dotenv/version.rb#1 +module Dotenv + extend ::Dotenv + + # Returns the value of attribute instrumenter. + # + # source://dotenv//lib/dotenv.rb#15 + def instrumenter; end + + # Sets the attribute instrumenter + # + # @param value the value to set the attribute instrumenter to. + # + # source://dotenv//lib/dotenv.rb#15 + def instrumenter=(_arg0); end + + # Loads environment variables from one or more `.env` files. See `#parse` for more details. + # + # source://dotenv//lib/dotenv.rb#18 + def load(*filenames, overwrite: T.unsafe(nil), ignore: T.unsafe(nil)); end + + # Same as `#load`, but raises Errno::ENOENT if any files don't exist + # + # source://dotenv//lib/dotenv.rb#27 + def load!(*filenames); end + + # Modify `ENV` for the block and restore it to its previous state afterwards. + # + # Note that the block is synchronized to prevent concurrent modifications to `ENV`, + # so multiple threads will be executed serially. + # + # @param env [Hash] Hash of keys and values to set in `ENV` + # + # source://dotenv//lib/dotenv.rb#116 + def modify(env = T.unsafe(nil), &block); end + + # same as `#load`, but will overwrite existing values in `ENV` + # + # source://dotenv//lib/dotenv.rb#32 + def overload(*filenames); end + + # same as `#overwrite`, but raises Errno::ENOENT if any files don't exist + # + # source://dotenv//lib/dotenv.rb#38 + def overload!(*filenames); end + + # same as `#load`, but will overwrite existing values in `ENV` + # + # source://dotenv//lib/dotenv.rb#32 + def overwrite(*filenames); end + + # same as `#overwrite`, but raises Errno::ENOENT if any files don't exist + # + # source://dotenv//lib/dotenv.rb#38 + def overwrite!(*filenames); end + + # Parses the given files, yielding for each file if a block is given. + # + # @param filenames [String, Array] Files to parse + # @param overwrite [Boolean] Overwrite existing `ENV` values + # @param ignore [Boolean] Ignore non-existent files + # @param block [Proc] Block to yield for each parsed `Dotenv::Environment` + # @return [Hash] parsed key/value pairs + # + # source://dotenv//lib/dotenv.rb#50 + def parse(*filenames, overwrite: T.unsafe(nil), ignore: T.unsafe(nil), &block); end + + # @raise [MissingKeys] + # + # source://dotenv//lib/dotenv.rb#126 + def require_keys(*keys); end + + # Restore `ENV` to a given state + # + # @param env [Hash] Hash of keys and values to restore, defaults to the last saved state + # @param safe [Boolean] Is it safe to modify `ENV`? Defaults to `true` in the main thread, otherwise raises an error. + # + # source://dotenv//lib/dotenv.rb#77 + def restore(env = T.unsafe(nil), safe: T.unsafe(nil)); end + + # Save the current `ENV` to be restored later + # + # source://dotenv//lib/dotenv.rb#67 + def save; end + + # Update `ENV` with the given hash of keys and values + # + # @param env [Hash] Hash of keys and values to set in `ENV` + # @param overwrite [Boolean] Overwrite existing `ENV` values + # + # source://dotenv//lib/dotenv.rb#98 + def update(env = T.unsafe(nil), overwrite: T.unsafe(nil)); end + + private + + # source://dotenv//lib/dotenv.rb#134 + def instrument(name, payload = T.unsafe(nil), &block); end +end + +# A diff between multiple states of ENV. +# +# source://dotenv//lib/dotenv/diff.rb#3 +class Dotenv::Diff + # Create a new diff. If given a block, the state of ENV after the block will be preserved as + # the final state for comparison. Otherwise, the current ENV will be the final state. + # + # @param a [Hash] the initial state, defaults to a snapshot of current ENV + # @param b [Hash] the final state, defaults to the current ENV + # @return [Diff] a new instance of Diff + # @yield [diff] a block to execute before recording the final state + # + # source://dotenv//lib/dotenv/diff.rb#16 + def initialize(a: T.unsafe(nil), b: T.unsafe(nil), &block); end + + # The initial state + # + # source://dotenv//lib/dotenv/diff.rb#5 + def a; end + + # Return a Hash of keys added with their new values + # + # source://dotenv//lib/dotenv/diff.rb#24 + def added; end + + # Returns true if any keys were added, removed, or changed + # + # @return [Boolean] + # + # source://dotenv//lib/dotenv/diff.rb#46 + def any?; end + + # The final or current state + # + # source://dotenv//lib/dotenv/diff.rb#8 + def b; end + + # Returns of Hash of keys changed with an array of their previous and new values + # + # source://dotenv//lib/dotenv/diff.rb#34 + def changed; end + + # Returns a Hash of all added, changed, and removed keys and their new values + # + # source://dotenv//lib/dotenv/diff.rb#41 + def env; end + + # Returns a Hash of keys removed with their previous values + # + # source://dotenv//lib/dotenv/diff.rb#29 + def removed; end + + private + + # source://dotenv//lib/dotenv/diff.rb#52 + def snapshot; end +end + +# A `.env` file that will be read and parsed into a Hash +# +# source://dotenv//lib/dotenv/environment.rb#3 +class Dotenv::Environment < ::Hash + # Create a new Environment + # + # @param filename [String] the path to the file to read + # @param overwrite [Boolean] whether the parser should assume existing values will be overwritten + # @return [Environment] a new instance of Environment + # + # source://dotenv//lib/dotenv/environment.rb#10 + def initialize(filename, overwrite: T.unsafe(nil)); end + + # Returns the value of attribute filename. + # + # source://dotenv//lib/dotenv/environment.rb#4 + def filename; end + + # source://dotenv//lib/dotenv/environment.rb#17 + def load; end + + # Returns the value of attribute overwrite. + # + # source://dotenv//lib/dotenv/environment.rb#4 + def overwrite; end + + # source://dotenv//lib/dotenv/environment.rb#21 + def read; end +end + +# source://dotenv//lib/dotenv/missing_keys.rb#2 +class Dotenv::Error < ::StandardError; end + +# Error raised when encountering a syntax error while parsing a .env file. +# +# source://dotenv//lib/dotenv/parser.rb#6 +class Dotenv::FormatError < ::SyntaxError; end + +# Logs instrumented events +# +# Usage: +# require "active_support/notifications" +# require "dotenv/log_subscriber" +# Dotenv.instrumenter = ActiveSupport::Notifications +# +# source://dotenv//lib/dotenv/log_subscriber.rb#11 +class Dotenv::LogSubscriber < ::ActiveSupport::LogSubscriber + # source://dotenv//lib/dotenv/log_subscriber.rb#18 + def load(event); end + + # source://dotenv//lib/dotenv/log_subscriber.rb#14 + def logger; end + + # source://dotenv//lib/dotenv/log_subscriber.rb#34 + def restore(event); end + + # source://dotenv//lib/dotenv/log_subscriber.rb#30 + def save(event); end + + # source://dotenv//lib/dotenv/log_subscriber.rb#24 + def update(event); end + + private + + # source://dotenv//lib/dotenv/log_subscriber.rb#57 + def color_env_constant; end + + # source://dotenv//lib/dotenv/log_subscriber.rb#49 + def color_filename(filename); end + + # source://dotenv//lib/dotenv/log_subscriber.rb#53 + def color_var(name); end +end + +# source://dotenv//lib/dotenv/missing_keys.rb#4 +class Dotenv::MissingKeys < ::Dotenv::Error + # @return [MissingKeys] a new instance of MissingKeys + # + # source://dotenv//lib/dotenv/missing_keys.rb#5 + def initialize(keys); end +end + +# Parses the `.env` file format into key/value pairs. +# It allows for variable substitutions, command substitutions, and exporting of variables. +# +# source://dotenv//lib/dotenv/parser.rb#10 +class Dotenv::Parser + # @return [Parser] a new instance of Parser + # + # source://dotenv//lib/dotenv/parser.rb#40 + def initialize(string, overwrite: T.unsafe(nil)); end + + # source://dotenv//lib/dotenv/parser.rb#46 + def call; end + + private + + # source://dotenv//lib/dotenv/parser.rb#82 + def expand_newlines(value); end + + # source://dotenv//lib/dotenv/parser.rb#62 + def parse_line(line); end + + # source://dotenv//lib/dotenv/parser.rb#70 + def parse_value(value); end + + # source://dotenv//lib/dotenv/parser.rb#104 + def perform_substitutions(value, maybe_quote); end + + # source://dotenv//lib/dotenv/parser.rb#78 + def unescape_characters(value); end + + # source://dotenv//lib/dotenv/parser.rb#94 + def unescape_value(value, maybe_quote); end + + # @return [Boolean] + # + # source://dotenv//lib/dotenv/parser.rb#90 + def variable_not_set?(line); end + + class << self + # source://dotenv//lib/dotenv/parser.rb#35 + def call(*_arg0, **_arg1, &_arg2); end + + # Returns the value of attribute substitutions. + # + # source://dotenv//lib/dotenv/parser.rb#33 + def substitutions; end + end +end + +# source://dotenv//lib/dotenv/parser.rb#14 +Dotenv::Parser::LINE = T.let(T.unsafe(nil), Regexp) + +# Rails integration for using Dotenv to load ENV variables from a file +# +# source://dotenv//lib/dotenv/rails.rb#25 +class Dotenv::Rails < ::Rails::Railtie + # @return [Rails] a new instance of Rails + # + # source://dotenv//lib/dotenv/rails.rb#28 + def initialize; end + + # source://dotenv//lib/dotenv/rails.rb#26 + def autorestore(*_arg0, **_arg1, &_arg2); end + + # source://dotenv//lib/dotenv/rails.rb#26 + def autorestore=(arg); end + + # source://dotenv//lib/dotenv/rails.rb#86 + def deprecator; end + + # The current environment that the app is running in. + # + # When running `rake`, the Rails application is initialized in development, so we have to + # check which rake tasks are being run to determine the environment. + # + # See https://github.com/bkeepers/dotenv/issues/219 + # + # source://dotenv//lib/dotenv/rails.rb#76 + def env; end + + # source://dotenv//lib/dotenv/rails.rb#26 + def files(*_arg0, **_arg1, &_arg2); end + + # source://dotenv//lib/dotenv/rails.rb#26 + def files=(arg); end + + # Public: Load dotenv + # + # This will get called during the `before_configuration` callback, but you + # can manually call `Dotenv::Rails.load` if you needed it sooner. + # + # source://dotenv//lib/dotenv/rails.rb#48 + def load; end + + # source://dotenv//lib/dotenv/rails.rb#26 + def logger(*_arg0, **_arg1, &_arg2); end + + # Set a new logger and replay logs + # + # source://dotenv//lib/dotenv/rails.rb#65 + def logger=(new_logger); end + + # source://dotenv//lib/dotenv/rails.rb#52 + def overload; end + + # source://dotenv//lib/dotenv/rails.rb#26 + def overwrite(*_arg0, **_arg1, &_arg2); end + + # source://dotenv//lib/dotenv/rails.rb#26 + def overwrite=(arg); end + + # Internal: `Rails.root` is nil in Rails 4.1 before the application is + # initialized, so this falls back to the `RAILS_ROOT` environment variable, + # or the current working directory. + # + # source://dotenv//lib/dotenv/rails.rb#60 + def root; end + + class << self + # Rails uses `#method_missing` to delegate all class methods to the + # instance, which means `Kernel#load` gets called here. We don't want that. + # + # source://dotenv//lib/dotenv/rails.rb#92 + def load; end + end +end + +# source://dotenv//lib/dotenv/rails.rb#84 +Dotenv::Rails::TEST_RAKE_TASKS = T.let(T.unsafe(nil), Regexp) + +# source://dotenv//lib/dotenv/rails.rb#113 +Dotenv::Railtie = Dotenv::Rails + +# A logger that can be used before the apps real logger is initialized. +# +# source://dotenv//lib/dotenv/replay_logger.rb#3 +class Dotenv::ReplayLogger < ::Logger + # @return [ReplayLogger] a new instance of ReplayLogger + # + # source://dotenv//lib/dotenv/replay_logger.rb#4 + def initialize; end + + # Override the add method to store logs so we can replay them to a real logger later. + # + # source://dotenv//lib/dotenv/replay_logger.rb#10 + def add(*args, &block); end + + # Replay the store logs to a real logger. + # + # source://dotenv//lib/dotenv/replay_logger.rb#15 + def replay(logger); end +end + +# An internal monitor to synchronize access to ENV in multi-threaded environments. +# +# source://dotenv//lib/dotenv.rb#12 +Dotenv::SEMAPHORE = T.let(T.unsafe(nil), Monitor) + +# source://dotenv//lib/dotenv/substitutions/variable.rb#4 +module Dotenv::Substitutions; end + +# Substitute shell commands in a value. +# +# SHA=$(git rev-parse HEAD) +# +# source://dotenv//lib/dotenv/substitutions/command.rb#9 +module Dotenv::Substitutions::Command + class << self + # source://dotenv//lib/dotenv/substitutions/command.rb#23 + def call(value, _env, overwrite: T.unsafe(nil)); end + end +end + +# Substitute variables in a value. +# +# HOST=example.com +# URL="https://$HOST" +# +# source://dotenv//lib/dotenv/substitutions/variable.rb#10 +module Dotenv::Substitutions::Variable + class << self + # source://dotenv//lib/dotenv/substitutions/variable.rb#21 + def call(value, env, overwrite: T.unsafe(nil)); end + + private + + # source://dotenv//lib/dotenv/substitutions/variable.rb#31 + def substitute(match, variable, env); end + end +end + +# source://dotenv//lib/dotenv/version.rb#2 +Dotenv::VERSION = T.let(T.unsafe(nil), String) diff --git a/sorbet/rbi/gems/et-orbi@1.2.7.rbi b/sorbet/rbi/gems/et-orbi@1.2.11.rbi similarity index 77% rename from sorbet/rbi/gems/et-orbi@1.2.7.rbi rename to sorbet/rbi/gems/et-orbi@1.2.11.rbi index 15bac9c3e..5608eaee3 100644 --- a/sorbet/rbi/gems/et-orbi@1.2.7.rbi +++ b/sorbet/rbi/gems/et-orbi@1.2.11.rbi @@ -184,22 +184,22 @@ class EtOrbi::EoTime # source://et-orbi//lib/et-orbi/time.rb#67 def initialize(s, zone); end - # source://et-orbi//lib/et-orbi/time.rb#236 + # source://et-orbi//lib/et-orbi/time.rb#251 def +(t); end - # source://et-orbi//lib/et-orbi/time.rb#237 + # source://et-orbi//lib/et-orbi/time.rb#252 def -(t); end - # source://et-orbi//lib/et-orbi/time.rb#229 + # source://et-orbi//lib/et-orbi/time.rb#244 def <(o); end - # source://et-orbi//lib/et-orbi/time.rb#230 + # source://et-orbi//lib/et-orbi/time.rb#245 def <=(o); end - # source://et-orbi//lib/et-orbi/time.rb#231 + # source://et-orbi//lib/et-orbi/time.rb#246 def <=>(o); end - # source://et-orbi//lib/et-orbi/time.rb#206 + # source://et-orbi//lib/et-orbi/time.rb#221 def ==(o); end # Nota Bene: @@ -211,13 +211,13 @@ class EtOrbi::EoTime # The eql? method returns true if obj and other refer to the same hash key. # This is used by Hash to test members for equality. # - # source://et-orbi//lib/et-orbi/time.rb#227 + # source://et-orbi//lib/et-orbi/time.rb#242 def >(o); end - # source://et-orbi//lib/et-orbi/time.rb#228 + # source://et-orbi//lib/et-orbi/time.rb#243 def >=(o); end - # source://et-orbi//lib/et-orbi/time.rb#233 + # source://et-orbi//lib/et-orbi/time.rb#248 def add(t); end # Returns true if this EoTime instance corresponds to 2 different UTC @@ -228,71 +228,78 @@ class EtOrbi::EoTime # # @return [Boolean] # - # source://et-orbi//lib/et-orbi/time.rb#113 + # source://et-orbi//lib/et-orbi/time.rb#128 def ambiguous?; end - # source://et-orbi//lib/et-orbi/time.rb#203 + # source://et-orbi//lib/et-orbi/time.rb#218 def asctime; end - # source://et-orbi//lib/et-orbi/time.rb#203 + # source://et-orbi//lib/et-orbi/time.rb#409 + def clone; end + + # source://et-orbi//lib/et-orbi/time.rb#218 def day; end # Returns this ::EtOrbi::EoTime as a ::Time instance # in the current UTC timezone. # - # source://et-orbi//lib/et-orbi/time.rb#127 + # source://et-orbi//lib/et-orbi/time.rb#142 def getgm; end # Returns this ::EtOrbi::EoTime as a ::Time instance # in the current UTC timezone. # - # source://et-orbi//lib/et-orbi/time.rb#127 + # source://et-orbi//lib/et-orbi/time.rb#142 def getutc; end - # source://et-orbi//lib/et-orbi/time.rb#203 + # source://et-orbi//lib/et-orbi/time.rb#218 def hour; end - # source://et-orbi//lib/et-orbi/time.rb#319 + # source://et-orbi//lib/et-orbi/time.rb#339 def in_time_zone(zone = T.unsafe(nil)); end - # source://et-orbi//lib/et-orbi/time.rb#302 + # source://et-orbi//lib/et-orbi/time.rb#317 def inc(t, dir = T.unsafe(nil)); end # @return [Boolean] # - # source://et-orbi//lib/et-orbi/time.rb#174 + # source://et-orbi//lib/et-orbi/time.rb#189 def is_dst?; end # @return [Boolean] # - # source://et-orbi//lib/et-orbi/time.rb#174 + # source://et-orbi//lib/et-orbi/time.rb#189 def isdst; end - # source://et-orbi//lib/et-orbi/time.rb#277 + # source://et-orbi//lib/et-orbi/time.rb#292 def iso8601(fraction_digits = T.unsafe(nil)); end - # source://et-orbi//lib/et-orbi/time.rb#319 + # source://et-orbi//lib/et-orbi/time.rb#339 def localtime(zone = T.unsafe(nil)); end - # source://et-orbi//lib/et-orbi/time.rb#203 + # source://et-orbi//lib/et-orbi/time.rb#218 def min; end - # source://et-orbi//lib/et-orbi/time.rb#203 + # source://et-orbi//lib/et-orbi/time.rb#218 def month; end - # source://et-orbi//lib/et-orbi/time.rb#242 + # source://et-orbi//lib/et-orbi/time.rb#257 def monthdays; end - # source://et-orbi//lib/et-orbi/time.rb#339 + # "reference week", used in fugit for cron modulo notation + # + # source://et-orbi//lib/et-orbi/time.rb#367 def rday; end - # source://et-orbi//lib/et-orbi/time.rb#345 + # source://et-orbi//lib/et-orbi/time.rb#377 def reach(points); end - # source://et-orbi//lib/et-orbi/time.rb#333 + # "reference week", used in fugit for cron modulo notation + # + # source://et-orbi//lib/et-orbi/time.rb#355 def rweek; end - # source://et-orbi//lib/et-orbi/time.rb#203 + # source://et-orbi//lib/et-orbi/time.rb#218 def sec; end # instance methods @@ -300,22 +307,22 @@ class EtOrbi::EoTime # source://et-orbi//lib/et-orbi/time.rb#64 def seconds; end - # source://et-orbi//lib/et-orbi/time.rb#95 + # source://et-orbi//lib/et-orbi/time.rb#103 def seconds=(f); end - # source://et-orbi//lib/et-orbi/time.rb#155 + # source://et-orbi//lib/et-orbi/time.rb#170 def strftime(format); end - # source://et-orbi//lib/et-orbi/time.rb#234 + # source://et-orbi//lib/et-orbi/time.rb#249 def subtract(t); end - # source://et-orbi//lib/et-orbi/time.rb#180 + # source://et-orbi//lib/et-orbi/time.rb#195 def to_debug_s; end - # source://et-orbi//lib/et-orbi/time.rb#145 + # source://et-orbi//lib/et-orbi/time.rb#160 def to_f; end - # source://et-orbi//lib/et-orbi/time.rb#150 + # source://et-orbi//lib/et-orbi/time.rb#165 def to_i; end # Returns this ::EtOrbi::EoTime as a ::Time instance @@ -323,10 +330,10 @@ class EtOrbi::EoTime # # Has a #to_t alias. # - # source://et-orbi//lib/et-orbi/time.rb#167 + # source://et-orbi//lib/et-orbi/time.rb#182 def to_local_time; end - # source://et-orbi//lib/et-orbi/time.rb#267 + # source://et-orbi//lib/et-orbi/time.rb#282 def to_s; end # Returns this ::EtOrbi::EoTime as a ::Time instance @@ -334,37 +341,42 @@ class EtOrbi::EoTime # # Has a #to_t alias. # - # source://et-orbi//lib/et-orbi/time.rb#167 + # source://et-orbi//lib/et-orbi/time.rb#182 def to_t; end - # source://et-orbi//lib/et-orbi/time.rb#297 + # source://et-orbi//lib/et-orbi/time.rb#312 def to_time_s; end # Debug current time by showing local time / delta / utc time # for example: "0120-7(0820)" # - # source://et-orbi//lib/et-orbi/time.rb#286 + # source://et-orbi//lib/et-orbi/time.rb#301 def to_utc_comparison_s; end # Returns this ::EtOrbi::EoTime as a ::Time instance # in the current UTC timezone. # - # source://et-orbi//lib/et-orbi/time.rb#127 + # source://et-orbi//lib/et-orbi/time.rb#142 def to_utc_time; end - # source://et-orbi//lib/et-orbi/time.rb#272 + # source://et-orbi//lib/et-orbi/time.rb#287 def to_zs; end - # source://et-orbi//lib/et-orbi/time.rb#319 + # Nullify the "caches" used by #to_time, #rweek, and others + # + # source://et-orbi//lib/et-orbi/time.rb#96 + def touch; end + + # source://et-orbi//lib/et-orbi/time.rb#339 def translate(zone = T.unsafe(nil)); end - # source://et-orbi//lib/et-orbi/time.rb#203 + # source://et-orbi//lib/et-orbi/time.rb#218 def usec; end # Returns this ::EtOrbi::EoTime as a ::Time instance # in the current UTC timezone. # - # source://et-orbi//lib/et-orbi/time.rb#127 + # source://et-orbi//lib/et-orbi/time.rb#142 def utc; end # Returns true if this ::EtOrbi::EoTime instance timezone is UTC. @@ -372,22 +384,22 @@ class EtOrbi::EoTime # # @return [Boolean] # - # source://et-orbi//lib/et-orbi/time.rb#135 + # source://et-orbi//lib/et-orbi/time.rb#150 def utc?; end - # source://et-orbi//lib/et-orbi/time.rb#195 + # source://et-orbi//lib/et-orbi/time.rb#210 def utc_offset; end - # source://et-orbi//lib/et-orbi/time.rb#203 + # source://et-orbi//lib/et-orbi/time.rb#218 def wday; end - # source://et-orbi//lib/et-orbi/time.rb#327 + # source://et-orbi//lib/et-orbi/time.rb#347 def wday_in_month; end - # source://et-orbi//lib/et-orbi/time.rb#203 + # source://et-orbi//lib/et-orbi/time.rb#218 def yday; end - # source://et-orbi//lib/et-orbi/time.rb#203 + # source://et-orbi//lib/et-orbi/time.rb#218 def year; end # Returns the value of attribute zone. @@ -395,18 +407,18 @@ class EtOrbi::EoTime # source://et-orbi//lib/et-orbi/time.rb#65 def zone; end - # source://et-orbi//lib/et-orbi/time.rb#101 + # source://et-orbi//lib/et-orbi/time.rb#112 def zone=(z); end protected - # source://et-orbi//lib/et-orbi/time.rb#428 + # source://et-orbi//lib/et-orbi/time.rb#465 def _to_f(o); end - # source://et-orbi//lib/et-orbi/time.rb#389 + # source://et-orbi//lib/et-orbi/time.rb#426 def count_weeks(start, dir); end - # source://et-orbi//lib/et-orbi/time.rb#402 + # source://et-orbi//lib/et-orbi/time.rb#439 def strfz(code); end # Returns a Ruby Time instance. @@ -414,7 +426,7 @@ class EtOrbi::EoTime # Warning: the timezone of that Time instance will be UTC when used with # TZInfo < 2.0.0. # - # source://et-orbi//lib/et-orbi/time.rb#384 + # source://et-orbi//lib/et-orbi/time.rb#421 def to_time; end class << self @@ -444,10 +456,10 @@ class EtOrbi::EoTime end end -# source://et-orbi//lib/et-orbi/time.rb#239 +# source://et-orbi//lib/et-orbi/time.rb#254 EtOrbi::EoTime::DAY_S = T.let(T.unsafe(nil), Integer) -# source://et-orbi//lib/et-orbi/time.rb#240 +# source://et-orbi//lib/et-orbi/time.rb#255 EtOrbi::EoTime::WEEK_S = T.let(T.unsafe(nil), Integer) # source://et-orbi//lib/et-orbi.rb#16 diff --git a/sorbet/rbi/gems/factory_bot@6.2.1.rbi b/sorbet/rbi/gems/factory_bot@6.4.6.rbi similarity index 94% rename from sorbet/rbi/gems/factory_bot@6.2.1.rbi rename to sorbet/rbi/gems/factory_bot@6.4.6.rbi index ec6adc716..fca748498 100644 --- a/sorbet/rbi/gems/factory_bot@6.2.1.rbi +++ b/sorbet/rbi/gems/factory_bot@6.4.6.rbi @@ -693,21 +693,21 @@ class FactoryBot::Decorator < ::BasicObject # source://factory_bot//lib/factory_bot/decorator.rb#5 def initialize(component); end - # source://factory_bot//lib/factory_bot/decorator.rb#11 + # source://factory_bot//lib/factory_bot/decorator.rb#9 def method_missing(*_arg0, **_arg1, &_arg2); end - # source://factory_bot//lib/factory_bot/decorator.rb#15 + # source://factory_bot//lib/factory_bot/decorator.rb#13 def send(*_arg0, **_arg1, &_arg2); end private # @return [Boolean] # - # source://factory_bot//lib/factory_bot/decorator.rb#29 + # source://factory_bot//lib/factory_bot/decorator.rb#17 def respond_to_missing?(name, include_private = T.unsafe(nil)); end class << self - # source://factory_bot//lib/factory_bot/decorator.rb#33 + # source://factory_bot//lib/factory_bot/decorator.rb#21 def const_missing(name); end end end @@ -761,52 +761,52 @@ class FactoryBot::Definition # @api private # @return [Definition] a new instance of Definition # - # source://factory_bot//lib/factory_bot/definition.rb#6 + # source://factory_bot//lib/factory_bot/definition.rb#7 def initialize(name, base_traits = T.unsafe(nil)); end # @api private # - # source://factory_bot//lib/factory_bot/definition.rb#76 + # source://factory_bot//lib/factory_bot/definition.rb#86 def add_callback(callback); end # @api private # - # source://factory_bot//lib/factory_bot/definition.rb#100 + # source://factory_bot//lib/factory_bot/definition.rb#110 def after(*names, &block); end # @api private # - # source://factory_bot//lib/factory_bot/definition.rb#72 + # source://factory_bot//lib/factory_bot/definition.rb#82 def append_traits(new_traits); end # @api private # - # source://factory_bot//lib/factory_bot/definition.rb#23 + # source://factory_bot//lib/factory_bot/definition.rb#24 def attributes; end # @api private # - # source://factory_bot//lib/factory_bot/definition.rb#96 + # source://factory_bot//lib/factory_bot/definition.rb#106 def before(*names, &block); end # @api private # - # source://factory_bot//lib/factory_bot/definition.rb#104 + # source://factory_bot//lib/factory_bot/definition.rb#114 def callback(*names, &block); end # @api private # - # source://factory_bot//lib/factory_bot/definition.rb#44 + # source://factory_bot//lib/factory_bot/definition.rb#45 def callbacks; end # @api private # - # source://factory_bot//lib/factory_bot/definition.rb#48 + # source://factory_bot//lib/factory_bot/definition.rb#49 def compile(klass = T.unsafe(nil)); end # @api private # - # source://factory_bot//lib/factory_bot/definition.rb#40 + # source://factory_bot//lib/factory_bot/definition.rb#41 def constructor; end # @api private @@ -814,17 +814,17 @@ class FactoryBot::Definition # source://factory_bot//lib/factory_bot/definition.rb#4 def declarations; end - # source://factory_bot//lib/factory_bot/definition.rb#21 + # source://factory_bot//lib/factory_bot/definition.rb#22 def declare_attribute(*_arg0, **_arg1, &_arg2); end # @api private # - # source://factory_bot//lib/factory_bot/definition.rb#92 + # source://factory_bot//lib/factory_bot/definition.rb#102 def define_constructor(&block); end # @api private # - # source://factory_bot//lib/factory_bot/definition.rb#84 + # source://factory_bot//lib/factory_bot/definition.rb#94 def define_trait(trait); end # @api private @@ -834,9 +834,19 @@ class FactoryBot::Definition # @api private # - # source://factory_bot//lib/factory_bot/definition.rb#68 + # source://factory_bot//lib/factory_bot/definition.rb#78 def inherit_traits(new_traits); end + # @api private + # + # source://factory_bot//lib/factory_bot/definition.rb#5 + def klass; end + + # @api private + # + # source://factory_bot//lib/factory_bot/definition.rb#5 + def klass=(_arg0); end + # @api private # # source://factory_bot//lib/factory_bot/definition.rb#4 @@ -844,12 +854,12 @@ class FactoryBot::Definition # @api private # - # source://factory_bot//lib/factory_bot/definition.rb#63 + # source://factory_bot//lib/factory_bot/definition.rb#73 def overridable; end # @api private # - # source://factory_bot//lib/factory_bot/definition.rb#88 + # source://factory_bot//lib/factory_bot/definition.rb#98 def register_enum(enum); end # @api private @@ -859,65 +869,65 @@ class FactoryBot::Definition # @api private # - # source://factory_bot//lib/factory_bot/definition.rb#80 + # source://factory_bot//lib/factory_bot/definition.rb#90 def skip_create; end # @api private # - # source://factory_bot//lib/factory_bot/definition.rb#32 + # source://factory_bot//lib/factory_bot/definition.rb#33 def to_create(&block); end private # @api private # - # source://factory_bot//lib/factory_bot/definition.rb#130 + # source://factory_bot//lib/factory_bot/definition.rb#151 def additional_traits; end # @api private # - # source://factory_bot//lib/factory_bot/definition.rb#150 + # source://factory_bot//lib/factory_bot/definition.rb#171 def aggregate_from_traits_and_self(method_name, &block); end # @api private # - # source://factory_bot//lib/factory_bot/definition.rb#175 + # source://factory_bot//lib/factory_bot/definition.rb#196 def automatically_register_defined_enums(klass); end # @api private # @return [Boolean] # - # source://factory_bot//lib/factory_bot/definition.rb#179 + # source://factory_bot//lib/factory_bot/definition.rb#200 def automatically_register_defined_enums?(klass); end # @api private # - # source://factory_bot//lib/factory_bot/definition.rb#112 + # source://factory_bot//lib/factory_bot/definition.rb#122 def base_traits; end # @api private # - # source://factory_bot//lib/factory_bot/definition.rb#118 + # source://factory_bot//lib/factory_bot/definition.rb#131 def error_with_definition_name(error); end # @api private # - # source://factory_bot//lib/factory_bot/definition.rb#160 + # source://factory_bot//lib/factory_bot/definition.rb#181 def expand_enum_traits(klass); end # @api private # - # source://factory_bot//lib/factory_bot/definition.rb#143 + # source://factory_bot//lib/factory_bot/definition.rb#164 def initialize_copy(source); end # @api private # - # source://factory_bot//lib/factory_bot/definition.rb#134 + # source://factory_bot//lib/factory_bot/definition.rb#155 def trait_by_name(name); end # @api private # - # source://factory_bot//lib/factory_bot/definition.rb#138 + # source://factory_bot//lib/factory_bot/definition.rb#159 def trait_for(name); end end @@ -1073,7 +1083,7 @@ class FactoryBot::DefinitionProxy # Except that no globally available sequence will be defined. # # source://factory_bot//lib/factory_bot/definition_proxy.rb#122 - def sequence(name, *args, &block); end + def sequence(name, *_arg1, **_arg2, &_arg3); end # @raise [FactoryBot::MethodDefinitionError] # @@ -1200,25 +1210,23 @@ class FactoryBot::Enum def enum_values(klass); end end -# source://factory_bot//lib/factory_bot/evaluation.rb#4 +# source://factory_bot//lib/factory_bot/evaluation.rb#2 class FactoryBot::Evaluation - include ::Observable - # @return [Evaluation] a new instance of Evaluation # - # source://factory_bot//lib/factory_bot/evaluation.rb#7 - def initialize(evaluator, attribute_assigner, to_create); end + # source://factory_bot//lib/factory_bot/evaluation.rb#3 + def initialize(evaluator, attribute_assigner, to_create, observer); end - # source://factory_bot//lib/factory_bot/evaluation.rb#15 + # source://factory_bot//lib/factory_bot/evaluation.rb#12 def create(result_instance); end - # source://factory_bot//lib/factory_bot/evaluation.rb#13 + # source://factory_bot//lib/factory_bot/evaluation.rb#10 def hash(*_arg0, **_arg1, &_arg2); end - # source://factory_bot//lib/factory_bot/evaluation.rb#22 + # source://factory_bot//lib/factory_bot/evaluation.rb#19 def notify(name, result_instance); end - # source://factory_bot//lib/factory_bot/evaluation.rb#13 + # source://factory_bot//lib/factory_bot/evaluation.rb#10 def object(*_arg0, **_arg1, &_arg2); end end @@ -1234,7 +1242,7 @@ class FactoryBot::Evaluator # @api private # - # source://factory_bot//lib/factory_bot/evaluator.rb#51 + # source://factory_bot//lib/factory_bot/evaluator.rb#50 def __override_names__; end # @api private @@ -1253,7 +1261,7 @@ class FactoryBot::Evaluator # @api private # - # source://factory_bot//lib/factory_bot/evaluator.rb#55 + # source://factory_bot//lib/factory_bot/evaluator.rb#54 def increment_sequence(sequence); end # @api private @@ -1269,20 +1277,20 @@ class FactoryBot::Evaluator # @api private # # source://factory_bot//lib/factory_bot/evaluator.rb#38 - def method_missing(method_name, *args, **_arg2, &block); end + def method_missing(method_name, *_arg1, **_arg2, &_arg3); end private # @api private # @return [Boolean] # - # source://factory_bot//lib/factory_bot/evaluator.rb#47 + # source://factory_bot//lib/factory_bot/evaluator.rb#46 def respond_to_missing?(method_name, _include_private = T.unsafe(nil)); end class << self # @api private # - # source://factory_bot//lib/factory_bot/evaluator.rb#59 + # source://factory_bot//lib/factory_bot/evaluator.rb#58 def attribute_list; end # source://factory_bot//lib/factory_bot/evaluator.rb#7 @@ -1296,7 +1304,7 @@ class FactoryBot::Evaluator # @api private # - # source://factory_bot//lib/factory_bot/evaluator.rb#67 + # source://factory_bot//lib/factory_bot/evaluator.rb#66 def define_attribute(name, &block); end end end @@ -1604,7 +1612,7 @@ module FactoryBot::Internal # @api private # # source://factory_bot//lib/factory_bot/internal.rb#42 - def trait_by_name(name); end + def trait_by_name(name, klass); end # source://factory_bot//lib/factory_bot/internal.rb#5 def traits(*_arg0, **_arg1, &_arg2); end @@ -1811,6 +1819,9 @@ class FactoryBot::Registry # source://factory_bot//lib/factory_bot/registry.rb#40 def key_error_with_custom_message(key_error); end + + # source://factory_bot//lib/factory_bot/registry.rb#50 + def new_key_error(message, key_error); end end # Sequences are defined using sequence within a FactoryBot.define block. @@ -1954,33 +1965,38 @@ class FactoryBot::Strategy::Stub private - # source://factory_bot//lib/factory_bot/strategy/stub.rb#86 + # source://factory_bot//lib/factory_bot/strategy/stub.rb#98 def clear_changes_information(result_instance); end # @return [Boolean] # - # source://factory_bot//lib/factory_bot/strategy/stub.rb#81 + # source://factory_bot//lib/factory_bot/strategy/stub.rb#85 def has_settable_id?(result_instance); end # @return [Boolean] # - # source://factory_bot//lib/factory_bot/strategy/stub.rb#102 + # source://factory_bot//lib/factory_bot/strategy/stub.rb#114 def missing_created_at?(result_instance); end # @return [Boolean] # - # source://factory_bot//lib/factory_bot/strategy/stub.rb#108 + # source://factory_bot//lib/factory_bot/strategy/stub.rb#120 def missing_updated_at?(result_instance); end # source://factory_bot//lib/factory_bot/strategy/stub.rb#50 - def next_id; end + def next_id(result_instance); end - # source://factory_bot//lib/factory_bot/strategy/stub.rb#92 + # source://factory_bot//lib/factory_bot/strategy/stub.rb#104 def set_timestamps(result_instance); end - # source://factory_bot//lib/factory_bot/strategy/stub.rb#54 + # source://factory_bot//lib/factory_bot/strategy/stub.rb#58 def stub_database_interaction_on_result(result_instance); end + # @return [Boolean] + # + # source://factory_bot//lib/factory_bot/strategy/stub.rb#91 + def uuid_primary_key?(result_instance); end + class << self # source://factory_bot//lib/factory_bot/strategy/stub.rb#27 def next_id=(id); end @@ -2096,7 +2112,7 @@ class FactoryBot::Syntax::Default::DSL def initialize_with(*_arg0, **_arg1, &_arg2); end # source://factory_bot//lib/factory_bot/syntax/default.rb#28 - def sequence(name, *args, &block); end + def sequence(name, *_arg1, **_arg2, &_arg3); end # source://factory_bot//lib/factory_bot/syntax/default.rb#40 def skip_create(*_arg0, **_arg1, &_arg2); end @@ -2325,6 +2341,12 @@ class FactoryBot::Trait # source://factory_bot//lib/factory_bot/trait.rb#4 def definition; end + # source://factory_bot//lib/factory_bot/trait.rb#17 + def klass(*_arg0, **_arg1, &_arg2); end + + # source://factory_bot//lib/factory_bot/trait.rb#17 + def klass=(arg); end + # @api private # # source://factory_bot//lib/factory_bot/trait.rb#4 diff --git a/sorbet/rbi/gems/factory_bot_rails@6.2.0.rbi b/sorbet/rbi/gems/factory_bot_rails@6.4.3.rbi similarity index 85% rename from sorbet/rbi/gems/factory_bot_rails@6.2.0.rbi rename to sorbet/rbi/gems/factory_bot_rails@6.4.3.rbi index dff55f697..95fc73e31 100644 --- a/sorbet/rbi/gems/factory_bot_rails@6.2.0.rbi +++ b/sorbet/rbi/gems/factory_bot_rails@6.4.3.rbi @@ -27,6 +27,25 @@ class FactoryBotRails::DefinitionFilePaths def files; end end +# source://factory_bot_rails//lib/factory_bot_rails/factory_validator.rb#2 +class FactoryBotRails::FactoryValidator + # @return [FactoryValidator] a new instance of FactoryValidator + # + # source://factory_bot_rails//lib/factory_bot_rails/factory_validator.rb#3 + def initialize(validators = T.unsafe(nil)); end + + # source://factory_bot_rails//lib/factory_bot_rails/factory_validator.rb#7 + def add_validator(validator); end + + # source://factory_bot_rails//lib/factory_bot_rails/factory_validator.rb#11 + def run; end + + private + + # source://factory_bot_rails//lib/factory_bot_rails/factory_validator.rb#17 + def validate_compiled_factory; end +end + # source://factory_bot_rails//lib/factory_bot_rails/generator.rb#6 class FactoryBotRails::Generator # @return [Generator] a new instance of Generator @@ -76,7 +95,7 @@ class FactoryBotRails::Generators::NullGenerator # @return [NullGenerator] a new instance of NullGenerator # # source://factory_bot_rails//lib/factory_bot_rails/generators/null_generator.rb#4 - def initialize(generators); end + def initialize(*_arg0); end # source://factory_bot_rails//lib/factory_bot_rails/generators/null_generator.rb#7 def run; end @@ -104,11 +123,11 @@ class FactoryBotRails::Generators::RSpecGenerator def fixture_replacement_setting; end end -# source://factory_bot_rails//lib/factory_bot_rails/railtie.rb#9 +# source://factory_bot_rails//lib/factory_bot_rails/railtie.rb#10 class FactoryBotRails::Railtie < ::Rails::Railtie private - # source://factory_bot_rails//lib/factory_bot_rails/railtie.rb#28 + # source://factory_bot_rails//lib/factory_bot_rails/railtie.rb#31 def definition_file_paths; end end diff --git a/sorbet/rbi/gems/foreman@0.87.2.rbi b/sorbet/rbi/gems/foreman@0.88.1.rbi similarity index 100% rename from sorbet/rbi/gems/foreman@0.87.2.rbi rename to sorbet/rbi/gems/foreman@0.88.1.rbi diff --git a/sorbet/rbi/gems/fugit@1.8.1.rbi b/sorbet/rbi/gems/fugit@1.11.0.rbi similarity index 79% rename from sorbet/rbi/gems/fugit@1.8.1.rbi rename to sorbet/rbi/gems/fugit@1.11.0.rbi index 38202da65..2105eff52 100644 --- a/sorbet/rbi/gems/fugit@1.8.1.rbi +++ b/sorbet/rbi/gems/fugit@1.11.0.rbi @@ -8,7 +8,7 @@ # source://fugit//lib/fugit.rb#4 module Fugit class << self - # source://fugit//lib/fugit/parse.rb#49 + # source://fugit//lib/fugit/parse.rb#66 def determine_type(s); end # source://fugit//lib/fugit/parse.rb#30 @@ -20,7 +20,7 @@ module Fugit # source://fugit//lib/fugit/parse.rb#13 def do_parse_cron(s); end - # source://fugit//lib/fugit/parse.rb#43 + # source://fugit//lib/fugit/parse.rb#60 def do_parse_cronish(s, opts = T.unsafe(nil)); end # source://fugit//lib/fugit/parse.rb#14 @@ -44,7 +44,7 @@ module Fugit # source://fugit//lib/fugit/parse.rb#7 def parse_cron(s); end - # source://fugit//lib/fugit/parse.rb#36 + # source://fugit//lib/fugit/parse.rb#53 def parse_cronish(s, opts = T.unsafe(nil)); end # source://fugit//lib/fugit/parse.rb#8 @@ -80,7 +80,7 @@ end # source://fugit//lib/fugit/cron.rb#5 class Fugit::Cron - # source://fugit//lib/fugit/cron.rb#433 + # source://fugit//lib/fugit/cron.rb#489 def ==(o); end # Mostly used as a #next_time sanity check. @@ -91,23 +91,23 @@ class Fugit::Cron # # Nota bene: cron with seconds are not supported. # - # source://fugit//lib/fugit/cron.rb#331 + # source://fugit//lib/fugit/cron.rb#387 def brute_frequency(year = T.unsafe(nil)); end # @return [Boolean] # - # source://fugit//lib/fugit/cron.rb#200 + # source://fugit//lib/fugit/cron.rb#198 def day_match?(nt); end - # source://fugit//lib/fugit/cron.rb#433 + # source://fugit//lib/fugit/cron.rb#489 def eql?(o); end - # source://fugit//lib/fugit/cron.rb#439 + # source://fugit//lib/fugit/cron.rb#495 def hash; end # @return [Boolean] # - # source://fugit//lib/fugit/cron.rb#153 + # source://fugit//lib/fugit/cron.rb#151 def hour_match?(nt); end # Returns the value of attribute hours. @@ -117,12 +117,12 @@ class Fugit::Cron # @return [Boolean] # - # source://fugit//lib/fugit/cron.rb#230 + # source://fugit//lib/fugit/cron.rb#228 def match?(t); end # @return [Boolean] # - # source://fugit//lib/fugit/cron.rb#154 + # source://fugit//lib/fugit/cron.rb#152 def min_match?(nt); end # Returns the value of attribute minutes. @@ -132,12 +132,12 @@ class Fugit::Cron # @return [Boolean] # - # source://fugit//lib/fugit/cron.rb#152 + # source://fugit//lib/fugit/cron.rb#150 def month_match?(nt); end # @return [Boolean] # - # source://fugit//lib/fugit/cron.rb#189 + # source://fugit//lib/fugit/cron.rb#187 def monthday_match?(nt); end # Returns the value of attribute monthdays. @@ -150,6 +150,12 @@ class Fugit::Cron # source://fugit//lib/fugit/cron.rb#22 def months; end + # Returns an ::Enumerable instance that yields each "next time" in + # succession + # + # source://fugit//lib/fugit/cron.rb#352 + def next(from = T.unsafe(nil)); end + # See gh-15 and tst/iteration_count.rb # # Initially set to 1024 after seeing the worst case for #next_time @@ -157,7 +163,7 @@ class Fugit::Cron # gh-18 and noticing some > 1024 for some experiments. 2048 should # be ok. # - # source://fugit//lib/fugit/cron.rb#247 + # source://fugit//lib/fugit/cron.rb#245 def next_time(from = T.unsafe(nil)); end # Returns the value of attribute original. @@ -165,15 +171,21 @@ class Fugit::Cron # source://fugit//lib/fugit/cron.rb#20 def original; end + # Returns an ::Enumerable instance that yields each "previous time" in + # succession + # + # source://fugit//lib/fugit/cron.rb#360 + def prev(from = T.unsafe(nil)); end + # source://fugit//lib/fugit/cron.rb#297 def previous_time(from = T.unsafe(nil)); end - # source://fugit//lib/fugit/cron.rb#361 + # source://fugit//lib/fugit/cron.rb#417 def rough_frequency; end # @return [Boolean] # - # source://fugit//lib/fugit/cron.rb#155 + # source://fugit//lib/fugit/cron.rb#153 def sec_match?(nt); end # Returns the value of attribute seconds. @@ -186,28 +198,28 @@ class Fugit::Cron # source://fugit//lib/fugit/cron.rb#22 def timezone; end - # source://fugit//lib/fugit/cron.rb#418 + # source://fugit//lib/fugit/cron.rb#474 def to_a; end - # source://fugit//lib/fugit/cron.rb#55 + # source://fugit//lib/fugit/cron.rb#53 def to_cron_s; end - # source://fugit//lib/fugit/cron.rb#423 + # source://fugit//lib/fugit/cron.rb#479 def to_h; end # @return [Boolean] # - # source://fugit//lib/fugit/cron.rb#157 + # source://fugit//lib/fugit/cron.rb#155 def weekday_hash_match?(nt, hsh); end # @return [Boolean] # - # source://fugit//lib/fugit/cron.rb#173 + # source://fugit//lib/fugit/cron.rb#171 def weekday_match?(nt); end # @return [Boolean] # - # source://fugit//lib/fugit/cron.rb#168 + # source://fugit//lib/fugit/cron.rb#166 def weekday_modulo_match?(nt, mod); end # Returns the value of attribute weekdays. @@ -215,6 +227,12 @@ class Fugit::Cron # source://fugit//lib/fugit/cron.rb#22 def weekdays; end + # Returns an array of EtOrbi::EoTime instances that correspond to + # the occurrences of the cron within the given time range + # + # source://fugit//lib/fugit/cron.rb#368 + def within(time_range, time_end = T.unsafe(nil)); end + # Returns the value of attribute zone. # # source://fugit//lib/fugit/cron.rb#20 @@ -222,50 +240,50 @@ class Fugit::Cron protected - # source://fugit//lib/fugit/cron.rb#566 - def compact(key); end - - # source://fugit//lib/fugit/cron.rb#446 + # source://fugit//lib/fugit/cron.rb#502 def compact_month_days; end - # source://fugit//lib/fugit/cron.rb#587 + # source://fugit//lib/fugit/cron.rb#656 def determine_hours(arr); end - # source://fugit//lib/fugit/cron.rb#582 + # source://fugit//lib/fugit/cron.rb#652 def determine_minutes(arr); end - # source://fugit//lib/fugit/cron.rb#594 + # source://fugit//lib/fugit/cron.rb#660 def determine_monthdays(arr); end - # source://fugit//lib/fugit/cron.rb#599 + # source://fugit//lib/fugit/cron.rb#664 def determine_months(arr); end - # source://fugit//lib/fugit/cron.rb#577 + # source://fugit//lib/fugit/cron.rb#648 def determine_seconds(arr); end - # source://fugit//lib/fugit/cron.rb#629 + # source://fugit//lib/fugit/cron.rb#695 def determine_timezone(z); end - # source://fugit//lib/fugit/cron.rb#604 + # source://fugit//lib/fugit/cron.rb#668 def determine_weekdays(arr); end - # source://fugit//lib/fugit/cron.rb#508 + # source://fugit//lib/fugit/cron.rb#631 + def do_determine(key, arr, min, max); end + + # source://fugit//lib/fugit/cron.rb#568 def expand(min, max, r); end - # source://fugit//lib/fugit/cron.rb#489 + # source://fugit//lib/fugit/cron.rb#545 def init(original, h); end - # source://fugit//lib/fugit/cron.rb#524 + # source://fugit//lib/fugit/cron.rb#589 def range(min, max, sta, edn, sla); end - # source://fugit//lib/fugit/cron.rb#462 + # source://fugit//lib/fugit/cron.rb#518 def rough_days; end - # source://fugit//lib/fugit/cron.rb#634 + # source://fugit//lib/fugit/cron.rb#702 def weekdays_to_cron_s; end class << self - # source://fugit//lib/fugit/cron.rb#48 + # source://fugit//lib/fugit/cron.rb#46 def do_parse(s); end # source://fugit//lib/fugit/cron.rb#27 @@ -276,381 +294,416 @@ class Fugit::Cron end end -# source://fugit//lib/fugit/cron.rb#487 +# Used by Fugit::Cron#next and Fugit::Cron#prev +# +# source://fugit//lib/fugit/cron.rb#327 +class Fugit::Cron::CronIterator + include ::Enumerable + + # @return [CronIterator] a new instance of CronIterator + # + # source://fugit//lib/fugit/cron.rb#332 + def initialize(cron, direction, start); end + + # Returns the value of attribute cron. + # + # source://fugit//lib/fugit/cron.rb#330 + def cron; end + + # Returns the value of attribute current. + # + # source://fugit//lib/fugit/cron.rb#330 + def current; end + + # Returns the value of attribute direction. + # + # source://fugit//lib/fugit/cron.rb#330 + def direction; end + + # source://fugit//lib/fugit/cron.rb#340 + def each; end + + # Returns the value of attribute start. + # + # source://fugit//lib/fugit/cron.rb#330 + def start; end +end + +# source://fugit//lib/fugit/cron.rb#543 Fugit::Cron::FREQUENCY_CACHE = T.let(T.unsafe(nil), Hash) -# source://fugit//lib/fugit/cron.rb#390 +# source://fugit//lib/fugit/cron.rb#446 class Fugit::Cron::Frequency # @return [Frequency] a new instance of Frequency # - # source://fugit//lib/fugit/cron.rb#395 + # source://fugit//lib/fugit/cron.rb#451 def initialize(deltas, span); end # Returns the value of attribute delta_max. # - # source://fugit//lib/fugit/cron.rb#392 + # source://fugit//lib/fugit/cron.rb#448 def delta_max; end # Returns the value of attribute delta_min. # - # source://fugit//lib/fugit/cron.rb#392 + # source://fugit//lib/fugit/cron.rb#448 def delta_min; end # Returns the value of attribute occurrences. # - # source://fugit//lib/fugit/cron.rb#392 + # source://fugit//lib/fugit/cron.rb#448 def occurrences; end # Returns the value of attribute span. # - # source://fugit//lib/fugit/cron.rb#392 + # source://fugit//lib/fugit/cron.rb#448 def span; end # Returns the value of attribute span_years. # - # source://fugit//lib/fugit/cron.rb#393 + # source://fugit//lib/fugit/cron.rb#449 def span_years; end - # source://fugit//lib/fugit/cron.rb#405 + # source://fugit//lib/fugit/cron.rb#461 def to_debug_s; end # Returns the value of attribute yearly_occurrences. # - # source://fugit//lib/fugit/cron.rb#393 + # source://fugit//lib/fugit/cron.rb#449 def yearly_occurrences; end end # source://fugit//lib/fugit/cron.rb#17 Fugit::Cron::MAXDAYS = T.let(T.unsafe(nil), Array) -# source://fugit//lib/fugit/cron.rb#238 +# source://fugit//lib/fugit/cron.rb#236 Fugit::Cron::MAX_ITERATION_COUNT = T.let(T.unsafe(nil), Integer) -# source://fugit//lib/fugit/cron.rb#652 +# source://fugit//lib/fugit/cron.rb#720 module Fugit::Cron::Parser include ::Raabro extend ::Raabro::ModuleMethods extend ::Raabro extend ::Fugit::Cron::Parser - # source://fugit//lib/fugit/cron.rb#688 + # source://fugit//lib/fugit/cron.rb#756 def _dom(i); end - # source://fugit//lib/fugit/cron.rb#690 + # source://fugit//lib/fugit/cron.rb#758 def _dow(i); end - # source://fugit//lib/fugit/cron.rb#687 + # source://fugit//lib/fugit/cron.rb#755 def _hou(i); end - # source://fugit//lib/fugit/cron.rb#689 + # source://fugit//lib/fugit/cron.rb#757 def _mon(i); end - # source://fugit//lib/fugit/cron.rb#686 + # source://fugit//lib/fugit/cron.rb#754 def _mos(i); end - # source://fugit//lib/fugit/cron.rb#747 + # source://fugit//lib/fugit/cron.rb#815 def _tz(i); end - # source://fugit//lib/fugit/cron.rb#744 + # source://fugit//lib/fugit/cron.rb#812 def _tz_delta(i); end - # source://fugit//lib/fugit/cron.rb#741 + # source://fugit//lib/fugit/cron.rb#809 def _tz_name(i); end # @return [Boolean] # - # source://fugit//lib/fugit/cron.rb#674 + # source://fugit//lib/fugit/cron.rb#742 def and?(i); end - # source://fugit//lib/fugit/cron.rb#749 + # source://fugit//lib/fugit/cron.rb#817 def classic_cron(i); end - # source://fugit//lib/fugit/cron.rb#672 + # source://fugit//lib/fugit/cron.rb#740 def comma(i); end # @return [Boolean] # - # source://fugit//lib/fugit/cron.rb#673 + # source://fugit//lib/fugit/cron.rb#741 def comma?(i); end - # source://fugit//lib/fugit/cron.rb#758 + # source://fugit//lib/fugit/cron.rb#826 def cron(i); end - # source://fugit//lib/fugit/cron.rb#680 + # source://fugit//lib/fugit/cron.rb#748 def dom(i); end - # source://fugit//lib/fugit/cron.rb#716 + # source://fugit//lib/fugit/cron.rb#784 def dom_elt(i); end - # source://fugit//lib/fugit/cron.rb#682 + # source://fugit//lib/fugit/cron.rb#750 def dow(i); end - # source://fugit//lib/fugit/cron.rb#718 + # source://fugit//lib/fugit/cron.rb#786 def dow_elt(i); end - # source://fugit//lib/fugit/cron.rb#725 + # source://fugit//lib/fugit/cron.rb#793 def dow_elt_(i); end - # source://fugit//lib/fugit/cron.rb#684 + # source://fugit//lib/fugit/cron.rb#752 def dow_hash(i); end - # source://fugit//lib/fugit/cron.rb#723 + # source://fugit//lib/fugit/cron.rb#791 def h_dow(i); end - # source://fugit//lib/fugit/cron.rb#679 + # source://fugit//lib/fugit/cron.rb#747 def hou(i); end - # source://fugit//lib/fugit/cron.rb#715 + # source://fugit//lib/fugit/cron.rb#783 def hou_elt(i); end - # source://fugit//lib/fugit/cron.rb#671 + # source://fugit//lib/fugit/cron.rb#739 def hyphen(i); end - # source://fugit//lib/fugit/cron.rb#737 + # source://fugit//lib/fugit/cron.rb#805 def ldom_(i); end - # source://fugit//lib/fugit/cron.rb#739 + # source://fugit//lib/fugit/cron.rb#807 def ldow(i); end - # source://fugit//lib/fugit/cron.rb#736 + # source://fugit//lib/fugit/cron.rb#804 def lhou_(i); end - # source://fugit//lib/fugit/cron.rb#730 + # source://fugit//lib/fugit/cron.rb#798 def list_dom(i); end - # source://fugit//lib/fugit/cron.rb#732 + # source://fugit//lib/fugit/cron.rb#800 def list_dow(i); end - # source://fugit//lib/fugit/cron.rb#729 + # source://fugit//lib/fugit/cron.rb#797 def list_hou(i); end - # source://fugit//lib/fugit/cron.rb#728 + # source://fugit//lib/fugit/cron.rb#796 def list_min(i); end - # source://fugit//lib/fugit/cron.rb#731 + # source://fugit//lib/fugit/cron.rb#799 def list_mon(i); end - # source://fugit//lib/fugit/cron.rb#727 + # source://fugit//lib/fugit/cron.rb#795 def list_sec(i); end - # source://fugit//lib/fugit/cron.rb#735 + # source://fugit//lib/fugit/cron.rb#803 def lmin_(i); end - # source://fugit//lib/fugit/cron.rb#738 + # source://fugit//lib/fugit/cron.rb#806 def lmon_(i); end - # source://fugit//lib/fugit/cron.rb#734 + # source://fugit//lib/fugit/cron.rb#802 def lsec_(i); end - # source://fugit//lib/fugit/cron.rb#720 + # source://fugit//lib/fugit/cron.rb#788 def mod(i); end - # source://fugit//lib/fugit/cron.rb#722 + # source://fugit//lib/fugit/cron.rb#790 def mod_dow(i); end - # source://fugit//lib/fugit/cron.rb#681 + # source://fugit//lib/fugit/cron.rb#749 def mon(i); end - # source://fugit//lib/fugit/cron.rb#717 + # source://fugit//lib/fugit/cron.rb#785 def mon_elt(i); end # min or sec # - # source://fugit//lib/fugit/cron.rb#678 + # source://fugit//lib/fugit/cron.rb#746 def mos(i); end # ssws: slash or sorws # - # source://fugit//lib/fugit/cron.rb#714 + # source://fugit//lib/fugit/cron.rb#782 def mos_elt(i); end - # source://fugit//lib/fugit/cron.rb#695 + # source://fugit//lib/fugit/cron.rb#763 def r_dom(i); end - # source://fugit//lib/fugit/cron.rb#697 + # source://fugit//lib/fugit/cron.rb#765 def r_dow(i); end - # source://fugit//lib/fugit/cron.rb#694 + # source://fugit//lib/fugit/cron.rb#762 def r_hou(i); end - # source://fugit//lib/fugit/cron.rb#696 + # source://fugit//lib/fugit/cron.rb#764 def r_mon(i); end # r: range # - # source://fugit//lib/fugit/cron.rb#693 + # source://fugit//lib/fugit/cron.rb#761 def r_mos(i); end # rewriting the parsed tree # - # source://fugit//lib/fugit/cron.rb#764 + # source://fugit//lib/fugit/cron.rb#832 def rewrite_bound(k, t); end - # source://fugit//lib/fugit/cron.rb#825 + # source://fugit//lib/fugit/cron.rb#893 def rewrite_cron(t); end - # source://fugit//lib/fugit/cron.rb#782 + # source://fugit//lib/fugit/cron.rb#850 def rewrite_elt(k, t); end - # source://fugit//lib/fugit/cron.rb#810 + # source://fugit//lib/fugit/cron.rb#878 def rewrite_entry(t); end - # source://fugit//lib/fugit/cron.rb#774 + # source://fugit//lib/fugit/cron.rb#842 def rewrite_mod(k, t); end - # source://fugit//lib/fugit/cron.rb#817 + # source://fugit//lib/fugit/cron.rb#885 def rewrite_tz(t); end # piece parsers bottom to top # - # source://fugit//lib/fugit/cron.rb#669 + # source://fugit//lib/fugit/cron.rb#737 def s(i); end - # source://fugit//lib/fugit/cron.rb#753 + # source://fugit//lib/fugit/cron.rb#821 def second_cron(i); end - # source://fugit//lib/fugit/cron.rb#676 + # source://fugit//lib/fugit/cron.rb#744 def slash(i); end - # source://fugit//lib/fugit/cron.rb#702 + # source://fugit//lib/fugit/cron.rb#770 def sor_dom(i); end - # source://fugit//lib/fugit/cron.rb#704 + # source://fugit//lib/fugit/cron.rb#772 def sor_dow(i); end - # source://fugit//lib/fugit/cron.rb#701 + # source://fugit//lib/fugit/cron.rb#769 def sor_hou(i); end - # source://fugit//lib/fugit/cron.rb#703 + # source://fugit//lib/fugit/cron.rb#771 def sor_mon(i); end # sor: star or range # - # source://fugit//lib/fugit/cron.rb#700 + # source://fugit//lib/fugit/cron.rb#768 def sor_mos(i); end - # source://fugit//lib/fugit/cron.rb#709 + # source://fugit//lib/fugit/cron.rb#777 def sorws_dom(i); end - # source://fugit//lib/fugit/cron.rb#711 + # source://fugit//lib/fugit/cron.rb#779 def sorws_dow(i); end - # source://fugit//lib/fugit/cron.rb#708 + # source://fugit//lib/fugit/cron.rb#776 def sorws_hou(i); end - # source://fugit//lib/fugit/cron.rb#710 + # source://fugit//lib/fugit/cron.rb#778 def sorws_mon(i); end # sorws: star or range with[out] slash # - # source://fugit//lib/fugit/cron.rb#707 + # source://fugit//lib/fugit/cron.rb#775 def sorws_mos(i); end - # source://fugit//lib/fugit/cron.rb#670 + # source://fugit//lib/fugit/cron.rb#738 def star(i); end end -# source://fugit//lib/fugit/cron.rb#659 +# source://fugit//lib/fugit/cron.rb#727 Fugit::Cron::Parser::DOW_REX = T.let(T.unsafe(nil), Regexp) -# source://fugit//lib/fugit/cron.rb#662 +# source://fugit//lib/fugit/cron.rb#730 Fugit::Cron::Parser::MONTHS = T.let(T.unsafe(nil), Array) -# source://fugit//lib/fugit/cron.rb#664 +# source://fugit//lib/fugit/cron.rb#732 Fugit::Cron::Parser::MONTH_REX = T.let(T.unsafe(nil), Regexp) -# source://fugit//lib/fugit/cron.rb#654 +# source://fugit//lib/fugit/cron.rb#722 Fugit::Cron::Parser::WEEKDAYS = T.let(T.unsafe(nil), Array) -# source://fugit//lib/fugit/cron.rb#657 +# source://fugit//lib/fugit/cron.rb#725 Fugit::Cron::Parser::WEEKDS = T.let(T.unsafe(nil), Array) -# source://fugit//lib/fugit/cron.rb#355 +# source://fugit//lib/fugit/cron.rb#411 Fugit::Cron::SLOTS = T.let(T.unsafe(nil), Array) # source://fugit//lib/fugit/cron.rb#7 Fugit::Cron::SPECIALS = T.let(T.unsafe(nil), Hash) -# source://fugit//lib/fugit/cron.rb#68 +# source://fugit//lib/fugit/cron.rb#66 class Fugit::Cron::TimeCursor # @return [TimeCursor] a new instance of TimeCursor # - # source://fugit//lib/fugit/cron.rb#70 + # source://fugit//lib/fugit/cron.rb#68 def initialize(cron, t); end - # source://fugit//lib/fugit/cron.rb#82 + # source://fugit//lib/fugit/cron.rb#80 def day; end - # source://fugit//lib/fugit/cron.rb#85 + # source://fugit//lib/fugit/cron.rb#83 def dec(i); end - # source://fugit//lib/fugit/cron.rb#134 + # source://fugit//lib/fugit/cron.rb#132 def dec_day; end - # source://fugit//lib/fugit/cron.rb#137 + # source://fugit//lib/fugit/cron.rb#135 def dec_hour; end - # source://fugit//lib/fugit/cron.rb#140 + # source://fugit//lib/fugit/cron.rb#138 def dec_min; end - # source://fugit//lib/fugit/cron.rb#130 + # source://fugit//lib/fugit/cron.rb#128 def dec_month; end - # source://fugit//lib/fugit/cron.rb#144 + # source://fugit//lib/fugit/cron.rb#142 def dec_sec; end - # source://fugit//lib/fugit/cron.rb#82 + # source://fugit//lib/fugit/cron.rb#80 def hour; end - # source://fugit//lib/fugit/cron.rb#84 + # source://fugit//lib/fugit/cron.rb#82 def inc(i); end - # source://fugit//lib/fugit/cron.rb#98 + # source://fugit//lib/fugit/cron.rb#96 def inc_day; end - # source://fugit//lib/fugit/cron.rb#115 + # source://fugit//lib/fugit/cron.rb#113 def inc_hour; end - # source://fugit//lib/fugit/cron.rb#118 + # source://fugit//lib/fugit/cron.rb#116 def inc_min; end - # source://fugit//lib/fugit/cron.rb#87 + # source://fugit//lib/fugit/cron.rb#85 def inc_month; end - # source://fugit//lib/fugit/cron.rb#122 + # source://fugit//lib/fugit/cron.rb#120 def inc_sec; end - # source://fugit//lib/fugit/cron.rb#82 + # source://fugit//lib/fugit/cron.rb#80 def min; end - # source://fugit//lib/fugit/cron.rb#82 + # source://fugit//lib/fugit/cron.rb#80 def month; end - # source://fugit//lib/fugit/cron.rb#82 + # source://fugit//lib/fugit/cron.rb#80 def rday; end - # source://fugit//lib/fugit/cron.rb#82 + # source://fugit//lib/fugit/cron.rb#80 def rweek; end - # source://fugit//lib/fugit/cron.rb#82 + # source://fugit//lib/fugit/cron.rb#80 def sec; end - # source://fugit//lib/fugit/cron.rb#76 + # source://fugit//lib/fugit/cron.rb#74 def time; end - # source://fugit//lib/fugit/cron.rb#79 + # source://fugit//lib/fugit/cron.rb#77 def to_i; end - # source://fugit//lib/fugit/cron.rb#77 + # source://fugit//lib/fugit/cron.rb#75 def to_t; end - # source://fugit//lib/fugit/cron.rb#82 + # source://fugit//lib/fugit/cron.rb#80 def wday; end - # source://fugit//lib/fugit/cron.rb#82 + # source://fugit//lib/fugit/cron.rb#80 def wday_in_month; end - # source://fugit//lib/fugit/cron.rb#82 + # source://fugit//lib/fugit/cron.rb#80 def year; end end @@ -1415,9 +1468,20 @@ class Fugit::Nat::SlotGroup def make_slot(key, data0, data1 = T.unsafe(nil)); end # source://fugit//lib/fugit/nat.rb#681 - def parse_cron(hm); end + def parse_cron(hm, opts); end + + # Return nil if the cron is "not strict" + # + # For example, "0 0/17 * * *" (gh-86) is a perfectly valid + # cron string, but makes not much sense when derived via `.parse_nat` + # from "every 17 hours". + # + # It happens here because it's nat being strict, not cron. + # + # source://fugit//lib/fugit/nat.rb#718 + def restrict(a, cron); end - # source://fugit//lib/fugit/nat.rb#701 + # source://fugit//lib/fugit/nat.rb#729 def slot(key, default); end end diff --git a/sorbet/rbi/gems/graphql-client@0.18.0.rbi b/sorbet/rbi/gems/graphql-client@0.23.0.rbi similarity index 80% rename from sorbet/rbi/gems/graphql-client@0.18.0.rbi rename to sorbet/rbi/gems/graphql-client@0.23.0.rbi index 55b4e96a6..5878999d1 100644 --- a/sorbet/rbi/gems/graphql-client@0.18.0.rbi +++ b/sorbet/rbi/gems/graphql-client@0.23.0.rbi @@ -5,28 +5,34 @@ # Please instead update this file by running `bin/tapioca gem graphql-client`. -# source://graphql-client//lib/graphql/client/error.rb#2 +# source://graphql-client//lib/graphql/client/type_stack.rb#2 module GraphQL class << self - # source://graphql/2.0.26/lib/graphql.rb#35 + # source://graphql/2.3.10/lib/graphql.rb#27 def default_parser; end - # source://graphql/2.0.26/lib/graphql.rb#39 + # source://graphql/2.3.10/lib/graphql.rb#31 def default_parser=(_arg0); end - # source://graphql/2.0.26/lib/graphql.rb#45 - def parse(graphql_string, trace: T.unsafe(nil)); end + # source://graphql/2.3.10/lib/graphql.rb#37 + def parse(graphql_string, trace: T.unsafe(nil), filename: T.unsafe(nil), max_tokens: T.unsafe(nil)); end - # source://graphql/2.0.26/lib/graphql.rb#52 + # source://graphql/2.3.10/lib/graphql.rb#44 def parse_file(filename); end - # source://graphql/2.0.26/lib/graphql.rb#62 + # source://graphql/2.3.10/lib/graphql.rb#54 def parse_with_racc(string, filename: T.unsafe(nil), trace: T.unsafe(nil)); end - # source://graphql/2.0.26/lib/graphql.rb#58 + # source://graphql/2.3.10/lib/graphql.rb#72 + def reject_numbers_followed_by_names; end + + # source://graphql/2.3.10/lib/graphql.rb#72 + def reject_numbers_followed_by_names=(_arg0); end + + # source://graphql/2.3.10/lib/graphql.rb#50 def scan(graphql_string); end - # source://graphql/2.0.26/lib/graphql.rb#66 + # source://graphql/2.3.10/lib/graphql.rb#59 def scan_with_ruby(graphql_string); end end end @@ -38,21 +44,21 @@ end # to point at a remote GraphQL HTTP service or execute directly against a # Schema object. # -# source://graphql-client//lib/graphql/client/error.rb#3 +# source://graphql-client//lib/graphql/client/type_stack.rb#3 class GraphQL::Client extend ::GraphQL::Client::CollocatedEnforcement # @return [Client] a new instance of Client # - # source://graphql-client//lib/graphql/client.rb#93 - def initialize(schema:, execute: T.unsafe(nil), enforce_collocated_callers: T.unsafe(nil)); end + # source://graphql-client//lib/graphql/client.rb#94 + def initialize(schema:, execute: T.unsafe(nil), enforce_collocated_callers: T.unsafe(nil), raise_on_unknown_enum_value: T.unsafe(nil)); end # Deprecated: Allow dynamically generated queries to be passed to # Client#query. # # This ability will eventually be removed in future versions. # - # source://graphql-client//lib/graphql/client.rb#45 + # source://graphql-client//lib/graphql/client.rb#46 def allow_dynamic_queries; end # Deprecated: Allow dynamically generated queries to be passed to @@ -60,7 +66,7 @@ class GraphQL::Client # # This ability will eventually be removed in future versions. # - # source://graphql-client//lib/graphql/client.rb#45 + # source://graphql-client//lib/graphql/client.rb#46 def allow_dynamic_queries=(_arg0); end # Public: Create operation definition from a fragment definition. @@ -84,85 +90,85 @@ class GraphQL::Client # # Returns an OperationDefinition. # - # source://graphql-client//lib/graphql/client.rb#293 + # source://graphql-client//lib/graphql/client.rb#299 def create_operation(fragment, filename = T.unsafe(nil), lineno = T.unsafe(nil)); end # Returns the value of attribute document. # - # source://graphql-client//lib/graphql/client.rb#330 + # source://graphql-client//lib/graphql/client.rb#336 def document; end # Returns the value of attribute document_tracking_enabled. # - # source://graphql-client//lib/graphql/client.rb#36 + # source://graphql-client//lib/graphql/client.rb#37 def document_tracking_enabled; end # Sets the attribute document_tracking_enabled # # @param value the value to set the attribute document_tracking_enabled to. # - # source://graphql-client//lib/graphql/client.rb#36 + # source://graphql-client//lib/graphql/client.rb#37 def document_tracking_enabled=(_arg0); end # Public: Check if collocated caller enforcement is enabled. # - # source://graphql-client//lib/graphql/client.rb#39 + # source://graphql-client//lib/graphql/client.rb#40 def enforce_collocated_callers; end # Returns the value of attribute execute. # - # source://graphql-client//lib/graphql/client.rb#32 + # source://graphql-client//lib/graphql/client.rb#33 def execute; end # Public: A wrapper to use the more-efficient `.get_type` when it's available from GraphQL-Ruby (1.10+) # - # source://graphql-client//lib/graphql/client.rb#269 + # source://graphql-client//lib/graphql/client.rb#275 def get_type(type_name); end - # source://graphql-client//lib/graphql/client.rb#125 + # source://graphql-client//lib/graphql/client.rb#131 def parse(str, filename = T.unsafe(nil), lineno = T.unsafe(nil)); end # A cache of the schema's merged possible types # # @param type_condition [Class, String] a type definition or type name # - # source://graphql-client//lib/graphql/client.rb#108 + # source://graphql-client//lib/graphql/client.rb#114 def possible_types(type_condition = T.unsafe(nil)); end # @raise [NotImplementedError] # - # source://graphql-client//lib/graphql/client.rb#332 + # source://graphql-client//lib/graphql/client.rb#338 def query(definition, variables: T.unsafe(nil), context: T.unsafe(nil)); end # Returns the value of attribute schema. # - # source://graphql-client//lib/graphql/client.rb#32 + # source://graphql-client//lib/graphql/client.rb#33 def schema; end # Returns the value of attribute types. # - # source://graphql-client//lib/graphql/client.rb#34 + # source://graphql-client//lib/graphql/client.rb#35 def types; end private - # source://graphql-client//lib/graphql/client.rb#436 + # source://graphql-client//lib/graphql/client.rb#455 def deep_freeze_json_object(obj); end - # source://graphql-client//lib/graphql/client.rb#449 + # source://graphql-client//lib/graphql/client.rb#468 def deep_stringify_keys(obj); end - # source://graphql-client//lib/graphql/client.rb#428 + # source://graphql-client//lib/graphql/client.rb#447 def find_definition_dependencies(node); end - # source://graphql-client//lib/graphql/client.rb#398 + # source://graphql-client//lib/graphql/client.rb#404 def sliced_definitions(document_dependencies, doc, source_location:); end class << self - # source://graphql-client//lib/graphql/client.rb#72 + # source://graphql-client//lib/graphql/client.rb#73 def dump_schema(schema, io = T.unsafe(nil), context: T.unsafe(nil)); end - # source://graphql-client//lib/graphql/client.rb#47 + # source://graphql-client//lib/graphql/client.rb#48 def load_schema(schema); end end end @@ -272,26 +278,55 @@ class GraphQL::Client::Definition < ::Module private - # source://graphql-client//lib/graphql/client/definition.rb#160 + # source://graphql-client//lib/graphql/client/definition.rb#222 def cast_object(obj); end - # source://graphql-client//lib/graphql/client/definition.rb#187 - def flatten_spreads(node); end - - # source://graphql-client//lib/graphql/client/definition.rb#202 - def index_node_definitions(visitor); end - - # source://graphql-client//lib/graphql/client/definition.rb#173 - def index_spreads(visitor); end - class << self # source://graphql-client//lib/graphql/client/definition.rb#17 def for(ast_node:, **kargs); end end end -# source://graphql-client//lib/graphql/client/definition.rb#171 -GraphQL::Client::Definition::EMPTY_SET = T.let(T.unsafe(nil), Set) +# source://graphql-client//lib/graphql/client/definition.rb#156 +class GraphQL::Client::Definition::DefinitionVisitor < ::GraphQL::Language::Visitor + # @return [DefinitionVisitor] a new instance of DefinitionVisitor + # + # source://graphql-client//lib/graphql/client/definition.rb#159 + def initialize(doc); end + + # Returns the value of attribute definitions. + # + # source://graphql-client//lib/graphql/client/definition.rb#157 + def definitions; end + + # source://graphql-client//lib/graphql/client/definition.rb#166 + def on_field(node, parent); end + + # source://graphql-client//lib/graphql/client/definition.rb#172 + def on_fragment_definition(node, parent); end + + # source://graphql-client//lib/graphql/client/definition.rb#190 + def on_inline_fragment(node, parent); end + + # source://graphql-client//lib/graphql/client/definition.rb#181 + def on_operation_definition(node, parent); end + + # Returns the value of attribute spreads. + # + # source://graphql-client//lib/graphql/client/definition.rb#157 + def spreads; end + + private + + # source://graphql-client//lib/graphql/client/definition.rb#204 + def flatten_spreads(node); end + + # source://graphql-client//lib/graphql/client/definition.rb#199 + def get_spreads(node); end +end + +# source://graphql-client//lib/graphql/client/definition.rb#197 +GraphQL::Client::Definition::DefinitionVisitor::EMPTY_SET = T.let(T.unsafe(nil), Set) # Internal: Detect variables used in a definition. # @@ -307,7 +342,7 @@ module GraphQL::Client::DefinitionVariables # # Returns a Hash[Symbol] to VariableDefinition objects. # - # source://graphql-client//lib/graphql/client/definition_variables.rb#57 + # source://graphql-client//lib/graphql/client/definition_variables.rb#64 def operation_variables(schema, document, definition_name = T.unsafe(nil)); end # Internal: Get AST node for GraphQL type. @@ -316,7 +351,7 @@ module GraphQL::Client::DefinitionVariables # # Returns GraphQL::Language::Nodes::Type. # - # source://graphql-client//lib/graphql/client/definition_variables.rb#68 + # source://graphql-client//lib/graphql/client/definition_variables.rb#75 def variable_node(type); end # Internal: Detect all variables used in a given operation or fragment @@ -333,9 +368,27 @@ module GraphQL::Client::DefinitionVariables end end +# source://graphql-client//lib/graphql/client/definition_variables.rb#32 +class GraphQL::Client::DefinitionVariables::VariablesVisitor < ::GraphQL::Language::Visitor + include ::GraphQL::Client::TypeStack + + # @return [VariablesVisitor] a new instance of VariablesVisitor + # + # source://graphql-client//lib/graphql/client/type_stack.rb#30 + def initialize(document, schema:, **rest); end + + # source://graphql-client//lib/graphql/client/definition_variables.rb#42 + def on_variable_identifier(node, parent); end + + # Returns the value of attribute variables. + # + # source://graphql-client//lib/graphql/client/definition_variables.rb#40 + def variables; end +end + # Internal: Use schema to detect definition and field types. # -# source://graphql-client//lib/graphql/client/document_types.rb#7 +# source://graphql-client//lib/graphql/client/document_types.rb#8 module GraphQL::Client::DocumentTypes class << self # Internal: Detect all types used in a given document @@ -345,12 +398,39 @@ module GraphQL::Client::DocumentTypes # # Returns a Hash[Language::Nodes::Node] to GraphQL::Type objects. # - # source://graphql-client//lib/graphql/client/document_types.rb#14 + # source://graphql-client//lib/graphql/client/document_types.rb#45 def analyze_types(schema, document); end end end -# source://graphql-client//lib/graphql/client.rb#26 +# source://graphql-client//lib/graphql/client/document_types.rb#9 +class GraphQL::Client::DocumentTypes::AnalyzeTypesVisitor < ::GraphQL::Language::Visitor + include ::GraphQL::Client::TypeStack + + # @return [AnalyzeTypesVisitor] a new instance of AnalyzeTypesVisitor + # + # source://graphql-client//lib/graphql/client/type_stack.rb#30 + def initialize(document, schema:, **rest); end + + # Returns the value of attribute fields. + # + # source://graphql-client//lib/graphql/client/document_types.rb#11 + def fields; end + + # source://graphql-client//lib/graphql/client/type_stack.rb#48 + def on_field(node, parent); end + + # source://graphql-client//lib/graphql/client/type_stack.rb#119 + def on_fragment_definition(node, parent); end + + # source://graphql-client//lib/graphql/client/type_stack.rb#102 + def on_inline_fragment(node, parent); end + + # source://graphql-client//lib/graphql/client/type_stack.rb#91 + def on_operation_definition(node, parent); end +end + +# source://graphql-client//lib/graphql/client.rb#27 class GraphQL::Client::DynamicQueryError < ::GraphQL::Client::Error; end # Public: Abstract base class for all errors raised by GraphQL::Client. @@ -571,6 +651,22 @@ class GraphQL::Client::FragmentDefinition < ::GraphQL::Client::Definition def new(obj, *args); end end +# source://graphql-client//lib/graphql/client.rb#433 +class GraphQL::Client::GatherNamesVisitor < ::GraphQL::Language::Visitor + # @return [GatherNamesVisitor] a new instance of GatherNamesVisitor + # + # source://graphql-client//lib/graphql/client.rb#434 + def initialize(node); end + + # Returns the value of attribute names. + # + # source://graphql-client//lib/graphql/client.rb#439 + def names; end + + # source://graphql-client//lib/graphql/client.rb#441 + def on_fragment_spread(node, parent); end +end + # Public: Basic HTTP network adapter. # # GraphQL::Client.new( @@ -718,7 +814,7 @@ end # source://graphql-client//lib/graphql/client/error.rb#11 class GraphQL::Client::ImplicitlyFetchedFieldError < ::NoMethodError; end -# source://graphql-client//lib/graphql/client.rb#70 +# source://graphql-client//lib/graphql/client.rb#71 GraphQL::Client::IntrospectionDocument = T.let(T.unsafe(nil), GraphQL::Language::Nodes::Document) # source://graphql-client//lib/graphql/client/error.rb#8 @@ -727,16 +823,16 @@ class GraphQL::Client::InvariantError < ::GraphQL::Client::Error; end # Internal: FragmentSpread and FragmentDefinition extension to allow its # name to point to a lazily defined Proc instead of a static string. # -# source://graphql-client//lib/graphql/client.rb#388 +# source://graphql-client//lib/graphql/client.rb#394 module GraphQL::Client::LazyName # Sets the attribute _definition # # @param value the value to set the attribute _definition to. # - # source://graphql-client//lib/graphql/client.rb#393 + # source://graphql-client//lib/graphql/client.rb#399 def _definition=(_arg0); end - # source://graphql-client//lib/graphql/client.rb#389 + # source://graphql-client//lib/graphql/client.rb#395 def name; end end @@ -762,7 +858,7 @@ end # source://graphql-client//lib/graphql/client/collocated_enforcement.rb#11 class GraphQL::Client::NonCollocatedCallerError < ::GraphQL::Client::Error; end -# source://graphql-client//lib/graphql/client.rb#27 +# source://graphql-client//lib/graphql/client.rb#28 class GraphQL::Client::NotImplementedError < ::GraphQL::Client::Error; end # Specific operation definition subtype for queries, mutations or @@ -813,25 +909,25 @@ class GraphQL::Client::QueryTypename::InsertTypenameVisitor < ::GraphQL::Languag def on_operation_definition(node, parent); end end -# source://graphql-client//lib/graphql/client.rb#236 +# source://graphql-client//lib/graphql/client.rb#242 class GraphQL::Client::RenameNodeVisitor < ::GraphQL::Language::Visitor # @return [RenameNodeVisitor] a new instance of RenameNodeVisitor # - # source://graphql-client//lib/graphql/client.rb#237 + # source://graphql-client//lib/graphql/client.rb#243 def initialize(document, definitions:); end - # source://graphql-client//lib/graphql/client.rb#242 + # source://graphql-client//lib/graphql/client.rb#248 def on_fragment_definition(node, _parent); end - # source://graphql-client//lib/graphql/client.rb#252 + # source://graphql-client//lib/graphql/client.rb#258 def on_fragment_spread(node, _parent); end - # source://graphql-client//lib/graphql/client.rb#247 + # source://graphql-client//lib/graphql/client.rb#253 def on_operation_definition(node, _parent); end private - # source://graphql-client//lib/graphql/client.rb#259 + # source://graphql-client//lib/graphql/client.rb#265 def rename_node(node); end end @@ -845,7 +941,7 @@ class GraphQL::Client::Response # # @return [Response] a new instance of Response # - # source://graphql-client//lib/graphql/client/response.rb#34 + # source://graphql-client//lib/graphql/client/response.rb#35 def initialize(hash, data: T.unsafe(nil), errors: T.unsafe(nil), extensions: T.unsafe(nil)); end # Public: Wrapped ObjectType of data returned from the server. @@ -854,7 +950,7 @@ class GraphQL::Client::Response # # Returns instance of ObjectType subclass. # - # source://graphql-client//lib/graphql/client/response.rb#21 + # source://graphql-client//lib/graphql/client/response.rb#22 def data; end # Public: Get partial failures from response. @@ -863,12 +959,12 @@ class GraphQL::Client::Response # # Returns Errors collection object with zero or more errors. # - # source://graphql-client//lib/graphql/client/response.rb#28 + # source://graphql-client//lib/graphql/client/response.rb#29 def errors; end # Public: Hash of server specific extension metadata. # - # source://graphql-client//lib/graphql/client/response.rb#31 + # source://graphql-client//lib/graphql/client/response.rb#32 def extensions; end # Public: Original JSON response hash returned from server. @@ -884,16 +980,23 @@ class GraphQL::Client::Response # # source://graphql-client//lib/graphql/client/response.rb#13 def to_h; end + + # Public: Original JSON response hash returned from server. + # + # Returns Hash. + # + # source://graphql-client//lib/graphql/client/response.rb#13 + def to_hash; end end # source://graphql-client//lib/graphql/client/schema/base_type.rb#5 module GraphQL::Client::Schema class << self - # source://graphql-client//lib/graphql/client/schema.rb#85 + # source://graphql-client//lib/graphql/client/schema.rb#86 def class_for(schema, type, cache); end # source://graphql-client//lib/graphql/client/schema.rb#69 - def generate(schema); end + def generate(schema, raise_on_unknown_enum_value: T.unsafe(nil)); end end end @@ -974,10 +1077,10 @@ class GraphQL::Client::Schema::EnumType < ::Module # # @return [EnumType] a new instance of EnumType # - # source://graphql-client//lib/graphql/client/schema/enum_type.rb#43 + # source://graphql-client//lib/graphql/client/schema/enum_type.rb#53 def initialize(type); end - # source://graphql-client//lib/graphql/client/schema/enum_type.rb#67 + # source://graphql-client//lib/graphql/client/schema/enum_type.rb#77 def [](value); end # Internal: Cast JSON value to the enumeration's corresponding constant string instance @@ -988,10 +1091,10 @@ class GraphQL::Client::Schema::EnumType < ::Module # # Returns String or nil. # - # source://graphql-client//lib/graphql/client/schema/enum_type.rb#78 + # source://graphql-client//lib/graphql/client/schema/enum_type.rb#88 def cast(value, _errors = T.unsafe(nil)); end - # source://graphql-client//lib/graphql/client/schema/enum_type.rb#63 + # source://graphql-client//lib/graphql/client/schema/enum_type.rb#73 def define_class(definition, ast_nodes); end end @@ -1002,17 +1105,30 @@ class GraphQL::Client::Schema::EnumType::EnumValue < ::String # source://graphql-client//lib/graphql/client/schema/enum_type.rb#13 def initialize(obj, enum_value, enum); end - # source://graphql-client//lib/graphql/client/schema/enum_type.rb#27 + # source://graphql-client//lib/graphql/client/schema/enum_type.rb#31 def method_missing(method_name, *args); end + # @return [Boolean] + # + # source://graphql-client//lib/graphql/client/schema/enum_type.rb#19 + def unknown_enum_value?; end + private # @return [Boolean] # - # source://graphql-client//lib/graphql/client/schema/enum_type.rb#19 + # source://graphql-client//lib/graphql/client/schema/enum_type.rb#23 def respond_to_missing?(method_name, include_private = T.unsafe(nil)); end end +# source://graphql-client//lib/graphql/client/schema/enum_type.rb#44 +class GraphQL::Client::Schema::EnumType::UnexpectedEnumValue < ::String + # @return [Boolean] + # + # source://graphql-client//lib/graphql/client/schema/enum_type.rb#45 + def unknown_enum_value?; end +end + # source://graphql-client//lib/graphql/client/schema/include_directive.rb#8 class GraphQL::Client::Schema::IncludeDirective include ::GraphQL::Client::Schema::BaseType @@ -1136,11 +1252,11 @@ class GraphQL::Client::Schema::NonNullType def to_non_null_type; end end -# source://graphql-client//lib/graphql/client/schema/object_type.rb#176 +# source://graphql-client//lib/graphql/client/schema/object_type.rb#175 class GraphQL::Client::Schema::ObjectClass # @return [ObjectClass] a new instance of ObjectClass # - # source://graphql-client//lib/graphql/client/schema/object_type.rb#177 + # source://graphql-client//lib/graphql/client/schema/object_type.rb#176 def initialize(data = T.unsafe(nil), errors = T.unsafe(nil), definer = T.unsafe(nil)); end # source://graphql-client//lib/graphql/client/schema/object_type.rb#196 @@ -1173,9 +1289,16 @@ class GraphQL::Client::Schema::ObjectClass # # Returns Hash # - # source://graphql-client//lib/graphql/client/schema/object_type.rb#192 + # source://graphql-client//lib/graphql/client/schema/object_type.rb#191 def to_h; end + # Public: Returns the raw response data + # + # Returns Hash + # + # source://graphql-client//lib/graphql/client/schema/object_type.rb#191 + def to_hash; end + private # @return [Boolean] @@ -1195,15 +1318,15 @@ class GraphQL::Client::Schema::ObjectClass def verify_collocated_path; end end -# source://graphql-client//lib/graphql/client/schema/object_type.rb#11 +# source://graphql-client//lib/graphql/client/schema/object_type.rb#10 module GraphQL::Client::Schema::ObjectType - # source://graphql-client//lib/graphql/client/schema/object_type.rb#116 + # source://graphql-client//lib/graphql/client/schema/object_type.rb#115 def cast(value, errors); end - # source://graphql-client//lib/graphql/client/schema/object_type.rb#69 + # source://graphql-client//lib/graphql/client/schema/object_type.rb#68 def define_class(definition, ast_nodes); end - # source://graphql-client//lib/graphql/client/schema/object_type.rb#101 + # source://graphql-client//lib/graphql/client/schema/object_type.rb#100 def define_field(name, type); end private @@ -1211,54 +1334,54 @@ module GraphQL::Client::Schema::ObjectType # Given an AST selection on this object, gather it into `fields` if it applies. # If it's a fragment, continue recursively checking the selections on the fragment. # - # source://graphql-client//lib/graphql/client/schema/object_type.rb#131 + # source://graphql-client//lib/graphql/client/schema/object_type.rb#130 def gather_selections(fields, definition, selected_ast_node); end class << self - # source://graphql-client//lib/graphql/client/schema/object_type.rb#12 + # source://graphql-client//lib/graphql/client/schema/object_type.rb#11 def new(type, fields = T.unsafe(nil)); end end end -# source://graphql-client//lib/graphql/client/schema/object_type.rb#25 +# source://graphql-client//lib/graphql/client/schema/object_type.rb#24 class GraphQL::Client::Schema::ObjectType::WithDefinition include ::GraphQL::Client::Schema::BaseType include ::GraphQL::Client::Schema::ObjectType # @return [WithDefinition] a new instance of WithDefinition # - # source://graphql-client//lib/graphql/client/schema/object_type.rb#49 + # source://graphql-client//lib/graphql/client/schema/object_type.rb#48 def initialize(klass, defined_fields, definition, spreads); end # Returns the value of attribute defined_fields. # - # source://graphql-client//lib/graphql/client/schema/object_type.rb#31 + # source://graphql-client//lib/graphql/client/schema/object_type.rb#30 def defined_fields; end # Returns the value of attribute definition. # - # source://graphql-client//lib/graphql/client/schema/object_type.rb#31 + # source://graphql-client//lib/graphql/client/schema/object_type.rb#30 def definition; end - # source://graphql-client//lib/graphql/client/schema/object_type.rb#37 + # source://graphql-client//lib/graphql/client/schema/object_type.rb#36 def fields; end # Returns the value of attribute klass. # - # source://graphql-client//lib/graphql/client/schema/object_type.rb#31 + # source://graphql-client//lib/graphql/client/schema/object_type.rb#30 def klass; end - # source://graphql-client//lib/graphql/client/schema/object_type.rb#64 + # source://graphql-client//lib/graphql/client/schema/object_type.rb#63 def new(data = T.unsafe(nil), errors = T.unsafe(nil)); end - # source://graphql-client//lib/graphql/client/schema/object_type.rb#41 + # source://graphql-client//lib/graphql/client/schema/object_type.rb#40 def spreads; end - # source://graphql-client//lib/graphql/client/schema/object_type.rb#33 + # source://graphql-client//lib/graphql/client/schema/object_type.rb#32 def type; end end -# source://graphql-client//lib/graphql/client/schema/object_type.rb#29 +# source://graphql-client//lib/graphql/client/schema/object_type.rb#28 GraphQL::Client::Schema::ObjectType::WithDefinition::EMPTY_SET = T.let(T.unsafe(nil), Set) # source://graphql-client//lib/graphql/client/schema/possible_types.rb#10 @@ -1360,13 +1483,81 @@ class GraphQL::Client::Schema::UnionType < ::Module def new(types); end end +# source://graphql-client//lib/graphql/client/type_stack.rb#4 +module GraphQL::Client::TypeStack + # @param schema [GraphQL::Schema] the schema whose types to use when climbing this document + # @param visitor [GraphQL::Language::Visitor] a visitor to follow & watch the types + # + # source://graphql-client//lib/graphql/client/type_stack.rb#30 + def initialize(document, schema:, **rest); end + + # @return [Array] arguments which have been entered + # + # source://graphql-client//lib/graphql/client/type_stack.rb#23 + def argument_definitions; end + + # Directives are pushed on, then popped off while traversing the tree + # + # @return [Array] directives which have been entered + # + # source://graphql-client//lib/graphql/client/type_stack.rb#20 + def directive_definitions; end + + # When it enters a field, it's pushed on this stack (useful for nested fields, args). + # When it exits, it's popped off. + # + # @return [Array] fields which have been entered + # + # source://graphql-client//lib/graphql/client/type_stack.rb#16 + def field_definitions; end + + # When it enters an object (starting with query or mutation root), it's pushed on this stack. + # When it exits, it's popped off. + # + # @return [Array] + # + # source://graphql-client//lib/graphql/client/type_stack.rb#11 + def object_types; end + + # source://graphql-client//lib/graphql/client/type_stack.rb#68 + def on_argument(node, parent); end + + # source://graphql-client//lib/graphql/client/type_stack.rb#40 + def on_directive(node, parent); end + + # source://graphql-client//lib/graphql/client/type_stack.rb#48 + def on_field(node, parent); end + + # source://graphql-client//lib/graphql/client/type_stack.rb#119 + def on_fragment_definition(node, parent); end + + # source://graphql-client//lib/graphql/client/type_stack.rb#136 + def on_fragment_spread(node, parent); end + + # source://graphql-client//lib/graphql/client/type_stack.rb#102 + def on_inline_fragment(node, parent); end + + # source://graphql-client//lib/graphql/client/type_stack.rb#91 + def on_operation_definition(node, parent); end + + # @return [Array] fields which have been entered (by their AST name) + # + # source://graphql-client//lib/graphql/client/type_stack.rb#26 + def path; end + + # @return [GraphQL::Schema] the schema whose types are present in this document + # + # source://graphql-client//lib/graphql/client/type_stack.rb#6 + def schema; end +end + # source://graphql-client//lib/graphql/client/error.rb#14 class GraphQL::Client::UnfetchedFieldError < ::NoMethodError; end # source://graphql-client//lib/graphql/client/error.rb#17 class GraphQL::Client::UnimplementedFieldError < ::NoMethodError; end -# source://graphql-client//lib/graphql/client.rb#28 +# source://graphql-client//lib/graphql/client.rb#29 class GraphQL::Client::ValidationError < ::GraphQL::Client::Error; end # Collocation will not be enforced if a stack trace includes any of these gems. diff --git a/sorbet/rbi/gems/graphql@2.0.26.rbi b/sorbet/rbi/gems/graphql@2.3.10.rbi similarity index 77% rename from sorbet/rbi/gems/graphql@2.0.26.rbi rename to sorbet/rbi/gems/graphql@2.3.10.rbi index a91c69984..a564ccd57 100644 --- a/sorbet/rbi/gems/graphql@2.0.26.rbi +++ b/sorbet/rbi/gems/graphql@2.3.10.rbi @@ -5,50 +5,17 @@ # Please instead update this file by running `bin/tapioca gem graphql`. -# backport from ruby v2.5 to v2.2 that has no `padding` things -# -# @api private -# -# source://graphql//lib/graphql/schema/base_64_bp.rb#7 -module Base64Bp - extend ::Base64 - - private - - # @api private - # - # source://graphql//lib/graphql/schema/base_64_bp.rb#19 - def urlsafe_decode64(str); end - - # @api private - # - # source://graphql//lib/graphql/schema/base_64_bp.rb#12 - def urlsafe_encode64(bin, padding:); end - - class << self - # @api private - # - # source://graphql//lib/graphql/schema/base_64_bp.rb#19 - def urlsafe_decode64(str); end - - # @api private - # - # source://graphql//lib/graphql/schema/base_64_bp.rb#12 - def urlsafe_encode64(bin, padding:); end - end -end - # source://graphql//lib/graphql.rb#8 module GraphQL class << self - # source://graphql//lib/graphql.rb#35 + # source://graphql//lib/graphql.rb#27 def default_parser; end # Sets the attribute default_parser # # @param value the value to set the attribute default_parser to. # - # source://graphql//lib/graphql.rb#39 + # source://graphql//lib/graphql.rb#31 def default_parser=(_arg0); end # Turn a query string or schema definition into an AST @@ -56,60 +23,45 @@ module GraphQL # @param graphql_string [String] a GraphQL query string or schema definition # @return [GraphQL::Language::Nodes::Document] # - # source://graphql//lib/graphql.rb#45 - def parse(graphql_string, trace: T.unsafe(nil)); end + # source://graphql//lib/graphql.rb#37 + def parse(graphql_string, trace: T.unsafe(nil), filename: T.unsafe(nil), max_tokens: T.unsafe(nil)); end # Read the contents of `filename` and parse them as GraphQL # # @param filename [String] Path to a `.graphql` file containing IDL or query # @return [GraphQL::Language::Nodes::Document] # - # source://graphql//lib/graphql.rb#52 + # source://graphql//lib/graphql.rb#44 def parse_file(filename); end - # source://graphql//lib/graphql.rb#62 + # source://graphql//lib/graphql.rb#54 def parse_with_racc(string, filename: T.unsafe(nil), trace: T.unsafe(nil)); end + # If true, the parser should raise when an integer or float is followed immediately by an identifier (instead of a space or punctuation) + # + # source://graphql//lib/graphql.rb#72 + def reject_numbers_followed_by_names; end + + # If true, the parser should raise when an integer or float is followed immediately by an identifier (instead of a space or punctuation) + # + # source://graphql//lib/graphql.rb#72 + def reject_numbers_followed_by_names=(_arg0); end + # @return [Array] # - # source://graphql//lib/graphql.rb#58 + # source://graphql//lib/graphql.rb#50 def scan(graphql_string); end - # source://graphql//lib/graphql.rb#66 + # source://graphql//lib/graphql.rb#59 def scan_with_ruby(graphql_string); end end end -# source://graphql//lib/graphql/analysis/ast/visitor.rb#3 -module GraphQL::Analysis; end - -# A query reducer for measuring the depth of a given query. -# -# See https://graphql-ruby.org/queries/ast_analysis.html for more examples. -# -# @example Logging the depth of a query -# class LogQueryDepth < GraphQL::Analysis::QueryDepth -# def result -# log("GraphQL query depth: #{@max_depth}") -# end -# end -# -# # In your Schema file: -# -# class MySchema < GraphQL::Schema -# query_analyzer LogQueryDepth -# end -# -# # When you run the query, the depth will get logged: -# -# Schema.execute(query_str) -# # GraphQL query depth: 8 -# -# source://graphql//lib/graphql/analysis/ast/visitor.rb#4 -module GraphQL::Analysis::AST +# source://graphql//lib/graphql/analysis/visitor.rb#3 +module GraphQL::Analysis private - # source://graphql//lib/graphql/analysis/ast.rb#76 + # source://graphql//lib/graphql/analysis.rb#89 def analysis_errors(results); end # Analyze a multiplex, and all queries within. @@ -117,21 +69,21 @@ module GraphQL::Analysis::AST # Query analyzers are ran per query, without carrying state between queries. # # @param multiplex [GraphQL::Execution::Multiplex] - # @param analyzers [Array] + # @param analyzers [Array] # @return [Array] Results from multiplex analyzers # - # source://graphql//lib/graphql/analysis/ast.rb#21 + # source://graphql//lib/graphql/analysis.rb#22 def analyze_multiplex(multiplex, analyzers); end # @param query [GraphQL::Query] - # @param analyzers [Array] + # @param analyzers [Array] # @return [Array] Results from those analyzers # - # source://graphql//lib/graphql/analysis/ast.rb#50 + # source://graphql//lib/graphql/analysis.rb#51 def analyze_query(query, analyzers, multiplex_analyzers: T.unsafe(nil)); end class << self - # source://graphql//lib/graphql/analysis/ast.rb#76 + # source://graphql//lib/graphql/analysis.rb#89 def analysis_errors(results); end # Analyze a multiplex, and all queries within. @@ -139,21 +91,24 @@ module GraphQL::Analysis::AST # Query analyzers are ran per query, without carrying state between queries. # # @param multiplex [GraphQL::Execution::Multiplex] - # @param analyzers [Array] + # @param analyzers [Array] # @return [Array] Results from multiplex analyzers # - # source://graphql//lib/graphql/analysis/ast.rb#21 + # source://graphql//lib/graphql/analysis.rb#22 def analyze_multiplex(multiplex, analyzers); end # @param query [GraphQL::Query] - # @param analyzers [Array] + # @param analyzers [Array] # @return [Array] Results from those analyzers # - # source://graphql//lib/graphql/analysis/ast.rb#50 + # source://graphql//lib/graphql/analysis.rb#51 def analyze_query(query, analyzers, multiplex_analyzers: T.unsafe(nil)); end end end +# source://graphql//lib/graphql/analysis.rb#13 +GraphQL::Analysis::AST = GraphQL::Analysis + # Query analyzer for query ASTs. Query analyzers respond to visitor style methods # but are prefixed by `enter` and `leave`. # @@ -162,11 +117,11 @@ end # # @param The [GraphQL::Query, GraphQL::Execution::Multiplex] query or multiplex to analyze # -# source://graphql//lib/graphql/analysis/ast/analyzer.rb#12 -class GraphQL::Analysis::AST::Analyzer +# source://graphql//lib/graphql/analysis/analyzer.rb#11 +class GraphQL::Analysis::Analyzer # @return [Analyzer] a new instance of Analyzer # - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#13 + # source://graphql//lib/graphql/analysis/analyzer.rb#12 def initialize(subject); end # Analyzer hook to decide at analysis time whether a query should @@ -174,103 +129,103 @@ class GraphQL::Analysis::AST::Analyzer # # @return [Boolean] If the query should be analyzed or not # - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#28 + # source://graphql//lib/graphql/analysis/analyzer.rb#27 def analyze?; end - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#44 + # source://graphql//lib/graphql/analysis/analyzer.rb#50 def on_enter_abstract_node(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#44 + # source://graphql//lib/graphql/analysis/analyzer.rb#50 def on_enter_argument(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#44 + # source://graphql//lib/graphql/analysis/analyzer.rb#50 def on_enter_directive(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#44 + # source://graphql//lib/graphql/analysis/analyzer.rb#50 def on_enter_document(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#44 + # source://graphql//lib/graphql/analysis/analyzer.rb#50 def on_enter_enum(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#44 + # source://graphql//lib/graphql/analysis/analyzer.rb#50 def on_enter_field(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#44 + # source://graphql//lib/graphql/analysis/analyzer.rb#50 def on_enter_fragment_spread(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#44 + # source://graphql//lib/graphql/analysis/analyzer.rb#50 def on_enter_inline_fragment(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#44 + # source://graphql//lib/graphql/analysis/analyzer.rb#50 def on_enter_input_object(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#44 + # source://graphql//lib/graphql/analysis/analyzer.rb#50 def on_enter_list_type(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#44 + # source://graphql//lib/graphql/analysis/analyzer.rb#50 def on_enter_non_null_type(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#44 + # source://graphql//lib/graphql/analysis/analyzer.rb#50 def on_enter_null_value(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#44 + # source://graphql//lib/graphql/analysis/analyzer.rb#50 def on_enter_operation_definition(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#44 + # source://graphql//lib/graphql/analysis/analyzer.rb#50 def on_enter_type_name(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#44 + # source://graphql//lib/graphql/analysis/analyzer.rb#50 def on_enter_variable_definition(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#44 + # source://graphql//lib/graphql/analysis/analyzer.rb#50 def on_enter_variable_identifier(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#47 + # source://graphql//lib/graphql/analysis/analyzer.rb#53 def on_leave_abstract_node(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#47 + # source://graphql//lib/graphql/analysis/analyzer.rb#53 def on_leave_argument(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#47 + # source://graphql//lib/graphql/analysis/analyzer.rb#53 def on_leave_directive(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#47 + # source://graphql//lib/graphql/analysis/analyzer.rb#53 def on_leave_document(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#47 + # source://graphql//lib/graphql/analysis/analyzer.rb#53 def on_leave_enum(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#47 + # source://graphql//lib/graphql/analysis/analyzer.rb#53 def on_leave_field(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#47 + # source://graphql//lib/graphql/analysis/analyzer.rb#53 def on_leave_fragment_spread(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#47 + # source://graphql//lib/graphql/analysis/analyzer.rb#53 def on_leave_inline_fragment(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#47 + # source://graphql//lib/graphql/analysis/analyzer.rb#53 def on_leave_input_object(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#47 + # source://graphql//lib/graphql/analysis/analyzer.rb#53 def on_leave_list_type(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#47 + # source://graphql//lib/graphql/analysis/analyzer.rb#53 def on_leave_non_null_type(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#47 + # source://graphql//lib/graphql/analysis/analyzer.rb#53 def on_leave_null_value(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#47 + # source://graphql//lib/graphql/analysis/analyzer.rb#53 def on_leave_operation_definition(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#47 + # source://graphql//lib/graphql/analysis/analyzer.rb#53 def on_leave_type_name(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#47 + # source://graphql//lib/graphql/analysis/analyzer.rb#53 def on_leave_variable_definition(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#47 + # source://graphql//lib/graphql/analysis/analyzer.rb#53 def on_leave_variable_identifier(node, parent, visitor); end # The result for this analyzer. Returning {GraphQL::AnalysisError} results @@ -279,97 +234,105 @@ class GraphQL::Analysis::AST::Analyzer # @raise [GraphQL::RequiredImplementationMissingError] # @return [Any] The analyzer result # - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#35 + # source://graphql//lib/graphql/analysis/analyzer.rb#41 def result; end + # Analyzer hook to decide at analysis time whether analysis + # requires a visitor pass; can be disabled for precomputed results. + # + # @return [Boolean] If analysis requires visitation or not + # + # source://graphql//lib/graphql/analysis/analyzer.rb#34 + def visit?; end + protected # @return [GraphQL::Execution::Multiplex, nil] `nil` if this analyzer is visiting a query # - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#80 + # source://graphql//lib/graphql/analysis/analyzer.rb#86 def multiplex; end # @return [GraphQL::Query, nil] `nil` if this analyzer is visiting a multiplex # (When this is `nil`, use `visitor.query` inside visit methods to get the current query) # - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#77 + # source://graphql//lib/graphql/analysis/analyzer.rb#83 def query; end # @return [GraphQL::Query, GraphQL::Execution::Multiplex] Whatever this analyzer is analyzing # - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#73 + # source://graphql//lib/graphql/analysis/analyzer.rb#79 def subject; end class << self private - # source://graphql//lib/graphql/analysis/ast/analyzer.rb#42 + # source://graphql//lib/graphql/analysis/analyzer.rb#48 def build_visitor_hooks(member_name); end end end -# source://graphql//lib/graphql/analysis/ast/field_usage.rb#5 -class GraphQL::Analysis::AST::FieldUsage < ::GraphQL::Analysis::AST::Analyzer +# source://graphql//lib/graphql/analysis/field_usage.rb#4 +class GraphQL::Analysis::FieldUsage < ::GraphQL::Analysis::Analyzer # @return [FieldUsage] a new instance of FieldUsage # - # source://graphql//lib/graphql/analysis/ast/field_usage.rb#6 + # source://graphql//lib/graphql/analysis/field_usage.rb#5 def initialize(query); end - # source://graphql//lib/graphql/analysis/ast/field_usage.rb#13 + # source://graphql//lib/graphql/analysis/field_usage.rb#13 def on_leave_field(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/field_usage.rb#26 + # source://graphql//lib/graphql/analysis/field_usage.rb#26 def result; end private - # source://graphql//lib/graphql/analysis/ast/field_usage.rb#36 + # source://graphql//lib/graphql/analysis/field_usage.rb#37 def extract_deprecated_arguments(argument_values); end + + # source://graphql//lib/graphql/analysis/field_usage.rb#74 + def extract_deprecated_enum_value(enum_type, value); end end # Used under the hood to implement complexity validation, # see {Schema#max_complexity} and {Query#max_complexity} # -# source://graphql//lib/graphql/analysis/ast/max_query_complexity.rb#7 -class GraphQL::Analysis::AST::MaxQueryComplexity < ::GraphQL::Analysis::AST::QueryComplexity - # source://graphql//lib/graphql/analysis/ast/max_query_complexity.rb#8 +# source://graphql//lib/graphql/analysis/max_query_complexity.rb#6 +class GraphQL::Analysis::MaxQueryComplexity < ::GraphQL::Analysis::QueryComplexity + # source://graphql//lib/graphql/analysis/max_query_complexity.rb#7 def result; end end -# source://graphql//lib/graphql/analysis/ast/max_query_depth.rb#5 -class GraphQL::Analysis::AST::MaxQueryDepth < ::GraphQL::Analysis::AST::QueryDepth - # source://graphql//lib/graphql/analysis/ast/max_query_depth.rb#6 +# source://graphql//lib/graphql/analysis/max_query_depth.rb#4 +class GraphQL::Analysis::MaxQueryDepth < ::GraphQL::Analysis::QueryDepth + # source://graphql//lib/graphql/analysis/max_query_depth.rb#5 def result; end end -# source://graphql//lib/graphql/analysis/ast/query_complexity.rb#6 -class GraphQL::Analysis::AST::QueryComplexity < ::GraphQL::Analysis::AST::Analyzer +# Calculate the complexity of a query, using {Field#complexity} values. +# +# source://graphql//lib/graphql/analysis/query_complexity.rb#5 +class GraphQL::Analysis::QueryComplexity < ::GraphQL::Analysis::Analyzer # State for the query complexity calculation: # - `complexities_on_type` holds complexity scores for each type # # @return [QueryComplexity] a new instance of QueryComplexity # - # source://graphql//lib/graphql/analysis/ast/query_complexity.rb#9 + # source://graphql//lib/graphql/analysis/query_complexity.rb#8 def initialize(query); end - # source://graphql//lib/graphql/analysis/ast/query_complexity.rb#61 + # source://graphql//lib/graphql/analysis/query_complexity.rb#49 def on_enter_field(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/query_complexity.rb#83 + # source://graphql//lib/graphql/analysis/query_complexity.rb#67 def on_leave_field(node, parent, visitor); end - # Overide this method to use the complexity result + # Override this method to use the complexity result # - # source://graphql//lib/graphql/analysis/ast/query_complexity.rb#15 + # source://graphql//lib/graphql/analysis/query_complexity.rb#15 def result; end private - # @return [Boolean] - # - # source://graphql//lib/graphql/analysis/ast/query_complexity.rb#161 - def applies_to?(query, left_scope, right_scope); end - # A hook which is called whenever a field's max complexity is calculated. # Override this method to capture individual field complexity details. # @@ -377,256 +340,266 @@ class GraphQL::Analysis::AST::QueryComplexity < ::GraphQL::Analysis::AST::Analyz # @param max_complexity [Numeric] Field's maximum complexity including child complexity # @param child_complexity [Numeric, nil] Field's child complexity # - # source://graphql//lib/graphql/analysis/ast/query_complexity.rb#179 + # source://graphql//lib/graphql/analysis/query_complexity.rb#136 def field_complexity(scoped_type_complexity, max_complexity:, child_complexity: T.unsafe(nil)); end # @return [Integer] # - # source://graphql//lib/graphql/analysis/ast/query_complexity.rb#95 + # source://graphql//lib/graphql/analysis/query_complexity.rb#80 def max_possible_complexity; end - # (`{field_key => complexity}`) - # - # @param children_for_scope [Array] An array of `scoped_children[scope]` hashes - # @return [Integer] Complexity value for all these selections in the current scope + # @param inner_selections [Array>] Field selections for a scope + # @return [Integer] Total complexity value for all these selections in the parent scope # - # source://graphql//lib/graphql/analysis/ast/query_complexity.rb#185 - def merged_max_complexity(query, children_for_scope); end + # source://graphql//lib/graphql/analysis/query_complexity.rb#141 + def merged_max_complexity(query, inner_selections); end # @param query [GraphQL::Query] Used for `query.possible_types` - # @param scoped_children_hashes [Array] Array of scoped children hashes + # @param scopes [Array] Array of scoped type complexities # @return [Integer] # - # source://graphql//lib/graphql/analysis/ast/query_complexity.rb#107 - def merged_max_complexity_for_scopes(query, scoped_children_hashes); end + # source://graphql//lib/graphql/analysis/query_complexity.rb#89 + def merged_max_complexity_for_scopes(query, scopes); end + + # @return [Boolean] + # + # source://graphql//lib/graphql/analysis/query_complexity.rb#123 + def types_intersect?(query, a, b); end end -# source://graphql//lib/graphql/analysis/ast/query_complexity.rb#19 -class GraphQL::Analysis::AST::QueryComplexity::ScopedTypeComplexity +# ScopedTypeComplexity models a tree of GraphQL types mapped to inner selections, ie: +# Hash> +# +# source://graphql//lib/graphql/analysis/query_complexity.rb#21 +class GraphQL::Analysis::QueryComplexity::ScopedTypeComplexity < ::Hash # @param parent_type [Class] The owner of `field_definition` # @param field_definition [GraphQL::Field, GraphQL::Schema::Field] Used for getting the `.complexity` configuration # @param query [GraphQL::Query] Used for `query.possible_types` # @param response_path [Array] The path to the response key for the field - # @return [ScopedTypeComplexity] a new instance of ScopedTypeComplexity + # @return [Hash>] # - # source://graphql//lib/graphql/analysis/ast/query_complexity.rb#30 + # source://graphql//lib/graphql/analysis/query_complexity.rb#32 def initialize(parent_type, field_definition, query, response_path); end # Returns the value of attribute field_definition. # - # source://graphql//lib/graphql/analysis/ast/query_complexity.rb#24 + # source://graphql//lib/graphql/analysis/query_complexity.rb#25 def field_definition; end # @return [Array] # - # source://graphql//lib/graphql/analysis/ast/query_complexity.rb#40 + # source://graphql//lib/graphql/analysis/query_complexity.rb#42 def nodes; end - # source://graphql//lib/graphql/analysis/ast/query_complexity.rb#56 + # source://graphql//lib/graphql/analysis/query_complexity.rb#44 def own_complexity(child_complexity); end # Returns the value of attribute query. # - # source://graphql//lib/graphql/analysis/ast/query_complexity.rb#24 + # source://graphql//lib/graphql/analysis/query_complexity.rb#25 def query; end # Returns the value of attribute response_path. # - # source://graphql//lib/graphql/analysis/ast/query_complexity.rb#24 + # source://graphql//lib/graphql/analysis/query_complexity.rb#25 def response_path; end - - # This value is only calculated when asked for to avoid needless hash allocations. - # Also, if it's never asked for, we determine that this scope complexity - # is a scalar field ({#terminal?}). - # - # @return [Hash ScopedTypeComplexity>]] Hash ScopedTypeComplexity>] - # - # source://graphql//lib/graphql/analysis/ast/query_complexity.rb#52 - def scoped_children; end - - # Returns true if this field has no selections, ie, it's a scalar. - # We need a quick way to check whether we should continue traversing. - # - # @return [Boolean] - # - # source://graphql//lib/graphql/analysis/ast/query_complexity.rb#44 - def terminal?; end end -# A single proc for {#scoped_children} hashes. Use this to avoid repeated allocations, -# since the lexical binding isn't important. +# A proc for defaulting empty namespace requests as a new scope hash. # -# source://graphql//lib/graphql/analysis/ast/query_complexity.rb#22 -GraphQL::Analysis::AST::QueryComplexity::ScopedTypeComplexity::HASH_CHILDREN = T.let(T.unsafe(nil), Proc) +# source://graphql//lib/graphql/analysis/query_complexity.rb#23 +GraphQL::Analysis::QueryComplexity::ScopedTypeComplexity::DEFAULT_PROC = T.let(T.unsafe(nil), Proc) -# source://graphql//lib/graphql/analysis/ast/query_depth.rb#27 -class GraphQL::Analysis::AST::QueryDepth < ::GraphQL::Analysis::AST::Analyzer +# A query reducer for measuring the depth of a given query. +# +# See https://graphql-ruby.org/queries/ast_analysis.html for more examples. +# +# @example Logging the depth of a query +# class LogQueryDepth < GraphQL::Analysis::QueryDepth +# def result +# log("GraphQL query depth: #{@max_depth}") +# end +# end +# +# # In your Schema file: +# +# class MySchema < GraphQL::Schema +# query_analyzer LogQueryDepth +# end +# +# # When you run the query, the depth will get logged: +# +# Schema.execute(query_str) +# # GraphQL query depth: 8 +# +# source://graphql//lib/graphql/analysis/query_depth.rb#26 +class GraphQL::Analysis::QueryDepth < ::GraphQL::Analysis::Analyzer # @return [QueryDepth] a new instance of QueryDepth # - # source://graphql//lib/graphql/analysis/ast/query_depth.rb#28 + # source://graphql//lib/graphql/analysis/query_depth.rb#27 def initialize(query); end - # source://graphql//lib/graphql/analysis/ast/query_depth.rb#34 + # source://graphql//lib/graphql/analysis/query_depth.rb#34 def on_enter_field(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/query_depth.rb#40 + # source://graphql//lib/graphql/analysis/query_depth.rb#42 def on_leave_field(node, parent, visitor); end - # source://graphql//lib/graphql/analysis/ast/query_depth.rb#49 + # source://graphql//lib/graphql/analysis/query_depth.rb#53 def result; end end # Depth first traversal through a query AST, calling AST analyzers # along the way. # -# The visitor is a special case of GraphQL::Language::Visitor, visiting +# The visitor is a special case of GraphQL::Language::StaticVisitor, visiting # only the selected operation, providing helpers for common use cases such # as skipped fields and visiting fragment spreads. # -# @see {GraphQL::Analysis::AST::Analyzer} AST Analyzers for queries +# @see {GraphQL::Analysis::Analyzer} AST Analyzers for queries # -# source://graphql//lib/graphql/analysis/ast/visitor.rb#13 -class GraphQL::Analysis::AST::Visitor < ::GraphQL::Language::Visitor +# source://graphql//lib/graphql/analysis/visitor.rb#12 +class GraphQL::Analysis::Visitor < ::GraphQL::Language::StaticVisitor # @return [Visitor] a new instance of Visitor # - # source://graphql//lib/graphql/analysis/ast/visitor.rb#14 + # source://graphql//lib/graphql/analysis/visitor.rb#13 def initialize(query:, analyzers:); end # @return [GraphQL::Argument, nil] The most-recently-entered GraphQL::Argument, if currently inside one # - # source://graphql//lib/graphql/analysis/ast/visitor.rb#224 + # source://graphql//lib/graphql/analysis/visitor.rb#232 def argument_definition; end # @return [GraphQL::Execution::Interpreter::Arguments] Arguments for this node, merging default values, literal values and query variables # @see {GraphQL::Query#arguments_for} # - # source://graphql//lib/graphql/analysis/ast/visitor.rb#48 + # source://graphql//lib/graphql/analysis/visitor.rb#48 def arguments_for(ast_node, field_definition); end - # source://graphql//lib/graphql/analysis/ast/visitor.rb#72 + # source://graphql//lib/graphql/analysis/visitor.rb#72 def call_on_enter_argument(node, parent); end - # source://graphql//lib/graphql/analysis/ast/visitor.rb#72 + # source://graphql//lib/graphql/analysis/visitor.rb#72 def call_on_enter_directive(node, parent); end - # source://graphql//lib/graphql/analysis/ast/visitor.rb#72 + # source://graphql//lib/graphql/analysis/visitor.rb#72 def call_on_enter_field(node, parent); end - # source://graphql//lib/graphql/analysis/ast/visitor.rb#72 + # source://graphql//lib/graphql/analysis/visitor.rb#72 def call_on_enter_fragment_definition(node, parent); end - # source://graphql//lib/graphql/analysis/ast/visitor.rb#72 + # source://graphql//lib/graphql/analysis/visitor.rb#72 def call_on_enter_fragment_spread(node, parent); end - # source://graphql//lib/graphql/analysis/ast/visitor.rb#72 + # source://graphql//lib/graphql/analysis/visitor.rb#72 def call_on_enter_inline_fragment(node, parent); end - # source://graphql//lib/graphql/analysis/ast/visitor.rb#72 + # source://graphql//lib/graphql/analysis/visitor.rb#72 def call_on_enter_operation_definition(node, parent); end - # source://graphql//lib/graphql/analysis/ast/visitor.rb#82 + # source://graphql//lib/graphql/analysis/visitor.rb#82 def call_on_leave_argument(node, parent); end - # source://graphql//lib/graphql/analysis/ast/visitor.rb#82 + # source://graphql//lib/graphql/analysis/visitor.rb#82 def call_on_leave_directive(node, parent); end - # source://graphql//lib/graphql/analysis/ast/visitor.rb#82 + # source://graphql//lib/graphql/analysis/visitor.rb#82 def call_on_leave_field(node, parent); end - # source://graphql//lib/graphql/analysis/ast/visitor.rb#82 + # source://graphql//lib/graphql/analysis/visitor.rb#82 def call_on_leave_fragment_definition(node, parent); end - # source://graphql//lib/graphql/analysis/ast/visitor.rb#82 + # source://graphql//lib/graphql/analysis/visitor.rb#82 def call_on_leave_fragment_spread(node, parent); end - # source://graphql//lib/graphql/analysis/ast/visitor.rb#82 + # source://graphql//lib/graphql/analysis/visitor.rb#82 def call_on_leave_inline_fragment(node, parent); end - # source://graphql//lib/graphql/analysis/ast/visitor.rb#82 + # source://graphql//lib/graphql/analysis/visitor.rb#82 def call_on_leave_operation_definition(node, parent); end # @return [GraphQL::Directive, nil] The most-recently-entered GraphQL::Directive, if currently inside one # - # source://graphql//lib/graphql/analysis/ast/visitor.rb#219 + # source://graphql//lib/graphql/analysis/visitor.rb#227 def directive_definition; end # @return [GraphQL::Field, nil] The most-recently-entered GraphQL::Field, if currently inside one # - # source://graphql//lib/graphql/analysis/ast/visitor.rb#209 + # source://graphql//lib/graphql/analysis/visitor.rb#217 def field_definition; end # @return [Array] Types whose scope we've entered # - # source://graphql//lib/graphql/analysis/ast/visitor.rb#34 + # source://graphql//lib/graphql/analysis/visitor.rb#34 def object_types; end - # source://graphql//lib/graphql/analysis/ast/visitor.rb#163 + # source://graphql//lib/graphql/analysis/visitor.rb#167 def on_argument(node, parent); end - # source://graphql//lib/graphql/analysis/ast/visitor.rb#154 + # source://graphql//lib/graphql/analysis/visitor.rb#158 def on_directive(node, parent); end - # source://graphql//lib/graphql/analysis/ast/visitor.rb#127 + # source://graphql//lib/graphql/analysis/visitor.rb#131 def on_field(node, parent); end - # source://graphql//lib/graphql/analysis/ast/visitor.rb#107 + # source://graphql//lib/graphql/analysis/visitor.rb#107 def on_fragment_definition(node, parent); end - # source://graphql//lib/graphql/analysis/ast/visitor.rb#188 + # source://graphql//lib/graphql/analysis/visitor.rb#192 def on_fragment_spread(node, parent); end - # source://graphql//lib/graphql/analysis/ast/visitor.rb#118 + # source://graphql//lib/graphql/analysis/visitor.rb#118 def on_inline_fragment(node, parent); end - # source://graphql//lib/graphql/analysis/ast/visitor.rb#96 + # source://graphql//lib/graphql/analysis/visitor.rb#96 def on_operation_definition(node, parent); end # @return [GraphQL::BaseType] The type which the current type came from # - # source://graphql//lib/graphql/analysis/ast/visitor.rb#204 + # source://graphql//lib/graphql/analysis/visitor.rb#212 def parent_type_definition; end # @return [GraphQL::Argument, nil] The previous GraphQL argument # - # source://graphql//lib/graphql/analysis/ast/visitor.rb#229 + # source://graphql//lib/graphql/analysis/visitor.rb#237 def previous_argument_definition; end # @return [GraphQL::Field, nil] The GraphQL field which returned the object that the current field belongs to # - # source://graphql//lib/graphql/analysis/ast/visitor.rb#214 + # source://graphql//lib/graphql/analysis/visitor.rb#222 def previous_field_definition; end # @return [GraphQL::Query] the query being visited # - # source://graphql//lib/graphql/analysis/ast/visitor.rb#31 + # source://graphql//lib/graphql/analysis/visitor.rb#31 def query; end # @return [Array] The path to the response key for the current field # - # source://graphql//lib/graphql/analysis/ast/visitor.rb#63 + # source://graphql//lib/graphql/analysis/visitor.rb#63 def response_path; end # @return [Boolean] If the current node should be skipped because of a skip or include directive # - # source://graphql//lib/graphql/analysis/ast/visitor.rb#58 + # source://graphql//lib/graphql/analysis/visitor.rb#58 def skipping?; end # @return [GraphQL::BaseType] The current object type # - # source://graphql//lib/graphql/analysis/ast/visitor.rb#199 + # source://graphql//lib/graphql/analysis/visitor.rb#207 def type_definition; end - # source://graphql//lib/graphql/analysis/ast/visitor.rb#39 + # source://graphql//lib/graphql/analysis/visitor.rb#39 def visit; end # @return [Boolean] If the visitor is currently inside a fragment definition # - # source://graphql//lib/graphql/analysis/ast/visitor.rb#53 + # source://graphql//lib/graphql/analysis/visitor.rb#53 def visiting_fragment_definition?; end private @@ -634,23 +607,23 @@ class GraphQL::Analysis::AST::Visitor < ::GraphQL::Language::Visitor # Visit a fragment spread inline instead of visiting the definition # by itself. # - # source://graphql//lib/graphql/analysis/ast/visitor.rb#237 + # source://graphql//lib/graphql/analysis/visitor.rb#245 def enter_fragment_spread_inline(fragment_spread); end # Visit a fragment spread inline instead of visiting the definition # by itself. # - # source://graphql//lib/graphql/analysis/ast/visitor.rb#253 + # source://graphql//lib/graphql/analysis/visitor.rb#261 def leave_fragment_spread_inline(_fragment_spread); end # @yield [node] # - # source://graphql//lib/graphql/analysis/ast/visitor.rb#262 + # source://graphql//lib/graphql/analysis/visitor.rb#270 def on_fragment_with_type(node); end # @return [Boolean] # - # source://graphql//lib/graphql/analysis/ast/visitor.rb#257 + # source://graphql//lib/graphql/analysis/visitor.rb#265 def skip?(ast_node); end end @@ -755,14 +728,14 @@ module GraphQL::Backtrace::InspectResult # source://graphql//lib/graphql/backtrace/inspect_result.rb#7 def inspect_result(obj); end - # source://graphql//lib/graphql/backtrace/inspect_result.rb#30 + # source://graphql//lib/graphql/backtrace/inspect_result.rb#24 def inspect_truncated(obj); end class << self # source://graphql//lib/graphql/backtrace/inspect_result.rb#7 def inspect_result(obj); end - # source://graphql//lib/graphql/backtrace/inspect_result.rb#30 + # source://graphql//lib/graphql/backtrace/inspect_result.rb#24 def inspect_truncated(obj); end end end @@ -816,30 +789,33 @@ GraphQL::Backtrace::Table::MIN_COL_WIDTH = T.let(T.unsafe(nil), Integer) # source://graphql//lib/graphql/backtrace/trace.rb#4 module GraphQL::Backtrace::Trace - # source://graphql//lib/graphql/backtrace/trace.rb#12 + # source://graphql//lib/graphql/backtrace/trace.rb#5 + def initialize(*args, **kwargs, &block); end + + # source://graphql//lib/graphql/backtrace/trace.rb#18 def analyze_query(query:); end - # source://graphql//lib/graphql/backtrace/trace.rb#30 + # source://graphql//lib/graphql/backtrace/trace.rb#36 def execute_field(field:, query:, ast_node:, arguments:, object:); end - # source://graphql//lib/graphql/backtrace/trace.rb#35 + # source://graphql//lib/graphql/backtrace/trace.rb#41 def execute_field_lazy(field:, query:, ast_node:, arguments:, object:); end - # source://graphql//lib/graphql/backtrace/trace.rb#40 + # source://graphql//lib/graphql/backtrace/trace.rb#46 def execute_multiplex(multiplex:); end - # source://graphql//lib/graphql/backtrace/trace.rb#19 + # source://graphql//lib/graphql/backtrace/trace.rb#25 def execute_query(query:); end - # source://graphql//lib/graphql/backtrace/trace.rb#24 + # source://graphql//lib/graphql/backtrace/trace.rb#30 def execute_query_lazy(query:, multiplex:); end - # source://graphql//lib/graphql/backtrace/trace.rb#5 + # source://graphql//lib/graphql/backtrace/trace.rb#11 def validate(query:, validate:); end private - # source://graphql//lib/graphql/backtrace/trace.rb#71 + # source://graphql//lib/graphql/backtrace/trace.rb#69 def push_field_backtrace_context(field, query, ast_node, arguments, object); end # source://graphql//lib/graphql/backtrace/trace.rb#62 @@ -895,26 +871,7 @@ module GraphQL::Backtrace::Tracer end # source://graphql//lib/graphql/coercion_error.rb#3 -class GraphQL::CoercionError < ::GraphQL::Error - # @return [CoercionError] a new instance of CoercionError - # - # source://graphql//lib/graphql/coercion_error.rb#8 - def initialize(message, extensions: T.unsafe(nil)); end - - # under the `extensions` key. - # - # @return [Hash] Optional custom data for error objects which will be added - # - # source://graphql//lib/graphql/coercion_error.rb#6 - def extensions; end - - # under the `extensions` key. - # - # @return [Hash] Optional custom data for error objects which will be added - # - # source://graphql//lib/graphql/coercion_error.rb#6 - def extensions=(_arg0); end -end +class GraphQL::CoercionError < ::GraphQL::ExecutionError; end # This plugin supports Fiber-based concurrency, along with {GraphQL::Dataloader::Source}. # @@ -935,35 +892,67 @@ end class GraphQL::Dataloader # @return [Dataloader] a new instance of Dataloader # - # source://graphql//lib/graphql/dataloader.rb#52 + # source://graphql//lib/graphql/dataloader.rb#53 def initialize(nonblocking: T.unsafe(nil)); end # @api private Nothing to see here # - # source://graphql//lib/graphql/dataloader.rb#100 + # source://graphql//lib/graphql/dataloader.rb#132 def append_job(&job); end - # source://graphql//lib/graphql/dataloader.rb#234 - def join_queues(previous_queue, next_queue); end + # This method is called when Dataloader is finished using a fiber. + # Use it to perform any cleanup, such as releasing database connections (if required manually) + # + # source://graphql//lib/graphql/dataloader.rb#93 + def cleanup_fiber; end + + # Clear any already-loaded objects from {Source} caches + # + # @return [void] + # + # source://graphql//lib/graphql/dataloader.rb#141 + def clear_cache; end + + # This is called before the fiber is spawned, from the parent context (i.e. from + # the thread or fiber that it is scheduled from). + # + # @return [Hash] Current fiber-local variables + # + # source://graphql//lib/graphql/dataloader.rb#69 + def get_fiber_variables; end # @return [Boolean] # - # source://graphql//lib/graphql/dataloader.rb#60 + # source://graphql//lib/graphql/dataloader.rb#61 def nonblocking?; end - # @api private Move along, move along - # - # source://graphql//lib/graphql/dataloader.rb#136 + # source://graphql//lib/graphql/dataloader.rb#180 def run; end + # source://graphql//lib/graphql/dataloader.rb#230 + def run_fiber(f); end + # Use a self-contained queue for the work in the block. # - # source://graphql//lib/graphql/dataloader.rb#108 + # source://graphql//lib/graphql/dataloader.rb#149 def run_isolated; end + # Set up the fiber variables in a new fiber. + # + # This is called within the fiber, right after it is spawned. + # + # @param vars [Hash] Fiber-local variables from {get_fiber_variables} + # @return [void] + # + # source://graphql//lib/graphql/dataloader.rb#86 + def set_fiber_variables(vars); end + + # source://graphql//lib/graphql/dataloader.rb#234 + def spawn_fiber; end + # truffle-ruby wasn't doing well with the implementation below # - # source://graphql//lib/graphql/dataloader.rb#80 + # source://graphql//lib/graphql/dataloader.rb#112 def with(source_class, *batch_args, **batch_kwargs); end # Tell the dataloader that this fiber is waiting for data. @@ -972,31 +961,19 @@ class GraphQL::Dataloader # # @return [void] # - # source://graphql//lib/graphql/dataloader.rb#94 + # source://graphql//lib/graphql/dataloader.rb#126 def yield; end private - # If there are pending sources, return a fiber for running them. - # Otherwise, return `nil`. - # - # @return [Fiber, nil] - # - # source://graphql//lib/graphql/dataloader.rb#248 - def create_source_fiber; end + # source://graphql//lib/graphql/dataloader.rb#245 + def join_queues(prev_queue, new_queue); end - # source://graphql//lib/graphql/dataloader.rb#276 - def resume(fiber); end + # source://graphql//lib/graphql/dataloader.rb#251 + def spawn_job_fiber; end - # Copies the thread local vars into the fiber thread local vars. Many - # gems (such as RequestStore, MiniRacer, etc.) rely on thread local vars - # to keep track of execution context, and without this they do not - # behave as expected. - # - # @see https://github.com/rmosolgo/graphql-ruby/issues/3449 - # - # source://graphql//lib/graphql/dataloader.rb#288 - def spawn_fiber; end + # source://graphql//lib/graphql/dataloader.rb#261 + def spawn_source_fiber; end class << self # Returns the value of attribute default_nonblocking. @@ -1017,13 +994,27 @@ class GraphQL::Dataloader # Call the block with a Dataloader instance, # then run all enqueued jobs and return the result of the block. # - # source://graphql//lib/graphql/dataloader.rb#42 + # source://graphql//lib/graphql/dataloader.rb#43 def with_dataloading(&block); end end end +# source://graphql//lib/graphql/dataloader/async_dataloader.rb#4 +class GraphQL::Dataloader::AsyncDataloader < ::GraphQL::Dataloader + # source://graphql//lib/graphql/dataloader/async_dataloader.rb#14 + def run; end + + # source://graphql//lib/graphql/dataloader/async_dataloader.rb#5 + def yield; end + + private + + # source://graphql//lib/graphql/dataloader/async_dataloader.rb#65 + def spawn_source_task(parent_task, condition); end +end + # source://graphql//lib/graphql/dataloader.rb#30 -class GraphQL::Dataloader::AsyncDataloader < ::GraphQL::Dataloader; end +class GraphQL::Dataloader::NonblockingDataloader < ::GraphQL::Dataloader; end # The default implementation of dataloading -- all no-ops. # @@ -1036,7 +1027,7 @@ class GraphQL::Dataloader::NullDataloader < ::GraphQL::Dataloader def append_job; end # These are all no-ops because code was - # executed sychronously. + # executed synchronously. # # source://graphql//lib/graphql/dataloader/null_dataloader.rb#12 def run; end @@ -1065,6 +1056,9 @@ class GraphQL::Dataloader::Request # # source://graphql//lib/graphql/dataloader/request.rb#14 def load; end + + # source://graphql//lib/graphql/dataloader/request.rb#18 + def load_with_deprecation_warning; end end # @see Source#request_all which returns an instance of this. @@ -1086,6 +1080,13 @@ end # source://graphql//lib/graphql/dataloader/source.rb#5 class GraphQL::Dataloader::Source + # Clear any already-loaded objects for this source + # + # @return [void] + # + # source://graphql//lib/graphql/dataloader/source.rb#167 + def clear_cache; end + # Returns the value of attribute dataloader. # # source://graphql//lib/graphql/dataloader/source.rb#18 @@ -1117,17 +1118,17 @@ class GraphQL::Dataloader::Source # @param new_results [Hash Object>] key-value pairs to cache in this source # @return [void] # - # source://graphql//lib/graphql/dataloader/source.rb#116 + # source://graphql//lib/graphql/dataloader/source.rb#117 def merge(new_results); end # Returns the value of attribute pending. # - # source://graphql//lib/graphql/dataloader/source.rb#164 + # source://graphql//lib/graphql/dataloader/source.rb#172 def pending; end # @return [Boolean] True if this source has any pending requests for data. # - # source://graphql//lib/graphql/dataloader/source.rb#108 + # source://graphql//lib/graphql/dataloader/source.rb#109 def pending?; end # @return [Dataloader::Request] a pending request for a value from `key`. Call `.load` on that object to wait for the result. @@ -1149,12 +1150,17 @@ class GraphQL::Dataloader::Source # source://graphql//lib/graphql/dataloader/source.rb#34 def result_key_for(value); end + # Returns the value of attribute results. + # + # source://graphql//lib/graphql/dataloader/source.rb#172 + def results; end + # Called by {GraphQL::Dataloader} to resolve and pending requests to this source. # # @api private # @return [void] # - # source://graphql//lib/graphql/dataloader/source.rb#127 + # source://graphql//lib/graphql/dataloader/source.rb#128 def run_pending_keys; end # Called by {Dataloader} to prepare the {Source}'s internal state @@ -1169,7 +1175,7 @@ class GraphQL::Dataloader::Source # # @return [void] # - # source://graphql//lib/graphql/dataloader/source.rb#94 + # source://graphql//lib/graphql/dataloader/source.rb#95 def sync(pending_result_keys); end private @@ -1180,7 +1186,7 @@ class GraphQL::Dataloader::Source # @param key [Object] key passed to {#load} or {#load_all} # @return [Object] The result from {#fetch} for `key`. # - # source://graphql//lib/graphql/dataloader/source.rb#172 + # source://graphql//lib/graphql/dataloader/source.rb#180 def result_for(key); end class << self @@ -1199,11 +1205,14 @@ class GraphQL::Dataloader::Source # @param batch_kwargs [Hash] # @return [Object] # - # source://graphql//lib/graphql/dataloader/source.rb#160 + # source://graphql//lib/graphql/dataloader/source.rb#161 def batch_key_for(*batch_args, **batch_kwargs); end end end +# source://graphql//lib/graphql/dataloader/source.rb#91 +GraphQL::Dataloader::Source::MAX_ITERATIONS = T.let(T.unsafe(nil), Integer) + # This error is raised when `Types::ISO8601Date` is asked to return a value # that cannot be parsed to a Ruby Date. # @@ -1222,14 +1231,6 @@ class GraphQL::DateEncodingError < ::GraphQL::RuntimeTypeError def date_value; end end -# source://graphql//lib/graphql/deprecation.rb#4 -module GraphQL::Deprecation - class << self - # source://graphql//lib/graphql/deprecation.rb#5 - def warn(message); end - end -end - # source://graphql//lib/graphql/dig.rb#3 module GraphQL::Dig # implemented using the old activesupport #dig instead of the ruby built-in @@ -1243,16 +1244,34 @@ module GraphQL::Dig def dig(own_key, *rest_keys); end end -# source://graphql//lib/graphql.rb#72 +# This error is raised when `Types::ISO8601Duration` is asked to return a value +# that cannot be parsed as an ISO8601-formatted duration by ActiveSupport::Duration. +# +# @see GraphQL::Types::ISO8601Duration which raises this error +# +# source://graphql//lib/graphql/duration_encoding_error.rb#7 +class GraphQL::DurationEncodingError < ::GraphQL::RuntimeTypeError + # @return [DurationEncodingError] a new instance of DurationEncodingError + # + # source://graphql//lib/graphql/duration_encoding_error.rb#11 + def initialize(value); end + + # The value which couldn't be encoded + # + # source://graphql//lib/graphql/duration_encoding_error.rb#9 + def duration_value; end +end + +# source://graphql//lib/graphql.rb#65 module GraphQL::EmptyObjects; end -# source://graphql//lib/graphql.rb#74 +# source://graphql//lib/graphql.rb#67 GraphQL::EmptyObjects::EMPTY_ARRAY = T.let(T.unsafe(nil), Array) -# source://graphql//lib/graphql.rb#73 +# source://graphql//lib/graphql.rb#66 GraphQL::EmptyObjects::EMPTY_HASH = T.let(T.unsafe(nil), Hash) -# source://graphql//lib/graphql.rb#17 +# source://graphql//lib/graphql.rb#9 class GraphQL::Error < ::StandardError; end # source://graphql//lib/graphql/execution/directive_checks.rb#3 @@ -1320,28 +1339,10 @@ class GraphQL::Execution::Interpreter # @param queries [Array] # @param context [Hash] # @param max_complexity [Integer, nil] - # @return [Array] One result per query + # @return [Array] One result per query # # source://graphql//lib/graphql/execution/interpreter.rb#24 def run_all(schema, query_options, context: T.unsafe(nil), max_complexity: T.unsafe(nil)); end - - private - - # source://graphql//lib/graphql/execution/interpreter.rb#204 - def call_after_hooks(instrumenters, object, after_hook_name, ex); end - - # Call each before hook, and if they all succeed, yield. - # If they don't all succeed, call after_ for each one that succeeded. - # - # source://graphql//lib/graphql/execution/interpreter.rb#179 - def call_hooks(instrumenters, object, before_hook_name, after_hook_name); end - - # Call the before_ hooks of each query, - # Then yield if no errors. - # `call_hooks` takes care of appropriate cleanup. - # - # source://graphql//lib/graphql/execution/interpreter.rb#164 - def each_query_call_hooks(instrumenters, queries, i = T.unsafe(nil)); end end end @@ -1354,21 +1355,26 @@ class GraphQL::Execution::Interpreter::ArgumentValue # @return [ArgumentValue] a new instance of ArgumentValue # # source://graphql//lib/graphql/execution/interpreter/argument_value.rb#9 - def initialize(definition:, value:, default_used:); end + def initialize(definition:, value:, original_value:, default_used:); end # @return [Boolean] `true` if the schema-defined `default_value:` was applied in this case. (No client-provided value was present.) # - # source://graphql//lib/graphql/execution/interpreter/argument_value.rb#22 + # source://graphql//lib/graphql/execution/interpreter/argument_value.rb#26 def default_used?; end # @return [GraphQL::Schema::Argument] The definition instance for this argument # - # source://graphql//lib/graphql/execution/interpreter/argument_value.rb#19 + # source://graphql//lib/graphql/execution/interpreter/argument_value.rb#23 def definition; end + # @return [Object] The value of this argument _before_ `prepare` is applied. + # + # source://graphql//lib/graphql/execution/interpreter/argument_value.rb#20 + def original_value; end + # @return [Object] The Ruby-ready value for this Argument # - # source://graphql//lib/graphql/execution/interpreter/argument_value.rb#16 + # source://graphql//lib/graphql/execution/interpreter/argument_value.rb#17 def value; end end @@ -1495,11 +1501,11 @@ class GraphQL::Execution::Interpreter::ExecutionErrors def add(err_or_msg); end end -# source://graphql//lib/graphql/execution/interpreter.rb#216 +# source://graphql//lib/graphql/execution/interpreter.rb#150 class GraphQL::Execution::Interpreter::ListResultFailedError < ::GraphQL::Error # @return [ListResultFailedError] a new instance of ListResultFailedError # - # source://graphql//lib/graphql/execution/interpreter.rb#217 + # source://graphql//lib/graphql/execution/interpreter.rb#151 def initialize(value:, path:, field:); end end @@ -1553,12 +1559,12 @@ end # # @api private # -# source://graphql//lib/graphql/execution/interpreter/runtime.rb#10 +# source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#6 class GraphQL::Execution::Interpreter::Runtime # @api private # @return [Runtime] a new instance of Runtime # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#194 + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#38 def initialize(query:, lazies_at_depth:); end # @api private @@ -1568,23 +1574,23 @@ class GraphQL::Execution::Interpreter::Runtime # @param trace [Boolean] If `false`, don't wrap this with field tracing # @return [GraphQL::Execution::Lazy, Object] If loading `object` will be deferred, it's a wrapper over it. # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#962 - def after_lazy(lazy_obj, field:, owner_object:, arguments:, ast_node:, result:, result_name:, eager: T.unsafe(nil), trace: T.unsafe(nil), &block); end + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#756 + def after_lazy(lazy_obj, field:, owner_object:, arguments:, ast_node:, result:, result_name:, runtime_state:, eager: T.unsafe(nil), trace: T.unsafe(nil), &block); end # @api private # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#1012 + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#810 def arguments(graphql_object, arg_owner, ast_node); end # @api private # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#891 + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#686 def call_method_on_directives(method_name, object, directives, &block); end # @api private # @return [GraphQL::Query::Context] # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#192 + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#36 def context; end # The resolver for `field` returned `value`. Continue to execute the query, @@ -1597,28 +1603,22 @@ class GraphQL::Execution::Interpreter::Runtime # @api private # @return [Lazy, Array, Hash, Object] Lazy, Array, and Hash are all traversed to resolve lazy values later # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#736 - def continue_field(value, owner_type, field, current_type, ast_node, next_selections, is_non_null, owner_object, arguments, result_name, selection_result); end + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#557 + def continue_field(value, owner_type, field, current_type, ast_node, next_selections, is_non_null, owner_object, arguments, result_name, selection_result, was_scoped, runtime_state); end # @api private # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#632 - def continue_value(value, parent_type, field, is_non_null, ast_node, result_name, selection_result); end + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#451 + def continue_value(value, field, is_non_null, ast_node, result_name, selection_result); end # @api private # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#620 + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#439 def current_path; end - # @api private - # @return [Boolean] - # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#573 - def dead_result?(selection_result); end - # @api private # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#1021 + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#819 def delete_all_interpreter_context; end # Check {Schema::Directive.include?} for each directive that's present @@ -1626,81 +1626,86 @@ class GraphQL::Execution::Interpreter::Runtime # @api private # @return [Boolean] # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#924 + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#718 def directives_include?(node, graphql_object, parent_type); end + # @api private + # + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#110 + def each_gathered_selections(response_hash); end + # @api private # @return [void] # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#400 - def evaluate_selection(result_name, field_ast_nodes_or_ast_node, owner_object, owner_type, is_eager_field, selections_result, parent_object); end + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#234 + def evaluate_selection(result_name, field_ast_nodes_or_ast_node, selections_result); end # @api private # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#462 - def evaluate_selection_with_args(arguments, field_defn, ast_node, field_ast_nodes, owner_type, object, is_eager_field, result_name, selection_result, parent_object, return_type, return_type_non_null); end + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#278 + def evaluate_selection_with_args(arguments, field_defn, ast_node, field_ast_nodes, object, result_name, selection_result, runtime_state); end # @api private # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#518 - def evaluate_selection_with_resolved_keyword_args(kwarg_arguments, resolved_arguments, field_defn, ast_node, field_ast_nodes, owner_type, object, is_eager_field, result_name, selection_result, parent_object, return_type, return_type_non_null); end + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#336 + def evaluate_selection_with_resolved_keyword_args(kwarg_arguments, resolved_arguments, field_defn, ast_node, field_ast_nodes, object, result_name, selection_result, runtime_state); end # @api private # @return [void] # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#370 - def evaluate_selections(owner_object, owner_type, is_eager_selection, gathered_selections, selections_result, target_result, parent_object); end + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#198 + def evaluate_selections(gathered_selections, selections_result, target_result, runtime_state); end # @api private # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#222 + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#60 def final_result; end # @api private # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#302 + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#121 def gather_selections(owner_object, owner_type, selections, selections_to_run = T.unsafe(nil), selections_by_name = T.unsafe(nil)); end # @api private # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#935 + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#729 def get_current_runtime_state; end # @api private # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#226 + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#64 def inspect; end # @api private # @return [Boolean] # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#1048 + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#846 def lazy?(object); end # @api private # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#945 + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#739 def minimal_after_lazy(value, &block); end # @api private # @return [GraphQL::Query] # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#186 + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#30 def query; end # @api private # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#876 - def resolve_list_item(inner_value, inner_type, inner_type_non_null, ast_node, field, owner_object, arguments, this_idx, response_list, next_selections, owner_type); end + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#672 + def resolve_list_item(inner_value, inner_type, inner_type_non_null, ast_node, field, owner_object, arguments, this_idx, response_list, owner_type, was_scoped, runtime_state); end # @api private # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#1032 + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#830 def resolve_type(type, value); end # @api private # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#896 + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#691 def run_directive(method_name, object, directives, idx, &block); end # This _begins_ the execution. Some deferred work @@ -1709,13 +1714,13 @@ class GraphQL::Execution::Interpreter::Runtime # @api private # @return [void] # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#243 + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#71 def run_eager; end # @api private # @return [Class] # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#189 + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#33 def schema; end # Mark this node and any already-registered children as dead, @@ -1723,243 +1728,228 @@ class GraphQL::Execution::Interpreter::Runtime # # @api private # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#607 + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#426 def set_graphql_dead(selection_result); end # @api private # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#577 + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#396 def set_result(selection_result, result_name, value, is_child_result, is_non_null); end - - # @api private - # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#230 - def tap_or_each(obj_or_array); end end # @api private # -# source://graphql//lib/graphql/execution/interpreter/runtime.rb#11 +# source://graphql//lib/graphql/execution/interpreter/runtime.rb#12 class GraphQL::Execution::Interpreter::Runtime::CurrentState # @api private # @return [CurrentState] a new instance of CurrentState # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#12 + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#13 def initialize; end # @api private # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#20 + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#25 def current_arguments; end # @api private # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#20 + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#25 def current_arguments=(_arg0); end # @api private # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#20 + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#25 def current_field; end # @api private # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#20 + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#25 def current_field=(_arg0); end # @api private # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#20 + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#21 def current_object; end # @api private # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#20 - def current_object=(_arg0); end - - # @api private - # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#20 + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#25 def current_result; end # @api private # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#20 + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#25 def current_result=(_arg0); end # @api private # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#20 + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#25 def current_result_name; end # @api private # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#20 + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#25 def current_result_name=(_arg0); end -end -# @api private -# -# source://graphql//lib/graphql/execution/interpreter/runtime.rb#24 -module GraphQL::Execution::Interpreter::Runtime::GraphQLResult # @api private # # source://graphql//lib/graphql/execution/interpreter/runtime.rb#25 - def initialize(result_name, parent_result, is_non_null_in_parent); end + def was_authorized_by_scope_items; end # @api private # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#40 + # source://graphql//lib/graphql/execution/interpreter/runtime.rb#25 + def was_authorized_by_scope_items=(_arg0); end +end + +# source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#7 +module GraphQL::Execution::Interpreter::Runtime::GraphQLResult + # source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#8 + def initialize(result_name, result_type, application_value, parent_result, is_non_null_in_parent, selections, is_eager); end + + # source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#27 def build_path(path_array); end - # @api private + # Returns the value of attribute graphql_application_value. + # + # source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#33 + def graphql_application_value; end + + # Returns the value of attribute graphql_dead. # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#45 + # source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#32 def graphql_dead; end - # @api private + # Sets the attribute graphql_dead # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#45 + # @param value the value to set the attribute graphql_dead to. + # + # source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#32 def graphql_dead=(_arg0); end - # @api private + # Returns the value of attribute graphql_is_eager. + # + # source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#33 + def graphql_is_eager; end + + # Returns the value of attribute graphql_is_non_null_in_parent. # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#46 + # source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#33 def graphql_is_non_null_in_parent; end - # @api private + # Returns the value of attribute graphql_parent. # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#46 + # source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#33 def graphql_parent; end - # @api private # @return [Hash] Plain-Ruby result data (`@graphql_metadata` contains Result wrapper objects) # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#49 + # source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#37 def graphql_result_data; end - # @api private # @return [Hash] Plain-Ruby result data (`@graphql_metadata` contains Result wrapper objects) # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#49 + # source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#37 def graphql_result_data=(_arg0); end - # @api private + # Returns the value of attribute graphql_result_name. # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#46 + # source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#33 def graphql_result_name; end - # @api private + # Returns the value of attribute graphql_result_type. # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#36 + # source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#33 + def graphql_result_type; end + + # Returns the value of attribute graphql_selections. + # + # source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#33 + def graphql_selections; end + + # source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#23 def path; end end -# @api private -# -# source://graphql//lib/graphql/execution/interpreter/runtime.rb#138 +# source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#126 class GraphQL::Execution::Interpreter::Runtime::GraphQLResultArray include ::GraphQL::Execution::Interpreter::Runtime::GraphQLResult - # @api private # @return [GraphQLResultArray] a new instance of GraphQLResultArray # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#141 - def initialize(_result_name, _parent_result, _is_non_null_in_parent); end + # source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#129 + def initialize(_result_name, _result_type, _application_value, _parent_result, _is_non_null_in_parent, _selections, _is_eager); end - # @api private - # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#146 + # source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#134 def graphql_skip_at(index); end - # @api private - # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#168 + # source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#156 def set_child_result(idx, value); end - # @api private - # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#158 + # source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#146 def set_leaf(idx, value); end - # @api private - # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#180 + # source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#168 def values; end end -# @api private -# -# source://graphql//lib/graphql/execution/interpreter/runtime.rb#52 +# source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#40 class GraphQL::Execution::Interpreter::Runtime::GraphQLResultHash include ::GraphQL::Execution::Interpreter::Runtime::GraphQLResult - # @api private # @return [GraphQLResultHash] a new instance of GraphQLResultHash # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#53 - def initialize(_result_name, _parent_result, _is_non_null_in_parent); end + # source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#41 + def initialize(_result_name, _result_type, _application_value, _parent_result, _is_non_null_in_parent, _selections, _is_eager); end - # @api private - # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#110 + # source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#98 def [](k); end - # @api private - # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#93 + # source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#81 def delete(key); end - # @api private - # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#98 + # source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#86 def each; end - # @api private + # Returns the value of attribute graphql_merged_into. # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#60 + # source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#48 def graphql_merged_into; end - # @api private + # Sets the attribute graphql_merged_into # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#60 + # @param value the value to set the attribute graphql_merged_into to. + # + # source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#48 def graphql_merged_into=(_arg0); end - # @api private # @return [Boolean] # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#106 + # source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#94 def key?(k); end - # @api private - # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#114 + # source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#102 def merge_into(into_result); end - # @api private - # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#82 + # source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#70 def set_child_result(key, value); end - # @api private - # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#62 + # source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#50 def set_leaf(key, value); end - # @api private - # - # source://graphql//lib/graphql/execution/interpreter/runtime.rb#102 + # source://graphql//lib/graphql/execution/interpreter/runtime/graphql_result.rb#90 def values; end end # @api private # -# source://graphql//lib/graphql/execution/interpreter/runtime.rb#631 +# source://graphql//lib/graphql/execution/interpreter/runtime.rb#450 GraphQL::Execution::Interpreter::Runtime::HALT = T.let(T.unsafe(nil), Object) # @api private # -# source://graphql//lib/graphql/execution/interpreter/runtime.rb#367 +# source://graphql//lib/graphql/execution/interpreter/runtime.rb#195 GraphQL::Execution::Interpreter::Runtime::NO_ARGS = T.let(T.unsafe(nil), Hash) # This wraps a value which is available, but not yet calculated, like a promise or future. @@ -2155,6 +2145,14 @@ class GraphQL::Execution::Lookahead # source://graphql//lib/graphql/execution/lookahead.rb#34 def initialize(query:, ast_nodes:, field: T.unsafe(nil), root_type: T.unsafe(nil), owner_type: T.unsafe(nil)); end + # Like {#selection}, but for aliases. + # It returns a null object (check with {#selected?}) + # + # @return [GraphQL::Execution::Lookahead] + # + # source://graphql//lib/graphql/execution/lookahead.rb#140 + def alias_selection(alias_name, selected_type: T.unsafe(nil), arguments: T.unsafe(nil)); end + # @return [Hash] # # source://graphql//lib/graphql/execution/lookahead.rb#53 @@ -2170,7 +2168,7 @@ class GraphQL::Execution::Lookahead # source://graphql//lib/graphql/execution/lookahead.rb#47 def field; end - # source://graphql//lib/graphql/execution/lookahead.rb#186 + # source://graphql//lib/graphql/execution/lookahead.rb#209 def inspect; end # The method name of the field. @@ -2183,7 +2181,7 @@ class GraphQL::Execution::Lookahead # end # @return [Symbol] # - # source://graphql//lib/graphql/execution/lookahead.rb#182 + # source://graphql//lib/graphql/execution/lookahead.rb#205 def name; end # @return [GraphQL::Schema::Object, GraphQL::Schema::Union, GraphQL::Schema::Interface] @@ -2193,7 +2191,7 @@ class GraphQL::Execution::Lookahead # @return [Boolean] True if this lookahead represents a field that was requested # - # source://graphql//lib/graphql/execution/lookahead.rb#84 + # source://graphql//lib/graphql/execution/lookahead.rb#100 def selected?; end # Like {#selects?}, but can be used for chaining. @@ -2202,7 +2200,7 @@ class GraphQL::Execution::Lookahead # @param field_name [String, Symbol] # @return [GraphQL::Execution::Lookahead] # - # source://graphql//lib/graphql/execution/lookahead.rb#92 + # source://graphql//lib/graphql/execution/lookahead.rb#108 def selection(field_name, selected_type: T.unsafe(nil), arguments: T.unsafe(nil)); end # Like {#selection}, but for all nodes. @@ -2220,7 +2218,7 @@ class GraphQL::Execution::Lookahead # @param arguments [Hash] Arguments which must match in the selection # @return [Array] # - # source://graphql//lib/graphql/execution/lookahead.rb#151 + # source://graphql//lib/graphql/execution/lookahead.rb#174 def selections(arguments: T.unsafe(nil)); end # True if this node has a selection on `field_name`. @@ -2240,61 +2238,93 @@ class GraphQL::Execution::Lookahead # source://graphql//lib/graphql/execution/lookahead.rb#79 def selects?(field_name, selected_type: T.unsafe(nil), arguments: T.unsafe(nil)); end + # True if this node has a selection with alias matching `alias_name`. + # If `alias_name` is a String, it is treated as a GraphQL-style (camelized) + # field name and used verbatim. If `alias_name` is a Symbol, it is + # treated as a Ruby-style (underscored) name and camelized before comparing. + # + # If `arguments:` is provided, each provided key/value will be matched + # against the arguments in the next selection. This method will return false + # if any of the given `arguments:` are not present and matching in the next selection. + # (But, the next selection may contain _more_ than the given arguments.) + # + # @param alias_name [String, Symbol] + # @param arguments [Hash] Arguments which must match in the selection + # @return [Boolean] + # + # source://graphql//lib/graphql/execution/lookahead.rb#95 + def selects_alias?(alias_name, arguments: T.unsafe(nil)); end + private + # source://graphql//lib/graphql/execution/lookahead.rb#349 + def alias_selections; end + # @return [Boolean] # - # source://graphql//lib/graphql/execution/lookahead.rb#296 + # source://graphql//lib/graphql/execution/lookahead.rb#319 def arguments_match?(arguments, field_defn, field_node); end # If a selection on `node` matches `field_name` (which is backed by `field_defn`) # and matches the `arguments:` constraints, then add that node to `matches` # - # source://graphql//lib/graphql/execution/lookahead.rb#274 - def find_selected_nodes(node, field_defn, arguments:, matches:); end + # source://graphql//lib/graphql/execution/lookahead.rb#297 + def find_selected_nodes(node, field_name, field_defn, arguments:, matches:, alias_name: T.unsafe(nil)); end - # source://graphql//lib/graphql/execution/lookahead.rb#234 + # source://graphql//lib/graphql/execution/lookahead.rb#257 def find_selections(subselections_by_type, selections_on_type, selected_type, ast_selections, arguments); end + # source://graphql//lib/graphql/execution/lookahead.rb#333 + def lookahead_for_selection(field_defn, selected_type, arguments, alias_name = T.unsafe(nil)); end + + # source://graphql//lib/graphql/execution/lookahead.rb#354 + def lookup_alias_node(nodes, name); end + + # source://graphql//lib/graphql/execution/lookahead.rb#373 + def lookup_fragment(ast_selection); end + # @return [Boolean] # - # source://graphql//lib/graphql/execution/lookahead.rb#222 + # source://graphql//lib/graphql/execution/lookahead.rb#245 def skipped_by_directive?(ast_selection); end + + # source://graphql//lib/graphql/execution/lookahead.rb#362 + def unwrap_fragments(node); end end # A singleton, so that misses don't come with overhead. # -# source://graphql//lib/graphql/execution/lookahead.rb#218 +# source://graphql//lib/graphql/execution/lookahead.rb#241 GraphQL::Execution::Lookahead::NULL_LOOKAHEAD = T.let(T.unsafe(nil), GraphQL::Execution::Lookahead::NullLookahead) # This is returned for {Lookahead#selection} when a non-existent field is passed # -# source://graphql//lib/graphql/execution/lookahead.rb#191 +# source://graphql//lib/graphql/execution/lookahead.rb#214 class GraphQL::Execution::Lookahead::NullLookahead < ::GraphQL::Execution::Lookahead # No inputs required here. # # @return [NullLookahead] a new instance of NullLookahead # - # source://graphql//lib/graphql/execution/lookahead.rb#193 + # source://graphql//lib/graphql/execution/lookahead.rb#216 def initialize; end - # source://graphql//lib/graphql/execution/lookahead.rb#212 + # source://graphql//lib/graphql/execution/lookahead.rb#235 def inspect; end # @return [Boolean] # - # source://graphql//lib/graphql/execution/lookahead.rb#196 + # source://graphql//lib/graphql/execution/lookahead.rb#219 def selected?; end - # source://graphql//lib/graphql/execution/lookahead.rb#204 + # source://graphql//lib/graphql/execution/lookahead.rb#227 def selection(*_arg0); end - # source://graphql//lib/graphql/execution/lookahead.rb#208 + # source://graphql//lib/graphql/execution/lookahead.rb#231 def selections(*_arg0); end # @return [Boolean] # - # source://graphql//lib/graphql/execution/lookahead.rb#200 + # source://graphql//lib/graphql/execution/lookahead.rb#223 def selects?(*_arg0); end end @@ -2446,62 +2476,6 @@ class GraphQL::ExecutionError < ::GraphQL::Error def to_h; end end -# @api private -# -# source://graphql//lib/graphql/filter.rb#6 -class GraphQL::Filter - # @api private - # @return [Filter] a new instance of Filter - # - # source://graphql//lib/graphql/filter.rb#7 - def initialize(only: T.unsafe(nil), except: T.unsafe(nil), silence_deprecation_warning: T.unsafe(nil)); end - - # Returns true if `member, ctx` passes this filter - # - # @api private - # - # source://graphql//lib/graphql/filter.rb#17 - def call(member, ctx); end - - # @api private - # - # source://graphql//lib/graphql/filter.rb#22 - def merge(only: T.unsafe(nil), except: T.unsafe(nil)); end -end - -# @api private -# -# source://graphql//lib/graphql/filter.rb#53 -class GraphQL::Filter::MergedExcept < ::GraphQL::Filter::MergedOnly - # @api private - # - # source://graphql//lib/graphql/filter.rb#54 - def call(member, ctx); end -end - -# @api private -# -# source://graphql//lib/graphql/filter.rb#31 -class GraphQL::Filter::MergedOnly - # @api private - # @return [MergedOnly] a new instance of MergedOnly - # - # source://graphql//lib/graphql/filter.rb#32 - def initialize(first, second); end - - # @api private - # - # source://graphql//lib/graphql/filter.rb#37 - def call(member, ctx); end - - class << self - # @api private - # - # source://graphql//lib/graphql/filter.rb#41 - def build(onlies); end - end -end - # This error is raised when `Types::Int` is given an input value outside of 32-bit integer range. # # For really big integer values, consider `GraphQL::Types::BigInt` @@ -2641,28 +2615,23 @@ end # source://graphql//lib/graphql/introspection/schema_type.rb#5 class GraphQL::Introspection::SchemaType < ::GraphQL::Introspection::BaseObject - # source://graphql//lib/graphql/introspection/schema_type.rb#38 + # source://graphql//lib/graphql/introspection/schema_type.rb#41 def directives; end - # source://graphql//lib/graphql/introspection/schema_type.rb#30 + # source://graphql//lib/graphql/introspection/schema_type.rb#33 def mutation_type; end - # source://graphql//lib/graphql/introspection/schema_type.rb#26 + # source://graphql//lib/graphql/introspection/schema_type.rb#29 def query_type; end # source://graphql//lib/graphql/introspection/schema_type.rb#18 def schema_description; end - # source://graphql//lib/graphql/introspection/schema_type.rb#34 + # source://graphql//lib/graphql/introspection/schema_type.rb#37 def subscription_type; end # source://graphql//lib/graphql/introspection/schema_type.rb#22 def types; end - - private - - # source://graphql//lib/graphql/introspection/schema_type.rb#44 - def permitted_root_type(op_type); end end # source://graphql//lib/graphql/introspection/type_kind_enum.rb#4 @@ -2779,20 +2748,31 @@ end # This error is raised when GraphQL-Ruby encounters a situation # that it *thought* would never happen. Please report this bug! # -# source://graphql//lib/graphql.rb#22 +# source://graphql//lib/graphql.rb#14 class GraphQL::InvariantError < ::GraphQL::Error # @return [InvariantError] a new instance of InvariantError # - # source://graphql//lib/graphql.rb#23 + # source://graphql//lib/graphql.rb#15 def initialize(message); end end # source://graphql//lib/graphql/language/block_string.rb#3 module GraphQL::Language class << self + # source://graphql//lib/graphql/language.rb#88 + def add_space_between_numbers_and_names(query_str); end + + # Returns a new string if any single-quoted newlines were escaped. + # Otherwise, returns `query_str` unchanged. + # + # @return [String] + # + # source://graphql//lib/graphql/language.rb#46 + def escape_single_quoted_newlines(query_str); end + # @api private # - # source://graphql//lib/graphql/language.rb#18 + # source://graphql//lib/graphql/language.rb#19 def serialize(value); end end end @@ -2800,9 +2780,16 @@ end # source://graphql//lib/graphql/language/block_string.rb#4 module GraphQL::Language::BlockString class << self - # source://graphql//lib/graphql/language/block_string.rb#82 + # @yield [parts.slice!(0, 3).join] + # + # source://graphql//lib/graphql/language/block_string.rb#94 def break_line(line, length); end + # @return [Boolean] + # + # source://graphql//lib/graphql/language/block_string.rb#110 + def contains_only_whitespace?(line); end + # source://graphql//lib/graphql/language/block_string.rb#61 def print(str, indent: T.unsafe(nil)); end @@ -2837,7 +2824,7 @@ module GraphQL::Language::DefinitionSlice end # source://graphql//lib/graphql/language/definition_slice.rb#18 -class GraphQL::Language::DefinitionSlice::DependencyVisitor < ::GraphQL::Language::Visitor +class GraphQL::Language::DefinitionSlice::DependencyVisitor < ::GraphQL::Language::StaticVisitor # @return [DependencyVisitor] a new instance of DependencyVisitor # # source://graphql//lib/graphql/language/definition_slice.rb#19 @@ -2869,171 +2856,166 @@ class GraphQL::Language::DocumentFromSchemaDefinition # @return [DocumentFromSchemaDefinition] a new instance of DocumentFromSchemaDefinition # # source://graphql//lib/graphql/language/document_from_schema_definition.rb#16 - def initialize(schema, context: T.unsafe(nil), only: T.unsafe(nil), except: T.unsafe(nil), include_introspection_types: T.unsafe(nil), include_built_in_directives: T.unsafe(nil), include_built_in_scalars: T.unsafe(nil), always_include_schema: T.unsafe(nil)); end + def initialize(schema, context: T.unsafe(nil), include_introspection_types: T.unsafe(nil), include_built_in_directives: T.unsafe(nil), include_built_in_scalars: T.unsafe(nil), always_include_schema: T.unsafe(nil)); end # @api private # - # source://graphql//lib/graphql/language/document_from_schema_definition.rb#135 + # source://graphql//lib/graphql/language/document_from_schema_definition.rb#124 def build_argument_node(argument); end # @api private # - # source://graphql//lib/graphql/language/document_from_schema_definition.rb#249 + # source://graphql//lib/graphql/language/document_from_schema_definition.rb#239 def build_argument_nodes(arguments); end # @api private # - # source://graphql//lib/graphql/language/document_from_schema_definition.rb#197 + # source://graphql//lib/graphql/language/document_from_schema_definition.rb#187 def build_default_value(default_value, type); end # @api private # - # source://graphql//lib/graphql/language/document_from_schema_definition.rb#261 + # source://graphql//lib/graphql/language/document_from_schema_definition.rb#255 def build_definition_nodes; end # @api private # - # source://graphql//lib/graphql/language/document_from_schema_definition.rb#176 + # source://graphql//lib/graphql/language/document_from_schema_definition.rb#165 def build_directive_location_node(location); end # @api private # - # source://graphql//lib/graphql/language/document_from_schema_definition.rb#172 + # source://graphql//lib/graphql/language/document_from_schema_definition.rb#161 def build_directive_location_nodes(locations); end # @api private # - # source://graphql//lib/graphql/language/document_from_schema_definition.rb#162 + # source://graphql//lib/graphql/language/document_from_schema_definition.rb#151 def build_directive_node(directive); end # @api private # - # source://graphql//lib/graphql/language/document_from_schema_definition.rb#255 + # source://graphql//lib/graphql/language/document_from_schema_definition.rb#249 def build_directive_nodes(directives); end # @api private # - # source://graphql//lib/graphql/language/document_from_schema_definition.rb#108 + # source://graphql//lib/graphql/language/document_from_schema_definition.rb#97 def build_enum_type_node(enum_type); end # @api private # - # source://graphql//lib/graphql/language/document_from_schema_definition.rb#119 + # source://graphql//lib/graphql/language/document_from_schema_definition.rb#108 def build_enum_value_node(enum_value); end # @api private # - # source://graphql//lib/graphql/language/document_from_schema_definition.rb#79 + # source://graphql//lib/graphql/language/document_from_schema_definition.rb#68 def build_field_node(field); end # @api private # - # source://graphql//lib/graphql/language/document_from_schema_definition.rb#297 + # source://graphql//lib/graphql/language/document_from_schema_definition.rb#290 def build_field_nodes(fields); end # @api private # - # source://graphql//lib/graphql/language/document_from_schema_definition.rb#153 + # source://graphql//lib/graphql/language/document_from_schema_definition.rb#142 def build_input_object_node(input_object); end # @api private # - # source://graphql//lib/graphql/language/document_from_schema_definition.rb#98 + # source://graphql//lib/graphql/language/document_from_schema_definition.rb#87 def build_interface_type_node(interface_type); end # @api private # - # source://graphql//lib/graphql/language/document_from_schema_definition.rb#69 + # source://graphql//lib/graphql/language/document_from_schema_definition.rb#52 def build_object_type_node(object_type); end # @api private # - # source://graphql//lib/graphql/language/document_from_schema_definition.rb#127 + # source://graphql//lib/graphql/language/document_from_schema_definition.rb#116 def build_scalar_type_node(scalar_type); end # @api private # - # source://graphql//lib/graphql/language/document_from_schema_definition.rb#54 + # source://graphql//lib/graphql/language/document_from_schema_definition.rb#37 def build_schema_node; end # @api private # - # source://graphql//lib/graphql/language/document_from_schema_definition.rb#230 + # source://graphql//lib/graphql/language/document_from_schema_definition.rb#220 def build_type_definition_node(type); end # @api private # - # source://graphql//lib/graphql/language/document_from_schema_definition.rb#283 + # source://graphql//lib/graphql/language/document_from_schema_definition.rb#276 def build_type_definition_nodes(types); end # @api private # - # source://graphql//lib/graphql/language/document_from_schema_definition.rb#182 + # source://graphql//lib/graphql/language/document_from_schema_definition.rb#171 def build_type_name_node(type); end # @api private # - # source://graphql//lib/graphql/language/document_from_schema_definition.rb#89 + # source://graphql//lib/graphql/language/document_from_schema_definition.rb#78 def build_union_type_node(union_type); end # @api private # - # source://graphql//lib/graphql/language/document_from_schema_definition.rb#48 + # source://graphql//lib/graphql/language/document_from_schema_definition.rb#31 def document; end private # @api private # - # source://graphql//lib/graphql/language/document_from_schema_definition.rb#354 + # source://graphql//lib/graphql/language/document_from_schema_definition.rb#347 def always_include_schema; end # @api private # - # source://graphql//lib/graphql/language/document_from_schema_definition.rb#321 + # source://graphql//lib/graphql/language/document_from_schema_definition.rb#314 def definition_directives(member, directives_method); end # @api private # - # source://graphql//lib/graphql/language/document_from_schema_definition.rb#317 + # source://graphql//lib/graphql/language/document_from_schema_definition.rb#310 def directives(member); end # @api private # - # source://graphql//lib/graphql/language/document_from_schema_definition.rb#354 + # source://graphql//lib/graphql/language/document_from_schema_definition.rb#347 def include_built_in_directives; end # @api private # - # source://graphql//lib/graphql/language/document_from_schema_definition.rb#354 + # source://graphql//lib/graphql/language/document_from_schema_definition.rb#347 def include_built_in_scalars; end # @api private # - # source://graphql//lib/graphql/language/document_from_schema_definition.rb#354 + # source://graphql//lib/graphql/language/document_from_schema_definition.rb#347 def include_introspection_types; end # @api private # @return [Boolean] # - # source://graphql//lib/graphql/language/document_from_schema_definition.rb#305 + # source://graphql//lib/graphql/language/document_from_schema_definition.rb#298 def include_schema_node?; end # @api private # - # source://graphql//lib/graphql/language/document_from_schema_definition.rb#354 + # source://graphql//lib/graphql/language/document_from_schema_definition.rb#347 def schema; end # @api private # @return [Boolean] # - # source://graphql//lib/graphql/language/document_from_schema_definition.rb#311 + # source://graphql//lib/graphql/language/document_from_schema_definition.rb#304 def schema_respects_root_name_conventions?(schema); end - - # @api private - # - # source://graphql//lib/graphql/language/document_from_schema_definition.rb#354 - def warden; end end # Exposes {.generate}, which turns AST nodes back into query strings. @@ -3057,216 +3039,226 @@ module GraphQL::Language::Generation def generate(node, indent: T.unsafe(nil), printer: T.unsafe(nil)); end end -# source://graphql//lib/graphql/language/lexer.rb#7 -module GraphQL::Language::Lexer - include ::GraphQL::Language::Lexer::Literals +# source://graphql//lib/graphql/language.rb#79 +GraphQL::Language::INVALID_NUMBER_FOLLOWED_BY_NAME_REGEXP = T.let(T.unsafe(nil), Regexp) - class << self - # source://graphql//lib/graphql/language/lexer.rb#133 - def emit(token_name, ts, te, meta, token_value); end +# source://graphql//lib/graphql/language/lexer.rb#5 +class GraphQL::Language::Lexer + # @return [Lexer] a new instance of Lexer + # + # source://graphql//lib/graphql/language/lexer.rb#6 + def initialize(graphql_str, filename: T.unsafe(nil), max_tokens: T.unsafe(nil)); end + + # This produces a unique integer for bytes 2 and 3 of each keyword string + # See https://tenderlovemaking.com/2023/09/02/fast-tokenizers-with-stringscanner.html + # + # source://graphql//lib/graphql/language/lexer.rb#239 + def _hash(key); end + + # source://graphql//lib/graphql/language/lexer.rb#24 + def advance; end - # source://graphql//lib/graphql/language/lexer.rb#200 - def emit_block(ts, te, meta, value); end + # source://graphql//lib/graphql/language/lexer.rb#158 + def column_number; end - # source://graphql//lib/graphql/language/lexer.rb#207 - def emit_string(ts, te, meta, value); end + # source://graphql//lib/graphql/language/lexer.rb#102 + def debug_token_value(token_name); end - # source://graphql//lib/graphql/language/lexer.rb#172 - def record_comment(ts, te, meta, str); end + # @return [Boolean] + # + # source://graphql//lib/graphql/language/lexer.rb#18 + def eos?; end + + # source://graphql//lib/graphql/language/lexer.rb#154 + def line_number; end + # Returns the value of attribute pos. + # + # source://graphql//lib/graphql/language/lexer.rb#22 + def pos; end + + # @raise [GraphQL::ParseError] + # + # source://graphql//lib/graphql/language/lexer.rb#162 + def raise_parse_error(message, line = T.unsafe(nil), col = T.unsafe(nil)); end + + # source://graphql//lib/graphql/language/lexer.rb#131 + def string_value; end + + # source://graphql//lib/graphql/language/lexer.rb#96 + def token_value; end + + class << self # Replace any escaped unicode or whitespace with the _actual_ characters # To avoid allocating more strings, this modifies the string passed into it # - # source://graphql//lib/graphql/language/lexer.rb#148 + # source://graphql//lib/graphql/language/lexer.rb#318 def replace_escaped_characters_in_place(raw_string); end - # source://graphql//lib/graphql/language/lexer.rb#90 + # This is not used during parsing because the parser + # doesn't actually need tokens. + # + # source://graphql//lib/graphql/language/lexer.rb#345 def tokenize(string); end end end -# source://graphql//lib/graphql/language/lexer.rb#10 -GraphQL::Language::Lexer::BLANK = T.let(T.unsafe(nil), Regexp) - -# source://graphql//lib/graphql/language/lexer.rb#62 +# source://graphql//lib/graphql/language/lexer.rb#272 GraphQL::Language::Lexer::BLOCK_QUOTE = T.let(T.unsafe(nil), String) -# source://graphql//lib/graphql/language/lexer.rb#75 -GraphQL::Language::Lexer::BLOCK_STRING = T.let(T.unsafe(nil), Regexp) - -# source://graphql//lib/graphql/language/lexer.rb#11 -GraphQL::Language::Lexer::COMMENT = T.let(T.unsafe(nil), Regexp) - -# source://graphql//lib/graphql/language/lexer.rb#63 -GraphQL::Language::Lexer::ESCAPED_QUOTE = T.let(T.unsafe(nil), Regexp) - -# source://graphql//lib/graphql/language/lexer.rb#186 -GraphQL::Language::Lexer::ESCAPES = T.let(T.unsafe(nil), Regexp) - -# source://graphql//lib/graphql/language/lexer.rb#187 -GraphQL::Language::Lexer::ESCAPES_REPLACE = T.let(T.unsafe(nil), Hash) +# source://graphql//lib/graphql/language/lexer.rb#276 +GraphQL::Language::Lexer::BLOCK_STRING_REGEXP = T.let(T.unsafe(nil), Regexp) -# source://graphql//lib/graphql/language/lexer.rb#15 -GraphQL::Language::Lexer::FLOAT = T.let(T.unsafe(nil), Regexp) +# source://graphql//lib/graphql/language/lexer.rb#292 +module GraphQL::Language::Lexer::ByteFor; end -# source://graphql//lib/graphql/language/lexer.rb#13 -GraphQL::Language::Lexer::FLOAT_DECIMAL = T.let(T.unsafe(nil), Regexp) +# source://graphql//lib/graphql/language/lexer.rb#296 +GraphQL::Language::Lexer::ByteFor::ELLIPSIS = T.let(T.unsafe(nil), Integer) -# source://graphql//lib/graphql/language/lexer.rb#14 -GraphQL::Language::Lexer::FLOAT_EXP = T.let(T.unsafe(nil), Regexp) - -# source://graphql//lib/graphql/language/lexer.rb#57 -GraphQL::Language::Lexer::FOUR_DIGIT_UNICODE = T.let(T.unsafe(nil), Regexp) - -# source://graphql//lib/graphql/language/lexer.rb#8 -GraphQL::Language::Lexer::IDENTIFIER = T.let(T.unsafe(nil), Regexp) - -# source://graphql//lib/graphql/language/lexer.rb#12 -GraphQL::Language::Lexer::INT = T.let(T.unsafe(nil), Regexp) - -# source://graphql//lib/graphql/language/lexer.rb#72 -GraphQL::Language::Lexer::LIT = T.let(T.unsafe(nil), Regexp) - -# source://graphql//lib/graphql/language/lexer.rb#66 -GraphQL::Language::Lexer::LIT_NAME_LUT = T.let(T.unsafe(nil), Hash) - -# source://graphql//lib/graphql/language/lexer.rb#17 -module GraphQL::Language::Lexer::Literals; end +# identifier, *not* a keyword +# +# source://graphql//lib/graphql/language/lexer.rb#297 +GraphQL::Language::Lexer::ByteFor::IDENTIFIER = T.let(T.unsafe(nil), Integer) -# source://graphql//lib/graphql/language/lexer.rb#50 -GraphQL::Language::Lexer::Literals::AMP = T.let(T.unsafe(nil), String) +# identifier or keyword +# +# source://graphql//lib/graphql/language/lexer.rb#294 +GraphQL::Language::Lexer::ByteFor::NAME = T.let(T.unsafe(nil), Integer) -# source://graphql//lib/graphql/language/lexer.rb#48 -GraphQL::Language::Lexer::Literals::BANG = T.let(T.unsafe(nil), String) +# int or float +# +# source://graphql//lib/graphql/language/lexer.rb#293 +GraphQL::Language::Lexer::ByteFor::NUMBER = T.let(T.unsafe(nil), Integer) -# source://graphql//lib/graphql/language/lexer.rb#43 -GraphQL::Language::Lexer::Literals::COLON = T.let(T.unsafe(nil), String) +# source://graphql//lib/graphql/language/lexer.rb#298 +GraphQL::Language::Lexer::ByteFor::PUNCTUATION = T.let(T.unsafe(nil), Integer) -# source://graphql//lib/graphql/language/lexer.rb#35 -GraphQL::Language::Lexer::Literals::DIRECTIVE = T.let(T.unsafe(nil), Regexp) +# source://graphql//lib/graphql/language/lexer.rb#295 +GraphQL::Language::Lexer::ByteFor::STRING = T.let(T.unsafe(nil), Integer) -# source://graphql//lib/graphql/language/lexer.rb#45 -GraphQL::Language::Lexer::Literals::DIR_SIGN = T.let(T.unsafe(nil), String) +# source://graphql//lib/graphql/language/lexer.rb#129 +GraphQL::Language::Lexer::ESCAPED = T.let(T.unsafe(nil), Regexp) -# source://graphql//lib/graphql/language/lexer.rb#46 -GraphQL::Language::Lexer::Literals::ELLIPSIS = T.let(T.unsafe(nil), String) +# source://graphql//lib/graphql/language/lexer.rb#273 +GraphQL::Language::Lexer::ESCAPED_QUOTE = T.let(T.unsafe(nil), Regexp) -# source://graphql//lib/graphql/language/lexer.rb#33 -GraphQL::Language::Lexer::Literals::ENUM = T.let(T.unsafe(nil), Regexp) +# source://graphql//lib/graphql/language/lexer.rb#116 +GraphQL::Language::Lexer::ESCAPES = T.let(T.unsafe(nil), Regexp) -# source://graphql//lib/graphql/language/lexer.rb#47 -GraphQL::Language::Lexer::Literals::EQUALS = T.let(T.unsafe(nil), String) +# source://graphql//lib/graphql/language/lexer.rb#117 +GraphQL::Language::Lexer::ESCAPES_REPLACE = T.let(T.unsafe(nil), Hash) -# source://graphql//lib/graphql/language/lexer.rb#29 -GraphQL::Language::Lexer::Literals::EXTEND = T.let(T.unsafe(nil), Regexp) +# Use this array to check, for a given byte that will start a token, +# what kind of token might it start? +# +# source://graphql//lib/graphql/language/lexer.rb#290 +GraphQL::Language::Lexer::FIRST_BYTES = T.let(T.unsafe(nil), Array) -# source://graphql//lib/graphql/language/lexer.rb#21 -GraphQL::Language::Lexer::Literals::FALSE = T.let(T.unsafe(nil), Regexp) +# source://graphql//lib/graphql/language/lexer.rb#174 +GraphQL::Language::Lexer::FLOAT_DECIMAL_REGEXP = T.let(T.unsafe(nil), Regexp) -# source://graphql//lib/graphql/language/lexer.rb#19 -GraphQL::Language::Lexer::Literals::FRAGMENT = T.let(T.unsafe(nil), Regexp) +# source://graphql//lib/graphql/language/lexer.rb#175 +GraphQL::Language::Lexer::FLOAT_EXP_REGEXP = T.let(T.unsafe(nil), Regexp) -# source://graphql//lib/graphql/language/lexer.rb#30 -GraphQL::Language::Lexer::Literals::IMPLEMENTS = T.let(T.unsafe(nil), Regexp) +# source://graphql//lib/graphql/language/lexer.rb#268 +GraphQL::Language::Lexer::FOUR_DIGIT_UNICODE = T.let(T.unsafe(nil), Regexp) -# source://graphql//lib/graphql/language/lexer.rb#34 -GraphQL::Language::Lexer::Literals::INPUT = T.let(T.unsafe(nil), Regexp) +# source://graphql//lib/graphql/language/lexer.rb#172 +GraphQL::Language::Lexer::IDENTIFIER_REGEXP = T.let(T.unsafe(nil), Regexp) -# source://graphql//lib/graphql/language/lexer.rb#31 -GraphQL::Language::Lexer::Literals::INTERFACE = T.let(T.unsafe(nil), Regexp) +# source://graphql//lib/graphql/language/lexer.rb#166 +GraphQL::Language::Lexer::IGNORE_REGEXP = T.let(T.unsafe(nil), Regexp) -# source://graphql//lib/graphql/language/lexer.rb#41 -GraphQL::Language::Lexer::Literals::LBRACKET = T.let(T.unsafe(nil), String) +# source://graphql//lib/graphql/language/lexer.rb#173 +GraphQL::Language::Lexer::INT_REGEXP = T.let(T.unsafe(nil), Regexp) -# source://graphql//lib/graphql/language/lexer.rb#37 -GraphQL::Language::Lexer::Literals::LCURLY = T.let(T.unsafe(nil), String) +# source://graphql//lib/graphql/language/lexer.rb#179 +GraphQL::Language::Lexer::KEYWORDS = T.let(T.unsafe(nil), Array) -# source://graphql//lib/graphql/language/lexer.rb#39 -GraphQL::Language::Lexer::Literals::LPAREN = T.let(T.unsafe(nil), String) +# source://graphql//lib/graphql/language/lexer.rb#202 +GraphQL::Language::Lexer::KEYWORD_BY_TWO_BYTES = T.let(T.unsafe(nil), Array) -# source://graphql//lib/graphql/language/lexer.rb#24 -GraphQL::Language::Lexer::Literals::MUTATION = T.let(T.unsafe(nil), Regexp) +# source://graphql//lib/graphql/language/lexer.rb#201 +GraphQL::Language::Lexer::KEYWORD_REGEXP = T.let(T.unsafe(nil), Regexp) -# source://graphql//lib/graphql/language/lexer.rb#22 -GraphQL::Language::Lexer::Literals::NULL = T.let(T.unsafe(nil), Regexp) +# TODO: FLOAT_EXP_REGEXP should not be allowed to follow INT_REGEXP, integers are not allowed to have exponent parts. +# +# source://graphql//lib/graphql/language/lexer.rb#177 +GraphQL::Language::Lexer::NUMERIC_REGEXP = T.let(T.unsafe(nil), Regexp) -# source://graphql//lib/graphql/language/lexer.rb#18 -GraphQL::Language::Lexer::Literals::ON = T.let(T.unsafe(nil), Regexp) +# source://graphql//lib/graphql/language/lexer.rb#269 +GraphQL::Language::Lexer::N_DIGIT_UNICODE = T.let(T.unsafe(nil), Regexp) -# source://graphql//lib/graphql/language/lexer.rb#49 -GraphQL::Language::Lexer::Literals::PIPE = T.let(T.unsafe(nil), String) +# A sparse array mapping the bytes for each punctuation +# to a symbol name for that punctuation +# +# source://graphql//lib/graphql/language/lexer.rb#261 +GraphQL::Language::Lexer::PUNCTUATION_NAME_FOR_BYTE = T.let(T.unsafe(nil), Array) -# source://graphql//lib/graphql/language/lexer.rb#23 -GraphQL::Language::Lexer::Literals::QUERY = T.let(T.unsafe(nil), Regexp) +# source://graphql//lib/graphql/language/lexer.rb#243 +module GraphQL::Language::Lexer::Punctuation; end -# source://graphql//lib/graphql/language/lexer.rb#42 -GraphQL::Language::Lexer::Literals::RBRACKET = T.let(T.unsafe(nil), String) +# source://graphql//lib/graphql/language/lexer.rb#256 +GraphQL::Language::Lexer::Punctuation::AMP = T.let(T.unsafe(nil), String) -# source://graphql//lib/graphql/language/lexer.rb#38 -GraphQL::Language::Lexer::Literals::RCURLY = T.let(T.unsafe(nil), String) +# source://graphql//lib/graphql/language/lexer.rb#254 +GraphQL::Language::Lexer::Punctuation::BANG = T.let(T.unsafe(nil), String) -# source://graphql//lib/graphql/language/lexer.rb#36 -GraphQL::Language::Lexer::Literals::REPEATABLE = T.let(T.unsafe(nil), Regexp) +# source://graphql//lib/graphql/language/lexer.rb#250 +GraphQL::Language::Lexer::Punctuation::COLON = T.let(T.unsafe(nil), String) -# source://graphql//lib/graphql/language/lexer.rb#40 -GraphQL::Language::Lexer::Literals::RPAREN = T.let(T.unsafe(nil), String) +# source://graphql//lib/graphql/language/lexer.rb#252 +GraphQL::Language::Lexer::Punctuation::DIR_SIGN = T.let(T.unsafe(nil), String) -# source://graphql//lib/graphql/language/lexer.rb#27 -GraphQL::Language::Lexer::Literals::SCALAR = T.let(T.unsafe(nil), Regexp) +# source://graphql//lib/graphql/language/lexer.rb#253 +GraphQL::Language::Lexer::Punctuation::EQUALS = T.let(T.unsafe(nil), String) -# source://graphql//lib/graphql/language/lexer.rb#26 -GraphQL::Language::Lexer::Literals::SCHEMA = T.let(T.unsafe(nil), Regexp) +# source://graphql//lib/graphql/language/lexer.rb#248 +GraphQL::Language::Lexer::Punctuation::LBRACKET = T.let(T.unsafe(nil), String) -# source://graphql//lib/graphql/language/lexer.rb#25 -GraphQL::Language::Lexer::Literals::SUBSCRIPTION = T.let(T.unsafe(nil), Regexp) +# source://graphql//lib/graphql/language/lexer.rb#244 +GraphQL::Language::Lexer::Punctuation::LCURLY = T.let(T.unsafe(nil), String) -# source://graphql//lib/graphql/language/lexer.rb#20 -GraphQL::Language::Lexer::Literals::TRUE = T.let(T.unsafe(nil), Regexp) +# source://graphql//lib/graphql/language/lexer.rb#246 +GraphQL::Language::Lexer::Punctuation::LPAREN = T.let(T.unsafe(nil), String) -# source://graphql//lib/graphql/language/lexer.rb#28 -GraphQL::Language::Lexer::Literals::TYPE = T.let(T.unsafe(nil), Regexp) +# source://graphql//lib/graphql/language/lexer.rb#255 +GraphQL::Language::Lexer::Punctuation::PIPE = T.let(T.unsafe(nil), String) -# source://graphql//lib/graphql/language/lexer.rb#32 -GraphQL::Language::Lexer::Literals::UNION = T.let(T.unsafe(nil), Regexp) +# source://graphql//lib/graphql/language/lexer.rb#249 +GraphQL::Language::Lexer::Punctuation::RBRACKET = T.let(T.unsafe(nil), String) -# source://graphql//lib/graphql/language/lexer.rb#44 -GraphQL::Language::Lexer::Literals::VAR_SIGN = T.let(T.unsafe(nil), String) +# source://graphql//lib/graphql/language/lexer.rb#245 +GraphQL::Language::Lexer::Punctuation::RCURLY = T.let(T.unsafe(nil), String) -# source://graphql//lib/graphql/language/lexer.rb#9 -GraphQL::Language::Lexer::NEWLINE = T.let(T.unsafe(nil), Regexp) +# source://graphql//lib/graphql/language/lexer.rb#247 +GraphQL::Language::Lexer::Punctuation::RPAREN = T.let(T.unsafe(nil), String) -# source://graphql//lib/graphql/language/lexer.rb#58 -GraphQL::Language::Lexer::N_DIGIT_UNICODE = T.let(T.unsafe(nil), Regexp) +# source://graphql//lib/graphql/language/lexer.rb#251 +GraphQL::Language::Lexer::Punctuation::VAR_SIGN = T.let(T.unsafe(nil), String) -# source://graphql//lib/graphql/language/lexer.rb#55 +# source://graphql//lib/graphql/language/lexer.rb#266 GraphQL::Language::Lexer::QUOTE = T.let(T.unsafe(nil), String) -# source://graphql//lib/graphql/language/lexer.rb#74 -GraphQL::Language::Lexer::QUOTED_STRING = T.let(T.unsafe(nil), Regexp) +# source://graphql//lib/graphql/language/lexer.rb#275 +GraphQL::Language::Lexer::QUOTED_STRING_REGEXP = T.let(T.unsafe(nil), Regexp) -# source://graphql//lib/graphql/language/lexer.rb#64 +# source://graphql//lib/graphql/language/lexer.rb#274 GraphQL::Language::Lexer::STRING_CHAR = T.let(T.unsafe(nil), Regexp) -# # https://graphql.github.io/graphql-spec/June2018/#sec-String-Value -# -# source://graphql//lib/graphql/language/lexer.rb#61 +# source://graphql//lib/graphql/language/lexer.rb#271 GraphQL::Language::Lexer::STRING_ESCAPE = T.let(T.unsafe(nil), Regexp) -# source://graphql//lib/graphql/language/lexer.rb#56 +# source://graphql//lib/graphql/language/lexer.rb#267 GraphQL::Language::Lexer::UNICODE_DIGIT = T.let(T.unsafe(nil), Regexp) -# source://graphql//lib/graphql/language/lexer.rb#59 +# source://graphql//lib/graphql/language/lexer.rb#270 GraphQL::Language::Lexer::UNICODE_ESCAPE = T.let(T.unsafe(nil), Regexp) -# # catch-all for anything else. must be at the bottom for precedence. -# -# source://graphql//lib/graphql/language/lexer.rb#88 -GraphQL::Language::Lexer::UNKNOWN_CHAR = T.let(T.unsafe(nil), Regexp) - -# source://graphql//lib/graphql/language/lexer.rb#197 +# source://graphql//lib/graphql/language/lexer.rb#127 GraphQL::Language::Lexer::UTF_8 = T.let(T.unsafe(nil), Regexp) -# source://graphql//lib/graphql/language/lexer.rb#198 +# source://graphql//lib/graphql/language/lexer.rb#128 GraphQL::Language::Lexer::VALID_STRING = T.let(T.unsafe(nil), Regexp) # source://graphql//lib/graphql/language/nodes.rb#4 @@ -3281,48 +3273,38 @@ module GraphQL::Language::Nodes; end # # source://graphql//lib/graphql/language/nodes.rb#12 class GraphQL::Language::Nodes::AbstractNode - # Initialize a node by extracting its position, - # then calling the class's `initialize_node` method. - # - # @param options [Hash] Initial attributes for this node - # @return [AbstractNode] a new instance of AbstractNode - # - # source://graphql//lib/graphql/language/nodes.rb#30 - def initialize(options = T.unsafe(nil)); end - # Value equality # # @return [Boolean] True if `self` is equivalent to `other` # - # source://graphql//lib/graphql/language/nodes.rb#47 + # source://graphql//lib/graphql/language/nodes.rb#50 def ==(other); end # @return [Array] all nodes in the tree below this one # - # source://graphql//lib/graphql/language/nodes.rb#57 + # source://graphql//lib/graphql/language/nodes.rb#60 def children; end - # source://graphql//lib/graphql/language/nodes.rb#73 + # source://graphql//lib/graphql/language/nodes.rb#76 def children_method_name; end - # Returns the value of attribute col. - # - # source://graphql//lib/graphql/language/nodes.rb#25 + # source://graphql//lib/graphql/language/nodes.rb#40 def col; end + # source://graphql//lib/graphql/language/nodes.rb#44 + def definition_line; end + # TODO DRY with `replace_child` # - # source://graphql//lib/graphql/language/nodes.rb#119 + # source://graphql//lib/graphql/language/nodes.rb#122 def delete_child(previous_child); end # Returns the value of attribute filename. # - # source://graphql//lib/graphql/language/nodes.rb#25 + # source://graphql//lib/graphql/language/nodes.rb#34 def filename; end - # Returns the value of attribute line. - # - # source://graphql//lib/graphql/language/nodes.rb#25 + # source://graphql//lib/graphql/language/nodes.rb#36 def line; end # This creates a copy of `self`, with `new_options` applied. @@ -3330,44 +3312,44 @@ class GraphQL::Language::Nodes::AbstractNode # @param new_options [Hash] # @return [AbstractNode] a shallow copy of `self` # - # source://graphql//lib/graphql/language/nodes.rb#92 + # source://graphql//lib/graphql/language/nodes.rb#95 def merge(new_options); end - # source://graphql//lib/graphql/language/nodes.rb#77 + # source://graphql//lib/graphql/language/nodes.rb#80 def position; end # Copy `self`, but modify the copy so that `previous_child` is replaced by `new_child` # - # source://graphql//lib/graphql/language/nodes.rb#97 + # source://graphql//lib/graphql/language/nodes.rb#100 def replace_child(previous_child, new_child); end # @return [Array] Scalar values attached to this node # - # source://graphql//lib/graphql/language/nodes.rb#62 + # source://graphql//lib/graphql/language/nodes.rb#65 def scalars; end - # source://graphql//lib/graphql/language/nodes.rb#81 + # source://graphql//lib/graphql/language/nodes.rb#84 def to_query_string(printer: T.unsafe(nil)); end protected - # source://graphql//lib/graphql/language/nodes.rb#133 + # source://graphql//lib/graphql/language/nodes.rb#136 def merge!(new_options); end private # This might be unnecessary, but its easiest to add it here. # - # source://graphql//lib/graphql/language/nodes.rb#67 + # source://graphql//lib/graphql/language/nodes.rb#70 def initialize_copy(other); end class << self - # source://graphql//lib/graphql/language/nodes.rb#165 + # source://graphql//lib/graphql/language/nodes.rb#168 def children_of_type; end # Add a default `#visit_method` and `#children_method_name` using the class name # - # source://graphql//lib/graphql/language/nodes.rb#142 + # source://graphql//lib/graphql/language/nodes.rb#145 def inherited(child_class); end private @@ -3378,17 +3360,17 @@ class GraphQL::Language::Nodes::AbstractNode # - Add a persistent update method to add a child # - Generate a `#children` method # - # source://graphql//lib/graphql/language/nodes.rb#176 + # source://graphql//lib/graphql/language/nodes.rb#179 def children_methods(children_of_type); end - # source://graphql//lib/graphql/language/nodes.rb#264 - def generate_initialize_node; end + # source://graphql//lib/graphql/language/nodes.rb#276 + def generate_initialize; end # These methods return a plain Ruby value, not another node # - Add reader methods # - Add a `#scalars` method # - # source://graphql//lib/graphql/language/nodes.rb#242 + # source://graphql//lib/graphql/language/nodes.rb#246 def scalar_methods(*method_names); end end end @@ -3396,7 +3378,7 @@ end # source://graphql//lib/graphql/language/nodes.rb#14 module GraphQL::Language::Nodes::AbstractNode::DefinitionNode # source://graphql//lib/graphql/language/nodes.rb#19 - def initialize(options = T.unsafe(nil)); end + def initialize(definition_line: T.unsafe(nil), **_rest); end # This AST node's {#line} returns the first line, which may be the description. # @@ -3404,157 +3386,179 @@ module GraphQL::Language::Nodes::AbstractNode::DefinitionNode # # source://graphql//lib/graphql/language/nodes.rb#17 def definition_line; end + + # source://graphql//lib/graphql/language/nodes.rb#24 + def marshal_dump; end + + # source://graphql//lib/graphql/language/nodes.rb#28 + def marshal_load(values); end end -# source://graphql//lib/graphql/language/nodes.rb#54 +# source://graphql//lib/graphql/language/nodes.rb#57 GraphQL::Language::Nodes::AbstractNode::NO_CHILDREN = T.let(T.unsafe(nil), Array) # A key-value pair for a field's inputs # -# source://graphql//lib/graphql/language/nodes.rb#315 +# source://graphql//lib/graphql/language/nodes.rb#354 class GraphQL::Language::Nodes::Argument < ::GraphQL::Language::Nodes::AbstractNode - # source://graphql//lib/graphql/language/nodes.rb#325 + # source://graphql//lib/graphql/language/nodes.rb#310 + def initialize(name: T.unsafe(nil), value: T.unsafe(nil), line: T.unsafe(nil), col: T.unsafe(nil), pos: T.unsafe(nil), filename: T.unsafe(nil), source: T.unsafe(nil)); end + + # source://graphql//lib/graphql/language/nodes.rb#364 def children; end - # source://graphql//lib/graphql/language/nodes.rb#288 - def initialize_node(name: T.unsafe(nil), value: T.unsafe(nil)); end + # source://graphql//lib/graphql/language/nodes.rb#324 + def marshal_dump; end + + # source://graphql//lib/graphql/language/nodes.rb#332 + def marshal_load(values); end # @return [String] the key for this argument # - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#258 def name; end - # source://graphql//lib/graphql/language/nodes.rb#256 + # source://graphql//lib/graphql/language/nodes.rb#260 def scalars; end # @return [String, Float, Integer, Boolean, Array, InputObject, VariableIdentifier] The value passed for this key # - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#258 def value; end - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#293 + # source://graphql//lib/graphql/language/nodes.rb#320 def from_a(filename, line, col, name, value); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end -# source://graphql//lib/graphql/language/nodes.rb#330 +# source://graphql//lib/graphql/language/nodes.rb#369 class GraphQL::Language::Nodes::Directive < ::GraphQL::Language::Nodes::AbstractNode - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#310 + def initialize(name: T.unsafe(nil), arguments: T.unsafe(nil), line: T.unsafe(nil), col: T.unsafe(nil), pos: T.unsafe(nil), filename: T.unsafe(nil), source: T.unsafe(nil)); end + + # source://graphql//lib/graphql/language/nodes.rb#193 def arguments; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def children; end - # source://graphql//lib/graphql/language/nodes.rb#288 - def initialize_node(name: T.unsafe(nil), arguments: T.unsafe(nil)); end + # source://graphql//lib/graphql/language/nodes.rb#324 + def marshal_dump; end + + # source://graphql//lib/graphql/language/nodes.rb#332 + def marshal_load(values); end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_argument(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_argument(**node_opts); end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#258 def name; end - # source://graphql//lib/graphql/language/nodes.rb#256 + # source://graphql//lib/graphql/language/nodes.rb#260 def scalars; end - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#293 + # source://graphql//lib/graphql/language/nodes.rb#320 def from_a(filename, line, col, name, arguments); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end -# source://graphql//lib/graphql/language/nodes.rb#338 +# source://graphql//lib/graphql/language/nodes.rb#377 class GraphQL::Language::Nodes::DirectiveDefinition < ::GraphQL::Language::Nodes::AbstractNode - include ::GraphQL::Language::Nodes::AbstractNode::DefinitionNode + # source://graphql//lib/graphql/language/nodes.rb#310 + def initialize(name: T.unsafe(nil), repeatable: T.unsafe(nil), description: T.unsafe(nil), arguments: T.unsafe(nil), locations: T.unsafe(nil), line: T.unsafe(nil), col: T.unsafe(nil), pos: T.unsafe(nil), filename: T.unsafe(nil), source: T.unsafe(nil), definition_pos: T.unsafe(nil)); end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def arguments; end - # source://graphql//lib/graphql/language/nodes.rb#211 + # source://graphql//lib/graphql/language/nodes.rb#214 def children; end # Returns the value of attribute description. # - # source://graphql//lib/graphql/language/nodes.rb#340 + # source://graphql//lib/graphql/language/nodes.rb#378 def description; end - # source://graphql//lib/graphql/language/nodes.rb#288 - def initialize_node(name: T.unsafe(nil), repeatable: T.unsafe(nil), description: T.unsafe(nil), arguments: T.unsafe(nil), locations: T.unsafe(nil)); end - - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def locations; end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_argument(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#328 + def marshal_dump; end + + # source://graphql//lib/graphql/language/nodes.rb#336 + def marshal_load(values); end + + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_argument(**node_opts); end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_location(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_location(**node_opts); end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#258 def name; end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#258 def repeatable; end - # source://graphql//lib/graphql/language/nodes.rb#256 + # source://graphql//lib/graphql/language/nodes.rb#260 def scalars; end - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#296 + # source://graphql//lib/graphql/language/nodes.rb#324 def from_a(filename, line, col, name, repeatable, description, arguments, locations); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end -# source://graphql//lib/graphql/language/nodes.rb#335 +# source://graphql//lib/graphql/language/nodes.rb#374 class GraphQL::Language::Nodes::DirectiveLocation < ::GraphQL::Language::Nodes::NameOnlyNode - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end @@ -3569,778 +3573,854 @@ end # @example Creating a custom string from a document # class VariableScrubber < GraphQL::Language::Printer # def print_argument(arg) -# "#{arg.name}: " +# print_string("#{arg.name}: ") # end # end # # document.to_query_string(printer: VariableScrubber.new) # -# source://graphql//lib/graphql/language/nodes.rb#544 +# source://graphql//lib/graphql/language/nodes.rb#601 class GraphQL::Language::Nodes::Document < ::GraphQL::Language::Nodes::AbstractNode - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#310 + def initialize(definitions: T.unsafe(nil), line: T.unsafe(nil), col: T.unsafe(nil), pos: T.unsafe(nil), filename: T.unsafe(nil), source: T.unsafe(nil)); end + + # source://graphql//lib/graphql/language/nodes.rb#193 def children; end # @return [Array] top-level GraphQL units: operations or fragments # - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def definitions; end - # source://graphql//lib/graphql/language/nodes.rb#288 - def initialize_node(definitions: T.unsafe(nil)); end + # source://graphql//lib/graphql/language/nodes.rb#323 + def marshal_dump; end + + # source://graphql//lib/graphql/language/nodes.rb#331 + def marshal_load(values); end - # source://graphql//lib/graphql/language/nodes.rb#550 + # source://graphql//lib/graphql/language/nodes.rb#607 def slice_definition(name); end - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#292 + # source://graphql//lib/graphql/language/nodes.rb#319 def from_a(filename, line, col, definitions); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end # An enum value. The string is available as {#name}. # -# source://graphql//lib/graphql/language/nodes.rb#349 +# source://graphql//lib/graphql/language/nodes.rb#388 class GraphQL::Language::Nodes::Enum < ::GraphQL::Language::Nodes::NameOnlyNode - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end -# source://graphql//lib/graphql/language/nodes.rb#701 +# source://graphql//lib/graphql/language/nodes.rb#750 class GraphQL::Language::Nodes::EnumTypeDefinition < ::GraphQL::Language::Nodes::AbstractNode - include ::GraphQL::Language::Nodes::AbstractNode::DefinitionNode + # source://graphql//lib/graphql/language/nodes.rb#310 + def initialize(name: T.unsafe(nil), description: T.unsafe(nil), directives: T.unsafe(nil), values: T.unsafe(nil), line: T.unsafe(nil), col: T.unsafe(nil), pos: T.unsafe(nil), filename: T.unsafe(nil), source: T.unsafe(nil), definition_pos: T.unsafe(nil)); end - # source://graphql//lib/graphql/language/nodes.rb#211 + # source://graphql//lib/graphql/language/nodes.rb#214 def children; end # Returns the value of attribute description. # - # source://graphql//lib/graphql/language/nodes.rb#703 + # source://graphql//lib/graphql/language/nodes.rb#751 def description; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def directives; end - # source://graphql//lib/graphql/language/nodes.rb#288 - def initialize_node(name: T.unsafe(nil), description: T.unsafe(nil), directives: T.unsafe(nil), values: T.unsafe(nil)); end + # source://graphql//lib/graphql/language/nodes.rb#327 + def marshal_dump; end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_directive(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#335 + def marshal_load(values); end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_value(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_directive(**node_opts); end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_value(**node_opts); end + + # source://graphql//lib/graphql/language/nodes.rb#258 def name; end - # source://graphql//lib/graphql/language/nodes.rb#256 + # source://graphql//lib/graphql/language/nodes.rb#260 def scalars; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def values; end - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#295 + # source://graphql//lib/graphql/language/nodes.rb#323 def from_a(filename, line, col, name, description, directives, values); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end -# source://graphql//lib/graphql/language/nodes.rb#712 +# source://graphql//lib/graphql/language/nodes.rb#760 class GraphQL::Language::Nodes::EnumTypeExtension < ::GraphQL::Language::Nodes::AbstractNode - # source://graphql//lib/graphql/language/nodes.rb#211 + # source://graphql//lib/graphql/language/nodes.rb#310 + def initialize(name: T.unsafe(nil), directives: T.unsafe(nil), values: T.unsafe(nil), line: T.unsafe(nil), col: T.unsafe(nil), pos: T.unsafe(nil), filename: T.unsafe(nil), source: T.unsafe(nil)); end + + # source://graphql//lib/graphql/language/nodes.rb#214 def children; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def directives; end - # source://graphql//lib/graphql/language/nodes.rb#288 - def initialize_node(name: T.unsafe(nil), directives: T.unsafe(nil), values: T.unsafe(nil)); end + # source://graphql//lib/graphql/language/nodes.rb#325 + def marshal_dump; end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_directive(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#333 + def marshal_load(values); end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_value(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_directive(**node_opts); end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_value(**node_opts); end + + # source://graphql//lib/graphql/language/nodes.rb#258 def name; end - # source://graphql//lib/graphql/language/nodes.rb#256 + # source://graphql//lib/graphql/language/nodes.rb#260 def scalars; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def values; end - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#294 + # source://graphql//lib/graphql/language/nodes.rb#321 def from_a(filename, line, col, name, directives, values); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end -# source://graphql//lib/graphql/language/nodes.rb#691 +# source://graphql//lib/graphql/language/nodes.rb#741 class GraphQL::Language::Nodes::EnumValueDefinition < ::GraphQL::Language::Nodes::AbstractNode - include ::GraphQL::Language::Nodes::AbstractNode::DefinitionNode + # source://graphql//lib/graphql/language/nodes.rb#310 + def initialize(name: T.unsafe(nil), description: T.unsafe(nil), directives: T.unsafe(nil), line: T.unsafe(nil), col: T.unsafe(nil), pos: T.unsafe(nil), filename: T.unsafe(nil), source: T.unsafe(nil), definition_pos: T.unsafe(nil)); end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def children; end # Returns the value of attribute description. # - # source://graphql//lib/graphql/language/nodes.rb#693 + # source://graphql//lib/graphql/language/nodes.rb#742 def description; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def directives; end - # source://graphql//lib/graphql/language/nodes.rb#288 - def initialize_node(name: T.unsafe(nil), description: T.unsafe(nil), directives: T.unsafe(nil)); end + # source://graphql//lib/graphql/language/nodes.rb#326 + def marshal_dump; end + + # source://graphql//lib/graphql/language/nodes.rb#334 + def marshal_load(values); end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_directive(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_directive(**node_opts); end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#258 def name; end - # source://graphql//lib/graphql/language/nodes.rb#256 + # source://graphql//lib/graphql/language/nodes.rb#260 def scalars; end - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#294 + # source://graphql//lib/graphql/language/nodes.rb#322 def from_a(filename, line, col, name, description, directives); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end # A single selection in a GraphQL query. # -# source://graphql//lib/graphql/language/nodes.rb#357 +# source://graphql//lib/graphql/language/nodes.rb#396 class GraphQL::Language::Nodes::Field < ::GraphQL::Language::Nodes::AbstractNode - # source://graphql//lib/graphql/language/nodes.rb#254 + # @return [Field] a new instance of Field + # + # source://graphql//lib/graphql/language/nodes.rb#397 + def initialize(name: T.unsafe(nil), arguments: T.unsafe(nil), directives: T.unsafe(nil), selections: T.unsafe(nil), field_alias: T.unsafe(nil), line: T.unsafe(nil), col: T.unsafe(nil), pos: T.unsafe(nil), filename: T.unsafe(nil), source: T.unsafe(nil)); end + + # source://graphql//lib/graphql/language/nodes.rb#258 def alias; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def arguments; end - # source://graphql//lib/graphql/language/nodes.rb#211 + # source://graphql//lib/graphql/language/nodes.rb#214 def children; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def directives; end - # source://graphql//lib/graphql/language/nodes.rb#368 - def initialize_node(attributes); end + # source://graphql//lib/graphql/language/nodes.rb#415 + def marshal_dump; end + + # source://graphql//lib/graphql/language/nodes.rb#419 + def marshal_load(values); end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_argument(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_argument(**node_opts); end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_directive(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_directive(**node_opts); end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_selection(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_selection(**node_opts); end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#258 def name; end - # source://graphql//lib/graphql/language/nodes.rb#256 + # source://graphql//lib/graphql/language/nodes.rb#260 def scalars; end - # @return [Array] Selections on this object (or empty array if this is a scalar field) - # - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def selections; end - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#377 - def from_a(filename, line, col, graphql_alias, name, arguments, directives, selections); end + # source://graphql//lib/graphql/language/nodes.rb#411 + def from_a(filename, line, col, field_alias, name, arguments, directives, selections); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end -# source://graphql//lib/graphql/language/nodes.rb#609 +# source://graphql//lib/graphql/language/nodes.rb#663 class GraphQL::Language::Nodes::FieldDefinition < ::GraphQL::Language::Nodes::AbstractNode - include ::GraphQL::Language::Nodes::AbstractNode::DefinitionNode + # source://graphql//lib/graphql/language/nodes.rb#310 + def initialize(name: T.unsafe(nil), type: T.unsafe(nil), description: T.unsafe(nil), arguments: T.unsafe(nil), directives: T.unsafe(nil), line: T.unsafe(nil), col: T.unsafe(nil), pos: T.unsafe(nil), filename: T.unsafe(nil), source: T.unsafe(nil), definition_pos: T.unsafe(nil)); end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def arguments; end - # source://graphql//lib/graphql/language/nodes.rb#211 + # source://graphql//lib/graphql/language/nodes.rb#214 def children; end # Returns the value of attribute description. # - # source://graphql//lib/graphql/language/nodes.rb#611 + # source://graphql//lib/graphql/language/nodes.rb#664 def description; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def directives; end # this is so that `children_method_name` of `InputValueDefinition` works properly # with `#replace_child` # - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def fields; end - # source://graphql//lib/graphql/language/nodes.rb#288 - def initialize_node(name: T.unsafe(nil), type: T.unsafe(nil), description: T.unsafe(nil), arguments: T.unsafe(nil), directives: T.unsafe(nil)); end + # source://graphql//lib/graphql/language/nodes.rb#328 + def marshal_dump; end + + # source://graphql//lib/graphql/language/nodes.rb#336 + def marshal_load(values); end - # source://graphql//lib/graphql/language/nodes.rb#622 + # source://graphql//lib/graphql/language/nodes.rb#675 def merge(new_options); end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_argument(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_argument(**node_opts); end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_directive(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_directive(**node_opts); end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#258 def name; end - # source://graphql//lib/graphql/language/nodes.rb#256 + # source://graphql//lib/graphql/language/nodes.rb#260 def scalars; end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#258 def type; end - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#296 + # source://graphql//lib/graphql/language/nodes.rb#324 def from_a(filename, line, col, name, type, description, arguments, directives); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end # A reusable fragment, defined at document-level. # -# source://graphql//lib/graphql/language/nodes.rb#386 +# source://graphql//lib/graphql/language/nodes.rb#435 class GraphQL::Language::Nodes::FragmentDefinition < ::GraphQL::Language::Nodes::AbstractNode - # source://graphql//lib/graphql/language/nodes.rb#211 + # @return [FragmentDefinition] a new instance of FragmentDefinition + # + # source://graphql//lib/graphql/language/nodes.rb#436 + def initialize(name: T.unsafe(nil), type: T.unsafe(nil), directives: T.unsafe(nil), selections: T.unsafe(nil), filename: T.unsafe(nil), pos: T.unsafe(nil), source: T.unsafe(nil), line: T.unsafe(nil), col: T.unsafe(nil)); end + + # source://graphql//lib/graphql/language/nodes.rb#214 def children; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def directives; end - # source://graphql//lib/graphql/language/nodes.rb#392 - def initialize_node(name: T.unsafe(nil), type: T.unsafe(nil), directives: T.unsafe(nil), selections: T.unsafe(nil)); end + # source://graphql//lib/graphql/language/nodes.rb#452 + def marshal_dump; end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_directive(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#456 + def marshal_load(values); end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_selection(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_directive(**node_opts); end - # @return [String] the identifier for this fragment, which may be applied with `...#{name}` - # - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_selection(**node_opts); end + + # source://graphql//lib/graphql/language/nodes.rb#258 def name; end - # source://graphql//lib/graphql/language/nodes.rb#256 + # source://graphql//lib/graphql/language/nodes.rb#260 def scalars; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def selections; end - # @return [String] the type condition for this fragment (name of type which it may apply to) - # - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#258 def type; end - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#399 + # source://graphql//lib/graphql/language/nodes.rb#448 def from_a(filename, line, col, name, type, directives, selections); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end # Application of a named fragment in a selection # -# source://graphql//lib/graphql/language/nodes.rb#413 +# source://graphql//lib/graphql/language/nodes.rb#470 class GraphQL::Language::Nodes::FragmentSpread < ::GraphQL::Language::Nodes::AbstractNode - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#310 + def initialize(name: T.unsafe(nil), directives: T.unsafe(nil), line: T.unsafe(nil), col: T.unsafe(nil), pos: T.unsafe(nil), filename: T.unsafe(nil), source: T.unsafe(nil)); end + + # source://graphql//lib/graphql/language/nodes.rb#193 def children; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def directives; end - # source://graphql//lib/graphql/language/nodes.rb#288 - def initialize_node(name: T.unsafe(nil), directives: T.unsafe(nil)); end + # source://graphql//lib/graphql/language/nodes.rb#324 + def marshal_dump; end + + # source://graphql//lib/graphql/language/nodes.rb#332 + def marshal_load(values); end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_directive(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_directive(**node_opts); end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#258 def name; end - # source://graphql//lib/graphql/language/nodes.rb#256 + # source://graphql//lib/graphql/language/nodes.rb#260 def scalars; end - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#293 + # source://graphql//lib/graphql/language/nodes.rb#320 def from_a(filename, line, col, name, directives); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end # An unnamed fragment, defined directly in the query with `... { }` # -# source://graphql//lib/graphql/language/nodes.rb#424 +# source://graphql//lib/graphql/language/nodes.rb#481 class GraphQL::Language::Nodes::InlineFragment < ::GraphQL::Language::Nodes::AbstractNode - # source://graphql//lib/graphql/language/nodes.rb#211 + # source://graphql//lib/graphql/language/nodes.rb#310 + def initialize(type: T.unsafe(nil), directives: T.unsafe(nil), selections: T.unsafe(nil), line: T.unsafe(nil), col: T.unsafe(nil), pos: T.unsafe(nil), filename: T.unsafe(nil), source: T.unsafe(nil)); end + + # source://graphql//lib/graphql/language/nodes.rb#214 def children; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def directives; end - # source://graphql//lib/graphql/language/nodes.rb#288 - def initialize_node(type: T.unsafe(nil), directives: T.unsafe(nil), selections: T.unsafe(nil)); end + # source://graphql//lib/graphql/language/nodes.rb#325 + def marshal_dump; end + + # source://graphql//lib/graphql/language/nodes.rb#333 + def marshal_load(values); end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_directive(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_directive(**node_opts); end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_selection(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_selection(**node_opts); end - # source://graphql//lib/graphql/language/nodes.rb#256 + # source://graphql//lib/graphql/language/nodes.rb#260 def scalars; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def selections; end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#258 def type; end - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#294 + # source://graphql//lib/graphql/language/nodes.rb#321 def from_a(filename, line, col, type, directives, selections); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end # A collection of key-value inputs which may be a field argument # -# source://graphql//lib/graphql/language/nodes.rb#438 +# source://graphql//lib/graphql/language/nodes.rb#495 class GraphQL::Language::Nodes::InputObject < ::GraphQL::Language::Nodes::AbstractNode + # source://graphql//lib/graphql/language/nodes.rb#310 + def initialize(arguments: T.unsafe(nil), line: T.unsafe(nil), col: T.unsafe(nil), pos: T.unsafe(nil), filename: T.unsafe(nil), source: T.unsafe(nil)); end + # @return [Array] A list of key-value pairs inside this input object # - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def arguments; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def children; end - # source://graphql//lib/graphql/language/nodes.rb#288 - def initialize_node(arguments: T.unsafe(nil)); end + # source://graphql//lib/graphql/language/nodes.rb#323 + def marshal_dump; end + + # source://graphql//lib/graphql/language/nodes.rb#331 + def marshal_load(values); end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_argument(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_argument(**node_opts); end # @return [Hash] Recursively turn this input object into a Ruby Hash # - # source://graphql//lib/graphql/language/nodes.rb#446 + # source://graphql//lib/graphql/language/nodes.rb#503 def to_h(options = T.unsafe(nil)); end - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end private - # source://graphql//lib/graphql/language/nodes.rb#458 + # source://graphql//lib/graphql/language/nodes.rb#515 def serialize_value_for_hash(value); end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#292 + # source://graphql//lib/graphql/language/nodes.rb#319 def from_a(filename, line, col, arguments); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end -# source://graphql//lib/graphql/language/nodes.rb#721 +# source://graphql//lib/graphql/language/nodes.rb#769 class GraphQL::Language::Nodes::InputObjectTypeDefinition < ::GraphQL::Language::Nodes::AbstractNode - include ::GraphQL::Language::Nodes::AbstractNode::DefinitionNode + # source://graphql//lib/graphql/language/nodes.rb#310 + def initialize(name: T.unsafe(nil), description: T.unsafe(nil), directives: T.unsafe(nil), fields: T.unsafe(nil), line: T.unsafe(nil), col: T.unsafe(nil), pos: T.unsafe(nil), filename: T.unsafe(nil), source: T.unsafe(nil), definition_pos: T.unsafe(nil)); end - # source://graphql//lib/graphql/language/nodes.rb#211 + # source://graphql//lib/graphql/language/nodes.rb#214 def children; end # Returns the value of attribute description. # - # source://graphql//lib/graphql/language/nodes.rb#723 + # source://graphql//lib/graphql/language/nodes.rb#770 def description; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def directives; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def fields; end - # source://graphql//lib/graphql/language/nodes.rb#288 - def initialize_node(name: T.unsafe(nil), description: T.unsafe(nil), directives: T.unsafe(nil), fields: T.unsafe(nil)); end + # source://graphql//lib/graphql/language/nodes.rb#327 + def marshal_dump; end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_directive(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#335 + def marshal_load(values); end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_field(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_directive(**node_opts); end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_field(**node_opts); end + + # source://graphql//lib/graphql/language/nodes.rb#258 def name; end - # source://graphql//lib/graphql/language/nodes.rb#256 + # source://graphql//lib/graphql/language/nodes.rb#260 def scalars; end - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#295 + # source://graphql//lib/graphql/language/nodes.rb#323 def from_a(filename, line, col, name, description, directives, fields); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end -# source://graphql//lib/graphql/language/nodes.rb#732 +# source://graphql//lib/graphql/language/nodes.rb#779 class GraphQL::Language::Nodes::InputObjectTypeExtension < ::GraphQL::Language::Nodes::AbstractNode - # source://graphql//lib/graphql/language/nodes.rb#211 + # source://graphql//lib/graphql/language/nodes.rb#310 + def initialize(name: T.unsafe(nil), directives: T.unsafe(nil), fields: T.unsafe(nil), line: T.unsafe(nil), col: T.unsafe(nil), pos: T.unsafe(nil), filename: T.unsafe(nil), source: T.unsafe(nil)); end + + # source://graphql//lib/graphql/language/nodes.rb#214 def children; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def directives; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def fields; end - # source://graphql//lib/graphql/language/nodes.rb#288 - def initialize_node(name: T.unsafe(nil), directives: T.unsafe(nil), fields: T.unsafe(nil)); end + # source://graphql//lib/graphql/language/nodes.rb#325 + def marshal_dump; end + + # source://graphql//lib/graphql/language/nodes.rb#333 + def marshal_load(values); end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_directive(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_directive(**node_opts); end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_field(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_field(**node_opts); end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#258 def name; end - # source://graphql//lib/graphql/language/nodes.rb#256 + # source://graphql//lib/graphql/language/nodes.rb#260 def scalars; end - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#294 + # source://graphql//lib/graphql/language/nodes.rb#321 def from_a(filename, line, col, name, directives, fields); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end -# source://graphql//lib/graphql/language/nodes.rb#599 +# source://graphql//lib/graphql/language/nodes.rb#654 class GraphQL::Language::Nodes::InputValueDefinition < ::GraphQL::Language::Nodes::AbstractNode - include ::GraphQL::Language::Nodes::AbstractNode::DefinitionNode + # source://graphql//lib/graphql/language/nodes.rb#310 + def initialize(name: T.unsafe(nil), type: T.unsafe(nil), default_value: T.unsafe(nil), description: T.unsafe(nil), directives: T.unsafe(nil), line: T.unsafe(nil), col: T.unsafe(nil), pos: T.unsafe(nil), filename: T.unsafe(nil), source: T.unsafe(nil), definition_pos: T.unsafe(nil)); end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def children; end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#258 def default_value; end # Returns the value of attribute description. # - # source://graphql//lib/graphql/language/nodes.rb#601 + # source://graphql//lib/graphql/language/nodes.rb#655 def description; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def directives; end - # source://graphql//lib/graphql/language/nodes.rb#288 - def initialize_node(name: T.unsafe(nil), type: T.unsafe(nil), default_value: T.unsafe(nil), description: T.unsafe(nil), directives: T.unsafe(nil)); end + # source://graphql//lib/graphql/language/nodes.rb#328 + def marshal_dump; end + + # source://graphql//lib/graphql/language/nodes.rb#336 + def marshal_load(values); end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_directive(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_directive(**node_opts); end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#258 def name; end - # source://graphql//lib/graphql/language/nodes.rb#256 + # source://graphql//lib/graphql/language/nodes.rb#260 def scalars; end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#258 def type; end - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#296 + # source://graphql//lib/graphql/language/nodes.rb#324 def from_a(filename, line, col, name, type, default_value, description, directives); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end -# source://graphql//lib/graphql/language/nodes.rb#650 +# source://graphql//lib/graphql/language/nodes.rb#702 class GraphQL::Language::Nodes::InterfaceTypeDefinition < ::GraphQL::Language::Nodes::AbstractNode - include ::GraphQL::Language::Nodes::AbstractNode::DefinitionNode + # source://graphql//lib/graphql/language/nodes.rb#310 + def initialize(name: T.unsafe(nil), description: T.unsafe(nil), interfaces: T.unsafe(nil), directives: T.unsafe(nil), fields: T.unsafe(nil), line: T.unsafe(nil), col: T.unsafe(nil), pos: T.unsafe(nil), filename: T.unsafe(nil), source: T.unsafe(nil), definition_pos: T.unsafe(nil)); end - # source://graphql//lib/graphql/language/nodes.rb#211 + # source://graphql//lib/graphql/language/nodes.rb#214 def children; end # Returns the value of attribute description. # - # source://graphql//lib/graphql/language/nodes.rb#652 + # source://graphql//lib/graphql/language/nodes.rb#703 def description; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def directives; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def fields; end - # source://graphql//lib/graphql/language/nodes.rb#288 - def initialize_node(name: T.unsafe(nil), description: T.unsafe(nil), interfaces: T.unsafe(nil), directives: T.unsafe(nil), fields: T.unsafe(nil)); end - - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def interfaces; end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_directive(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#328 + def marshal_dump; end + + # source://graphql//lib/graphql/language/nodes.rb#336 + def marshal_load(values); end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_field(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_directive(**node_opts); end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_interface(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_field(**node_opts); end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_interface(**node_opts); end + + # source://graphql//lib/graphql/language/nodes.rb#258 def name; end - # source://graphql//lib/graphql/language/nodes.rb#256 + # source://graphql//lib/graphql/language/nodes.rb#260 def scalars; end - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#296 + # source://graphql//lib/graphql/language/nodes.rb#324 def from_a(filename, line, col, name, description, interfaces, directives, fields); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end -# source://graphql//lib/graphql/language/nodes.rb#662 +# source://graphql//lib/graphql/language/nodes.rb#713 class GraphQL::Language::Nodes::InterfaceTypeExtension < ::GraphQL::Language::Nodes::AbstractNode - # source://graphql//lib/graphql/language/nodes.rb#211 + # source://graphql//lib/graphql/language/nodes.rb#310 + def initialize(name: T.unsafe(nil), interfaces: T.unsafe(nil), directives: T.unsafe(nil), fields: T.unsafe(nil), line: T.unsafe(nil), col: T.unsafe(nil), pos: T.unsafe(nil), filename: T.unsafe(nil), source: T.unsafe(nil)); end + + # source://graphql//lib/graphql/language/nodes.rb#214 def children; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def directives; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def fields; end - # source://graphql//lib/graphql/language/nodes.rb#288 - def initialize_node(name: T.unsafe(nil), interfaces: T.unsafe(nil), directives: T.unsafe(nil), fields: T.unsafe(nil)); end - - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def interfaces; end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_directive(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#326 + def marshal_dump; end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_field(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#334 + def marshal_load(values); end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_interface(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_directive(**node_opts); end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_field(**node_opts); end + + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_interface(**node_opts); end + + # source://graphql//lib/graphql/language/nodes.rb#258 def name; end - # source://graphql//lib/graphql/language/nodes.rb#256 + # source://graphql//lib/graphql/language/nodes.rb#260 def scalars; end - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#295 + # source://graphql//lib/graphql/language/nodes.rb#322 def from_a(filename, line, col, name, interfaces, directives, fields); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end # A list type definition, denoted with `[...]` (used for variable type definitions) # -# source://graphql//lib/graphql/language/nodes.rb#477 +# source://graphql//lib/graphql/language/nodes.rb#534 class GraphQL::Language::Nodes::ListType < ::GraphQL::Language::Nodes::WrapperType - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end @@ -4350,170 +4430,186 @@ GraphQL::Language::Nodes::NONE = T.let(T.unsafe(nil), Array) # Base class for nodes whose only value is a name (no child nodes or other scalars) # -# source://graphql//lib/graphql/language/nodes.rb#309 +# source://graphql//lib/graphql/language/nodes.rb#348 class GraphQL::Language::Nodes::NameOnlyNode < ::GraphQL::Language::Nodes::AbstractNode - # source://graphql//lib/graphql/language/nodes.rb#288 - def initialize_node(name: T.unsafe(nil)); end + # source://graphql//lib/graphql/language/nodes.rb#310 + def initialize(name: T.unsafe(nil), line: T.unsafe(nil), col: T.unsafe(nil), pos: T.unsafe(nil), filename: T.unsafe(nil), source: T.unsafe(nil)); end + + # source://graphql//lib/graphql/language/nodes.rb#323 + def marshal_dump; end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#331 + def marshal_load(values); end + + # source://graphql//lib/graphql/language/nodes.rb#258 def name; end - # source://graphql//lib/graphql/language/nodes.rb#256 + # source://graphql//lib/graphql/language/nodes.rb#260 def scalars; end - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#292 + # source://graphql//lib/graphql/language/nodes.rb#319 def from_a(filename, line, col, name); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end # A non-null type definition, denoted with `...!` (used for variable type definitions) # -# source://graphql//lib/graphql/language/nodes.rb#481 +# source://graphql//lib/graphql/language/nodes.rb#538 class GraphQL::Language::Nodes::NonNullType < ::GraphQL::Language::Nodes::WrapperType - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end # A null value literal. # -# source://graphql//lib/graphql/language/nodes.rb#353 +# source://graphql//lib/graphql/language/nodes.rb#392 class GraphQL::Language::Nodes::NullValue < ::GraphQL::Language::Nodes::NameOnlyNode - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end -# source://graphql//lib/graphql/language/nodes.rb#630 +# source://graphql//lib/graphql/language/nodes.rb#683 class GraphQL::Language::Nodes::ObjectTypeDefinition < ::GraphQL::Language::Nodes::AbstractNode - include ::GraphQL::Language::Nodes::AbstractNode::DefinitionNode + # source://graphql//lib/graphql/language/nodes.rb#310 + def initialize(name: T.unsafe(nil), interfaces: T.unsafe(nil), description: T.unsafe(nil), directives: T.unsafe(nil), fields: T.unsafe(nil), line: T.unsafe(nil), col: T.unsafe(nil), pos: T.unsafe(nil), filename: T.unsafe(nil), source: T.unsafe(nil), definition_pos: T.unsafe(nil)); end - # source://graphql//lib/graphql/language/nodes.rb#211 + # source://graphql//lib/graphql/language/nodes.rb#214 def children; end # Returns the value of attribute description. # - # source://graphql//lib/graphql/language/nodes.rb#632 + # source://graphql//lib/graphql/language/nodes.rb#684 def description; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def directives; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def fields; end - # source://graphql//lib/graphql/language/nodes.rb#288 - def initialize_node(name: T.unsafe(nil), interfaces: T.unsafe(nil), description: T.unsafe(nil), directives: T.unsafe(nil), fields: T.unsafe(nil)); end - - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#258 def interfaces; end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_directive(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#328 + def marshal_dump; end + + # source://graphql//lib/graphql/language/nodes.rb#336 + def marshal_load(values); end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_field(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_directive(**node_opts); end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_field(**node_opts); end + + # source://graphql//lib/graphql/language/nodes.rb#258 def name; end - # source://graphql//lib/graphql/language/nodes.rb#256 + # source://graphql//lib/graphql/language/nodes.rb#260 def scalars; end - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#296 + # source://graphql//lib/graphql/language/nodes.rb#324 def from_a(filename, line, col, name, interfaces, description, directives, fields); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end -# source://graphql//lib/graphql/language/nodes.rb#641 +# source://graphql//lib/graphql/language/nodes.rb#693 class GraphQL::Language::Nodes::ObjectTypeExtension < ::GraphQL::Language::Nodes::AbstractNode - # source://graphql//lib/graphql/language/nodes.rb#211 + # source://graphql//lib/graphql/language/nodes.rb#310 + def initialize(name: T.unsafe(nil), interfaces: T.unsafe(nil), directives: T.unsafe(nil), fields: T.unsafe(nil), line: T.unsafe(nil), col: T.unsafe(nil), pos: T.unsafe(nil), filename: T.unsafe(nil), source: T.unsafe(nil)); end + + # source://graphql//lib/graphql/language/nodes.rb#214 def children; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def directives; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def fields; end - # source://graphql//lib/graphql/language/nodes.rb#288 - def initialize_node(name: T.unsafe(nil), interfaces: T.unsafe(nil), directives: T.unsafe(nil), fields: T.unsafe(nil)); end - - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#258 def interfaces; end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_directive(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#326 + def marshal_dump; end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_field(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#334 + def marshal_load(values); end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_directive(**node_opts); end + + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_field(**node_opts); end + + # source://graphql//lib/graphql/language/nodes.rb#258 def name; end - # source://graphql//lib/graphql/language/nodes.rb#256 + # source://graphql//lib/graphql/language/nodes.rb#260 def scalars; end - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#295 + # source://graphql//lib/graphql/language/nodes.rb#322 def from_a(filename, line, col, name, interfaces, directives, fields); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end @@ -4522,589 +4618,650 @@ end # May be anonymous or named. # May be explicitly typed (eg `mutation { ... }`) or implicitly a query (eg `{ ... }`). # -# source://graphql//lib/graphql/language/nodes.rb#503 +# source://graphql//lib/graphql/language/nodes.rb#560 class GraphQL::Language::Nodes::OperationDefinition < ::GraphQL::Language::Nodes::AbstractNode - # source://graphql//lib/graphql/language/nodes.rb#211 + # source://graphql//lib/graphql/language/nodes.rb#310 + def initialize(operation_type: T.unsafe(nil), name: T.unsafe(nil), variables: T.unsafe(nil), directives: T.unsafe(nil), selections: T.unsafe(nil), line: T.unsafe(nil), col: T.unsafe(nil), pos: T.unsafe(nil), filename: T.unsafe(nil), source: T.unsafe(nil), definition_pos: T.unsafe(nil)); end + + # source://graphql//lib/graphql/language/nodes.rb#214 def children; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def directives; end - # source://graphql//lib/graphql/language/nodes.rb#288 - def initialize_node(operation_type: T.unsafe(nil), name: T.unsafe(nil), variables: T.unsafe(nil), directives: T.unsafe(nil), selections: T.unsafe(nil)); end + # source://graphql//lib/graphql/language/nodes.rb#328 + def marshal_dump; end + + # source://graphql//lib/graphql/language/nodes.rb#336 + def marshal_load(values); end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_directive(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_directive(**node_opts); end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_selection(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_selection(**node_opts); end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_variable(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_variable(**node_opts); end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#258 def name; end # @return [String, nil] The root type for this operation, or `nil` for implicit `"query"` # - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#258 def operation_type; end - # source://graphql//lib/graphql/language/nodes.rb#256 + # source://graphql//lib/graphql/language/nodes.rb#260 def scalars; end # @return [Array] Root-level fields on this operation # - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def selections; end # @return [Array] Variable $definitions for this operation # - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def variables; end - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#296 + # source://graphql//lib/graphql/language/nodes.rb#324 def from_a(filename, line, col, operation_type, name, variables, directives, selections); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end -# source://graphql//lib/graphql/language/nodes.rb#581 +# source://graphql//lib/graphql/language/nodes.rb#637 class GraphQL::Language::Nodes::ScalarTypeDefinition < ::GraphQL::Language::Nodes::AbstractNode - include ::GraphQL::Language::Nodes::AbstractNode::DefinitionNode + # source://graphql//lib/graphql/language/nodes.rb#310 + def initialize(name: T.unsafe(nil), description: T.unsafe(nil), directives: T.unsafe(nil), line: T.unsafe(nil), col: T.unsafe(nil), pos: T.unsafe(nil), filename: T.unsafe(nil), source: T.unsafe(nil), definition_pos: T.unsafe(nil)); end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def children; end # Returns the value of attribute description. # - # source://graphql//lib/graphql/language/nodes.rb#583 + # source://graphql//lib/graphql/language/nodes.rb#638 def description; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def directives; end - # source://graphql//lib/graphql/language/nodes.rb#288 - def initialize_node(name: T.unsafe(nil), description: T.unsafe(nil), directives: T.unsafe(nil)); end + # source://graphql//lib/graphql/language/nodes.rb#326 + def marshal_dump; end + + # source://graphql//lib/graphql/language/nodes.rb#334 + def marshal_load(values); end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_directive(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_directive(**node_opts); end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#258 def name; end - # source://graphql//lib/graphql/language/nodes.rb#256 + # source://graphql//lib/graphql/language/nodes.rb#260 def scalars; end - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#294 + # source://graphql//lib/graphql/language/nodes.rb#322 def from_a(filename, line, col, name, description, directives); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end -# source://graphql//lib/graphql/language/nodes.rb#591 +# source://graphql//lib/graphql/language/nodes.rb#646 class GraphQL::Language::Nodes::ScalarTypeExtension < ::GraphQL::Language::Nodes::AbstractNode - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#310 + def initialize(name: T.unsafe(nil), directives: T.unsafe(nil), line: T.unsafe(nil), col: T.unsafe(nil), pos: T.unsafe(nil), filename: T.unsafe(nil), source: T.unsafe(nil)); end + + # source://graphql//lib/graphql/language/nodes.rb#193 def children; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def directives; end - # source://graphql//lib/graphql/language/nodes.rb#288 - def initialize_node(name: T.unsafe(nil), directives: T.unsafe(nil)); end + # source://graphql//lib/graphql/language/nodes.rb#324 + def marshal_dump; end + + # source://graphql//lib/graphql/language/nodes.rb#332 + def marshal_load(values); end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_directive(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_directive(**node_opts); end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#258 def name; end - # source://graphql//lib/graphql/language/nodes.rb#256 + # source://graphql//lib/graphql/language/nodes.rb#260 def scalars; end - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#293 + # source://graphql//lib/graphql/language/nodes.rb#320 def from_a(filename, line, col, name, directives); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end -# source://graphql//lib/graphql/language/nodes.rb#564 +# source://graphql//lib/graphql/language/nodes.rb#621 class GraphQL::Language::Nodes::SchemaDefinition < ::GraphQL::Language::Nodes::AbstractNode - include ::GraphQL::Language::Nodes::AbstractNode::DefinitionNode + # source://graphql//lib/graphql/language/nodes.rb#310 + def initialize(query: T.unsafe(nil), mutation: T.unsafe(nil), subscription: T.unsafe(nil), directives: T.unsafe(nil), line: T.unsafe(nil), col: T.unsafe(nil), pos: T.unsafe(nil), filename: T.unsafe(nil), source: T.unsafe(nil), definition_pos: T.unsafe(nil)); end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def children; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def directives; end - # source://graphql//lib/graphql/language/nodes.rb#288 - def initialize_node(query: T.unsafe(nil), mutation: T.unsafe(nil), subscription: T.unsafe(nil), directives: T.unsafe(nil)); end + # source://graphql//lib/graphql/language/nodes.rb#327 + def marshal_dump; end + + # source://graphql//lib/graphql/language/nodes.rb#335 + def marshal_load(values); end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_directive(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_directive(**node_opts); end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#258 def mutation; end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#258 def query; end - # source://graphql//lib/graphql/language/nodes.rb#256 + # source://graphql//lib/graphql/language/nodes.rb#260 def scalars; end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#258 def subscription; end - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#295 + # source://graphql//lib/graphql/language/nodes.rb#323 def from_a(filename, line, col, query, mutation, subscription, directives); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end -# source://graphql//lib/graphql/language/nodes.rb#573 +# source://graphql//lib/graphql/language/nodes.rb#629 class GraphQL::Language::Nodes::SchemaExtension < ::GraphQL::Language::Nodes::AbstractNode - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#310 + def initialize(query: T.unsafe(nil), mutation: T.unsafe(nil), subscription: T.unsafe(nil), directives: T.unsafe(nil), line: T.unsafe(nil), col: T.unsafe(nil), pos: T.unsafe(nil), filename: T.unsafe(nil), source: T.unsafe(nil)); end + + # source://graphql//lib/graphql/language/nodes.rb#193 def children; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def directives; end - # source://graphql//lib/graphql/language/nodes.rb#288 - def initialize_node(query: T.unsafe(nil), mutation: T.unsafe(nil), subscription: T.unsafe(nil), directives: T.unsafe(nil)); end + # source://graphql//lib/graphql/language/nodes.rb#326 + def marshal_dump; end + + # source://graphql//lib/graphql/language/nodes.rb#334 + def marshal_load(values); end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_directive(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_directive(**node_opts); end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#258 def mutation; end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#258 def query; end - # source://graphql//lib/graphql/language/nodes.rb#256 + # source://graphql//lib/graphql/language/nodes.rb#260 def scalars; end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#258 def subscription; end - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#295 + # source://graphql//lib/graphql/language/nodes.rb#322 def from_a(filename, line, col, query, mutation, subscription, directives); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end # A type name, used for variable definitions # -# source://graphql//lib/graphql/language/nodes.rb#556 +# source://graphql//lib/graphql/language/nodes.rb#613 class GraphQL::Language::Nodes::TypeName < ::GraphQL::Language::Nodes::NameOnlyNode - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end -# source://graphql//lib/graphql/language/nodes.rb#672 +# source://graphql//lib/graphql/language/nodes.rb#723 class GraphQL::Language::Nodes::UnionTypeDefinition < ::GraphQL::Language::Nodes::AbstractNode - include ::GraphQL::Language::Nodes::AbstractNode::DefinitionNode + # source://graphql//lib/graphql/language/nodes.rb#310 + def initialize(name: T.unsafe(nil), types: T.unsafe(nil), description: T.unsafe(nil), directives: T.unsafe(nil), line: T.unsafe(nil), col: T.unsafe(nil), pos: T.unsafe(nil), filename: T.unsafe(nil), source: T.unsafe(nil), definition_pos: T.unsafe(nil)); end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def children; end # Returns the value of attribute description. # - # source://graphql//lib/graphql/language/nodes.rb#674 + # source://graphql//lib/graphql/language/nodes.rb#724 def description; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def directives; end - # source://graphql//lib/graphql/language/nodes.rb#288 - def initialize_node(name: T.unsafe(nil), types: T.unsafe(nil), description: T.unsafe(nil), directives: T.unsafe(nil)); end + # source://graphql//lib/graphql/language/nodes.rb#327 + def marshal_dump; end + + # source://graphql//lib/graphql/language/nodes.rb#335 + def marshal_load(values); end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_directive(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_directive(**node_opts); end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#258 def name; end - # source://graphql//lib/graphql/language/nodes.rb#256 + # source://graphql//lib/graphql/language/nodes.rb#260 def scalars; end # Returns the value of attribute types. # - # source://graphql//lib/graphql/language/nodes.rb#674 + # source://graphql//lib/graphql/language/nodes.rb#724 def types; end - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#295 + # source://graphql//lib/graphql/language/nodes.rb#323 def from_a(filename, line, col, name, types, description, directives); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end -# source://graphql//lib/graphql/language/nodes.rb#682 +# source://graphql//lib/graphql/language/nodes.rb#732 class GraphQL::Language::Nodes::UnionTypeExtension < ::GraphQL::Language::Nodes::AbstractNode - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#310 + def initialize(name: T.unsafe(nil), types: T.unsafe(nil), directives: T.unsafe(nil), line: T.unsafe(nil), col: T.unsafe(nil), pos: T.unsafe(nil), filename: T.unsafe(nil), source: T.unsafe(nil)); end + + # source://graphql//lib/graphql/language/nodes.rb#193 def children; end - # source://graphql//lib/graphql/language/nodes.rb#190 + # source://graphql//lib/graphql/language/nodes.rb#193 def directives; end - # source://graphql//lib/graphql/language/nodes.rb#288 - def initialize_node(name: T.unsafe(nil), types: T.unsafe(nil), directives: T.unsafe(nil)); end + # source://graphql//lib/graphql/language/nodes.rb#325 + def marshal_dump; end + + # source://graphql//lib/graphql/language/nodes.rb#333 + def marshal_load(values); end - # source://graphql//lib/graphql/language/nodes.rb#198 - def merge_directive(node_opts); end + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_directive(**node_opts); end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#258 def name; end - # source://graphql//lib/graphql/language/nodes.rb#256 + # source://graphql//lib/graphql/language/nodes.rb#260 def scalars; end # Returns the value of attribute types. # - # source://graphql//lib/graphql/language/nodes.rb#683 + # source://graphql//lib/graphql/language/nodes.rb#733 def types; end - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#294 + # source://graphql//lib/graphql/language/nodes.rb#321 def from_a(filename, line, col, name, types, directives); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end # An operation-level query variable # -# source://graphql//lib/graphql/language/nodes.rb#485 +# source://graphql//lib/graphql/language/nodes.rb#542 class GraphQL::Language::Nodes::VariableDefinition < ::GraphQL::Language::Nodes::AbstractNode + # source://graphql//lib/graphql/language/nodes.rb#310 + def initialize(name: T.unsafe(nil), type: T.unsafe(nil), default_value: T.unsafe(nil), directives: T.unsafe(nil), line: T.unsafe(nil), col: T.unsafe(nil), pos: T.unsafe(nil), filename: T.unsafe(nil), source: T.unsafe(nil), definition_pos: T.unsafe(nil)); end + + # source://graphql//lib/graphql/language/nodes.rb#193 + def children; end + # @return [String, Integer, Float, Boolean, Array, NullValue] A Ruby value to use if no other value is provided # - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#258 def default_value; end - # source://graphql//lib/graphql/language/nodes.rb#288 - def initialize_node(name: T.unsafe(nil), type: T.unsafe(nil), default_value: T.unsafe(nil)); end + # source://graphql//lib/graphql/language/nodes.rb#193 + def directives; end + + # source://graphql//lib/graphql/language/nodes.rb#327 + def marshal_dump; end + + # source://graphql//lib/graphql/language/nodes.rb#335 + def marshal_load(values); end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#201 + def merge_directive(**node_opts); end + + # source://graphql//lib/graphql/language/nodes.rb#258 def name; end - # source://graphql//lib/graphql/language/nodes.rb#256 + # source://graphql//lib/graphql/language/nodes.rb#260 def scalars; end # @return [TypeName, NonNullType, ListType] The expected type of this value # - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#258 def type; end - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#294 - def from_a(filename, line, col, name, type, default_value); end + # source://graphql//lib/graphql/language/nodes.rb#323 + def from_a(filename, line, col, name, type, default_value, directives); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end # Usage of a variable in a query. Name does _not_ include `$`. # -# source://graphql//lib/graphql/language/nodes.rb#560 +# source://graphql//lib/graphql/language/nodes.rb#617 class GraphQL::Language::Nodes::VariableIdentifier < ::GraphQL::Language::Nodes::NameOnlyNode - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end # Base class for non-null type names and list type names # -# source://graphql//lib/graphql/language/nodes.rb#303 +# source://graphql//lib/graphql/language/nodes.rb#342 class GraphQL::Language::Nodes::WrapperType < ::GraphQL::Language::Nodes::AbstractNode - # source://graphql//lib/graphql/language/nodes.rb#288 - def initialize_node(of_type: T.unsafe(nil)); end + # source://graphql//lib/graphql/language/nodes.rb#310 + def initialize(of_type: T.unsafe(nil), line: T.unsafe(nil), col: T.unsafe(nil), pos: T.unsafe(nil), filename: T.unsafe(nil), source: T.unsafe(nil)); end + + # source://graphql//lib/graphql/language/nodes.rb#323 + def marshal_dump; end - # source://graphql//lib/graphql/language/nodes.rb#254 + # source://graphql//lib/graphql/language/nodes.rb#331 + def marshal_load(values); end + + # source://graphql//lib/graphql/language/nodes.rb#258 def of_type; end - # source://graphql//lib/graphql/language/nodes.rb#256 + # source://graphql//lib/graphql/language/nodes.rb#260 def scalars; end - # source://graphql//lib/graphql/language/nodes.rb#149 + # source://graphql//lib/graphql/language/nodes.rb#152 def visit_method; end class << self - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name; end - # source://graphql//lib/graphql/language/nodes.rb#154 + # source://graphql//lib/graphql/language/nodes.rb#157 def children_method_name=(_arg0); end - # source://graphql//lib/graphql/language/nodes.rb#292 + # source://graphql//lib/graphql/language/nodes.rb#319 def from_a(filename, line, col, of_type); end - # source://graphql//lib/graphql/language/nodes.rb#156 + # source://graphql//lib/graphql/language/nodes.rb#159 def visit_method; end end end -# source://graphql//lib/graphql/language/parser.rb#13 -class GraphQL::Language::Parser < ::Racc::Parser - def initialize(query_string, filename:, trace: T.unsafe(nil)); end - - def _reduce_10(val, _values, result); end - def _reduce_100(val, _values, result); end - def _reduce_102(val, _values, result); end - def _reduce_103(val, _values, result); end - def _reduce_104(val, _values, result); end - def _reduce_105(val, _values, result); end - def _reduce_106(val, _values, result); end - def _reduce_107(val, _values, result); end - def _reduce_108(val, _values, result); end - def _reduce_109(val, _values, result); end - def _reduce_11(val, _values, result); end - def _reduce_114(val, _values, result); end - def _reduce_115(val, _values, result); end - def _reduce_116(val, _values, result); end - def _reduce_118(val, _values, result); end - def _reduce_119(val, _values, result); end - def _reduce_12(val, _values, result); end - def _reduce_128(val, _values, result); end - def _reduce_129(val, _values, result); end - def _reduce_136(val, _values, result); end - def _reduce_137(val, _values, result); end - def _reduce_138(val, _values, result); end - def _reduce_139(val, _values, result); end - def _reduce_140(val, _values, result); end - def _reduce_141(val, _values, result); end - def _reduce_142(val, _values, result); end - def _reduce_143(val, _values, result); end - def _reduce_144(val, _values, result); end - def _reduce_145(val, _values, result); end - def _reduce_146(val, _values, result); end - def _reduce_147(val, _values, result); end - def _reduce_148(val, _values, result); end - def _reduce_149(val, _values, result); end - def _reduce_153(val, _values, result); end - def _reduce_154(val, _values, result); end - def _reduce_155(val, _values, result); end - def _reduce_157(val, _values, result); end - def _reduce_158(val, _values, result); end - def _reduce_159(val, _values, result); end - def _reduce_16(val, _values, result); end - def _reduce_160(val, _values, result); end - def _reduce_161(val, _values, result); end - def _reduce_162(val, _values, result); end - def _reduce_163(val, _values, result); end - def _reduce_164(val, _values, result); end - def _reduce_165(val, _values, result); end - def _reduce_166(val, _values, result); end - def _reduce_167(val, _values, result); end - def _reduce_168(val, _values, result); end - def _reduce_169(val, _values, result); end - def _reduce_170(val, _values, result); end - def _reduce_171(val, _values, result); end - def _reduce_172(val, _values, result); end - def _reduce_173(val, _values, result); end - def _reduce_174(val, _values, result); end - def _reduce_175(val, _values, result); end - def _reduce_176(val, _values, result); end - def _reduce_177(val, _values, result); end - def _reduce_178(val, _values, result); end - def _reduce_179(val, _values, result); end - def _reduce_18(val, _values, result); end - def _reduce_180(val, _values, result); end - def _reduce_181(val, _values, result); end - def _reduce_184(val, _values, result); end - def _reduce_185(val, _values, result); end - def _reduce_19(val, _values, result); end - def _reduce_2(val, _values, result); end - def _reduce_20(val, _values, result); end - def _reduce_21(val, _values, result); end - def _reduce_22(val, _values, result); end - def _reduce_23(val, _values, result); end - def _reduce_24(val, _values, result); end - def _reduce_25(val, _values, result); end - def _reduce_26(val, _values, result); end - def _reduce_27(val, _values, result); end - def _reduce_28(val, _values, result); end - def _reduce_29(val, _values, result); end - def _reduce_3(val, _values, result); end - def _reduce_30(val, _values, result); end - def _reduce_31(val, _values, result); end - def _reduce_32(val, _values, result); end - def _reduce_33(val, _values, result); end - def _reduce_37(val, _values, result); end - def _reduce_38(val, _values, result); end - def _reduce_4(val, _values, result); end - def _reduce_63(val, _values, result); end - def _reduce_64(val, _values, result); end - def _reduce_65(val, _values, result); end - def _reduce_66(val, _values, result); end - def _reduce_67(val, _values, result); end - def _reduce_68(val, _values, result); end - def _reduce_69(val, _values, result); end - def _reduce_70(val, _values, result); end - def _reduce_71(val, _values, result); end - def _reduce_72(val, _values, result); end - def _reduce_73(val, _values, result); end - def _reduce_74(val, _values, result); end - def _reduce_75(val, _values, result); end - def _reduce_83(val, _values, result); end - def _reduce_84(val, _values, result); end - def _reduce_85(val, _values, result); end - def _reduce_86(val, _values, result); end - def _reduce_87(val, _values, result); end - def _reduce_88(val, _values, result); end - def _reduce_89(val, _values, result); end - def _reduce_90(val, _values, result); end - def _reduce_91(val, _values, result); end - def _reduce_92(val, _values, result); end - def _reduce_93(val, _values, result); end - def _reduce_94(val, _values, result); end - def _reduce_95(val, _values, result); end - def _reduce_96(val, _values, result); end - def _reduce_97(val, _values, result); end - def _reduce_98(val, _values, result); end - def _reduce_99(val, _values, result); end - - # source://graphql//lib/graphql/language/parser.rb#2010 - def _reduce_none(val, _values, result); end - - def parse_document; end +# source://graphql//lib/graphql/language/parser.rb#8 +class GraphQL::Language::Parser + include ::GraphQL::Language::Nodes + include ::GraphQL::EmptyObjects + + # @return [Parser] a new instance of Parser + # + # source://graphql//lib/graphql/language/parser.rb#30 + def initialize(graphql_str, filename: T.unsafe(nil), trace: T.unsafe(nil), max_tokens: T.unsafe(nil)); end + + # source://graphql//lib/graphql/language/parser.rb#61 + def column_at(pos); end + + # source://graphql//lib/graphql/language/parser.rb#52 + def line_at(pos); end + + # source://graphql//lib/graphql/language/parser.rb#42 + def parse; end private - def get_description(token); end - def make_node(node_name, assigns); end - def next_token; end - def on_error(parser_token_id, lexer_token, vstack); end + # source://graphql//lib/graphql/language/parser.rb#91 + def advance_token; end + + # @return [Boolean] + # + # source://graphql//lib/graphql/language/parser.rb#790 + def at?(expected_token_name); end + + # token_value works for when the scanner matched something + # which is usually fine and it's good for it to be fast at that. + # + # source://graphql//lib/graphql/language/parser.rb#829 + def debug_token_value; end + + # source://graphql//lib/graphql/language/parser.rb#114 + def definition; end + + # source://graphql//lib/graphql/language/parser.rb#99 + def document; end + + # source://graphql//lib/graphql/language/parser.rb#801 + def expect_one_of(token_names); end + + # source://graphql//lib/graphql/language/parser.rb#794 + def expect_token(expected_token_name); end + + # Only use when we care about the expected token's value + # + # source://graphql//lib/graphql/language/parser.rb#818 + def expect_token_value(tok); end + + # @return [Array] Positions of each line break in the original string + # + # source://graphql//lib/graphql/language/parser.rb#74 + def lines_at; end + + # source://graphql//lib/graphql/language/parser.rb#500 + def list_type; end + + # source://graphql//lib/graphql/language/parser.rb#454 + def parse_argument_definitions; end + + # source://graphql//lib/graphql/language/parser.rb#668 + def parse_arguments; end + + # source://graphql//lib/graphql/language/parser.rb#651 + def parse_directives; end + + # source://graphql//lib/graphql/language/parser.rb#379 + def parse_enum_value_definitions; end + + # source://graphql//lib/graphql/language/parser.rb#435 + def parse_field_definitions; end + + # source://graphql//lib/graphql/language/parser.rb#420 + def parse_implements; end + + # source://graphql//lib/graphql/language/parser.rb#365 + def parse_input_object_field_definitions; end + + # source://graphql//lib/graphql/language/parser.rb#468 + def parse_input_value_definition; end + + # source://graphql//lib/graphql/language/parser.rb#573 + def parse_name; end + + # source://graphql//lib/graphql/language/parser.rb#639 + def parse_name_without_on; end + + # source://graphql//lib/graphql/language/parser.rb#508 + def parse_operation_type; end + + # source://graphql//lib/graphql/language/parser.rb#647 + def parse_type_name; end + + # source://graphql//lib/graphql/language/parser.rb#403 + def parse_union_members; end + + # source://graphql//lib/graphql/language/parser.rb#95 + def pos; end + + # @raise [GraphQL::ParseError] + # + # source://graphql//lib/graphql/language/parser.rb#805 + def raise_parse_error(message); end + + # source://graphql//lib/graphql/language/parser.rb#522 + def selection_set; end + + # source://graphql//lib/graphql/language/parser.rb#688 + def string_value; end + + # Returns the value of attribute token_name. + # + # source://graphql//lib/graphql/language/parser.rb#89 + def token_name; end + + # source://graphql//lib/graphql/language/parser.rb#485 + def type; end + + # source://graphql//lib/graphql/language/parser.rb#694 + def value; end class << self + # Returns the value of attribute cache. + # + # source://graphql//lib/graphql/language/parser.rb#13 def cache; end + + # Sets the attribute cache + # + # @param value the value to set the attribute cache to. + # + # source://graphql//lib/graphql/language/parser.rb#13 def cache=(_arg0); end - def parse(query_string, filename: T.unsafe(nil), trace: T.unsafe(nil)); end + + # source://graphql//lib/graphql/language/parser.rb#15 + def parse(graphql_str, filename: T.unsafe(nil), trace: T.unsafe(nil), max_tokens: T.unsafe(nil)); end + + # source://graphql//lib/graphql/language/parser.rb#19 def parse_file(filename, trace: T.unsafe(nil)); end end end -# source://graphql//lib/graphql/language/parser.rb#838 -GraphQL::Language::Parser::Racc_arg = T.let(T.unsafe(nil), Array) - -# source://graphql//lib/graphql/language/parser.rb#981 -GraphQL::Language::Parser::Racc_debug_parser = T.let(T.unsafe(nil), FalseClass) - -# source://graphql//lib/graphql/language/parser.rb#854 -GraphQL::Language::Parser::Racc_token_to_s_table = T.let(T.unsafe(nil), Array) +# source://graphql//lib/graphql/language/parser.rb#832 +class GraphQL::Language::Parser::SchemaParser < ::GraphQL::Language::Parser + # @return [SchemaParser] a new instance of SchemaParser + # + # source://graphql//lib/graphql/language/parser.rb#833 + def initialize(*args, **kwargs); end +end # source://graphql//lib/graphql/language/printer.rb#4 class GraphQL::Language::Printer @@ -5118,130 +5275,151 @@ class GraphQL::Language::Printer # # class MyPrinter < GraphQL::Language::Printer # def print_argument(arg) - # "#{arg.name}: " + # print_string("#{arg.name}: ") # end # end # # MyPrinter.new.print(document) # # => "mutation { pay(creditCard: ) { success } }" + # @param node [Nodes::AbstractNode] # @param indent [String] Whitespace to add to the printed node + # @param truncate_size [Integer, nil] The size to truncate to. # @return [String] Valid GraphQL for `node` # - # source://graphql//lib/graphql/language/printer.rb#27 - def print(node, indent: T.unsafe(nil)); end + # source://graphql//lib/graphql/language/printer.rb#54 + def print(node, indent: T.unsafe(nil), truncate_size: T.unsafe(nil)); end protected - # source://graphql//lib/graphql/language/printer.rb#37 + # source://graphql//lib/graphql/language/printer.rb#76 def print_argument(argument); end - # source://graphql//lib/graphql/language/printer.rb#191 + # source://graphql//lib/graphql/language/printer.rb#296 def print_arguments(arguments, indent: T.unsafe(nil)); end - # source://graphql//lib/graphql/language/printer.rb#274 + # source://graphql//lib/graphql/language/printer.rb#420 def print_description(node, indent: T.unsafe(nil), first_in_block: T.unsafe(nil)); end - # source://graphql//lib/graphql/language/printer.rb#41 + # source://graphql//lib/graphql/language/printer.rb#91 def print_directive(directive); end - # source://graphql//lib/graphql/language/printer.rb#259 + # source://graphql//lib/graphql/language/printer.rb#396 def print_directive_definition(directive); end - # source://graphql//lib/graphql/language/printer.rb#294 + # source://graphql//lib/graphql/language/printer.rb#442 def print_directives(directives); end - # source://graphql//lib/graphql/language/printer.rb#33 + # source://graphql//lib/graphql/language/printer.rb#69 def print_document(document); end - # source://graphql//lib/graphql/language/printer.rb#51 + # source://graphql//lib/graphql/language/printer.rb#105 def print_enum(enum); end - # source://graphql//lib/graphql/language/printer.rb#228 + # source://graphql//lib/graphql/language/printer.rb#357 def print_enum_type_definition(enum_type, extension: T.unsafe(nil)); end - # source://graphql//lib/graphql/language/printer.rb#238 + # source://graphql//lib/graphql/language/printer.rb#372 def print_enum_value_definition(enum_value); end - # source://graphql//lib/graphql/language/printer.rb#59 + # source://graphql//lib/graphql/language/printer.rb#113 def print_field(field, indent: T.unsafe(nil)); end - # source://graphql//lib/graphql/language/printer.rb#204 + # source://graphql//lib/graphql/language/printer.rb#320 def print_field_definition(field); end - # source://graphql//lib/graphql/language/printer.rb#281 + # source://graphql//lib/graphql/language/printer.rb#427 def print_field_definitions(fields); end - # source://graphql//lib/graphql/language/printer.rb#69 + # source://graphql//lib/graphql/language/printer.rb#132 def print_fragment_definition(fragment_def, indent: T.unsafe(nil)); end - # source://graphql//lib/graphql/language/printer.rb#79 + # source://graphql//lib/graphql/language/printer.rb#148 def print_fragment_spread(fragment_spread, indent: T.unsafe(nil)); end - # source://graphql//lib/graphql/language/printer.rb#181 + # source://graphql//lib/graphql/language/printer.rb#273 def print_implements(type); end - # source://graphql//lib/graphql/language/printer.rb#85 + # source://graphql//lib/graphql/language/printer.rb#155 def print_inline_fragment(inline_fragment, indent: T.unsafe(nil)); end - # source://graphql//lib/graphql/language/printer.rb#95 + # source://graphql//lib/graphql/language/printer.rb#82 def print_input_object(input_object); end - # source://graphql//lib/graphql/language/printer.rb#244 + # source://graphql//lib/graphql/language/printer.rb#379 def print_input_object_type_definition(input_object_type, extension: T.unsafe(nil)); end - # source://graphql//lib/graphql/language/printer.rb#185 + # source://graphql//lib/graphql/language/printer.rb#285 def print_input_value_definition(input_value); end - # source://graphql//lib/graphql/language/printer.rb#213 + # source://graphql//lib/graphql/language/printer.rb#330 def print_interface_type_definition(interface_type, extension: T.unsafe(nil)); end - # source://graphql//lib/graphql/language/printer.rb#99 + # source://graphql//lib/graphql/language/printer.rb#166 def print_list_type(list_type); end - # source://graphql//lib/graphql/language/printer.rb#314 + # source://graphql//lib/graphql/language/printer.rb#463 def print_node(node, indent: T.unsafe(nil)); end - # source://graphql//lib/graphql/language/printer.rb#103 + # source://graphql//lib/graphql/language/printer.rb#172 def print_non_null_type(non_null_type); end - # source://graphql//lib/graphql/language/printer.rb#55 + # source://graphql//lib/graphql/language/printer.rb#109 def print_null_value; end - # source://graphql//lib/graphql/language/printer.rb#173 + # source://graphql//lib/graphql/language/printer.rb#264 def print_object_type_definition(object_type, extension: T.unsafe(nil)); end - # source://graphql//lib/graphql/language/printer.rb#107 + # source://graphql//lib/graphql/language/printer.rb#177 def print_operation_definition(operation_definition, indent: T.unsafe(nil)); end - # source://graphql//lib/graphql/language/printer.rb#167 + # source://graphql//lib/graphql/language/printer.rb#257 def print_scalar_type_definition(scalar_type, extension: T.unsafe(nil)); end - # source://graphql//lib/graphql/language/printer.rb#134 + # source://graphql//lib/graphql/language/printer.rb#222 def print_schema_definition(schema, extension: T.unsafe(nil)); end - # source://graphql//lib/graphql/language/printer.rb#302 + # source://graphql//lib/graphql/language/printer.rb#451 def print_selections(selections, indent: T.unsafe(nil)); end - # source://graphql//lib/graphql/language/printer.rb#120 + # source://graphql//lib/graphql/language/printer.rb#65 + def print_string(str); end + + # source://graphql//lib/graphql/language/printer.rb#198 def print_type_name(type_name); end - # source://graphql//lib/graphql/language/printer.rb#221 + # source://graphql//lib/graphql/language/printer.rb#339 def print_union_type_definition(union_type, extension: T.unsafe(nil)); end - # source://graphql//lib/graphql/language/printer.rb#124 + # source://graphql//lib/graphql/language/printer.rb#202 def print_variable_definition(variable_definition); end - # source://graphql//lib/graphql/language/printer.rb#130 + # source://graphql//lib/graphql/language/printer.rb#217 def print_variable_identifier(variable_identifier); end +end - private +# source://graphql//lib/graphql/language/printer.rb#5 +GraphQL::Language::Printer::OMISSION = T.let(T.unsafe(nil), String) - # Returns the value of attribute node. +# source://graphql//lib/graphql/language/printer.rb#7 +class GraphQL::Language::Printer::TruncatableBuffer + # @return [TruncatableBuffer] a new instance of TruncatableBuffer # - # source://graphql//lib/graphql/language/printer.rb#397 - def node; end + # source://graphql//lib/graphql/language/printer.rb#12 + def initialize(truncate_size: T.unsafe(nil)); end + + # source://graphql//lib/graphql/language/printer.rb#17 + def append(other); end + + # source://graphql//lib/graphql/language/printer.rb#26 + def to_string; end end +# source://graphql//lib/graphql/language/printer.rb#10 +GraphQL::Language::Printer::TruncatableBuffer::DEFAULT_INIT_CAPACITY = T.let(T.unsafe(nil), Integer) + +# source://graphql//lib/graphql/language/printer.rb#8 +class GraphQL::Language::Printer::TruncatableBuffer::TruncateSizeReached < ::StandardError; end + # A custom printer used to print sanitized queries. It inlines provided variables # within the query for facilitate logging and analysis of queries. # @@ -5268,117 +5446,218 @@ class GraphQL::Language::SanitizedPrinter < ::GraphQL::Language::Printer # source://graphql//lib/graphql/language/sanitized_printer.rb#99 def coerce_argument_value_to_list?(type, value); end - # source://graphql//lib/graphql/language/sanitized_printer.rb#76 + # source://graphql//lib/graphql/language/sanitized_printer.rb#75 def print_argument(argument); end - # source://graphql//lib/graphql/language/sanitized_printer.rb#149 + # source://graphql//lib/graphql/language/sanitized_printer.rb#144 def print_directive(directive); end - # source://graphql//lib/graphql/language/sanitized_printer.rb#115 - def print_field(field, indent: T.unsafe(nil)); end + # source://graphql//lib/graphql/language/sanitized_printer.rb#115 + def print_field(field, indent: T.unsafe(nil)); end + + # source://graphql//lib/graphql/language/sanitized_printer.rb#135 + def print_fragment_definition(fragment_def, indent: T.unsafe(nil)); end + + # source://graphql//lib/graphql/language/sanitized_printer.rb#123 + def print_inline_fragment(inline_fragment, indent: T.unsafe(nil)); end + + # source://graphql//lib/graphql/language/sanitized_printer.rb#39 + def print_node(node, indent: T.unsafe(nil)); end + + # Print the operation definition but do not include the variable + # definitions since we will inline them within the query + # + # source://graphql//lib/graphql/language/sanitized_printer.rb#154 + def print_operation_definition(operation_definition, indent: T.unsafe(nil)); end + + # source://graphql//lib/graphql/language/sanitized_printer.rb#106 + def print_variable_identifier(variable_id); end + + # Indicates whether or not to redact non-null values for the given argument. Defaults to redacting all strings + # arguments but this can be customized by subclasses. + # + # @return [Boolean] + # + # source://graphql//lib/graphql/language/sanitized_printer.rb#63 + def redact_argument_value?(argument, value); end + + # Returns the value to use for redacted versions of the given argument. Defaults to the + # string "". + # + # source://graphql//lib/graphql/language/sanitized_printer.rb#71 + def redacted_argument_value(argument); end + + # @return [String, nil] A scrubbed query string, if the query was valid. + # + # source://graphql//lib/graphql/language/sanitized_printer.rb#31 + def sanitized_query_string; end + + private + + # Returns the value of attribute query. + # + # source://graphql//lib/graphql/language/sanitized_printer.rb#217 + def query; end + + # source://graphql//lib/graphql/language/sanitized_printer.rb#172 + def value_to_ast(value, type); end +end + +# source://graphql//lib/graphql/language/sanitized_printer.rb#20 +GraphQL::Language::SanitizedPrinter::REDACTED = T.let(T.unsafe(nil), String) + +# Like `GraphQL::Language::Visitor` except it doesn't support +# making changes to the document -- only visiting it as-is. +# +# source://graphql//lib/graphql/language/static_visitor.rb#6 +class GraphQL::Language::StaticVisitor + # @return [StaticVisitor] a new instance of StaticVisitor + # + # source://graphql//lib/graphql/language/static_visitor.rb#7 + def initialize(document); end + + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_argument(node, parent); end + + # source://graphql//lib/graphql/language/static_visitor.rb#109 + def on_argument_children(new_node); end + + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_directive(node, parent); end + + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_directive_definition(node, parent); end + + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_directive_location(node, parent); end + + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_document(node, parent); end + + # source://graphql//lib/graphql/language/static_visitor.rb#58 + def on_document_children(document_node); end + + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_enum(node, parent); end + + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_enum_type_definition(node, parent); end + + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_enum_type_extension(node, parent); end + + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_enum_value_definition(node, parent); end + + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_field(node, parent); end + + # source://graphql//lib/graphql/language/static_visitor.rb#65 + def on_field_children(new_node); end + + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_field_definition(node, parent); end + + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_fragment_definition(node, parent); end + + # source://graphql//lib/graphql/language/static_visitor.rb#94 + def on_fragment_definition_children(new_node); end + + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_fragment_spread(node, parent); end + + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_inline_fragment(node, parent); end + + # source://graphql//lib/graphql/language/static_visitor.rb#94 + def on_inline_fragment_children(new_node); end + + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_input_object(node, parent); end + + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_input_object_type_definition(node, parent); end + + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_input_object_type_extension(node, parent); end + + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_input_value_definition(node, parent); end + + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_interface_type_definition(node, parent); end - # source://graphql//lib/graphql/language/sanitized_printer.rb#138 - def print_fragment_definition(fragment_def, indent: T.unsafe(nil)); end + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_interface_type_extension(node, parent); end - # source://graphql//lib/graphql/language/sanitized_printer.rb#124 - def print_inline_fragment(inline_fragment, indent: T.unsafe(nil)); end + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_list_type(node, parent); end - # source://graphql//lib/graphql/language/sanitized_printer.rb#39 - def print_node(node, indent: T.unsafe(nil)); end + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_non_null_type(node, parent); end - # Print the operation definition but do not include the variable - # definitions since we will inline them within the query - # - # source://graphql//lib/graphql/language/sanitized_printer.rb#160 - def print_operation_definition(operation_definition, indent: T.unsafe(nil)); end + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_null_value(node, parent); end - # source://graphql//lib/graphql/language/sanitized_printer.rb#106 - def print_variable_identifier(variable_id); end + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_object_type_definition(node, parent); end - # Indicates whether or not to redact non-null values for the given argument. Defaults to redacting all strings - # arguments but this can be customized by subclasses. - # - # @return [Boolean] - # - # source://graphql//lib/graphql/language/sanitized_printer.rb#64 - def redact_argument_value?(argument, value); end + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_object_type_extension(node, parent); end - # Returns the value to use for redacted versions of the given argument. Defaults to the - # string "". - # - # source://graphql//lib/graphql/language/sanitized_printer.rb#72 - def redacted_argument_value(argument); end + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_operation_definition(node, parent); end - # @return [String, nil] A scrubbed query string, if the query was valid. - # - # source://graphql//lib/graphql/language/sanitized_printer.rb#31 - def sanitized_query_string; end + # source://graphql//lib/graphql/language/static_visitor.rb#101 + def on_operation_definition_children(new_node); end - private + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_scalar_type_definition(node, parent); end - # Returns the value of attribute query. - # - # source://graphql//lib/graphql/language/sanitized_printer.rb#219 - def query; end + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_scalar_type_extension(node, parent); end - # source://graphql//lib/graphql/language/sanitized_printer.rb#179 - def value_to_ast(value, type); end -end + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_schema_definition(node, parent); end -# source://graphql//lib/graphql/language/sanitized_printer.rb#20 -GraphQL::Language::SanitizedPrinter::REDACTED = T.let(T.unsafe(nil), String) + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_schema_extension(node, parent); end -# Emitted by the lexer and passed to the parser. -# Contains type, value and position data. -# -# source://graphql//lib/graphql/language/token.rb#6 -class GraphQL::Language::Token - # @return [Token] a new instance of Token - # - # source://graphql//lib/graphql/language/token.rb#13 - def initialize(name, value, line, col, prev_token); end + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_type_name(node, parent); end - # Returns the value of attribute col. - # - # source://graphql//lib/graphql/language/token.rb#11 - def col; end + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_union_type_definition(node, parent); end - # source://graphql//lib/graphql/language/token.rb#29 - def inspect; end + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_union_type_extension(node, parent); end - # Returns the value of attribute line. - # - # source://graphql//lib/graphql/language/token.rb#11 - def line; end + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_variable_definition(node, parent); end - # source://graphql//lib/graphql/language/token.rb#25 - def line_and_column; end + # source://graphql//lib/graphql/language/static_visitor.rb#40 + def on_variable_identifier(node, parent); end - # @return [Symbol] The kind of token this is + # Visit `document` and all children # - # source://graphql//lib/graphql/language/token.rb#8 - def name; end - - # Returns the value of attribute prev_token. + # @return [void] # - # source://graphql//lib/graphql/language/token.rb#11 - def prev_token; end - - # source://graphql//lib/graphql/language/token.rb#23 - def to_f; end + # source://graphql//lib/graphql/language/static_visitor.rb#13 + def visit; end - # source://graphql//lib/graphql/language/token.rb#22 - def to_i; end + # source://graphql//lib/graphql/language/static_visitor.rb#73 + def visit_directives(new_node); end - # @return [String] The text of this token - # - # source://graphql//lib/graphql/language/token.rb#10 - def to_s; end + # source://graphql//lib/graphql/language/static_visitor.rb#79 + def visit_selections(new_node); end - # @return [String] The text of this token - # - # source://graphql//lib/graphql/language/token.rb#10 - def value; end + class << self + # We don't use `alias` here because it breaks `super` + # + # source://graphql//lib/graphql/language/static_visitor.rb#26 + def make_visit_methods(ast_node_class); end + end end # Depth-first traversal through the tree, calling hooks at each stop. @@ -5410,293 +5689,270 @@ end # # Check the result # visitor.count # # => 3 +# @see GraphQL::Language::StaticVisitor for a faster visitor that doesn't support modifying the document # -# source://graphql//lib/graphql/language/visitor.rb#33 +# source://graphql//lib/graphql/language/visitor.rb#35 class GraphQL::Language::Visitor # @return [Visitor] a new instance of Visitor # - # source://graphql//lib/graphql/language/visitor.rb#45 + # source://graphql//lib/graphql/language/visitor.rb#42 def initialize(document); end - # Get a {NodeVisitor} for `node_class` - # - # @deprecated see `on_` methods, like {#on_field} - # @example Run a hook whenever you enter a new Field - # visitor[GraphQL::Language::Nodes::Field] << ->(node, parent) { p "Here's a field" } - # @param node_class [Class] The node class that you want to listen to - # @return [NodeVisitor] - # - # source://graphql//lib/graphql/language/visitor.rb#61 - def [](node_class); end - - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_argument(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#218 + # source://graphql//lib/graphql/language/visitor.rb#197 def on_argument_children(new_node); end - # source://graphql//lib/graphql/language/visitor.rb#117 + # source://graphql//lib/graphql/language/visitor.rb#96 def on_argument_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_directive(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_directive_definition(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#130 + # source://graphql//lib/graphql/language/visitor.rb#109 def on_directive_definition_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_directive_location(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#117 + # source://graphql//lib/graphql/language/visitor.rb#96 def on_directive_location_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#123 + # source://graphql//lib/graphql/language/visitor.rb#102 def on_directive_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_document(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#140 + # source://graphql//lib/graphql/language/visitor.rb#119 def on_document_children(document_node); end - # source://graphql//lib/graphql/language/visitor.rb#117 + # source://graphql//lib/graphql/language/visitor.rb#96 def on_document_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_enum(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_enum_type_definition(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#130 + # source://graphql//lib/graphql/language/visitor.rb#109 def on_enum_type_definition_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_enum_type_extension(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#130 + # source://graphql//lib/graphql/language/visitor.rb#109 def on_enum_type_extension_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_enum_value_definition(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#123 + # source://graphql//lib/graphql/language/visitor.rb#102 def on_enum_value_definition_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#117 + # source://graphql//lib/graphql/language/visitor.rb#96 def on_enum_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_field(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#153 + # source://graphql//lib/graphql/language/visitor.rb#132 def on_field_children(new_node); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_field_definition(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#130 + # source://graphql//lib/graphql/language/visitor.rb#109 def on_field_definition_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#117 + # source://graphql//lib/graphql/language/visitor.rb#96 def on_field_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_fragment_definition(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#197 + # source://graphql//lib/graphql/language/visitor.rb#176 def on_fragment_definition_children(new_node); end - # source://graphql//lib/graphql/language/visitor.rb#117 + # source://graphql//lib/graphql/language/visitor.rb#96 def on_fragment_definition_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_fragment_spread(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#123 + # source://graphql//lib/graphql/language/visitor.rb#102 def on_fragment_spread_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_inline_fragment(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#197 + # source://graphql//lib/graphql/language/visitor.rb#176 def on_inline_fragment_children(new_node); end - # source://graphql//lib/graphql/language/visitor.rb#117 + # source://graphql//lib/graphql/language/visitor.rb#96 def on_inline_fragment_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_input_object(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_input_object_type_definition(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#130 + # source://graphql//lib/graphql/language/visitor.rb#109 def on_input_object_type_definition_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_input_object_type_extension(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#130 + # source://graphql//lib/graphql/language/visitor.rb#109 def on_input_object_type_extension_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#123 + # source://graphql//lib/graphql/language/visitor.rb#102 def on_input_object_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_input_value_definition(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#123 + # source://graphql//lib/graphql/language/visitor.rb#102 def on_input_value_definition_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_interface_type_definition(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#137 + # source://graphql//lib/graphql/language/visitor.rb#116 def on_interface_type_definition_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_interface_type_extension(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#137 + # source://graphql//lib/graphql/language/visitor.rb#116 def on_interface_type_extension_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_list_type(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#117 + # source://graphql//lib/graphql/language/visitor.rb#96 def on_list_type_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_non_null_type(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#117 + # source://graphql//lib/graphql/language/visitor.rb#96 def on_non_null_type_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_null_value(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#117 + # source://graphql//lib/graphql/language/visitor.rb#96 def on_null_value_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_object_type_definition(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#130 + # source://graphql//lib/graphql/language/visitor.rb#109 def on_object_type_definition_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_object_type_extension(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#130 + # source://graphql//lib/graphql/language/visitor.rb#109 def on_object_type_extension_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_operation_definition(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#205 + # source://graphql//lib/graphql/language/visitor.rb#184 def on_operation_definition_children(new_node); end - # source://graphql//lib/graphql/language/visitor.rb#117 + # source://graphql//lib/graphql/language/visitor.rb#96 def on_operation_definition_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_scalar_type_definition(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#123 + # source://graphql//lib/graphql/language/visitor.rb#102 def on_scalar_type_definition_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_scalar_type_extension(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#123 + # source://graphql//lib/graphql/language/visitor.rb#102 def on_scalar_type_extension_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_schema_definition(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#123 + # source://graphql//lib/graphql/language/visitor.rb#102 def on_schema_definition_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_schema_extension(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#123 + # source://graphql//lib/graphql/language/visitor.rb#102 def on_schema_extension_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_type_name(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#117 + # source://graphql//lib/graphql/language/visitor.rb#96 def on_type_name_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_union_type_definition(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#123 + # source://graphql//lib/graphql/language/visitor.rb#102 def on_union_type_definition_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_union_type_extension(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#123 + # source://graphql//lib/graphql/language/visitor.rb#102 def on_union_type_extension_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_variable_definition(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#117 + # source://graphql//lib/graphql/language/visitor.rb#102 def on_variable_definition_with_modifications(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#95 + # source://graphql//lib/graphql/language/visitor.rb#79 def on_variable_identifier(node, parent); end - # source://graphql//lib/graphql/language/visitor.rb#117 + # source://graphql//lib/graphql/language/visitor.rb#96 def on_variable_identifier_with_modifications(node, parent); end # @return [GraphQL::Language::Nodes::Document] The document with any modifications applied # - # source://graphql//lib/graphql/language/visitor.rb#52 + # source://graphql//lib/graphql/language/visitor.rb#48 def result; end - # Visit `document` and all children, applying hooks as you go + # Visit `document` and all children # # @return [void] # - # source://graphql//lib/graphql/language/visitor.rb#67 + # source://graphql//lib/graphql/language/visitor.rb#52 def visit; end - # source://graphql//lib/graphql/language/visitor.rb#166 + # source://graphql//lib/graphql/language/visitor.rb#145 def visit_directives(new_node); end - # source://graphql//lib/graphql/language/visitor.rb#177 + # source://graphql//lib/graphql/language/visitor.rb#156 def visit_selections(new_node); end private - # source://graphql//lib/graphql/language/visitor.rb#282 + # source://graphql//lib/graphql/language/visitor.rb#261 def apply_modifications(node, parent, new_node_and_new_parent); end - # source://graphql//lib/graphql/language/visitor.rb#309 - def begin_visit(node, parent); end - - # Should global `leave` visitors come first or last? - # - # source://graphql//lib/graphql/language/visitor.rb#315 - def end_visit(node, parent); end - class << self - # If one of the visitors returns SKIP, stop visiting this node - # - # source://graphql//lib/graphql/language/visitor.rb#321 - def apply_hooks(hooks, node, parent); end - # We don't use `alias` here because it breaks `super` # - # source://graphql//lib/graphql/language/visitor.rb#80 + # source://graphql//lib/graphql/language/visitor.rb#65 def make_visit_methods(ast_node_class); end end end @@ -5704,49 +5960,12 @@ end # When this is returned from a visitor method, # Then the `node` passed into the method is removed from `parent`'s children. # -# source://graphql//lib/graphql/language/visitor.rb#43 +# source://graphql//lib/graphql/language/visitor.rb#40 GraphQL::Language::Visitor::DELETE_NODE = T.let(T.unsafe(nil), GraphQL::Language::Visitor::DeleteNode) -# source://graphql//lib/graphql/language/visitor.rb#39 +# source://graphql//lib/graphql/language/visitor.rb#36 class GraphQL::Language::Visitor::DeleteNode; end -# Collect `enter` and `leave` hooks for classes in {GraphQL::Language::Nodes} -# -# Access {NodeVisitor}s via {GraphQL::Language::Visitor#[]} -# -# source://graphql//lib/graphql/language/visitor.rb#331 -class GraphQL::Language::Visitor::NodeVisitor - # @return [NodeVisitor] a new instance of NodeVisitor - # - # source://graphql//lib/graphql/language/visitor.rb#337 - def initialize; end - - # Shorthand to add a hook to the {#enter} array - # - # @param hook [Proc] A hook to add - # - # source://graphql//lib/graphql/language/visitor.rb#344 - def <<(hook); end - - # @return [Array] Hooks to call when entering a node of this type - # - # source://graphql//lib/graphql/language/visitor.rb#333 - def enter; end - - # @return [Array] Hooks to call when leaving a node of this type - # - # source://graphql//lib/graphql/language/visitor.rb#335 - def leave; end -end - -# If any hook returns this value, the {Visitor} stops visiting this -# node right away -# -# @deprecated Use `super` to continue the visit; or don't call it to halt. -# -# source://graphql//lib/graphql/language/visitor.rb#37 -GraphQL::Language::Visitor::SKIP = T.let(T.unsafe(nil), Symbol) - # Raised when a argument is configured with `loads:` and the client provides an `ID`, # but no object is loaded for that ID. # @@ -5756,14 +5975,19 @@ GraphQL::Language::Visitor::SKIP = T.let(T.unsafe(nil), Symbol) class GraphQL::LoadApplicationObjectFailedError < ::GraphQL::ExecutionError # @return [LoadApplicationObjectFailedError] a new instance of LoadApplicationObjectFailedError # - # source://graphql//lib/graphql/load_application_object_failed_error.rb#15 - def initialize(argument:, id:, object:); end + # source://graphql//lib/graphql/load_application_object_failed_error.rb#18 + def initialize(argument:, id:, object:, context:); end # @return [GraphQL::Schema::Argument] the argument definition for the argument that was looked up # # source://graphql//lib/graphql/load_application_object_failed_error.rb#10 def argument; end + # @return [GraphQL::Query::Context] + # + # source://graphql//lib/graphql/load_application_object_failed_error.rb#16 + def context; end + # @return [String] The ID provided by the client # # source://graphql//lib/graphql/load_application_object_failed_error.rb#12 @@ -5775,7 +5999,7 @@ class GraphQL::LoadApplicationObjectFailedError < ::GraphQL::ExecutionError def object; end end -# source://graphql//lib/graphql.rb#70 +# source://graphql//lib/graphql.rb#63 GraphQL::NOT_CONFIGURED = T.let(T.unsafe(nil), Object) # source://graphql//lib/graphql/name_validator.rb#3 @@ -5874,47 +6098,47 @@ class GraphQL::Pagination::Connection # @param default_page_size [Integer, nil] A configured value to determine the result size when neither first or last are given. # @return [Connection] a new instance of Connection # - # source://graphql//lib/graphql/pagination/connection.rb#61 + # source://graphql//lib/graphql/pagination/connection.rb#69 def initialize(items, parent: T.unsafe(nil), field: T.unsafe(nil), context: T.unsafe(nil), first: T.unsafe(nil), after: T.unsafe(nil), max_page_size: T.unsafe(nil), default_page_size: T.unsafe(nil), last: T.unsafe(nil), before: T.unsafe(nil), edge_class: T.unsafe(nil), arguments: T.unsafe(nil)); end # @return [String, nil] the client-provided cursor. `""` is treated as `nil`. # - # source://graphql//lib/graphql/pagination/connection.rb#40 + # source://graphql//lib/graphql/pagination/connection.rb#48 def after; end # Raw access to client-provided values. (`max_page_size` not applied to first or last.) # - # source://graphql//lib/graphql/pagination/connection.rb#28 + # source://graphql//lib/graphql/pagination/connection.rb#36 def after_value; end # Raw access to client-provided values. (`max_page_size` not applied to first or last.) # - # source://graphql//lib/graphql/pagination/connection.rb#28 + # source://graphql//lib/graphql/pagination/connection.rb#36 def after_value=(_arg0); end # @return [Hash Object>] The field arguments from the field that returned this connection # - # source://graphql//lib/graphql/pagination/connection.rb#49 + # source://graphql//lib/graphql/pagination/connection.rb#57 def arguments; end # @return [Hash Object>] The field arguments from the field that returned this connection # - # source://graphql//lib/graphql/pagination/connection.rb#49 + # source://graphql//lib/graphql/pagination/connection.rb#57 def arguments=(_arg0); end # @return [String, nil] the client-provided cursor. `""` is treated as `nil`. # - # source://graphql//lib/graphql/pagination/connection.rb#31 + # source://graphql//lib/graphql/pagination/connection.rb#39 def before; end # Raw access to client-provided values. (`max_page_size` not applied to first or last.) # - # source://graphql//lib/graphql/pagination/connection.rb#28 + # source://graphql//lib/graphql/pagination/connection.rb#36 def before_value; end # Raw access to client-provided values. (`max_page_size` not applied to first or last.) # - # source://graphql//lib/graphql/pagination/connection.rb#28 + # source://graphql//lib/graphql/pagination/connection.rb#36 def before_value=(_arg0); end # @return [GraphQL::Query::Context] @@ -5922,10 +6146,8 @@ class GraphQL::Pagination::Connection # source://graphql//lib/graphql/pagination/connection.rb#22 def context; end - # @return [GraphQL::Query::Context] - # - # source://graphql//lib/graphql/pagination/connection.rb#22 - def context=(_arg0); end + # source://graphql//lib/graphql/pagination/connection.rb#24 + def context=(new_ctx); end # Return a cursor for this item. # @@ -5933,50 +6155,50 @@ class GraphQL::Pagination::Connection # @raise [PaginationImplementationMissingError] # @return [String] # - # source://graphql//lib/graphql/pagination/connection.rb#205 + # source://graphql//lib/graphql/pagination/connection.rb#218 def cursor_for(item); end - # source://graphql//lib/graphql/pagination/connection.rb#110 + # source://graphql//lib/graphql/pagination/connection.rb#123 def default_page_size; end - # source://graphql//lib/graphql/pagination/connection.rb#105 + # source://graphql//lib/graphql/pagination/connection.rb#118 def default_page_size=(new_value); end # @return [Class] A wrapper class for edges of this connection # - # source://graphql//lib/graphql/pagination/connection.rb#161 + # source://graphql//lib/graphql/pagination/connection.rb#174 def edge_class; end # @return [Class] A wrapper class for edges of this connection # - # source://graphql//lib/graphql/pagination/connection.rb#161 + # source://graphql//lib/graphql/pagination/connection.rb#174 def edge_class=(_arg0); end # A dynamic alias for compatibility with {Relay::BaseConnection}. # # @deprecated use {#nodes} instead # - # source://graphql//lib/graphql/pagination/connection.rb#173 + # source://graphql//lib/graphql/pagination/connection.rb#186 def edge_nodes; end # @return [Array] {nodes}, but wrapped with Edge instances # - # source://graphql//lib/graphql/pagination/connection.rb#156 + # source://graphql//lib/graphql/pagination/connection.rb#169 def edges; end # @return [String] The cursor of the last item in {nodes} # - # source://graphql//lib/graphql/pagination/connection.rb#198 + # source://graphql//lib/graphql/pagination/connection.rb#211 def end_cursor; end # @return [GraphQL::Schema::Field] The field this connection was returned by # - # source://graphql//lib/graphql/pagination/connection.rb#164 + # source://graphql//lib/graphql/pagination/connection.rb#177 def field; end # @return [GraphQL::Schema::Field] The field this connection was returned by # - # source://graphql//lib/graphql/pagination/connection.rb#164 + # source://graphql//lib/graphql/pagination/connection.rb#177 def field=(_arg0); end # @return [Integer, nil] A clamped `first` value. @@ -5986,46 +6208,46 @@ class GraphQL::Pagination::Connection # is greater than `max_page_size``, it'll be clamped down to # `max_page_size`. If `default_page_size` is nil, use `max_page_size`. # - # source://graphql//lib/graphql/pagination/connection.rb#130 + # source://graphql//lib/graphql/pagination/connection.rb#143 def first; end # Sets the attribute first # # @param value the value to set the attribute first to. # - # source://graphql//lib/graphql/pagination/connection.rb#122 + # source://graphql//lib/graphql/pagination/connection.rb#135 def first=(_arg0); end # Raw access to client-provided values. (`max_page_size` not applied to first or last.) # - # source://graphql//lib/graphql/pagination/connection.rb#28 + # source://graphql//lib/graphql/pagination/connection.rb#36 def first_value; end # Raw access to client-provided values. (`max_page_size` not applied to first or last.) # - # source://graphql//lib/graphql/pagination/connection.rb#28 + # source://graphql//lib/graphql/pagination/connection.rb#36 def first_value=(_arg0); end # @return [Boolean] # - # source://graphql//lib/graphql/pagination/connection.rb#118 + # source://graphql//lib/graphql/pagination/connection.rb#131 def has_default_page_size_override?; end # @return [Boolean] # - # source://graphql//lib/graphql/pagination/connection.rb#101 + # source://graphql//lib/graphql/pagination/connection.rb#114 def has_max_page_size_override?; end # @raise [PaginationImplementationMissingError] # @return [Boolean] True if there are more items after this page # - # source://graphql//lib/graphql/pagination/connection.rb#183 + # source://graphql//lib/graphql/pagination/connection.rb#196 def has_next_page; end # @raise [PaginationImplementationMissingError] # @return [Boolean] True if there were items before these items # - # source://graphql//lib/graphql/pagination/connection.rb#188 + # source://graphql//lib/graphql/pagination/connection.rb#201 def has_previous_page; end # @return [Object] A list object, from the application. This is the unpaginated value passed into the connection. @@ -6035,51 +6257,51 @@ class GraphQL::Pagination::Connection # @return [Integer, nil] A clamped `last` value. (The underlying instance variable doesn't have limits on it) # - # source://graphql//lib/graphql/pagination/connection.rb#151 + # source://graphql//lib/graphql/pagination/connection.rb#164 def last; end # Sets the attribute last # # @param value the value to set the attribute last to. # - # source://graphql//lib/graphql/pagination/connection.rb#149 + # source://graphql//lib/graphql/pagination/connection.rb#162 def last=(_arg0); end # Raw access to client-provided values. (`max_page_size` not applied to first or last.) # - # source://graphql//lib/graphql/pagination/connection.rb#28 + # source://graphql//lib/graphql/pagination/connection.rb#36 def last_value; end # Raw access to client-provided values. (`max_page_size` not applied to first or last.) # - # source://graphql//lib/graphql/pagination/connection.rb#28 + # source://graphql//lib/graphql/pagination/connection.rb#36 def last_value=(_arg0); end - # source://graphql//lib/graphql/pagination/connection.rb#93 + # source://graphql//lib/graphql/pagination/connection.rb#106 def max_page_size; end - # source://graphql//lib/graphql/pagination/connection.rb#88 + # source://graphql//lib/graphql/pagination/connection.rb#101 def max_page_size=(new_value); end # @raise [PaginationImplementationMissingError] # @return [Array] A slice of {items}, constrained by {@first_value}/{@after_value}/{@last_value}/{@before_value} # - # source://graphql//lib/graphql/pagination/connection.rb#167 + # source://graphql//lib/graphql/pagination/connection.rb#180 def nodes; end # The connection object itself implements `PageInfo` fields # - # source://graphql//lib/graphql/pagination/connection.rb#178 + # source://graphql//lib/graphql/pagination/connection.rb#191 def page_info; end # @return [Object] the object this collection belongs to # - # source://graphql//lib/graphql/pagination/connection.rb#25 + # source://graphql//lib/graphql/pagination/connection.rb#33 def parent; end # @return [Object] the object this collection belongs to # - # source://graphql//lib/graphql/pagination/connection.rb#25 + # source://graphql//lib/graphql/pagination/connection.rb#33 def parent=(_arg0); end # This is called by `Relay::RangeAdd` -- it can be overridden @@ -6088,50 +6310,63 @@ class GraphQL::Pagination::Connection # @param item [Object] An item newly added to `items` # @return [Edge] # - # source://graphql//lib/graphql/pagination/connection.rb#145 + # source://graphql//lib/graphql/pagination/connection.rb#158 def range_add_edge(item); end # @return [String] The cursor of the first item in {nodes} # - # source://graphql//lib/graphql/pagination/connection.rb#193 + # source://graphql//lib/graphql/pagination/connection.rb#206 def start_cursor; end + # @return [Boolean] + # + # source://graphql//lib/graphql/pagination/connection.rb#97 + def was_authorized_by_scope_items?; end + private - # source://graphql//lib/graphql/pagination/connection.rb#225 + # source://graphql//lib/graphql/pagination/connection.rb#248 def decode(cursor); end - # source://graphql//lib/graphql/pagination/connection.rb#229 + # source://graphql//lib/graphql/pagination/connection.rb#224 + def detect_was_authorized_by_scope_items; end + + # source://graphql//lib/graphql/pagination/connection.rb#252 def encode(cursor); end # @param argument [nil, Integer] `first` or `last`, as provided by the client # @param max_page_size [nil, Integer] # @return [nil, Integer] `nil` if the input was `nil`, otherwise a value between `0` and `max_page_size` # - # source://graphql//lib/graphql/pagination/connection.rb#214 + # source://graphql//lib/graphql/pagination/connection.rb#237 def limit_pagination_argument(argument, max_page_size); end end # A wrapper around paginated items. It includes a {cursor} for pagination # and could be extended with custom relationship-level data. # -# source://graphql//lib/graphql/pagination/connection.rb#235 +# source://graphql//lib/graphql/pagination/connection.rb#258 class GraphQL::Pagination::Connection::Edge # @return [Edge] a new instance of Edge # - # source://graphql//lib/graphql/pagination/connection.rb#238 + # source://graphql//lib/graphql/pagination/connection.rb#261 def initialize(node, connection); end - # source://graphql//lib/graphql/pagination/connection.rb#247 + # source://graphql//lib/graphql/pagination/connection.rb#270 def cursor; end # Returns the value of attribute node. # - # source://graphql//lib/graphql/pagination/connection.rb#236 + # source://graphql//lib/graphql/pagination/connection.rb#259 def node; end - # source://graphql//lib/graphql/pagination/connection.rb#243 + # source://graphql//lib/graphql/pagination/connection.rb#266 def parent; end + + # @return [Boolean] + # + # source://graphql//lib/graphql/pagination/connection.rb#274 + def was_authorized_by_scope_items?; end end # source://graphql//lib/graphql/pagination/connection.rb#15 @@ -6202,7 +6437,7 @@ class GraphQL::Pagination::Connections::ImplementationMissingError < ::GraphQL:: # source://graphql//lib/graphql/pagination/mongoid_relation_connection.rb#6 class GraphQL::Pagination::MongoidRelationConnection < ::GraphQL::Pagination::RelationConnection - # source://graphql//lib/graphql/pagination/mongoid_relation_connection.rb#20 + # source://graphql//lib/graphql/pagination/mongoid_relation_connection.rb#19 def null_relation(relation); end # source://graphql//lib/graphql/pagination/mongoid_relation_connection.rb#15 @@ -6361,7 +6596,7 @@ end # A combination of query string and {Schema} instance which can be reduced to a {#result}. # -# source://graphql//lib/graphql/query/null_context.rb#3 +# source://graphql//lib/graphql/query/context/scoped_context.rb#3 class GraphQL::Query include ::GraphQL::Tracing::Traceable extend ::Forwardable @@ -6376,32 +6611,30 @@ class GraphQL::Query # @param root_value [Object] the object used to resolve fields on the root type # @param max_depth [Numeric] the maximum number of nested selections allowed for this query (falls back to schema-level value) # @param max_complexity [Numeric] the maximum field complexity for this query (falls back to schema-level value) - # @param except [<#call(schema_member, context)>] If provided, objects will be hidden from the schema when `.call(schema_member, context)` returns truthy - # @param only [<#call(schema_member, context)>] If provided, objects will be hidden from the schema when `.call(schema_member, context)` returns false # @return [Query] a new instance of Query # - # source://graphql//lib/graphql/query.rb#100 - def initialize(schema, query_string = T.unsafe(nil), query: T.unsafe(nil), document: T.unsafe(nil), context: T.unsafe(nil), variables: T.unsafe(nil), validate: T.unsafe(nil), static_validator: T.unsafe(nil), subscription_topic: T.unsafe(nil), operation_name: T.unsafe(nil), root_value: T.unsafe(nil), max_depth: T.unsafe(nil), max_complexity: T.unsafe(nil), except: T.unsafe(nil), only: T.unsafe(nil), warden: T.unsafe(nil)); end + # source://graphql//lib/graphql/query.rb#98 + def initialize(schema, query_string = T.unsafe(nil), query: T.unsafe(nil), document: T.unsafe(nil), context: T.unsafe(nil), variables: T.unsafe(nil), validate: T.unsafe(nil), static_validator: T.unsafe(nil), subscription_topic: T.unsafe(nil), operation_name: T.unsafe(nil), root_value: T.unsafe(nil), max_depth: T.unsafe(nil), max_complexity: T.unsafe(nil), warden: T.unsafe(nil), use_schema_subset: T.unsafe(nil)); end - # source://graphql//lib/graphql/query.rb#377 + # source://graphql//lib/graphql/query.rb#389 def after_lazy(value, &block); end # Returns the value of attribute analysis_errors. # - # source://graphql//lib/graphql/query.rb#322 + # source://graphql//lib/graphql/query.rb#341 def analysis_errors; end # Sets the attribute analysis_errors # # @param value the value to set the attribute analysis_errors to. # - # source://graphql//lib/graphql/query.rb#322 + # source://graphql//lib/graphql/query.rb#341 def analysis_errors=(_arg0); end # source://forwardable/1.3.3/forwardable.rb#231 def analyzers(*args, **_arg1, &block); end - # source://graphql//lib/graphql/query.rb#275 + # source://graphql//lib/graphql/query.rb#294 def arguments_cache; end # Node-level cache for calculating arguments. Used during execution and query analysis. @@ -6410,7 +6643,7 @@ class GraphQL::Query # @param definition [GraphQL::Schema::Field] # @param parent_object [GraphQL::Schema::Object] # - # source://graphql//lib/graphql/query.rb#271 + # source://graphql//lib/graphql/query.rb#290 def arguments_for(ast_node, definition, parent_object: T.unsafe(nil)); end # source://forwardable/1.3.3/forwardable.rb#231 @@ -6423,7 +6656,7 @@ class GraphQL::Query # @return [GraphQL::Tracing::Trace] # - # source://graphql//lib/graphql/query.rb#185 + # source://graphql//lib/graphql/query.rb#197 def current_trace; end # @return [GraphQL::Language::Nodes::Document] @@ -6433,7 +6666,7 @@ class GraphQL::Query # @return [Boolean] # - # source://graphql//lib/graphql/query.rb#233 + # source://graphql//lib/graphql/query.rb#252 def executed?; end # This contains a few components: @@ -6449,10 +6682,10 @@ class GraphQL::Query # @see operation_fingerprint # @see variables_fingerprint # - # source://graphql//lib/graphql/query.rb#301 + # source://graphql//lib/graphql/query.rb#320 def fingerprint; end - # source://graphql//lib/graphql/query.rb#216 + # source://graphql//lib/graphql/query.rb#235 def fragments; end # source://forwardable/1.3.3/forwardable.rb#231 @@ -6463,7 +6696,7 @@ class GraphQL::Query # @api private # - # source://graphql//lib/graphql/query.rb#373 + # source://graphql//lib/graphql/query.rb#385 def handle_or_reraise(err); end # source://graphql//lib/graphql/query.rb#74 @@ -6471,14 +6704,19 @@ class GraphQL::Query # @return [Boolean] # - # source://graphql//lib/graphql/query.rb#178 + # source://graphql//lib/graphql/query.rb#190 def interpreter?; end + # Returns the value of attribute logger. + # + # source://graphql//lib/graphql/query.rb#401 + def logger; end + # A lookahead for the root selections of this query # # @return [GraphQL::Execution::Lookahead] # - # source://graphql//lib/graphql/query.rb#195 + # source://graphql//lib/graphql/query.rb#207 def lookahead; end # source://forwardable/1.3.3/forwardable.rb#231 @@ -6487,31 +6725,26 @@ class GraphQL::Query # source://forwardable/1.3.3/forwardable.rb#231 def max_depth(*args, **_arg1, &block); end - # @return [void] - # - # source://graphql//lib/graphql/query.rb#358 - def merge_filters(only: T.unsafe(nil), except: T.unsafe(nil)); end - # Returns the value of attribute multiplex. # - # source://graphql//lib/graphql/query.rb#182 + # source://graphql//lib/graphql/query.rb#194 def multiplex; end # Sets the attribute multiplex # # @param value the value to set the attribute multiplex to. # - # source://graphql//lib/graphql/query.rb#182 + # source://graphql//lib/graphql/query.rb#194 def multiplex=(_arg0); end # @return [Boolean] # - # source://graphql//lib/graphql/query.rb#349 + # source://graphql//lib/graphql/query.rb#372 def mutation?; end # @return [String] An opaque hash for identifying this query's given query string and selected operation # - # source://graphql//lib/graphql/query.rb#306 + # source://graphql//lib/graphql/query.rb#325 def operation_fingerprint; end # @return [nil, String] The operation name provided by client or the one inferred from the document. Used to determine which operation to run. @@ -6524,7 +6757,7 @@ class GraphQL::Query # source://graphql//lib/graphql/query.rb#34 def operation_name=(_arg0); end - # source://graphql//lib/graphql/query.rb#220 + # source://graphql//lib/graphql/query.rb#239 def operations; end # source://forwardable/1.3.3/forwardable.rb#231 @@ -6537,12 +6770,12 @@ class GraphQL::Query # @return [Boolean] # - # source://graphql//lib/graphql/query.rb#353 + # source://graphql//lib/graphql/query.rb#376 def query?; end # If a document was provided to `GraphQL::Schema#execute` instead of the raw query string, we will need to get it from the document # - # source://graphql//lib/graphql/query.rb#174 + # source://graphql//lib/graphql/query.rb#186 def query_string; end # Sets the attribute query_string @@ -6557,24 +6790,24 @@ class GraphQL::Query # @return [GraphQL::ObjectType, nil] The runtime type of `value` from {Schema#resolve_type} # @see {#possible_types} to apply filtering from `only` / `except` # - # source://graphql//lib/graphql/query.rb#337 + # source://graphql//lib/graphql/query.rb#360 def resolve_type(abstract_type, value = T.unsafe(nil)); end # Get the result for this query, executing it once # - # @return [Hash] A GraphQL response, with `"data"` and/or `"errors"` keys + # @return [GraphQL::Query::Result] A Hash-like GraphQL response, with `"data"` and/or `"errors"` keys # - # source://graphql//lib/graphql/query.rb#226 + # source://graphql//lib/graphql/query.rb#245 def result; end # @api private # - # source://graphql//lib/graphql/query.rb#214 + # source://graphql//lib/graphql/query.rb#233 def result_values; end # @api private # - # source://graphql//lib/graphql/query.rb#204 + # source://graphql//lib/graphql/query.rb#223 def result_values=(result_hash); end # source://forwardable/1.3.3/forwardable.rb#231 @@ -6596,7 +6829,7 @@ class GraphQL::Query # # @return [String, nil] Returns nil if the query is invalid. # - # source://graphql//lib/graphql/query.rb#283 + # source://graphql//lib/graphql/query.rb#302 def sanitized_query_string(inline_variables: T.unsafe(nil)); end # Returns the value of attribute schema. @@ -6609,7 +6842,7 @@ class GraphQL::Query # # @return [GraphQL::Language::Nodes::OperationDefinition, nil] # - # source://graphql//lib/graphql/query.rb#244 + # source://graphql//lib/graphql/query.rb#263 def selected_operation; end # @return [String, nil] The name of the operation to run (may be inferred) @@ -6617,7 +6850,7 @@ class GraphQL::Query # source://graphql//lib/graphql/query.rb#79 def selected_operation_name; end - # source://graphql//lib/graphql/query.rb#237 + # source://graphql//lib/graphql/query.rb#256 def static_errors; end # @return [GraphQL::StaticValidation::Validator] if present, the query will validate with these rules. @@ -6632,7 +6865,7 @@ class GraphQL::Query # @return [Boolean] # - # source://graphql//lib/graphql/query.rb#368 + # source://graphql//lib/graphql/query.rb#380 def subscription?; end # @return [String, nil] the triggered event, if this query is a subscription update @@ -6642,7 +6875,7 @@ class GraphQL::Query # @return [Boolean] # - # source://graphql//lib/graphql/query.rb#189 + # source://graphql//lib/graphql/query.rb#201 def subscription_update?; end # Returns the value of attribute tracers. @@ -6650,9 +6883,12 @@ class GraphQL::Query # source://graphql//lib/graphql/query.rb#87 def tracers; end + # source://graphql//lib/graphql/query.rb#352 + def types; end + # @return [Boolean] # - # source://graphql//lib/graphql/query.rb#323 + # source://graphql//lib/graphql/query.rb#342 def valid?; end # @return [Boolean] if false, static validation is skipped (execution behavior for invalid queries is undefined) @@ -6665,10 +6901,13 @@ class GraphQL::Query # source://graphql//lib/graphql/query.rb#40 def validate=(new_validate); end + # source://forwardable/1.3.3/forwardable.rb#231 + def validate_timeout_remaining(*args, **_arg1, &block); end + # source://forwardable/1.3.3/forwardable.rb#231 def validation_errors(*args, **_arg1, &block); end - # source://graphql//lib/graphql/query.rb#315 + # source://graphql//lib/graphql/query.rb#334 def validation_pipeline; end # Determine the values for variables of this query, using default values @@ -6678,38 +6917,37 @@ class GraphQL::Query # # @return [GraphQL::Query::Variables] Variables to apply to this query # - # source://graphql//lib/graphql/query.rb#254 + # source://graphql//lib/graphql/query.rb#273 def variables; end # @return [String] An opaque hash for identifying this query's given a variable values (not including defaults) # - # source://graphql//lib/graphql/query.rb#311 + # source://graphql//lib/graphql/query.rb#330 def variables_fingerprint; end - # source://graphql//lib/graphql/query.rb#327 + # source://graphql//lib/graphql/query.rb#346 def warden; end private - # source://graphql//lib/graphql/query.rb#391 + # source://graphql//lib/graphql/query.rb#405 def find_operation(operations, operation_name); end - # source://graphql//lib/graphql/query.rb#401 + # source://graphql//lib/graphql/query.rb#415 def prepare_ast; end # Since the query string is processed at the last possible moment, # any internal values which depend on it should be accessed within this wrapper. # - # source://graphql//lib/graphql/query.rb#465 + # source://graphql//lib/graphql/query.rb#479 def with_prepared_ast; end end # Expose some query-specific info to field resolve functions. # It delegates `[]` to the hash that's passed to `GraphQL::Query#initialize`. # -# source://graphql//lib/graphql/query/context.rb#6 +# source://graphql//lib/graphql/query/context/scoped_context.rb#4 class GraphQL::Query::Context - include ::GraphQL::Query::Context::SharedMethods extend ::Forwardable # Make a new context which delegates key lookup to `values` @@ -6718,45 +6956,63 @@ class GraphQL::Query::Context # @param values [Hash] A hash of arbitrary values which will be accessible at query-time # @return [Context] a new instance of Context # - # source://graphql//lib/graphql/query/context.rb#78 - def initialize(query:, values:, object:, schema: T.unsafe(nil)); end + # source://graphql//lib/graphql/query/context.rb#49 + def initialize(query:, values:, schema: T.unsafe(nil)); end # Lookup `key` from the hash passed to {Schema#execute} as `context:` # - # source://graphql//lib/graphql/query/context.rb#220 + # source://graphql//lib/graphql/query/context.rb#96 def [](key); end # Reassign `key` to the hash passed to {Schema#execute} as `context:` # - # source://graphql//lib/graphql/query/context.rb#209 + # source://graphql//lib/graphql/query/context.rb#81 def []=(key, value); end - # source://graphql//lib/graphql/query/context.rb#239 + # Add error at query-level. + # + # @param error [GraphQL::ExecutionError] an execution error + # @return [void] + # + # source://graphql//lib/graphql/query/context.rb#124 + def add_error(error); end + + # @example Print the GraphQL backtrace during field resolution + # puts ctx.backtrace + # @return [GraphQL::Backtrace] The backtrace for this point in query execution + # + # source://graphql//lib/graphql/query/context.rb#136 + def backtrace; end + + # source://graphql//lib/graphql/query/context.rb#144 def current_path; end - # source://graphql//lib/graphql/query/context.rb#196 + # source://graphql//lib/graphql/query/context.rb#68 def dataloader; end - # source://graphql//lib/graphql/query/context.rb#253 + # source://graphql//lib/graphql/query/context.rb#158 def delete(key); end - # source://graphql//lib/graphql/query/context.rb#281 + # source://graphql//lib/graphql/query/context.rb#186 def dig(key, *other_keys); end # @return [Array] errors returned during execution # - # source://graphql//lib/graphql/query/context.rb#64 + # source://graphql//lib/graphql/query/context.rb#35 def errors; end - # source://graphql//lib/graphql/query/context.rb#263 + # source://graphql//lib/graphql/query/context.rb#140 + def execution_errors; end + + # source://graphql//lib/graphql/query/context.rb#168 def fetch(key, default = T.unsafe(nil)); end - # source://graphql//lib/graphql/query/context.rb#336 + # source://graphql//lib/graphql/query/context.rb#245 def inspect; end # @api private # - # source://graphql//lib/graphql/query/context.rb#201 + # source://graphql//lib/graphql/query/context.rb#73 def interpreter=(_arg0); end # source://forwardable/1.3.3/forwardable.rb#231 @@ -6764,123 +7020,163 @@ class GraphQL::Query::Context # @return [Boolean] # - # source://graphql//lib/graphql/query/context.rb#308 + # source://graphql//lib/graphql/query/context.rb#213 def key?(key); end + # source://graphql//lib/graphql/query/context.rb#241 + def logger; end + # Get an isolated hash for `ns`. Doesn't affect user-provided storage. # # @param ns [Object] a usage-specific namespace identifier # @return [Hash] namespaced storage # - # source://graphql//lib/graphql/query/context.rb#323 + # source://graphql//lib/graphql/query/context.rb#228 def namespace(ns); end # @return [Boolean] true if this namespace was accessed before # - # source://graphql//lib/graphql/query/context.rb#332 + # source://graphql//lib/graphql/query/context.rb#237 def namespace?(ns); end # @return [Array] The current position in the result # - # source://graphql//lib/graphql/query/context.rb#73 + # source://graphql//lib/graphql/query/context.rb#44 def path; end # @return [GraphQL::Query] The query whose context this is # - # source://graphql//lib/graphql/query/context.rb#67 + # source://graphql//lib/graphql/query/context.rb#38 def query; end # @return [Hash] A hash that will be added verbatim to the result hash, as `"extensions" => { ... }` # - # source://graphql//lib/graphql/query/context.rb#192 + # source://graphql//lib/graphql/query/context.rb#64 def response_extensions; end # @return [GraphQL::Schema] # - # source://graphql//lib/graphql/query/context.rb#70 + # source://graphql//lib/graphql/query/context.rb#41 def schema; end + # Use this when you need to do a scoped set _inside_ a lazy-loaded (or batch-loaded) + # block of code. + # + # @example using scoped context inside a promise + # scoped_ctx = context.scoped + # SomeBatchLoader.load(...).then do |thing| + # # use a scoped_ctx which was created _before_ dataloading: + # scoped_ctx.set!(:thing, thing) + # end + # @return [Context::Scoped] + # + # source://graphql//lib/graphql/query/context.rb#268 + def scoped; end + # @api private # - # source://graphql//lib/graphql/query/context.rb#207 + # source://graphql//lib/graphql/query/context.rb#79 def scoped_context; end - # source://graphql//lib/graphql/query/context.rb#340 + # source://graphql//lib/graphql/query/context.rb#249 def scoped_merge!(hash); end - # source://graphql//lib/graphql/query/context.rb#344 + # source://graphql//lib/graphql/query/context.rb#253 def scoped_set!(key, value); end - # source://graphql//lib/graphql/query/context.rb#298 + # Return this value to tell the runtime + # to exclude this field from the response altogether + # + # source://graphql//lib/graphql/query/context.rb#117 + def skip; end + + # source://graphql//lib/graphql/query/context.rb#203 def to_h; end - # source://graphql//lib/graphql/query/context.rb#298 + # source://graphql//lib/graphql/query/context.rb#203 def to_hash; end # source://forwardable/1.3.3/forwardable.rb#231 def trace(*args, **_arg1, &block); end + # source://graphql//lib/graphql/query/context.rb#87 + def types; end + # @api private # - # source://graphql//lib/graphql/query/context.rb#204 + # source://graphql//lib/graphql/query/context.rb#76 def value=(_arg0); end # @return [GraphQL::Schema::Warden] # - # source://graphql//lib/graphql/query/context.rb#313 + # source://graphql//lib/graphql/query/context.rb#218 def warden; end # @api private # - # source://graphql//lib/graphql/query/context.rb#318 + # source://graphql//lib/graphql/query/context.rb#223 def warden=(_arg0); end end -# source://graphql//lib/graphql/query/context.rb#38 +# source://graphql//lib/graphql/query/context.rb#10 class GraphQL::Query::Context::ExecutionErrors # @return [ExecutionErrors] a new instance of ExecutionErrors # - # source://graphql//lib/graphql/query/context.rb#39 + # source://graphql//lib/graphql/query/context.rb#11 def initialize(ctx); end - # source://graphql//lib/graphql/query/context.rb#43 + # source://graphql//lib/graphql/query/context.rb#15 def >>(err_or_msg); end - # source://graphql//lib/graphql/query/context.rb#43 + # source://graphql//lib/graphql/query/context.rb#15 def add(err_or_msg); end - # source://graphql//lib/graphql/query/context.rb#43 + # source://graphql//lib/graphql/query/context.rb#15 def push(err_or_msg); end end -# source://graphql//lib/graphql/query/context.rb#215 +# source://graphql//lib/graphql/query/context.rb#91 GraphQL::Query::Context::RUNTIME_METADATA_KEYS = T.let(T.unsafe(nil), Set) -# source://graphql//lib/graphql/query/context.rb#93 +# source://graphql//lib/graphql/query/context.rb#272 +class GraphQL::Query::Context::Scoped + # @return [Scoped] a new instance of Scoped + # + # source://graphql//lib/graphql/query/context.rb#273 + def initialize(scoped_context, path); end + + # source://graphql//lib/graphql/query/context.rb#278 + def merge!(hash); end + + # source://graphql//lib/graphql/query/context.rb#282 + def set!(key, value); end +end + +# source://graphql//lib/graphql/query/context/scoped_context.rb#5 class GraphQL::Query::Context::ScopedContext # @return [ScopedContext] a new instance of ScopedContext # - # source://graphql//lib/graphql/query/context.rb#97 + # source://graphql//lib/graphql/query/context/scoped_context.rb#6 def initialize(query_context); end - # source://graphql//lib/graphql/query/context.rb#137 + # source://graphql//lib/graphql/query/context/scoped_context.rb#46 def [](key); end - # source://graphql//lib/graphql/query/context.rb#146 + # source://graphql//lib/graphql/query/context/scoped_context.rb#55 def current_path; end - # source://graphql//lib/graphql/query/context.rb#150 + # source://graphql//lib/graphql/query/context/scoped_context.rb#59 def dig(key, *other_keys); end # @return [Boolean] # - # source://graphql//lib/graphql/query/context.rb#126 + # source://graphql//lib/graphql/query/context/scoped_context.rb#35 def key?(key); end - # source://graphql//lib/graphql/query/context.rb#115 - def merge!(hash); end + # source://graphql//lib/graphql/query/context/scoped_context.rb#24 + def merge!(hash, at: T.unsafe(nil)); end - # source://graphql//lib/graphql/query/context.rb#103 + # source://graphql//lib/graphql/query/context/scoped_context.rb#12 def merged_context; end private @@ -6888,44 +7184,11 @@ class GraphQL::Query::Context::ScopedContext # Start at the current location, # but look up the tree for previously-assigned scoped values # - # source://graphql//lib/graphql/query/context.rb#168 + # source://graphql//lib/graphql/query/context/scoped_context.rb#77 def each_present_path_ctx; end end -# source://graphql//lib/graphql/query/context.rb#95 -GraphQL::Query::Context::ScopedContext::NO_CONTEXT = T.let(T.unsafe(nil), Hash) - -# source://graphql//lib/graphql/query/context.rb#94 -GraphQL::Query::Context::ScopedContext::NO_PATH = T.let(T.unsafe(nil), Array) - -# source://graphql//lib/graphql/query/context.rb#7 -module GraphQL::Query::Context::SharedMethods - # Add error at query-level. - # - # @param error [GraphQL::ExecutionError] an execution error - # @return [void] - # - # source://graphql//lib/graphql/query/context.rb#17 - def add_error(error); end - - # @example Print the GraphQL backtrace during field resolution - # puts ctx.backtrace - # @return [GraphQL::Backtrace] The backtrace for this point in query execution - # - # source://graphql//lib/graphql/query/context.rb#29 - def backtrace; end - - # source://graphql//lib/graphql/query/context.rb#33 - def execution_errors; end - - # Return this value to tell the runtime - # to exclude this field from the response altogether - # - # source://graphql//lib/graphql/query/context.rb#10 - def skip; end -end - -# source://graphql//lib/graphql/query/context.rb#261 +# source://graphql//lib/graphql/query/context.rb#166 GraphQL::Query::Context::UNSPECIFIED_FETCH_DEFAULT = T.let(T.unsafe(nil), Object) # @api private @@ -6988,13 +7251,14 @@ GraphQL::Query::InputValidationResult::VALID = T.let(T.unsafe(nil), GraphQL::Que # This object can be `ctx` in places where there is no query # -# source://graphql//lib/graphql/query/null_context.rb#5 -class GraphQL::Query::NullContext - extend ::Forwardable +# source://graphql//lib/graphql/query/null_context.rb#6 +class GraphQL::Query::NullContext < ::GraphQL::Query::Context + include ::Singleton + extend ::Singleton::SingletonClassMethods # @return [NullContext] a new instance of NullContext # - # source://graphql//lib/graphql/query/null_context.rb#20 + # source://graphql//lib/graphql/query/null_context.rb#23 def initialize; end # source://forwardable/1.3.3/forwardable.rb#231 @@ -7002,7 +7266,7 @@ class GraphQL::Query::NullContext # Returns the value of attribute dataloader. # - # source://graphql//lib/graphql/query/null_context.rb#17 + # source://graphql//lib/graphql/query/null_context.rb#20 def dataloader; end # source://forwardable/1.3.3/forwardable.rb#231 @@ -7013,7 +7277,7 @@ class GraphQL::Query::NullContext # @return [Boolean] # - # source://graphql//lib/graphql/query/null_context.rb#27 + # source://graphql//lib/graphql/query/null_context.rb#30 def interpreter?; end # source://forwardable/1.3.3/forwardable.rb#231 @@ -7021,61 +7285,39 @@ class GraphQL::Query::NullContext # Returns the value of attribute query. # - # source://graphql//lib/graphql/query/null_context.rb#17 + # source://graphql//lib/graphql/query/null_context.rb#20 def query; end # Returns the value of attribute schema. # - # source://graphql//lib/graphql/query/null_context.rb#17 + # source://graphql//lib/graphql/query/null_context.rb#20 def schema; end + # source://graphql//lib/graphql/query/null_context.rb#34 + def types; end + # Returns the value of attribute warden. # - # source://graphql//lib/graphql/query/null_context.rb#17 + # source://graphql//lib/graphql/query/null_context.rb#20 def warden; end class << self - # source://forwardable/1.3.3/forwardable.rb#231 - def [](*args, **_arg1, &block); end - - # source://forwardable/1.3.3/forwardable.rb#231 - def dataloader(*args, **_arg1, &block); end - - # source://forwardable/1.3.3/forwardable.rb#231 - def dig(*args, **_arg1, &block); end - - # source://forwardable/1.3.3/forwardable.rb#231 - def fetch(*args, **_arg1, &block); end - - # source://graphql//lib/graphql/query/null_context.rb#34 - def instance; end - - # source://forwardable/1.3.3/forwardable.rb#231 - def interpreter?(*args, **_arg1, &block); end - - # source://forwardable/1.3.3/forwardable.rb#231 - def key?(*args, **_arg1, &block); end - - # source://forwardable/1.3.3/forwardable.rb#231 - def query(*args, **_arg1, &block); end - - # source://forwardable/1.3.3/forwardable.rb#231 - def schema(*args, **_arg1, &block); end + private - # source://forwardable/1.3.3/forwardable.rb#231 - def warden(*args, **_arg1, &block); end + def allocate; end + def new(*_arg0); end end end -# source://graphql//lib/graphql/query/null_context.rb#6 +# source://graphql//lib/graphql/query/null_context.rb#9 class GraphQL::Query::NullContext::NullQuery # @yield [value] # - # source://graphql//lib/graphql/query/null_context.rb#7 + # source://graphql//lib/graphql/query/null_context.rb#10 def after_lazy(value); end end -# source://graphql//lib/graphql/query/null_context.rb#12 +# source://graphql//lib/graphql/query/null_context.rb#15 class GraphQL::Query::NullContext::NullSchema < ::GraphQL::Schema; end # source://graphql//lib/graphql/query.rb#17 @@ -7212,6 +7454,11 @@ class GraphQL::Query::ValidationPipeline # source://graphql//lib/graphql/query/validation_pipeline.rb#32 def valid?; end + # @api private + # + # source://graphql//lib/graphql/query/validation_pipeline.rb#17 + def validate_timeout_remaining; end + # @api private # @return [Array] Static validation errors for the query string # @@ -7322,7 +7569,7 @@ class GraphQL::Query::Variables def deep_stringify(val); end end -# source://graphql//lib/graphql/railtie.rb#3 +# source://graphql//lib/graphql/railtie.rb#4 class GraphQL::Railtie < ::Rails::Railtie; end # source://graphql//lib/graphql/relay/range_add.rb#3 @@ -7382,14 +7629,9 @@ class GraphQL::Relay::RangeAdd def parent; end end -# source://graphql//lib/graphql.rb#31 +# source://graphql//lib/graphql.rb#23 class GraphQL::RequiredImplementationMissingError < ::GraphQL::Error; end -# forwards-compat for argument handling -# -# source://graphql//lib/graphql.rb#10 -module GraphQL::Ruby2Keywords; end - # source://graphql//lib/graphql/runtime_type_error.rb#3 class GraphQL::RuntimeTypeError < ::GraphQL::Error; end @@ -7408,10 +7650,6 @@ class GraphQL::RuntimeTypeError < ::GraphQL::Error; end # Schemas can restrict large incoming queries with `max_depth` and `max_complexity` configurations. # (These configurations can be overridden by specific calls to {Schema#execute}) # -# Schemas can specify how queries should be executed against them. -# `query_execution_strategy`, `mutation_execution_strategy` and `subscription_execution_strategy` -# each apply to corresponding root types. -# # @example defining a schema # class MySchema < GraphQL::Schema # query QueryType @@ -7428,7 +7666,7 @@ class GraphQL::Schema class << self # @api private # - # source://graphql//lib/graphql/schema.rb#1149 + # source://graphql//lib/graphql/schema.rb#1367 def add_subscription_extension_if_necessary; end # Return a lazy if any of `maybe_lazies` are lazy, @@ -7437,7 +7675,7 @@ class GraphQL::Schema # @api private # @param maybe_lazies [Array] # - # source://graphql//lib/graphql/schema.rb#1208 + # source://graphql//lib/graphql/schema.rb#1426 def after_any_lazies(maybe_lazies); end # Call the given block at the right time, either: @@ -7446,17 +7684,17 @@ class GraphQL::Schema # # @api private # - # source://graphql//lib/graphql/schema.rb#1168 + # source://graphql//lib/graphql/schema.rb#1386 def after_lazy(value, &block); end - # source://graphql//lib/graphql/schema.rb#694 + # source://graphql//lib/graphql/schema.rb#793 def analysis_engine; end # Sets the attribute analysis_engine # # @param value the value to set the attribute analysis_engine to. # - # source://graphql//lib/graphql/schema.rb#692 + # source://graphql//lib/graphql/schema.rb#791 def analysis_engine=(_arg0); end # Return the Hash response of {Introspection::INTROSPECTION_QUERY}. @@ -7471,65 +7709,73 @@ class GraphQL::Schema # @param include_is_one_of [Boolean] If true, `isOneOf: true|false` will be included with input objects # @return [Hash] GraphQL result # - # source://graphql//lib/graphql/schema.rb#225 - def as_json(only: T.unsafe(nil), except: T.unsafe(nil), context: T.unsafe(nil), include_deprecated_args: T.unsafe(nil), include_schema_description: T.unsafe(nil), include_is_repeatable: T.unsafe(nil), include_specified_by_url: T.unsafe(nil), include_is_one_of: T.unsafe(nil)); end + # source://graphql//lib/graphql/schema.rb#276 + def as_json(context: T.unsafe(nil), include_deprecated_args: T.unsafe(nil), include_schema_description: T.unsafe(nil), include_is_repeatable: T.unsafe(nil), include_specified_by_url: T.unsafe(nil), include_is_one_of: T.unsafe(nil)); end + + # source://graphql//lib/graphql/schema.rb#212 + def build_trace_mode(mode); end # @return [GraphQL::Pagination::Connections] if installed # - # source://graphql//lib/graphql/schema.rb#367 + # source://graphql//lib/graphql/schema.rb#411 def connections; end # @api private # - # source://graphql//lib/graphql/schema.rb#364 + # source://graphql//lib/graphql/schema.rb#408 def connections=(_arg0); end - # source://graphql//lib/graphql/schema.rb#798 + # source://graphql//lib/graphql/schema.rb#967 def context_class(new_context_class = T.unsafe(nil)); end - # source://graphql//lib/graphql/schema.rb#592 + # source://graphql//lib/graphql/schema.rb#831 + def count_introspection_fields; end + + # source://graphql//lib/graphql/schema.rb#651 def cursor_encoder(new_encoder = T.unsafe(nil)); end # @api private # @see GraphQL::Dataloader # - # source://graphql//lib/graphql/schema.rb#509 + # source://graphql//lib/graphql/schema.rb#575 def dataloader_class; end # Sets the attribute dataloader_class # # @param value the value to set the attribute dataloader_class to. # - # source://graphql//lib/graphql/schema.rb#513 + # source://graphql//lib/graphql/schema.rb#579 def dataloader_class=(_arg0); end - # source://graphql//lib/graphql/schema.rb#790 + # source://graphql//lib/graphql/schema.rb#939 def default_analysis_engine; end - # source://graphql//lib/graphql/schema.rb#991 + # source://graphql//lib/graphql/schema.rb#1177 def default_directives; end - # source://graphql//lib/graphql/schema.rb#782 + # source://graphql//lib/graphql/schema.rb#931 def default_execution_strategy; end - # source://graphql//lib/graphql/schema.rb#271 - def default_filter; end + # source://graphql//lib/graphql/schema.rb#947 + def default_logger(new_default_logger = T.unsafe(nil)); end - # source://graphql//lib/graphql/schema.rb#275 - def default_mask(new_mask = T.unsafe(nil)); end - - # source://graphql//lib/graphql/schema.rb#599 + # source://graphql//lib/graphql/schema.rb#658 def default_max_page_size(new_default_max_page_size = T.unsafe(nil)); end - # source://graphql//lib/graphql/schema.rb#607 + # source://graphql//lib/graphql/schema.rb#677 def default_page_size(new_default_page_size = T.unsafe(nil)); end - # source://graphql//lib/graphql/schema.rb#134 + # @param new_mode [Symbol] If configured, this will be used when `context: { trace_mode: ... }` isn't set. + # + # source://graphql//lib/graphql/schema.rb#147 + def default_trace_mode(new_mode = T.unsafe(nil)); end + + # source://graphql//lib/graphql/schema.rb#133 def deprecated_graphql_definition; end # @return [String, nil] # - # source://graphql//lib/graphql/schema.rb#253 + # source://graphql//lib/graphql/schema.rb#302 def description(new_description = T.unsafe(nil)); end # Attach a single directive to this schema @@ -7537,62 +7783,68 @@ class GraphQL::Schema # @param new_directive [Class] # @return void # - # source://graphql//lib/graphql/schema.rb#987 + # source://graphql//lib/graphql/schema.rb#1173 def directive(new_directive); end # Add several directives at once # # @param new_directives [Class] # - # source://graphql//lib/graphql/schema.rb#976 + # source://graphql//lib/graphql/schema.rb#1157 def directives(*new_directives); end - # source://graphql//lib/graphql/schema.rb#730 + # source://graphql//lib/graphql/schema.rb#839 def disable_introspection_entry_points; end # @return [Boolean] # - # source://graphql//lib/graphql/schema.rb#748 + # source://graphql//lib/graphql/schema.rb#857 def disable_introspection_entry_points?; end - # source://graphql//lib/graphql/schema.rb#736 + # source://graphql//lib/graphql/schema.rb#845 def disable_schema_introspection_entry_point; end # @return [Boolean] # - # source://graphql//lib/graphql/schema.rb#756 + # source://graphql//lib/graphql/schema.rb#865 def disable_schema_introspection_entry_point?; end - # source://graphql//lib/graphql/schema.rb#742 + # source://graphql//lib/graphql/schema.rb#851 def disable_type_introspection_entry_point; end # @return [Boolean] # - # source://graphql//lib/graphql/schema.rb#764 + # source://graphql//lib/graphql/schema.rb#873 def disable_type_introspection_entry_point?; end - # source://graphql//lib/graphql/schema.rb#708 + # source://graphql//lib/graphql/schema.rb#807 def error_bubbling(new_error_bubbling = T.unsafe(nil)); end # Sets the attribute error_bubbling # # @param value the value to set the attribute error_bubbling to. # - # source://graphql//lib/graphql/schema.rb#716 + # source://graphql//lib/graphql/schema.rb#816 def error_bubbling=(_arg0); end - # source://graphql//lib/graphql/schema.rb#820 + # source://graphql//lib/graphql/schema.rb#989 def error_handlers; end # Execute a query on itself. # - # @return [Hash] query result, ready to be serialized as JSON + # @return [GraphQL::Query::Result] query result, ready to be serialized as JSON # @see {Query#initialize} for arguments. # - # source://graphql//lib/graphql/schema.rb#1097 + # source://graphql//lib/graphql/schema.rb#1315 def execute(query_str = T.unsafe(nil), **kwargs); end - # source://graphql//lib/graphql/schema.rb#263 + # @param new_extra_types [Module] Type definitions to include in printing and introspection, even though they aren't referenced in the schema + # @return [Array] Type definitions added to this schema + # + # source://graphql//lib/graphql/schema.rb#883 + def extra_types(*new_extra_types); end + + # source://graphql//lib/graphql/schema.rb#312 def find(path); end # Create schema from an IDL schema or file containing an IDL definition. @@ -7603,7 +7855,7 @@ class GraphQL::Schema # @param using [Hash] Plugins to attach to the created schema with `use(key, value)` # @return [Class] the schema described by `document` # - # source://graphql//lib/graphql/schema.rb#113 + # source://graphql//lib/graphql/schema.rb#112 def from_definition(definition_or_path, default_resolve: T.unsafe(nil), parser: T.unsafe(nil), using: T.unsafe(nil)); end # Create schema with the result of an introspection query. @@ -7611,91 +7863,112 @@ class GraphQL::Schema # @param introspection_result [Hash] A response from {GraphQL::Introspection::INTROSPECTION_QUERY} # @return [Class] the schema described by `input` # - # source://graphql//lib/graphql/schema.rb#103 + # source://graphql//lib/graphql/schema.rb#102 def from_introspection(introspection_result); end - # source://graphql//lib/graphql/schema.rb#547 + # source://graphql//lib/graphql/schema.rb#606 def get_field(type_or_name, field_name, context = T.unsafe(nil)); end - # source://graphql//lib/graphql/schema.rb#570 + # source://graphql//lib/graphql/schema.rb#629 def get_fields(type, context = T.unsafe(nil)); end # @param type_name [String] # @return [Module, nil] A type, or nil if there's no type called `type_name` # - # source://graphql//lib/graphql/schema.rb#332 + # source://graphql//lib/graphql/schema.rb#367 def get_type(type_name, context = T.unsafe(nil)); end # @api private # - # source://graphql//lib/graphql/schema.rb#829 + # source://graphql//lib/graphql/schema.rb#998 def handle_or_reraise(context, err); end + # @return [Boolean] Does this schema have _any_ definition for a type named `type_name`, regardless of visibility? + # + # source://graphql//lib/graphql/schema.rb#403 + def has_defined_type?(type_name); end + # @raise [GraphQL::RequiredImplementationMissingError] # - # source://graphql//lib/graphql/schema.rb#893 + # source://graphql//lib/graphql/schema.rb#1064 def id_from_object(object, type, ctx); end - # source://graphql//lib/graphql/schema.rb#881 + # source://graphql//lib/graphql/schema.rb#1046 def inherited(child_class); end - # source://graphql//lib/graphql/schema.rb#970 + # source://graphql//lib/graphql/schema.rb#1145 def instrument(instrument_step, instrumenter, options = T.unsafe(nil)); end - # source://graphql//lib/graphql/schema.rb#1141 + # source://graphql//lib/graphql/schema.rb#1359 def instrumenters; end # Sets the attribute interpreter # # @param value the value to set the attribute interpreter to. # - # source://graphql//lib/graphql/schema.rb#706 + # source://graphql//lib/graphql/schema.rb#805 def interpreter=(_arg0); end # @return [Boolean] # - # source://graphql//lib/graphql/schema.rb#702 + # source://graphql//lib/graphql/schema.rb#801 def interpreter?; end - # source://graphql//lib/graphql/schema.rb#574 + # source://graphql//lib/graphql/schema.rb#633 def introspection(new_introspection_namespace = T.unsafe(nil)); end - # source://graphql//lib/graphql/schema.rb#584 + # source://graphql//lib/graphql/schema.rb#643 def introspection_system; end # @return [Boolean] True if this object should be lazily resolved # - # source://graphql//lib/graphql/schema.rb#1200 + # source://graphql//lib/graphql/schema.rb#1418 def lazy?(obj); end # @return [Symbol, nil] The method name to lazily resolve `obj`, or nil if `obj`'s class wasn't registered with {#lazy_resolve}. # - # source://graphql//lib/graphql/schema.rb#1195 + # source://graphql//lib/graphql/schema.rb#1413 def lazy_method_name(obj); end - # source://graphql//lib/graphql/schema.rb#966 + # source://graphql//lib/graphql/schema.rb#1141 def lazy_resolve(lazy_class, value_method); end - # source://graphql//lib/graphql/schema.rb#682 - def max_complexity(max_complexity = T.unsafe(nil)); end + # Called when a type is needed by name at runtime + # + # source://graphql//lib/graphql/schema.rb#1082 + def load_type(type_name, ctx); end + + # source://graphql//lib/graphql/schema.rb#772 + def max_complexity(max_complexity = T.unsafe(nil), count_introspection_fields: T.unsafe(nil)); end # Sets the attribute max_complexity # # @param value the value to set the attribute max_complexity to. # - # source://graphql//lib/graphql/schema.rb#680 + # source://graphql//lib/graphql/schema.rb#770 def max_complexity=(_arg0); end - # source://graphql//lib/graphql/schema.rb#720 - def max_depth(new_max_depth = T.unsafe(nil)); end + # source://graphql//lib/graphql/schema.rb#783 + def max_complexity_count_introspection_fields; end + + # source://graphql//lib/graphql/schema.rb#820 + def max_depth(new_max_depth = T.unsafe(nil), count_introspection_fields: T.unsafe(nil)); end # Sets the attribute max_depth # # @param value the value to set the attribute max_depth to. # - # source://graphql//lib/graphql/schema.rb#718 + # source://graphql//lib/graphql/schema.rb#818 def max_depth=(_arg0); end + # A limit on the number of tokens to accept on incoming query strings. + # Use this to prevent parsing maliciously-large query strings. + # + # @return [nil, Integer] + # + # source://graphql//lib/graphql/schema.rb#669 + def max_query_string_tokens(new_max_tokens = T.unsafe(nil)); end + # Execute several queries on itself, concurrently. # # @example Run several queries at once @@ -7711,48 +7984,53 @@ class GraphQL::Schema # } # @param queries [Array] Keyword arguments for each query # @param context [Hash] Multiplex-level context - # @return [Array] One result for each query in the input + # @return [Array] One result for each query in the input # @see {Query#initialize} for query keyword arguments # @see {Execution::Multiplex#run_all} for multiplex keyword arguments # - # source://graphql//lib/graphql/schema.rb#1137 + # source://graphql//lib/graphql/schema.rb#1355 def multiplex(queries, **kwargs); end - # source://graphql//lib/graphql/schema.rb#1078 + # source://graphql//lib/graphql/schema.rb#1296 def multiplex_analyzer(new_analyzer); end - # source://graphql//lib/graphql/schema.rb#1082 + # source://graphql//lib/graphql/schema.rb#1300 def multiplex_analyzers; end - # source://graphql//lib/graphql/schema.rb#400 + # source://graphql//lib/graphql/schema.rb#444 def mutation(new_mutation_object = T.unsafe(nil)); end - # source://graphql//lib/graphql/schema.rb#623 - def mutation_execution_strategy(new_mutation_execution_strategy = T.unsafe(nil)); end + # source://graphql//lib/graphql/schema.rb#697 + def mutation_execution_strategy(new_mutation_execution_strategy = T.unsafe(nil), deprecation_warning: T.unsafe(nil)); end # @return [Boolean] # - # source://graphql//lib/graphql/schema.rb#382 + # source://graphql//lib/graphql/schema.rb#426 def new_connections?; end # Create a trace instance which will include the trace modules specified for the optional mode. # + # If no `mode:` is given, then {default_trace_mode} will be used. + # # @param mode [Symbol] Trace modules for this trade mode will be included # @param options [Hash] Keywords that will be passed to the tracing class during `#initialize` # @return [Tracing::Trace] # - # source://graphql//lib/graphql/schema.rb#1052 + # source://graphql//lib/graphql/schema.rb#1263 def new_trace(mode: T.unsafe(nil), **options); end # @raise [GraphQL::RequiredImplementationMissingError] # - # source://graphql//lib/graphql/schema.rb#889 + # source://graphql//lib/graphql/schema.rb#1060 def object_from_id(node_id, ctx); end - # source://graphql//lib/graphql/schema.rb#772 + # source://graphql//lib/graphql/schema.rb#901 def orphan_types(*new_orphan_types); end - # source://graphql//lib/graphql/schema.rb#194 + # source://graphql//lib/graphql/schema.rb#203 + def own_trace_modes; end + + # source://graphql//lib/graphql/schema.rb#245 def own_trace_modules; end # A function to call when {#execute} receives an invalid query string @@ -7763,102 +8041,115 @@ class GraphQL::Schema # @param ctx [GraphQL::Query::Context] The context for the query where the error occurred # @return void # - # source://graphql//lib/graphql/schema.rb#962 + # source://graphql//lib/graphql/schema.rb#1137 def parse_error(parse_err, ctx); end - # source://graphql//lib/graphql/schema.rb#298 + # source://graphql//lib/graphql/schema.rb#333 def plugins; end # @param type [Module] The type definition whose possible types you want to see # @return [Hash] All possible types, if no `type` is given. # @return [Array] Possible types for `type`, if it's given. # - # source://graphql//lib/graphql/schema.rb#463 + # source://graphql//lib/graphql/schema.rb#529 def possible_types(type = T.unsafe(nil), context = T.unsafe(nil)); end - # source://graphql//lib/graphql/schema.rb#386 + # source://graphql//lib/graphql/schema.rb#430 def query(new_query_object = T.unsafe(nil)); end - # source://graphql//lib/graphql/schema.rb#1070 + # source://graphql//lib/graphql/schema.rb#1288 def query_analyzer(new_analyzer); end - # source://graphql//lib/graphql/schema.rb#1074 + # source://graphql//lib/graphql/schema.rb#1292 def query_analyzers; end - # source://graphql//lib/graphql/schema.rb#615 - def query_execution_strategy(new_query_execution_strategy = T.unsafe(nil)); end + # source://graphql//lib/graphql/schema.rb#750 + def query_class(new_query_class = T.unsafe(nil)); end - # source://graphql//lib/graphql/schema.rb#1160 + # source://graphql//lib/graphql/schema.rb#685 + def query_execution_strategy(new_query_execution_strategy = T.unsafe(nil), deprecation_warning: T.unsafe(nil)); end + + # source://graphql//lib/graphql/schema.rb#1378 def query_stack_error(query, err); end - # source://graphql//lib/graphql/schema.rb#515 + # source://graphql//lib/graphql/schema.rb#581 def references_to(to_type = T.unsafe(nil), from: T.unsafe(nil)); end - # source://graphql//lib/graphql/schema.rb#806 + # source://graphql//lib/graphql/schema.rb#975 def rescue_from(*err_classes, &handler_block); end - # source://graphql//lib/graphql/schema.rb#872 + # @raise [GraphQL::RequiredImplementationMissingError] + # + # source://graphql//lib/graphql/schema.rb#1041 def resolve_type(type, obj, ctx); end # @return [GraphQL::ObjectType, nil] # @see [GraphQL::Schema::Warden] Restricted access to root types # - # source://graphql//lib/graphql/schema.rb#431 + # source://graphql//lib/graphql/schema.rb#475 def root_type_for_operation(operation); end - # source://graphql//lib/graphql/schema.rb#444 + # source://graphql//lib/graphql/schema.rb#488 def root_types; end - # source://graphql//lib/graphql/schema.rb#1086 + # source://graphql//lib/graphql/schema.rb#1304 def sanitized_printer(new_sanitized_printer = T.unsafe(nil)); end - # source://graphql//lib/graphql/schema.rb#901 + # source://graphql//lib/graphql/schema.rb#1072 def schema_directive(dir_class, **options); end - # source://graphql//lib/graphql/schema.rb#906 + # source://graphql//lib/graphql/schema.rb#1077 def schema_directives; end - # source://graphql//lib/graphql/schema.rb#285 + # source://graphql//lib/graphql/schema.rb#320 def static_validator; end - # source://graphql//lib/graphql/schema.rb#414 + # source://graphql//lib/graphql/schema.rb#458 def subscription(new_subscription_object = T.unsafe(nil)); end - # source://graphql//lib/graphql/schema.rb#631 - def subscription_execution_strategy(new_subscription_execution_strategy = T.unsafe(nil)); end + # source://graphql//lib/graphql/schema.rb#709 + def subscription_execution_strategy(new_subscription_execution_strategy = T.unsafe(nil), deprecation_warning: T.unsafe(nil)); end # @return [GraphQL::Subscriptions] # - # source://graphql//lib/graphql/schema.rb#139 + # source://graphql//lib/graphql/schema.rb#138 def subscriptions(inherited: T.unsafe(nil)); end - # source://graphql//lib/graphql/schema.rb#143 + # source://graphql//lib/graphql/schema.rb#142 def subscriptions=(new_implementation); end + # source://graphql//lib/graphql/schema.rb#504 + def subset_class; end + + # Sets the attribute subset_class + # + # @param value the value to set the attribute subset_class to. + # + # source://graphql//lib/graphql/schema.rb#514 + def subset_class=(_arg0); end + # Override this method to handle lazy objects in a custom way. # # @api private # @param value [Object] an instance of a class registered with {.lazy_resolve} # @return [Object] A GraphQL-ready (non-lazy) object # - # source://graphql//lib/graphql/schema.rb#1184 + # source://graphql//lib/graphql/schema.rb#1402 def sync_lazy(value); end # Return the GraphQL IDL for the schema # # @param context [Hash] - # @param only [<#call(member, ctx)>] - # @param except [<#call(member, ctx)>] # @return [String] # - # source://graphql//lib/graphql/schema.rb#242 - def to_definition(only: T.unsafe(nil), except: T.unsafe(nil), context: T.unsafe(nil)); end + # source://graphql//lib/graphql/schema.rb#291 + def to_definition(context: T.unsafe(nil)); end # Return the GraphQL::Language::Document IDL AST for the schema # # @return [GraphQL::Language::Document] # - # source://graphql//lib/graphql/schema.rb#248 + # source://graphql//lib/graphql/schema.rb#297 def to_document; end # Returns the JSON response of {Introspection::INTROSPECTION_QUERY}. @@ -7866,37 +8157,43 @@ class GraphQL::Schema # @return [String] # @see {#as_json} # - # source://graphql//lib/graphql/schema.rb#211 + # source://graphql//lib/graphql/schema.rb#262 def to_json(**args); end - # source://graphql//lib/graphql/schema.rb#147 + # source://graphql//lib/graphql/schema.rb#159 def trace_class(new_class = T.unsafe(nil)); end # @return [Class] Return the trace class to use for this mode, looking one up on the superclass if this Schema doesn't have one defined. # - # source://graphql//lib/graphql/schema.rb#158 - def trace_class_for(mode); end + # source://graphql//lib/graphql/schema.rb#174 + def trace_class_for(mode, build: T.unsafe(nil)); end # Configure `trace_class` to be used whenever `context: { trace_mode: mode_name }` is requested. - # `:default` is used when no `trace_mode: ...` is requested. + # {default_trace_mode} is used when no `trace_mode: ...` is requested. + # + # When a `trace_class` is added this way, it will _not_ receive other modules added with `trace_with(...)` + # unless `trace_mode` is explicitly given. (This class will not receive any default trace modules.) + # + # Subclasses of the schema will use `trace_class` as a base class for this mode and those + # subclass also will _not_ receive default tracing modules. # # @param mode_name [Symbol] # @param trace_class [Class] subclass of GraphQL::Tracing::Trace # @return void # - # source://graphql//lib/graphql/schema.rb#188 + # source://graphql//lib/graphql/schema.rb#198 def trace_mode(mode_name, trace_class); end # @return [Array] Modules added for tracing in `trace_mode`, including inherited ones # - # source://graphql//lib/graphql/schema.rb#199 + # source://graphql//lib/graphql/schema.rb#250 def trace_modules_for(trace_mode); end # The options hash for this trace mode # # @return [Hash] # - # source://graphql//lib/graphql/schema.rb#1036 + # source://graphql//lib/graphql/schema.rb#1241 def trace_options_for(mode); end # Mix `trace_mod` into this schema's `Trace` class so that its methods @@ -7907,19 +8204,19 @@ class GraphQL::Schema # @param options [Hash] Keywords that will be passed to the tracing class during `#initialize` # @return [void] # - # source://graphql//lib/graphql/schema.rb#1019 + # source://graphql//lib/graphql/schema.rb#1211 def trace_with(trace_mod, mode: T.unsafe(nil), **options); end - # source://graphql//lib/graphql/schema.rb#1000 - def tracer(new_tracer); end + # source://graphql//lib/graphql/schema.rb#1187 + def tracer(new_tracer, silence_deprecation_warning: T.unsafe(nil)); end - # source://graphql//lib/graphql/schema.rb#1008 + # source://graphql//lib/graphql/schema.rb#1200 def tracers; end - # source://graphql//lib/graphql/schema.rb#945 + # source://graphql//lib/graphql/schema.rb#1120 def type_error(type_error, ctx); end - # source://graphql//lib/graphql/schema.rb#542 + # source://graphql//lib/graphql/schema.rb#602 def type_from_ast(ast_node, context: T.unsafe(nil)); end # Build a map of `{ name => type }` and return it @@ -7927,7 +8224,7 @@ class GraphQL::Schema # @return [Hash Class>] A dictionary of type classes by their GraphQL name # @see get_type Which is more efficient for finding _one type_ by name, because it doesn't merge hashes. # - # source://graphql//lib/graphql/schema.rb#305 + # source://graphql//lib/graphql/schema.rb#340 def types(context = T.unsafe(nil)); end # This hook is called when a field fails an `authorized?` check. @@ -7943,7 +8240,7 @@ class GraphQL::Schema # @param unauthorized_error [GraphQL::UnauthorizedFieldError] # @return [Field] The returned field will be put in the GraphQL response # - # source://graphql//lib/graphql/schema.rb#941 + # source://graphql//lib/graphql/schema.rb#1116 def unauthorized_field(unauthorized_error); end # This hook is called when an object fails an `authorized?` check. @@ -7962,18 +8259,30 @@ class GraphQL::Schema # @param unauthorized_error [GraphQL::UnauthorizedError] # @return [Object] The returned object will be put in the GraphQL response # - # source://graphql//lib/graphql/schema.rb#925 + # source://graphql//lib/graphql/schema.rb#1100 def unauthorized_object(unauthorized_error); end - # source://graphql//lib/graphql/schema.rb#492 + # source://graphql//lib/graphql/schema.rb#558 def union_memberships(type = T.unsafe(nil)); end - # source://graphql//lib/graphql/schema.rb#289 + # source://graphql//lib/graphql/schema.rb#324 def use(plugin, **kwargs); end + # Sets the attribute use_schema_subset + # + # @param value the value to set the attribute use_schema_subset to. + # + # source://graphql//lib/graphql/schema.rb#514 + def use_schema_subset=(_arg0); end + # @return [Boolean] # - # source://graphql//lib/graphql/schema.rb#698 + # source://graphql//lib/graphql/schema.rb#516 + def use_schema_subset?; end + + # @return [Boolean] + # + # source://graphql//lib/graphql/schema.rb#797 def using_ast_analysis?; end # Validate a query string according to this schema. @@ -7981,86 +8290,97 @@ class GraphQL::Schema # @param string_or_document [String, GraphQL::Language::Nodes::Document] # @return [Array] # - # source://graphql//lib/graphql/schema.rb#654 + # source://graphql//lib/graphql/schema.rb#736 def validate(string_or_document, rules: T.unsafe(nil), context: T.unsafe(nil)); end - # source://graphql//lib/graphql/schema.rb#670 + # source://graphql//lib/graphql/schema.rb#760 def validate_max_errors(new_validate_max_errors = T.unsafe(nil)); end # Sets the attribute validate_max_errors # # @param value the value to set the attribute validate_max_errors to. # - # source://graphql//lib/graphql/schema.rb#668 + # source://graphql//lib/graphql/schema.rb#758 def validate_max_errors=(_arg0); end - # source://graphql//lib/graphql/schema.rb#641 + # source://graphql//lib/graphql/schema.rb#723 def validate_timeout(new_validate_timeout = T.unsafe(nil)); end # Sets the attribute validate_timeout # # @param value the value to set the attribute validate_timeout to. # - # source://graphql//lib/graphql/schema.rb#639 + # source://graphql//lib/graphql/schema.rb#721 def validate_timeout=(_arg0); end # @return [Boolean] # - # source://graphql//lib/graphql/schema.rb#897 + # source://graphql//lib/graphql/schema.rb#1068 def visible?(member, ctx); end - # source://graphql//lib/graphql/schema.rb#448 + # source://graphql//lib/graphql/schema.rb#492 def warden_class; end # Sets the attribute warden_class # # @param value the value to set the attribute warden_class to. # - # source://graphql//lib/graphql/schema.rb#458 + # source://graphql//lib/graphql/schema.rb#502 def warden_class=(_arg0); end private + # source://graphql//lib/graphql/schema.rb#1438 + def add_trace_options_for(mode, new_options); end + # @param t [Module, Array] # @return [void] # - # source://graphql//lib/graphql/schema.rb#1222 + # source://graphql//lib/graphql/schema.rb#1446 def add_type_and_traverse(t, root:); end - # source://graphql//lib/graphql/schema.rb#1273 + # This is overridden in subclasses to check the inheritance chain + # + # source://graphql//lib/graphql/schema.rb#1561 + def get_references_to(type_defn); end + + # source://graphql//lib/graphql/schema.rb#1498 def lazy_methods; end - # source://graphql//lib/graphql/schema.rb#1291 + # source://graphql//lib/graphql/schema.rb#1520 def non_introspection_types; end - # source://graphql//lib/graphql/schema.rb#1311 + # source://graphql//lib/graphql/schema.rb#1540 def own_directives; end - # source://graphql//lib/graphql/schema.rb#1315 + # source://graphql//lib/graphql/schema.rb#1544 def own_instrumenters; end - # source://graphql//lib/graphql/schema.rb#1327 + # source://graphql//lib/graphql/schema.rb#1556 def own_multiplex_analyzers; end - # source://graphql//lib/graphql/schema.rb#1299 + # source://graphql//lib/graphql/schema.rb#1528 def own_orphan_types; end - # source://graphql//lib/graphql/schema.rb#1295 + # source://graphql//lib/graphql/schema.rb#1524 def own_plugins; end - # source://graphql//lib/graphql/schema.rb#1303 + # source://graphql//lib/graphql/schema.rb#1532 def own_possible_types; end - # source://graphql//lib/graphql/schema.rb#1323 + # source://graphql//lib/graphql/schema.rb#1552 def own_query_analyzers; end - # source://graphql//lib/graphql/schema.rb#1319 + # source://graphql//lib/graphql/schema.rb#1516 + def own_references_to; end + + # source://graphql//lib/graphql/schema.rb#1548 def own_tracers; end - # source://graphql//lib/graphql/schema.rb#1287 + # source://graphql//lib/graphql/schema.rb#1512 def own_types; end - # source://graphql//lib/graphql/schema.rb#1307 + # source://graphql//lib/graphql/schema.rb#1536 def own_union_memberships; end end end @@ -8107,7 +8427,7 @@ class GraphQL::Schema::Addition # source://graphql//lib/graphql/schema/addition.rb#42 def add_directives_from(owner); end - # source://graphql//lib/graphql/schema/addition.rb#150 + # source://graphql//lib/graphql/schema/addition.rb#152 def add_type(type, owner:, late_types:, path:); end # source://graphql//lib/graphql/schema/addition.rb#50 @@ -8177,7 +8497,7 @@ class GraphQL::Schema::Argument # @api private # - # source://graphql//lib/graphql/schema/argument.rb#235 + # source://graphql//lib/graphql/schema/argument.rb#240 def coerce_into_values(parent_object, values, context, argument_values); end # @param default_value [Object] The value to use when the client doesn't provide one @@ -8229,7 +8549,7 @@ class GraphQL::Schema::Argument # source://graphql//lib/graphql/schema/argument.rb#29 def keyword; end - # source://graphql//lib/graphql/schema/argument.rb#295 + # source://graphql//lib/graphql/schema/argument.rb#301 def load_and_authorize_value(load_method_owner, coerced_value, context); end # @return [Class, Module, nil] If this argument should load an application object, this is the type of object to load @@ -8279,7 +8599,7 @@ class GraphQL::Schema::Argument # @api private # - # source://graphql//lib/graphql/schema/argument.rb#334 + # source://graphql//lib/graphql/schema/argument.rb#354 def validate_default_value; end # @return [Boolean] @@ -8289,18 +8609,21 @@ class GraphQL::Schema::Argument private - # source://graphql//lib/graphql/schema/argument.rb#382 + # source://graphql//lib/graphql/schema/argument.rb#390 + def recursively_prepare_input_object(value, type); end + + # source://graphql//lib/graphql/schema/argument.rb#417 def validate_deprecated_or_optional(null:, deprecation_reason:); end - # source://graphql//lib/graphql/schema/argument.rb#370 + # source://graphql//lib/graphql/schema/argument.rb#405 def validate_input_type(input_type); end end -# source://graphql//lib/graphql/schema/argument.rb#361 +# source://graphql//lib/graphql/schema/argument.rb#381 class GraphQL::Schema::Argument::InvalidDefaultValueError < ::GraphQL::Error # @return [InvalidDefaultValueError] a new instance of InvalidDefaultValueError # - # source://graphql//lib/graphql/schema/argument.rb#362 + # source://graphql//lib/graphql/schema/argument.rb#382 def initialize(argument); end end @@ -8309,17 +8632,17 @@ GraphQL::Schema::BUILT_IN_TYPES = T.let(T.unsafe(nil), Hash) # @api private # -# source://graphql//lib/graphql/schema/base_64_encoder.rb#8 +# source://graphql//lib/graphql/schema/base_64_encoder.rb#6 module GraphQL::Schema::Base64Encoder class << self # @api private # - # source://graphql//lib/graphql/schema/base_64_encoder.rb#13 + # source://graphql//lib/graphql/schema/base_64_encoder.rb#11 def decode(encoded_text, nonce: T.unsafe(nil)); end # @api private # - # source://graphql//lib/graphql/schema/base_64_encoder.rb#9 + # source://graphql//lib/graphql/schema/base_64_encoder.rb#7 def encode(unencoded_text, nonce: T.unsafe(nil)); end end end @@ -8332,17 +8655,17 @@ module GraphQL::Schema::BuildFromDefinition # source://graphql//lib/graphql/schema/build_from_definition.rb#9 def from_definition(schema_superclass, definition_string, parser: T.unsafe(nil), **kwargs); end - # source://graphql//lib/graphql/schema/build_from_definition.rb#13 + # source://graphql//lib/graphql/schema/build_from_definition.rb#16 def from_definition_path(schema_superclass, definition_path, parser: T.unsafe(nil), **kwargs); end - # source://graphql//lib/graphql/schema/build_from_definition.rb#17 + # source://graphql//lib/graphql/schema/build_from_definition.rb#23 def from_document(schema_superclass, document, default_resolve:, using: T.unsafe(nil), relay: T.unsafe(nil)); end end end # @api private # -# source://graphql//lib/graphql/schema/build_from_definition.rb#23 +# source://graphql//lib/graphql/schema/build_from_definition.rb#29 module GraphQL::Schema::BuildFromDefinition::Builder include ::GraphQL::EmptyObjects extend ::GraphQL::EmptyObjects @@ -8350,93 +8673,93 @@ module GraphQL::Schema::BuildFromDefinition::Builder # @api private # - # source://graphql//lib/graphql/schema/build_from_definition.rb#253 + # source://graphql//lib/graphql/schema/build_from_definition.rb#261 def args_to_kwargs(arg_owner, node); end # @api private # @raise [InvalidDocumentError] # - # source://graphql//lib/graphql/schema/build_from_definition.rb#27 + # source://graphql//lib/graphql/schema/build_from_definition.rb#33 def build(schema_superclass, document, default_resolve:, relay:, using: T.unsafe(nil)); end # @api private # - # source://graphql//lib/graphql/schema/build_from_definition.rb#378 + # source://graphql//lib/graphql/schema/build_from_definition.rb#386 def build_arguments(type_class, arguments, type_resolver); end # @api private # - # source://graphql//lib/graphql/schema/build_from_definition.rb#363 + # source://graphql//lib/graphql/schema/build_from_definition.rb#371 def build_default_value(default_value); end # @api private # - # source://graphql//lib/graphql/schema/build_from_definition.rb#192 + # source://graphql//lib/graphql/schema/build_from_definition.rb#200 def build_definition_from_node(definition, type_resolver, default_resolve); end # @api private # - # source://graphql//lib/graphql/schema/build_from_definition.rb#290 + # source://graphql//lib/graphql/schema/build_from_definition.rb#298 def build_deprecation_reason(directives); end # @api private # - # source://graphql//lib/graphql/schema/build_from_definition.rb#402 + # source://graphql//lib/graphql/schema/build_from_definition.rb#410 def build_directive(directive_definition, type_resolver); end # @api private # - # source://graphql//lib/graphql/schema/build_from_definition.rb#223 + # source://graphql//lib/graphql/schema/build_from_definition.rb#231 def build_directives(definition, ast_node, type_resolver); end # @api private # - # source://graphql//lib/graphql/schema/build_from_definition.rb#271 + # source://graphql//lib/graphql/schema/build_from_definition.rb#279 def build_enum_type(enum_type_definition, type_resolver); end # @api private # - # source://graphql//lib/graphql/schema/build_from_definition.rb#431 + # source://graphql//lib/graphql/schema/build_from_definition.rb#439 def build_fields(owner, field_definitions, type_resolver, default_resolve:); end # @api private # - # source://graphql//lib/graphql/schema/build_from_definition.rb#352 + # source://graphql//lib/graphql/schema/build_from_definition.rb#360 def build_input_object_type(input_object_type_definition, type_resolver); end # @api private # - # source://graphql//lib/graphql/schema/build_from_definition.rb#414 + # source://graphql//lib/graphql/schema/build_from_definition.rb#422 def build_interface_type(interface_type_definition, type_resolver); end # @api private # - # source://graphql//lib/graphql/schema/build_from_definition.rb#334 + # source://graphql//lib/graphql/schema/build_from_definition.rb#342 def build_object_type(object_type_definition, type_resolver); end # @api private # - # source://graphql//lib/graphql/schema/build_from_definition.rb#467 + # source://graphql//lib/graphql/schema/build_from_definition.rb#473 def build_resolve_type(lookup_hash, directives, missing_type_handler); end # @api private # - # source://graphql//lib/graphql/schema/build_from_definition.rb#300 + # source://graphql//lib/graphql/schema/build_from_definition.rb#308 def build_scalar_type(scalar_type_definition, type_resolver, default_resolve:); end # @api private # - # source://graphql//lib/graphql/schema/build_from_definition.rb#317 + # source://graphql//lib/graphql/schema/build_from_definition.rb#325 def build_scalar_type_coerce_method(scalar_class, method_name, default_definition_resolve); end # @api private # - # source://graphql//lib/graphql/schema/build_from_definition.rb#323 + # source://graphql//lib/graphql/schema/build_from_definition.rb#331 def build_union_type(union_type_definition, type_resolver); end # @api private # - # source://graphql//lib/graphql/schema/build_from_definition.rb#235 + # source://graphql//lib/graphql/schema/build_from_definition.rb#243 def prepare_directives(ast_node, type_resolver); end # Modify `types`, replacing any late-bound references to built-in types @@ -8447,18 +8770,13 @@ module GraphQL::Schema::BuildFromDefinition::Builder # @api private # @return void # - # source://graphql//lib/graphql/schema/build_from_definition.rb#214 + # source://graphql//lib/graphql/schema/build_from_definition.rb#222 def replace_late_bound_types_with_built_in(types); end - - # @api private - # - # source://graphql//lib/graphql/schema/build_from_definition.rb#491 - def resolve_type_name(type); end end # @api private # -# source://graphql//lib/graphql/schema/build_from_definition.rb#188 +# source://graphql//lib/graphql/schema/build_from_definition.rb#196 GraphQL::Schema::BuildFromDefinition::Builder::NullResolveType = T.let(T.unsafe(nil), Proc) # Wrap a user-provided hash of resolution behavior for easy access at runtime. @@ -8560,7 +8878,7 @@ class GraphQL::Schema::Directive < ::GraphQL::Schema::Member private - # source://graphql//lib/graphql/schema/directive.rb#211 + # source://graphql//lib/graphql/schema/directive.rb#213 def assert_has_location(location); end # source://graphql//lib/graphql/schema/directive.rb#176 @@ -8652,11 +8970,6 @@ GraphQL::Schema::Directive::DEFAULT_DEPRECATION_REASON = T.let(T.unsafe(nil), St # source://graphql//lib/graphql/schema/directive/deprecated.rb#5 class GraphQL::Schema::Directive::Deprecated < ::GraphQL::Schema::Directive extend ::GraphQL::Schema::Member::HasArguments::ClassConfigured::InheritedArguments - - class << self - # source://graphql//lib/graphql/schema/member/has_arguments.rb#68 - def load_reason(value, _context = T.unsafe(nil)); end - end end # source://graphql//lib/graphql/schema/directive.rb#144 @@ -8730,9 +9043,6 @@ class GraphQL::Schema::Directive::Feature < ::GraphQL::Schema::Directive # # source://graphql//lib/graphql/schema/directive/feature.rb#49 def include?(object, arguments, context); end - - # source://graphql//lib/graphql/schema/member/has_arguments.rb#68 - def load_flag(value, _context = T.unsafe(nil)); end end end @@ -8748,11 +9058,6 @@ class GraphQL::Schema::Directive::Flagged < ::GraphQL::Schema::Directive # # source://graphql//lib/graphql/schema/directive/flagged.rb#9 def initialize(target, **options); end - - class << self - # source://graphql//lib/graphql/schema/member/has_arguments.rb#68 - def load_by(value, _context = T.unsafe(nil)); end - end end # source://graphql//lib/graphql/schema/directive/flagged.rb#40 @@ -8787,9 +9092,6 @@ class GraphQL::Schema::Directive::Include < ::GraphQL::Schema::Directive extend ::GraphQL::Schema::Member::HasArguments::ClassConfigured::InheritedArguments class << self - # source://graphql//lib/graphql/schema/member/has_arguments.rb#68 - def load_if(value, _context = T.unsafe(nil)); end - # @return [Boolean] # # source://graphql//lib/graphql/schema/directive/include.rb#19 @@ -8812,6 +9114,19 @@ GraphQL::Schema::Directive::OBJECT = T.let(T.unsafe(nil), Symbol) # source://graphql//lib/graphql/schema/directive/one_of.rb#5 class GraphQL::Schema::Directive::OneOf < ::GraphQL::Schema::Directive extend ::GraphQL::Schema::Member::HasArguments::ClassConfigured::InheritedArguments + + # @return [OneOf] a new instance of OneOf + # + # source://graphql//lib/graphql/schema/directive/one_of.rb#10 + def initialize(*_arg0, **_arg1, &_arg2); end +end + +# source://graphql//lib/graphql/schema/directive/one_of.rb#16 +module GraphQL::Schema::Directive::OneOf::IsOneOf + # @return [Boolean] + # + # source://graphql//lib/graphql/schema/directive/one_of.rb#17 + def one_of?; end end # source://graphql//lib/graphql/schema/directive.rb#130 @@ -8831,9 +9146,6 @@ class GraphQL::Schema::Directive::Skip < ::GraphQL::Schema::Directive extend ::GraphQL::Schema::Member::HasArguments::ClassConfigured::InheritedArguments class << self - # source://graphql//lib/graphql/schema/member/has_arguments.rb#68 - def load_if(value, _context = T.unsafe(nil)); end - # @return [Boolean] # # source://graphql//lib/graphql/schema/directive/skip.rb#19 @@ -8841,6 +9153,11 @@ class GraphQL::Schema::Directive::Skip < ::GraphQL::Schema::Directive end end +# source://graphql//lib/graphql/schema/directive/specified_by.rb#5 +class GraphQL::Schema::Directive::SpecifiedBy < ::GraphQL::Schema::Directive + extend ::GraphQL::Schema::Member::HasArguments::ClassConfigured::InheritedArguments +end + # An example directive to show how you might interact with the runtime. # # This directive takes the return value of the tagged part of the query, @@ -8861,9 +9178,6 @@ class GraphQL::Schema::Directive::Transform < ::GraphQL::Schema::Directive extend ::GraphQL::Schema::Member::HasArguments::ClassConfigured::InheritedArguments class << self - # source://graphql//lib/graphql/schema/member/has_arguments.rb#68 - def load_by(value, _context = T.unsafe(nil)); end - # Implement the Directive API # # source://graphql//lib/graphql/schema/directive/transform.rb#36 @@ -8880,16 +9194,16 @@ GraphQL::Schema::Directive::UNION = T.let(T.unsafe(nil), Symbol) # source://graphql//lib/graphql/schema/directive.rb#148 GraphQL::Schema::Directive::VARIABLE_DEFINITION = T.let(T.unsafe(nil), Symbol) -# source://graphql//lib/graphql/schema.rb#78 +# source://graphql//lib/graphql/schema.rb#77 class GraphQL::Schema::DuplicateNamesError < ::GraphQL::Error # @return [DuplicateNamesError] a new instance of DuplicateNamesError # - # source://graphql//lib/graphql/schema.rb#80 + # source://graphql//lib/graphql/schema.rb#79 def initialize(duplicated_name:, duplicated_definition_1:, duplicated_definition_2:); end # Returns the value of attribute duplicated_name. # - # source://graphql//lib/graphql/schema.rb#79 + # source://graphql//lib/graphql/schema.rb#78 def duplicated_name; end end @@ -8905,7 +9219,7 @@ end # # ONIONS # # PEPPERS # # } -# class PizzaTopping < GraphQL::Enum +# class PizzaTopping < GraphQL::Schema::Enum # value :MUSHROOMS # value :ONIONS # value :PEPPERS @@ -8967,7 +9281,7 @@ class GraphQL::Schema::Enum < ::GraphQL::Schema::Member private - # source://graphql//lib/graphql/schema/enum.rb#175 + # source://graphql//lib/graphql/schema/enum.rb#179 def own_values; end end end @@ -9091,10 +9405,11 @@ class GraphQL::Schema::Field # @param ast_node [Language::Nodes::FieldDefinition, nil] If this schema was parsed from definition, this AST node defined the field # @param method_conflict_warning [Boolean] If false, skip the warning if this field's method conflicts with a built-in method # @param validates [Array] Configurations for validating this field + # @param fallback_value [Object] A fallback value if the method is not defined # @return [Field] a new instance of Field # - # source://graphql//lib/graphql/schema/field.rb#222 - def initialize(type: T.unsafe(nil), name: T.unsafe(nil), owner: T.unsafe(nil), null: T.unsafe(nil), description: T.unsafe(nil), deprecation_reason: T.unsafe(nil), method: T.unsafe(nil), hash_key: T.unsafe(nil), dig: T.unsafe(nil), resolver_method: T.unsafe(nil), connection: T.unsafe(nil), max_page_size: T.unsafe(nil), default_page_size: T.unsafe(nil), scope: T.unsafe(nil), introspection: T.unsafe(nil), camelize: T.unsafe(nil), trace: T.unsafe(nil), complexity: T.unsafe(nil), ast_node: T.unsafe(nil), extras: T.unsafe(nil), extensions: T.unsafe(nil), connection_extension: T.unsafe(nil), resolver_class: T.unsafe(nil), subscription_scope: T.unsafe(nil), relay_node_field: T.unsafe(nil), relay_nodes_field: T.unsafe(nil), method_conflict_warning: T.unsafe(nil), broadcastable: T.unsafe(nil), arguments: T.unsafe(nil), directives: T.unsafe(nil), validates: T.unsafe(nil), fallback_value: T.unsafe(nil), &definition_block); end + # source://graphql//lib/graphql/schema/field.rb#234 + def initialize(type: T.unsafe(nil), name: T.unsafe(nil), owner: T.unsafe(nil), null: T.unsafe(nil), description: T.unsafe(nil), deprecation_reason: T.unsafe(nil), method: T.unsafe(nil), hash_key: T.unsafe(nil), dig: T.unsafe(nil), resolver_method: T.unsafe(nil), connection: T.unsafe(nil), max_page_size: T.unsafe(nil), default_page_size: T.unsafe(nil), scope: T.unsafe(nil), introspection: T.unsafe(nil), camelize: T.unsafe(nil), trace: T.unsafe(nil), complexity: T.unsafe(nil), ast_node: T.unsafe(nil), extras: T.unsafe(nil), extensions: T.unsafe(nil), connection_extension: T.unsafe(nil), resolver_class: T.unsafe(nil), subscription_scope: T.unsafe(nil), relay_node_field: T.unsafe(nil), relay_nodes_field: T.unsafe(nil), method_conflict_warning: T.unsafe(nil), broadcastable: T.unsafe(nil), arguments: T.unsafe(nil), directives: T.unsafe(nil), validates: T.unsafe(nil), fallback_value: T.unsafe(nil), dynamic_introspection: T.unsafe(nil), &definition_block); end # @return [Boolean] # @@ -9106,10 +9421,10 @@ class GraphQL::Schema::Field # @return [Boolean, nil] # @see GraphQL::Subscriptions::BroadcastAnalyzer # - # source://graphql//lib/graphql/schema/field.rb#357 + # source://graphql//lib/graphql/schema/field.rb#372 def broadcastable?; end - # source://graphql//lib/graphql/schema/field.rb#456 + # source://graphql//lib/graphql/schema/field.rb#471 def calculate_complexity(query:, nodes:, child_complexity:); end # source://graphql//lib/graphql/schema/field.rb#521 @@ -9119,7 +9434,7 @@ class GraphQL::Schema::Field # # @return [Boolean] if true, this field will be wrapped with Relay connection behavior # - # source://graphql//lib/graphql/schema/field.rb#130 + # source://graphql//lib/graphql/schema/field.rb#142 def connection?; end # @return [Integer, nil] Applied to connections if {#has_default_page_size?} @@ -9130,7 +9445,7 @@ class GraphQL::Schema::Field # @param text [String] # @return [String] # - # source://graphql//lib/graphql/schema/field.rb#369 + # source://graphql//lib/graphql/schema/field.rb#384 def description(text = T.unsafe(nil)); end # Sets the attribute description @@ -9145,6 +9460,21 @@ class GraphQL::Schema::Field # source://graphql//lib/graphql/schema/field.rb#33 def dig_keys; end + # source://graphql//lib/graphql/schema/field.rb#44 + def directives; end + + # Returns the value of attribute dynamic_introspection. + # + # source://graphql//lib/graphql/schema/field.rb#367 + def dynamic_introspection; end + + # Sets the attribute dynamic_introspection + # + # @param value the value to set the attribute dynamic_introspection to. + # + # source://graphql//lib/graphql/schema/field.rb#367 + def dynamic_introspection=(_arg0); end + # Add `extension` to this field, initialized with `options` if provided. # # @example adding an extension @@ -9155,7 +9485,7 @@ class GraphQL::Schema::Field # @param options [Hash] if provided, given as `options:` when initializing `extension`. # @return [void] # - # source://graphql//lib/graphql/schema/field.rb#421 + # source://graphql//lib/graphql/schema/field.rb#436 def extension(extension_class, options = T.unsafe(nil)); end # Read extension instances from this field, @@ -9171,7 +9501,7 @@ class GraphQL::Schema::Field # @param extensions [Array Hash>>] Add extensions to this field. For hash elements, only the first key/value is used. # @return [Array] extensions to apply to this field # - # source://graphql//lib/graphql/schema/field.rb#396 + # source://graphql//lib/graphql/schema/field.rb#411 def extensions(new_extensions = T.unsafe(nil)); end # Read extras (as symbols) from this field, @@ -9180,7 +9510,7 @@ class GraphQL::Schema::Field # @param new_extras [Array] Add extras to this field # @return [Array] # - # source://graphql//lib/graphql/schema/field.rb#438 + # source://graphql//lib/graphql/schema/field.rb#453 def extras(new_extras = T.unsafe(nil)); end # @param ctx [GraphQL::Query::Context] @@ -9208,12 +9538,12 @@ class GraphQL::Schema::Field # source://graphql//lib/graphql/schema/field.rb#32 def hash_key; end - # source://graphql//lib/graphql/schema/field.rb#71 + # source://graphql//lib/graphql/schema/field.rb#83 def inspect; end # @return [Boolean] Is this field a predefined introspection field? # - # source://graphql//lib/graphql/schema/field.rb#67 + # source://graphql//lib/graphql/schema/field.rb#79 def introspection?; end # @return [Integer, nil] Applied to connections if {#has_max_page_size?} @@ -9223,7 +9553,7 @@ class GraphQL::Schema::Field # @return [Boolean] Should we warn if this field's name conflicts with a built-in method? # - # source://graphql//lib/graphql/schema/field.rb#189 + # source://graphql//lib/graphql/schema/field.rb#201 def method_conflict_warning?; end # @return [String] Method or hash key on the underlying object to look up @@ -9238,7 +9568,7 @@ class GraphQL::Schema::Field # @return [Class, nil] The {Schema::Resolver} this field was derived from, if there is one # - # source://graphql//lib/graphql/schema/field.rb#62 + # source://graphql//lib/graphql/schema/field.rb#74 def mutation; end # @return [String] the GraphQL name for this field, camelized unless `camelize: false` is provided @@ -9248,32 +9578,32 @@ class GraphQL::Schema::Field # @return [Symbol] the original name of the field, passed in by the user # - # source://graphql//lib/graphql/schema/field.rb#59 + # source://graphql//lib/graphql/schema/field.rb#71 def original_name; end # @return [Class] The thing this field was defined on (type, mutation, resolver) # - # source://graphql//lib/graphql/schema/field.rb#45 + # source://graphql//lib/graphql/schema/field.rb#57 def owner; end # @return [Class] The thing this field was defined on (type, mutation, resolver) # - # source://graphql//lib/graphql/schema/field.rb#45 + # source://graphql//lib/graphql/schema/field.rb#57 def owner=(_arg0); end # @return [Class] The GraphQL type this field belongs to. (For fields defined on mutations, it's the payload type) # - # source://graphql//lib/graphql/schema/field.rb#48 + # source://graphql//lib/graphql/schema/field.rb#60 def owner_type; end # @return Boolean # - # source://graphql//lib/graphql/schema/field.rb#184 + # source://graphql//lib/graphql/schema/field.rb#196 def relay_node_field; end # @return Boolean # - # source://graphql//lib/graphql/schema/field.rb#186 + # source://graphql//lib/graphql/schema/field.rb#198 def relay_nodes_field; end # This method is called by the interpreter for each field. @@ -9288,7 +9618,7 @@ class GraphQL::Schema::Field # @return [Class, nil] The {Schema::Resolver} this field was derived from, if there is one # - # source://graphql//lib/graphql/schema/field.rb#62 + # source://graphql//lib/graphql/schema/field.rb#74 def resolver; end # @return [Symbol] The method on the type to look up @@ -9298,24 +9628,24 @@ class GraphQL::Schema::Field # @return [Boolean] if true, the return type's `.scope_items` method will be applied to this field's return value # - # source://graphql//lib/graphql/schema/field.rb#148 + # source://graphql//lib/graphql/schema/field.rb#160 def scoped?; end # @return [String, nil] # - # source://graphql//lib/graphql/schema/field.rb#81 + # source://graphql//lib/graphql/schema/field.rb#93 def subscription_scope; end # Sets the attribute subscription_scope # # @param value the value to set the attribute subscription_scope to. # - # source://graphql//lib/graphql/schema/field.rb#84 + # source://graphql//lib/graphql/schema/field.rb#96 def subscription_scope=(_arg0); end # @return [Boolean] Apply tracing to this field? (Default: skip scalars, this is the override value) # - # source://graphql//lib/graphql/schema/field.rb#78 + # source://graphql//lib/graphql/schema/field.rb#90 def trace; end # source://graphql//lib/graphql/schema/field.rb#580 @@ -9335,6 +9665,9 @@ class GraphQL::Schema::Field private + # source://graphql//lib/graphql/schema/field.rb#883 + def apply_own_complexity_to(child_complexity, query, nodes); end + # source://graphql//lib/graphql/schema/field.rb#773 def assert_satisfactory_implementation(receiver, method_name, ruby_kwargs); end @@ -9360,7 +9693,7 @@ class GraphQL::Schema::Field # end # @return [Class] A {FieldExtension} subclass for implementing pagination behavior. # - # source://graphql//lib/graphql/schema/field.rb#175 + # source://graphql//lib/graphql/schema/field.rb#187 def connection_extension(new_extension_class = T.unsafe(nil)); end # Create a field instance from a list of arguments, keyword arguments, and a block. @@ -9373,10 +9706,10 @@ class GraphQL::Schema::Field # @param resolver [Class] A {GraphQL::Schema::Resolver} class to use for field configuration # @param mutation [Class] A {GraphQL::Schema::Mutation} class to use for field configuration # @param subscription [Class] A {GraphQL::Schema::Subscription} class to use for field configuration - # @return [GraphQL::Schema:Field] an instance of `self + # @return [GraphQL::Schema:Field] an instance of `self` # @see {.initialize} for other options # - # source://graphql//lib/graphql/schema/field.rb#97 + # source://graphql//lib/graphql/schema/field.rb#109 def from_options(name = T.unsafe(nil), type = T.unsafe(nil), desc = T.unsafe(nil), resolver: T.unsafe(nil), mutation: T.unsafe(nil), subscription: T.unsafe(nil), **kwargs, &block); end end end @@ -9655,6 +9988,78 @@ end # source://graphql//lib/graphql/schema/finder.rb#20 class GraphQL::Schema::Finder::MemberNotFoundError < ::ArgumentError; end +# source://graphql//lib/graphql/schema/has_single_input_argument.rb#5 +module GraphQL::Schema::HasSingleInputArgument + mixes_in_class_methods ::GraphQL::Schema::HasSingleInputArgument::ClassMethods + + # source://graphql//lib/graphql/schema/has_single_input_argument.rb#6 + def resolve_with_support(**inputs); end + + private + + # source://graphql//lib/graphql/schema/has_single_input_argument.rb#150 + def authorize_arguments(args, values); end + + class << self + # @private + # + # source://graphql//lib/graphql/schema/has_single_input_argument.rb#42 + def included(base); end + end +end + +# source://graphql//lib/graphql/schema/has_single_input_argument.rb#46 +module GraphQL::Schema::HasSingleInputArgument::ClassMethods + # source://graphql//lib/graphql/schema/has_single_input_argument.rb#74 + def all_field_argument_definitions; end + + # @return [Boolean] + # + # source://graphql//lib/graphql/schema/has_single_input_argument.rb#70 + def any_field_arguments?; end + + # Also apply this argument to the input type: + # + # source://graphql//lib/graphql/schema/has_single_input_argument.rb#79 + def argument(*args, own_argument: T.unsafe(nil), **kwargs, &block); end + + # source://graphql//lib/graphql/schema/has_single_input_argument.rb#47 + def dummy; end + + # source://graphql//lib/graphql/schema/has_single_input_argument.rb#58 + def field_arguments(context = T.unsafe(nil)); end + + # source://graphql//lib/graphql/schema/has_single_input_argument.rb#62 + def get_field_argument(name, context = T.unsafe(nil)); end + + # The base class for generated input object types + # + # @param new_class [Class] The base class to use for generating input object definitions + # @return [Class] The base class for this mutation's generated input object (default is {GraphQL::Schema::InputObject}) + # + # source://graphql//lib/graphql/schema/has_single_input_argument.rb#105 + def input_object_class(new_class = T.unsafe(nil)); end + + # @param new_input_type [Class, nil] If provided, it configures this mutation to accept `new_input_type` instead of generating an input type + # @return [Class] The generated {Schema::InputObject} class for this mutation's `input` + # + # source://graphql//lib/graphql/schema/has_single_input_argument.rb#114 + def input_type(new_input_type = T.unsafe(nil)); end + + # source://graphql//lib/graphql/schema/has_single_input_argument.rb#66 + def own_field_arguments; end + + private + + # Generate the input type for the `input:` argument + # To customize how input objects are generated, override this method + # + # @return [Class] a subclass of {.input_object_class} + # + # source://graphql//lib/graphql/schema/has_single_input_argument.rb#126 + def generate_input_type; end +end + # source://graphql//lib/graphql/schema/input_object.rb#4 class GraphQL::Schema::InputObject < ::GraphQL::Schema::Member include ::GraphQL::Schema::Member::HasArguments::ArgumentObjectLoader @@ -9678,7 +10083,7 @@ class GraphQL::Schema::InputObject < ::GraphQL::Schema::Member # # @param key [Symbol, String] # - # source://graphql//lib/graphql/schema/input_object.rb#103 + # source://graphql//lib/graphql/schema/input_object.rb#104 def [](key); end # source://forwardable/1.3.3/forwardable.rb#231 @@ -9702,7 +10107,7 @@ class GraphQL::Schema::InputObject < ::GraphQL::Schema::Member # @return [Boolean] # - # source://graphql//lib/graphql/schema/input_object.rb#113 + # source://graphql//lib/graphql/schema/input_object.rb#114 def key?(key); end # source://forwardable/1.3.3/forwardable.rb#231 @@ -9711,21 +10116,21 @@ class GraphQL::Schema::InputObject < ::GraphQL::Schema::Member # source://forwardable/1.3.3/forwardable.rb#231 def map(*args, **_arg1, &block); end - # source://graphql//lib/graphql/schema/input_object.rb#47 + # source://graphql//lib/graphql/schema/input_object.rb#48 def prepare; end - # source://graphql//lib/graphql/schema/input_object.rb#39 + # source://graphql//lib/graphql/schema/input_object.rb#40 def to_h; end - # source://graphql//lib/graphql/schema/input_object.rb#43 + # source://graphql//lib/graphql/schema/input_object.rb#44 def to_hash; end # A copy of the Ruby-style hash # - # source://graphql//lib/graphql/schema/input_object.rb#118 + # source://graphql//lib/graphql/schema/input_object.rb#119 def to_kwargs; end - # source://graphql//lib/graphql/schema/input_object.rb#85 + # source://graphql//lib/graphql/schema/input_object.rb#86 def unwrap_value(value); end # source://forwardable/1.3.3/forwardable.rb#231 @@ -9733,39 +10138,39 @@ class GraphQL::Schema::InputObject < ::GraphQL::Schema::Member private - # source://graphql//lib/graphql/schema/input_object.rb#249 + # source://graphql//lib/graphql/schema/input_object.rb#250 def overwrite_argument(key, value); end class << self - # source://graphql//lib/graphql/schema/input_object.rb#123 + # source://graphql//lib/graphql/schema/input_object.rb#124 def argument(*args, **kwargs, &block); end # @return [Boolean] # - # source://graphql//lib/graphql/schema/input_object.rb#58 + # source://graphql//lib/graphql/schema/input_object.rb#59 def authorized?(obj, value, ctx); end - # source://graphql//lib/graphql/schema/input_object.rb#207 + # source://graphql//lib/graphql/schema/input_object.rb#209 def coerce_input(value, ctx); end # It's funny to think of a _result_ of an input object. # This is used for rendering the default value in introspection responses. # - # source://graphql//lib/graphql/schema/input_object.rb#226 + # source://graphql//lib/graphql/schema/input_object.rb#227 def coerce_result(value, ctx); end - # source://graphql//lib/graphql/schema/input_object.rb#143 + # source://graphql//lib/graphql/schema/input_object.rb#145 def kind; end - # source://graphql//lib/graphql/schema/input_object.rb#72 + # source://graphql//lib/graphql/schema/input_object.rb#73 def one_of; end # @return [Boolean] # - # source://graphql//lib/graphql/schema/input_object.rb#81 + # source://graphql//lib/graphql/schema/input_object.rb#82 def one_of?; end - # source://graphql//lib/graphql/schema/input_object.rb#150 + # source://graphql//lib/graphql/schema/input_object.rb#152 def validate_non_null_input(input, ctx, max_errors: T.unsafe(nil)); end end end @@ -9788,7 +10193,7 @@ module GraphQL::Schema::Interface extend ::GraphQL::Schema::Member::HasInterfaces extend ::GraphQL::Schema::Interface::DefinitionMethods - # source://graphql//lib/graphql/schema/interface.rb#98 + # source://graphql//lib/graphql/schema/interface.rb#102 def unwrap; end end @@ -9817,22 +10222,22 @@ module GraphQL::Schema::Interface::DefinitionMethods # Here's the tricky part. Make sure behavior keeps making its way down the inheritance chain. # - # source://graphql//lib/graphql/schema/interface.rb#40 + # source://graphql//lib/graphql/schema/interface.rb#49 def included(child_class); end - # source://graphql//lib/graphql/schema/interface.rb#91 + # source://graphql//lib/graphql/schema/interface.rb#95 def kind; end - # source://graphql//lib/graphql/schema/interface.rb#81 + # source://graphql//lib/graphql/schema/interface.rb#85 def orphan_types(*types); end - # source://graphql//lib/graphql/schema/interface.rb#31 + # source://graphql//lib/graphql/schema/interface.rb#40 def type_membership_class(membership_class = T.unsafe(nil)); end # @return [Boolean] # @see {Schema::Warden} hides interfaces without visible implementations # - # source://graphql//lib/graphql/schema/interface.rb#27 + # source://graphql//lib/graphql/schema/interface.rb#36 def visible?(context); end end @@ -9843,16 +10248,16 @@ class GraphQL::Schema::IntrospectionSystem # source://graphql//lib/graphql/schema/introspection_system.rb#7 def initialize(schema); end - # source://graphql//lib/graphql/schema/introspection_system.rb#57 + # source://graphql//lib/graphql/schema/introspection_system.rb#59 def dynamic_field(name:); end - # source://graphql//lib/graphql/schema/introspection_system.rb#53 + # source://graphql//lib/graphql/schema/introspection_system.rb#55 def dynamic_fields; end - # source://graphql//lib/graphql/schema/introspection_system.rb#49 + # source://graphql//lib/graphql/schema/introspection_system.rb#51 def entry_point(name:); end - # source://graphql//lib/graphql/schema/introspection_system.rb#45 + # source://graphql//lib/graphql/schema/introspection_system.rb#47 def entry_points; end # Returns the value of attribute possible_types. @@ -9867,7 +10272,7 @@ class GraphQL::Schema::IntrospectionSystem # @api private # @return void # - # source://graphql//lib/graphql/schema/introspection_system.rb#67 + # source://graphql//lib/graphql/schema/introspection_system.rb#69 def resolve_late_bindings; end # Returns the value of attribute types. @@ -9879,38 +10284,35 @@ class GraphQL::Schema::IntrospectionSystem # This is probably not 100% robust -- but it has to be good enough to avoid modifying the built-in introspection types # - # source://graphql//lib/graphql/schema/introspection_system.rb#130 + # source://graphql//lib/graphql/schema/introspection_system.rb#120 def dup_type_class(type_class); end - # source://graphql//lib/graphql/schema/introspection_system.rb#112 + # source://graphql//lib/graphql/schema/introspection_system.rb#114 def get_fields_from_class(class_sym:); end - # source://graphql//lib/graphql/schema/introspection_system.rb#104 + # source://graphql//lib/graphql/schema/introspection_system.rb#106 def load_constant(class_name); end - # source://graphql//lib/graphql/schema/introspection_system.rb#88 + # source://graphql//lib/graphql/schema/introspection_system.rb#90 def resolve_late_binding(late_bound_type); end end -# source://graphql//lib/graphql/schema/introspection_system.rb#146 +# source://graphql//lib/graphql/schema/introspection_system.rb#136 class GraphQL::Schema::IntrospectionSystem::PerFieldProxyResolve # @return [PerFieldProxyResolve] a new instance of PerFieldProxyResolve # - # source://graphql//lib/graphql/schema/introspection_system.rb#147 + # source://graphql//lib/graphql/schema/introspection_system.rb#137 def initialize(object_class:, inner_resolve:); end - # source://graphql//lib/graphql/schema/introspection_system.rb#152 + # source://graphql//lib/graphql/schema/introspection_system.rb#142 def call(obj, args, ctx); end end # Error that is raised when [#Schema#from_definition] is passed an invalid schema definition string. # -# source://graphql//lib/graphql/schema.rb#97 +# source://graphql//lib/graphql/schema.rb#96 class GraphQL::Schema::InvalidDocumentError < ::GraphQL::Error; end -# source://graphql//lib/graphql/schema/invalid_type_error.rb#4 -class GraphQL::Schema::InvalidTypeError < ::GraphQL::Error; end - # A stand-in for a type which will be resolved in a given schema, by name. # TODO: support argument types too, make this a public API somehow # @@ -9931,7 +10333,7 @@ class GraphQL::Schema::LateBoundType # @api Private # - # source://graphql//lib/graphql/schema/late_bound_type.rb#28 + # source://graphql//lib/graphql/schema/late_bound_type.rb#32 def inspect; end # @api Private @@ -9942,7 +10344,7 @@ class GraphQL::Schema::LateBoundType # @api Private # @return [Boolean] # - # source://graphql//lib/graphql/schema/late_bound_type.rb#32 + # source://graphql//lib/graphql/schema/late_bound_type.rb#36 def non_null?; end # @api Private @@ -9957,9 +10359,14 @@ class GraphQL::Schema::LateBoundType # @api Private # - # source://graphql//lib/graphql/schema/late_bound_type.rb#28 + # source://graphql//lib/graphql/schema/late_bound_type.rb#32 def to_s; end + # @api Private + # + # source://graphql//lib/graphql/schema/late_bound_type.rb#28 + def to_type_signature; end + # @api Private # # source://graphql//lib/graphql/schema/late_bound_type.rb#16 @@ -10010,7 +10417,7 @@ class GraphQL::Schema::List < ::GraphQL::Schema::Wrapper private # source://graphql//lib/graphql/schema/list.rb#79 - def add_max_errros_reached_message(result); end + def add_max_errors_reached_message(result); end # source://graphql//lib/graphql/schema/list.rb#70 def ensure_array(value); end @@ -10036,29 +10443,29 @@ module GraphQL::Schema::Loader def load(introspection_result); end class << self - # source://graphql//lib/graphql/schema/loader.rb#198 + # source://graphql//lib/graphql/schema/loader.rb#197 def build_arguments(arg_owner, args, type_resolver); end - # source://graphql//lib/graphql/schema/loader.rb#172 + # source://graphql//lib/graphql/schema/loader.rb#173 def build_fields(type_defn, fields, type_resolver); end private - # source://graphql//lib/graphql/schema/loader.rb#159 + # source://graphql//lib/graphql/schema/loader.rb#160 def define_directive(directive, type_resolver); end - # source://graphql//lib/graphql/schema/loader.rb#98 + # source://graphql//lib/graphql/schema/loader.rb#99 def define_type(type, type_resolver); end - # source://graphql//lib/graphql/schema/loader.rb#77 + # source://graphql//lib/graphql/schema/loader.rb#78 def extract_default_value(default_value_str, input_value_ast); end - # source://graphql//lib/graphql/schema/loader.rb#58 + # source://graphql//lib/graphql/schema/loader.rb#59 def resolve_type(types, type); end end end -# source://graphql//lib/graphql/schema/loader.rb#53 +# source://graphql//lib/graphql/schema/loader.rb#54 GraphQL::Schema::Loader::NullScalarCoerce = T.let(T.unsafe(nil), Proc) # The base class for things that make up the schema, @@ -10094,7 +10501,7 @@ module GraphQL::Schema::Member::BaseDSLMethods # @api private # @return [Boolean] # - # source://graphql//lib/graphql/schema/member/base_dsl_methods.rb#113 + # source://graphql//lib/graphql/schema/member/base_dsl_methods.rb#114 def authorized?(object, context); end # Creates the default name for a schema member. @@ -10108,7 +10515,7 @@ module GraphQL::Schema::Member::BaseDSLMethods # @api private # - # source://graphql//lib/graphql/schema/member/base_dsl_methods.rb#117 + # source://graphql//lib/graphql/schema/member/base_dsl_methods.rb#118 def default_relay; end # Call this method to provide a new description; OR @@ -10166,19 +10573,19 @@ module GraphQL::Schema::Member::BaseDSLMethods # @api private # @return [Boolean] # - # source://graphql//lib/graphql/schema/member/base_dsl_methods.rb#109 + # source://graphql//lib/graphql/schema/member/base_dsl_methods.rb#110 def visible?(context); end protected # @api private # - # source://graphql//lib/graphql/schema/member/base_dsl_methods.rb#123 + # source://graphql//lib/graphql/schema/member/base_dsl_methods.rb#124 def default_graphql_name=(_arg0); end # @api private # - # source://graphql//lib/graphql/schema/member/base_dsl_methods.rb#123 + # source://graphql//lib/graphql/schema/member/base_dsl_methods.rb#124 def graphql_name=(_arg0); end end @@ -10304,12 +10711,17 @@ module GraphQL::Schema::Member::HasArguments # @param arg_defn [GraphQL::Schema::Argument] # @return [GraphQL::Schema::Argument] # - # source://graphql//lib/graphql/schema/member/has_arguments.rb#80 + # source://graphql//lib/graphql/schema/member/has_arguments.rb#47 def add_argument(arg_defn); end - # source://graphql//lib/graphql/schema/member/has_arguments.rb#220 + # source://graphql//lib/graphql/schema/member/has_arguments.rb#200 def all_argument_definitions; end + # @return [Boolean] + # + # source://graphql//lib/graphql/schema/member/has_arguments.rb#92 + def any_arguments?; end + # @return [GraphQL::Schema::Argument] An instance of {argument_class}, created from `*args` # @see {GraphQL::Schema::Argument#initialize} for parameters # @@ -10318,17 +10730,17 @@ module GraphQL::Schema::Member::HasArguments # @param new_arg_class [Class] A class to use for building argument definitions # - # source://graphql//lib/graphql/schema/member/has_arguments.rb#239 + # source://graphql//lib/graphql/schema/member/has_arguments.rb#219 def argument_class(new_arg_class = T.unsafe(nil)); end # @return [Hash GraphQL::Schema::Argument] Arguments defined on this thing, keyed by name. Includes inherited definitions] Hash GraphQL::Schema::Argument] Arguments defined on this thing, keyed by name. Includes inherited definitions # - # source://graphql//lib/graphql/schema/member/has_arguments.rb#112 + # source://graphql//lib/graphql/schema/member/has_arguments.rb#79 def arguments(context = T.unsafe(nil)); end # @return [Boolean] # - # source://graphql//lib/graphql/schema/member/has_arguments.rb#322 + # source://graphql//lib/graphql/schema/member/has_arguments.rb#302 def arguments_statically_coercible?; end # If given a block, it will eventually yield the loaded args to the block. @@ -10338,28 +10750,28 @@ module GraphQL::Schema::Member::HasArguments # @api private # @param values [Hash] # @param context [GraphQL::Query::Context] - # @return [Interpreter::Arguments, Execution::Lazy] - # @yield [Interpreter::Arguments, Execution::Lazy] + # @return [Interpreter::Arguments, Execution::Lazy] + # @yield [Interpreter::Arguments, Execution::Lazy] # - # source://graphql//lib/graphql/schema/member/has_arguments.rb#252 + # source://graphql//lib/graphql/schema/member/has_arguments.rb#232 def coerce_arguments(parent_object, values, context, &block); end # @return [GraphQL::Schema::Argument, nil] Argument defined on this thing, fetched by name. # - # source://graphql//lib/graphql/schema/member/has_arguments.rb#227 + # source://graphql//lib/graphql/schema/member/has_arguments.rb#207 def get_argument(argument_name, context = T.unsafe(nil)); end - # source://graphql//lib/graphql/schema/member/has_arguments.rb#419 + # source://graphql//lib/graphql/schema/member/has_arguments.rb#410 def own_arguments; end - # source://graphql//lib/graphql/schema/member/has_arguments.rb#96 + # source://graphql//lib/graphql/schema/member/has_arguments.rb#63 def remove_argument(arg_defn); end # Usually, this is validated statically by RequiredArgumentsArePresent, # but not for directives. # TODO apply static validations on schema definitions? # - # source://graphql//lib/graphql/schema/member/has_arguments.rb#309 + # source://graphql//lib/graphql/schema/member/has_arguments.rb#289 def validate_directive_argument(arg_defn, value); end class << self @@ -10375,24 +10787,24 @@ module GraphQL::Schema::Member::HasArguments end end -# source://graphql//lib/graphql/schema/member/has_arguments.rb#330 +# source://graphql//lib/graphql/schema/member/has_arguments.rb#310 module GraphQL::Schema::Member::HasArguments::ArgumentClassAccessor - # source://graphql//lib/graphql/schema/member/has_arguments.rb#331 + # source://graphql//lib/graphql/schema/member/has_arguments.rb#311 def argument_class(new_arg_class = T.unsafe(nil)); end end -# source://graphql//lib/graphql/schema/member/has_arguments.rb#342 +# source://graphql//lib/graphql/schema/member/has_arguments.rb#322 module GraphQL::Schema::Member::HasArguments::ArgumentObjectLoader - # source://graphql//lib/graphql/schema/member/has_arguments.rb#367 + # source://graphql//lib/graphql/schema/member/has_arguments.rb#347 def authorize_application_object(argument, id, context, loaded_application_object); end - # source://graphql//lib/graphql/schema/member/has_arguments.rb#362 + # source://graphql//lib/graphql/schema/member/has_arguments.rb#342 def load_and_authorize_application_object(argument, id, context); end - # source://graphql//lib/graphql/schema/member/has_arguments.rb#354 + # source://graphql//lib/graphql/schema/member/has_arguments.rb#334 def load_application_object(argument, id, context); end - # source://graphql//lib/graphql/schema/member/has_arguments.rb#413 + # source://graphql//lib/graphql/schema/member/has_arguments.rb#404 def load_application_object_failed(err); end # Look up the corresponding object for a provided ID. @@ -10403,44 +10815,54 @@ module GraphQL::Schema::Member::HasArguments::ArgumentObjectLoader # @param id [String] A client-provided to look up # @param context [GraphQL::Query::Context] the current context # - # source://graphql//lib/graphql/schema/member/has_arguments.rb#350 + # source://graphql//lib/graphql/schema/member/has_arguments.rb#330 def object_from_id(type, id, context); end end -# source://graphql//lib/graphql/schema/member/has_arguments.rb#125 +# source://graphql//lib/graphql/schema/member/has_arguments.rb#96 module GraphQL::Schema::Member::HasArguments::ClassConfigured - # source://graphql//lib/graphql/schema/member/has_arguments.rb#126 + # source://graphql//lib/graphql/schema/member/has_arguments.rb#97 def inherited(child_class); end end -# source://graphql//lib/graphql/schema/member/has_arguments.rb#131 +# source://graphql//lib/graphql/schema/member/has_arguments.rb#102 module GraphQL::Schema::Member::HasArguments::ClassConfigured::InheritedArguments - # source://graphql//lib/graphql/schema/member/has_arguments.rb#148 + # source://graphql//lib/graphql/schema/member/has_arguments.rb#123 def all_argument_definitions; end - # source://graphql//lib/graphql/schema/member/has_arguments.rb#132 + # @return [Boolean] + # + # source://graphql//lib/graphql/schema/member/has_arguments.rb#119 + def any_arguments?; end + + # source://graphql//lib/graphql/schema/member/has_arguments.rb#103 def arguments(context = T.unsafe(nil)); end - # source://graphql//lib/graphql/schema/member/has_arguments.rb#161 + # source://graphql//lib/graphql/schema/member/has_arguments.rb#136 def get_argument(argument_name, context = T.unsafe(nil)); end end -# source://graphql//lib/graphql/schema/member/has_arguments.rb#175 +# source://graphql//lib/graphql/schema/member/has_arguments.rb#151 module GraphQL::Schema::Member::HasArguments::FieldConfigured - # source://graphql//lib/graphql/schema/member/has_arguments.rb#194 + # source://graphql//lib/graphql/schema/member/has_arguments.rb#174 def all_argument_definitions; end - # source://graphql//lib/graphql/schema/member/has_arguments.rb#176 + # @return [Boolean] + # + # source://graphql//lib/graphql/schema/member/has_arguments.rb#170 + def any_arguments?; end + + # source://graphql//lib/graphql/schema/member/has_arguments.rb#152 def arguments(context = T.unsafe(nil)); end end -# source://graphql//lib/graphql/schema/member/has_arguments.rb#314 +# source://graphql//lib/graphql/schema/member/has_arguments.rb#294 module GraphQL::Schema::Member::HasArguments::HasDirectiveArguments - # source://graphql//lib/graphql/schema/member/has_arguments.rb#315 + # source://graphql//lib/graphql/schema/member/has_arguments.rb#295 def validate_directive_argument(arg_defn, value); end end -# source://graphql//lib/graphql/schema/member/has_arguments.rb#418 +# source://graphql//lib/graphql/schema/member/has_arguments.rb#409 GraphQL::Schema::Member::HasArguments::NO_ARGUMENTS = T.let(T.unsafe(nil), Hash) # source://graphql//lib/graphql/schema/member/has_ast_node.rb#5 @@ -10541,7 +10963,7 @@ module GraphQL::Schema::Member::HasDirectives private # Modify `target` by adding items from `dirs` such that: - # - Any name conflict is overriden by the incoming member of `dirs` + # - Any name conflict is overridden by the incoming member of `dirs` # - Any other member of `dirs` is appended # # @param target [Array] @@ -10596,28 +11018,28 @@ module GraphQL::Schema::Member::HasFields # @param [GraphQL::Schema::Field] # @return [String] A warning to give when this field definition might conflict with a built-in method # - # source://graphql//lib/graphql/schema/member/has_fields.rb#214 + # source://graphql//lib/graphql/schema/member/has_fields.rb#219 def conflict_field_name_warning(field_defn); end - # source://graphql//lib/graphql/schema/member/has_fields.rb#181 + # source://graphql//lib/graphql/schema/member/has_fields.rb#186 def inherited(subclass); end # If `type` is an interface, and `self` has a type membership for `type`, then make sure it's visible. # # @return [Boolean] # - # source://graphql//lib/graphql/schema/member/has_fields.rb#190 + # source://graphql//lib/graphql/schema/member/has_fields.rb#195 def visible_interface_implementation?(type, context, warden); end class << self # @private # - # source://graphql//lib/graphql/schema/member/has_fields.rb#174 + # source://graphql//lib/graphql/schema/member/has_fields.rb#179 def extended(child_class); end # @private # - # source://graphql//lib/graphql/schema/member/has_fields.rb#168 + # source://graphql//lib/graphql/schema/member/has_fields.rb#173 def included(child_class); end end end @@ -10641,21 +11063,21 @@ GraphQL::Schema::Member::HasFields::GRAPHQL_RUBY_KEYWORDS = T.let(T.unsafe(nil), module GraphQL::Schema::Member::HasFields::InterfaceMethods # @return [Hash GraphQL::Schema::Field>] Fields on this object, keyed by name, including inherited fields # - # source://graphql//lib/graphql/schema/member/has_fields.rb#113 + # source://graphql//lib/graphql/schema/member/has_fields.rb#114 def fields(context = T.unsafe(nil)); end # source://graphql//lib/graphql/schema/member/has_fields.rb#100 def get_field(field_name, context = T.unsafe(nil)); end end -# source://graphql//lib/graphql/schema/member/has_fields.rb#132 +# source://graphql//lib/graphql/schema/member/has_fields.rb#133 module GraphQL::Schema::Member::HasFields::ObjectMethods # @return [Hash GraphQL::Schema::Field>] Fields on this object, keyed by name, including inherited fields # - # source://graphql//lib/graphql/schema/member/has_fields.rb#148 + # source://graphql//lib/graphql/schema/member/has_fields.rb#153 def fields(context = T.unsafe(nil)); end - # source://graphql//lib/graphql/schema/member/has_fields.rb#133 + # source://graphql//lib/graphql/schema/member/has_fields.rb#134 def get_field(field_name, context = T.unsafe(nil)); end end @@ -10676,7 +11098,7 @@ module GraphQL::Schema::Member::HasInterfaces # param context [Query::Context] If omitted, skip filtering. # - # source://graphql//lib/graphql/schema/member/has_interfaces.rb#93 + # source://graphql//lib/graphql/schema/member/has_interfaces.rb#102 def interfaces(context = T.unsafe(nil)); end # source://graphql//lib/graphql/schema/member/has_interfaces.rb#53 @@ -10684,13 +11106,13 @@ module GraphQL::Schema::Member::HasInterfaces private - # source://graphql//lib/graphql/schema/member/has_interfaces.rb#120 + # source://graphql//lib/graphql/schema/member/has_interfaces.rb#134 def inherited(subclass); end class << self # @private # - # source://graphql//lib/graphql/schema/member/has_interfaces.rb#116 + # source://graphql//lib/graphql/schema/member/has_interfaces.rb#130 def extended(child_class); end end end @@ -10709,7 +11131,7 @@ end # source://graphql//lib/graphql/schema/member/has_interfaces.rb#72 module GraphQL::Schema::Member::HasInterfaces::ClassConfigured::InheritedInterfaces - # source://graphql//lib/graphql/schema/member/has_interfaces.rb#80 + # source://graphql//lib/graphql/schema/member/has_interfaces.rb#89 def interface_type_memberships; end # source://graphql//lib/graphql/schema/member/has_interfaces.rb#73 @@ -10826,7 +11248,7 @@ module GraphQL::Schema::Member::RelayShortcuts private - # If one of thse values is accessed, initialize all the instance variables to retain + # If one of these values is accessed, initialize all the instance variables to retain # a consistent object shape. # # source://graphql//lib/graphql/schema/member/relay_shortcuts.rb#81 @@ -10835,6 +11257,12 @@ end # source://graphql//lib/graphql/schema/member/scoped.rb#6 module GraphQL::Schema::Member::Scoped + # source://graphql//lib/graphql/schema/member/scoped.rb#31 + def inherited(subclass); end + + # source://graphql//lib/graphql/schema/member/scoped.rb#19 + def reauthorize_scoped_objects(new_value = T.unsafe(nil)); end + # This is called when a field has `scope: true`. # The field's return type class receives this call. # @@ -10851,40 +11279,40 @@ end # source://graphql//lib/graphql/schema/member/type_system_helpers.rb#6 module GraphQL::Schema::Member::TypeSystemHelpers # source://graphql//lib/graphql/schema/member/type_system_helpers.rb#7 - def initialize(*args, **_arg1, &block); end + def initialize(*_arg0, **_arg1, &_arg2); end # @raise [GraphQL::RequiredImplementationMissingError] # @return [GraphQL::TypeKinds::TypeKind] # - # source://graphql//lib/graphql/schema/member/type_system_helpers.rb#39 + # source://graphql//lib/graphql/schema/member/type_system_helpers.rb#38 def kind; end # @return [Boolean] true if this is a list type. A non-nullable list is considered a list. # - # source://graphql//lib/graphql/schema/member/type_system_helpers.rb#30 + # source://graphql//lib/graphql/schema/member/type_system_helpers.rb#29 def list?; end # @return [Boolean] true if this is a non-nullable type. A nullable list of non-nullables is considered nullable. # - # source://graphql//lib/graphql/schema/member/type_system_helpers.rb#25 + # source://graphql//lib/graphql/schema/member/type_system_helpers.rb#24 def non_null?; end # @return [Schema::List] Make a list-type representation of this type # - # source://graphql//lib/graphql/schema/member/type_system_helpers.rb#20 + # source://graphql//lib/graphql/schema/member/type_system_helpers.rb#19 def to_list_type; end # @return [Schema::NonNull] Make a non-null-type representation of this type # - # source://graphql//lib/graphql/schema/member/type_system_helpers.rb#15 + # source://graphql//lib/graphql/schema/member/type_system_helpers.rb#14 def to_non_null_type; end - # source://graphql//lib/graphql/schema/member/type_system_helpers.rb#34 + # source://graphql//lib/graphql/schema/member/type_system_helpers.rb#33 def to_type_signature; end private - # source://graphql//lib/graphql/schema/member/type_system_helpers.rb#45 + # source://graphql//lib/graphql/schema/member/type_system_helpers.rb#44 def inherited(subclass); end end @@ -10973,20 +11401,25 @@ class GraphQL::Schema::Mutation < ::GraphQL::Schema::Resolver extend ::GraphQL::Schema::Member::HasFields::ObjectMethods extend ::GraphQL::Schema::Resolver::HasPayloadType + # @api private + # + # source://graphql//lib/graphql/schema/mutation.rb#66 + def call_resolve(_args_hash); end + class << self # @return [Boolean] # - # source://graphql//lib/graphql/schema/mutation.rb#66 + # source://graphql//lib/graphql/schema/mutation.rb#73 def visible?(context); end private - # source://graphql//lib/graphql/schema/mutation.rb#72 + # source://graphql//lib/graphql/schema/mutation.rb#79 def conflict_field_name_warning(field_defn); end # Override this to attach self as `mutation` # - # source://graphql//lib/graphql/schema/mutation.rb#77 + # source://graphql//lib/graphql/schema/mutation.rb#84 def generate_payload_type; end end end @@ -11062,7 +11495,7 @@ class GraphQL::Schema::Object < ::GraphQL::Schema::Member # @return [Object] a new instance of Object # - # source://graphql//lib/graphql/schema/object.rb#96 + # source://graphql//lib/graphql/schema/object.rb#104 def initialize(object, context); end # @return [GraphQL::Query::Context] the context instance for this query @@ -11105,23 +11538,29 @@ class GraphQL::Schema::Object < ::GraphQL::Schema::Member # @raise [GraphQL::UnauthorizedError] if the user-provided hook returns `false` # @return [GraphQL::Schema::Object, GraphQL::Execution::Lazy] # - # source://graphql//lib/graphql/schema/object.rb#55 + # source://graphql//lib/graphql/schema/object.rb#59 def authorized_new(object, context); end # Set up a type-specific invalid null error to use when this object's non-null fields wrongly return `nil`. # It should help with debugging and bug tracker integrations. # - # source://graphql//lib/graphql/schema/object.rb#104 + # source://graphql//lib/graphql/schema/object.rb#112 def const_missing(name); end - # source://graphql//lib/graphql/schema/object.rb#114 + # source://graphql//lib/graphql/schema/object.rb#122 def kind; end + # source://graphql//lib/graphql/schema/object.rb#99 + def scoped_new(object, context); end + # This is called by the runtime to return an object to call methods on. # - # source://graphql//lib/graphql/schema/object.rb#34 + # source://graphql//lib/graphql/schema/object.rb#38 def wrap(object, context); end + # source://graphql//lib/graphql/schema/object.rb#33 + def wrap_scoped(object, context); end + protected def new(*_arg0); end @@ -11160,20 +11599,18 @@ end class GraphQL::Schema::Printer < ::GraphQL::Language::Printer # @param schema [GraphQL::Schema] # @param context [Hash] - # @param only [<#call(member, ctx)>] - # @param except [<#call(member, ctx)>] # @param introspection [Boolean] Should include the introspection types in the string? # @return [Printer] a new instance of Printer # - # source://graphql//lib/graphql/schema/printer.rb#42 - def initialize(schema, context: T.unsafe(nil), only: T.unsafe(nil), except: T.unsafe(nil), introspection: T.unsafe(nil)); end + # source://graphql//lib/graphql/schema/printer.rb#40 + def initialize(schema, context: T.unsafe(nil), introspection: T.unsafe(nil)); end # Return a GraphQL schema string for the defined types in the schema # - # source://graphql//lib/graphql/schema/printer.rb#86 + # source://graphql//lib/graphql/schema/printer.rb#87 def print_schema; end - # source://graphql//lib/graphql/schema/printer.rb#90 + # source://graphql//lib/graphql/schema/printer.rb#91 def print_type(type); end # Returns the value of attribute schema. @@ -11189,7 +11626,7 @@ class GraphQL::Schema::Printer < ::GraphQL::Language::Printer class << self # Return the GraphQL schema string for the introspection type system # - # source://graphql//lib/graphql/schema/printer.rb#56 + # source://graphql//lib/graphql/schema/printer.rb#52 def print_introspection_schema; end # Return a GraphQL schema string for the defined types in the schema @@ -11199,14 +11636,14 @@ class GraphQL::Schema::Printer < ::GraphQL::Language::Printer # @param only [<#call(member, ctx)>] # @param except [<#call(member, ctx)>] # - # source://graphql//lib/graphql/schema/printer.rb#80 + # source://graphql//lib/graphql/schema/printer.rb#81 def print_schema(schema, **args); end end end -# source://graphql//lib/graphql/schema/printer.rb#95 +# source://graphql//lib/graphql/schema/printer.rb#96 class GraphQL::Schema::Printer::IntrospectionPrinter < ::GraphQL::Language::Printer - # source://graphql//lib/graphql/schema/printer.rb#96 + # source://graphql//lib/graphql/schema/printer.rb#97 def print_schema_definition(schema); end end @@ -11229,62 +11666,14 @@ end # # source://graphql//lib/graphql/schema/relay_classic_mutation.rb#23 class GraphQL::Schema::RelayClassicMutation < ::GraphQL::Schema::Mutation + include ::GraphQL::Schema::HasSingleInputArgument + extend ::GraphQL::Schema::HasSingleInputArgument::ClassMethods + # Override {GraphQL::Schema::Resolver#resolve_with_support} to # delete `client_mutation_id` from the kwargs. # - # source://graphql//lib/graphql/schema/relay_classic_mutation.rb#31 + # source://graphql//lib/graphql/schema/relay_classic_mutation.rb#35 def resolve_with_support(**inputs); end - - private - - # source://graphql//lib/graphql/schema/relay_classic_mutation.rb#172 - def authorize_arguments(args, values); end - - class << self - # source://graphql//lib/graphql/schema/relay_classic_mutation.rb#95 - def all_field_argument_definitions; end - - # Also apply this argument to the input type: - # - # source://graphql//lib/graphql/schema/relay_classic_mutation.rb#100 - def argument(*args, own_argument: T.unsafe(nil), **kwargs, &block); end - - # source://graphql//lib/graphql/schema/relay_classic_mutation.rb#73 - def dummy; end - - # source://graphql//lib/graphql/schema/relay_classic_mutation.rb#83 - def field_arguments(context = T.unsafe(nil)); end - - # source://graphql//lib/graphql/schema/relay_classic_mutation.rb#87 - def get_field_argument(name, context = T.unsafe(nil)); end - - # The base class for generated input object types - # - # @param new_class [Class] The base class to use for generating input object definitions - # @return [Class] The base class for this mutation's generated input object (default is {GraphQL::Schema::InputObject}) - # - # source://graphql//lib/graphql/schema/relay_classic_mutation.rb#126 - def input_object_class(new_class = T.unsafe(nil)); end - - # @param new_input_type [Class, nil] If provided, it configures this mutation to accept `new_input_type` instead of generating an input type - # @return [Class] The generated {Schema::InputObject} class for this mutation's `input` - # - # source://graphql//lib/graphql/schema/relay_classic_mutation.rb#135 - def input_type(new_input_type = T.unsafe(nil)); end - - # source://graphql//lib/graphql/schema/relay_classic_mutation.rb#91 - def own_field_arguments; end - - private - - # Generate the input type for the `input:` argument - # To customize how input objects are generated, override this method - # - # @return [Class] a subclass of {.input_object_class} - # - # source://graphql//lib/graphql/schema/relay_classic_mutation.rb#147 - def generate_input_type; end - end end # A class-based container for field configuration and resolution logic. It supports: @@ -11316,16 +11705,17 @@ class GraphQL::Schema::Resolver extend ::GraphQL::Schema::Member::HasValidators extend ::GraphQL::Schema::Member::HasValidators::ClassConfigured extend ::GraphQL::Schema::Member::HasPath + extend ::GraphQL::Schema::Member::HasDirectives # @param object [Object] The application object that this field is being resolved on # @param context [GraphQL::Query::Context] # @param field [GraphQL::Schema::Field] # @return [Resolver] a new instance of Resolver # - # source://graphql//lib/graphql/schema/resolver.rb#32 + # source://graphql//lib/graphql/schema/resolver.rb#33 def initialize(object:, context:, field:); end - # source://graphql//lib/graphql/schema/resolver.rb#58 + # source://graphql//lib/graphql/schema/resolver.rb#59 def arguments; end # Called after arguments are loaded, but before resolving. @@ -11337,27 +11727,32 @@ class GraphQL::Schema::Resolver # @raise [GraphQL::UnauthorizedError] To signal an authorization failure # @return [Boolean, early_return_data] If `false`, execution will stop (and `early_return_data` will be returned instead, if present.) # - # source://graphql//lib/graphql/schema/resolver.rb#145 + # source://graphql//lib/graphql/schema/resolver.rb#153 def authorized?(**inputs); end + # @api private {GraphQL::Schema::Mutation} uses this to clear the dataloader cache + # + # source://graphql//lib/graphql/schema/resolver.rb#118 + def call_resolve(args_hash); end + # @return [GraphQL::Query::Context] # - # source://graphql//lib/graphql/schema/resolver.rb#48 + # source://graphql//lib/graphql/schema/resolver.rb#49 def context; end # @return [GraphQL::Dataloader] # - # source://graphql//lib/graphql/schema/resolver.rb#51 + # source://graphql//lib/graphql/schema/resolver.rb#52 def dataloader; end # @return [GraphQL::Schema::Field] # - # source://graphql//lib/graphql/schema/resolver.rb#56 + # source://graphql//lib/graphql/schema/resolver.rb#57 def field; end # @return [Object] The application object this field is being resolved on # - # source://graphql//lib/graphql/schema/resolver.rb#45 + # source://graphql//lib/graphql/schema/resolver.rb#46 def object; end # Called before arguments are prepared. @@ -11371,7 +11766,7 @@ class GraphQL::Schema::Resolver # @raise [GraphQL::UnauthorizedError] To signal an authorization failure # @return [Boolean, early_return_data] If `false`, execution will stop (and `early_return_data` will be returned instead, if present.) # - # source://graphql//lib/graphql/schema/resolver.rb#134 + # source://graphql//lib/graphql/schema/resolver.rb#142 def ready?(**args); end # Do the work. Everything happens here. @@ -11379,7 +11774,7 @@ class GraphQL::Schema::Resolver # @raise [GraphQL::RequiredImplementationMissingError] # @return [Object] An object corresponding to the return type # - # source://graphql//lib/graphql/schema/resolver.rb#120 + # source://graphql//lib/graphql/schema/resolver.rb#128 def resolve(**args); end # This method is _actually_ called by the runtime, @@ -11388,7 +11783,7 @@ class GraphQL::Schema::Resolver # # @api private # - # source://graphql//lib/graphql/schema/resolver.rb#66 + # source://graphql//lib/graphql/schema/resolver.rb#67 def resolve_with_support(**args); end # Called when an object loaded by `loads:` fails the `.authorized?` check for its resolved GraphQL object type. @@ -11399,45 +11794,50 @@ class GraphQL::Schema::Resolver # # @param err [GraphQL::UnauthorizedError] # - # source://graphql//lib/graphql/schema/resolver.rb#157 + # source://graphql//lib/graphql/schema/resolver.rb#165 def unauthorized_object(err); end private - # source://graphql//lib/graphql/schema/resolver.rb#163 + # source://graphql//lib/graphql/schema/resolver.rb#171 def authorize_arguments(args, inputs); end - # source://graphql//lib/graphql/schema/resolver.rb#206 + # source://graphql//lib/graphql/schema/resolver.rb#217 def get_argument(name, context = T.unsafe(nil)); end - # source://graphql//lib/graphql/schema/resolver.rb#179 + # source://graphql//lib/graphql/schema/resolver.rb#190 def load_arguments(args); end class << self - # source://graphql//lib/graphql/schema/resolver.rb#219 + # source://graphql//lib/graphql/schema/resolver.rb#234 def all_field_argument_definitions; end + # @return [Boolean] + # + # source://graphql//lib/graphql/schema/resolver.rb#226 + def any_field_arguments?; end + # Add an argument to this field's signature, but # also add some preparation hook methods which will be used for this argument # # @see {GraphQL::Schema::Argument#initialize} for the signature # - # source://graphql//lib/graphql/schema/resolver.rb#360 + # source://graphql//lib/graphql/schema/resolver.rb#375 def argument(*args, **kwargs, &block); end - # source://graphql//lib/graphql/schema/resolver.rb#297 + # source://graphql//lib/graphql/schema/resolver.rb#312 def broadcastable(new_broadcastable); end # @return [Boolean, nil] # - # source://graphql//lib/graphql/schema/resolver.rb#302 + # source://graphql//lib/graphql/schema/resolver.rb#317 def broadcastable?; end # Specifies the complexity of the field. Defaults to `1` # # @return [Integer, Proc] # - # source://graphql//lib/graphql/schema/resolver.rb#290 + # source://graphql//lib/graphql/schema/resolver.rb#305 def complexity(new_complexity = T.unsafe(nil)); end # Get or set the `default_page_size:` which will be configured for fields using this resolver @@ -11446,7 +11846,7 @@ class GraphQL::Schema::Resolver # @param default_page_size [Integer, nil] Set a new value # @return [Integer, nil] The `default_page_size` assigned to fields that use this resolver # - # source://graphql//lib/graphql/schema/resolver.rb#335 + # source://graphql//lib/graphql/schema/resolver.rb#350 def default_page_size(new_default_page_size = T.unsafe(nil)); end # Registers new extension @@ -11454,35 +11854,35 @@ class GraphQL::Schema::Resolver # @param extension [Class] Extension class # @param options [Hash] Optional extension options # - # source://graphql//lib/graphql/schema/resolver.rb#369 + # source://graphql//lib/graphql/schema/resolver.rb#384 def extension(extension, **options); end # @api private # - # source://graphql//lib/graphql/schema/resolver.rb#375 + # source://graphql//lib/graphql/schema/resolver.rb#390 def extensions; end # Additional info injected into {#resolve} # # @see {GraphQL::Schema::Field#extras} # - # source://graphql//lib/graphql/schema/resolver.rb#234 + # source://graphql//lib/graphql/schema/resolver.rb#249 def extras(new_extras = T.unsafe(nil)); end - # source://graphql//lib/graphql/schema/resolver.rb#211 + # source://graphql//lib/graphql/schema/resolver.rb#222 def field_arguments(context = T.unsafe(nil)); end - # source://graphql//lib/graphql/schema/resolver.rb#215 + # source://graphql//lib/graphql/schema/resolver.rb#230 def get_field_argument(name, context = T.unsafe(nil)); end # @return [Boolean] `true` if this resolver or a superclass has an assigned `default_page_size` # - # source://graphql//lib/graphql/schema/resolver.rb#348 + # source://graphql//lib/graphql/schema/resolver.rb#363 def has_default_page_size?; end # @return [Boolean] `true` if this resolver or a superclass has an assigned `max_page_size` # - # source://graphql//lib/graphql/schema/resolver.rb#327 + # source://graphql//lib/graphql/schema/resolver.rb#342 def has_max_page_size?; end # Get or set the `max_page_size:` which will be configured for fields using this resolver @@ -11491,7 +11891,7 @@ class GraphQL::Schema::Resolver # @param max_page_size [Integer, nil] Set a new value # @return [Integer, nil] The `max_page_size` assigned to fields that use this resolver # - # source://graphql//lib/graphql/schema/resolver.rb#314 + # source://graphql//lib/graphql/schema/resolver.rb#329 def max_page_size(new_max_page_size = T.unsafe(nil)); end # If `true` (default), then the return type for this resolver will be nullable. @@ -11500,17 +11900,17 @@ class GraphQL::Schema::Resolver # @param allow_null [Boolean] Whether or not the response can be null # @see #type which sets the return type of this field and accepts a `null:` option # - # source://graphql//lib/graphql/schema/resolver.rb#247 + # source://graphql//lib/graphql/schema/resolver.rb#262 def null(allow_null = T.unsafe(nil)); end # Default `:resolve` set below. # # @return [Symbol] The method to call on instances of this object to resolve the field # - # source://graphql//lib/graphql/schema/resolver.rb#225 + # source://graphql//lib/graphql/schema/resolver.rb#240 def resolve_method(new_method = T.unsafe(nil)); end - # source://graphql//lib/graphql/schema/resolver.rb#255 + # source://graphql//lib/graphql/schema/resolver.rb#270 def resolver_method(new_method_name = T.unsafe(nil)); end # Call this method to get the return type of the field, @@ -11522,17 +11922,17 @@ class GraphQL::Schema::Resolver # @param null [true, false] Whether or not the field may return `nil` # @return [Class] The type which this field returns. # - # source://graphql//lib/graphql/schema/resolver.rb#270 + # source://graphql//lib/graphql/schema/resolver.rb#285 def type(new_type = T.unsafe(nil), null: T.unsafe(nil)); end # A non-normalized type configuration, without `null` applied # - # source://graphql//lib/graphql/schema/resolver.rb#353 + # source://graphql//lib/graphql/schema/resolver.rb#368 def type_expr; end private - # source://graphql//lib/graphql/schema/resolver.rb#396 + # source://graphql//lib/graphql/schema/resolver.rb#411 def own_extensions; end end end @@ -11624,6 +12024,12 @@ class GraphQL::Schema::Scalar < ::GraphQL::Schema::Member end end +# source://graphql//lib/graphql/schema.rb#1566 +module GraphQL::Schema::SubclassGetReferencesTo + # source://graphql//lib/graphql/schema.rb#1567 + def get_references_to(type_defn); end +end + # This class can be extended to create fields on your subscription root. # # It provides hooks for the different parts of the subscription lifecycle: @@ -11651,22 +12057,22 @@ class GraphQL::Schema::Subscription < ::GraphQL::Schema::Resolver # remove this subscription (assuming that the object was deleted in the meantime, # or that it became inaccessible). # - # source://graphql//lib/graphql/schema/subscription.rb#89 + # source://graphql//lib/graphql/schema/subscription.rb#94 def load_application_object_failed(err); end # Implement the {Resolve} API # - # source://graphql//lib/graphql/schema/subscription.rb#45 + # source://graphql//lib/graphql/schema/subscription.rb#50 def resolve(**args); end # Wrap the user-defined `#subscribe` hook # - # source://graphql//lib/graphql/schema/subscription.rb#52 + # source://graphql//lib/graphql/schema/subscription.rb#57 def resolve_subscribe(**args); end # Wrap the user-provided `#update` hook # - # source://graphql//lib/graphql/schema/subscription.rb#69 + # source://graphql//lib/graphql/schema/subscription.rb#74 def resolve_update(**args); end # source://graphql//lib/graphql/schema/subscription.rb#28 @@ -11676,19 +12082,22 @@ class GraphQL::Schema::Subscription < ::GraphQL::Schema::Resolver # Override it to return an object or # `:no_response` to (explicitly) return nothing. # - # source://graphql//lib/graphql/schema/subscription.rb#64 + # source://graphql//lib/graphql/schema/subscription.rb#69 def subscribe(args = T.unsafe(nil)); end # Call this to halt execution and remove this subscription from the system # - # source://graphql//lib/graphql/schema/subscription.rb#97 - def unsubscribe; end + # @param update_value [Object] if present, deliver this update before unsubscribing + # @return [void] + # + # source://graphql//lib/graphql/schema/subscription.rb#104 + def unsubscribe(update_value = T.unsafe(nil)); end # The default implementation returns the root object. # Override it to return {NO_UPDATE} if you want to # skip updates sometimes. Or override it to return a different object. # - # source://graphql//lib/graphql/schema/subscription.rb#82 + # source://graphql//lib/graphql/schema/subscription.rb#87 def update(args = T.unsafe(nil)); end class << self @@ -11699,12 +12108,12 @@ class GraphQL::Schema::Subscription < ::GraphQL::Schema::Resolver # @param optional [Boolean] If true, then don't require `scope:` to be provided to updates to this subscription. # @return [Symbol] # - # source://graphql//lib/graphql/schema/subscription.rb#108 + # source://graphql//lib/graphql/schema/subscription.rb#115 def subscription_scope(new_scope = T.unsafe(nil), optional: T.unsafe(nil)); end # @return [Boolean] # - # source://graphql//lib/graphql/schema/subscription.rb#119 + # source://graphql//lib/graphql/schema/subscription.rb#126 def subscription_scope_optional?; end # This is called during initial subscription to get a "name" for this subscription. @@ -11724,7 +12133,7 @@ class GraphQL::Schema::Subscription < ::GraphQL::Schema::Resolver # @return [String] An identifier corresponding to a stream of updates # @see {#update} for how to skip updates when an event comes with a matching topic. # - # source://graphql//lib/graphql/schema/subscription.rb#143 + # source://graphql//lib/graphql/schema/subscription.rb#150 def topic_for(arguments:, field:, scope:); end end end @@ -11732,9 +12141,108 @@ end # source://graphql//lib/graphql/schema/subscription.rb#17 GraphQL::Schema::Subscription::NO_UPDATE = T.let(T.unsafe(nil), Symbol) -# source://graphql//lib/graphql/schema/subscription.rb#102 +# source://graphql//lib/graphql/schema/subscription.rb#109 GraphQL::Schema::Subscription::READING_SCOPE = T.let(T.unsafe(nil), Object) +# source://graphql//lib/graphql/schema/subset.rb#5 +class GraphQL::Schema::Subset + # @return [Subset] a new instance of Subset + # + # source://graphql//lib/graphql/schema/subset.rb#6 + def initialize(query); end + + # source://graphql//lib/graphql/schema/subset.rb#221 + def all_types; end + + # source://graphql//lib/graphql/schema/subset.rb#150 + def argument(owner, arg_name); end + + # source://graphql//lib/graphql/schema/subset.rb#146 + def arguments(owner); end + + # @return [Boolean] + # + # source://graphql//lib/graphql/schema/subset.rb#242 + def directive_exists?(dir_name); end + + # source://graphql//lib/graphql/schema/subset.rb#247 + def directives; end + + # source://graphql//lib/graphql/schema/subset.rb#234 + def enum_values(owner); end + + # source://graphql//lib/graphql/schema/subset.rb#110 + def field(owner, field_name); end + + # @return [Boolean] + # + # source://graphql//lib/graphql/schema/subset.rb#55 + def field_on_visible_interface?(field, owner); end + + # source://graphql//lib/graphql/schema/subset.rb#142 + def fields(owner); end + + # source://graphql//lib/graphql/schema/subset.rb#201 + def interfaces(obj_or_int_type); end + + # @return [Boolean] + # + # source://graphql//lib/graphql/schema/subset.rb#251 + def loadable?(t, _ctx); end + + # source://graphql//lib/graphql/schema/subset.rb#261 + def loaded_types; end + + # source://graphql//lib/graphql/schema/subset.rb#213 + def mutation_root; end + + # source://graphql//lib/graphql/schema/subset.rb#181 + def possible_types(type); end + + # source://graphql//lib/graphql/schema/subset.rb#209 + def query_root; end + + # TODO rename this to indicate that it is called with a typename + # + # @return [Boolean] + # + # source://graphql//lib/graphql/schema/subset.rb#256 + def reachable_type?(type_name); end + + # source://graphql//lib/graphql/schema/subset.rb#217 + def subscription_root; end + + # source://graphql//lib/graphql/schema/subset.rb#79 + def type(type_name); end + + private + + # source://graphql//lib/graphql/schema/subset.rb#267 + def add_if_visible(t); end + + # source://graphql//lib/graphql/schema/subset.rb#271 + def add_type(t, by_member); end + + # source://graphql//lib/graphql/schema/subset.rb#319 + def load_all_types; end + + # source://graphql//lib/graphql/schema/subset.rb#290 + def non_duplicate_items(definitions, visibility_cache); end + + # @raise [DuplicateNamesError] + # + # source://graphql//lib/graphql/schema/subset.rb#303 + def raise_duplicate_definition(first_defn, second_defn); end + + # @return [Boolean] + # + # source://graphql//lib/graphql/schema/subset.rb#307 + def referenced?(t); end + + # source://graphql//lib/graphql/schema/subset.rb#349 + def visit_type(type); end +end + # This plugin will stop resolving new fields after `max_seconds` have elapsed. # After the time has passed, any remaining fields will be `nil`, with errors added # to the `errors` key. Any already-resolved fields will be in the `data` key, so @@ -11833,7 +12341,7 @@ module GraphQL::Schema::TypeExpression # Return `nil` if not found. # # @api private - # @param type_owner [#get_type] A thing for looking up types by name + # @param type_owner [#type] A thing for looking up types by name # @param ast_node [GraphQL::Language::Nodes::AbstractNode] # @return [Class, GraphQL::Schema::NonNull, GraphQL::Schema:List] # @@ -11988,16 +12496,16 @@ module GraphQL::Schema::UniqueWithinType end end -# source://graphql//lib/graphql/schema.rb#88 +# source://graphql//lib/graphql/schema.rb#87 class GraphQL::Schema::UnresolvedLateBoundTypeError < ::GraphQL::Error # @return [UnresolvedLateBoundTypeError] a new instance of UnresolvedLateBoundTypeError # - # source://graphql//lib/graphql/schema.rb#90 + # source://graphql//lib/graphql/schema.rb#89 def initialize(type:); end # Returns the value of attribute type. # - # source://graphql//lib/graphql/schema.rb#89 + # source://graphql//lib/graphql/schema.rb#88 def type; end end @@ -12089,6 +12597,32 @@ class GraphQL::Schema::Validator end end +# Use this to validate each member of an array value. +# +# @example validate format of all strings in an array +# +# argument :handles, [String], +# validates: { all: { format: { with: /\A[a-z0-9_]+\Z/ } } } +# @example multiple validators can be combined +# +# argument :handles, [String], +# validates: { all: { format: { with: /\A[a-z0-9_]+\Z/ }, length: { maximum: 32 } } } +# @example any type can be used +# +# argument :choices, [Integer], +# validates: { all: { inclusion: { in: 1..12 } } } +# +# source://graphql//lib/graphql/schema/validator/all_validator.rb#23 +class GraphQL::Schema::Validator::AllValidator < ::GraphQL::Schema::Validator + # @return [AllValidator] a new instance of AllValidator + # + # source://graphql//lib/graphql/schema/validator/all_validator.rb#24 + def initialize(validated:, allow_blank: T.unsafe(nil), allow_null: T.unsafe(nil), **validators); end + + # source://graphql//lib/graphql/schema/validator/all_validator.rb#30 + def validate(object, context, value); end +end + # Use this to specifically reject values that respond to `.blank?` and respond truthy for that method. # # @example Require a non-empty string for an argument @@ -12309,160 +12843,147 @@ class GraphQL::Schema::Validator::ValidationFailedError < ::GraphQL::ExecutionEr def errors; end end -# Restrict access to a {GraphQL::Schema} with a user-defined filter. +# Restrict access to a {GraphQL::Schema} with a user-defined `visible?` implementations. # # When validating and executing a query, all access to schema members -# should go through a warden. If you access the schema directly, -# you may show a client something that it shouldn't be allowed to see. -# -# @api private -# @example Hiding private fields -# private_members = -> (member, ctx) { member.metadata[:private] } -# result = Schema.execute(query_string, except: private_members) -# @example Custom filter implementation -# # It must respond to `#call(member)`. -# class MissingRequiredFlags -# def initialize(user) -# @user = user -# end -# -# # Return `false` if any required flags are missing -# def call(member, ctx) -# member.metadata[:required_flags].any? do |flag| -# !@user.has_flag?(flag) -# end -# end -# end -# -# # Then, use the custom filter in query: -# missing_required_flags = MissingRequiredFlags.new(current_user) +# should go through a warden. If you access the schema directly, +# you may show a client something that it shouldn't be allowed to see. # -# # This query can only access members which match the user's flags -# result = Schema.execute(query_string, except: missing_required_flags) +# @api private # -# source://graphql//lib/graphql/schema/warden.rb#39 +# source://graphql//lib/graphql/schema/warden.rb#14 class GraphQL::Schema::Warden # @api private - # @param filter [<#call(member)>] Objects are hidden when `.call(member, ctx)` returns true # @param context [GraphQL::Query::Context] # @param schema [GraphQL::Schema] # @return [Warden] a new instance of Warden # - # source://graphql//lib/graphql/schema/warden.rb#120 - def initialize(filter = T.unsafe(nil), context:, schema:); end + # source://graphql//lib/graphql/schema/warden.rb#183 + def initialize(context:, schema:); end # @api private # @param argument_owner [GraphQL::Field, GraphQL::InputObjectType] # @return [Array] Visible arguments on `argument_owner` # - # source://graphql//lib/graphql/schema/warden.rb#221 + # source://graphql//lib/graphql/schema/warden.rb#284 def arguments(argument_owner, ctx = T.unsafe(nil)); end # @api private # - # source://graphql//lib/graphql/schema/warden.rb#249 + # source://graphql//lib/graphql/schema/warden.rb#327 def directives; end # @api private # @return [Array] Visible members of `enum_defn` # - # source://graphql//lib/graphql/schema/warden.rb#227 + # source://graphql//lib/graphql/schema/warden.rb#299 def enum_values(enum_defn); end # @api private # @param type_defn [GraphQL::ObjectType, GraphQL::InterfaceType] # @return [Array] Fields on `type_defn` # - # source://graphql//lib/graphql/schema/warden.rb#214 + # source://graphql//lib/graphql/schema/warden.rb#277 def fields(type_defn); end # @api private # @return [GraphQL::Argument, nil] The argument named `argument_name` on `parent_type`, if it exists and is visible # - # source://graphql//lib/graphql/schema/warden.rb#198 + # source://graphql//lib/graphql/schema/warden.rb#261 def get_argument(parent_type, argument_name); end # @api private # @return [GraphQL::Field, nil] The field named `field_name` on `parent_type`, if it exists # - # source://graphql//lib/graphql/schema/warden.rb#182 + # source://graphql//lib/graphql/schema/warden.rb#245 def get_field(parent_type, field_name); end # @api private # @return [GraphQL::BaseType, nil] The type named `type_name`, if it exists (else `nil`) # - # source://graphql//lib/graphql/schema/warden.rb#157 + # source://graphql//lib/graphql/schema/warden.rb#220 def get_type(type_name); end # @api private # - # source://graphql//lib/graphql/schema/warden.rb#286 + # source://graphql//lib/graphql/schema/warden.rb#364 def interface_type_memberships(obj_type, _ctx = T.unsafe(nil)); end # @api private # @return [Array] Visible interfaces implemented by `obj_type` # - # source://graphql//lib/graphql/schema/warden.rb#244 + # source://graphql//lib/graphql/schema/warden.rb#316 def interfaces(obj_type); end + # @api private + # @return [Boolean] True if this type is used for `loads:` but not in the schema otherwise and not _explicitly_ hidden. + # + # source://graphql//lib/graphql/schema/warden.rb#215 + def loadable?(type, _ctx); end + # @api private # @return [Array] The types which may be member of `type_defn` # - # source://graphql//lib/graphql/schema/warden.rb#204 + # source://graphql//lib/graphql/schema/warden.rb#267 def possible_types(type_defn); end # @api private # @return [Boolean] Boolean True if the type is visible and reachable in the schema # - # source://graphql//lib/graphql/schema/warden.rb#176 + # source://graphql//lib/graphql/schema/warden.rb#239 def reachable_type?(type_name); end # @api private # @return [Array] Visible and reachable types in the schema # - # source://graphql//lib/graphql/schema/warden.rb#171 + # source://graphql//lib/graphql/schema/warden.rb#234 def reachable_types; end # @api private # - # source://graphql//lib/graphql/schema/warden.rb#253 + # source://graphql//lib/graphql/schema/warden.rb#331 def root_type_for_operation(op_name); end + # @api private + # + # source://graphql//lib/graphql/schema/warden.rb#107 + def schema_subset; end + # @api private # @return [Hash] Visible types in the schema # - # source://graphql//lib/graphql/schema/warden.rb#144 + # source://graphql//lib/graphql/schema/warden.rb#202 def types; end # @api private # @return [Boolean] # - # source://graphql//lib/graphql/schema/warden.rb#273 + # source://graphql//lib/graphql/schema/warden.rb#351 def visible_argument?(arg_defn, _ctx = T.unsafe(nil)); end # @api private # @return [Boolean] # - # source://graphql//lib/graphql/schema/warden.rb#238 + # source://graphql//lib/graphql/schema/warden.rb#310 def visible_enum_value?(enum_value, _ctx = T.unsafe(nil)); end # @api private # @param owner [Class, Module] If provided, confirm that field has the given owner. # @return [Boolean] # - # source://graphql//lib/graphql/schema/warden.rb#263 + # source://graphql//lib/graphql/schema/warden.rb#341 def visible_field?(field_defn, _ctx = T.unsafe(nil), owner = T.unsafe(nil)); end # @api private # @return [Boolean] # - # source://graphql//lib/graphql/schema/warden.rb#277 + # source://graphql//lib/graphql/schema/warden.rb#355 def visible_type?(type_defn, _ctx = T.unsafe(nil)); end # @api private # @return [Boolean] # - # source://graphql//lib/graphql/schema/warden.rb#282 + # source://graphql//lib/graphql/schema/warden.rb#360 def visible_type_membership?(type_membership, _ctx = T.unsafe(nil)); end private @@ -12474,35 +12995,35 @@ class GraphQL::Schema::Warden # @api private # @return [Boolean] # - # source://graphql//lib/graphql/schema/warden.rb#327 + # source://graphql//lib/graphql/schema/warden.rb#420 def field_on_visible_interface?(field_defn, type_defn); end # @api private # @return [Boolean] # - # source://graphql//lib/graphql/schema/warden.rb#368 + # source://graphql//lib/graphql/schema/warden.rb#457 def orphan_type?(type_defn); end # @api private # - # source://graphql//lib/graphql/schema/warden.rb#391 + # source://graphql//lib/graphql/schema/warden.rb#471 def reachable_type_set; end # @api private # - # source://graphql//lib/graphql/schema/warden.rb#387 + # source://graphql//lib/graphql/schema/warden.rb#465 def read_through; end # @api private # @return [Boolean] # - # source://graphql//lib/graphql/schema/warden.rb#359 + # source://graphql//lib/graphql/schema/warden.rb#452 def referenced?(type_defn); end # @api private # @return [Boolean] # - # source://graphql//lib/graphql/schema/warden.rb#353 + # source://graphql//lib/graphql/schema/warden.rb#446 def root_type?(type_defn); end # We need this to tell whether a field was inherited by an interface @@ -12510,42 +13031,35 @@ class GraphQL::Schema::Warden # # @api private # - # source://graphql//lib/graphql/schema/warden.rb#319 + # source://graphql//lib/graphql/schema/warden.rb#412 def unfiltered_interfaces(type_defn); end # @api private # - # source://graphql//lib/graphql/schema/warden.rb#312 + # source://graphql//lib/graphql/schema/warden.rb#405 def union_memberships(obj_type); end # @api private # @return [Boolean] # - # source://graphql//lib/graphql/schema/warden.rb#383 + # source://graphql//lib/graphql/schema/warden.rb#461 def visible?(member); end # @api private # @return [Boolean] # - # source://graphql//lib/graphql/schema/warden.rb#372 - def visible_abstract_type?(type_defn); end - - # @api private - # @return [Boolean] - # - # source://graphql//lib/graphql/schema/warden.rb#295 + # source://graphql//lib/graphql/schema/warden.rb#373 def visible_and_reachable_type?(type_defn); end # @api private - # @return [Boolean] # - # source://graphql//lib/graphql/schema/warden.rb#379 - def visible_possible_types?(type_defn); end + # source://graphql//lib/graphql/schema/warden.rb#509 + def visit_type(type, unvisited_types, visited_type_set, type_by_name_hash, included_interface_possible_types_set, include_interface_possible_types:); end class << self # @api private # - # source://graphql//lib/graphql/schema/warden.rb#40 + # source://graphql//lib/graphql/schema/warden.rb#15 def from_context(context); end # @api private @@ -12556,128 +13070,146 @@ class GraphQL::Schema::Warden # @return [Object] `entry` or one of `entry`'s items if exactly one of them is visible for this context # @return [nil] If neither `entry` nor any of `entry`'s items are visible for this context # - # source://graphql//lib/graphql/schema/warden.rb#53 + # source://graphql//lib/graphql/schema/warden.rb#28 def visible_entry?(visibility_method, entry, context, warden = T.unsafe(nil)); end end end # @api private # -# source://graphql//lib/graphql/schema/warden.rb#366 -GraphQL::Schema::Warden::NO_REFERENCES = T.let(T.unsafe(nil), Array) - -# @api private -# -# source://graphql//lib/graphql/schema/warden.rb#91 +# source://graphql//lib/graphql/schema/warden.rb#70 class GraphQL::Schema::Warden::NullWarden # @api private # @return [NullWarden] a new instance of NullWarden # - # source://graphql//lib/graphql/schema/warden.rb#92 + # source://graphql//lib/graphql/schema/warden.rb#71 def initialize(_filter = T.unsafe(nil), context:, schema:); end # @api private # - # source://graphql//lib/graphql/schema/warden.rb#103 + # source://graphql//lib/graphql/schema/warden.rb#92 def arguments(argument_owner, ctx = T.unsafe(nil)); end # @api private # - # source://graphql//lib/graphql/schema/warden.rb#108 + # source://graphql//lib/graphql/schema/warden.rb#97 def directives; end # @api private # - # source://graphql//lib/graphql/schema/warden.rb#104 + # source://graphql//lib/graphql/schema/warden.rb#93 def enum_values(enum_defn); end # @api private # - # source://graphql//lib/graphql/schema/warden.rb#109 + # source://graphql//lib/graphql/schema/warden.rb#98 def fields(type_defn); end # @api private # - # source://graphql//lib/graphql/schema/warden.rb#105 + # source://graphql//lib/graphql/schema/warden.rb#94 def get_argument(parent_type, argument_name); end # @api private # - # source://graphql//lib/graphql/schema/warden.rb#110 + # source://graphql//lib/graphql/schema/warden.rb#99 def get_field(parent_type, field_name); end # @api private # - # source://graphql//lib/graphql/schema/warden.rb#102 + # source://graphql//lib/graphql/schema/warden.rb#91 def get_type(type_name); end # @api private # - # source://graphql//lib/graphql/schema/warden.rb#101 + # source://graphql//lib/graphql/schema/warden.rb#90 def interface_type_memberships(obj_type, _ctx = T.unsafe(nil)); end # @api private # - # source://graphql//lib/graphql/schema/warden.rb#114 + # source://graphql//lib/graphql/schema/warden.rb#104 def interfaces(obj_type); end + # @api private + # @return [Boolean] + # + # source://graphql//lib/graphql/schema/warden.rb#101 + def loadable?(type, _ctx); end + # @api private # - # source://graphql//lib/graphql/schema/warden.rb#113 + # source://graphql//lib/graphql/schema/warden.rb#103 def possible_types(type_defn); end # @api private # @return [Boolean] # - # source://graphql//lib/graphql/schema/warden.rb#111 + # source://graphql//lib/graphql/schema/warden.rb#100 def reachable_type?(type_name); end # @api private # - # source://graphql//lib/graphql/schema/warden.rb#112 + # source://graphql//lib/graphql/schema/warden.rb#102 def reachable_types; end # @api private # - # source://graphql//lib/graphql/schema/warden.rb#107 + # source://graphql//lib/graphql/schema/warden.rb#96 def root_type_for_operation(op_name); end # @api private # - # source://graphql//lib/graphql/schema/warden.rb#106 + # source://graphql//lib/graphql/schema/warden.rb#83 + def schema_subset; end + + # @api private + # + # source://graphql//lib/graphql/schema/warden.rb#95 def types; end # @api private # @return [Boolean] # - # source://graphql//lib/graphql/schema/warden.rb#97 + # source://graphql//lib/graphql/schema/warden.rb#86 def visible_argument?(arg_defn, _ctx = T.unsafe(nil)); end # @api private # @return [Boolean] # - # source://graphql//lib/graphql/schema/warden.rb#99 + # source://graphql//lib/graphql/schema/warden.rb#88 def visible_enum_value?(enum_value, _ctx = T.unsafe(nil)); end # @api private # @return [Boolean] # - # source://graphql//lib/graphql/schema/warden.rb#96 + # source://graphql//lib/graphql/schema/warden.rb#85 def visible_field?(field_defn, _ctx = T.unsafe(nil), owner = T.unsafe(nil)); end # @api private # @return [Boolean] # - # source://graphql//lib/graphql/schema/warden.rb#98 + # source://graphql//lib/graphql/schema/warden.rb#87 def visible_type?(type_defn, _ctx = T.unsafe(nil)); end # @api private # @return [Boolean] # - # source://graphql//lib/graphql/schema/warden.rb#100 + # source://graphql//lib/graphql/schema/warden.rb#89 def visible_type_membership?(type_membership, _ctx = T.unsafe(nil)); end end +# @api private +# +# source://graphql//lib/graphql/schema/warden.rb#77 +module GraphQL::Schema::Warden::NullWarden::NullSubset + class << self + # @api private + # + # source://graphql//lib/graphql/schema/warden.rb#78 + def new(query); end + end +end + # This is used when a caller provides a Hash for context. # We want to call the schema's hooks, but we don't have a full-blown warden. # The `context` arguments to these methods exist purely to simplify the code that @@ -12685,51 +13217,158 @@ end # # @api private # -# source://graphql//lib/graphql/schema/warden.rb#79 +# source://graphql//lib/graphql/schema/warden.rb#54 class GraphQL::Schema::Warden::PassThruWarden class << self # @api private # - # source://graphql//lib/graphql/schema/warden.rb#87 + # source://graphql//lib/graphql/schema/warden.rb#62 def arguments(owner, ctx); end # @api private # - # source://graphql//lib/graphql/schema/warden.rb#86 + # source://graphql//lib/graphql/schema/warden.rb#61 def interface_type_memberships(obj_t, ctx); end # @api private # @return [Boolean] # - # source://graphql//lib/graphql/schema/warden.rb#82 + # source://graphql//lib/graphql/schema/warden.rb#63 + def loadable?(type, ctx); end + + # @api private + # + # source://graphql//lib/graphql/schema/warden.rb#64 + def schema_subset; end + + # @api private + # @return [Boolean] + # + # source://graphql//lib/graphql/schema/warden.rb#57 def visible_argument?(arg, ctx); end # @api private # @return [Boolean] # - # source://graphql//lib/graphql/schema/warden.rb#84 + # source://graphql//lib/graphql/schema/warden.rb#59 def visible_enum_value?(ev, ctx); end # @api private # @return [Boolean] # - # source://graphql//lib/graphql/schema/warden.rb#81 + # source://graphql//lib/graphql/schema/warden.rb#56 def visible_field?(field, ctx); end # @api private # @return [Boolean] # - # source://graphql//lib/graphql/schema/warden.rb#83 + # source://graphql//lib/graphql/schema/warden.rb#58 def visible_type?(type, ctx); end # @api private # @return [Boolean] # - # source://graphql//lib/graphql/schema/warden.rb#85 + # source://graphql//lib/graphql/schema/warden.rb#60 def visible_type_membership?(tm, ctx); end end end +# @api private +# +# source://graphql//lib/graphql/schema/warden.rb#111 +class GraphQL::Schema::Warden::SchemaSubset + # @api private + # @return [SchemaSubset] a new instance of SchemaSubset + # + # source://graphql//lib/graphql/schema/warden.rb#112 + def initialize(warden); end + + # @api private + # + # source://graphql//lib/graphql/schema/warden.rb#164 + def all_types; end + + # @api private + # + # source://graphql//lib/graphql/schema/warden.rb#132 + def argument(owner, arg_name); end + + # @api private + # + # source://graphql//lib/graphql/schema/warden.rb#148 + def arguments(owner); end + + # @api private + # @return [Boolean] + # + # source://graphql//lib/graphql/schema/warden.rb#120 + def directive_exists?(dir_name); end + + # @api private + # + # source://graphql//lib/graphql/schema/warden.rb#116 + def directives; end + + # @api private + # + # source://graphql//lib/graphql/schema/warden.rb#160 + def enum_values(enum_type); end + + # @api private + # + # source://graphql//lib/graphql/schema/warden.rb#128 + def field(owner, field_name); end + + # @api private + # + # source://graphql//lib/graphql/schema/warden.rb#152 + def fields(owner); end + + # @api private + # + # source://graphql//lib/graphql/schema/warden.rb#168 + def interfaces(obj_type); end + + # TODO remove ctx here? + # + # @api private + # @return [Boolean] + # + # source://graphql//lib/graphql/schema/warden.rb#172 + def loadable?(t, ctx); end + + # @api private + # + # source://graphql//lib/graphql/schema/warden.rb#140 + def mutation_root; end + + # @api private + # + # source://graphql//lib/graphql/schema/warden.rb#156 + def possible_types(type); end + + # @api private + # + # source://graphql//lib/graphql/schema/warden.rb#136 + def query_root; end + + # @api private + # @return [Boolean] + # + # source://graphql//lib/graphql/schema/warden.rb#176 + def reachable_type?(type_name); end + + # @api private + # + # source://graphql//lib/graphql/schema/warden.rb#144 + def subscription_root; end + + # @api private + # + # source://graphql//lib/graphql/schema/warden.rb#124 + def type(name); end +end + # source://graphql//lib/graphql/schema/wrapper.rb#5 class GraphQL::Schema::Wrapper include ::GraphQL::Schema::Member::TypeSystemHelpers @@ -12756,7 +13395,7 @@ module GraphQL::StaticValidation; end # Default rules for {GraphQL::StaticValidation::Validator} # -# Order is important here. Some validators return {GraphQL::Language::Visitor::SKIP} +# Order is important here. Some validators skip later hooks. # which stops the visit on that node. That way it doesn't try to find fields on types that # don't exist, etc. # @@ -12896,7 +13535,7 @@ class GraphQL::StaticValidation::ArgumentsAreDefinedError < ::GraphQL::StaticVal end # source://graphql//lib/graphql/static_validation/base_visitor.rb#4 -class GraphQL::StaticValidation::BaseVisitor < ::GraphQL::Language::Visitor +class GraphQL::StaticValidation::BaseVisitor < ::GraphQL::Language::StaticVisitor # @return [BaseVisitor] a new instance of BaseVisitor # # source://graphql//lib/graphql/static_validation/base_visitor.rb#5 @@ -12904,22 +13543,22 @@ class GraphQL::StaticValidation::BaseVisitor < ::GraphQL::Language::Visitor # Returns the value of attribute context. # - # source://graphql//lib/graphql/static_validation/base_visitor.rb#17 + # source://graphql//lib/graphql/static_validation/base_visitor.rb#18 def context; end # @return [Array] Types whose scope we've entered # - # source://graphql//lib/graphql/static_validation/base_visitor.rb#20 + # source://graphql//lib/graphql/static_validation/base_visitor.rb#21 def object_types; end # @return [Array] The nesting of the current position in the AST # - # source://graphql//lib/graphql/static_validation/base_visitor.rb#23 + # source://graphql//lib/graphql/static_validation/base_visitor.rb#24 def path; end private - # source://graphql//lib/graphql/static_validation/base_visitor.rb#190 + # source://graphql//lib/graphql/static_validation/base_visitor.rb#191 def add_error(error, path: T.unsafe(nil)); end class << self @@ -12929,70 +13568,70 @@ class GraphQL::StaticValidation::BaseVisitor < ::GraphQL::Language::Visitor # @param rules [Array] # @return [Class] A class for validating `rules` during visitation # - # source://graphql//lib/graphql/static_validation/base_visitor.rb#31 + # source://graphql//lib/graphql/static_validation/base_visitor.rb#32 def including_rules(rules); end end end -# source://graphql//lib/graphql/static_validation/base_visitor.rb#54 +# source://graphql//lib/graphql/static_validation/base_visitor.rb#55 module GraphQL::StaticValidation::BaseVisitor::ContextMethods # @return [GraphQL::Argument, nil] The most-recently-entered GraphQL::Argument, if currently inside one # - # source://graphql//lib/graphql/static_validation/base_visitor.rb#163 + # source://graphql//lib/graphql/static_validation/base_visitor.rb#164 def argument_definition; end # @return [GraphQL::Directive, nil] The most-recently-entered GraphQL::Directive, if currently inside one # - # source://graphql//lib/graphql/static_validation/base_visitor.rb#158 + # source://graphql//lib/graphql/static_validation/base_visitor.rb#159 def directive_definition; end # @return [GraphQL::Field, nil] The most-recently-entered GraphQL::Field, if currently inside one # - # source://graphql//lib/graphql/static_validation/base_visitor.rb#153 + # source://graphql//lib/graphql/static_validation/base_visitor.rb#154 def field_definition; end - # source://graphql//lib/graphql/static_validation/base_visitor.rb#102 + # source://graphql//lib/graphql/static_validation/base_visitor.rb#103 def on_argument(node, parent); end - # source://graphql//lib/graphql/static_validation/base_visitor.rb#95 + # source://graphql//lib/graphql/static_validation/base_visitor.rb#96 def on_directive(node, parent); end - # source://graphql//lib/graphql/static_validation/base_visitor.rb#78 + # source://graphql//lib/graphql/static_validation/base_visitor.rb#79 def on_field(node, parent); end - # source://graphql//lib/graphql/static_validation/base_visitor.rb#64 + # source://graphql//lib/graphql/static_validation/base_visitor.rb#65 def on_fragment_definition(node, parent); end - # source://graphql//lib/graphql/static_validation/base_visitor.rb#125 + # source://graphql//lib/graphql/static_validation/base_visitor.rb#126 def on_fragment_spread(node, parent); end - # source://graphql//lib/graphql/static_validation/base_visitor.rb#71 + # source://graphql//lib/graphql/static_validation/base_visitor.rb#72 def on_inline_fragment(node, parent); end - # source://graphql//lib/graphql/static_validation/base_visitor.rb#131 + # source://graphql//lib/graphql/static_validation/base_visitor.rb#132 def on_input_object(node, parent); end - # source://graphql//lib/graphql/static_validation/base_visitor.rb#55 + # source://graphql//lib/graphql/static_validation/base_visitor.rb#56 def on_operation_definition(node, parent); end # @return [GraphQL::BaseType] The type which the current type came from # - # source://graphql//lib/graphql/static_validation/base_visitor.rb#148 + # source://graphql//lib/graphql/static_validation/base_visitor.rb#149 def parent_type_definition; end # @return [GraphQL::BaseType] The current object type # - # source://graphql//lib/graphql/static_validation/base_visitor.rb#143 + # source://graphql//lib/graphql/static_validation/base_visitor.rb#144 def type_definition; end private # @yield [node] # - # source://graphql//lib/graphql/static_validation/base_visitor.rb#171 + # source://graphql//lib/graphql/static_validation/base_visitor.rb#172 def on_fragment_with_type(node); end - # source://graphql//lib/graphql/static_validation/base_visitor.rb#183 + # source://graphql//lib/graphql/static_validation/base_visitor.rb#184 def push_type(t); end end @@ -13104,7 +13743,7 @@ module GraphQL::StaticValidation::DirectivesAreDefined # source://graphql//lib/graphql/static_validation/rules/directives_are_defined.rb#5 def initialize(*_arg0); end - # source://graphql//lib/graphql/static_validation/rules/directives_are_defined.rb#10 + # source://graphql//lib/graphql/static_validation/rules/directives_are_defined.rb#9 def on_directive(node, parent); end end @@ -13359,7 +13998,7 @@ module GraphQL::StaticValidation::FieldsWillMerge def find_fields_and_fragments(selections, owner_type:, parents:, fields:, fragment_spreads:); end # Given two list of parents, find out if they are mutually exclusive - # In this context, `parents` represends the "self scope" of the field, + # In this context, `parents` represents the "self scope" of the field, # what types may be found at this point in the query. # # @return [Boolean] @@ -13870,7 +14509,7 @@ class GraphQL::StaticValidation::LiteralValidator # source://graphql//lib/graphql/static_validation/literal_validator.rb#97 def constant_scalar?(ast_value); end - # source://graphql//lib/graphql/static_validation/literal_validator.rb#144 + # source://graphql//lib/graphql/static_validation/literal_validator.rb#143 def ensure_array(value); end # When `error_bubbling` is false, we want to bail on the first failure that we find. @@ -13879,10 +14518,10 @@ class GraphQL::StaticValidation::LiteralValidator # source://graphql//lib/graphql/static_validation/literal_validator.rb#86 def maybe_raise_if_invalid(ast_value); end - # source://graphql//lib/graphql/static_validation/literal_validator.rb#148 + # source://graphql//lib/graphql/static_validation/literal_validator.rb#147 def merge_results(results_list); end - # source://graphql//lib/graphql/static_validation/literal_validator.rb#133 + # source://graphql//lib/graphql/static_validation/literal_validator.rb#132 def present_input_field_values_are_valid(type, ast_node); end # source://graphql//lib/graphql/static_validation/literal_validator.rb#34 @@ -14145,275 +14784,52 @@ class GraphQL::StaticValidation::RequiredInputObjectAttributesArePresentError < # source://graphql//lib/graphql/static_validation/rules/required_input_object_attributes_are_present_error.rb#9 def initialize(message, path:, nodes:, argument_type:, argument_name:, input_object_type:); end - # Returns the value of attribute argument_name. - # - # source://graphql//lib/graphql/static_validation/rules/required_input_object_attributes_are_present_error.rb#6 - def argument_name; end - - # Returns the value of attribute argument_type. - # - # source://graphql//lib/graphql/static_validation/rules/required_input_object_attributes_are_present_error.rb#5 - def argument_type; end - - # source://graphql//lib/graphql/static_validation/rules/required_input_object_attributes_are_present_error.rb#30 - def code; end - - # Returns the value of attribute input_object_type. - # - # source://graphql//lib/graphql/static_validation/rules/required_input_object_attributes_are_present_error.rb#7 - def input_object_type; end - - # A hash representation of this Message - # - # source://graphql//lib/graphql/static_validation/rules/required_input_object_attributes_are_present_error.rb#17 - def to_h; end -end - -# source://graphql//lib/graphql/static_validation/rules/subscription_root_exists.rb#4 -module GraphQL::StaticValidation::SubscriptionRootExists - # source://graphql//lib/graphql/static_validation/rules/subscription_root_exists.rb#5 - def on_operation_definition(node, _parent); end -end - -# source://graphql//lib/graphql/static_validation/rules/subscription_root_exists_error.rb#4 -class GraphQL::StaticValidation::SubscriptionRootExistsError < ::GraphQL::StaticValidation::Error - # @return [SubscriptionRootExistsError] a new instance of SubscriptionRootExistsError - # - # source://graphql//lib/graphql/static_validation/rules/subscription_root_exists_error.rb#6 - def initialize(message, path: T.unsafe(nil), nodes: T.unsafe(nil)); end - - # source://graphql//lib/graphql/static_validation/rules/subscription_root_exists_error.rb#21 - def code; end - - # A hash representation of this Message - # - # source://graphql//lib/graphql/static_validation/rules/subscription_root_exists_error.rb#11 - def to_h; end -end - -# - Ride along with `GraphQL::Language::Visitor` -# - Track type info, expose it to validators -# -# source://graphql//lib/graphql/static_validation/type_stack.rb#6 -class GraphQL::StaticValidation::TypeStack - # @param schema [GraphQL::Schema] the schema whose types to use when climbing this document - # @param visitor [GraphQL::Language::Visitor] a visitor to follow & watch the types - # @return [TypeStack] a new instance of TypeStack - # - # source://graphql//lib/graphql/static_validation/type_stack.rb#38 - def initialize(schema, visitor); end - - # @return [Array] arguments which have been entered - # - # source://graphql//lib/graphql/static_validation/type_stack.rb#31 - def argument_definitions; end - - # Directives are pushed on, then popped off while traversing the tree - # - # @return [Array] directives which have been entered - # - # source://graphql//lib/graphql/static_validation/type_stack.rb#28 - def directive_definitions; end - - # When it enters a field, it's pushed on this stack (useful for nested fields, args). - # When it exits, it's popped off. - # - # @return [Array] fields which have been entered - # - # source://graphql//lib/graphql/static_validation/type_stack.rb#24 - def field_definitions; end - - # When it enters an object (starting with query or mutation root), it's pushed on this stack. - # When it exits, it's popped off. - # - # @return [Array] - # - # source://graphql//lib/graphql/static_validation/type_stack.rb#19 - def object_types; end - - # @return [Array] fields which have been entered (by their AST name) - # - # source://graphql//lib/graphql/static_validation/type_stack.rb#34 - def path; end - - # @return [GraphQL::Schema] the schema whose types are present in this document - # - # source://graphql//lib/graphql/static_validation/type_stack.rb#14 - def schema; end -end - -# source://graphql//lib/graphql/static_validation/type_stack.rb#142 -module GraphQL::StaticValidation::TypeStack::ArgumentStrategy - private - - # source://graphql//lib/graphql/static_validation/type_stack.rb#166 - def pop(stack, node); end - - # Push `argument_defn` onto the stack. - # It's possible that `argument_defn` will be nil. - # Push it anyways so `pop` has something to pop. - # - # source://graphql//lib/graphql/static_validation/type_stack.rb#147 - def push(stack, node); end - - class << self - # source://graphql//lib/graphql/static_validation/type_stack.rb#166 - def pop(stack, node); end - - # Push `argument_defn` onto the stack. - # It's possible that `argument_defn` will be nil. - # Push it anyways so `pop` has something to pop. - # - # source://graphql//lib/graphql/static_validation/type_stack.rb#147 - def push(stack, node); end - end -end - -# source://graphql//lib/graphql/static_validation/type_stack.rb#130 -module GraphQL::StaticValidation::TypeStack::DirectiveStrategy - private - - # source://graphql//lib/graphql/static_validation/type_stack.rb#137 - def pop(stack, node); end - - # source://graphql//lib/graphql/static_validation/type_stack.rb#132 - def push(stack, node); end - - class << self - # source://graphql//lib/graphql/static_validation/type_stack.rb#137 - def pop(stack, node); end - - # source://graphql//lib/graphql/static_validation/type_stack.rb#132 - def push(stack, node); end - end -end - -# source://graphql//lib/graphql/static_validation/type_stack.rb#193 -class GraphQL::StaticValidation::TypeStack::EnterWithStrategy - # @return [EnterWithStrategy] a new instance of EnterWithStrategy - # - # source://graphql//lib/graphql/static_validation/type_stack.rb#194 - def initialize(stack, strategy); end - - # source://graphql//lib/graphql/static_validation/type_stack.rb#199 - def call(node, parent); end -end - -# source://graphql//lib/graphql/static_validation/type_stack.rb#106 -module GraphQL::StaticValidation::TypeStack::FieldStrategy - private - - # source://graphql//lib/graphql/static_validation/type_stack.rb#123 - def pop(stack, node); end - - # source://graphql//lib/graphql/static_validation/type_stack.rb#108 - def push(stack, node); end - - class << self - # source://graphql//lib/graphql/static_validation/type_stack.rb#123 - def pop(stack, node); end - - # source://graphql//lib/graphql/static_validation/type_stack.rb#108 - def push(stack, node); end - end -end - -# source://graphql//lib/graphql/static_validation/type_stack.rb#75 -module GraphQL::StaticValidation::TypeStack::FragmentDefinitionStrategy - extend ::GraphQL::StaticValidation::TypeStack::FragmentWithTypeStrategy - - private - - # source://graphql//lib/graphql/static_validation/type_stack.rb#78 - def push_path_member(stack, node); end - - class << self - # source://graphql//lib/graphql/static_validation/type_stack.rb#78 - def push_path_member(stack, node); end - end -end - -# source://graphql//lib/graphql/static_validation/type_stack.rb#172 -module GraphQL::StaticValidation::TypeStack::FragmentSpreadStrategy - private - - # source://graphql//lib/graphql/static_validation/type_stack.rb#178 - def pop(stack, node); end - - # source://graphql//lib/graphql/static_validation/type_stack.rb#174 - def push(stack, node); end - - class << self - # source://graphql//lib/graphql/static_validation/type_stack.rb#178 - def pop(stack, node); end - - # source://graphql//lib/graphql/static_validation/type_stack.rb#174 - def push(stack, node); end - end -end - -# source://graphql//lib/graphql/static_validation/type_stack.rb#55 -module GraphQL::StaticValidation::TypeStack::FragmentWithTypeStrategy - # source://graphql//lib/graphql/static_validation/type_stack.rb#69 - def pop(stack, node); end - - # source://graphql//lib/graphql/static_validation/type_stack.rb#56 - def push(stack, node); end -end - -# source://graphql//lib/graphql/static_validation/type_stack.rb#83 -module GraphQL::StaticValidation::TypeStack::InlineFragmentStrategy - extend ::GraphQL::StaticValidation::TypeStack::FragmentWithTypeStrategy - - private + # Returns the value of attribute argument_name. + # + # source://graphql//lib/graphql/static_validation/rules/required_input_object_attributes_are_present_error.rb#6 + def argument_name; end - # source://graphql//lib/graphql/static_validation/type_stack.rb#86 - def push_path_member(stack, node); end + # Returns the value of attribute argument_type. + # + # source://graphql//lib/graphql/static_validation/rules/required_input_object_attributes_are_present_error.rb#5 + def argument_type; end - class << self - # source://graphql//lib/graphql/static_validation/type_stack.rb#86 - def push_path_member(stack, node); end - end -end + # source://graphql//lib/graphql/static_validation/rules/required_input_object_attributes_are_present_error.rb#30 + def code; end -# source://graphql//lib/graphql/static_validation/type_stack.rb#204 -class GraphQL::StaticValidation::TypeStack::LeaveWithStrategy - # @return [LeaveWithStrategy] a new instance of LeaveWithStrategy + # Returns the value of attribute input_object_type. # - # source://graphql//lib/graphql/static_validation/type_stack.rb#205 - def initialize(stack, strategy); end + # source://graphql//lib/graphql/static_validation/rules/required_input_object_attributes_are_present_error.rb#7 + def input_object_type; end - # source://graphql//lib/graphql/static_validation/type_stack.rb#210 - def call(node, parent); end + # A hash representation of this Message + # + # source://graphql//lib/graphql/static_validation/rules/required_input_object_attributes_are_present_error.rb#17 + def to_h; end end -# source://graphql//lib/graphql/static_validation/type_stack.rb#91 -module GraphQL::StaticValidation::TypeStack::OperationDefinitionStrategy - private - - # source://graphql//lib/graphql/static_validation/type_stack.rb#100 - def pop(stack, node); end +# source://graphql//lib/graphql/static_validation/rules/subscription_root_exists.rb#4 +module GraphQL::StaticValidation::SubscriptionRootExists + # source://graphql//lib/graphql/static_validation/rules/subscription_root_exists.rb#5 + def on_operation_definition(node, _parent); end +end - # source://graphql//lib/graphql/static_validation/type_stack.rb#93 - def push(stack, node); end +# source://graphql//lib/graphql/static_validation/rules/subscription_root_exists_error.rb#4 +class GraphQL::StaticValidation::SubscriptionRootExistsError < ::GraphQL::StaticValidation::Error + # @return [SubscriptionRootExistsError] a new instance of SubscriptionRootExistsError + # + # source://graphql//lib/graphql/static_validation/rules/subscription_root_exists_error.rb#6 + def initialize(message, path: T.unsafe(nil), nodes: T.unsafe(nil)); end - class << self - # source://graphql//lib/graphql/static_validation/type_stack.rb#100 - def pop(stack, node); end + # source://graphql//lib/graphql/static_validation/rules/subscription_root_exists_error.rb#21 + def code; end - # source://graphql//lib/graphql/static_validation/type_stack.rb#93 - def push(stack, node); end - end + # A hash representation of this Message + # + # source://graphql//lib/graphql/static_validation/rules/subscription_root_exists_error.rb#11 + def to_h; end end -# source://graphql//lib/graphql/static_validation/type_stack.rb#183 -GraphQL::StaticValidation::TypeStack::PUSH_STRATEGIES = T.let(T.unsafe(nil), Hash) - -# These are jumping-off points for infering types down the tree -# -# source://graphql//lib/graphql/static_validation/type_stack.rb#8 -GraphQL::StaticValidation::TypeStack::TYPE_INFERRENCE_ROOTS = T.let(T.unsafe(nil), Array) - # source://graphql//lib/graphql/static_validation/rules/unique_directives_per_location.rb#4 module GraphQL::StaticValidation::UniqueDirectivesPerLocation # source://graphql//lib/graphql/static_validation/rules/unique_directives_per_location.rb#23 @@ -14496,16 +14912,13 @@ end # # It holds a list of errors which each validator may add to. # -# It also provides limited access to the {TypeStack} instance, -# which tracks state as you climb in and out of different fields. -# -# source://graphql//lib/graphql/static_validation/validation_context.rb#14 +# source://graphql//lib/graphql/static_validation/validation_context.rb#11 class GraphQL::StaticValidation::ValidationContext extend ::Forwardable # @return [ValidationContext] a new instance of ValidationContext # - # source://graphql//lib/graphql/static_validation/validation_context.rb#23 + # source://graphql//lib/graphql/static_validation/validation_context.rb#21 def initialize(query, visitor_class, max_errors); end # source://forwardable/1.3.3/forwardable.rb#231 @@ -14522,7 +14935,7 @@ class GraphQL::StaticValidation::ValidationContext # Returns the value of attribute errors. # - # source://graphql//lib/graphql/static_validation/validation_context.rb#17 + # source://graphql//lib/graphql/static_validation/validation_context.rb#14 def errors; end # source://forwardable/1.3.3/forwardable.rb#231 @@ -14533,7 +14946,7 @@ class GraphQL::StaticValidation::ValidationContext # Returns the value of attribute max_errors. # - # source://graphql//lib/graphql/static_validation/validation_context.rb#17 + # source://graphql//lib/graphql/static_validation/validation_context.rb#14 def max_errors; end # source://forwardable/1.3.3/forwardable.rb#231 @@ -14544,7 +14957,7 @@ class GraphQL::StaticValidation::ValidationContext # Returns the value of attribute on_dependency_resolve_handlers. # - # source://graphql//lib/graphql/static_validation/validation_context.rb#17 + # source://graphql//lib/graphql/static_validation/validation_context.rb#14 def on_dependency_resolve_handlers; end # source://forwardable/1.3.3/forwardable.rb#231 @@ -14558,11 +14971,13 @@ class GraphQL::StaticValidation::ValidationContext # Returns the value of attribute query. # - # source://graphql//lib/graphql/static_validation/validation_context.rb#17 + # source://graphql//lib/graphql/static_validation/validation_context.rb#14 def query; end - # source://forwardable/1.3.3/forwardable.rb#231 - def schema(*args, **_arg1, &block); end + # Returns the value of attribute schema. + # + # source://graphql//lib/graphql/static_validation/validation_context.rb#14 + def schema; end # source://graphql//lib/graphql/static_validation/validation_context.rb#48 def schema_directives; end @@ -14575,16 +14990,18 @@ class GraphQL::StaticValidation::ValidationContext # source://forwardable/1.3.3/forwardable.rb#231 def type_definition(*args, **_arg1, &block); end + # Returns the value of attribute types. + # + # source://graphql//lib/graphql/static_validation/validation_context.rb#14 + def types; end + # source://graphql//lib/graphql/static_validation/validation_context.rb#40 def validate_literal(ast_value, type); end # Returns the value of attribute visitor. # - # source://graphql//lib/graphql/static_validation/validation_context.rb#17 + # source://graphql//lib/graphql/static_validation/validation_context.rb#14 def visitor; end - - # source://forwardable/1.3.3/forwardable.rb#231 - def warden(*args, **_arg1, &block); end end # source://graphql//lib/graphql/static_validation/validation_timeout_error.rb#4 @@ -14626,7 +15043,7 @@ class GraphQL::StaticValidation::Validator # @param query [GraphQL::Query] # @param context [GraphQL::StaticValidation::ValidationContext] # - # source://graphql//lib/graphql/static_validation/validator.rb#67 + # source://graphql//lib/graphql/static_validation/validator.rb#70 def handle_timeout(query, context); end # Validate `query` against the schema. Returns an array of message hashes. @@ -14988,22 +15405,22 @@ class GraphQL::Subscriptions # @param validate_update [Boolean] If false, then validation is skipped when executing updates # @return [Subscriptions] a new instance of Subscriptions # - # source://graphql//lib/graphql/subscriptions.rb#43 + # source://graphql//lib/graphql/subscriptions.rb#40 def initialize(schema:, validate_update: T.unsafe(nil), broadcast: T.unsafe(nil), default_broadcastable: T.unsafe(nil), **rest); end # @return [Boolean] if true, then a query like this one would be broadcasted # - # source://graphql//lib/graphql/subscriptions.rb#231 + # source://graphql//lib/graphql/subscriptions.rb#233 def broadcastable?(query_str, **query_options); end # @return [String] A new unique identifier for a subscription # - # source://graphql//lib/graphql/subscriptions.rb#214 + # source://graphql//lib/graphql/subscriptions.rb#216 def build_id; end # @return [Boolean] Used when fields don't have `broadcastable:` explicitly set # - # source://graphql//lib/graphql/subscriptions.rb#53 + # source://graphql//lib/graphql/subscriptions.rb#50 def default_broadcastable; end # A subscription was terminated server-side. @@ -15013,7 +15430,7 @@ class GraphQL::Subscriptions # @raise [GraphQL::RequiredImplementationMissingError] # @return void. # - # source://graphql//lib/graphql/subscriptions.rb#209 + # source://graphql//lib/graphql/subscriptions.rb#211 def delete_subscription(subscription_id); end # A subscription query was re-evaluated, returning `result`. @@ -15024,7 +15441,7 @@ class GraphQL::Subscriptions # @raise [GraphQL::RequiredImplementationMissingError] # @return [void] # - # source://graphql//lib/graphql/subscriptions.rb#192 + # source://graphql//lib/graphql/subscriptions.rb#194 def deliver(subscription_id, result); end # Run the update query for this subscription and deliver it @@ -15033,7 +15450,7 @@ class GraphQL::Subscriptions # @see {#execute_update} # @see {#deliver} # - # source://graphql//lib/graphql/subscriptions.rb#163 + # source://graphql//lib/graphql/subscriptions.rb#158 def execute(subscription_id, event, object); end # Event `event` occurred on `object`, @@ -15044,7 +15461,7 @@ class GraphQL::Subscriptions # @raise [GraphQL::RequiredImplementationMissingError] # @return [void] # - # source://graphql//lib/graphql/subscriptions.rb#175 + # source://graphql//lib/graphql/subscriptions.rb#177 def execute_all(event, object); end # `event` was triggered on `object`, and `subscription_id` was subscribed, @@ -15057,7 +15474,7 @@ class GraphQL::Subscriptions # @param object [Object] The value for the subscription field # @return [GraphQL::Query::Result] # - # source://graphql//lib/graphql/subscriptions.rb#107 + # source://graphql//lib/graphql/subscriptions.rb#104 def execute_update(subscription_id, event, object); end # Convert a user-provided event name or argument @@ -15069,7 +15486,7 @@ class GraphQL::Subscriptions # @param event_or_arg_name [String, Symbol] # @return [String] # - # source://graphql//lib/graphql/subscriptions.rb#226 + # source://graphql//lib/graphql/subscriptions.rb#228 def normalize_name(event_or_arg_name); end # The system wants to send an update to this subscription. @@ -15079,7 +15496,7 @@ class GraphQL::Subscriptions # @raise [GraphQL::RequiredImplementationMissingError] # @return [Hash] Containing required keys # - # source://graphql//lib/graphql/subscriptions.rb#183 + # source://graphql//lib/graphql/subscriptions.rb#185 def read_subscription(subscription_id); end # Fetch subscriptions matching this field + arguments pair @@ -15092,7 +15509,7 @@ class GraphQL::Subscriptions # @param context [Hash] # @return [void] # - # source://graphql//lib/graphql/subscriptions.rb#63 + # source://graphql//lib/graphql/subscriptions.rb#60 def trigger(event_name, args, object, scope: T.unsafe(nil), context: T.unsafe(nil)); end # Define this method to customize whether to validate @@ -15100,7 +15517,7 @@ class GraphQL::Subscriptions # # @return [Boolean] defaults to `true`, or false if `validate: false` is provided. # - # source://graphql//lib/graphql/subscriptions.rb#155 + # source://graphql//lib/graphql/subscriptions.rb#150 def validate_update?(query:, context:, root_value:, subscription_topic:, operation_name:, variables:); end # `query` was executed and found subscriptions to `events`. @@ -15111,7 +15528,7 @@ class GraphQL::Subscriptions # @raise [GraphQL::RequiredImplementationMissingError] # @return [void] # - # source://graphql//lib/graphql/subscriptions.rb#201 + # source://graphql//lib/graphql/subscriptions.rb#203 def write_subscription(query, events); end private @@ -15124,13 +15541,13 @@ class GraphQL::Subscriptions # @param args [Hash, Array, Any] some GraphQL input value to coerce as `arg_owner` # @return [Any] normalized arguments value # - # source://graphql//lib/graphql/subscriptions.rb#248 + # source://graphql//lib/graphql/subscriptions.rb#250 def normalize_arguments(event_name, arg_owner, args, context); end class << self # @see {Subscriptions#initialize} for options, concrete implementations may add options. # - # source://graphql//lib/graphql/subscriptions.rb#26 + # source://graphql//lib/graphql/subscriptions.rb#25 def use(defn, options = T.unsafe(nil)); end end end @@ -15168,7 +15585,7 @@ end # } # # result = MySchema.execute( -# query: query, +# query, # context: context, # variables: variables, # operation_name: operation_name @@ -15225,7 +15642,7 @@ class GraphQL::Subscriptions::ActionCableSubscriptions < ::GraphQL::Subscription # The channel was closed, forget about it. # - # source://graphql//lib/graphql/subscriptions/action_cable_subscriptions.rb#223 + # source://graphql//lib/graphql/subscriptions/action_cable_subscriptions.rb#224 def delete_subscription(subscription_id); end # This subscription was re-evaluated. @@ -15246,12 +15663,12 @@ class GraphQL::Subscriptions::ActionCableSubscriptions < ::GraphQL::Subscription # @param message [String] n ActionCable-broadcasted string (JSON) # @param context [GraphQL::Query::Context] the context of the first event for a given subscription fingerprint # - # source://graphql//lib/graphql/subscriptions/action_cable_subscriptions.rb#196 + # source://graphql//lib/graphql/subscriptions/action_cable_subscriptions.rb#197 def load_action_cable_message(message, context); end # Return the query from "storage" (in memory) # - # source://graphql//lib/graphql/subscriptions/action_cable_subscriptions.rb#205 + # source://graphql//lib/graphql/subscriptions/action_cable_subscriptions.rb#206 def read_subscription(subscription_id); end # Every subscribing channel is listening here, but only one of them takes any action. @@ -15265,7 +15682,7 @@ class GraphQL::Subscriptions::ActionCableSubscriptions < ::GraphQL::Subscription # let the listener belonging to the first event on the list be # the one to build and publish payloads. # - # source://graphql//lib/graphql/subscriptions/action_cable_subscriptions.rb#166 + # source://graphql//lib/graphql/subscriptions/action_cable_subscriptions.rb#167 def setup_stream(channel, initial_event); end # A query was run where these events were subscribed to. @@ -15273,15 +15690,15 @@ class GraphQL::Subscriptions::ActionCableSubscriptions < ::GraphQL::Subscription # It will receive notifications when events come in # and re-evaluate the query locally. # - # source://graphql//lib/graphql/subscriptions/action_cable_subscriptions.rb#135 + # source://graphql//lib/graphql/subscriptions/action_cable_subscriptions.rb#136 def write_subscription(query, events); end private - # source://graphql//lib/graphql/subscriptions/action_cable_subscriptions.rb#248 + # source://graphql//lib/graphql/subscriptions/action_cable_subscriptions.rb#249 def stream_event_name(event); end - # source://graphql//lib/graphql/subscriptions/action_cable_subscriptions.rb#244 + # source://graphql//lib/graphql/subscriptions/action_cable_subscriptions.rb#245 def stream_subscription_name(subscription_id); end end @@ -15301,7 +15718,7 @@ GraphQL::Subscriptions::ActionCableSubscriptions::SUBSCRIPTION_PREFIX = T.let(T. # @see Subscriptions#broadcastable? for a public API # # source://graphql//lib/graphql/subscriptions/broadcast_analyzer.rb#12 -class GraphQL::Subscriptions::BroadcastAnalyzer < ::GraphQL::Analysis::AST::Analyzer +class GraphQL::Subscriptions::BroadcastAnalyzer < ::GraphQL::Analysis::Analyzer # @api private # @return [BroadcastAnalyzer] a new instance of BroadcastAnalyzer # @@ -15327,7 +15744,7 @@ class GraphQL::Subscriptions::BroadcastAnalyzer < ::GraphQL::Analysis::AST::Anal # @api private # @return [void] # - # source://graphql//lib/graphql/subscriptions/broadcast_analyzer.rb#50 + # source://graphql//lib/graphql/subscriptions/broadcast_analyzer.rb#49 def result; end private @@ -15336,8 +15753,8 @@ class GraphQL::Subscriptions::BroadcastAnalyzer < ::GraphQL::Analysis::AST::Anal # # @api private # - # source://graphql//lib/graphql/subscriptions/broadcast_analyzer.rb#58 - def apply_broadcastable(field_defn); end + # source://graphql//lib/graphql/subscriptions/broadcast_analyzer.rb#57 + def apply_broadcastable(owner_type, field_defn); end end # source://graphql//lib/graphql/subscriptions/default_subscription_resolve_extension.rb#4 @@ -15412,7 +15829,7 @@ class GraphQL::Subscriptions::Event # source://graphql//lib/graphql/subscriptions/event.rb#68 def deep_sort_hash_keys(hash_to_sort); end - # source://graphql//lib/graphql/subscriptions/event.rb#133 + # source://graphql//lib/graphql/subscriptions/event.rb#139 def get_arg_definition(arg_owner, arg_name, context); end # source://graphql//lib/graphql/subscriptions/event.rb#94 @@ -15420,33 +15837,11 @@ class GraphQL::Subscriptions::Event end end -# Wrap the root fields of the subscription type with special logic for: -# - Registering the subscription during the first execution -# - Evaluating the triggered portion(s) of the subscription during later execution -# -# source://graphql//lib/graphql/subscriptions/instrumentation.rb#7 -class GraphQL::Subscriptions::Instrumentation - # @return [Instrumentation] a new instance of Instrumentation - # - # source://graphql//lib/graphql/subscriptions/instrumentation.rb#8 - def initialize(schema:); end - - # After checking the root fields, pass the gathered events to the store - # - # source://graphql//lib/graphql/subscriptions/instrumentation.rb#20 - def after_query(query); end - - # If needed, prepare to gather events which this query subscribes to - # - # source://graphql//lib/graphql/subscriptions/instrumentation.rb#13 - def before_query(query); end -end - # Raised when either: # - the triggered `event_name` doesn't match a field in the schema; or # - one or more arguments don't match the field arguments # -# source://graphql//lib/graphql/subscriptions.rb#15 +# source://graphql//lib/graphql/subscriptions.rb#14 class GraphQL::Subscriptions::InvalidTriggerError < ::GraphQL::Error; end # Serialization helpers for passing subscription data around. @@ -15561,9 +15956,93 @@ GraphQL::Subscriptions::Serialize::TIMESTAMP_KEY = T.let(T.unsafe(nil), String) # - Or, an update didn't pass `.trigger(..., scope:)` # When raised, the initial subscription or update fails completely. # -# source://graphql//lib/graphql/subscriptions.rb#22 +# source://graphql//lib/graphql/subscriptions.rb#21 class GraphQL::Subscriptions::SubscriptionScopeMissingError < ::GraphQL::Error; end +# source://graphql//lib/graphql/testing/helpers.rb#3 +module GraphQL::Testing; end + +# source://graphql//lib/graphql/testing/helpers.rb#4 +module GraphQL::Testing::Helpers + # source://graphql//lib/graphql/testing/helpers.rb#42 + def run_graphql_field(schema, field_path, object, arguments: T.unsafe(nil), context: T.unsafe(nil), ast_node: T.unsafe(nil), lookahead: T.unsafe(nil)); end + + # @yield [resolution_context] + # + # source://graphql//lib/graphql/testing/helpers.rb#100 + def with_resolution_context(schema, type:, object:, context: T.unsafe(nil)); end + + class << self + # @param schema_class [Class] + # @return [Module] A helpers module which always uses the given schema + # + # source://graphql//lib/graphql/testing/helpers.rb#7 + def for(schema_class); end + end +end + +# source://graphql//lib/graphql/testing/helpers.rb#11 +class GraphQL::Testing::Helpers::Error < ::GraphQL::Error; end + +# source://graphql//lib/graphql/testing/helpers.rb#35 +class GraphQL::Testing::Helpers::FieldNotDefinedError < ::GraphQL::Testing::Helpers::Error + # @return [FieldNotDefinedError] a new instance of FieldNotDefinedError + # + # source://graphql//lib/graphql/testing/helpers.rb#36 + def initialize(type_name:, field_name:); end +end + +# source://graphql//lib/graphql/testing/helpers.rb#21 +class GraphQL::Testing::Helpers::FieldNotVisibleError < ::GraphQL::Testing::Helpers::Error + # @return [FieldNotVisibleError] a new instance of FieldNotVisibleError + # + # source://graphql//lib/graphql/testing/helpers.rb#22 + def initialize(type_name:, field_name:); end +end + +# source://graphql//lib/graphql/testing/helpers.rb#111 +class GraphQL::Testing::Helpers::ResolutionAssertionContext + # @return [ResolutionAssertionContext] a new instance of ResolutionAssertionContext + # + # source://graphql//lib/graphql/testing/helpers.rb#112 + def initialize(test, type_name:, object:, schema:, context:); end + + # source://graphql//lib/graphql/testing/helpers.rb#121 + def run_graphql_field(field_name, arguments: T.unsafe(nil)); end +end + +# source://graphql//lib/graphql/testing/helpers.rb#130 +module GraphQL::Testing::Helpers::SchemaHelpers + include ::GraphQL::Testing::Helpers + + # source://graphql//lib/graphql/testing/helpers.rb#133 + def run_graphql_field(field_path, object, arguments: T.unsafe(nil), context: T.unsafe(nil)); end + + # source://graphql//lib/graphql/testing/helpers.rb#137 + def with_resolution_context(*args, **kwargs, &block); end + + class << self + # source://graphql//lib/graphql/testing/helpers.rb#142 + def for(schema_class); end + end +end + +# source://graphql//lib/graphql/testing/helpers.rb#28 +class GraphQL::Testing::Helpers::TypeNotDefinedError < ::GraphQL::Testing::Helpers::Error + # @return [TypeNotDefinedError] a new instance of TypeNotDefinedError + # + # source://graphql//lib/graphql/testing/helpers.rb#29 + def initialize(type_name:); end +end + +# source://graphql//lib/graphql/testing/helpers.rb#14 +class GraphQL::Testing::Helpers::TypeNotVisibleError < ::GraphQL::Testing::Helpers::Error + # @return [TypeNotVisibleError] a new instance of TypeNotVisibleError + # + # source://graphql//lib/graphql/testing/helpers.rb#15 + def initialize(type_name:); end +end + # source://graphql//lib/graphql/tracing/trace.rb#3 module GraphQL::Tracing; end @@ -15965,52 +16444,53 @@ end module GraphQL::Tracing::DataDogTrace include ::GraphQL::Tracing::PlatformTrace + # @param tracer [#trace] Deprecated # @param analytics_enabled [Boolean] Deprecated # @param analytics_sample_rate [Float] Deprecated # - # source://graphql//lib/graphql/tracing/data_dog_trace.rb#8 + # source://graphql//lib/graphql/tracing/data_dog_trace.rb#9 def initialize(tracer: T.unsafe(nil), analytics_enabled: T.unsafe(nil), analytics_sample_rate: T.unsafe(nil), service: T.unsafe(nil), **rest); end - # source://graphql//lib/graphql/tracing/data_dog_trace.rb#35 + # source://graphql//lib/graphql/tracing/data_dog_trace.rb#33 def analyze_multiplex(**data); end - # source://graphql//lib/graphql/tracing/data_dog_trace.rb#35 + # source://graphql//lib/graphql/tracing/data_dog_trace.rb#33 def analyze_query(**data); end - # source://graphql//lib/graphql/tracing/data_dog_trace.rb#120 + # source://graphql//lib/graphql/tracing/data_dog_trace.rb#111 def authorized(query:, type:, object:); end - # source://graphql//lib/graphql/tracing/data_dog_trace.rb#141 + # source://graphql//lib/graphql/tracing/data_dog_trace.rb#130 def authorized_lazy(object:, type:, query:); end - # source://graphql//lib/graphql/tracing/data_dog_trace.rb#126 + # source://graphql//lib/graphql/tracing/data_dog_trace.rb#117 def authorized_span(span_key, object, type, query); end - # source://graphql//lib/graphql/tracing/data_dog_trace.rb#108 + # source://graphql//lib/graphql/tracing/data_dog_trace.rb#99 def execute_field(query:, field:, ast_node:, arguments:, object:); end - # source://graphql//lib/graphql/tracing/data_dog_trace.rb#114 + # source://graphql//lib/graphql/tracing/data_dog_trace.rb#105 def execute_field_lazy(query:, field:, ast_node:, arguments:, object:); end - # source://graphql//lib/graphql/tracing/data_dog_trace.rb#79 + # source://graphql//lib/graphql/tracing/data_dog_trace.rb#72 def execute_field_span(span_key, query, field, ast_node, arguments, object); end - # source://graphql//lib/graphql/tracing/data_dog_trace.rb#35 + # source://graphql//lib/graphql/tracing/data_dog_trace.rb#33 def execute_multiplex(**data); end - # source://graphql//lib/graphql/tracing/data_dog_trace.rb#35 + # source://graphql//lib/graphql/tracing/data_dog_trace.rb#33 def execute_query(**data); end - # source://graphql//lib/graphql/tracing/data_dog_trace.rb#35 + # source://graphql//lib/graphql/tracing/data_dog_trace.rb#33 def execute_query_lazy(**data); end - # source://graphql//lib/graphql/tracing/data_dog_trace.rb#35 + # source://graphql//lib/graphql/tracing/data_dog_trace.rb#33 def lex(**data); end - # source://graphql//lib/graphql/tracing/data_dog_trace.rb#35 + # source://graphql//lib/graphql/tracing/data_dog_trace.rb#33 def parse(**data); end - # source://graphql//lib/graphql/tracing/data_dog_trace.rb#187 + # source://graphql//lib/graphql/tracing/data_dog_trace.rb#174 def platform_authorized_key(type); end # Implement this method in a subclass to apply custom tags to datadog spans @@ -16021,22 +16501,22 @@ module GraphQL::Tracing::DataDogTrace # @param data [Hash] The runtime data for this event (@see GraphQL::Tracing for keys for each event) # @param span [Datadog::Tracing::SpanOperation] The datadog span for this event # - # source://graphql//lib/graphql/tracing/data_dog_trace.rb#183 + # source://graphql//lib/graphql/tracing/data_dog_trace.rb#170 def platform_field_key(field); end - # source://graphql//lib/graphql/tracing/data_dog_trace.rb#191 + # source://graphql//lib/graphql/tracing/data_dog_trace.rb#178 def platform_resolve_type_key(type); end - # source://graphql//lib/graphql/tracing/data_dog_trace.rb#147 + # source://graphql//lib/graphql/tracing/data_dog_trace.rb#136 def resolve_type(object:, type:, query:); end - # source://graphql//lib/graphql/tracing/data_dog_trace.rb#153 + # source://graphql//lib/graphql/tracing/data_dog_trace.rb#142 def resolve_type_lazy(object:, type:, query:); end - # source://graphql//lib/graphql/tracing/data_dog_trace.rb#159 + # source://graphql//lib/graphql/tracing/data_dog_trace.rb#148 def resolve_type_span(span_key, object, type, query); end - # source://graphql//lib/graphql/tracing/data_dog_trace.rb#35 + # source://graphql//lib/graphql/tracing/data_dog_trace.rb#33 def validate(**data); end end @@ -16051,24 +16531,19 @@ end class GraphQL::Tracing::DataDogTracing < ::GraphQL::Tracing::PlatformTracing # @return [Boolean] # - # source://graphql//lib/graphql/tracing/data_dog_tracing.rb#71 - def analytics_available?; end - - # @return [Boolean] - # - # source://graphql//lib/graphql/tracing/data_dog_tracing.rb#77 + # source://graphql//lib/graphql/tracing/data_dog_tracing.rb#63 def analytics_enabled?; end - # source://graphql//lib/graphql/tracing/data_dog_tracing.rb#82 + # source://graphql//lib/graphql/tracing/data_dog_tracing.rb#68 def analytics_sample_rate; end - # source://graphql//lib/graphql/tracing/data_dog_tracing.rb#91 + # source://graphql//lib/graphql/tracing/data_dog_tracing.rb#77 def platform_authorized_key(type); end - # source://graphql//lib/graphql/tracing/data_dog_tracing.rb#87 + # source://graphql//lib/graphql/tracing/data_dog_tracing.rb#73 def platform_field_key(type, field); end - # source://graphql//lib/graphql/tracing/data_dog_tracing.rb#95 + # source://graphql//lib/graphql/tracing/data_dog_tracing.rb#81 def platform_resolve_type_key(type); end # source://graphql//lib/graphql/tracing/data_dog_tracing.rb#17 @@ -16080,16 +16555,58 @@ class GraphQL::Tracing::DataDogTracing < ::GraphQL::Tracing::PlatformTracing # @param data [Hash] The runtime data for this event (@see GraphQL::Tracing for keys for each event) # @param span [Datadog::Tracing::SpanOperation] The datadog span for this event # - # source://graphql//lib/graphql/tracing/data_dog_tracing.rb#62 + # source://graphql//lib/graphql/tracing/data_dog_tracing.rb#53 def prepare_span(key, data, span); end - # source://graphql//lib/graphql/tracing/data_dog_tracing.rb#54 - def service_name; end - - # source://graphql//lib/graphql/tracing/data_dog_tracing.rb#65 + # source://graphql//lib/graphql/tracing/data_dog_tracing.rb#56 def tracer; end end +# source://graphql//lib/graphql/tracing/legacy_hooks_trace.rb#4 +module GraphQL::Tracing::LegacyHooksTrace + # source://graphql//lib/graphql/tracing/legacy_hooks_trace.rb#5 + def execute_multiplex(multiplex:); end +end + +# source://graphql//lib/graphql/tracing/legacy_hooks_trace.rb#16 +module GraphQL::Tracing::LegacyHooksTrace::RunHooks + private + + # source://graphql//lib/graphql/tracing/legacy_hooks_trace.rb#61 + def call_after_hooks(instrumenters, object, after_hook_name, ex); end + + # Call each before hook, and if they all succeed, yield. + # If they don't all succeed, call after_ for each one that succeeded. + # + # source://graphql//lib/graphql/tracing/legacy_hooks_trace.rb#36 + def call_hooks(instrumenters, object, before_hook_name, after_hook_name); end + + # Call the before_ hooks of each query, + # Then yield if no errors. + # `call_hooks` takes care of appropriate cleanup. + # + # source://graphql//lib/graphql/tracing/legacy_hooks_trace.rb#21 + def each_query_call_hooks(instrumenters, queries, i = T.unsafe(nil)); end + + class << self + # source://graphql//lib/graphql/tracing/legacy_hooks_trace.rb#61 + def call_after_hooks(instrumenters, object, after_hook_name, ex); end + + # Call each before hook, and if they all succeed, yield. + # If they don't all succeed, call after_ for each one that succeeded. + # + # source://graphql//lib/graphql/tracing/legacy_hooks_trace.rb#36 + def call_hooks(instrumenters, object, before_hook_name, after_hook_name); end + + # Call the before_ hooks of each query, + # Then yield if no errors. + # `call_hooks` takes care of appropriate cleanup. + # + # source://graphql//lib/graphql/tracing/legacy_hooks_trace.rb#21 + def each_query_call_hooks(instrumenters, queries, i = T.unsafe(nil)); end + end +end + # source://graphql//lib/graphql/tracing/legacy_trace.rb#65 class GraphQL::Tracing::LegacyTrace < ::GraphQL::Tracing::Trace include ::GraphQL::Tracing::CallLegacyTracers @@ -16300,18 +16817,18 @@ GraphQL::Tracing::NotificationsTracing::KEYS = T.let(T.unsafe(nil), Hash) # source://graphql//lib/graphql/tracing/notifications_tracing.rb#28 GraphQL::Tracing::NotificationsTracing::MAX_KEYS_SIZE = T.let(T.unsafe(nil), Integer) -# source://graphql//lib/graphql/tracing.rb#33 +# source://graphql//lib/graphql/tracing.rb#35 GraphQL::Tracing::NullTrace = T.let(T.unsafe(nil), GraphQL::Tracing::Trace) -# source://graphql//lib/graphql/tracing.rb#65 +# source://graphql//lib/graphql/tracing.rb#67 module GraphQL::Tracing::NullTracer private - # source://graphql//lib/graphql/tracing.rb#67 + # source://graphql//lib/graphql/tracing.rb#69 def trace(k, v); end class << self - # source://graphql//lib/graphql/tracing.rb#67 + # source://graphql//lib/graphql/tracing.rb#69 def trace(k, v); end end end @@ -16408,17 +16925,17 @@ class GraphQL::Tracing::PlatformTracing # @param trace_phase [Symbol] The stage of execution being traced (used by OpenTelementry tracing) # @return [String] # - # source://graphql//lib/graphql/tracing/platform_tracing.rb#128 + # source://graphql//lib/graphql/tracing/platform_tracing.rb#130 def cached_platform_key(ctx, key, trace_phase); end # @api private # - # source://graphql//lib/graphql/tracing/platform_tracing.rb#108 + # source://graphql//lib/graphql/tracing/platform_tracing.rb#110 def fallback_transaction_name(context); end # @api private # - # source://graphql//lib/graphql/tracing/platform_tracing.rb#112 + # source://graphql//lib/graphql/tracing/platform_tracing.rb#114 def options; end # Get the transaction name based on the operation type and name if possible, or fall back to a user provided @@ -16426,7 +16943,7 @@ class GraphQL::Tracing::PlatformTracing # # @api private # - # source://graphql//lib/graphql/tracing/platform_tracing.rb#96 + # source://graphql//lib/graphql/tracing/platform_tracing.rb#98 def transaction_name(query); end class << self @@ -16461,10 +16978,10 @@ module GraphQL::Tracing::PrometheusTrace def initialize(client: T.unsafe(nil), keys_whitelist: T.unsafe(nil), collector_type: T.unsafe(nil), **rest); end # source://graphql//lib/graphql/tracing/prometheus_trace.rb#26 - def analyze_multiplex(**data, &block); end + def analyze_multiplex(**data); end # source://graphql//lib/graphql/tracing/prometheus_trace.rb#26 - def analyze_query(**data, &block); end + def analyze_query(**data); end # source://graphql//lib/graphql/tracing/platform_trace.rb#72 def authorized(type:, query:, object:); end @@ -16479,19 +16996,19 @@ module GraphQL::Tracing::PrometheusTrace def execute_field_lazy(query:, field:, ast_node:, arguments:, object:); end # source://graphql//lib/graphql/tracing/prometheus_trace.rb#26 - def execute_multiplex(**data, &block); end + def execute_multiplex(**data); end # source://graphql//lib/graphql/tracing/prometheus_trace.rb#26 - def execute_query(**data, &block); end + def execute_query(**data); end # source://graphql//lib/graphql/tracing/prometheus_trace.rb#26 - def execute_query_lazy(**data, &block); end + def execute_query_lazy(**data); end # source://graphql//lib/graphql/tracing/prometheus_trace.rb#26 - def lex(**data, &block); end + def lex(**data); end # source://graphql//lib/graphql/tracing/prometheus_trace.rb#26 - def parse(**data, &block); end + def parse(**data); end # source://graphql//lib/graphql/tracing/prometheus_trace.rb#41 def platform_authorized(platform_key, &block); end @@ -16527,12 +17044,12 @@ module GraphQL::Tracing::PrometheusTrace def resolve_type_lazy(query:, type:, object:); end # source://graphql//lib/graphql/tracing/prometheus_trace.rb#26 - def validate(**data, &block); end + def validate(**data); end private # source://graphql//lib/graphql/tracing/prometheus_trace.rb#71 - def instrument_execution(platform_key, key, &block); end + def instrument_prometheus_execution(platform_key, key, &block); end end # source://graphql//lib/graphql/tracing/prometheus_trace.rb#0 @@ -16684,6 +17201,102 @@ end # source://graphql//lib/graphql/tracing/scout_tracing.rb#6 GraphQL::Tracing::ScoutTracing::INSTRUMENT_OPTS = T.let(T.unsafe(nil), Hash) +# source://graphql//lib/graphql/tracing/sentry_trace.rb#5 +module GraphQL::Tracing::SentryTrace + include ::GraphQL::Tracing::PlatformTrace + + # @param set_transaction_name [Boolean] If true, the GraphQL operation name will be used as the transaction name. + # This is not advised if you run more than one query per HTTP request, for example, with `graphql-client` or multiplexing. + # It can also be specified per-query with `context[:set_sentry_transaction_name]`. + # + # source://graphql//lib/graphql/tracing/sentry_trace.rb#11 + def initialize(set_transaction_name: T.unsafe(nil), **_rest); end + + # source://graphql//lib/graphql/tracing/sentry_trace.rb#35 + def analyze_multiplex(**data); end + + # source://graphql//lib/graphql/tracing/sentry_trace.rb#35 + def analyze_query(**data); end + + # source://graphql//lib/graphql/tracing/platform_trace.rb#72 + def authorized(type:, query:, object:); end + + # source://graphql//lib/graphql/tracing/platform_trace.rb#72 + def authorized_lazy(type:, query:, object:); end + + # source://graphql//lib/graphql/tracing/platform_trace.rb#44 + def execute_field(query:, field:, ast_node:, arguments:, object:); end + + # source://graphql//lib/graphql/tracing/platform_trace.rb#44 + def execute_field_lazy(query:, field:, ast_node:, arguments:, object:); end + + # source://graphql//lib/graphql/tracing/sentry_trace.rb#35 + def execute_multiplex(**data); end + + # source://graphql//lib/graphql/tracing/sentry_trace.rb#16 + def execute_query(**data); end + + # source://graphql//lib/graphql/tracing/sentry_trace.rb#35 + def execute_query_lazy(**data); end + + # source://graphql//lib/graphql/tracing/sentry_trace.rb#35 + def lex(**data); end + + # source://graphql//lib/graphql/tracing/sentry_trace.rb#35 + def parse(**data); end + + # source://graphql//lib/graphql/tracing/sentry_trace.rb#50 + def platform_authorized(platform_key, &block); end + + # source://graphql//lib/graphql/tracing/sentry_trace.rb#70 + def platform_authorized_key(type); end + + # source://graphql//lib/graphql/tracing/sentry_trace.rb#54 + def platform_authorized_lazy(platform_key, &block); end + + # source://graphql//lib/graphql/tracing/sentry_trace.rb#42 + def platform_execute_field(platform_key, &block); end + + # source://graphql//lib/graphql/tracing/sentry_trace.rb#46 + def platform_execute_field_lazy(platform_key, &block); end + + # source://graphql//lib/graphql/tracing/sentry_trace.rb#66 + def platform_field_key(field); end + + # source://graphql//lib/graphql/tracing/sentry_trace.rb#58 + def platform_resolve_type(platform_key, &block); end + + # source://graphql//lib/graphql/tracing/sentry_trace.rb#74 + def platform_resolve_type_key(type); end + + # source://graphql//lib/graphql/tracing/sentry_trace.rb#62 + def platform_resolve_type_lazy(platform_key, &block); end + + # source://graphql//lib/graphql/tracing/platform_trace.rb#85 + def resolve_type(query:, type:, object:); end + + # source://graphql//lib/graphql/tracing/platform_trace.rb#85 + def resolve_type_lazy(query:, type:, object:); end + + # source://graphql//lib/graphql/tracing/sentry_trace.rb#35 + def validate(**data); end + + private + + # source://graphql//lib/graphql/tracing/sentry_trace.rb#80 + def instrument_sentry_execution(platform_key, trace_method, data = T.unsafe(nil), &block); end + + # source://graphql//lib/graphql/tracing/sentry_trace.rb#102 + def operation_name(query); end +end + +# source://graphql//lib/graphql/tracing/sentry_trace.rb#0 +class GraphQL::Tracing::SentryTrace::KeyCache + include ::GraphQL::Tracing::PlatformTrace + include ::GraphQL::Tracing::SentryTrace + include ::GraphQL::Tracing::PlatformTrace::BaseKeyCache +end + # source://graphql//lib/graphql/tracing/statsd_trace.rb#5 module GraphQL::Tracing::StatsdTrace include ::GraphQL::Tracing::PlatformTrace @@ -16797,46 +17410,48 @@ class GraphQL::Tracing::Trace # source://graphql//lib/graphql/tracing/trace.rb#13 def initialize(multiplex: T.unsafe(nil), query: T.unsafe(nil), **_options); end - # source://graphql//lib/graphql/tracing/trace.rb#30 + # source://graphql//lib/graphql/tracing/trace.rb#31 def analyze_multiplex(multiplex:); end - # source://graphql//lib/graphql/tracing/trace.rb#34 + # source://graphql//lib/graphql/tracing/trace.rb#35 def analyze_query(query:); end - # source://graphql//lib/graphql/tracing/trace.rb#58 + # source://graphql//lib/graphql/tracing/trace.rb#59 def authorized(query:, type:, object:); end - # source://graphql//lib/graphql/tracing/trace.rb#62 + # source://graphql//lib/graphql/tracing/trace.rb#63 def authorized_lazy(query:, type:, object:); end - # source://graphql//lib/graphql/tracing/trace.rb#50 + # source://graphql//lib/graphql/tracing/trace.rb#51 def execute_field(field:, query:, ast_node:, arguments:, object:); end - # source://graphql//lib/graphql/tracing/trace.rb#54 + # source://graphql//lib/graphql/tracing/trace.rb#55 def execute_field_lazy(field:, query:, ast_node:, arguments:, object:); end - # source://graphql//lib/graphql/tracing/trace.rb#38 + # source://graphql//lib/graphql/tracing/trace.rb#39 def execute_multiplex(multiplex:); end - # source://graphql//lib/graphql/tracing/trace.rb#42 + # source://graphql//lib/graphql/tracing/trace.rb#43 def execute_query(query:); end - # source://graphql//lib/graphql/tracing/trace.rb#46 + # source://graphql//lib/graphql/tracing/trace.rb#47 def execute_query_lazy(query:, multiplex:); end - # source://graphql//lib/graphql/tracing/trace.rb#18 + # The Ruby parser doesn't call this method (`graphql/c_parser` does.) + # + # source://graphql//lib/graphql/tracing/trace.rb#19 def lex(query_string:); end - # source://graphql//lib/graphql/tracing/trace.rb#22 + # source://graphql//lib/graphql/tracing/trace.rb#23 def parse(query_string:); end - # source://graphql//lib/graphql/tracing/trace.rb#66 + # source://graphql//lib/graphql/tracing/trace.rb#67 def resolve_type(query:, type:, object:); end - # source://graphql//lib/graphql/tracing/trace.rb#70 + # source://graphql//lib/graphql/tracing/trace.rb#71 def resolve_type_lazy(query:, type:, object:); end - # source://graphql//lib/graphql/tracing/trace.rb#26 + # source://graphql//lib/graphql/tracing/trace.rb#27 def validate(query:, validate:); end end @@ -16845,14 +17460,14 @@ end # # @api private # -# source://graphql//lib/graphql/tracing.rb#38 +# source://graphql//lib/graphql/tracing.rb#40 module GraphQL::Tracing::Traceable # @api private # @param key [String] The name of the event in GraphQL internals # @param metadata [Hash] Event-related metadata (can be anything) # @return [Object] Must return the value of the block # - # source://graphql//lib/graphql/tracing.rb#42 + # source://graphql//lib/graphql/tracing.rb#44 def trace(key, metadata, &block); end private @@ -16866,7 +17481,7 @@ module GraphQL::Tracing::Traceable # @param metadata [Object] The current event object # @return Whatever the block returns # - # source://graphql//lib/graphql/tracing.rb#56 + # source://graphql//lib/graphql/tracing.rb#58 def call_tracers(idx, key, metadata, &block); end end @@ -16983,7 +17598,7 @@ class GraphQL::TypeKinds::TypeKind # source://graphql//lib/graphql/type_kinds.rb#40 def object?; end - # Does this TypeKind have multiple possible implementors? + # Does this TypeKind have multiple possible implementers? # # @deprecated Use `abstract?` instead of `resolves?`. # @return [Boolean] @@ -17139,6 +17754,49 @@ end # source://graphql//lib/graphql/types/iso_8601_date_time.rb#24 GraphQL::Types::ISO8601DateTime::DEFAULT_TIME_PRECISION = T.let(T.unsafe(nil), Integer) +# This scalar takes `Duration`s and transmits them as strings, +# using ISO 8601 format. ActiveSupport >= 5.0 must be loaded to use +# this scalar. +# +# Use it for fields or arguments as follows: +# +# field :age, GraphQL::Types::ISO8601Duration, null: false +# +# argument :interval, GraphQL::Types::ISO8601Duration, null: false +# +# Alternatively, use this built-in scalar as inspiration for your +# own Duration type. +# +# source://graphql//lib/graphql/types/iso_8601_duration.rb#16 +class GraphQL::Types::ISO8601Duration < ::GraphQL::Schema::Scalar + class << self + # @param value [String, ActiveSupport::Duration] + # @raise [GraphQL::Error] if ActiveSupport::Duration is not defined + # @raise [GraphQL::DurationEncodingError] if duration cannot be parsed + # @return [ActiveSupport::Duration, nil] + # + # source://graphql//lib/graphql/types/iso_8601_duration.rb#57 + def coerce_input(value, ctx); end + + # @param value [ActiveSupport::Duration, String] + # @raise [GraphQL::Error] if ActiveSupport::Duration is not defined or if an incompatible object is passed + # @return [String] + # + # source://graphql//lib/graphql/types/iso_8601_duration.rb#33 + def coerce_result(value, _ctx); end + + # @return [Integer, nil] + # + # source://graphql//lib/graphql/types/iso_8601_duration.rb#20 + def seconds_precision; end + + # @param value [Integer, nil] + # + # source://graphql//lib/graphql/types/iso_8601_duration.rb#26 + def seconds_precision=(value); end + end +end + # @see {Types::BigInt} for handling integers outside 32-bit range. # # source://graphql//lib/graphql/types/int.rb#6 @@ -17271,6 +17929,11 @@ end # source://graphql//lib/graphql/types/relay/page_info_behaviors.rb#23 module GraphQL::Types::Relay::ClassMethods + # @return [Boolean] + # + # source://graphql//lib/graphql/types/relay/page_info_behaviors.rb#28 + def default_broadcastable?; end + # @return [Boolean] # # source://graphql//lib/graphql/types/relay/page_info_behaviors.rb#24 @@ -17286,11 +17949,17 @@ module GraphQL::Types::Relay::ConnectionBehaviors # source://forwardable/1.3.3/forwardable.rb#231 def cursor_from_node(*args, **_arg1, &block); end + # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#196 + def edges; end + + # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#205 + def nodes; end + # source://forwardable/1.3.3/forwardable.rb#231 def parent(*args, **_arg1, &block); end class << self - # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#169 + # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#191 def add_page_info_field(obj_type); end # @private @@ -17300,27 +17969,35 @@ module GraphQL::Types::Relay::ConnectionBehaviors end end -# source://graphql//lib/graphql/types/relay/connection_behaviors.rb#24 +# source://graphql//lib/graphql/types/relay/connection_behaviors.rb#25 module GraphQL::Types::Relay::ConnectionBehaviors::ClassMethods # @return [Boolean] # - # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#96 + # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#118 def authorized?(obj, ctx); end + # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#46 + def default_broadcastable(new_value); end + + # @return [Boolean] + # + # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#42 + def default_broadcastable?; end + # @return [Boolean] # - # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#36 + # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#38 def default_relay?; end # @return [Class] # - # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#44 + # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#54 def edge_class; end # Set the default `edge_nullable` for this class and its child classes. (Defaults to `true`.) # Use `edge_nullable(false)` in your base class to make non-null `edge` fields. # - # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#127 + # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#149 def edge_nullable(new_value = T.unsafe(nil)); end # Configure this connection to return `edges` and `nodes` based on `edge_type_class`. @@ -17336,48 +18013,53 @@ module GraphQL::Types::Relay::ConnectionBehaviors::ClassMethods # # @param field_options [Hash] Any extra keyword arguments to pass to the `field :edges, ...` and `field :nodes, ...` configurations # - # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#57 + # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#67 def edge_type(edge_type_class, edge_class: T.unsafe(nil), node_type: T.unsafe(nil), nodes_field: T.unsafe(nil), node_nullable: T.unsafe(nil), edges_nullable: T.unsafe(nil), edge_nullable: T.unsafe(nil), field_options: T.unsafe(nil)); end # Set the default `edges_nullable` for this class and its child classes. (Defaults to `true`.) # Use `edges_nullable(false)` in your base class to make non-null `edges` fields. # - # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#117 + # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#139 def edges_nullable(new_value = T.unsafe(nil)); end # Set the default `nodes_field` for this class and its child classes. (Defaults to `true`.) # Use `nodes_field(false)` in your base class to prevent adding of a nodes field. # - # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#137 + # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#159 def has_nodes_field(new_value = T.unsafe(nil)); end - # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#25 + # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#26 def inherited(child_class); end # Set the default `node_nullable` for this class and its child classes. (Defaults to `true`.) # Use `node_nullable(false)` in your base class to make non-null `node` and `nodes` fields. # - # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#107 + # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#129 def node_nullable(new_value = T.unsafe(nil)); end # @return [Class] # - # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#41 + # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#51 def node_type; end # Add the shortcut `nodes` field to this connection and its subclasses # - # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#92 + # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#114 def nodes_field(node_nullable: T.unsafe(nil), field_options: T.unsafe(nil)); end + # The connection will skip auth on its nodes if the node_type is configured for that + # + # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#101 + def reauthorize_scoped_objects(new_value = T.unsafe(nil)); end + # Filter this list according to the way its node type would scope them # - # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#87 + # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#96 def scope_items(items, context); end # @return [Boolean] # - # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#100 + # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#122 def visible?(ctx); end protected @@ -17386,26 +18068,26 @@ module GraphQL::Types::Relay::ConnectionBehaviors::ClassMethods # # @param value the value to set the attribute edge_class to. # - # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#147 + # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#169 def edge_class=(_arg0); end # Sets the attribute edge_type # # @param value the value to set the attribute edge_type to. # - # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#147 + # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#169 def edge_type=(_arg0); end # Sets the attribute node_type # # @param value the value to set the attribute node_type to. # - # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#147 + # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#169 def node_type=(_arg0); end private - # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#151 + # source://graphql//lib/graphql/types/relay/connection_behaviors.rb#173 def define_nodes_field(nullable, field_options: T.unsafe(nil)); end end @@ -17413,6 +18095,9 @@ end module GraphQL::Types::Relay::EdgeBehaviors mixes_in_class_methods ::GraphQL::Types::Relay::EdgeBehaviors::ClassMethods + # source://graphql//lib/graphql/types/relay/edge_behaviors.rb#16 + def node; end + class << self # @private # @@ -17421,25 +18106,33 @@ module GraphQL::Types::Relay::EdgeBehaviors end end -# source://graphql//lib/graphql/types/relay/edge_behaviors.rb#15 +# source://graphql//lib/graphql/types/relay/edge_behaviors.rb#23 module GraphQL::Types::Relay::EdgeBehaviors::ClassMethods # @return [Boolean] # - # source://graphql//lib/graphql/types/relay/edge_behaviors.rb#50 + # source://graphql//lib/graphql/types/relay/edge_behaviors.rb#67 def authorized?(obj, ctx); end + # source://graphql//lib/graphql/types/relay/edge_behaviors.rb#39 + def default_broadcastable(new_value); end + # @return [Boolean] # - # source://graphql//lib/graphql/types/relay/edge_behaviors.rb#22 + # source://graphql//lib/graphql/types/relay/edge_behaviors.rb#35 + def default_broadcastable?; end + + # @return [Boolean] + # + # source://graphql//lib/graphql/types/relay/edge_behaviors.rb#31 def default_relay?; end - # source://graphql//lib/graphql/types/relay/edge_behaviors.rb#16 + # source://graphql//lib/graphql/types/relay/edge_behaviors.rb#24 def inherited(child_class); end # Set the default `node_nullable` for this class and its child classes. (Defaults to `true`.) # Use `node_nullable(false)` in your base class to make non-null `node` field. # - # source://graphql//lib/graphql/types/relay/edge_behaviors.rb#60 + # source://graphql//lib/graphql/types/relay/edge_behaviors.rb#77 def node_nullable(new_value = T.unsafe(nil)); end # Get or set the Object type that this edge wraps. @@ -17448,12 +18141,12 @@ module GraphQL::Types::Relay::EdgeBehaviors::ClassMethods # @param null [Boolean] # @param field_options [Hash] Any extra arguments to pass to the `field :node` configuration # - # source://graphql//lib/graphql/types/relay/edge_behaviors.rb#31 + # source://graphql//lib/graphql/types/relay/edge_behaviors.rb#48 def node_type(node_type = T.unsafe(nil), null: T.unsafe(nil), field_options: T.unsafe(nil)); end # @return [Boolean] # - # source://graphql//lib/graphql/types/relay/edge_behaviors.rb#54 + # source://graphql//lib/graphql/types/relay/edge_behaviors.rb#71 def visible?(ctx); end protected @@ -17462,14 +18155,14 @@ module GraphQL::Types::Relay::EdgeBehaviors::ClassMethods # # @param value the value to set the attribute node_nullable to. # - # source://graphql//lib/graphql/types/relay/edge_behaviors.rb#70 + # source://graphql//lib/graphql/types/relay/edge_behaviors.rb#87 def node_nullable=(_arg0); end # Sets the attribute node_type # # @param value the value to set the attribute node_type to. # - # source://graphql//lib/graphql/types/relay/edge_behaviors.rb#70 + # source://graphql//lib/graphql/types/relay/edge_behaviors.rb#87 def node_type=(_arg0); end end @@ -17532,13 +18225,9 @@ module GraphQL::Types::Relay::Node extend ::GraphQL::Schema::Member::HasDirectives extend ::GraphQL::Schema::Member::HasInterfaces extend ::GraphQL::Schema::Interface::DefinitionMethods - extend ::GraphQL::Types::Relay::Node::DefinitionMethods extend ::GraphQL::Types::Relay::NodeBehaviors::ClassMethods end -# source://graphql//lib/graphql/types/relay/node.rb#0 -module GraphQL::Types::Relay::Node::DefinitionMethods; end - # source://graphql//lib/graphql/types/relay/node.rb#0 class GraphQL::Types::Relay::Node::UnresolvedTypeError < ::GraphQL::UnresolvedTypeError; end diff --git a/sorbet/rbi/gems/guard@2.18.0.rbi b/sorbet/rbi/gems/guard@2.18.1.rbi similarity index 100% rename from sorbet/rbi/gems/guard@2.18.0.rbi rename to sorbet/rbi/gems/guard@2.18.1.rbi diff --git a/sorbet/rbi/gems/hashdiff@1.0.1.rbi b/sorbet/rbi/gems/hashdiff@1.1.0.rbi similarity index 97% rename from sorbet/rbi/gems/hashdiff@1.0.1.rbi rename to sorbet/rbi/gems/hashdiff@1.1.0.rbi index 985f6f6ee..9f7ccabd1 100644 --- a/sorbet/rbi/gems/hashdiff@1.0.1.rbi +++ b/sorbet/rbi/gems/hashdiff@1.1.0.rbi @@ -23,6 +23,7 @@ module Hashdiff # @param obj2 [Array, Hash] # @param options [Hash] the options to use when comparing # * :strict (Boolean) [true] whether numeric values will be compared on type as well as value. Set to false to allow comparing Integer, Float, BigDecimal to each other + # * :ignore_keys (Symbol, String or Array) [[]] a list of keys to ignore. No comparison is made for the specified key(s) # * :indifferent (Boolean) [false] whether to treat hash keys indifferently. Set to true to ignore differences between symbol keys (ie. {a: 1} ~= {'a' => 1}) # * :delimiter (String) ['.'] the delimiter used when returning nested key references # * :numeric_tolerance (Numeric) [0] should be a positive numeric value. Value by which numeric differences must be greater than. By default, numeric values are compared exactly; with the :tolerance option, the difference between numeric values must be greater than the given value. @@ -34,7 +35,7 @@ module Hashdiff # @since 0.0.1 # @yield [path, value1, value2] Optional block is used to compare each value, instead of default #==. If the block returns value other than true of false, then other specified comparison options will be used to do the comparison. # - # source://hashdiff//lib/hashdiff/diff.rb#31 + # source://hashdiff//lib/hashdiff/diff.rb#32 def best_diff(obj1, obj2, options = T.unsafe(nil), &block); end # check if objects are comparable @@ -95,6 +96,7 @@ module Hashdiff # @param obj2 [Array, Hash] # @param options [Hash] the options to use when comparing # * :strict (Boolean) [true] whether numeric values will be compared on type as well as value. Set to false to allow comparing Integer, Float, BigDecimal to each other + # * :ignore_keys (Symbol, String or Array) [[]] a list of keys to ignore. No comparison is made for the specified key(s) # * :indifferent (Boolean) [false] whether to treat hash keys indifferently. Set to true to ignore differences between symbol keys (ie. {a: 1} ~= {'a' => 1}) # * :similarity (Numeric) [0.8] should be between (0, 1]. Meaningful if there are similar hashes in arrays. See {best_diff}. # * :delimiter (String) ['.'] the delimiter used when returning nested key references @@ -107,7 +109,7 @@ module Hashdiff # @since 0.0.1 # @yield [path, value1, value2] Optional block is used to compare each value, instead of default #==. If the block returns value other than true of false, then other specified comparison options will be used to do the comparison. # - # source://hashdiff//lib/hashdiff/diff.rb#78 + # source://hashdiff//lib/hashdiff/diff.rb#80 def diff(obj1, obj2, options = T.unsafe(nil), &block); end # diff array using LCS algorithm @@ -115,7 +117,7 @@ module Hashdiff # @private # @yield [links] # - # source://hashdiff//lib/hashdiff/diff.rb#119 + # source://hashdiff//lib/hashdiff/diff.rb#124 def diff_array_lcs(arraya, arrayb, options = T.unsafe(nil)); end # caculate array difference using LCS algorithm diff --git a/sorbet/rbi/gems/honeybadger@5.2.1.rbi b/sorbet/rbi/gems/honeybadger@5.15.3.rbi similarity index 69% rename from sorbet/rbi/gems/honeybadger@5.2.1.rbi rename to sorbet/rbi/gems/honeybadger@5.15.3.rbi index 0709f2bd0..8cf7c00cb 100644 --- a/sorbet/rbi/gems/honeybadger@5.2.1.rbi +++ b/sorbet/rbi/gems/honeybadger@5.15.3.rbi @@ -62,6 +62,13 @@ module Honeybadger # source://forwardable/1.3.3/forwardable.rb#231 def clear!(*args, **_arg1, &block); end + # Forwards to {Honeybadger::Agent.instance}. + # + # @see Agent#collect + # + # source://forwardable/1.3.3/forwardable.rb#231 + def collect(*args, **_arg1, &block); end + # Forwards to {Honeybadger::Agent.instance}. # # @api private @@ -84,6 +91,20 @@ module Honeybadger # source://forwardable/1.3.3/forwardable.rb#231 def context(*args, **_arg1, &block); end + # Forwards to {Honeybadger::Agent.instance}. + # + # @see Agent#decrement_counter + # + # source://forwardable/1.3.3/forwardable.rb#231 + def decrement_counter(*args, **_arg1, &block); end + + # Forwards to {Honeybadger::Agent.instance}. + # + # @see Agent#event + # + # source://forwardable/1.3.3/forwardable.rb#231 + def event(*args, **_arg1, &block); end + # Forwards to {Honeybadger::Agent.instance}. # # @see Agent#exception_filter @@ -105,6 +126,13 @@ module Honeybadger # source://forwardable/1.3.3/forwardable.rb#231 def flush(*args, **_arg1, &block); end + # Forwards to {Honeybadger::Agent.instance}. + # + # @see Agent#gauge + # + # source://forwardable/1.3.3/forwardable.rb#231 + def gauge(*args, **_arg1, &block); end + # Forwards to {Honeybadger::Agent.instance}. # # @see Agent#get_context @@ -112,6 +140,20 @@ module Honeybadger # source://forwardable/1.3.3/forwardable.rb#231 def get_context(*args, **_arg1, &block); end + # Forwards to {Honeybadger::Agent.instance}. + # + # @see Agent#histogram + # + # source://forwardable/1.3.3/forwardable.rb#231 + def histogram(*args, **_arg1, &block); end + + # Forwards to {Honeybadger::Agent.instance}. + # + # @see Agent#increment_counter + # + # source://forwardable/1.3.3/forwardable.rb#231 + def increment_counter(*args, **_arg1, &block); end + # Forwards to {Honeybadger::Agent.instance}. # # @api private @@ -122,25 +164,39 @@ module Honeybadger # @api private # - # source://honeybadger//lib/honeybadger/singleton.rb#69 + # source://honeybadger//lib/honeybadger/singleton.rb#78 def install_at_exit_callback; end + # Forwards to {Honeybadger::Agent.instance}. + # + # @see Agent#instrumentation + # + # source://forwardable/1.3.3/forwardable.rb#231 + def instrumentation(*args, **_arg1, &block); end + # @api private # - # source://honeybadger//lib/honeybadger/singleton.rb#61 + # source://honeybadger//lib/honeybadger/singleton.rb#70 def load_plugins!; end # Forwards to {Agent.instance}. # # @see Agent#notify # - # source://honeybadger//lib/honeybadger/singleton.rb#54 - def notify(exception_or_opts, opts = T.unsafe(nil)); end + # source://honeybadger//lib/honeybadger/singleton.rb#63 + def notify(exception_or_opts = T.unsafe(nil), opts = T.unsafe(nil), **kwargs); end + + # Forwards to {Honeybadger::Agent.instance}. + # + # @see Agent#registry + # + # source://forwardable/1.3.3/forwardable.rb#231 + def registry(*args, **_arg1, &block); end # @deprecated # @raise [NoMethodError] # - # source://honeybadger//lib/honeybadger/singleton.rb#80 + # source://honeybadger//lib/honeybadger/singleton.rb#89 def start(config = T.unsafe(nil)); end # Forwards to {Honeybadger::Agent.instance}. @@ -150,6 +206,13 @@ module Honeybadger # source://forwardable/1.3.3/forwardable.rb#231 def stop(*args, **_arg1, &block); end + # Forwards to {Honeybadger::Agent.instance}. + # + # @see Agent#time + # + # source://forwardable/1.3.3/forwardable.rb#231 + def time(*args, **_arg1, &block); end + # Forwards to {Honeybadger::Agent.instance}. # # @see Agent#track_deployment @@ -170,7 +233,7 @@ module Honeybadger # @api private # @return [Boolean] # - # source://honeybadger//lib/honeybadger/singleton.rb#95 + # source://honeybadger//lib/honeybadger/singleton.rb#104 def ignored_exception?(exception); end end @@ -206,14 +269,14 @@ end # OtherBadger.notify(e) # end # -# source://honeybadger//lib/honeybadger/agent.rb#44 +# source://honeybadger//lib/honeybadger/agent.rb#49 class Honeybadger::Agent include ::Honeybadger::Logging::Helper extend ::Forwardable # @return [Agent] a new instance of Agent # - # source://honeybadger//lib/honeybadger/agent.rb#59 + # source://honeybadger//lib/honeybadger/agent.rb#64 def initialize(opts = T.unsafe(nil)); end # Appends a breadcrumb to the trace. Use this when you want to add some @@ -231,7 +294,7 @@ class Honeybadger::Agent # @param params [Hash] extra options for breadcrumb building # @return self # - # source://honeybadger//lib/honeybadger/agent.rb#310 + # source://honeybadger//lib/honeybadger/agent.rb#318 def add_breadcrumb(message, metadata: T.unsafe(nil), category: T.unsafe(nil)); end # @api private @@ -258,7 +321,7 @@ class Honeybadger::Agent # # @api private # - # source://honeybadger//lib/honeybadger/agent.rb#284 + # source://honeybadger//lib/honeybadger/agent.rb#292 def breadcrumbs; end # Perform a synchronous check_in. @@ -269,17 +332,22 @@ class Honeybadger::Agent # @return [Boolean] true if the check in was successful and false # otherwise. # - # source://honeybadger//lib/honeybadger/agent.rb#193 + # source://honeybadger//lib/honeybadger/agent.rb#199 def check_in(id); end # Clear all transaction scoped data. # - # source://honeybadger//lib/honeybadger/agent.rb#266 + # source://honeybadger//lib/honeybadger/agent.rb#274 def clear!; end # @api private # - # source://honeybadger//lib/honeybadger/agent.rb#368 + # source://honeybadger//lib/honeybadger/agent.rb#425 + def collect(collector); end + + # @api private + # + # source://honeybadger//lib/honeybadger/agent.rb#441 def config; end # Configure the Honeybadger agent via Ruby. @@ -324,10 +392,37 @@ class Honeybadger::Agent # the return value of that method will be used (explicit conversion). Can # include any key/value, but a few keys have a special meaning in # Honeybadger. - # @return [self] so that method calls can be chained. + # @return [Object, self] value of the block if passed, otherwise self + # + # source://honeybadger//lib/honeybadger/agent.rb#266 + def context(context = T.unsafe(nil), &block); end + + # @api private + # @see Honeybadger::Instrumentation#decrement_counter + # + # source://forwardable/1.3.3/forwardable.rb#231 + def decrement_counter(*args, **_arg1, &block); end + + # Sends event to events backend # - # source://honeybadger//lib/honeybadger/agent.rb#260 - def context(context = T.unsafe(nil)); end + # @example + # # With event type as first argument (recommended): + # Honeybadger.event("user_signed_up", user_id: 123) + # + # # With just a payload: + # Honeybadger.event(event_type: "user_signed_up", user_id: 123) + # @param event_name [String, Hash] a String describing the event or a Hash + # when the second argument is omitted. + # @param payload [Hash] Additional data to be sent with the event as keyword arguments + # @return [void] + # + # source://honeybadger//lib/honeybadger/agent.rb#393 + def event(event_type, payload = T.unsafe(nil)); end + + # @api private + # + # source://honeybadger//lib/honeybadger/agent.rb#514 + def events_worker; end # DEPRECATED: Callback to ignore exceptions. # @@ -391,9 +486,15 @@ class Honeybadger::Agent # @yield An optional block to execute (exceptions will propagate after # data is flushed). # - # source://honeybadger//lib/honeybadger/agent.rb#351 + # source://honeybadger//lib/honeybadger/agent.rb#359 def flush; end + # @api private + # @see Honeybadger::Instrumentation#gauge + # + # source://forwardable/1.3.3/forwardable.rb#231 + def gauge(*args, **_arg1, &block); end + # Get global context for the current request. # # @example @@ -401,15 +502,35 @@ class Honeybadger::Agent # Honeybadger.get_context # => {my_data: 'my value'} # @return [Hash, nil] # - # source://honeybadger//lib/honeybadger/agent.rb#278 + # source://honeybadger//lib/honeybadger/agent.rb#286 def get_context; end + # @api private + # @see Honeybadger::Instrumentation#histogram + # + # source://forwardable/1.3.3/forwardable.rb#231 + def histogram(*args, **_arg1, &block); end + + # @api private + # @see Honeybadger::Instrumentation#increment_counter + # + # source://forwardable/1.3.3/forwardable.rb#231 + def increment_counter(*args, **_arg1, &block); end + # @api private # @see Config#init! # # source://forwardable/1.3.3/forwardable.rb#231 def init!(*args, **_arg1, &block); end + # source://honeybadger//lib/honeybadger/agent.rb#551 + def instrumentation; end + + # @api private + # + # source://honeybadger//lib/honeybadger/agent.rb#514 + def metrics_worker; end + # Sends an exception to Honeybadger. Does not report ignored exceptions by # default. # @@ -424,10 +545,10 @@ class Honeybadger::Agent # end # # # Custom notification: - # Honeybadger.notify('Something went wrong.', { + # Honeybadger.notify('Something went wrong.', # error_class: 'MyClass', # context: {my_data: 'value'} - # }) # => '06220c5a-b471-41e5-baeb-de247da45a56' + # ) # => '06220c5a-b471-41e5-baeb-de247da45a56' # @option opts # @option opts # @option opts @@ -446,20 +567,32 @@ class Honeybadger::Agent # or a Hash of options which is used to build the notice. All other types # of objects will be converted to a String and used as the :error_message. # @param opts [Hash] The options Hash when the first argument is an Exception. + # @param kwargs [Hash] options as keyword args. # @return [String] UUID reference to the notice within Honeybadger. # @return [false] when ignored. # - # source://honeybadger//lib/honeybadger/agent.rb#121 - def notify(exception_or_opts, opts = T.unsafe(nil)); end + # source://honeybadger//lib/honeybadger/agent.rb#127 + def notify(exception_or_opts = T.unsafe(nil), opts = T.unsafe(nil), **kwargs); end + + # @api private + # + # source://honeybadger//lib/honeybadger/agent.rb#433 + def registry; end # Stops the Honeybadger service. # # @example # Honeybadger.stop # => nil # - # source://honeybadger//lib/honeybadger/agent.rb#362 + # source://honeybadger//lib/honeybadger/agent.rb#372 def stop(force = T.unsafe(nil)); end + # @api private + # @see Honeybadger::Instrumentation#time + # + # source://forwardable/1.3.3/forwardable.rb#231 + def time(*args, **_arg1, &block); end + # Track a new deployment # # @example @@ -471,50 +604,56 @@ class Honeybadger::Agent # @return [Boolean] true if the deployment was successfully tracked and false # otherwise. # - # source://honeybadger//lib/honeybadger/agent.rb#212 + # source://honeybadger//lib/honeybadger/agent.rb#218 def track_deployment(environment: T.unsafe(nil), revision: T.unsafe(nil), local_username: T.unsafe(nil), repository: T.unsafe(nil)); end # @api private # - # source://honeybadger//lib/honeybadger/agent.rb#431 + # source://honeybadger//lib/honeybadger/agent.rb#504 def with_rack_env(rack_env, &block); end # @api private # - # source://honeybadger//lib/honeybadger/agent.rb#439 + # source://honeybadger//lib/honeybadger/agent.rb#514 def worker; end private - # source://honeybadger//lib/honeybadger/agent.rb#461 + # source://honeybadger//lib/honeybadger/agent.rb#565 def context_manager; end - # source://honeybadger//lib/honeybadger/agent.rb#476 + # source://honeybadger//lib/honeybadger/agent.rb#585 + def init_events_worker; end + + # source://honeybadger//lib/honeybadger/agent.rb#590 + def init_metrics_worker; end + + # source://honeybadger//lib/honeybadger/agent.rb#580 def init_worker; end - # source://honeybadger//lib/honeybadger/agent.rb#466 + # source://honeybadger//lib/honeybadger/agent.rb#570 def push(object); end - # source://honeybadger//lib/honeybadger/agent.rb#471 + # source://honeybadger//lib/honeybadger/agent.rb#575 def send_now(object); end # @raise [ArgumentError] # - # source://honeybadger//lib/honeybadger/agent.rb#453 + # source://honeybadger//lib/honeybadger/agent.rb#557 def validate_notify_opts!(opts); end - # source://honeybadger//lib/honeybadger/agent.rb#480 + # source://honeybadger//lib/honeybadger/agent.rb#595 def with_error_handling; end class << self # @api private # - # source://honeybadger//lib/honeybadger/agent.rb#50 + # source://honeybadger//lib/honeybadger/agent.rb#55 def instance; end # @api private # - # source://honeybadger//lib/honeybadger/agent.rb#55 + # source://honeybadger//lib/honeybadger/agent.rb#60 def instance=(instance); end end end @@ -548,14 +687,14 @@ end # source://honeybadger//lib/honeybadger/backend.rb#12 class Honeybadger::Backend::BackendError < ::StandardError; end -# source://honeybadger//lib/honeybadger/backend/base.rb#70 +# source://honeybadger//lib/honeybadger/backend/base.rb#71 class Honeybadger::Backend::Base include ::Honeybadger::Logging::Helper extend ::Forwardable # @return [Base] a new instance of Base # - # source://honeybadger//lib/honeybadger/backend/base.rb#75 + # source://honeybadger//lib/honeybadger/backend/base.rb#76 def initialize(config); end # Does a check in using the input id. @@ -563,9 +702,19 @@ class Honeybadger::Backend::Base # @param id [String] The unique check_in id. # @raise NotImplementedError # - # source://honeybadger//lib/honeybadger/backend/base.rb#98 + # source://honeybadger//lib/honeybadger/backend/base.rb#99 def check_in(id); end + # Send event + # + # @example + # backend.event([{event_type: "email_received", ts: "2023-03-04T12:12:00+1:00", subject: 'Re: Aquisition' }}) + # @param payload [Array] array of event hashes to send + # @raise NotImplementedError + # + # source://honeybadger//lib/honeybadger/backend/base.rb#118 + def event(payload); end + # Process payload for feature. # # @example @@ -575,7 +724,7 @@ class Honeybadger::Backend::Base # @param payload [#to_json] The JSON payload to send. # @raise NotImplementedError # - # source://honeybadger//lib/honeybadger/backend/base.rb#89 + # source://honeybadger//lib/honeybadger/backend/base.rb#90 def notify(feature, payload); end # Track a deployment @@ -584,14 +733,14 @@ class Honeybadger::Backend::Base # backend.track_deployment({ revision: 'be2ceb6' }) # @param payload [#to_json] The JSON payload containing all deployment data. # - # source://honeybadger//lib/honeybadger/backend/base.rb#107 + # source://honeybadger//lib/honeybadger/backend/base.rb#108 def track_deployment(payload); end private # Returns the value of attribute config. # - # source://honeybadger//lib/honeybadger/backend/base.rb#113 + # source://honeybadger//lib/honeybadger/backend/base.rb#124 def config; end end @@ -604,6 +753,9 @@ class Honeybadger::Backend::Debug < ::Honeybadger::Backend::Null # source://honeybadger//lib/honeybadger/backend/debug.rb#15 def check_in(id); end + # source://honeybadger//lib/honeybadger/backend/debug.rb#21 + def event(payload); end + # source://honeybadger//lib/honeybadger/backend/debug.rb#9 def notify(feature, payload); end end @@ -618,6 +770,9 @@ class Honeybadger::Backend::Null < ::Honeybadger::Backend::Base # source://honeybadger//lib/honeybadger/backend/null.rb#24 def check_in(id); end + # source://honeybadger//lib/honeybadger/backend/null.rb#28 + def event(payload); end + # source://honeybadger//lib/honeybadger/backend/null.rb#20 def notify(feature, payload); end end @@ -643,7 +798,7 @@ class Honeybadger::Backend::Response # @overload initialize # @return [Response] a new instance of Response # - # source://honeybadger//lib/honeybadger/backend/base.rb#35 + # source://honeybadger//lib/honeybadger/backend/base.rb#36 def initialize(*args); end # Returns the value of attribute body. @@ -661,7 +816,7 @@ class Honeybadger::Backend::Response # source://honeybadger//lib/honeybadger/backend/base.rb#12 def error; end - # source://honeybadger//lib/honeybadger/backend/base.rb#50 + # source://honeybadger//lib/honeybadger/backend/base.rb#51 def error_message; end # Returns the value of attribute message. @@ -671,12 +826,12 @@ class Honeybadger::Backend::Response # @return [Boolean] # - # source://honeybadger//lib/honeybadger/backend/base.rb#46 + # source://honeybadger//lib/honeybadger/backend/base.rb#47 def success?; end private - # source://honeybadger//lib/honeybadger/backend/base.rb#61 + # source://honeybadger//lib/honeybadger/backend/base.rb#62 def parse_error(body); end end @@ -690,7 +845,7 @@ Honeybadger::Backend::Response::NOT_BLANK = T.let(T.unsafe(nil), Regexp) class Honeybadger::Backend::Server < ::Honeybadger::Backend::Base # @return [Server] a new instance of Server # - # source://honeybadger//lib/honeybadger/backend/server.rb#22 + # source://honeybadger//lib/honeybadger/backend/server.rb#21 def initialize(config); end # Does a check in using the input id. @@ -698,45 +853,61 @@ class Honeybadger::Backend::Server < ::Honeybadger::Backend::Base # @param id [String] The unique check_in id. # @return [Response] # - # source://honeybadger//lib/honeybadger/backend/server.rb#45 + # source://honeybadger//lib/honeybadger/backend/server.rb#44 def check_in(id); end + # Send event + # + # @example + # backend.event([{event_type: "email_received", ts: "2023-03-04T12:12:00+1:00", subject: 'Re: Aquisition' }}) + # @param payload [Array] array of event hashes to send + # @return [Response] + # + # source://honeybadger//lib/honeybadger/backend/server.rb#56 + def event(payload); end + # Post payload to endpoint for feature. # # @param feature [Symbol] The feature which is being notified. # @param payload [#to_json] The JSON payload to send. # @return [Response] # - # source://honeybadger//lib/honeybadger/backend/server.rb#33 + # source://honeybadger//lib/honeybadger/backend/server.rb#32 def notify(feature, payload); end private - # source://honeybadger//lib/honeybadger/backend/server.rb#53 + # source://honeybadger//lib/honeybadger/backend/server.rb#64 def payload_headers(payload); end end -# source://honeybadger//lib/honeybadger/backend/server.rb#17 +# source://honeybadger//lib/honeybadger/backend/server.rb#16 Honeybadger::Backend::Server::CHECK_IN_ENDPOINT = T.let(T.unsafe(nil), String) # source://honeybadger//lib/honeybadger/backend/server.rb#12 Honeybadger::Backend::Server::ENDPOINTS = T.let(T.unsafe(nil), Hash) -# source://honeybadger//lib/honeybadger/backend/server.rb#20 +# source://honeybadger//lib/honeybadger/backend/server.rb#17 +Honeybadger::Backend::Server::EVENTS_ENDPOINT = T.let(T.unsafe(nil), String) + +# source://honeybadger//lib/honeybadger/backend/server.rb#19 Honeybadger::Backend::Server::HTTP_ERRORS = T.let(T.unsafe(nil), Array) # source://honeybadger//lib/honeybadger/backend/test.rb#5 class Honeybadger::Backend::Test < ::Honeybadger::Backend::Null - # source://honeybadger//lib/honeybadger/backend/test.rb#40 + # source://honeybadger//lib/honeybadger/backend/test.rb#55 def check_in(id); end - # source://honeybadger//lib/honeybadger/backend/test.rb#31 + # source://honeybadger//lib/honeybadger/backend/test.rb#41 def check_ins; end - # source://honeybadger//lib/honeybadger/backend/test.rb#27 + # source://honeybadger//lib/honeybadger/backend/test.rb#50 + def event(payload); end + + # source://honeybadger//lib/honeybadger/backend/test.rb#37 def notifications; end - # source://honeybadger//lib/honeybadger/backend/test.rb#35 + # source://honeybadger//lib/honeybadger/backend/test.rb#45 def notify(feature, payload); end class << self @@ -747,9 +918,18 @@ class Honeybadger::Backend::Test < ::Honeybadger::Backend::Null # Test.check_ins # => ["foobar", "danny", ...] # @return [Array] List of check ins. # - # source://honeybadger//lib/honeybadger/backend/test.rb#23 + # source://honeybadger//lib/honeybadger/backend/test.rb#33 def check_ins; end + # The event list. + # + # @example + # Test.events # => [{}, {}, ...] + # @return [Array] List of event payloads. + # + # source://honeybadger//lib/honeybadger/backend/test.rb#22 + def events; end + # The notification list. # # @example @@ -1229,22 +1409,22 @@ class Honeybadger::Config # @api private # - # source://honeybadger//lib/honeybadger/config.rb#113 + # source://honeybadger//lib/honeybadger/config.rb#117 def [](key); end # @api private # - # source://honeybadger//lib/honeybadger/config.rb#125 + # source://honeybadger//lib/honeybadger/config.rb#129 def []=(key, value); end # @api private # - # source://honeybadger//lib/honeybadger/config.rb#150 + # source://honeybadger//lib/honeybadger/config.rb#154 def backend; end # @api private # - # source://honeybadger//lib/honeybadger/config.rb#155 + # source://honeybadger//lib/honeybadger/config.rb#159 def backend=(backend); end # @api private @@ -1252,6 +1432,11 @@ class Honeybadger::Config # source://honeybadger//lib/honeybadger/config.rb#82 def backtrace_filter(&block); end + # @api private + # + # source://honeybadger//lib/honeybadger/config.rb#95 + def before_event_hooks; end + # @api private # # source://honeybadger//lib/honeybadger/config.rb#91 @@ -1259,9 +1444,20 @@ class Honeybadger::Config # @api private # - # source://honeybadger//lib/honeybadger/config.rb#191 + # source://honeybadger//lib/honeybadger/config.rb#213 def ca_bundle_path; end + # @api private + # @return [Boolean] + # + # source://honeybadger//lib/honeybadger/config.rb#295 + def cluster_collection?(name); end + + # @api private + # + # source://honeybadger//lib/honeybadger/config.rb#301 + def collection_interval(name); end + # @api private # @yield [new_ruby] # @@ -1270,29 +1466,29 @@ class Honeybadger::Config # @api private # - # source://honeybadger//lib/honeybadger/config.rb#205 + # source://honeybadger//lib/honeybadger/config.rb#227 def connection_port; end # @api private # - # source://honeybadger//lib/honeybadger/config.rb#215 + # source://honeybadger//lib/honeybadger/config.rb#237 def connection_protocol; end # @api private # @return [Boolean] # - # source://honeybadger//lib/honeybadger/config.rb#174 + # source://honeybadger//lib/honeybadger/config.rb#178 def debug?; end # @api private # - # source://honeybadger//lib/honeybadger/config.rb#267 + # source://honeybadger//lib/honeybadger/config.rb#322 def detected_framework; end # @api private # @return [Boolean] # - # source://honeybadger//lib/honeybadger/config.rb#160 + # source://honeybadger//lib/honeybadger/config.rb#164 def dev?; end # @api private @@ -1307,17 +1503,32 @@ class Honeybadger::Config # @api private # - # source://honeybadger//lib/honeybadger/config.rb#95 + # source://honeybadger//lib/honeybadger/config.rb#253 + def events_batch_size; end + + # @api private + # + # source://honeybadger//lib/honeybadger/config.rb#249 + def events_max_queue_size; end + + # @api private + # + # source://honeybadger//lib/honeybadger/config.rb#257 + def events_timeout; end + + # @api private + # + # source://honeybadger//lib/honeybadger/config.rb#99 def exception_filter(&block); end # @api private # - # source://honeybadger//lib/honeybadger/config.rb#104 + # source://honeybadger//lib/honeybadger/config.rb#108 def exception_fingerprint(&block); end # @api private # - # source://honeybadger//lib/honeybadger/config.rb#231 + # source://honeybadger//lib/honeybadger/config.rb#265 def excluded_request_keys; end # @api private @@ -1332,19 +1543,24 @@ class Honeybadger::Config # @api private # - # source://honeybadger//lib/honeybadger/config.rb#283 + # source://honeybadger//lib/honeybadger/config.rb#338 def framework_name; end # @api private # - # source://honeybadger//lib/honeybadger/config.rb#113 + # source://honeybadger//lib/honeybadger/config.rb#117 def get(key); end # @api private # - # source://honeybadger//lib/honeybadger/config.rb#183 + # source://honeybadger//lib/honeybadger/config.rb#187 def ignored_classes; end + # @api private + # + # source://honeybadger//lib/honeybadger/config.rb#203 + def ignored_events; end + # Called by framework (see lib/honeybadger/init/) at the point of # initialization. This is not required for the notifier to work (i.e. with # `require 'honeybadger/ruby'`). @@ -1354,6 +1570,12 @@ class Honeybadger::Config # source://honeybadger//lib/honeybadger/config.rb#52 def init!(opts = T.unsafe(nil), env = T.unsafe(nil)); end + # @api private + # @return [Boolean] + # + # source://honeybadger//lib/honeybadger/config.rb#291 + def insights_enabled?; end + # @api private # # source://honeybadger//lib/honeybadger/config.rb#64 @@ -1362,49 +1584,60 @@ class Honeybadger::Config # @api private # @return [Boolean] # - # source://honeybadger//lib/honeybadger/config.rb#251 + # source://honeybadger//lib/honeybadger/config.rb#285 def load_plugin?(name); end + # @api private + # @return [Boolean] + # + # source://honeybadger//lib/honeybadger/config.rb#306 + def load_plugin_insights?(name); end + # @api private # - # source://honeybadger//lib/honeybadger/config.rb#201 + # source://honeybadger//lib/honeybadger/config.rb#223 def local_cert_path; end # @api private # @return [Boolean] # - # source://honeybadger//lib/honeybadger/config.rb#178 + # source://honeybadger//lib/honeybadger/config.rb#182 def log_debug?; end # @api private # - # source://honeybadger//lib/honeybadger/config.rb#240 + # source://honeybadger//lib/honeybadger/config.rb#274 def log_level(key = T.unsafe(nil)); end # @api private # - # source://honeybadger//lib/honeybadger/config.rb#145 + # source://honeybadger//lib/honeybadger/config.rb#149 def logger; end # @api private # - # source://honeybadger//lib/honeybadger/config.rb#223 + # source://honeybadger//lib/honeybadger/config.rb#245 def max_queue_size; end # @api private # - # source://honeybadger//lib/honeybadger/config.rb#227 + # source://honeybadger//lib/honeybadger/config.rb#261 def params_filters; end # @api private # @return [Boolean] # - # source://honeybadger//lib/honeybadger/config.rb#168 + # source://honeybadger//lib/honeybadger/config.rb#172 def public?; end # @api private # - # source://honeybadger//lib/honeybadger/config.rb#257 + # source://honeybadger//lib/honeybadger/config.rb#195 + def raw_ignored_events; end + + # @api private + # + # source://honeybadger//lib/honeybadger/config.rb#312 def root_regexp; end # @api private @@ -1419,23 +1652,23 @@ class Honeybadger::Config # @api private # - # source://honeybadger//lib/honeybadger/config.rb#125 + # source://honeybadger//lib/honeybadger/config.rb#129 def set(key, value); end # @api private # - # source://honeybadger//lib/honeybadger/config.rb#131 + # source://honeybadger//lib/honeybadger/config.rb#135 def to_h(defaults = T.unsafe(nil)); end # @api private # - # source://honeybadger//lib/honeybadger/config.rb#131 + # source://honeybadger//lib/honeybadger/config.rb#135 def to_hash(defaults = T.unsafe(nil)); end # @api private # @return [Boolean] # - # source://honeybadger//lib/honeybadger/config.rb#164 + # source://honeybadger//lib/honeybadger/config.rb#168 def warn_development?; end # @api private @@ -1452,82 +1685,91 @@ class Honeybadger::Config # @api private # - # source://honeybadger//lib/honeybadger/config.rb#349 + # source://honeybadger//lib/honeybadger/config.rb#404 def build_file_logger(path); end # @api private # - # source://honeybadger//lib/honeybadger/config.rb#360 + # source://honeybadger//lib/honeybadger/config.rb#415 def build_logger; end # @api private # - # source://honeybadger//lib/honeybadger/config.rb#340 + # source://honeybadger//lib/honeybadger/config.rb#395 def build_stdout_logger; end # @api private # - # source://honeybadger//lib/honeybadger/config.rb#307 + # source://honeybadger//lib/honeybadger/config.rb#362 def config_path; end # @api private # - # source://honeybadger//lib/honeybadger/config.rb#311 + # source://honeybadger//lib/honeybadger/config.rb#366 def config_paths; end # @api private # - # source://honeybadger//lib/honeybadger/config.rb#317 + # source://honeybadger//lib/honeybadger/config.rb#372 def default_backend; end # @api private # - # source://honeybadger//lib/honeybadger/config.rb#296 + # source://honeybadger//lib/honeybadger/config.rb#351 def detect_revision!; end + # Converts a nested hash into a single layer where keys become arrays: + # ex: > flat_hash({ :nested => { :hash => "value" }}) + # > { [:nested, :hash] => "value" } + # + # @api private + # + # source://honeybadger//lib/honeybadger/config.rb#474 + def flat_hash(h, f = T.unsafe(nil), g = T.unsafe(nil)); end + # Takes an Array and a value and returns true if the value exists in the # array in String or Symbol form, otherwise false. # # @api private # @return [Boolean] # - # source://honeybadger//lib/honeybadger/config.rb#381 + # source://honeybadger//lib/honeybadger/config.rb#436 def includes_token?(obj, value); end # @api private # - # source://honeybadger//lib/honeybadger/config.rb#322 + # source://honeybadger//lib/honeybadger/config.rb#377 def init_backend!; end # @api private # - # source://honeybadger//lib/honeybadger/config.rb#375 + # source://honeybadger//lib/honeybadger/config.rb#430 def init_logging!; end # @api private # - # source://honeybadger//lib/honeybadger/config.rb#395 + # source://honeybadger//lib/honeybadger/config.rb#450 def load_config_from_disk; end # @api private # - # source://honeybadger//lib/honeybadger/config.rb#386 + # source://honeybadger//lib/honeybadger/config.rb#441 def locate_absolute_path(path, root); end # @api private # - # source://honeybadger//lib/honeybadger/config.rb#301 + # source://honeybadger//lib/honeybadger/config.rb#356 def log_path; end # @api private # @return [Boolean] # - # source://honeybadger//lib/honeybadger/config.rb#356 + # source://honeybadger//lib/honeybadger/config.rb#411 def log_stdout?; end # @api private # - # source://honeybadger//lib/honeybadger/config.rb#403 + # source://honeybadger//lib/honeybadger/config.rb#458 def undotify_keys(hash); end end @@ -1539,13 +1781,13 @@ class Honeybadger::Config::Boolean; end # source://honeybadger//lib/honeybadger/config.rb#24 class Honeybadger::Config::ConfigError < ::StandardError; end -# source://honeybadger//lib/honeybadger/config/defaults.rb#334 +# source://honeybadger//lib/honeybadger/config/defaults.rb#420 Honeybadger::Config::DEFAULTS = T.let(T.unsafe(nil), Hash) -# source://honeybadger//lib/honeybadger/config/defaults.rb#36 +# source://honeybadger//lib/honeybadger/config/defaults.rb#42 Honeybadger::Config::DEFAULT_PATHS = T.let(T.unsafe(nil), Array) -# source://honeybadger//lib/honeybadger/config/defaults.rb#34 +# source://honeybadger//lib/honeybadger/config/defaults.rb#40 Honeybadger::Config::DEVELOPMENT_ENVIRONMENTS = T.let(T.unsafe(nil), Array) # @api private @@ -1579,6 +1821,9 @@ Honeybadger::Config::Env::IGNORED_TYPES = T.let(T.unsafe(nil), Set) # source://honeybadger//lib/honeybadger/config/defaults.rb#8 Honeybadger::Config::IGNORE_DEFAULT = T.let(T.unsafe(nil), Array) +# source://honeybadger//lib/honeybadger/config/defaults.rb#34 +Honeybadger::Config::IGNORE_EVENTS_DEFAULT = T.let(T.unsafe(nil), Array) + # @api private # # source://honeybadger//lib/honeybadger/config.rb#38 @@ -1609,12 +1854,12 @@ class Honeybadger::Config::Mash # source://honeybadger//lib/honeybadger/config/ruby.rb#19 def config; end - # source://honeybadger//lib/honeybadger/config/ruby.rb#60 + # source://honeybadger//lib/honeybadger/config/ruby.rb#65 def get(key); end # @return [Boolean] # - # source://honeybadger//lib/honeybadger/config/ruby.rb#49 + # source://honeybadger//lib/honeybadger/config/ruby.rb#54 def getter?(method_name); end # Returns the value of attribute hash. @@ -1622,12 +1867,12 @@ class Honeybadger::Config::Mash # source://honeybadger//lib/honeybadger/config/ruby.rb#19 def hash; end - # source://honeybadger//lib/honeybadger/config/ruby.rb#54 + # source://honeybadger//lib/honeybadger/config/ruby.rb#59 def key(method_name); end # @return [Boolean] # - # source://honeybadger//lib/honeybadger/config/ruby.rb#38 + # source://honeybadger//lib/honeybadger/config/ruby.rb#43 def mash?(method); end # source://honeybadger//lib/honeybadger/config/ruby.rb#21 @@ -1645,7 +1890,7 @@ class Honeybadger::Config::Mash # @return [Boolean] # - # source://honeybadger//lib/honeybadger/config/ruby.rb#43 + # source://honeybadger//lib/honeybadger/config/ruby.rb#48 def setter?(method_name); end end @@ -1657,39 +1902,42 @@ Honeybadger::Config::Mash::KEYS = T.let(T.unsafe(nil), Array) # source://honeybadger//lib/honeybadger/config.rb#36 Honeybadger::Config::NOT_BLANK = T.let(T.unsafe(nil), Regexp) -# source://honeybadger//lib/honeybadger/config/defaults.rb#38 +# source://honeybadger//lib/honeybadger/config/defaults.rb#44 Honeybadger::Config::OPTIONS = T.let(T.unsafe(nil), Hash) -# source://honeybadger//lib/honeybadger/config/ruby.rb#67 +# source://honeybadger//lib/honeybadger/config/ruby.rb#72 class Honeybadger::Config::Ruby < ::Honeybadger::Config::Mash - # source://honeybadger//lib/honeybadger/config/ruby.rb#80 + # source://honeybadger//lib/honeybadger/config/ruby.rb#85 def backend; end - # source://honeybadger//lib/honeybadger/config/ruby.rb#76 + # source://honeybadger//lib/honeybadger/config/ruby.rb#81 def backend=(backend); end - # source://honeybadger//lib/honeybadger/config/ruby.rb#96 + # source://honeybadger//lib/honeybadger/config/ruby.rb#113 def backtrace_filter(&block); end - # source://honeybadger//lib/honeybadger/config/ruby.rb#84 + # source://honeybadger//lib/honeybadger/config/ruby.rb#101 + def before_event(action = T.unsafe(nil), &block); end + + # source://honeybadger//lib/honeybadger/config/ruby.rb#89 def before_notify(action = T.unsafe(nil), &block); end - # source://honeybadger//lib/honeybadger/config/ruby.rb#105 + # source://honeybadger//lib/honeybadger/config/ruby.rb#122 def exception_filter(&block); end - # source://honeybadger//lib/honeybadger/config/ruby.rb#114 + # source://honeybadger//lib/honeybadger/config/ruby.rb#131 def exception_fingerprint(&block); end - # source://honeybadger//lib/honeybadger/config/ruby.rb#72 + # source://honeybadger//lib/honeybadger/config/ruby.rb#77 def logger; end - # source://honeybadger//lib/honeybadger/config/ruby.rb#68 + # source://honeybadger//lib/honeybadger/config/ruby.rb#73 def logger=(logger); end private - # source://honeybadger//lib/honeybadger/config/ruby.rb#125 - def validate_before_action(action); end + # source://honeybadger//lib/honeybadger/config/ruby.rb#142 + def validate_before_action(action, type); end end # source://honeybadger//lib/honeybadger/config/yaml.rb#7 @@ -1728,51 +1976,71 @@ class Honeybadger::ContextManager # @api private # - # source://honeybadger//lib/honeybadger/context_manager.rb#31 + # source://honeybadger//lib/honeybadger/context_manager.rb#48 def get_context; end # @api private # - # source://honeybadger//lib/honeybadger/context_manager.rb#39 + # source://honeybadger//lib/honeybadger/context_manager.rb#60 def get_rack_env; end + # @api private + # + # source://honeybadger//lib/honeybadger/context_manager.rb#68 + def get_request_id; end + # @api private # # source://honeybadger//lib/honeybadger/context_manager.rb#24 - def set_context(hash); end + def set_context(hash, &block); end # @api private # - # source://honeybadger//lib/honeybadger/context_manager.rb#35 + # source://honeybadger//lib/honeybadger/context_manager.rb#56 def set_rack_env(env); end + # @api private + # + # source://honeybadger//lib/honeybadger/context_manager.rb#64 + def set_request_id(request_id); end + private # @api private # - # source://honeybadger//lib/honeybadger/context_manager.rb#47 + # source://honeybadger//lib/honeybadger/context_manager.rb#76 def _initialize; end # @api private # - # source://honeybadger//lib/honeybadger/context_manager.rb#45 + # source://honeybadger//lib/honeybadger/context_manager.rb#74 def custom; end # @api private # - # source://honeybadger//lib/honeybadger/context_manager.rb#45 + # source://honeybadger//lib/honeybadger/context_manager.rb#74 def custom=(_arg0); end # @api private # - # source://honeybadger//lib/honeybadger/context_manager.rb#45 + # source://honeybadger//lib/honeybadger/context_manager.rb#74 def rack_env; end # @api private # - # source://honeybadger//lib/honeybadger/context_manager.rb#45 + # source://honeybadger//lib/honeybadger/context_manager.rb#74 def rack_env=(_arg0); end + # @api private + # + # source://honeybadger//lib/honeybadger/context_manager.rb#74 + def request_id; end + + # @api private + # + # source://honeybadger//lib/honeybadger/context_manager.rb#74 + def request_id=(_arg0); end + class << self # @api private # @@ -1793,8 +2061,8 @@ module Honeybadger::Conversions # @param object [Object] The context object. # @return [Hash] The hash context. # - # source://honeybadger//lib/honeybadger/conversions.rb#11 - def Context(object); end + # source://honeybadger//lib/honeybadger/conversions.rb#12 + def Context(object, depth = T.unsafe(nil)); end class << self # Convert context into a Hash. @@ -1803,78 +2071,571 @@ module Honeybadger::Conversions # @param object [Object] The context object. # @return [Hash] The hash context. # - # source://honeybadger//lib/honeybadger/conversions.rb#11 - def Context(object); end + # source://honeybadger//lib/honeybadger/conversions.rb#12 + def Context(object, depth = T.unsafe(nil)); end end end -# Substitution for gem root in backtrace lines. -# # @api private # -# source://honeybadger//lib/honeybadger/notice.rb#24 -Honeybadger::GEM_ROOT = T.let(T.unsafe(nil), String) +# source://honeybadger//lib/honeybadger/conversions.rb#5 +Honeybadger::Conversions::MAX_CONTEXT_DEPTH = T.let(T.unsafe(nil), Integer) -# source://honeybadger//lib/honeybadger/init/rails.rb#7 -module Honeybadger::Init; end - -# source://honeybadger//lib/honeybadger/init/rails.rb#8 -module Honeybadger::Init::Rails; end +# source://honeybadger//lib/honeybadger/counter.rb#4 +class Honeybadger::Counter < ::Honeybadger::Metric + # source://honeybadger//lib/honeybadger/counter.rb#5 + def count(by = T.unsafe(nil)); end -# source://honeybadger//lib/honeybadger/init/rails.rb#9 -class Honeybadger::Init::Rails::Railtie < ::Rails::Railtie; end + # source://honeybadger//lib/honeybadger/counter.rb#14 + def payloads; end +end -# @api private -# -# source://honeybadger//lib/honeybadger/logging.rb#8 -module Honeybadger::Logging; end +# source://honeybadger//lib/honeybadger/event.rb#4 +class Honeybadger::Event + extend ::Forwardable -# @api private -# -# source://honeybadger//lib/honeybadger/logging.rb#48 -class Honeybadger::Logging::Base # @api private - # @raise [NotImplementedError] + # @return [Event] a new instance of Event # - # source://honeybadger//lib/honeybadger/logging.rb#59 - def add(severity, msg); end - - # source://honeybadger//lib/honeybadger/logging.rb#50 - def debug(msg); end - - # source://honeybadger//lib/honeybadger/logging.rb#54 - def debug?; end + # source://honeybadger//lib/honeybadger/event.rb#19 + def initialize(event_type_or_payload, payload = T.unsafe(nil)); end - # source://honeybadger//lib/honeybadger/logging.rb#50 - def error(msg); end + # source://forwardable/1.3.3/forwardable.rb#231 + def [](*args, **_arg1, &block); end - # source://honeybadger//lib/honeybadger/logging.rb#54 - def error?; end + # source://forwardable/1.3.3/forwardable.rb#231 + def []=(*args, **_arg1, &block); end - # source://honeybadger//lib/honeybadger/logging.rb#50 - def fatal(msg); end + # Template used to create JSON payload. + # + # @api private + # @return [Hash] JSON representation of the event. + # + # source://honeybadger//lib/honeybadger/event.rb#49 + def as_json(*args); end - # source://honeybadger//lib/honeybadger/logging.rb#54 - def fatal?; end + # source://forwardable/1.3.3/forwardable.rb#231 + def dig(*args, **_arg1, &block); end - # source://honeybadger//lib/honeybadger/logging.rb#50 - def info(msg); end + # The event_type of the event + # + # source://honeybadger//lib/honeybadger/event.rb#11 + def event_type; end - # source://honeybadger//lib/honeybadger/logging.rb#54 - def info?; end + # Halts the event and the before_event callback chain. + # + # Returns nothing. + # + # source://honeybadger//lib/honeybadger/event.rb#35 + def halt!; end + # Determines if this event will be discarded. + # # @api private + # @return [Boolean] # - # source://honeybadger//lib/honeybadger/logging.rb#63 - def level; end + # source://honeybadger//lib/honeybadger/event.rb#41 + def halted?; end - # source://honeybadger//lib/honeybadger/logging.rb#50 - def unknown(msg); end + # The payload data of the event + # + # source://honeybadger//lib/honeybadger/event.rb#14 + def payload; end - # source://honeybadger//lib/honeybadger/logging.rb#54 - def unknown?; end + # The timestamp of the event + # + # source://honeybadger//lib/honeybadger/event.rb#8 + def ts; end +end - # source://honeybadger//lib/honeybadger/logging.rb#50 +# A concurrent queue to notify the backend. +# +# @api private +# +# source://honeybadger//lib/honeybadger/events_worker.rb#9 +class Honeybadger::EventsWorker + include ::Honeybadger::Logging::Helper + extend ::Forwardable + + # TODO: These could be configurable? + # + # @api private + # @return [EventsWorker] a new instance of EventsWorker + # + # source://honeybadger//lib/honeybadger/events_worker.rb#29 + def initialize(config); end + + # source://forwardable/1.3.3/forwardable.rb#231 + def backend(*args, **_arg1, &block); end + + # Blocks until queue is processed up to this point in time. + # + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#85 + def flush; end + + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#45 + def push(msg); end + + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#56 + def send_now(msg); end + + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#60 + def shutdown(force = T.unsafe(nil)); end + + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#95 + def start; end + + private + + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#262 + def calc_throttle_interval; end + + # @api private + # @return [Boolean] + # + # source://honeybadger//lib/honeybadger/events_worker.rb#127 + def can_start?; end + + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#220 + def check_and_send; end + + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#193 + def check_timeout; end + + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#114 + def config; end + + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#274 + def dec_throttle; end + + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#201 + def enqueue_msg(msg); end + + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#227 + def flush_send_queue; end + + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#283 + def handle_response(response); end + + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#266 + def inc_throttle; end + + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#137 + def kill!; end + + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#114 + def last_sent; end + + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#114 + def marker; end + + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#114 + def mutex; end + + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#114 + def pid; end + + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#114 + def queue; end + + # Release the marker. Important to perform during cleanup when shutting + # down, otherwise it could end up waiting indefinitely. + # + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#315 + def release_marker; end + + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#166 + def run; end + + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#159 + def schedule_timeout_check; end + + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#207 + def send_batch; end + + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#114 + def send_queue; end + + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#256 + def send_to_backend(msg); end + + # @api private + # @return [Boolean] + # + # source://honeybadger//lib/honeybadger/events_worker.rb#119 + def shutdown?; end + + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#319 + def signal_marker(marker); end + + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#114 + def start_at; end + + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#149 + def suspend(interval); end + + # @api private + # @return [Boolean] + # + # source://honeybadger//lib/honeybadger/events_worker.rb#123 + def suspended?; end + + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#114 + def thread; end + + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#114 + def throttle; end + + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#114 + def throttle_interval; end + + # @api private + # @return [Boolean] + # + # source://honeybadger//lib/honeybadger/events_worker.rb#133 + def throttled?; end + + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#114 + def timeout_thread; end + + # @api private + # + # source://honeybadger//lib/honeybadger/events_worker.rb#237 + def work(msg); end +end + +# The base number for the exponential backoff formula when calculating the +# throttle interval. `1.05 ** throttle` will reach an interval of 2 minutes +# after around 100 429 responses from the server. +# +# @api private +# +# source://honeybadger//lib/honeybadger/events_worker.rb#25 +Honeybadger::EventsWorker::BASE_THROTTLE = T.let(T.unsafe(nil), Float) + +# @api private +# +# source://honeybadger//lib/honeybadger/events_worker.rb#20 +Honeybadger::EventsWorker::CHECK_TIMEOUT = T.let(T.unsafe(nil), Symbol) + +# @api private +# +# source://honeybadger//lib/honeybadger/events_worker.rb#19 +Honeybadger::EventsWorker::FLUSH = T.let(T.unsafe(nil), Symbol) + +# Used to signal the worker to shutdown. +# +# @api private +# +# source://honeybadger//lib/honeybadger/events_worker.rb#18 +Honeybadger::EventsWorker::SHUTDOWN = T.let(T.unsafe(nil), Symbol) + +# Sub-class thread so we have a named thread (useful for debugging in Thread.list). +# +# @api private +# +# source://honeybadger//lib/honeybadger/events_worker.rb#15 +class Honeybadger::EventsWorker::Thread < ::Thread; end + +# Substitution for gem root in backtrace lines. +# +# @api private +# +# source://honeybadger//lib/honeybadger/notice.rb#24 +Honeybadger::GEM_ROOT = T.let(T.unsafe(nil), String) + +# source://honeybadger//lib/honeybadger/gauge.rb#4 +class Honeybadger::Gauge < ::Honeybadger::Metric + # source://honeybadger//lib/honeybadger/gauge.rb#19 + def payloads; end + + # source://honeybadger//lib/honeybadger/gauge.rb#5 + def record(value); end +end + +# source://honeybadger//lib/honeybadger/histogram.rb#4 +class Honeybadger::Histogram < ::Honeybadger::Metric + # source://honeybadger//lib/honeybadger/histogram.rb#22 + def bins; end + + # source://honeybadger//lib/honeybadger/histogram.rb#16 + def find_bin(value); end + + # source://honeybadger//lib/honeybadger/histogram.rb#26 + def payloads; end + + # source://honeybadger//lib/honeybadger/histogram.rb#8 + def record(value); end +end + +# source://honeybadger//lib/honeybadger/histogram.rb#5 +Honeybadger::Histogram::DEFAULT_BINS = T.let(T.unsafe(nil), Array) + +# not quite, but pretty much +# +# source://honeybadger//lib/honeybadger/histogram.rb#6 +Honeybadger::Histogram::INFINITY = T.let(T.unsafe(nil), Float) + +# source://honeybadger//lib/honeybadger/init/rails.rb#7 +module Honeybadger::Init; end + +# source://honeybadger//lib/honeybadger/init/rails.rb#8 +module Honeybadger::Init::Rails; end + +# source://honeybadger//lib/honeybadger/init/rails.rb#9 +class Honeybadger::Init::Rails::Railtie < ::Rails::Railtie; end + +# +Honeybadger::Instrumentation+ defines the API for collecting metric data from anywhere +# in an application. These class methods may be used directly, or from the Honeybadger singleton +# instance. There are three usage variations as show in the example below: +# +# class TicketsController < ApplicationController +# def create +# # pass a block +# Honeybadger.time('create.ticket') { Ticket.create(params[:ticket]) } +# +# # pass a lambda argument +# Honeybadger.time 'create.ticket', ->{ Ticket.create(params[:ticket]) } +# +# # pass the duration argument +# duration = timing_method { Ticket.create(params[:ticket]) } +# Honeybadger.time 'create.ticket', duration: duration +# end +# end +# +# source://honeybadger//lib/honeybadger/instrumentation.rb#28 +class Honeybadger::Instrumentation + # @return [Instrumentation] a new instance of Instrumentation + # + # source://honeybadger//lib/honeybadger/instrumentation.rb#31 + def initialize(agent); end + + # Returns the value of attribute agent. + # + # source://honeybadger//lib/honeybadger/instrumentation.rb#29 + def agent; end + + # source://honeybadger//lib/honeybadger/instrumentation.rb#94 + def decrement_counter(name, *args); end + + # @api private + # + # source://honeybadger//lib/honeybadger/instrumentation.rb#115 + def extract_attributes(args); end + + # @api private + # + # source://honeybadger//lib/honeybadger/instrumentation.rb#120 + def extract_callable(args); end + + # source://honeybadger//lib/honeybadger/instrumentation.rb#104 + def gauge(name, *args); end + + # source://honeybadger//lib/honeybadger/instrumentation.rb#66 + def histogram(name, *args); end + + # source://honeybadger//lib/honeybadger/instrumentation.rb#84 + def increment_counter(name, *args); end + + # returns two parameters, the first is the duration of the execution, and the second is + # the return value of the passed block + # + # source://honeybadger//lib/honeybadger/instrumentation.rb#41 + def monotonic_timer; end + + # source://honeybadger//lib/honeybadger/instrumentation.rb#35 + def registry; end + + # source://honeybadger//lib/honeybadger/instrumentation.rb#48 + def time(name, *args); end +end + +# +Honeybadger::InstrumentationHelper+ is a module that can be included into any class. This module +# provides a convenient DSL around the instrumentation methods to prvoide a cleaner interface. +# There are three usage variations as show in the example below: +# +# class TicketsController < ApplicationController +# include Honeybadger::InstrumentationHelper +# +# def create +# metric_source 'controller' +# metric_attributes { foo: 'bar' } # These attributes get tagged to all metrics called after. +# +# # pass a block +# time('create.ticket') { Ticket.create(params[:ticket]) } +# +# # pass a lambda argument +# time 'create.ticket', ->{ Ticket.create(params[:ticket]) } +# +# # pass the duration argument +# duration = timing_method { Ticket.create(params[:ticket]) } +# time 'create.ticket', duration: duration +# end +# end +# +# source://honeybadger//lib/honeybadger/instrumentation_helper.rb#30 +module Honeybadger::InstrumentationHelper + # source://honeybadger//lib/honeybadger/instrumentation_helper.rb#89 + def decrement_counter(name, *args); end + + # @api private + # + # source://honeybadger//lib/honeybadger/instrumentation_helper.rb#110 + def extract_attributes(args); end + + # @api private + # + # source://honeybadger//lib/honeybadger/instrumentation_helper.rb#116 + def extract_callable(args); end + + # source://honeybadger//lib/honeybadger/instrumentation_helper.rb#99 + def gauge(name, *args); end + + # source://honeybadger//lib/honeybadger/instrumentation_helper.rb#67 + def histogram(name, *args); end + + # source://honeybadger//lib/honeybadger/instrumentation_helper.rb#79 + def increment_counter(name, *args); end + + # source://honeybadger//lib/honeybadger/instrumentation_helper.rb#42 + def metric_agent(agent); end + + # source://honeybadger//lib/honeybadger/instrumentation_helper.rb#50 + def metric_attributes(attributes); end + + # source://honeybadger//lib/honeybadger/instrumentation_helper.rb#46 + def metric_instrumentation; end + + # source://honeybadger//lib/honeybadger/instrumentation_helper.rb#38 + def metric_source(source); end + + # returns two parameters, the first is the duration of the execution, and the second is + # the return value of the passed block + # + # source://honeybadger//lib/honeybadger/instrumentation_helper.rb#34 + def monotonic_timer; end + + # source://honeybadger//lib/honeybadger/instrumentation_helper.rb#55 + def time(name, *args); end +end + +# @api private +# +# source://honeybadger//lib/honeybadger/logging.rb#8 +module Honeybadger::Logging; end + +# @api private +# +# source://honeybadger//lib/honeybadger/logging.rb#48 +class Honeybadger::Logging::Base + # @api private + # @raise [NotImplementedError] + # + # source://honeybadger//lib/honeybadger/logging.rb#59 + def add(severity, msg); end + + # source://honeybadger//lib/honeybadger/logging.rb#50 + def debug(msg); end + + # source://honeybadger//lib/honeybadger/logging.rb#54 + def debug?; end + + # source://honeybadger//lib/honeybadger/logging.rb#50 + def error(msg); end + + # source://honeybadger//lib/honeybadger/logging.rb#54 + def error?; end + + # source://honeybadger//lib/honeybadger/logging.rb#50 + def fatal(msg); end + + # source://honeybadger//lib/honeybadger/logging.rb#54 + def fatal?; end + + # source://honeybadger//lib/honeybadger/logging.rb#50 + def info(msg); end + + # source://honeybadger//lib/honeybadger/logging.rb#54 + def info?; end + + # @api private + # + # source://honeybadger//lib/honeybadger/logging.rb#63 + def level; end + + # source://honeybadger//lib/honeybadger/logging.rb#50 + def unknown(msg); end + + # source://honeybadger//lib/honeybadger/logging.rb#54 + def unknown?; end + + # source://honeybadger//lib/honeybadger/logging.rb#50 def warn(msg); end # source://honeybadger//lib/honeybadger/logging.rb#54 @@ -2086,6 +2847,202 @@ end # source://honeybadger//lib/honeybadger/notice.rb#43 Honeybadger::MAX_EXCEPTION_CAUSES = T.let(T.unsafe(nil), Integer) +# source://honeybadger//lib/honeybadger/metric.rb#2 +class Honeybadger::Metric + # @return [Metric] a new instance of Metric + # + # source://honeybadger//lib/honeybadger/metric.rb#18 + def initialize(name, attributes); end + + # Returns the value of attribute attributes. + # + # source://honeybadger//lib/honeybadger/metric.rb#3 + def attributes; end + + # source://honeybadger//lib/honeybadger/metric.rb#32 + def base_payload; end + + # source://honeybadger//lib/honeybadger/metric.rb#41 + def event_payloads; end + + # source://honeybadger//lib/honeybadger/metric.rb#24 + def metric_type; end + + # Returns the value of attribute name. + # + # source://honeybadger//lib/honeybadger/metric.rb#3 + def name; end + + # Returns the value of attribute samples. + # + # source://honeybadger//lib/honeybadger/metric.rb#3 + def samples; end + + # source://honeybadger//lib/honeybadger/metric.rb#28 + def signature; end + + class << self + # source://honeybadger//lib/honeybadger/metric.rb#5 + def metric_type; end + + # source://honeybadger//lib/honeybadger/metric.rb#13 + def register(registry, metric_name, attributes); end + + # source://honeybadger//lib/honeybadger/metric.rb#9 + def signature(metric_type, name, attributes); end + end +end + +# A concurrent queue to execute plugin collect blocks and registry. +# +# @api private +# +# source://honeybadger//lib/honeybadger/metrics_worker.rb#6 +class Honeybadger::MetricsWorker + include ::Honeybadger::Logging::Helper + extend ::Forwardable + + # @api private + # @return [MetricsWorker] a new instance of MetricsWorker + # + # source://honeybadger//lib/honeybadger/metrics_worker.rb#17 + def initialize(config); end + + # Blocks until queue is processed up to this point in time. + # + # @api private + # + # source://honeybadger//lib/honeybadger/metrics_worker.rb#60 + def flush; end + + # @api private + # + # source://honeybadger//lib/honeybadger/metrics_worker.rb#28 + def push(msg); end + + # @api private + # + # source://honeybadger//lib/honeybadger/metrics_worker.rb#35 + def send_now(msg); end + + # @api private + # + # source://honeybadger//lib/honeybadger/metrics_worker.rb#42 + def shutdown(force = T.unsafe(nil)); end + + # @api private + # + # source://honeybadger//lib/honeybadger/metrics_worker.rb#69 + def start; end + + private + + # @api private + # @return [Boolean] + # + # source://honeybadger//lib/honeybadger/metrics_worker.rb#97 + def can_start?; end + + # @api private + # + # source://honeybadger//lib/honeybadger/metrics_worker.rb#87 + def config; end + + # @api private + # + # source://honeybadger//lib/honeybadger/metrics_worker.rb#87 + def interval_seconds; end + + # @api private + # + # source://honeybadger//lib/honeybadger/metrics_worker.rb#103 + def kill!; end + + # @api private + # + # source://honeybadger//lib/honeybadger/metrics_worker.rb#87 + def marker; end + + # @api private + # + # source://honeybadger//lib/honeybadger/metrics_worker.rb#87 + def mutex; end + + # @api private + # + # source://honeybadger//lib/honeybadger/metrics_worker.rb#87 + def pid; end + + # @api private + # + # source://honeybadger//lib/honeybadger/metrics_worker.rb#87 + def queue; end + + # Release the marker. Important to perform during cleanup when shutting + # down, otherwise it could end up waiting indefinitely. + # + # @api private + # + # source://honeybadger//lib/honeybadger/metrics_worker.rb#165 + def release_marker; end + + # @api private + # + # source://honeybadger//lib/honeybadger/metrics_worker.rb#124 + def run; end + + # @api private + # @return [Boolean] + # + # source://honeybadger//lib/honeybadger/metrics_worker.rb#89 + def shutdown?; end + + # @api private + # + # source://honeybadger//lib/honeybadger/metrics_worker.rb#169 + def signal_marker(marker); end + + # @api private + # + # source://honeybadger//lib/honeybadger/metrics_worker.rb#87 + def start_at; end + + # @api private + # + # source://honeybadger//lib/honeybadger/metrics_worker.rb#114 + def suspend(interval); end + + # @api private + # @return [Boolean] + # + # source://honeybadger//lib/honeybadger/metrics_worker.rb#93 + def suspended?; end + + # @api private + # + # source://honeybadger//lib/honeybadger/metrics_worker.rb#87 + def thread; end + + # @api private + # + # source://honeybadger//lib/honeybadger/metrics_worker.rb#146 + def work(msg); end +end + +# Used to signal the worker to shutdown. +# +# @api private +# +# source://honeybadger//lib/honeybadger/metrics_worker.rb#15 +Honeybadger::MetricsWorker::SHUTDOWN = T.let(T.unsafe(nil), Symbol) + +# Sub-class thread so we have a named thread (useful for debugging in Thread.list). +# +# @api private +# +# source://honeybadger//lib/honeybadger/metrics_worker.rb#12 +class Honeybadger::MetricsWorker::Thread < ::Thread; end + # @api private # # source://honeybadger//lib/honeybadger/notice.rb#15 @@ -2644,6 +3601,11 @@ Honeybadger::PROJECT_ROOT = T.let(T.unsafe(nil), String) # optional dependencies and load the plugin for each dependency only if it's # present in the application. # +# Plugins may also define a collect block that is repeatedly called from +# within a thread. The MetricsWorker contains a loop that will call all +# enabled plugins' collect method, and then sleep for 1 second. This block +# is useful for collecting and/or sending metrics at regular intervals. +# # See the plugins/ directory for examples of official plugins. If you're # interested in developing a plugin for Honeybadger, see the Integration # Guide: https://docs.honeybadger.io/ruby/gem-reference/integration.html @@ -2674,18 +3636,55 @@ Honeybadger::PROJECT_ROOT = T.let(T.unsafe(nil), String) # Honeybadger.notify(exception) # end # end +# +# collect do +# # This block will be periodically called at regular intervals. Here you can +# # gather metrics or inspect services. See the Honeybadger::InstrumentationHelper +# # module to see availble methods for metric collection. +# gauge 'scheduled_jobs', -> { MyFramework.stats.scheduled_jobs.count } +# gauge 'latency', -> { MyFramework.stats.latency } +# end # end # end # end # -# source://honeybadger//lib/honeybadger/plugin.rb#43 +# source://honeybadger//lib/honeybadger/plugin.rb#57 class Honeybadger::Plugin # @api private # @return [Plugin] a new instance of Plugin # - # source://honeybadger//lib/honeybadger/plugin.rb#115 + # source://honeybadger//lib/honeybadger/plugin.rb#159 def initialize(name); end + # Define an collect block. Collect blocks will be added to an execution + # queue if requirement blocks return +true+. The block will be called as frequently + # as once per second, but can be configured to increase it's interval. + # + # @example + # + # Honeybadger::Plugin.register 'my_framework' do + # requirement { defined?(MyFramework) } + # + # collect do + # stats = MyFramework.stats + # gauge 'capacity', -> { stats.capcity } + # end + # + # collect(interval: 10) do + # stats = MyFramework.more_expensive_stats + # gauge 'other_stat', -> { stats.expensive_metric } + # end + # end + # @return nil + # + # source://honeybadger//lib/honeybadger/plugin.rb#234 + def collect(options = T.unsafe(nil), &block); end + + # @api private + # + # source://honeybadger//lib/honeybadger/plugin.rb#268 + def collectors; end + # Define an execution block. Execution blocks will be executed if all # requirement blocks return +true+. # @@ -2707,34 +3706,34 @@ class Honeybadger::Plugin # end # @return nil # - # source://honeybadger//lib/honeybadger/plugin.rb#164 + # source://honeybadger//lib/honeybadger/plugin.rb#209 def execution(&block); end # @api private # - # source://honeybadger//lib/honeybadger/plugin.rb#208 + # source://honeybadger//lib/honeybadger/plugin.rb#284 def executions; end # @api private # - # source://honeybadger//lib/honeybadger/plugin.rb#177 + # source://honeybadger//lib/honeybadger/plugin.rb#247 def load!(config); end # @api private # @return [Boolean] # - # source://honeybadger//lib/honeybadger/plugin.rb#197 + # source://honeybadger//lib/honeybadger/plugin.rb#273 def loaded?; end # @api private # - # source://honeybadger//lib/honeybadger/plugin.rb#208 + # source://honeybadger//lib/honeybadger/plugin.rb#284 def name; end # @api private # @return [Boolean] # - # source://honeybadger//lib/honeybadger/plugin.rb#169 + # source://honeybadger//lib/honeybadger/plugin.rb#239 def ok?(config); end # Define a requirement. All requirement blocks must return +true+ for the @@ -2754,74 +3753,109 @@ class Honeybadger::Plugin # end # @return nil # - # source://honeybadger//lib/honeybadger/plugin.rb#139 + # source://honeybadger//lib/honeybadger/plugin.rb#184 def requirement(&block); end # @api private # - # source://honeybadger//lib/honeybadger/plugin.rb#208 + # source://honeybadger//lib/honeybadger/plugin.rb#284 def requirements; end # Used for testing only; don't normally call this. :) # # @private # - # source://honeybadger//lib/honeybadger/plugin.rb#203 + # source://honeybadger//lib/honeybadger/plugin.rb#279 def reset!; end class << self # @api private # - # source://honeybadger//lib/honeybadger/plugin.rb#52 + # source://honeybadger//lib/honeybadger/plugin.rb#66 def instances; end # @api private # - # source://honeybadger//lib/honeybadger/plugin.rb#77 + # source://honeybadger//lib/honeybadger/plugin.rb#93 def load!(config); end # @api private # - # source://honeybadger//lib/honeybadger/plugin.rb#88 + # source://honeybadger//lib/honeybadger/plugin.rb#104 def name_from_caller(caller); end - # Register a new plugin with Honeybadger. See {#requirement} and {#execution}. + # Register a new plugin with Honeybadger. See {#requirement}, {#execution}, and + # {#collect}.. # # @example # # Honeybadger::Plugin.register 'my_framework' do # requirement { } # execution { } + # collect { } # end # @param name [String, Symbol] The optional name of the plugin. Should use # +snake_case+. The name is inferred from the current file name if omitted. # @return nil # - # source://honeybadger//lib/honeybadger/plugin.rb#69 + # source://honeybadger//lib/honeybadger/plugin.rb#85 def register(name = T.unsafe(nil), &block); end end end # @api private # -# source://honeybadger//lib/honeybadger/plugin.rb#45 +# source://honeybadger//lib/honeybadger/plugin.rb#59 Honeybadger::Plugin::CALLER_FILE = T.let(T.unsafe(nil), Regexp) # @api private # -# source://honeybadger//lib/honeybadger/plugin.rb#96 +# source://honeybadger//lib/honeybadger/plugin.rb#131 +class Honeybadger::Plugin::CollectorExecution < ::Honeybadger::Plugin::Execution + include ::Honeybadger::InstrumentationHelper + + # @api private + # @return [CollectorExecution] a new instance of CollectorExecution + # + # source://honeybadger//lib/honeybadger/plugin.rb#136 + def initialize(name, config, options, &block); end + + # @api private + # + # source://honeybadger//lib/honeybadger/plugin.rb#153 + def register!; end + + # @api private + # + # source://honeybadger//lib/honeybadger/plugin.rb#149 + def reset; end + + # @api private + # + # source://honeybadger//lib/honeybadger/plugin.rb#145 + def tick; end +end + +# @api private +# +# source://honeybadger//lib/honeybadger/plugin.rb#134 +Honeybadger::Plugin::CollectorExecution::DEFAULT_COLLECTION_INTERVAL = T.let(T.unsafe(nil), Integer) + +# @api private +# +# source://honeybadger//lib/honeybadger/plugin.rb#112 class Honeybadger::Plugin::Execution extend ::Forwardable # @api private # @return [Execution] a new instance of Execution # - # source://honeybadger//lib/honeybadger/plugin.rb#99 + # source://honeybadger//lib/honeybadger/plugin.rb#115 def initialize(config, &block); end # @api private # - # source://honeybadger//lib/honeybadger/plugin.rb#104 + # source://honeybadger//lib/honeybadger/plugin.rb#120 def call; end # source://forwardable/1.3.3/forwardable.rb#231 @@ -2831,12 +3865,12 @@ class Honeybadger::Plugin::Execution # @api private # - # source://honeybadger//lib/honeybadger/plugin.rb#110 + # source://honeybadger//lib/honeybadger/plugin.rb#126 def block; end # @api private # - # source://honeybadger//lib/honeybadger/plugin.rb#110 + # source://honeybadger//lib/honeybadger/plugin.rb#126 def config; end end @@ -2919,7 +3953,7 @@ class Honeybadger::Rack::UserFeedback # @private # @todo Make this method and others actually private. # - # source://honeybadger//lib/honeybadger/rack/user_feedback.rb#46 + # source://honeybadger//lib/honeybadger/rack/user_feedback.rb#45 def action; end # source://honeybadger//lib/honeybadger/rack/user_feedback.rb#29 @@ -2930,13 +3964,13 @@ class Honeybadger::Rack::UserFeedback # @private # - # source://honeybadger//lib/honeybadger/rack/user_feedback.rb#59 + # source://honeybadger//lib/honeybadger/rack/user_feedback.rb#58 def custom_template_file; end # @private # @return [Boolean] # - # source://honeybadger//lib/honeybadger/rack/user_feedback.rb#64 + # source://honeybadger//lib/honeybadger/rack/user_feedback.rb#63 def custom_template_file?; end # source://forwardable/1.3.3/forwardable.rb#231 @@ -2944,17 +3978,17 @@ class Honeybadger::Rack::UserFeedback # @private # - # source://honeybadger//lib/honeybadger/rack/user_feedback.rb#53 + # source://honeybadger//lib/honeybadger/rack/user_feedback.rb#52 def render_form(error_id, action = T.unsafe(nil)); end # @private # - # source://honeybadger//lib/honeybadger/rack/user_feedback.rb#69 + # source://honeybadger//lib/honeybadger/rack/user_feedback.rb#68 def template_file; end private - # source://honeybadger//lib/honeybadger/rack/user_feedback.rb#82 + # source://honeybadger//lib/honeybadger/rack/user_feedback.rb#81 def agent; end end @@ -2984,7 +4018,7 @@ class Honeybadger::Rack::UserInformer private - # source://honeybadger//lib/honeybadger/rack/user_informer.rb#40 + # source://honeybadger//lib/honeybadger/rack/user_informer.rb#39 def agent; end end @@ -3036,6 +4070,43 @@ module Honeybadger::RakeHandler::Rake087Methods def standard_exception_handling; end end +# source://honeybadger//lib/honeybadger/registry.rb#2 +class Honeybadger::Registry + # @return [Registry] a new instance of Registry + # + # source://honeybadger//lib/honeybadger/registry.rb#3 + def initialize; end + + # source://honeybadger//lib/honeybadger/registry.rb#20 + def flush; end + + # source://honeybadger//lib/honeybadger/registry.rb#14 + def get(metric_type, name, attributes); end + + # source://honeybadger//lib/honeybadger/registry.rb#26 + def metrics; end + + # source://honeybadger//lib/honeybadger/registry.rb#8 + def register(metric); end +end + +# source://honeybadger//lib/honeybadger/registry_execution.rb#2 +class Honeybadger::RegistryExecution + # @return [RegistryExecution] a new instance of RegistryExecution + # + # source://honeybadger//lib/honeybadger/registry_execution.rb#3 + def initialize(registry, config, options); end + + # source://honeybadger//lib/honeybadger/registry_execution.rb#20 + def call; end + + # source://honeybadger//lib/honeybadger/registry_execution.rb#15 + def reset; end + + # source://honeybadger//lib/honeybadger/registry_execution.rb#11 + def tick; end +end + # Empty String (used for equality comparisons and assignment). # # @api private @@ -3043,6 +4114,9 @@ end # source://honeybadger//lib/honeybadger/notice.rb#32 Honeybadger::STRING_EMPTY = T.let(T.unsafe(nil), String) +# source://honeybadger//lib/honeybadger/timer.rb#4 +class Honeybadger::Timer < ::Honeybadger::Gauge; end + # @api private # # source://honeybadger//lib/honeybadger/const.rb#18 @@ -3071,31 +4145,36 @@ class Honeybadger::Util::HTTP # source://honeybadger//lib/honeybadger/util/http.rb#46 def post(endpoint, payload, headers = T.unsafe(nil)); end + # @api private + # + # source://honeybadger//lib/honeybadger/util/http.rb#52 + def post_newline_delimited(endpoint, payload, headers = T.unsafe(nil)); end + private # @api private # - # source://honeybadger//lib/honeybadger/util/http.rb#87 + # source://honeybadger//lib/honeybadger/util/http.rb#93 def compress(string, level = T.unsafe(nil)); end # @api private # - # source://honeybadger//lib/honeybadger/util/http.rb#54 + # source://honeybadger//lib/honeybadger/util/http.rb#60 def config; end # @api private # - # source://honeybadger//lib/honeybadger/util/http.rb#56 + # source://honeybadger//lib/honeybadger/util/http.rb#62 def http_connection; end # @api private # - # source://honeybadger//lib/honeybadger/util/http.rb#60 + # source://honeybadger//lib/honeybadger/util/http.rb#66 def http_headers(headers = T.unsafe(nil)); end # @api private # - # source://honeybadger//lib/honeybadger/util/http.rb#68 + # source://honeybadger//lib/honeybadger/util/http.rb#74 def setup_http_connection; end end @@ -3230,82 +4309,67 @@ class Honeybadger::Util::SQL class << self # @api private # - # source://honeybadger//lib/honeybadger/util/sql.rb#24 + # source://honeybadger//lib/honeybadger/util/sql.rb#21 def force_utf_8(string); end # @api private # - # source://honeybadger//lib/honeybadger/util/sql.rb#13 + # source://honeybadger//lib/honeybadger/util/sql.rb#10 def obfuscate(sql, adapter); end end end # @api private # -# source://honeybadger//lib/honeybadger/util/sql.rb#6 -Honeybadger::Util::SQL::DQuotedData = T.let(T.unsafe(nil), Regexp) - -# @api private -# -# source://honeybadger//lib/honeybadger/util/sql.rb#11 -Honeybadger::Util::SQL::DoubleQuoters = T.let(T.unsafe(nil), Regexp) +# source://honeybadger//lib/honeybadger/util/sql.rb#8 +Honeybadger::Util::SQL::DOUBLE_QUOTERS = T.let(T.unsafe(nil), Regexp) # @api private # -# source://honeybadger//lib/honeybadger/util/sql.rb#10 -Honeybadger::Util::SQL::EmptyReplacement = T.let(T.unsafe(nil), String) +# source://honeybadger//lib/honeybadger/util/sql.rb#6 +Honeybadger::Util::SQL::DQUOTE_DATA = T.let(T.unsafe(nil), Regexp) # @api private # # source://honeybadger//lib/honeybadger/util/sql.rb#4 -Honeybadger::Util::SQL::EscapedQuotes = T.let(T.unsafe(nil), Regexp) - -# @api private -# -# source://honeybadger//lib/honeybadger/util/sql.rb#8 -Honeybadger::Util::SQL::Newline = T.let(T.unsafe(nil), Regexp) +Honeybadger::Util::SQL::ESCAPE_QUOTES = T.let(T.unsafe(nil), Regexp) # @api private # # source://honeybadger//lib/honeybadger/util/sql.rb#7 -Honeybadger::Util::SQL::NumericData = T.let(T.unsafe(nil), Regexp) - -# @api private -# -# source://honeybadger//lib/honeybadger/util/sql.rb#9 -Honeybadger::Util::SQL::Replacement = T.let(T.unsafe(nil), String) +Honeybadger::Util::SQL::NUMBER_DATA = T.let(T.unsafe(nil), Regexp) # @api private # # source://honeybadger//lib/honeybadger/util/sql.rb#5 -Honeybadger::Util::SQL::SQuotedData = T.let(T.unsafe(nil), Regexp) +Honeybadger::Util::SQL::SQUOTE_DATA = T.let(T.unsafe(nil), Regexp) # Sanitizer sanitizes data for sending to Honeybadger's API. The filters # are based on Rails' HTTP parameter filter. # # @api private # -# source://honeybadger//lib/honeybadger/util/sanitizer.rb#10 +# source://honeybadger//lib/honeybadger/util/sanitizer.rb#9 class Honeybadger::Util::Sanitizer # @api private # @return [Sanitizer] a new instance of Sanitizer # - # source://honeybadger//lib/honeybadger/util/sanitizer.rb#35 + # source://honeybadger//lib/honeybadger/util/sanitizer.rb#34 def initialize(max_depth: T.unsafe(nil), filters: T.unsafe(nil)); end # @api private # - # source://honeybadger//lib/honeybadger/util/sanitizer.rb#133 + # source://honeybadger//lib/honeybadger/util/sanitizer.rb#132 def filter_cookies(raw_cookies); end # @api private # - # source://honeybadger//lib/honeybadger/util/sanitizer.rb#147 + # source://honeybadger//lib/honeybadger/util/sanitizer.rb#146 def filter_url(url); end # @api private # - # source://honeybadger//lib/honeybadger/util/sanitizer.rb#59 + # source://honeybadger//lib/honeybadger/util/sanitizer.rb#58 def sanitize(data, depth = T.unsafe(nil), stack = T.unsafe(nil), parents = T.unsafe(nil)); end private @@ -3313,146 +4377,146 @@ class Honeybadger::Util::Sanitizer # @api private # @return [Boolean] # - # source://honeybadger//lib/honeybadger/util/sanitizer.rb#197 + # source://honeybadger//lib/honeybadger/util/sanitizer.rb#196 def basic_object?(object); end # @api private # - # source://honeybadger//lib/honeybadger/util/sanitizer.rb#162 + # source://honeybadger//lib/honeybadger/util/sanitizer.rb#161 def blocks; end # @api private # @return [Boolean] # - # source://honeybadger//lib/honeybadger/util/sanitizer.rb#205 + # source://honeybadger//lib/honeybadger/util/sanitizer.rb#204 def can_dup?(obj); end # @api private # - # source://honeybadger//lib/honeybadger/util/sanitizer.rb#162 + # source://honeybadger//lib/honeybadger/util/sanitizer.rb#161 def deep_regexps; end # @api private # @return [Boolean] # - # source://honeybadger//lib/honeybadger/util/sanitizer.rb#168 + # source://honeybadger//lib/honeybadger/util/sanitizer.rb#167 def filter_key?(key, parents = T.unsafe(nil)); end # @api private # @return [Boolean] # - # source://honeybadger//lib/honeybadger/util/sanitizer.rb#164 + # source://honeybadger//lib/honeybadger/util/sanitizer.rb#163 def filters?; end # @api private # @return [Boolean] # - # source://honeybadger//lib/honeybadger/util/sanitizer.rb#209 + # source://honeybadger//lib/honeybadger/util/sanitizer.rb#208 def inspected?(string); end # @api private # - # source://honeybadger//lib/honeybadger/util/sanitizer.rb#162 + # source://honeybadger//lib/honeybadger/util/sanitizer.rb#161 def max_depth; end # @api private # @return [Boolean] # - # source://honeybadger//lib/honeybadger/util/sanitizer.rb#193 + # source://honeybadger//lib/honeybadger/util/sanitizer.rb#192 def recursive?(data); end # @api private # - # source://honeybadger//lib/honeybadger/util/sanitizer.rb#162 + # source://honeybadger//lib/honeybadger/util/sanitizer.rb#161 def regexps; end # @api private # - # source://honeybadger//lib/honeybadger/util/sanitizer.rb#175 + # source://honeybadger//lib/honeybadger/util/sanitizer.rb#174 def sanitize_string(string); end # @api private # - # source://honeybadger//lib/honeybadger/util/sanitizer.rb#188 + # source://honeybadger//lib/honeybadger/util/sanitizer.rb#187 def valid_encoding(string); end # @api private # @return [Boolean] # - # source://honeybadger//lib/honeybadger/util/sanitizer.rb#181 + # source://honeybadger//lib/honeybadger/util/sanitizer.rb#180 def valid_encoding?(string); end class << self # @api private # - # source://honeybadger//lib/honeybadger/util/sanitizer.rb#30 + # source://honeybadger//lib/honeybadger/util/sanitizer.rb#29 def sanitize(data); end end end # @api private # -# source://honeybadger//lib/honeybadger/util/sanitizer.rb#17 +# source://honeybadger//lib/honeybadger/util/sanitizer.rb#16 Honeybadger::Util::Sanitizer::BASIC_OBJECT = T.let(T.unsafe(nil), String) # @api private # -# source://honeybadger//lib/honeybadger/util/sanitizer.rb#11 +# source://honeybadger//lib/honeybadger/util/sanitizer.rb#10 Honeybadger::Util::Sanitizer::COOKIE_PAIRS = T.let(T.unsafe(nil), Regexp) # @api private # -# source://honeybadger//lib/honeybadger/util/sanitizer.rb#13 +# source://honeybadger//lib/honeybadger/util/sanitizer.rb#12 Honeybadger::Util::Sanitizer::COOKIE_PAIR_SEP = T.let(T.unsafe(nil), String) # @api private # -# source://honeybadger//lib/honeybadger/util/sanitizer.rb#12 +# source://honeybadger//lib/honeybadger/util/sanitizer.rb#11 Honeybadger::Util::Sanitizer::COOKIE_SEP = T.let(T.unsafe(nil), String) # @api private # -# source://honeybadger//lib/honeybadger/util/sanitizer.rb#18 +# source://honeybadger//lib/honeybadger/util/sanitizer.rb#17 Honeybadger::Util::Sanitizer::DEPTH = T.let(T.unsafe(nil), String) # @api private # -# source://honeybadger//lib/honeybadger/util/sanitizer.rb#15 +# source://honeybadger//lib/honeybadger/util/sanitizer.rb#14 Honeybadger::Util::Sanitizer::ENCODE_OPTS = T.let(T.unsafe(nil), Hash) # @api private # -# source://honeybadger//lib/honeybadger/util/sanitizer.rb#19 +# source://honeybadger//lib/honeybadger/util/sanitizer.rb#18 Honeybadger::Util::Sanitizer::FILTERED = T.let(T.unsafe(nil), String) # @api private # -# source://honeybadger//lib/honeybadger/util/sanitizer.rb#24 +# source://honeybadger//lib/honeybadger/util/sanitizer.rb#23 Honeybadger::Util::Sanitizer::IMMUTABLE = T.let(T.unsafe(nil), Array) # @api private # -# source://honeybadger//lib/honeybadger/util/sanitizer.rb#26 +# source://honeybadger//lib/honeybadger/util/sanitizer.rb#25 Honeybadger::Util::Sanitizer::MAX_STRING_SIZE = T.let(T.unsafe(nil), Integer) # @api private # -# source://honeybadger//lib/honeybadger/util/sanitizer.rb#20 +# source://honeybadger//lib/honeybadger/util/sanitizer.rb#19 Honeybadger::Util::Sanitizer::RAISED = T.let(T.unsafe(nil), String) # @api private # -# source://honeybadger//lib/honeybadger/util/sanitizer.rb#21 +# source://honeybadger//lib/honeybadger/util/sanitizer.rb#20 Honeybadger::Util::Sanitizer::RECURSION = T.let(T.unsafe(nil), String) # @api private # -# source://honeybadger//lib/honeybadger/util/sanitizer.rb#22 +# source://honeybadger//lib/honeybadger/util/sanitizer.rb#21 Honeybadger::Util::Sanitizer::TRUNCATED = T.let(T.unsafe(nil), String) # @api private # -# source://honeybadger//lib/honeybadger/util/sanitizer.rb#28 +# source://honeybadger//lib/honeybadger/util/sanitizer.rb#27 Honeybadger::Util::Sanitizer::VALID_ENCODINGS = T.let(T.unsafe(nil), Array) # @api private @@ -3626,7 +4690,7 @@ class Honeybadger::Worker # # @api private # - # source://honeybadger//lib/honeybadger/worker.rb#243 + # source://honeybadger//lib/honeybadger/worker.rb#246 def release_marker; end # @api private @@ -3642,7 +4706,7 @@ class Honeybadger::Worker # @api private # - # source://honeybadger//lib/honeybadger/worker.rb#247 + # source://honeybadger//lib/honeybadger/worker.rb#250 def signal_marker(marker); end # @api private diff --git a/sorbet/rbi/gems/http-cookie@1.0.5.rbi b/sorbet/rbi/gems/http-cookie@1.0.6.rbi similarity index 85% rename from sorbet/rbi/gems/http-cookie@1.0.5.rbi rename to sorbet/rbi/gems/http-cookie@1.0.6.rbi index 097243a89..3e018b622 100644 --- a/sorbet/rbi/gems/http-cookie@1.0.5.rbi +++ b/sorbet/rbi/gems/http-cookie@1.0.6.rbi @@ -38,13 +38,13 @@ class HTTP::Cookie # # @return [Cookie] a new instance of Cookie # - # source://http-cookie//lib/http/cookie.rb#130 + # source://http-cookie//lib/http/cookie.rb#132 def initialize(*args); end # Compares the cookie with another. When there are many cookies with # the same name for a URL, the value of the smallest must be used. # - # source://http-cookie//lib/http/cookie.rb#643 + # source://http-cookie//lib/http/cookie.rb#645 def <=>(other); end # Tests if it is OK to accept this cookie considering its origin. @@ -53,7 +53,7 @@ class HTTP::Cookie # # @return [Boolean] # - # source://http-cookie//lib/http/cookie.rb#569 + # source://http-cookie//lib/http/cookie.rb#571 def acceptable?; end # Tests if it is OK to accept this cookie if it is sent from a given @@ -61,90 +61,90 @@ class HTTP::Cookie # # @return [Boolean] # - # source://http-cookie//lib/http/cookie.rb#550 + # source://http-cookie//lib/http/cookie.rb#552 def acceptable_from_uri?(uri); end # The time this cookie was last accessed at. # - # source://http-cookie//lib/http/cookie.rb#546 + # source://http-cookie//lib/http/cookie.rb#548 def accessed_at; end # The time this cookie was last accessed at. # - # source://http-cookie//lib/http/cookie.rb#546 + # source://http-cookie//lib/http/cookie.rb#548 def accessed_at=(_arg0); end # Returns a string for use in the Cookie header, i.e. `name=value` # or `name="value"`. # - # source://http-cookie//lib/http/cookie.rb#596 + # source://http-cookie//lib/http/cookie.rb#598 def cookie_value; end # The time this cookie was created at. This value is used as a base # date for interpreting the Max-Age attribute value. See #expires. # - # source://http-cookie//lib/http/cookie.rb#543 + # source://http-cookie//lib/http/cookie.rb#545 def created_at; end # The time this cookie was created at. This value is used as a base # date for interpreting the Max-Age attribute value. See #expires. # - # source://http-cookie//lib/http/cookie.rb#543 + # source://http-cookie//lib/http/cookie.rb#545 def created_at=(_arg0); end # Returns the value of attribute domain. # - # source://http-cookie//lib/http/cookie.rb#383 + # source://http-cookie//lib/http/cookie.rb#385 def domain; end # See #domain. # - # source://http-cookie//lib/http/cookie.rb#386 + # source://http-cookie//lib/http/cookie.rb#388 def domain=(domain); end # Returns the domain attribute value as a DomainName object. # - # source://http-cookie//lib/http/cookie.rb#431 + # source://http-cookie//lib/http/cookie.rb#433 def domain_name; end # Returns the domain, with a dot prefixed only if the domain flag is # on. # - # source://http-cookie//lib/http/cookie.rb#426 + # source://http-cookie//lib/http/cookie.rb#428 def dot_domain; end # YAML serialization helper for Psych. # - # source://http-cookie//lib/http/cookie.rb#659 + # source://http-cookie//lib/http/cookie.rb#661 def encode_with(coder); end # Expires this cookie by setting the expires attribute value to a # past date. # - # source://http-cookie//lib/http/cookie.rb#536 + # source://http-cookie//lib/http/cookie.rb#538 def expire!; end # Tests if this cookie is expired by now, or by a given time. # # @return [Boolean] # - # source://http-cookie//lib/http/cookie.rb#526 + # source://http-cookie//lib/http/cookie.rb#528 def expired?(time = T.unsafe(nil)); end - # source://http-cookie//lib/http/cookie.rb#485 + # source://http-cookie//lib/http/cookie.rb#487 def expires; end # See #expires. # - # source://http-cookie//lib/http/cookie.rb#490 + # source://http-cookie//lib/http/cookie.rb#492 def expires=(t); end - # source://http-cookie//lib/http/cookie.rb#485 + # source://http-cookie//lib/http/cookie.rb#487 def expires_at; end # See #expires. # - # source://http-cookie//lib/http/cookie.rb#490 + # source://http-cookie//lib/http/cookie.rb#492 def expires_at=(t); end # The domain flag. (the opposite of host-only-flag) @@ -153,7 +153,7 @@ class HTTP::Cookie # \#domain, including the host domain itself. If it is false, this # cookie will be sent only to the host indicated by the #domain. # - # source://http-cookie//lib/http/cookie.rb#438 + # source://http-cookie//lib/http/cookie.rb#440 def for_domain; end # The domain flag. (the opposite of host-only-flag) @@ -162,7 +162,7 @@ class HTTP::Cookie # \#domain, including the host domain itself. If it is false, this # cookie will be sent only to the host indicated by the #domain. # - # source://http-cookie//lib/http/cookie.rb#438 + # source://http-cookie//lib/http/cookie.rb#440 def for_domain=(_arg0); end # The domain flag. (the opposite of host-only-flag) @@ -171,76 +171,76 @@ class HTTP::Cookie # \#domain, including the host domain itself. If it is false, this # cookie will be sent only to the host indicated by the #domain. # - # source://http-cookie//lib/http/cookie.rb#438 + # source://http-cookie//lib/http/cookie.rb#440 def for_domain?; end # The HttpOnly flag. (http-only-flag) # # A cookie with this flag on should be hidden from a client script. # - # source://http-cookie//lib/http/cookie.rb#476 + # source://http-cookie//lib/http/cookie.rb#478 def httponly; end # The HttpOnly flag. (http-only-flag) # # A cookie with this flag on should be hidden from a client script. # - # source://http-cookie//lib/http/cookie.rb#476 + # source://http-cookie//lib/http/cookie.rb#478 def httponly=(_arg0); end # The HttpOnly flag. (http-only-flag) # # A cookie with this flag on should be hidden from a client script. # - # source://http-cookie//lib/http/cookie.rb#476 + # source://http-cookie//lib/http/cookie.rb#478 def httponly?; end # YAML deserialization helper for Syck. # - # source://http-cookie//lib/http/cookie.rb#666 + # source://http-cookie//lib/http/cookie.rb#668 def init_with(coder); end - # source://http-cookie//lib/http/cookie.rb#635 + # source://http-cookie//lib/http/cookie.rb#637 def inspect; end # Returns the value of attribute max_age. # - # source://http-cookie//lib/http/cookie.rb#504 + # source://http-cookie//lib/http/cookie.rb#506 def max_age; end # See #max_age. # - # source://http-cookie//lib/http/cookie.rb#507 + # source://http-cookie//lib/http/cookie.rb#509 def max_age=(sec); end # Returns the value of attribute name. # - # source://http-cookie//lib/http/cookie.rb#347 + # source://http-cookie//lib/http/cookie.rb#349 def name; end # See #name. # - # source://http-cookie//lib/http/cookie.rb#350 + # source://http-cookie//lib/http/cookie.rb#352 def name=(name); end # Returns the value of attribute origin. # - # source://http-cookie//lib/http/cookie.rb#450 + # source://http-cookie//lib/http/cookie.rb#452 def origin; end # See #origin. # - # source://http-cookie//lib/http/cookie.rb#453 + # source://http-cookie//lib/http/cookie.rb#455 def origin=(origin); end # Returns the value of attribute path. # - # source://http-cookie//lib/http/cookie.rb#441 + # source://http-cookie//lib/http/cookie.rb#443 def path; end # See #path. # - # source://http-cookie//lib/http/cookie.rb#444 + # source://http-cookie//lib/http/cookie.rb#446 def path=(path); end # The secure flag. (secure-only-flag) @@ -248,7 +248,7 @@ class HTTP::Cookie # A cookie with this flag on should only be sent via a secure # protocol like HTTPS. # - # source://http-cookie//lib/http/cookie.rb#470 + # source://http-cookie//lib/http/cookie.rb#472 def secure; end # The secure flag. (secure-only-flag) @@ -256,7 +256,7 @@ class HTTP::Cookie # A cookie with this flag on should only be sent via a secure # protocol like HTTPS. # - # source://http-cookie//lib/http/cookie.rb#470 + # source://http-cookie//lib/http/cookie.rb#472 def secure=(_arg0); end # The secure flag. (secure-only-flag) @@ -264,21 +264,21 @@ class HTTP::Cookie # A cookie with this flag on should only be sent via a secure # protocol like HTTPS. # - # source://http-cookie//lib/http/cookie.rb#470 + # source://http-cookie//lib/http/cookie.rb#472 def secure?; end # The session flag. (the opposite of persistent-flag) # # A cookie with this flag on should be hidden from a client script. # - # source://http-cookie//lib/http/cookie.rb#482 + # source://http-cookie//lib/http/cookie.rb#484 def session; end # The session flag. (the opposite of persistent-flag) # # A cookie with this flag on should be hidden from a client script. # - # source://http-cookie//lib/http/cookie.rb#482 + # source://http-cookie//lib/http/cookie.rb#484 def session?; end # Returns a string for use in the Set-Cookie header. If necessary @@ -286,18 +286,18 @@ class HTTP::Cookie # missing, RuntimeError is raised. It is always the best to set an # origin before calling this method. # - # source://http-cookie//lib/http/cookie.rb#605 + # source://http-cookie//lib/http/cookie.rb#607 def set_cookie_value; end # Returns a string for use in the Cookie header, i.e. `name=value` # or `name="value"`. # - # source://http-cookie//lib/http/cookie.rb#596 + # source://http-cookie//lib/http/cookie.rb#598 def to_s; end # YAML serialization helper for Syck. # - # source://http-cookie//lib/http/cookie.rb#654 + # source://http-cookie//lib/http/cookie.rb#656 def to_yaml_properties; end # Tests if it is OK to send this cookie to a given `uri`. A @@ -305,36 +305,36 @@ class HTTP::Cookie # # @return [Boolean] # - # source://http-cookie//lib/http/cookie.rb#584 + # source://http-cookie//lib/http/cookie.rb#586 def valid_for_uri?(uri); end # Returns the value of attribute value. # - # source://http-cookie//lib/http/cookie.rb#364 + # source://http-cookie//lib/http/cookie.rb#366 def value; end # See #value. # - # source://http-cookie//lib/http/cookie.rb#367 + # source://http-cookie//lib/http/cookie.rb#369 def value=(value); end # YAML deserialization helper for Psych. # - # source://http-cookie//lib/http/cookie.rb#671 + # source://http-cookie//lib/http/cookie.rb#673 def yaml_initialize(tag, map); end class << self # Takes an array of cookies and returns a string for use in the # Cookie header, like "name1=value2; name2=value2". # - # source://http-cookie//lib/http/cookie.rb#331 + # source://http-cookie//lib/http/cookie.rb#333 def cookie_value(cookies); end # Parses a Cookie header value into a hash of name-value string # pairs. The first appearance takes precedence if multiple pairs # with the same name occur. # - # source://http-cookie//lib/http/cookie.rb#338 + # source://http-cookie//lib/http/cookie.rb#340 def cookie_value_to_hash(cookie_value); end # Parses a Set-Cookie header value `set_cookie` assuming that it @@ -371,7 +371,7 @@ class HTTP::Cookie # cookie definitions containing double-quotes just as naturally # expected. # - # source://http-cookie//lib/http/cookie.rb#273 + # source://http-cookie//lib/http/cookie.rb#275 def parse(set_cookie, origin, options = T.unsafe(nil), &block); end # Tests if +target_path+ is under +base_path+ as described in RFC @@ -394,7 +394,7 @@ class HTTP::Cookie # # @return [Boolean] # - # source://http-cookie//lib/http/cookie.rb#229 + # source://http-cookie//lib/http/cookie.rb#231 def path_match?(base_path, target_path); end end end @@ -402,90 +402,124 @@ end # Maximum number of cookies per domain (RFC 6265 6.1 requires 50 at # least) # -# source://http-cookie//lib/http/cookie.rb#19 +# source://http-cookie//lib/http/cookie.rb#21 HTTP::Cookie::MAX_COOKIES_PER_DOMAIN = T.let(T.unsafe(nil), Integer) # Maximum number of cookies total (RFC 6265 6.1 requires 3000 at # least) # -# source://http-cookie//lib/http/cookie.rb#22 +# source://http-cookie//lib/http/cookie.rb#24 HTTP::Cookie::MAX_COOKIES_TOTAL = T.let(T.unsafe(nil), Integer) # Maximum number of bytes per cookie (RFC 6265 6.1 requires 4096 at # least) # -# source://http-cookie//lib/http/cookie.rb#16 +# source://http-cookie//lib/http/cookie.rb#18 HTTP::Cookie::MAX_LENGTH = T.let(T.unsafe(nil), Integer) -# source://http-cookie//lib/http/cookie.rb#27 +# source://http-cookie//lib/http/cookie.rb#29 HTTP::Cookie::PERSISTENT_PROPERTIES = T.let(T.unsafe(nil), Array) -# source://http-cookie//lib/http/cookie/scanner.rb#5 +# source://http-cookie//lib/http/cookie/scanner.rb#6 class HTTP::Cookie::Scanner < ::StringScanner # @return [Scanner] a new instance of Scanner # - # source://http-cookie//lib/http/cookie/scanner.rb#18 + # source://http-cookie//lib/http/cookie/scanner.rb#19 def initialize(string, logger = T.unsafe(nil)); end - # source://http-cookie//lib/http/cookie/scanner.rb#104 + # source://http-cookie//lib/http/cookie/scanner.rb#105 def parse_cookie_date(s); end - # source://http-cookie//lib/http/cookie/scanner.rb#218 + # source://http-cookie//lib/http/cookie/scanner.rb#219 def scan_cookie; end - # source://http-cookie//lib/http/cookie/scanner.rb#34 + # source://http-cookie//lib/http/cookie/scanner.rb#35 def scan_dquoted; end - # source://http-cookie//lib/http/cookie/scanner.rb#47 + # source://http-cookie//lib/http/cookie/scanner.rb#48 def scan_name; end - # source://http-cookie//lib/http/cookie/scanner.rb#73 + # source://http-cookie//lib/http/cookie/scanner.rb#74 def scan_name_value(comma_as_separator = T.unsafe(nil)); end - # source://http-cookie//lib/http/cookie/scanner.rb#156 + # source://http-cookie//lib/http/cookie/scanner.rb#157 def scan_set_cookie; end - # source://http-cookie//lib/http/cookie/scanner.rb#53 + # source://http-cookie//lib/http/cookie/scanner.rb#54 def scan_value(comma_as_separator = T.unsafe(nil)); end - # source://http-cookie//lib/http/cookie/scanner.rb#30 + # source://http-cookie//lib/http/cookie/scanner.rb#31 def skip_wsp; end private - # source://http-cookie//lib/http/cookie/scanner.rb#85 + # source://http-cookie//lib/http/cookie/scanner.rb#86 def tuple_to_time(day_of_month, month, year, time); end class << self - # source://http-cookie//lib/http/cookie/scanner.rb#24 + # source://http-cookie//lib/http/cookie/scanner.rb#25 def quote(s); end end end -# source://http-cookie//lib/http/cookie/scanner.rb#13 +# source://http-cookie//lib/http/cookie/scanner.rb#14 HTTP::Cookie::Scanner::RE_BAD_CHAR = T.let(T.unsafe(nil), Regexp) # A pattern that matches the comma in a (typically date) value. # -# source://http-cookie//lib/http/cookie/scanner.rb#16 +# source://http-cookie//lib/http/cookie/scanner.rb#17 HTTP::Cookie::Scanner::RE_COOKIE_COMMA = T.let(T.unsafe(nil), Regexp) # A pattern that matches a cookie name or attribute name which may # be empty, capturing trailing whitespace. # -# source://http-cookie//lib/http/cookie/scanner.rb#11 +# source://http-cookie//lib/http/cookie/scanner.rb#12 HTTP::Cookie::Scanner::RE_NAME = T.let(T.unsafe(nil), Regexp) # Whitespace. # -# source://http-cookie//lib/http/cookie/scanner.rb#7 +# source://http-cookie//lib/http/cookie/scanner.rb#8 HTTP::Cookie::Scanner::RE_WSP = T.let(T.unsafe(nil), Regexp) # :stopdoc: # -# source://http-cookie//lib/http/cookie.rb#25 +# source://http-cookie//lib/http/cookie.rb#27 HTTP::Cookie::UNIX_EPOCH = T.let(T.unsafe(nil), Time) +# source://http-cookie//lib/http/cookie/uri_parser.rb#1 +module HTTP::Cookie::URIParser + private + + # Escape RFC 3986 "reserved" characters minus valid characters for path + # More specifically, gen-delims minus "/" / "?" / "#" + # + # source://http-cookie//lib/http/cookie/uri_parser.rb#17 + def escape_path(path); end + + # Parse a URI string or object, relaxing the constraints on the path component + # + # source://http-cookie//lib/http/cookie/uri_parser.rb#22 + def parse(uri); end + + class << self + # Escape RFC 3986 "reserved" characters minus valid characters for path + # More specifically, gen-delims minus "/" / "?" / "#" + # + # source://http-cookie//lib/http/cookie/uri_parser.rb#17 + def escape_path(path); end + + # Parse a URI string or object, relaxing the constraints on the path component + # + # source://http-cookie//lib/http/cookie/uri_parser.rb#22 + def parse(uri); end + end +end + +# Regular Expression taken from RFC 3986 Appendix B +# +# source://http-cookie//lib/http/cookie/uri_parser.rb#5 +HTTP::Cookie::URIParser::URIREGEX = T.let(T.unsafe(nil), Regexp) + # source://http-cookie//lib/http/cookie/version.rb#3 HTTP::Cookie::VERSION = T.let(T.unsafe(nil), String) diff --git a/sorbet/rbi/gems/httparty@0.21.0.rbi b/sorbet/rbi/gems/httparty@0.22.0.rbi similarity index 92% rename from sorbet/rbi/gems/httparty@0.21.0.rbi rename to sorbet/rbi/gems/httparty@0.22.0.rbi index ade434c9b..c4d86fb1d 100644 --- a/sorbet/rbi/gems/httparty@0.21.0.rbi +++ b/sorbet/rbi/gems/httparty@0.22.0.rbi @@ -15,44 +15,47 @@ module HTTParty mixes_in_class_methods ::HTTParty::ModuleInheritableAttributes::ClassMethods class << self - # source://httparty//lib/httparty.rb#668 + # source://httparty//lib/httparty.rb#679 + def build_request(*args, &block); end + + # source://httparty//lib/httparty.rb#667 def copy(*args, &block); end - # source://httparty//lib/httparty.rb#660 + # source://httparty//lib/httparty.rb#659 def delete(*args, &block); end - # source://httparty//lib/httparty.rb#644 + # source://httparty//lib/httparty.rb#643 def get(*args, &block); end - # source://httparty//lib/httparty.rb#672 + # source://httparty//lib/httparty.rb#671 def head(*args, &block); end # @private # - # source://httparty//lib/httparty.rb#26 + # source://httparty//lib/httparty.rb#21 def included(base); end - # source://httparty//lib/httparty.rb#664 + # source://httparty//lib/httparty.rb#663 def move(*args, &block); end - # source://httparty//lib/httparty.rb#629 + # source://httparty//lib/httparty.rb#628 def normalize_base_uri(url); end - # source://httparty//lib/httparty.rb#676 + # source://httparty//lib/httparty.rb#675 def options(*args, &block); end - # source://httparty//lib/httparty.rb#652 + # source://httparty//lib/httparty.rb#651 def patch(*args, &block); end - # source://httparty//lib/httparty.rb#648 + # source://httparty//lib/httparty.rb#647 def post(*args, &block); end - # source://httparty//lib/httparty.rb#656 + # source://httparty//lib/httparty.rb#655 def put(*args, &block); end end end -# source://httparty//lib/httparty.rb#640 +# source://httparty//lib/httparty.rb#639 class HTTParty::Basement include ::HTTParty include ::HTTParty::ModuleInheritableAttributes @@ -60,9 +63,16 @@ class HTTParty::Basement extend ::HTTParty::ModuleInheritableAttributes::ClassMethods class << self + # source://httparty//lib/httparty/module_inheritable_attributes.rb#32 def default_cookies; end + + # source://httparty//lib/httparty/module_inheritable_attributes.rb#32 def default_cookies=(_arg0); end + + # source://httparty//lib/httparty/module_inheritable_attributes.rb#32 def default_options; end + + # source://httparty//lib/httparty/module_inheritable_attributes.rb#32 def default_options=(_arg0); end end end @@ -101,7 +111,7 @@ end # * :+ssl_ca_file+: see HTTParty::ClassMethods.ssl_ca_file. # * :+ssl_ca_path+: see HTTParty::ClassMethods.ssl_ca_path. # -# source://httparty//lib/httparty.rb#69 +# source://httparty//lib/httparty.rb#64 module HTTParty::ClassMethods # Allows setting a base uri to be used for each request. # Will normalize uri to include http, etc. @@ -111,7 +121,7 @@ module HTTParty::ClassMethods # base_uri 'twitter.com' # end # - # source://httparty//lib/httparty.rb#112 + # source://httparty//lib/httparty.rb#107 def base_uri(uri = T.unsafe(nil)); end # Allows setting basic authentication username and password. @@ -121,9 +131,12 @@ module HTTParty::ClassMethods # basic_auth 'username', 'password' # end # - # source://httparty//lib/httparty.rb#123 + # source://httparty//lib/httparty.rb#118 def basic_auth(u, p); end + # source://httparty//lib/httparty.rb#589 + def build_request(http_method, path, options = T.unsafe(nil)); end + # Allows setting of SSL ciphers to use. This only works in Ruby 1.9+. # You can get a list of valid specific ciphers from OpenSSL::Cipher.ciphers. # You also can specify a cipher suite here, listed here at openssl.org: @@ -134,7 +147,7 @@ module HTTParty::ClassMethods # ciphers "RC4-SHA" # end # - # source://httparty//lib/httparty.rb#429 + # source://httparty//lib/httparty.rb#424 def ciphers(cipher_names); end # Allows setting a custom connection_adapter for the http connections @@ -151,17 +164,17 @@ module HTTParty::ClassMethods # end # @see HTTParty::ConnectionAdapter # - # source://httparty//lib/httparty.rb#504 + # source://httparty//lib/httparty.rb#499 def connection_adapter(custom_adapter = T.unsafe(nil), options = T.unsafe(nil)); end # @raise [ArgumentError] # - # source://httparty//lib/httparty.rb#246 + # source://httparty//lib/httparty.rb#241 def cookies(h = T.unsafe(nil)); end # Perform a COPY request to a path # - # source://httparty//lib/httparty.rb#566 + # source://httparty//lib/httparty.rb#561 def copy(path, options = T.unsafe(nil), &block); end # Set an output stream for debugging, defaults to $stderr. @@ -172,12 +185,12 @@ module HTTParty::ClassMethods # debug_output $stderr # end # - # source://httparty//lib/httparty.rb#226 + # source://httparty//lib/httparty.rb#221 def debug_output(stream = T.unsafe(nil)); end # Returns the value of attribute default_options. # - # source://httparty//lib/httparty.rb#594 + # source://httparty//lib/httparty.rb#596 def default_options; end # Allows setting default parameters to be appended to each request. @@ -190,7 +203,7 @@ module HTTParty::ClassMethods # # @raise [ArgumentError] # - # source://httparty//lib/httparty.rb#166 + # source://httparty//lib/httparty.rb#161 def default_params(h = T.unsafe(nil)); end # Allows setting a default timeout for all HTTP calls @@ -201,12 +214,12 @@ module HTTParty::ClassMethods # default_timeout 10 # end # - # source://httparty//lib/httparty.rb#179 + # source://httparty//lib/httparty.rb#174 def default_timeout(value); end # Perform a DELETE request to a path # - # source://httparty//lib/httparty.rb#556 + # source://httparty//lib/httparty.rb#551 def delete(path, options = T.unsafe(nil), &block); end # Allows setting digest authentication username and password. @@ -216,7 +229,7 @@ module HTTParty::ClassMethods # digest_auth 'username', 'password' # end # - # source://httparty//lib/httparty.rb#133 + # source://httparty//lib/httparty.rb#128 def digest_auth(u, p); end # Do not send rails style query strings. @@ -238,7 +251,7 @@ module HTTParty::ClassMethods # disable_rails_query_string_format # end # - # source://httparty//lib/httparty.rb#155 + # source://httparty//lib/httparty.rb#150 def disable_rails_query_string_format; end # Proceed to the location header when an HTTP response dictates a redirect. @@ -251,7 +264,7 @@ module HTTParty::ClassMethods # follow_redirects true # end # - # source://httparty//lib/httparty.rb#260 + # source://httparty//lib/httparty.rb#255 def follow_redirects(value = T.unsafe(nil)); end # Allows setting the format with which to parse. @@ -262,7 +275,7 @@ module HTTParty::ClassMethods # format :json # end # - # source://httparty//lib/httparty.rb#271 + # source://httparty//lib/httparty.rb#266 def format(f = T.unsafe(nil)); end # Allows making a get request to a url. @@ -278,12 +291,12 @@ module HTTParty::ClassMethods # # ie: http://foo.com/resource.json?limit=10 # Foo.get('http://foo.com/resource.json', query: {limit: 10}) # - # source://httparty//lib/httparty.rb#525 + # source://httparty//lib/httparty.rb#520 def get(path, options = T.unsafe(nil), &block); end # Perform a HEAD request to a path # - # source://httparty//lib/httparty.rb#571 + # source://httparty//lib/httparty.rb#566 def head(path, options = T.unsafe(nil), &block); end # Allows setting HTTP headers to be used for each request. @@ -293,7 +306,7 @@ module HTTParty::ClassMethods # headers 'Accept' => 'text/html' # end # - # source://httparty//lib/httparty.rb#236 + # source://httparty//lib/httparty.rb#231 def headers(h = T.unsafe(nil)); end # Allows setting http proxy information to be used @@ -303,10 +316,10 @@ module HTTParty::ClassMethods # http_proxy 'http://foo.com', 80, 'user', 'pass' # end # - # source://httparty//lib/httparty.rb#98 + # source://httparty//lib/httparty.rb#93 def http_proxy(addr = T.unsafe(nil), port = T.unsafe(nil), user = T.unsafe(nil), pass = T.unsafe(nil)); end - # source://httparty//lib/httparty.rb#586 + # source://httparty//lib/httparty.rb#581 def lock(path, options = T.unsafe(nil), &block); end # Turns on logging @@ -316,7 +329,7 @@ module HTTParty::ClassMethods # logger Logger.new('http_logger'), :info, :apache # end # - # source://httparty//lib/httparty.rb#76 + # source://httparty//lib/httparty.rb#71 def logger(logger, level = T.unsafe(nil), format = T.unsafe(nil)); end # Declare that you wish to maintain the chosen HTTP method across redirects. @@ -332,17 +345,17 @@ module HTTParty::ClassMethods # maintain_method_across_redirects true # end # - # source://httparty//lib/httparty.rb#317 + # source://httparty//lib/httparty.rb#312 def maintain_method_across_redirects(value = T.unsafe(nil)); end # Perform a MKCOL request to a path # - # source://httparty//lib/httparty.rb#582 + # source://httparty//lib/httparty.rb#577 def mkcol(path, options = T.unsafe(nil), &block); end # Perform a MOVE request to a path # - # source://httparty//lib/httparty.rb#561 + # source://httparty//lib/httparty.rb#556 def move(path, options = T.unsafe(nil), &block); end # Declare whether or not to follow redirects. When true, an @@ -364,7 +377,7 @@ module HTTParty::ClassMethods # end # @see HTTParty::ResponseError#response # - # source://httparty//lib/httparty.rb#300 + # source://httparty//lib/httparty.rb#295 def no_follow(value = T.unsafe(nil)); end # Allows setting a default open_timeout for all HTTP calls in seconds @@ -374,12 +387,12 @@ module HTTParty::ClassMethods # open_timeout 10 # end # - # source://httparty//lib/httparty.rb#190 + # source://httparty//lib/httparty.rb#185 def open_timeout(value); end # Perform an OPTIONS request to a path # - # source://httparty//lib/httparty.rb#577 + # source://httparty//lib/httparty.rb#572 def options(path, options = T.unsafe(nil), &block); end # Allows setting a custom parser for the response. @@ -389,12 +402,12 @@ module HTTParty::ClassMethods # parser Proc.new {|data| ...} # end # - # source://httparty//lib/httparty.rb#469 + # source://httparty//lib/httparty.rb#464 def parser(custom_parser = T.unsafe(nil)); end # Perform a PATCH request to a path # - # source://httparty//lib/httparty.rb#546 + # source://httparty//lib/httparty.rb#541 def patch(path, options = T.unsafe(nil), &block); end # Allows setting a PEM file to be used @@ -404,7 +417,7 @@ module HTTParty::ClassMethods # pem File.read('/home/user/my.pem'), "optional password" # end # - # source://httparty//lib/httparty.rb#345 + # source://httparty//lib/httparty.rb#340 def pem(pem_contents, password = T.unsafe(nil)); end # Allows setting a PKCS12 file to be used @@ -414,7 +427,7 @@ module HTTParty::ClassMethods # pkcs12 File.read('/home/user/my.p12'), "password" # end # - # source://httparty//lib/httparty.rb#356 + # source://httparty//lib/httparty.rb#351 def pkcs12(p12_contents, password); end # Allows making a post request to a url. @@ -430,12 +443,12 @@ module HTTParty::ClassMethods # # which appends the parameters to the URI. # Foo.post('http://foo.com/resources', query: {bar: 'baz'}) # - # source://httparty//lib/httparty.rb#541 + # source://httparty//lib/httparty.rb#536 def post(path, options = T.unsafe(nil), &block); end # Perform a PUT request to a path # - # source://httparty//lib/httparty.rb#551 + # source://httparty//lib/httparty.rb#546 def put(path, options = T.unsafe(nil), &block); end # Override the way query strings are normalized. @@ -466,17 +479,17 @@ module HTTParty::ClassMethods # @yield [Hash, String] query string # @yieldreturn [Array] an array that will later be joined with '&' # - # source://httparty//lib/httparty.rb#389 + # source://httparty//lib/httparty.rb#384 def query_string_normalizer(normalizer); end # Raises HTTParty::ResponseError if response's code matches this statuses # # class Foo # include HTTParty - # raise_on [404, 500] + # raise_on [404, 500, '5[0-9]*'] # end # - # source://httparty//lib/httparty.rb#88 + # source://httparty//lib/httparty.rb#83 def raise_on(codes = T.unsafe(nil)); end # Allows setting a default read_timeout for all HTTP calls in seconds @@ -486,7 +499,7 @@ module HTTParty::ClassMethods # read_timeout 10 # end # - # source://httparty//lib/httparty.rb#201 + # source://httparty//lib/httparty.rb#196 def read_timeout(value); end # Declare that you wish to resend the full HTTP request across redirects, @@ -503,7 +516,7 @@ module HTTParty::ClassMethods # resend_on_redirect # end # - # source://httparty//lib/httparty.rb#335 + # source://httparty//lib/httparty.rb#330 def resend_on_redirect(value = T.unsafe(nil)); end # Deactivate automatic decompression of the response body. @@ -519,7 +532,7 @@ module HTTParty::ClassMethods # skip_decompression # end # - # source://httparty//lib/httparty.rb#416 + # source://httparty//lib/httparty.rb#411 def skip_decompression(value = T.unsafe(nil)); end # Allows setting an OpenSSL certificate authority file. The file @@ -535,7 +548,7 @@ module HTTParty::ClassMethods # ssl_ca_file '/etc/ssl/certs/ca-certificates.crt' # end # - # source://httparty//lib/httparty.rb#445 + # source://httparty//lib/httparty.rb#440 def ssl_ca_file(path); end # Allows setting an OpenSSL certificate authority path (directory). @@ -549,7 +562,7 @@ module HTTParty::ClassMethods # ssl_ca_path '/etc/ssl/certs/' # end # - # source://httparty//lib/httparty.rb#459 + # source://httparty//lib/httparty.rb#454 def ssl_ca_path(path); end # Allows setting of SSL version to use. This only works in Ruby 1.9+. @@ -560,10 +573,10 @@ module HTTParty::ClassMethods # ssl_version :SSLv3 # end # - # source://httparty//lib/httparty.rb#400 + # source://httparty//lib/httparty.rb#395 def ssl_version(version); end - # source://httparty//lib/httparty.rb#590 + # source://httparty//lib/httparty.rb#585 def unlock(path, options = T.unsafe(nil), &block); end # Allows setting a custom URI adapter. @@ -575,7 +588,7 @@ module HTTParty::ClassMethods # # @raise [ArgumentError] # - # source://httparty//lib/httparty.rb#484 + # source://httparty//lib/httparty.rb#479 def uri_adapter(uri_adapter); end # Allows setting a default write_timeout for all HTTP calls in seconds @@ -586,26 +599,26 @@ module HTTParty::ClassMethods # write_timeout 10 # end # - # source://httparty//lib/httparty.rb#213 + # source://httparty//lib/httparty.rb#208 def write_timeout(value); end private - # source://httparty//lib/httparty.rb#602 + # source://httparty//lib/httparty.rb#604 def ensure_method_maintained_across_redirects(options); end - # source://httparty//lib/httparty.rb#608 + # source://httparty//lib/httparty.rb#610 def perform_request(http_method, path, options, &block); end - # source://httparty//lib/httparty.rb#615 + # source://httparty//lib/httparty.rb#614 def process_cookies(options); end - # source://httparty//lib/httparty.rb#621 + # source://httparty//lib/httparty.rb#620 def validate_format; end # @raise [ArgumentError] # - # source://httparty//lib/httparty.rb#598 + # source://httparty//lib/httparty.rb#600 def validate_timeout_argument(timeout_type, value); end end @@ -698,34 +711,31 @@ class HTTParty::ConnectionAdapter # @return [Boolean] # - # source://httparty//lib/httparty/connection_adapter.rb#188 + # source://httparty//lib/httparty/connection_adapter.rb#169 def add_max_retries?(max_retries); end # @return [Boolean] # - # source://httparty//lib/httparty/connection_adapter.rb#184 + # source://httparty//lib/httparty/connection_adapter.rb#165 def add_timeout?(timeout); end - # source://httparty//lib/httparty/connection_adapter.rb#208 + # source://httparty//lib/httparty/connection_adapter.rb#189 def attach_ssl_certificates(http, options); end - # source://httparty//lib/httparty/connection_adapter.rb#192 + # source://httparty//lib/httparty/connection_adapter.rb#173 def clean_host(host); end - # source://httparty//lib/httparty/connection_adapter.rb#176 - def from_ruby_version(ruby_version, option: T.unsafe(nil), warn: T.unsafe(nil)); end - # @return [Boolean] # - # source://httparty//lib/httparty/connection_adapter.rb#200 + # source://httparty//lib/httparty/connection_adapter.rb#181 def ssl_implied?(uri); end - # source://httparty//lib/httparty/connection_adapter.rb#196 + # source://httparty//lib/httparty/connection_adapter.rb#177 def strip_ipv6_brackets(host); end # @return [Boolean] # - # source://httparty//lib/httparty/connection_adapter.rb#204 + # source://httparty//lib/httparty/connection_adapter.rb#185 def verify_ssl_certificate?; end class << self @@ -1106,22 +1116,22 @@ class HTTParty::Logger::LogstashFormatter private - # source://httparty//lib/httparty/logger/logstash_formatter.rb#56 + # source://httparty//lib/httparty/logger/logstash_formatter.rb#57 def content_length; end - # source://httparty//lib/httparty/logger/logstash_formatter.rb#44 + # source://httparty//lib/httparty/logger/logstash_formatter.rb#45 def current_time; end - # source://httparty//lib/httparty/logger/logstash_formatter.rb#48 + # source://httparty//lib/httparty/logger/logstash_formatter.rb#49 def http_method; end # source://httparty//lib/httparty/logger/logstash_formatter.rb#26 def logstash_message; end - # source://httparty//lib/httparty/logger/logstash_formatter.rb#40 + # source://httparty//lib/httparty/logger/logstash_formatter.rb#41 def message; end - # source://httparty//lib/httparty/logger/logstash_formatter.rb#52 + # source://httparty//lib/httparty/logger/logstash_formatter.rb#53 def path; end # Returns the value of attribute request. @@ -1228,24 +1238,24 @@ class HTTParty::Parser protected - # source://httparty//lib/httparty/parser.rb#130 + # source://httparty//lib/httparty/parser.rb#132 def csv; end - # source://httparty//lib/httparty/parser.rb#134 + # source://httparty//lib/httparty/parser.rb#137 def html; end - # source://httparty//lib/httparty/parser.rb#126 + # source://httparty//lib/httparty/parser.rb#127 def json; end - # source://httparty//lib/httparty/parser.rb#146 + # source://httparty//lib/httparty/parser.rb#149 def parse_supported_format; end - # source://httparty//lib/httparty/parser.rb#138 + # source://httparty//lib/httparty/parser.rb#141 def plain; end # @return [Boolean] # - # source://httparty//lib/httparty/parser.rb#142 + # source://httparty//lib/httparty/parser.rb#145 def supports_format?; end # source://httparty//lib/httparty/parser.rb#120 @@ -1289,7 +1299,7 @@ end # source://httparty//lib/httparty/parser.rb#42 HTTParty::Parser::SupportedFormats = T.let(T.unsafe(nil), Hash) -# source://httparty//lib/httparty/parser.rb#124 +# source://httparty//lib/httparty/parser.rb#125 HTTParty::Parser::UTF8_BOM = T.let(T.unsafe(nil), String) # Exception that is raised when request has redirected too many times. @@ -1408,16 +1418,23 @@ class HTTParty::Request # source://httparty//lib/httparty/request.rb#292 def assume_utf16_is_big_endian; end - # source://httparty//lib/httparty/request.rb#365 + # source://httparty//lib/httparty/request.rb#380 def capture_cookies(response); end - # source://httparty//lib/httparty/request.rb#341 + # source://httparty//lib/httparty/request.rb#348 def check_duplicate_location_header; end + # Some Web Application Firewalls reject incoming GET requests that have a body + # if we redirect, and the resulting verb is GET then we will clear the body that + # may be left behind from the initiating request + # + # source://httparty//lib/httparty/request.rb#375 + def clear_body; end + # source://httparty//lib/httparty/request.rb#200 def credentials; end - # source://httparty//lib/httparty/request.rb#406 + # source://httparty//lib/httparty/request.rb#421 def decompress(body, encoding); end # @return [Boolean] @@ -1430,19 +1447,22 @@ class HTTParty::Request # source://httparty//lib/httparty/request.rb#257 def digest_auth?; end - # source://httparty//lib/httparty/request.rb#410 + # source://httparty//lib/httparty/request.rb#425 def encode_text(text, content_type); end # Uses the HTTP Content-Type header to determine the format of the # response It compares the MIME type returned to the types stored in the # SupportedFormats hash # - # source://httparty//lib/httparty/request.rb#378 + # source://httparty//lib/httparty/request.rb#393 def format_from_mimetype(mimetype); end - # source://httparty//lib/httparty/request.rb#334 + # source://httparty//lib/httparty/request.rb#341 def handle_host_redirection; end + # source://httparty//lib/httparty/request.rb#317 + def handle_redirection(&block); end + # source://httparty//lib/httparty/request.rb#296 def handle_response(raw_body, &block); end @@ -1452,7 +1472,7 @@ class HTTParty::Request # source://httparty//lib/httparty/request.rb#212 def normalize_query(query); end - # source://httparty//lib/httparty/request.rb#361 + # source://httparty//lib/httparty/request.rb#368 def parse_response(body); end # source://httparty//lib/httparty/request.rb#208 @@ -1460,7 +1480,7 @@ class HTTParty::Request # @return [Boolean] # - # source://httparty//lib/httparty/request.rb#394 + # source://httparty//lib/httparty/request.rb#409 def post?; end # source://httparty//lib/httparty/request.rb#277 @@ -1476,7 +1496,7 @@ class HTTParty::Request # @return [Boolean] # - # source://httparty//lib/httparty/request.rb#352 + # source://httparty//lib/httparty/request.rb#359 def response_redirects?; end # @return [Boolean] @@ -1486,10 +1506,10 @@ class HTTParty::Request # @return [Boolean] # - # source://httparty//lib/httparty/request.rb#348 + # source://httparty//lib/httparty/request.rb#355 def send_authorization_header?; end - # source://httparty//lib/httparty/request.rb#398 + # source://httparty//lib/httparty/request.rb#413 def set_basic_auth_from_uri; end # source://httparty//lib/httparty/request.rb#273 @@ -1503,7 +1523,7 @@ class HTTParty::Request # @raise [HTTParty::RedirectionTooDeep.new(last_response)] # - # source://httparty//lib/httparty/request.rb#384 + # source://httparty//lib/httparty/request.rb#399 def validate; end class << self @@ -1543,12 +1563,12 @@ class HTTParty::Request::Body # source://httparty//lib/httparty/request/body.rb#71 def file?(object); end - # source://httparty//lib/httparty/request/body.rb#98 + # source://httparty//lib/httparty/request/body.rb#99 def file_name(object); end # Returns the value of attribute force_multipart. # - # source://httparty//lib/httparty/request/body.rb#102 + # source://httparty//lib/httparty/request/body.rb#103 def force_multipart; end # source://httparty//lib/httparty/request/body.rb#42 @@ -1564,12 +1584,12 @@ class HTTParty::Request::Body # Returns the value of attribute params. # - # source://httparty//lib/httparty/request/body.rb#102 + # source://httparty//lib/httparty/request/body.rb#103 def params; end # Returns the value of attribute query_string_normalizer. # - # source://httparty//lib/httparty/request/body.rb#102 + # source://httparty//lib/httparty/request/body.rb#103 def query_string_normalizer; end end diff --git a/sorbet/rbi/gems/jb@0.8.0.rbi b/sorbet/rbi/gems/jb@0.8.2.rbi similarity index 97% rename from sorbet/rbi/gems/jb@0.8.0.rbi rename to sorbet/rbi/gems/jb@0.8.2.rbi index b3c039916..fc5d7e576 100644 --- a/sorbet/rbi/gems/jb@0.8.0.rbi +++ b/sorbet/rbi/gems/jb@0.8.2.rbi @@ -30,7 +30,7 @@ module ActionController::ApiRendering def render_to_body(options = T.unsafe(nil)); end end -# Mokey-patches for Action View 6+ +# Monkey-patches for Action View 6+ # # source://jb//lib/jb/version.rb#3 module Jb; end diff --git a/sorbet/rbi/gems/libv8-node@18.16.0.0.rbi b/sorbet/rbi/gems/libv8-node@22.5.1.0.rbi similarity index 100% rename from sorbet/rbi/gems/libv8-node@18.16.0.0.rbi rename to sorbet/rbi/gems/libv8-node@22.5.1.0.rbi diff --git a/sorbet/rbi/gems/listen@3.8.0.rbi b/sorbet/rbi/gems/listen@3.9.0.rbi similarity index 97% rename from sorbet/rbi/gems/listen@3.8.0.rbi rename to sorbet/rbi/gems/listen@3.9.0.rbi index 9daba297d..dcf6a6c77 100644 --- a/sorbet/rbi/gems/listen@3.8.0.rbi +++ b/sorbet/rbi/gems/listen@3.9.0.rbi @@ -11,14 +11,29 @@ # source://listen//lib/listen/logger.rb#3 module Listen class << self - # source://listen//lib/listen/logger.rb#12 + # source://listen//lib/listen/logger.rb#19 + def adapter_warn(message); end + + # Returns the value of attribute adapter_warn_behavior. + # + # source://listen//lib/listen/logger.rb#13 + def adapter_warn_behavior; end + + # Sets the attribute adapter_warn_behavior + # + # @param value the value to set the attribute adapter_warn_behavior to. + # + # source://listen//lib/listen/logger.rb#13 + def adapter_warn_behavior=(_arg0); end + + # source://listen//lib/listen/logger.rb#15 def logger; end # Sets the attribute logger # # @param value the value to set the attribute logger to. # - # source://listen//lib/listen/logger.rb#10 + # source://listen//lib/listen/logger.rb#12 def logger=(_arg0); end # This is used by the `listen` binary to handle Ctrl-C @@ -40,7 +55,10 @@ module Listen private - # source://listen//lib/listen/logger.rb#18 + # source://listen//lib/listen/logger.rb#50 + def adapter_warn_behavior_callback(message); end + + # source://listen//lib/listen/logger.rb#32 def default_logger; end end end @@ -1052,11 +1070,17 @@ class Listen::Record::SymlinkDetector # source://listen//lib/listen/record/symlink_detector.rb#28 def verify_unwatched!(entry); end + # Leaving this stub here since some warning work-arounds were referring to it. + # Deprecated. Will be removed in Listen v4.0. + # + # source://listen//lib/listen/record/symlink_detector.rb#35 + def warn(message); end + private # @raise [::Listen::Error::SymlinkLoop] # - # source://listen//lib/listen/record/symlink_detector.rb#35 + # source://listen//lib/listen/record/symlink_detector.rb#41 def _fail(symlinked, real_path); end end diff --git a/sorbet/rbi/gems/lumberjack@1.2.9.rbi b/sorbet/rbi/gems/lumberjack@1.2.10.rbi similarity index 95% rename from sorbet/rbi/gems/lumberjack@1.2.9.rbi rename to sorbet/rbi/gems/lumberjack@1.2.10.rbi index 33a97137e..8c1222a8c 100644 --- a/sorbet/rbi/gems/lumberjack@1.2.9.rbi +++ b/sorbet/rbi/gems/lumberjack@1.2.10.rbi @@ -10,9 +10,7 @@ module ActiveSupport::TaggedLogging extend ::Lumberjack::TaggedLogging::ClassMethods end -# frozen_string_literals: true -# -# source://lumberjack//lib/lumberjack.rb#8 +# source://lumberjack//lib/lumberjack.rb#9 module Lumberjack class << self # Contexts can be used to store tags that will be attached to all log entries in the block. @@ -26,21 +24,21 @@ module Lumberjack # # @return [Lumberjack::Context] The current context if called without a block. # - # source://lumberjack//lib/lumberjack.rb#63 + # source://lumberjack//lib/lumberjack.rb#64 def context(&block); end # Return true if inside a context block. # # @return [Boolean] # - # source://lumberjack//lib/lumberjack.rb#89 + # source://lumberjack//lib/lumberjack.rb#90 def context?; end # Return the tags from the current context or nil if there are no tags. # # @return [Hash, nil] # - # source://lumberjack//lib/lumberjack.rb#96 + # source://lumberjack//lib/lumberjack.rb#97 def context_tags; end # Set tags on the current context @@ -48,7 +46,7 @@ module Lumberjack # @param tags [Hash] The tags to set. # @return [void] # - # source://lumberjack//lib/lumberjack.rb#105 + # source://lumberjack//lib/lumberjack.rb#106 def tag(tags); end # Define a unit of work within a block. Within the block supplied to this @@ -64,14 +62,14 @@ module Lumberjack # @param id [String] The id for the unit of work. # @return [void] # - # source://lumberjack//lib/lumberjack.rb#38 + # source://lumberjack//lib/lumberjack.rb#39 def unit_of_work(id = T.unsafe(nil)); end # Get the UniqueIdentifier for the current unit of work. # # @return [String, nil] The id for the current unit of work. # - # source://lumberjack//lib/lumberjack.rb#49 + # source://lumberjack//lib/lumberjack.rb#50 def unit_of_work_id; end # Set the context to use within a block. @@ -79,7 +77,7 @@ module Lumberjack # @param context [Lumberjack::Context] The context to use within the block. # @return [Object] The result of the block. # - # source://lumberjack//lib/lumberjack.rb#76 + # source://lumberjack//lib/lumberjack.rb#77 def use_context(context, &block); end end end @@ -855,7 +853,7 @@ class Lumberjack::Formatter::TruncateFormatter def call(obj); end end -# source://lumberjack//lib/lumberjack.rb#9 +# source://lumberjack//lib/lumberjack.rb#10 Lumberjack::LINE_SEPARATOR = T.let(T.unsafe(nil), String) # An entry in a log is a data structure that captures the log message as well as @@ -1046,7 +1044,7 @@ class Lumberjack::Logger # @param msg [Object] The message to log. # @return [void] # - # source://lumberjack//lib/lumberjack/logger.rb#413 + # source://lumberjack//lib/lumberjack/logger.rb#417 def <<(msg); end # ::Logger compatible method to add a log entry. @@ -1056,7 +1054,7 @@ class Lumberjack::Logger # @param progname [String] The name of the program that is logging the message. # @return [void] # - # source://lumberjack//lib/lumberjack/logger.rb#225 + # source://lumberjack//lib/lumberjack/logger.rb#229 def add(severity, message = T.unsafe(nil), progname = T.unsafe(nil), &block); end # Add a message to the log with a given severity. The message can be either @@ -1079,21 +1077,21 @@ class Lumberjack::Logger # @param tags [Hash] The tags to add to the log entry. # @return [void] # - # source://lumberjack//lib/lumberjack/logger.rb#184 + # source://lumberjack//lib/lumberjack/logger.rb#188 def add_entry(severity, message, progname = T.unsafe(nil), tags = T.unsafe(nil)); end # Close the logging device. # # @return [void] # - # source://lumberjack//lib/lumberjack/logger.rb#251 + # source://lumberjack//lib/lumberjack/logger.rb#255 def close; end # Returns +true+ if the logging device is closed. # # @return [Boolean] +true+ if the logging device is closed. # - # source://lumberjack//lib/lumberjack/logger.rb#260 + # source://lumberjack//lib/lumberjack/logger.rb#264 def closed?; end # Get the timestamp format on the device if it has one. @@ -1119,21 +1117,21 @@ class Lumberjack::Logger # if the message is passed in a block. # @return [void] # - # source://lumberjack//lib/lumberjack/logger.rb#379 + # source://lumberjack//lib/lumberjack/logger.rb#383 def debug(message_or_progname_or_tags = T.unsafe(nil), progname_or_tags = T.unsafe(nil), &block); end # Set the log level to debug. # # @return [void] # - # source://lumberjack//lib/lumberjack/logger.rb#393 + # source://lumberjack//lib/lumberjack/logger.rb#397 def debug!; end # Return +true+ if +DEBUG+ messages are being logged. # # @return [Boolean] # - # source://lumberjack//lib/lumberjack/logger.rb#386 + # source://lumberjack//lib/lumberjack/logger.rb#390 def debug?; end # The device being written to @@ -1154,21 +1152,21 @@ class Lumberjack::Logger # if the message is passed in a block. # @return [void] # - # source://lumberjack//lib/lumberjack/logger.rb#304 + # source://lumberjack//lib/lumberjack/logger.rb#308 def error(message_or_progname_or_tags = T.unsafe(nil), progname_or_tags = T.unsafe(nil), &block); end # Set the log level to error. # # @return [void] # - # source://lumberjack//lib/lumberjack/logger.rb#318 + # source://lumberjack//lib/lumberjack/logger.rb#322 def error!; end # Return +true+ if +ERROR+ messages are being logged. # # @return [Boolean] # - # source://lumberjack//lib/lumberjack/logger.rb#311 + # source://lumberjack//lib/lumberjack/logger.rb#315 def error?; end # Log a +FATAL+ message. The message can be passed in either the +message+ argument or in a block. @@ -1179,35 +1177,35 @@ class Lumberjack::Logger # if the message is passed in a block. # @return [void] # - # source://lumberjack//lib/lumberjack/logger.rb#279 + # source://lumberjack//lib/lumberjack/logger.rb#283 def fatal(message_or_progname_or_tags = T.unsafe(nil), progname_or_tags = T.unsafe(nil), &block); end # Set the log level to fatal. # # @return [void] # - # source://lumberjack//lib/lumberjack/logger.rb#293 + # source://lumberjack//lib/lumberjack/logger.rb#297 def fatal!; end # Return +true+ if +FATAL+ messages are being logged. # # @return [Boolean] # - # source://lumberjack//lib/lumberjack/logger.rb#286 + # source://lumberjack//lib/lumberjack/logger.rb#290 def fatal?; end # Flush the logging device. Messages are not guaranteed to be written until this method is called. # # @return [void] # - # source://lumberjack//lib/lumberjack/logger.rb#242 + # source://lumberjack//lib/lumberjack/logger.rb#246 def flush; end # Get the Lumberjack::Formatter used to format objects for logging as messages. # # @return [Lumberjack::Formatter] The formatter. # - # source://lumberjack//lib/lumberjack/logger.rb#141 + # source://lumberjack//lib/lumberjack/logger.rb#145 def formatter; end # Set the Lumberjack::Formatter used to format objects for logging as messages. @@ -1215,7 +1213,7 @@ class Lumberjack::Logger # @param value [Lumberjack::Formatter, Object] The formatter to use. # @return [void] # - # source://lumberjack//lib/lumberjack/logger.rb#134 + # source://lumberjack//lib/lumberjack/logger.rb#138 def formatter=(value); end # Log an +INFO+ message. The message can be passed in either the +message+ argument or in a block. @@ -1226,21 +1224,21 @@ class Lumberjack::Logger # if the message is passed in a block. # @return [void] # - # source://lumberjack//lib/lumberjack/logger.rb#354 + # source://lumberjack//lib/lumberjack/logger.rb#358 def info(message_or_progname_or_tags = T.unsafe(nil), progname_or_tags = T.unsafe(nil), &block); end # Set the log level to info. # # @return [void] # - # source://lumberjack//lib/lumberjack/logger.rb#368 + # source://lumberjack//lib/lumberjack/logger.rb#372 def info!; end # Return +true+ if +INFO+ messages are being logged. # # @return [Boolean] # - # source://lumberjack//lib/lumberjack/logger.rb#361 + # source://lumberjack//lib/lumberjack/logger.rb#365 def info?; end # The time that the device was last flushed. @@ -1272,14 +1270,14 @@ class Lumberjack::Logger # @param progname [String] The name of the program that is logging the message. # @return [void] # - # source://lumberjack//lib/lumberjack/logger.rb#225 + # source://lumberjack//lib/lumberjack/logger.rb#229 def log(severity, message = T.unsafe(nil), progname = T.unsafe(nil), &block); end # Get the program name associated with log messages. # # @return [String] # - # source://lumberjack//lib/lumberjack/logger.rb#456 + # source://lumberjack//lib/lumberjack/logger.rb#460 def progname; end # Set the name of the program to attach to log entries. @@ -1294,14 +1292,14 @@ class Lumberjack::Logger # @param tag_names [Array] The tags to remove. # @return [void] # - # source://lumberjack//lib/lumberjack/logger.rb#489 + # source://lumberjack//lib/lumberjack/logger.rb#493 def remove_tag(*tag_names); end # Reopen the logging device. # # @param logdev [Object] passed through to the logging device. # - # source://lumberjack//lib/lumberjack/logger.rb#267 + # source://lumberjack//lib/lumberjack/logger.rb#271 def reopen(logdev = T.unsafe(nil)); end # Set the program name that is associated with log messages. If a block @@ -1310,7 +1308,7 @@ class Lumberjack::Logger # @param value [String] The program name to use. # @return [void] # - # source://lumberjack//lib/lumberjack/logger.rb#445 + # source://lumberjack//lib/lumberjack/logger.rb#449 def set_progname(value, &block); end # Get the level of severity of entries that are logged. Entries with a lower @@ -1342,7 +1340,7 @@ class Lumberjack::Logger # @param temporary_level [Integer, String, Symbol] The log level to use inside the block. # @return [Object] The result of the block. # - # source://lumberjack//lib/lumberjack/logger.rb#429 + # source://lumberjack//lib/lumberjack/logger.rb#433 def silence(temporary_level = T.unsafe(nil), &block); end # Set +silencer+ to false to disable silencing the log. @@ -1364,7 +1362,7 @@ class Lumberjack::Logger # @param tags [Hash] The tags to set. # @return [void] # - # source://lumberjack//lib/lumberjack/logger.rb#468 + # source://lumberjack//lib/lumberjack/logger.rb#472 def tag(tags, &block); end # The TagFormatter used for formatting tags for output @@ -1387,7 +1385,7 @@ class Lumberjack::Logger # # @return [Lumberjack::Logger] self. # - # source://lumberjack//lib/lumberjack/logger.rb#159 + # source://lumberjack//lib/lumberjack/logger.rb#163 def tagged_logger!; end # Return all tags in scope on the logger including global tags set on the Lumberjack @@ -1395,7 +1393,7 @@ class Lumberjack::Logger # # @return [Hash] # - # source://lumberjack//lib/lumberjack/logger.rb#502 + # source://lumberjack//lib/lumberjack/logger.rb#506 def tags; end # Log a message when the severity is not known. Unknown messages will always appear in the log. @@ -1407,7 +1405,7 @@ class Lumberjack::Logger # if the message is passed in a block. # @return [void] # - # source://lumberjack//lib/lumberjack/logger.rb#405 + # source://lumberjack//lib/lumberjack/logger.rb#409 def unknown(message_or_progname_or_tags = T.unsafe(nil), progname_or_tags = T.unsafe(nil), &block); end # Remove all tags on the current logger and logging context within a block. @@ -1416,7 +1414,7 @@ class Lumberjack::Logger # # @return [void] # - # source://lumberjack//lib/lumberjack/logger.rb#517 + # source://lumberjack//lib/lumberjack/logger.rb#521 def untagged(&block); end # Log a +WARN+ message. The message can be passed in either the +message+ argument or in a block. @@ -1427,56 +1425,64 @@ class Lumberjack::Logger # if the message is passed in a block. # @return [void] # - # source://lumberjack//lib/lumberjack/logger.rb#329 + # source://lumberjack//lib/lumberjack/logger.rb#333 def warn(message_or_progname_or_tags = T.unsafe(nil), progname_or_tags = T.unsafe(nil), &block); end # Set the log level to warn. # # @return [void] # - # source://lumberjack//lib/lumberjack/logger.rb#343 + # source://lumberjack//lib/lumberjack/logger.rb#347 def warn!; end # Return +true+ if +WARN+ messages are being logged. # # @return [Boolean] # - # source://lumberjack//lib/lumberjack/logger.rb#336 + # source://lumberjack//lib/lumberjack/logger.rb#340 def warn?; end + # Adjust the log level during the block execution for the current Fiber only. + # + # @param severity [Integer, Symbol, String] The severity level. + # @return [Object] The result of the block. + # + # source://lumberjack//lib/lumberjack/logger.rb#130 + def with_level(severity, &block); end + private # Dereference arguments to log calls so we can have methods with compatibility with ::Logger # - # source://lumberjack//lib/lumberjack/logger.rb#535 + # source://lumberjack//lib/lumberjack/logger.rb#539 def call_add_entry(severity, message_or_progname_or_tags, progname_or_tags, &block); end # Create a thread that will periodically call flush. # - # source://lumberjack//lib/lumberjack/logger.rb#623 + # source://lumberjack//lib/lumberjack/logger.rb#627 def create_flusher_thread(flush_seconds); end # Open a logging device. # - # source://lumberjack//lib/lumberjack/logger.rb#592 + # source://lumberjack//lib/lumberjack/logger.rb#596 def open_device(device, options); end # Set a local value for a thread tied to this object within a block. # - # source://lumberjack//lib/lumberjack/logger.rb#581 + # source://lumberjack//lib/lumberjack/logger.rb#585 def push_thread_local_value(name, value); end # Set a local value for a thread tied to this object. # - # source://lumberjack//lib/lumberjack/logger.rb#560 + # source://lumberjack//lib/lumberjack/logger.rb#564 def set_thread_local_value(name, value); end # Get a local value for a thread tied to this object. # - # source://lumberjack//lib/lumberjack/logger.rb#575 + # source://lumberjack//lib/lumberjack/logger.rb#579 def thread_local_value(name); end - # source://lumberjack//lib/lumberjack/logger.rb#613 + # source://lumberjack//lib/lumberjack/logger.rb#617 def write_to_device(entry); end end @@ -1530,6 +1536,14 @@ end # source://lumberjack//lib/lumberjack/severity.rb#5 module Lumberjack::Severity class << self + # Coerce a value to a severity level. + # + # @param value [Integer, String, Symbol] The value to coerce. + # @return [Integer] The severity level. + # + # source://lumberjack//lib/lumberjack/severity.rb#37 + def coerce(value); end + # Convert a severity label to a level. # # @param label [String, Symbol] The severity label to convert. diff --git a/sorbet/rbi/gems/mime-types-data@3.2023.0808.rbi b/sorbet/rbi/gems/mime-types-data@3.2024.0702.rbi similarity index 56% rename from sorbet/rbi/gems/mime-types-data@3.2023.0808.rbi rename to sorbet/rbi/gems/mime-types-data@3.2024.0702.rbi index f6346d08a..92faaf3ba 100644 --- a/sorbet/rbi/gems/mime-types-data@3.2023.0808.rbi +++ b/sorbet/rbi/gems/mime-types-data@3.2024.0702.rbi @@ -12,96 +12,96 @@ module MIME; end class MIME::Types extend ::Enumerable - # source://mime-types/3.5.0/lib/mime/types.rb#75 + # source://mime-types/3.5.2/lib/mime/types.rb#75 def initialize; end - # source://mime-types/3.5.0/lib/mime/types.rb#125 + # source://mime-types/3.5.2/lib/mime/types.rb#125 def [](type_id, complete: T.unsafe(nil), registered: T.unsafe(nil)); end - # source://mime-types/3.5.0/lib/mime/types.rb#167 + # source://mime-types/3.5.2/lib/mime/types.rb#167 def add(*types); end - # source://mime-types/3.5.0/lib/mime/types.rb#188 + # source://mime-types/3.5.2/lib/mime/types.rb#188 def add_type(type, quiet = T.unsafe(nil)); end - # source://mime-types/3.5.0/lib/mime/types.rb#81 + # source://mime-types/3.5.2/lib/mime/types.rb#81 def count; end - # source://mime-types/3.5.0/lib/mime/types.rb#90 + # source://mime-types/3.5.2/lib/mime/types.rb#90 def each; end - # source://mime-types/3.5.0/lib/mime/types.rb#85 + # source://mime-types/3.5.2/lib/mime/types.rb#85 def inspect; end - # source://mime-types/3.5.0/lib/mime/types.rb#153 + # source://mime-types/3.5.2/lib/mime/types.rb#153 def of(filename); end - # source://mime-types/3.5.0/lib/mime/types.rb#153 + # source://mime-types/3.5.2/lib/mime/types.rb#153 def type_for(filename); end private - # source://mime-types/3.5.0/lib/mime/types.rb#201 + # source://mime-types/3.5.2/lib/mime/types.rb#201 def add_type_variant!(mime_type); end - # source://mime-types/3.5.0/lib/mime/types.rb#211 + # source://mime-types/3.5.2/lib/mime/types.rb#211 def index_extensions!(mime_type); end - # source://mime-types/3.5.0/lib/mime/types.rb#221 + # source://mime-types/3.5.2/lib/mime/types.rb#221 def match(pattern); end - # source://mime-types/3.5.0/lib/mime/types.rb#215 + # source://mime-types/3.5.2/lib/mime/types.rb#215 def prune_matches(matches, complete, registered); end - # source://mime-types/3.5.0/lib/mime/types.rb#205 + # source://mime-types/3.5.2/lib/mime/types.rb#205 def reindex_extensions!(mime_type); end class << self - # source://mime-types/3.5.0/lib/mime/types/registry.rb#14 + # source://mime-types/3.5.2/lib/mime/types/registry.rb#14 def [](type_id, complete: T.unsafe(nil), registered: T.unsafe(nil)); end - # source://mime-types/3.5.0/lib/mime/types/registry.rb#39 + # source://mime-types/3.5.2/lib/mime/types/registry.rb#39 def add(*types); end - # source://mime-types/3.5.0/lib/mime/types/registry.rb#19 + # source://mime-types/3.5.2/lib/mime/types/registry.rb#19 def count; end - # source://mime-types/3.5.0/lib/mime/types/registry.rb#24 + # source://mime-types/3.5.2/lib/mime/types/registry.rb#24 def each; end - # source://mime-types/3.5.0/lib/mime/types/logger.rb#12 + # source://mime-types/3.5.2/lib/mime/types/logger.rb#12 def logger; end - # source://mime-types/3.5.0/lib/mime/types/logger.rb#12 + # source://mime-types/3.5.2/lib/mime/types/logger.rb#12 def logger=(_arg0); end - # source://mime-types/3.5.0/lib/mime/types/registry.rb#7 + # source://mime-types/3.5.2/lib/mime/types/registry.rb#7 def new(*_arg0); end - # source://mime-types/3.5.0/lib/mime/types/registry.rb#33 + # source://mime-types/3.5.2/lib/mime/types/registry.rb#33 def of(filename); end - # source://mime-types/3.5.0/lib/mime/types/registry.rb#33 + # source://mime-types/3.5.2/lib/mime/types/registry.rb#33 def type_for(filename); end private - # source://mime-types/3.5.0/lib/mime/types/registry.rb#75 + # source://mime-types/3.5.2/lib/mime/types/registry.rb#75 def __instances__; end - # source://mime-types/3.5.0/lib/mime/types/registry.rb#55 + # source://mime-types/3.5.2/lib/mime/types/registry.rb#55 def __types__; end - # source://mime-types/3.5.0/lib/mime/types/registry.rb#45 + # source://mime-types/3.5.2/lib/mime/types/registry.rb#45 def lazy_load?; end - # source://mime-types/3.5.0/lib/mime/types/registry.rb#65 + # source://mime-types/3.5.2/lib/mime/types/registry.rb#65 def load_default_mime_types(mode = T.unsafe(nil)); end - # source://mime-types/3.5.0/lib/mime/types/registry.rb#60 + # source://mime-types/3.5.2/lib/mime/types/registry.rb#60 def load_mode; end - # source://mime-types/3.5.0/lib/mime/types/registry.rb#79 + # source://mime-types/3.5.2/lib/mime/types/registry.rb#79 def reindex_extensions(type); end end end diff --git a/sorbet/rbi/gems/mime-types@3.5.0.rbi b/sorbet/rbi/gems/mime-types@3.5.2.rbi similarity index 100% rename from sorbet/rbi/gems/mime-types@3.5.0.rbi rename to sorbet/rbi/gems/mime-types@3.5.2.rbi diff --git a/sorbet/rbi/gems/mini_racer@0.8.0.rbi b/sorbet/rbi/gems/mini_racer@0.13.0.rbi similarity index 100% rename from sorbet/rbi/gems/mini_racer@0.8.0.rbi rename to sorbet/rbi/gems/mini_racer@0.13.0.rbi diff --git a/sorbet/rbi/gems/multi_xml@0.6.0.rbi b/sorbet/rbi/gems/multi_xml@0.6.0.rbi deleted file mode 100644 index 627dc8606..000000000 --- a/sorbet/rbi/gems/multi_xml@0.6.0.rbi +++ /dev/null @@ -1,102 +0,0 @@ -# typed: true - -# DO NOT EDIT MANUALLY -# This is an autogenerated file for types exported from the `multi_xml` gem. -# Please instead update this file by running `bin/tapioca gem multi_xml`. - - -# source://multi_xml//lib/multi_xml.rb#8 -module MultiXml - class << self - # The default parser based on what you currently - # have loaded and installed. First checks to see - # if any parsers are already loaded, then checks - # to see which are installed if none are loaded. - # - # @raise [NoParserError] - # - # source://multi_xml//lib/multi_xml.rb#87 - def default_parser; end - - # Parse an XML string or IO into Ruby. - # - # Options - # - # :symbolize_keys :: If true, will use symbols instead of strings for the keys. - # - # :disallowed_types :: Types to disallow from being typecasted. Defaults to `['yaml', 'symbol']`. Use `[]` to allow all types. - # - # :typecast_xml_value :: If true, won't typecast values for parsed document - # - # source://multi_xml//lib/multi_xml.rb#133 - def parse(xml, options = T.unsafe(nil)); end - - # Get the current parser class. - # - # source://multi_xml//lib/multi_xml.rb#77 - def parser; end - - # Set the XML parser utilizing a symbol, string, or class. - # Supported by default are: - # - # * :libxml - # * :nokogiri - # * :ox - # * :rexml - # * :oga - # - # source://multi_xml//lib/multi_xml.rb#112 - def parser=(new_parser); end - - private - - # TODO: Add support for other encodings - # - # source://multi_xml//lib/multi_xml.rb#174 - def parse_binary(binary, entity); end - - # source://multi_xml//lib/multi_xml.rb#183 - def parse_file(file, entity); end - - # source://multi_xml//lib/multi_xml.rb#191 - def symbolize_keys(params); end - - # source://multi_xml//lib/multi_xml.rb#218 - def typecast_xml_value(value, disallowed_types = T.unsafe(nil)); end - - # source://multi_xml//lib/multi_xml.rb#204 - def undasherize_keys(params); end - end -end - -# source://multi_xml//lib/multi_xml.rb#27 -MultiXml::CONTENT_ROOT = T.let(T.unsafe(nil), String) - -# source://multi_xml//lib/multi_xml.rb#69 -MultiXml::DEFAULT_OPTIONS = T.let(T.unsafe(nil), Hash) - -# source://multi_xml//lib/multi_xml.rb#67 -MultiXml::DISALLOWED_XML_TYPES = T.let(T.unsafe(nil), Array) - -# source://multi_xml//lib/multi_xml.rb#11 -class MultiXml::DisallowedTypeError < ::StandardError - # @return [DisallowedTypeError] a new instance of DisallowedTypeError - # - # source://multi_xml//lib/multi_xml.rb#12 - def initialize(type); end -end - -# source://multi_xml//lib/multi_xml.rb#10 -class MultiXml::NoParserError < ::StandardError; end - -# source://multi_xml//lib/multi_xml.rb#33 -MultiXml::PARSING = T.let(T.unsafe(nil), Hash) - -# source://multi_xml//lib/multi_xml.rb#9 -class MultiXml::ParseError < ::StandardError; end - -# source://multi_xml//lib/multi_xml.rb#18 -MultiXml::REQUIREMENT_MAP = T.let(T.unsafe(nil), Array) - -# source://multi_xml//lib/multi_xml.rb#52 -MultiXml::TYPE_NAMES = T.let(T.unsafe(nil), Hash) diff --git a/sorbet/rbi/gems/multi_xml@0.7.1.rbi b/sorbet/rbi/gems/multi_xml@0.7.1.rbi new file mode 100644 index 000000000..f3b31154c --- /dev/null +++ b/sorbet/rbi/gems/multi_xml@0.7.1.rbi @@ -0,0 +1,9 @@ +# typed: true + +# DO NOT EDIT MANUALLY +# This is an autogenerated file for types exported from the `multi_xml` gem. +# Please instead update this file by running `bin/tapioca gem multi_xml`. + + +# THIS IS AN EMPTY RBI FILE. +# see https://github.com/Shopify/tapioca#manually-requiring-parts-of-a-gem diff --git a/sorbet/rbi/gems/net-sftp@4.0.0.rbi b/sorbet/rbi/gems/net-sftp@4.0.0.rbi new file mode 100644 index 000000000..deaafe8ce --- /dev/null +++ b/sorbet/rbi/gems/net-sftp@4.0.0.rbi @@ -0,0 +1,9 @@ +# typed: true + +# DO NOT EDIT MANUALLY +# This is an autogenerated file for types exported from the `net-sftp` gem. +# Please instead update this file by running `bin/tapioca gem net-sftp`. + + +# THIS IS AN EMPTY RBI FILE. +# see https://github.com/Shopify/tapioca#manually-requiring-parts-of-a-gem diff --git a/sorbet/rbi/gems/net-ssh@7.2.0.rbi b/sorbet/rbi/gems/net-ssh@7.2.3.rbi similarity index 100% rename from sorbet/rbi/gems/net-ssh@7.2.0.rbi rename to sorbet/rbi/gems/net-ssh@7.2.3.rbi diff --git a/sorbet/rbi/gems/octokit@7.0.0.rbi b/sorbet/rbi/gems/octokit@9.1.0.rbi similarity index 91% rename from sorbet/rbi/gems/octokit@7.0.0.rbi rename to sorbet/rbi/gems/octokit@9.1.0.rbi index 67a2595c2..d92db2171 100644 --- a/sorbet/rbi/gems/octokit@7.0.0.rbi +++ b/sorbet/rbi/gems/octokit@9.1.0.rbi @@ -16,31 +16,38 @@ module Octokit # # @return [Octokit::Client] API wrapper # - # source://octokit//lib/octokit.rb#16 + # source://octokit//lib/octokit.rb#17 def client; end # EnterpriseAdminClient client based on configured options {Configurable} # # @return [Octokit::EnterpriseAdminClient] API wrapper # - # source://octokit//lib/octokit.rb#25 + # source://octokit//lib/octokit.rb#26 def enterprise_admin_client; end # EnterpriseManagementConsoleClient client based on configured options {Configurable} # # @return [Octokit::EnterpriseManagementConsoleClient] API wrapper # - # source://octokit//lib/octokit.rb#36 + # source://octokit//lib/octokit.rb#37 def enterprise_management_console_client; end + # ManageGHESClient client based on configured options {Configurable} + # + # @return [Octokit::ManageGHESClient] API wrapper + # + # source://octokit//lib/octokit.rb#48 + def manage_ghes_client; end + private - # source://octokit//lib/octokit.rb#52 + # source://octokit//lib/octokit.rb#65 def method_missing(method_name, *args, &block); end # @return [Boolean] # - # source://octokit//lib/octokit.rb#46 + # source://octokit//lib/octokit.rb#58 def respond_to_missing?(method_name, include_private = T.unsafe(nil)); end end end @@ -48,19 +55,19 @@ end # Raised when GitHub returns a 403 HTTP status code # and body matches 'abuse' # -# source://octokit//lib/octokit/error.rb#278 +# source://octokit//lib/octokit/error.rb#281 class Octokit::AbuseDetected < ::Octokit::Forbidden; end # Raised when GitHub returns a 403 HTTP status code # and body matches 'account was suspended' # -# source://octokit//lib/octokit/error.rb#290 +# source://octokit//lib/octokit/error.rb#293 class Octokit::AccountSuspended < ::Octokit::Forbidden; end # Raised when a method requires an application client_id # and secret but none is provided # -# source://octokit//lib/octokit/error.rb#357 +# source://octokit//lib/octokit/error.rb#363 class Octokit::ApplicationCredentialsRequired < ::StandardError; end # Extracts options from method arguments @@ -142,24 +149,24 @@ Octokit::Authentication::FARADAY_BASIC_AUTH_KEYS = T.let(T.unsafe(nil), Array) # Raised when GitHub returns a 502 HTTP status code # -# source://octokit//lib/octokit/error.rb#347 +# source://octokit//lib/octokit/error.rb#353 class Octokit::BadGateway < ::Octokit::ServerError; end # Raised when GitHub returns a 400 HTTP status code # -# source://octokit//lib/octokit/error.rb#229 +# source://octokit//lib/octokit/error.rb#232 class Octokit::BadRequest < ::Octokit::ClientError; end # Raised when GitHub returns a 403 HTTP status code # and body matches 'billing issue' # -# source://octokit//lib/octokit/error.rb#294 +# source://octokit//lib/octokit/error.rb#297 class Octokit::BillingIssue < ::Octokit::Forbidden; end # Raised when GitHub returns a 404 HTTP status code # and body matches 'Branch not protected' # -# source://octokit//lib/octokit/error.rb#309 +# source://octokit//lib/octokit/error.rb#312 class Octokit::BranchNotProtected < ::Octokit::ClientError; end # Client for the GitHub API @@ -211,7 +218,6 @@ class Octokit::Client include ::Octokit::Client::Organizations include ::Octokit::Client::Pages include ::Octokit::Client::Projects - include ::Octokit::Client::PubSubHubbub include ::Octokit::Client::PullRequests include ::Octokit::Client::RateLimit include ::Octokit::Client::Reactions @@ -232,14 +238,14 @@ class Octokit::Client # @return [Client] a new instance of Client # - # source://octokit//lib/octokit/client.rb#143 + # source://octokit//lib/octokit/client.rb#141 def initialize(options = T.unsafe(nil)); end # Set OAuth access token for authentication # # @param value [String] 40 character GitHub OAuth access token # - # source://octokit//lib/octokit/client.rb#228 + # source://octokit//lib/octokit/client.rb#226 def access_token=(value); end # Duplicate client using client_id and client_secret as @@ -258,59 +264,59 @@ class Octokit::Client # end # @yield [app_client] # - # source://octokit//lib/octokit/client.rb#196 + # source://octokit//lib/octokit/client.rb#194 def as_app(key = T.unsafe(nil), secret = T.unsafe(nil)); end # Set Bearer Token for authentication # # @param value [String] JWT # - # source://octokit//lib/octokit/client.rb#236 + # source://octokit//lib/octokit/client.rb#234 def bearer_token=(value); end # Set OAuth app client_id # # @param value [String] 20 character GitHub OAuth app client_id # - # source://octokit//lib/octokit/client.rb#244 + # source://octokit//lib/octokit/client.rb#242 def client_id=(value); end # Set OAuth app client_secret # # @param value [String] 40 character GitHub OAuth app client_secret # - # source://octokit//lib/octokit/client.rb#252 + # source://octokit//lib/octokit/client.rb#250 def client_secret=(value); end - # source://octokit//lib/octokit/client.rb#257 + # source://octokit//lib/octokit/client.rb#255 def client_without_redirects(options = T.unsafe(nil)); end # Text representation of the client, masking tokens and passwords # # @return [String] # - # source://octokit//lib/octokit/client.rb#163 + # source://octokit//lib/octokit/client.rb#161 def inspect; end # Set username for authentication # # @param value [String] GitHub username # - # source://octokit//lib/octokit/client.rb#212 + # source://octokit//lib/octokit/client.rb#210 def login=(value); end # Set password for authentication # # @param value [String] GitHub password # - # source://octokit//lib/octokit/client.rb#220 + # source://octokit//lib/octokit/client.rb#218 def password=(value); end private # convenience method for constructing a user specific path, if the user is logged in # - # source://octokit//lib/octokit/client/users.rb#427 + # source://octokit//lib/octokit/client/users.rb#454 def user_path(user, path); end end @@ -376,6 +382,17 @@ end # # source://octokit//lib/octokit/client/actions_secrets.rb#8 module Octokit::Client::ActionsSecrets + # Create or update an environment secret + # + # @param repo [Integer, String, Hash, Repository] A GitHub repository + # @param environment [String] Name of environment + # @param name [String] Name of secret + # @param options [Hash] encrypted_value and key_id + # @see https://docs.github.com/en/rest/actions/secrets#create-or-update-an-environment-secret + # + # source://octokit//lib/octokit/client/actions_secrets.rb#147 + def create_or_update_actions_environment_secret(repo, environment, name, options); end + # Create or update secrets # # @param repo [Integer, String, Hash, Repository] A GitHub repository @@ -383,18 +400,68 @@ module Octokit::Client::ActionsSecrets # @param options [Hash] encrypted_value and key_id # @see https://developer.github.com/v3/actions/secrets/#create-or-update-a-secret-for-a-repository # - # source://octokit//lib/octokit/client/actions_secrets.rb#45 + # source://octokit//lib/octokit/client/actions_secrets.rb#75 def create_or_update_actions_secret(repo, name, options); end + # Create or update org secrets + # + # @param org [String] A GitHub organization + # @param name [String] Name of secret + # @param options [Hash] encrypted_value and key_id + # @see https://developer.github.com/v3/actions/secrets/#create-or-update-a-secret + # + # source://octokit//lib/octokit/client/actions_secrets.rb#85 + def create_or_update_org_actions_secret(org, name, options); end + + # Delete environment secret + # + # @param repo [Integer, String, Hash, Repository] A GitHub repository + # @param environment [String] Name of environment + # @param name [String] Name of secret + # @see https://docs.github.com/en/rest/actions/secrets#delete-an-environment-secret + # + # source://octokit//lib/octokit/client/actions_secrets.rb#156 + def delete_actions_environment_secret(repo, environment, name); end + # Delete a secret # # @param repo [Integer, String, Hash, Repository] A GitHub repository # @param name [String] Name of secret # @see https://developer.github.com/v3/actions/secrets/#delete-a-secret-from-a-repository # - # source://octokit//lib/octokit/client/actions_secrets.rb#54 + # source://octokit//lib/octokit/client/actions_secrets.rb#94 def delete_actions_secret(repo, name); end + # Delete an org secret + # + # @param org [String] A GitHub organization + # @param name [String] Name of secret + # @see https://developer.github.com/v3/actions/secrets/#delete-a-secret + # + # source://octokit//lib/octokit/client/actions_secrets.rb#103 + def delete_org_actions_secret(org, name); end + + # Get environment public key for secrets encryption + # + # @param repo [Integer, String, Hash, Repository] A GitHub repository + # @param environment [String] Name of environment + # @return [Hash] key_id and key + # @see https://docs.github.com/en/rest/actions/secrets#get-an-environment-public-key + # + # source://octokit//lib/octokit/client/actions_secrets.rb#113 + def get_actions_environment_public_key(repo, environment); end + + # Get an environment secret + # + # @param repo [Integer, String, Hash, Repository] A GitHub repository + # @param environment [String] Name of environment + # @param name [String] Name of secret + # @return [Hash] name, created_at and updated_at + # @see https://docs.github.com/en/rest/actions/secrets#get-an-environment-secret + # + # source://octokit//lib/octokit/client/actions_secrets.rb#136 + def get_actions_environment_secret(repo, environment, name); end + # Get public key for secrets encryption # # @param repo [Integer, String, Hash, Repository] A GitHub repository @@ -411,17 +478,55 @@ module Octokit::Client::ActionsSecrets # @return [Hash] name, created_at and updated_at # @see https://developer.github.com/v3/actions/secrets/#get-a-secret # - # source://octokit//lib/octokit/client/actions_secrets.rb#35 + # source://octokit//lib/octokit/client/actions_secrets.rb#55 def get_actions_secret(repo, name); end + # Get public key for secrets encryption + # + # @param org [String] A GitHub organization + # @return [Hash] key_id and key + # @see https://developer.github.com/v3/actions/secrets/#get-your-public-key + # + # source://octokit//lib/octokit/client/actions_secrets.rb#23 + def get_org_actions_public_key(org); end + + # Get an org secret + # + # @param org [String] A GitHub organization + # @param name [String] Name of secret + # @return [Hash] name, created_at and updated_at + # @see https://developer.github.com/v3/actions/secrets/#get-a-secret + # + # source://octokit//lib/octokit/client/actions_secrets.rb#65 + def get_org_actions_secret(org, name); end + + # List environment secrets + # + # @param repo [Integer, String, Hash, Repository] A GitHub repository + # @param environment [String] Name of environment + # @return [Hash] total_count and list of secrets (each item is hash with name, created_at and updated_at) + # @see https://developer.github.com/v3/actions/secrets/#list-environment-secrets + # + # source://octokit//lib/octokit/client/actions_secrets.rb#123 + def list_actions_environment_secrets(repo, environment); end + # List secrets # # @param repo [Integer, String, Hash, Repository] A GitHub repository # @return [Hash] total_count and list of secrets (each item is hash with name, created_at and updated_at) # @see https://developer.github.com/v3/actions/secrets/#list-secrets-for-a-repository # - # source://octokit//lib/octokit/client/actions_secrets.rb#23 + # source://octokit//lib/octokit/client/actions_secrets.rb#32 def list_actions_secrets(repo); end + + # List org secrets + # + # @param org [String] A GitHub organization + # @return [Hash] total_count and list of secrets (each item is hash with name, created_at and updated_at) + # @see https://developer.github.com/v3/actions/secrets/#list-organization-secrets + # + # source://octokit//lib/octokit/client/actions_secrets.rb#43 + def list_org_actions_secrets(org); end end # Methods for the Actions Workflows jobs API @@ -736,6 +841,16 @@ module Octokit::Client::Apps # source://octokit//lib/octokit/client/apps.rb#14 def app(options = T.unsafe(nil)); end + # Returns a delivery for the webhook configured for a GitHub App. + # + # @param delivery_id [String] The id of a GitHub App Hook Delivery + # @param options [Hash] A customizable set of options + # @return [] The webhook delivery + # @see https://docs.github.com/en/rest/apps/webhooks#get-a-delivery-for-an-app-webhook + # + # source://octokit//lib/octokit/client/apps.rb#242 + def app_hook_delivery(delivery_id, options = T.unsafe(nil)); end + # Create a new installation token # # @param installation [Integer] The id of a GitHub App Installation @@ -769,6 +884,16 @@ module Octokit::Client::Apps # source://octokit//lib/octokit/client/apps.rb#217 def delete_installation(installation, options = T.unsafe(nil)); end + # Redeliver a delivery for the webhook configured for a GitHub App. + # + # @param delivery_id [Integer] The id of a GitHub App Hook Delivery + # @param options [Hash] A customizable set of options + # @return [Boolean] Success + # @see https://developer.github.com/v3/apps/#redeliver-a-delivery-for-an-app-webhook + # + # source://octokit//lib/octokit/client/apps.rb#254 + def deliver_app_hook(delivery_id, options = T.unsafe(nil)); end + # Find all installations that belong to an App # # @param options [Hash] A customizable set of options @@ -848,6 +973,15 @@ module Octokit::Client::Apps # source://octokit//lib/octokit/client/apps.rb#60 def installation(id, options = T.unsafe(nil)); end + # Returns a list of webhook deliveries for the webhook configured for a GitHub App. + # + # @param options [Hash] A customizable set of options + # @return [Array] an array of hook deliveries + # @see https://docs.github.com/en/rest/apps/webhooks#list-deliveries-for-an-app-webhook + # + # source://octokit//lib/octokit/client/apps.rb#228 + def list_app_hook_deliveries(options = T.unsafe(nil)); end + # List repositories that are accessible to the authenticated installation # # @param options [Hash] A customizable set of options @@ -897,7 +1031,7 @@ end # Header keys that can be passed in options hash to {#get},{#head} # -# source://octokit//lib/octokit/client.rb#141 +# source://octokit//lib/octokit/client.rb#139 Octokit::Client::CONVENIENCE_HEADERS = T.let(T.unsafe(nil), Set) # Methods for the Checks API @@ -1134,8 +1268,57 @@ end # # @see https://docs.github.com/rest/code-scanning # -# source://octokit//lib/octokit/client/code_scanning.rb#12 +# source://octokit//lib/octokit/client/code_scanning.rb#11 module Octokit::Client::CodeScanning + # Delete a specified code scanning analysis from a repository + # + # @param repo [Integer, String, Repository, Hash] A GitHub repository + # @param analysis_id [Integer] ID of the code scanning analysis + # @return [Sawyer::Resource] Next Code Scanning Analysis Information + # @see https://docs.github.com/en/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository + # + # source://octokit//lib/octokit/client/code_scanning.rb#67 + def delete_code_scanning_analysis(repo, analysis_id, options = T.unsafe(nil)); end + + # Gets a single code scanning alert + # + # @param repo [Integer, String, Repository, Hash] A GitHub repository + # @param alert_number [Integer] The number that identifies an alert + # @return [Sawyer::Resource] Code Scanning Alert + # @see https://docs.github.com/en/rest/code-scanning/code-scanning#get-a-code-scanning-alert + # + # source://octokit//lib/octokit/client/code_scanning.rb#126 + def get_code_scanning_alert(repo, alert_number, options = T.unsafe(nil)); end + + # Get a code scanning analysis for a repository + # + # @param repo [Integer, String, Repository, Hash] A GitHub repository + # @param analysis_id [Integer] ID of the code scanning analysis + # @return [Sawyer::Resource] Code Scanning Analysis + # @see https://docs.github.com/en/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository + # + # source://octokit//lib/octokit/client/code_scanning.rb#78 + def get_code_scanning_analysis(repo, analysis_id, options = T.unsafe(nil)); end + + # Get Code Scanning Default Configuration + # + # @param repo [Integer, String, Repository, Hash] A GitHub repository + # @return [Sawyer::Resource] CodeQl Default Setup Configuration Information + # @see https://docs.github.com/en/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration + # + # source://octokit//lib/octokit/client/code_scanning.rb#35 + def get_code_scanning_default_config(repo, options = T.unsafe(nil)); end + + # Gets a CodeQL database for a language in a repository + # + # @param repo [Integer, String, Repository, Hash] A GitHub repository + # @param language [String] + # @return [Sawyer::Resource] CodeQl Default Setup Configuration Information + # @see https://docs.github.com/en/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository + # + # source://octokit//lib/octokit/client/code_scanning.rb#46 + def get_codeql_database_for_repo(repo, language, options = T.unsafe(nil)); end + # Gets information about a SARIF upload # # @param repo [Integer, String, Repository, Hash] A GitHub repository @@ -1143,9 +1326,78 @@ module Octokit::Client::CodeScanning # @return [Sawyer::Resource] SARIF upload information # @see https://docs.github.com/rest/code-scanning#get-information-about-a-sarif-upload # - # source://octokit//lib/octokit/client/code_scanning.rb#37 + # source://octokit//lib/octokit/client/code_scanning.rb#174 def get_sarif_upload_information(repo, sarif_id, options = T.unsafe(nil)); end + # List code scanning alerts for an organization + # + # @param org [String] A GitHub organization + # @return [Array] Code Scanning Alert information + # @see https://docs.github.com/en/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization + # + # source://octokit//lib/octokit/client/code_scanning.rb#146 + def list_code_scanning_alerts_for_org(org, options = T.unsafe(nil)); end + + # List code scanning alerts for a repository + # + # @param org [String] A GitHub organization + # @return [Array] Code Scanning Alert information + # @see https://docs.github.com/en/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository + # + # source://octokit//lib/octokit/client/code_scanning.rb#136 + def list_code_scanning_alerts_for_repo(repo, options = T.unsafe(nil)); end + + # List code scanning analyses for a repository + # + # @param repo [Integer, String, Repository, Hash] A GitHub repository + # @return [Array] List of Code Scanning Analyses + # @see https://docs.github.com/en/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository + # + # source://octokit//lib/octokit/client/code_scanning.rb#88 + def list_code_scanning_analysis(repo, options = T.unsafe(nil)); end + + # Lists the CodeQL databases that are available in a repository + # + # @param repo [Integer, String, Repository, Hash] A GitHub repository + # @return [Array] List of CodeQL Databases + # @see https://docs.github.com/en/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository + # + # source://octokit//lib/octokit/client/code_scanning.rb#56 + def list_codeql_database_for_repo(repo, options = T.unsafe(nil)); end + + # List instances of a code scanning alert + # + # @param repo [Integer, String, Repository, Hash] A GitHub repository + # @param alert_number [Integer] The number that identifies an alert + # @return [Array] List of Code Scanning Alerts + # @see https://docs.github.com/en/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert + # + # source://octokit//lib/octokit/client/code_scanning.rb#99 + def list_instances_of_code_scanning_alert(repo, alert_number, options = T.unsafe(nil)); end + + # Update a code scanning alert + # + # @param repo [Integer, String, Repository, Hash] A GitHub repository + # @param alert_number [Integer] The number that identifies an alert + # @param state [String] The reason for dismissing or closing the alert. Required when the state is dismissed + # @return [Sawyer::Resource] Code Scanning Alert information + # @see https://docs.github.com/en/rest/code-scanning/code-scanning#update-a-code-scanning-alert + # + # source://octokit//lib/octokit/client/code_scanning.rb#111 + def update_code_scanning_alert(repo, alert_number, state, reason, comment = T.unsafe(nil), options = T.unsafe(nil)); end + + # Updates a code scanning default setup configuration + # + # @param repo [Integer, String, Repository, Hash] A GitHub repository + # @param state [String] The desired state of code scanning default setup + # @param query_suite [String] CodeQL query suite to be used + # @param languages [Array] List of CodeQL languages to be analyzed + # @return [Sawyer::Resource] Action Run information + # @see https://docs.github.com/en/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration + # + # source://octokit//lib/octokit/client/code_scanning.rb#21 + def update_code_scanning_default_config(repo, state, query_suite = T.unsafe(nil), languages = T.unsafe(nil), options = T.unsafe(nil)); end + # Uploads SARIF data containing the results of a code scanning analysis # # @param repo [Integer, String, Repository, Hash] A GitHub repository @@ -1155,12 +1407,12 @@ module Octokit::Client::CodeScanning # @return [Sawyer::Resource] SARIF upload information # @see https://docs.github.com/rest/code-scanning#upload-an-analysis-as-sarif-data # - # source://octokit//lib/octokit/client/code_scanning.rb#22 + # source://octokit//lib/octokit/client/code_scanning.rb#159 def upload_sarif_data(repo, file, sha, ref, options = T.unsafe(nil)); end private - # source://octokit//lib/octokit/client/code_scanning.rb#43 + # source://octokit//lib/octokit/client/code_scanning.rb#180 def compress_sarif_data(file); end end @@ -1177,18 +1429,37 @@ module Octokit::Client::CodespacesSecrets # @param options [Hash] encrypted_value and key_id # @see https://docs.github.com/en/rest/codespaces/repository-secrets?apiVersion=2022-11-28#create-or-update-a-repository-secret # - # source://octokit//lib/octokit/client/codespaces_secrets.rb#45 + # source://octokit//lib/octokit/client/codespaces_secrets.rb#75 def create_or_update_codespaces_secret(repo, name, options); end + # Create or update org secrets + # + # @param org [String] A GitHub organization + # @param name [String] Name of secret + # @param options [Hash] encrypted_value and key_id + # @see https://docs.github.com/en/rest/codespaces/organization-secrets?apiVersion=2022-11-28#create-or-update-an-organization-secret + # + # source://octokit//lib/octokit/client/codespaces_secrets.rb#85 + def create_or_update_org_codespaces_secret(org, name, options); end + # Delete a secret # # @param repo [Integer, String, Hash, Repository] A GitHub repository # @param name [String] Name of secret # @see https://docs.github.com/en/rest/codespaces/repository-secrets?apiVersion=2022-11-28#delete-a-repository-secret # - # source://octokit//lib/octokit/client/codespaces_secrets.rb#54 + # source://octokit//lib/octokit/client/codespaces_secrets.rb#94 def delete_codespaces_secret(repo, name); end + # Delete an org secret + # + # @param org [String] A GitHub organization + # @param name [String] Name of secret + # @see https://docs.github.com/en/rest/codespaces/organization-secrets?apiVersion=2022-11-28#delete-an-organization-secret + # + # source://octokit//lib/octokit/client/codespaces_secrets.rb#103 + def delete_org_codespaces_secret(org, name); end + # Get public key for secrets encryption # # @param repo [Integer, String, Hash, Repository] A GitHub repository @@ -1205,17 +1476,45 @@ module Octokit::Client::CodespacesSecrets # @return [Hash] name, created_at, updated_at, and visibility # @see https://docs.github.com/en/rest/codespaces/repository-secrets?apiVersion=2022-11-28#get-a-repository-secret # - # source://octokit//lib/octokit/client/codespaces_secrets.rb#35 + # source://octokit//lib/octokit/client/codespaces_secrets.rb#55 def get_codespaces_secret(repo, name); end + # Get public key for secrets encryption + # + # @param org [String] A GitHub organization + # @return [Hash] key_id and key + # @see https://docs.github.com/en/rest/codespaces/organization-secrets?apiVersion=2022-11-28#get-an-organization-public-key + # + # source://octokit//lib/octokit/client/codespaces_secrets.rb#23 + def get_org_codespaces_public_key(org); end + + # Get an org secret + # + # @param org [String] A GitHub organization + # @param name [String] Name of secret + # @return [Hash] name, created_at, updated_at, and visibility + # @see https://docs.github.com/en/rest/codespaces/organization-secrets?apiVersion=2022-11-28#get-an-organization-secret + # + # source://octokit//lib/octokit/client/codespaces_secrets.rb#65 + def get_org_codespaces_secret(org, name); end + # List secrets # # @param repo [Integer, String, Hash, Repository] A GitHub repository # @return [Hash] total_count and list of secrets (each item is hash with name, created_at and updated_at) # @see https://docs.github.com/en/rest/codespaces/repository-secrets?apiVersion=2022-11-28#list-repository-secrets # - # source://octokit//lib/octokit/client/codespaces_secrets.rb#23 + # source://octokit//lib/octokit/client/codespaces_secrets.rb#32 def list_codespaces_secrets(repo); end + + # List org secrets + # + # @param org [String] A GitHub organization + # @return [Hash] total_count and list of secrets (each item is hash with name, created_at and updated_at) + # @see https://docs.github.com/en/rest/codespaces/organization-secrets?apiVersion=2022-11-28#list-organization-secrets + # + # source://octokit//lib/octokit/client/codespaces_secrets.rb#43 + def list_org_codespaces_secrets(org); end end # Methods for the Branches for HEAD API @@ -1516,7 +1815,7 @@ end # # @see https://developer.github.com/v3/repos/contents/ # -# source://octokit//lib/octokit/client/contents.rb#10 +# source://octokit//lib/octokit/client/contents.rb#8 module Octokit::Client::Contents # Add content to a repository # @@ -1531,7 +1830,7 @@ module Octokit::Client::Contents # @return [Sawyer::Resource] The contents and commit info for the addition # @see https://developer.github.com/v3/repos/contents/#create-a-file # - # source://octokit//lib/octokit/client/contents.rb#61 + # source://octokit//lib/octokit/client/contents.rb#59 def add_content(*args); end # Add content to a repository @@ -1547,7 +1846,7 @@ module Octokit::Client::Contents # @return [Sawyer::Resource] The contents and commit info for the addition # @see https://developer.github.com/v3/repos/contents/#create-a-file # - # source://octokit//lib/octokit/client/contents.rb#61 + # source://octokit//lib/octokit/client/contents.rb#59 def add_contents(*args); end # This method will provide a URL to download a tarball or zipball archive for a repository. @@ -1561,7 +1860,7 @@ module Octokit::Client::Contents # @return [String] Location of the download # @see https://developer.github.com/v3/repos/contents/#get-archive-link # - # source://octokit//lib/octokit/client/contents.rb#157 + # source://octokit//lib/octokit/client/contents.rb#155 def archive_link(repo, options = T.unsafe(nil)); end # Receive a listing of a repository folder or the contents of a file @@ -1577,7 +1876,7 @@ module Octokit::Client::Contents # @return [Sawyer::Resource] The contents of a file or list of the files in the folder # @see https://developer.github.com/v3/repos/contents/#get-contents # - # source://octokit//lib/octokit/client/contents.rb#36 + # source://octokit//lib/octokit/client/contents.rb#34 def content(repo, options = T.unsafe(nil)); end # Receive a listing of a repository folder or the contents of a file @@ -1593,7 +1892,7 @@ module Octokit::Client::Contents # @return [Sawyer::Resource] The contents of a file or list of the files in the folder # @see https://developer.github.com/v3/repos/contents/#get-contents # - # source://octokit//lib/octokit/client/contents.rb#36 + # source://octokit//lib/octokit/client/contents.rb#34 def contents(repo, options = T.unsafe(nil)); end # Add content to a repository @@ -1609,7 +1908,7 @@ module Octokit::Client::Contents # @return [Sawyer::Resource] The contents and commit info for the addition # @see https://developer.github.com/v3/repos/contents/#create-a-file # - # source://octokit//lib/octokit/client/contents.rb#61 + # source://octokit//lib/octokit/client/contents.rb#59 def create_content(*args); end # Add content to a repository @@ -1625,7 +1924,7 @@ module Octokit::Client::Contents # @return [Sawyer::Resource] The contents and commit info for the addition # @see https://developer.github.com/v3/repos/contents/#create-a-file # - # source://octokit//lib/octokit/client/contents.rb#61 + # source://octokit//lib/octokit/client/contents.rb#59 def create_contents(*args); end # Delete content in a repository @@ -1645,7 +1944,7 @@ module Octokit::Client::Contents # @return [Sawyer::Resource] The commit info for the delete # @see https://developer.github.com/v3/repos/contents/#delete-a-file # - # source://octokit//lib/octokit/client/contents.rb#138 + # source://octokit//lib/octokit/client/contents.rb#136 def delete_content(repo, path, message, sha, options = T.unsafe(nil)); end # Delete content in a repository @@ -1665,7 +1964,7 @@ module Octokit::Client::Contents # @return [Sawyer::Resource] The commit info for the delete # @see https://developer.github.com/v3/repos/contents/#delete-a-file # - # source://octokit//lib/octokit/client/contents.rb#138 + # source://octokit//lib/octokit/client/contents.rb#136 def delete_contents(repo, path, message, sha, options = T.unsafe(nil)); end # Receive the default Readme for a repository @@ -1680,7 +1979,7 @@ module Octokit::Client::Contents # @return [Sawyer::Resource] The detail of the readme # @see https://developer.github.com/v3/repos/contents/#get-the-readme # - # source://octokit//lib/octokit/client/contents.rb#21 + # source://octokit//lib/octokit/client/contents.rb#19 def readme(repo, options = T.unsafe(nil)); end # Delete content in a repository @@ -1700,7 +1999,7 @@ module Octokit::Client::Contents # @return [Sawyer::Resource] The commit info for the delete # @see https://developer.github.com/v3/repos/contents/#delete-a-file # - # source://octokit//lib/octokit/client/contents.rb#138 + # source://octokit//lib/octokit/client/contents.rb#136 def remove_content(repo, path, message, sha, options = T.unsafe(nil)); end # Delete content in a repository @@ -1720,7 +2019,7 @@ module Octokit::Client::Contents # @return [Sawyer::Resource] The commit info for the delete # @see https://developer.github.com/v3/repos/contents/#delete-a-file # - # source://octokit//lib/octokit/client/contents.rb#138 + # source://octokit//lib/octokit/client/contents.rb#136 def remove_contents(repo, path, message, sha, options = T.unsafe(nil)); end # Update content in a repository @@ -1736,7 +2035,7 @@ module Octokit::Client::Contents # @return [Sawyer::Resource] The contents and commit info for the update # @see https://developer.github.com/v3/repos/contents/#update-a-file # - # source://octokit//lib/octokit/client/contents.rb#111 + # source://octokit//lib/octokit/client/contents.rb#109 def update_content(*args); end # Update content in a repository @@ -1752,7 +2051,7 @@ module Octokit::Client::Contents # @return [Sawyer::Resource] The contents and commit info for the update # @see https://developer.github.com/v3/repos/contents/#update-a-file # - # source://octokit//lib/octokit/client/contents.rb#111 + # source://octokit//lib/octokit/client/contents.rb#109 def update_contents(*args); end end @@ -1769,18 +2068,37 @@ module Octokit::Client::DependabotSecrets # @param options [Hash] encrypted_value and key_id # @see https://docs.github.com/en/rest/dependabot/repository-secrets?apiVersion=2022-11-28#create-or-update-a-repository-secret # - # source://octokit//lib/octokit/client/dependabot_secrets.rb#45 + # source://octokit//lib/octokit/client/dependabot_secrets.rb#75 def create_or_update_dependabot_secret(repo, name, options); end + # Create or update org secrets + # + # @param org [String] A GitHub organization + # @param name [String] Name of secret + # @param options [Hash] encrypted_value and key_id + # @see https://docs.github.com/en/rest/dependabot/organization-secrets?apiVersion=2022-11-28#create-or-update-an-organization-secret + # + # source://octokit//lib/octokit/client/dependabot_secrets.rb#85 + def create_or_update_org_dependabot_secret(org, name, options); end + # Delete a secret # # @param repo [Integer, String, Hash, Repository] A GitHub repository # @param name [String] Name of secret # @see https://docs.github.com/en/rest/dependabot/repository-secrets?apiVersion=2022-11-28#delete-a-repository-secret # - # source://octokit//lib/octokit/client/dependabot_secrets.rb#54 + # source://octokit//lib/octokit/client/dependabot_secrets.rb#94 def delete_dependabot_secret(repo, name); end + # Delete an org secret + # + # @param org [String] A GitHub organization + # @param name [String] Name of secret + # @see https://docs.github.com/en/rest/dependabot/organization-secrets?apiVersion=2022-11-28#delete-an-organization-secret + # + # source://octokit//lib/octokit/client/dependabot_secrets.rb#103 + def delete_org_dependabot_secret(org, name); end + # Get public key for secrets encryption # # @param repo [Integer, String, Hash, Repository] A GitHub repository @@ -1797,17 +2115,45 @@ module Octokit::Client::DependabotSecrets # @return [Hash] name, created_at, updated_at, and visibility # @see https://docs.github.com/en/rest/dependabot/repository-secrets?apiVersion=2022-11-28#get-a-repository-secret # - # source://octokit//lib/octokit/client/dependabot_secrets.rb#35 + # source://octokit//lib/octokit/client/dependabot_secrets.rb#55 def get_dependabot_secret(repo, name); end + # Get public key for secrets encryption + # + # @param org [String] A GitHub organization + # @return [Hash] key_id and key + # @see https://docs.github.com/en/rest/dependabot/organization-secrets?apiVersion=2022-11-28#get-an-organization-public-key + # + # source://octokit//lib/octokit/client/dependabot_secrets.rb#23 + def get_org_dependabot_public_key(org); end + + # Get an org secret + # + # @param org [String] A GitHub organization + # @param name [String] Name of secret + # @return [Hash] name, created_at, updated_at, and visibility + # @see https://docs.github.com/en/rest/dependabot/organization-secrets?apiVersion=2022-11-28#get-an-organization-secret + # + # source://octokit//lib/octokit/client/dependabot_secrets.rb#65 + def get_org_dependabot_secret(org, name); end + # List secrets # # @param repo [Integer, String, Hash, Repository] A GitHub repository # @return [Hash] total_count and list of secrets (each item is hash with name, created_at and updated_at) # @see https://docs.github.com/en/rest/dependabot/repository-secrets?apiVersion=2022-11-28#list-repository-secrets # - # source://octokit//lib/octokit/client/dependabot_secrets.rb#23 + # source://octokit//lib/octokit/client/dependabot_secrets.rb#32 def list_dependabot_secrets(repo); end + + # List org secrets + # + # @param org [String] A GitHub organization + # @return [Hash] total_count and list of secrets (each item is hash with name, created_at and updated_at) + # @see https://docs.github.com/en/rest/dependabot/organization-secrets?apiVersion=2022-11-28#list-organization-secrets + # + # source://octokit//lib/octokit/client/dependabot_secrets.rb#43 + def list_org_dependabot_secrets(org); end end # Methods for the Deployments API @@ -1992,7 +2338,7 @@ module Octokit::Client::Environments # @return [Sawyer::Resource] An environment # @see https://docs.github.com/en/rest/deployments/environments#create-or-update-an-environment # - # source://octokit//lib/octokit/client/environments.rb#40 + # source://octokit//lib/octokit/client/environments.rb#43 def create_or_update_environment(repo, environment_name, options = T.unsafe(nil)); end # Delete an Environment @@ -2002,7 +2348,7 @@ module Octokit::Client::Environments # @return [No Content] # @see https://docs.github.com/en/rest/deployments/environments#delete-an-environment # - # source://octokit//lib/octokit/client/environments.rb#50 + # source://octokit//lib/octokit/client/environments.rb#53 def delete_environment(repo, environment_name, options = T.unsafe(nil)); end # Fetch a single environment for a repository @@ -3782,7 +4128,7 @@ module Octokit::Client::OauthApplications # # @example # client = Octokit::Client.new(:client_id => 'abcdefg12345', :client_secret => 'secret') - # client.delete_token('deadbeef1234567890deadbeef987654321') + # client.delete_app_token('deadbeef1234567890deadbeef987654321') # @param access_token [String] 40 character GitHub OAuth access token # @return [Boolean] Result # @see https://developer.github.com/v3/apps/oauth_applications/#delete-an-app-token @@ -3796,7 +4142,7 @@ module Octokit::Client::OauthApplications # # @example # client = Octokit::Client.new(:client_id => 'abcdefg12345', :client_secret => 'secret') - # client.delete_token('deadbeef1234567890deadbeef987654321') + # client.delete_app_token('deadbeef1234567890deadbeef987654321') # @param access_token [String] 40 character GitHub OAuth access token # @return [Boolean] Result # @see https://developer.github.com/v3/apps/oauth_applications/#delete-an-app-token @@ -3838,7 +4184,7 @@ module Octokit::Client::OauthApplications # # @example # client = Octokit::Client.new(:client_id => 'abcdefg12345', :client_secret => 'secret') - # client.delete_token('deadbeef1234567890deadbeef987654321') + # client.delete_app_token('deadbeef1234567890deadbeef987654321') # @param access_token [String] 40 character GitHub OAuth access token # @return [Boolean] Result # @see https://developer.github.com/v3/apps/oauth_applications/#delete-an-app-token @@ -5581,75 +5927,6 @@ module Octokit::Client::Projects def update_project_column(id, name, options = T.unsafe(nil)); end end -# Methods for the PubSubHubbub API -# -# @see https://developer.github.com/v3/repos/hooks/#pubsubhubbub -# -# source://octokit//lib/octokit/client/pub_sub_hubbub.rb#8 -module Octokit::Client::PubSubHubbub - # Subscribe to a pubsub topic - # - # @example Subscribe to push events from one of your repositories, having an email sent when fired - # client = Octokit::Client.new(:oauth_token = "token") - # client.subscribe("https://github.com/joshk/devise_imapable/events/push", "github://Email?address=josh.kalderimis@gmail.com") - # @param topic [String] A recoginized and supported pubsub topic - # @param callback [String] A callback url to be posted to when the topic event is fired - # @param secret [String] An optional shared secret used to generate a SHA1 HMAC of the outgoing body content - # @return [Boolean] true if the subscribe was successful, otherwise an error is raised - # @see https://developer.github.com/v3/repos/hooks/#subscribing - # - # source://octokit//lib/octokit/client/pub_sub_hubbub.rb#19 - def subscribe(topic, callback, secret = T.unsafe(nil)); end - - # Subscribe to a repository through pubsub - # - # @example Subscribe to push events to one of your repositories to Travis-CI - # client = Octokit::Client.new(:oauth_token = "token") - # client.subscribe_service_hook('joshk/device_imapable', 'Travis', { :token => "test", :domain => "domain", :user => "user" }) - # @param repo [String, Repository, Hash] A GitHub repository - # @param service_name [String] service name owner - # @param service_arguments [Hash] params that will be passed by subscribed hook. - # List of services is available @ https://github.com/github/github-services/tree/master/docs. - # Please refer Data node for complete list of arguments. - # @param secret [String] An optional shared secret used to generate a SHA1 HMAC of the outgoing body content - # @return [Boolean] True if subscription successful, false otherwise - # @see https://developer.github.com/v3/repos/hooks/#subscribing - # - # source://octokit//lib/octokit/client/pub_sub_hubbub.rb#65 - def subscribe_service_hook(repo, service_name, service_arguments = T.unsafe(nil), secret = T.unsafe(nil)); end - - # Unsubscribe from a pubsub topic - # - # @example Unsubscribe to push events from one of your repositories, no longer having an email sent when fired - # client = Octokit::Client.new(:oauth_token = "token") - # client.unsubscribe("https://github.com/joshk/devise_imapable/events/push", "github://Email?address=josh.kalderimis@gmail.com") - # @param topic [String] A recoginized pubsub topic - # @param callback [String] A callback url to be unsubscribed from - # @return [Boolean] true if the unsubscribe was successful, otherwise an error is raised - # @see https://developer.github.com/v3/repos/hooks/#subscribing - # - # source://octokit//lib/octokit/client/pub_sub_hubbub.rb#41 - def unsubscribe(topic, callback); end - - # Unsubscribe repository through pubsub - # - # @example Subscribe to push events to one of your repositories to Travis-CI - # client = Octokit::Client.new(:oauth_token = "token") - # client.unsubscribe_service_hook('joshk/device_imapable', 'Travis') - # @param repo [String, Repository, Hash] A GitHub repository - # @param service_name [String] service name owner - # List of services is available @ https://github.com/github/github-services/tree/master/docs. - # @see https://developer.github.com/v3/repos/hooks/#subscribing - # - # source://octokit//lib/octokit/client/pub_sub_hubbub.rb#80 - def unsubscribe_service_hook(repo, service_name); end - - private - - # source://octokit//lib/octokit/client/pub_sub_hubbub.rb#88 - def pub_sub_hubbub_request(options = T.unsafe(nil)); end -end - # Methods for the Pull Requests API # # @see https://developer.github.com/v3/pulls/ @@ -5679,12 +5956,14 @@ module Octokit::Client::PullRequests # @param body [String] Comment content # @param commit_id [String] Sha of the commit to comment on. # @param path [String] Relative path of the file to comment on. - # @param position [Integer] Line index in the diff to comment on. + # @param line [Integer] Line index in the diff to comment on. + # For a multi-line comment, the last line of the range + # and specify 'start_line' in the 'options'. # @return [Sawyer::Resource] Hash representing the new comment # @see https://developer.github.com/v3/pulls/comments/#create-a-comment # - # source://octokit//lib/octokit/client/pull_requests.rb#207 - def create_pull_comment(repo, pull_id, body, commit_id, path, position, options = T.unsafe(nil)); end + # source://octokit//lib/octokit/client/pull_requests.rb#209 + def create_pull_comment(repo, pull_id, body, commit_id, path, line, options = T.unsafe(nil)); end # Create reply to a pull request comment # @@ -5697,7 +5976,7 @@ module Octokit::Client::PullRequests # @return [Sawyer::Resource] Hash representing new comment # @see https://developer.github.com/v3/pulls/comments/#create-a-comment # - # source://octokit//lib/octokit/client/pull_requests.rb#230 + # source://octokit//lib/octokit/client/pull_requests.rb#231 def create_pull_reply(repo, pull_id, body, comment_id, options = T.unsafe(nil)); end # Create a pull request @@ -5730,12 +6009,14 @@ module Octokit::Client::PullRequests # @param body [String] Comment content # @param commit_id [String] Sha of the commit to comment on. # @param path [String] Relative path of the file to comment on. - # @param position [Integer] Line index in the diff to comment on. + # @param line [Integer] Line index in the diff to comment on. + # For a multi-line comment, the last line of the range + # and specify 'start_line' in the 'options'. # @return [Sawyer::Resource] Hash representing the new comment # @see https://developer.github.com/v3/pulls/comments/#create-a-comment # - # source://octokit//lib/octokit/client/pull_requests.rb#207 - def create_pull_request_comment(repo, pull_id, body, commit_id, path, position, options = T.unsafe(nil)); end + # source://octokit//lib/octokit/client/pull_requests.rb#209 + def create_pull_request_comment(repo, pull_id, body, commit_id, path, line, options = T.unsafe(nil)); end # Create reply to a pull request comment # @@ -5748,7 +6029,7 @@ module Octokit::Client::PullRequests # @return [Sawyer::Resource] Hash representing new comment # @see https://developer.github.com/v3/pulls/comments/#create-a-comment # - # source://octokit//lib/octokit/client/pull_requests.rb#230 + # source://octokit//lib/octokit/client/pull_requests.rb#231 def create_pull_request_comment_reply(repo, pull_id, body, comment_id, options = T.unsafe(nil)); end # Create a pull request from existing issue @@ -5777,7 +6058,7 @@ module Octokit::Client::PullRequests # @return [Sawyer::Resource] Hash representing new comment # @see https://developer.github.com/v3/pulls/comments/#create-a-comment # - # source://octokit//lib/octokit/client/pull_requests.rb#230 + # source://octokit//lib/octokit/client/pull_requests.rb#231 def create_review_reply(repo, pull_id, body, comment_id, options = T.unsafe(nil)); end # Create a pull request comment @@ -5791,12 +6072,14 @@ module Octokit::Client::PullRequests # @param body [String] Comment content # @param commit_id [String] Sha of the commit to comment on. # @param path [String] Relative path of the file to comment on. - # @param position [Integer] Line index in the diff to comment on. + # @param line [Integer] Line index in the diff to comment on. + # For a multi-line comment, the last line of the range + # and specify 'start_line' in the 'options'. # @return [Sawyer::Resource] Hash representing the new comment # @see https://developer.github.com/v3/pulls/comments/#create-a-comment # - # source://octokit//lib/octokit/client/pull_requests.rb#207 - def create_view_comment(repo, pull_id, body, commit_id, path, position, options = T.unsafe(nil)); end + # source://octokit//lib/octokit/client/pull_requests.rb#209 + def create_view_comment(repo, pull_id, body, commit_id, path, line, options = T.unsafe(nil)); end # Delete pull request comment # @@ -5807,7 +6090,7 @@ module Octokit::Client::PullRequests # @return [Boolean] True if deleted, false otherwise # @see https://developer.github.com/v3/pulls/comments/#delete-a-comment # - # source://octokit//lib/octokit/client/pull_requests.rb#264 + # source://octokit//lib/octokit/client/pull_requests.rb#265 def delete_pull_comment(repo, comment_id, options = T.unsafe(nil)); end # Delete pull request comment @@ -5819,7 +6102,7 @@ module Octokit::Client::PullRequests # @return [Boolean] True if deleted, false otherwise # @see https://developer.github.com/v3/pulls/comments/#delete-a-comment # - # source://octokit//lib/octokit/client/pull_requests.rb#264 + # source://octokit//lib/octokit/client/pull_requests.rb#265 def delete_pull_request_comment(repo, comment_id, options = T.unsafe(nil)); end # Delete pull request comment @@ -5831,7 +6114,7 @@ module Octokit::Client::PullRequests # @return [Boolean] True if deleted, false otherwise # @see https://developer.github.com/v3/pulls/comments/#delete-a-comment # - # source://octokit//lib/octokit/client/pull_requests.rb#264 + # source://octokit//lib/octokit/client/pull_requests.rb#265 def delete_review_comment(repo, comment_id, options = T.unsafe(nil)); end # Merge a pull request @@ -5842,7 +6125,7 @@ module Octokit::Client::PullRequests # @return [Array] Merge commit info if successful # @see https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button # - # source://octokit//lib/octokit/client/pull_requests.rb#299 + # source://octokit//lib/octokit/client/pull_requests.rb#300 def merge_pull_request(repo, number, commit_message = T.unsafe(nil), options = T.unsafe(nil)); end # Get a pull request @@ -5896,7 +6179,7 @@ module Octokit::Client::PullRequests # @return [Array] List of files # @see https://developer.github.com/v3/pulls/#list-pull-requests-files # - # source://octokit//lib/octokit/client/pull_requests.rb#276 + # source://octokit//lib/octokit/client/pull_requests.rb#277 def pull_files(repo, number, options = T.unsafe(nil)); end # Check pull request merge status @@ -5906,7 +6189,7 @@ module Octokit::Client::PullRequests # @return [Boolean] True if the pull request has been merged # @see https://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged # - # source://octokit//lib/octokit/client/pull_requests.rb#309 + # source://octokit//lib/octokit/client/pull_requests.rb#310 def pull_merged?(repo, number, options = T.unsafe(nil)); end # Get a pull request @@ -5960,7 +6243,7 @@ module Octokit::Client::PullRequests # @return [Array] List of files # @see https://developer.github.com/v3/pulls/#list-pull-requests-files # - # source://octokit//lib/octokit/client/pull_requests.rb#276 + # source://octokit//lib/octokit/client/pull_requests.rb#277 def pull_request_files(repo, number, options = T.unsafe(nil)); end # Check pull request merge status @@ -5970,7 +6253,7 @@ module Octokit::Client::PullRequests # @return [Boolean] True if the pull request has been merged # @see https://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged # - # source://octokit//lib/octokit/client/pull_requests.rb#309 + # source://octokit//lib/octokit/client/pull_requests.rb#310 def pull_request_merged?(repo, number, options = T.unsafe(nil)); end # List pull requests for a repository @@ -6096,7 +6379,7 @@ module Octokit::Client::PullRequests # @return [Sawyer::Resource] Hash representing the updated comment # @see https://developer.github.com/v3/pulls/comments/#edit-a-comment # - # source://octokit//lib/octokit/client/pull_requests.rb#249 + # source://octokit//lib/octokit/client/pull_requests.rb#250 def update_pull_comment(repo, comment_id, body, options = T.unsafe(nil)); end # Update a pull request @@ -6123,7 +6406,7 @@ module Octokit::Client::PullRequests # @return [Boolean] True if the pull request branch has been updated # @see https://developer.github.com/v3/pulls/#update-a-pull-request-branch # - # source://octokit//lib/octokit/client/pull_requests.rb#288 + # source://octokit//lib/octokit/client/pull_requests.rb#289 def update_pull_request_branch(repo, number, options = T.unsafe(nil)); end # Update pull request comment @@ -6136,7 +6419,7 @@ module Octokit::Client::PullRequests # @return [Sawyer::Resource] Hash representing the updated comment # @see https://developer.github.com/v3/pulls/comments/#edit-a-comment # - # source://octokit//lib/octokit/client/pull_requests.rb#249 + # source://octokit//lib/octokit/client/pull_requests.rb#250 def update_pull_request_comment(repo, comment_id, body, options = T.unsafe(nil)); end # Update pull request comment @@ -6149,7 +6432,7 @@ module Octokit::Client::PullRequests # @return [Sawyer::Resource] Hash representing the updated comment # @see https://developer.github.com/v3/pulls/comments/#edit-a-comment # - # source://octokit//lib/octokit/client/pull_requests.rb#249 + # source://octokit//lib/octokit/client/pull_requests.rb#250 def update_review_comment(repo, comment_id, body, options = T.unsafe(nil)); end end @@ -6300,6 +6583,20 @@ module Octokit::Client::Reactions # source://octokit//lib/octokit/client/reactions.rb#133 def create_pull_request_review_comment_reaction(repo, id, reaction, options = T.unsafe(nil)); end + # Create reaction for a release + # + # @example + # @client.create_release_reaction("octokit/octokit.rb", 1) + # @param repo [Integer, String, Hash, Repository] A GitHub repository + # @param id [Integer] The Release id + # @param reaction [String] The Reaction + # @return [] Hash representing the reaction. + # @see https://docs.github.com/en/free-pro-team@latest/rest/reactions/reactions?apiVersion=2022-11-28#create-reaction-for-a-release + # @see https://developer.github.com/v3/reactions/#reaction-types + # + # source://octokit//lib/octokit/client/reactions.rb#182 + def create_release_reaction(repo, release_id, reaction, options = T.unsafe(nil)); end + # Delete a reaction # # @example @@ -6313,6 +6610,19 @@ module Octokit::Client::Reactions # source://octokit//lib/octokit/client/reactions.rb#150 def delete_issue_reaction(repo, issue_id, reaction_id, options = T.unsafe(nil)); end + # Delete a reaction for a release + # + # @example + # @client.delete_release_reaction("octokit/octokit.rb", 1, 2) + # @param repo [Integer, String, Hash, Repository] A GitHub repository + # @param issue_id [Integer] The Release id + # @param reaction_id [Integer] The Reaction id + # @return [Boolean] Return true if reaction was deleted, false otherwise. + # @see https://docs.github.com/en/free-pro-team@latest/rest/reactions/reactions?apiVersion=2022-11-28#delete-a-release-reaction + # + # source://octokit//lib/octokit/client/reactions.rb#199 + def delete_release_reaction(repo, release_id, reaction_id, options = T.unsafe(nil)); end + # List reactions for an issue comment # # @example @@ -6348,6 +6658,18 @@ module Octokit::Client::Reactions # # source://octokit//lib/octokit/client/reactions.rb#116 def pull_request_review_comment_reactions(repo, id, options = T.unsafe(nil)); end + + # List reactions for a release + # + # @example + # @client.release_reactions("octokit/octokit.rb", 1) + # @param repo [Integer, String, Hash, Repository] A GitHub repository + # @param id [Integer] The Release id + # @return [Array] Array of Hashes representing the reactions. + # @see https://docs.github.com/en/free-pro-team@latest/rest/reactions/reactions?apiVersion=2022-11-28#list-reactions-for-a-release + # + # source://octokit//lib/octokit/client/reactions.rb#165 + def release_reactions(repo, release_id, options = T.unsafe(nil)); end end # Methods for References for Git Data API @@ -8763,7 +9085,7 @@ module Octokit::Client::Users # @return [Array] Array of all email addresses of the user. # @see https://developer.github.com/v3/users/emails/#add-email-addresses # - # source://octokit//lib/octokit/client/users.rb#312 + # source://octokit//lib/octokit/client/users.rb#339 def add_email(email, _options = T.unsafe(nil)); end # Add public key to user account. @@ -8777,7 +9099,7 @@ module Octokit::Client::Users # @return [Sawyer::Resource] Hash representing the newly added public key. # @see https://developer.github.com/v3/users/keys/#create-a-public-key # - # source://octokit//lib/octokit/client/users.rb#255 + # source://octokit//lib/octokit/client/users.rb#282 def add_key(title, key, options = T.unsafe(nil)); end # List all GitHub users @@ -8800,7 +9122,7 @@ module Octokit::Client::Users # @param id [Integer] ID number of the migration. # @see https://docs.github.com/en/rest/reference/migrations#delete-a-user-migration-archive # - # source://octokit//lib/octokit/client/users.rb#398 + # source://octokit//lib/octokit/client/users.rb#425 def delete_user_migration_archive(id, options = T.unsafe(nil)); end # List email addresses for a user. @@ -8812,7 +9134,7 @@ module Octokit::Client::Users # @return [Array] Array of email addresses. # @see https://developer.github.com/v3/users/emails/#list-email-addresses-for-a-user # - # source://octokit//lib/octokit/client/users.rb#299 + # source://octokit//lib/octokit/client/users.rb#326 def emails(options = T.unsafe(nil)); end # Retrieve the access_token. @@ -8838,7 +9160,7 @@ module Octokit::Client::Users # @return [Boolean] True if follow was successful, false otherwise. # @see https://developer.github.com/v3/users/followers/#follow-a-user # - # source://octokit//lib/octokit/client/users.rb#149 + # source://octokit//lib/octokit/client/users.rb#176 def follow(user, options = T.unsafe(nil)); end # Get a user's followers. @@ -8851,7 +9173,7 @@ module Octokit::Client::Users # followers. # @see https://developer.github.com/v3/users/followers/#list-followers-of-a-user # - # source://octokit//lib/octokit/client/users.rb#99 + # source://octokit//lib/octokit/client/users.rb#126 def followers(user = T.unsafe(nil), options = T.unsafe(nil)); end # Get list of users a user is following. @@ -8864,7 +9186,7 @@ module Octokit::Client::Users # user is following. # @see https://developer.github.com/v3/users/followers/#list-users-followed-by-another-user # - # source://octokit//lib/octokit/client/users.rb#112 + # source://octokit//lib/octokit/client/users.rb#139 def following(user = T.unsafe(nil), options = T.unsafe(nil)); end # Check if you are following a user. Alternatively, check if a given user @@ -8882,7 +9204,7 @@ module Octokit::Client::Users # @see https://developer.github.com/v3/users/followers/#check-if-you-are-following-a-user # @see https://developer.github.com/v3/users/followers/#check-if-one-user-follows-another # - # source://octokit//lib/octokit/client/users.rb#134 + # source://octokit//lib/octokit/client/users.rb#161 def follows?(*args); end # Get a public key. @@ -8909,7 +9231,7 @@ module Octokit::Client::Users # @return [Sawyer::Resource] Hash representing the key. # @see https://developer.github.com/v3/users/keys/#get-a-single-public-key # - # source://octokit//lib/octokit/client/users.rb#217 + # source://octokit//lib/octokit/client/users.rb#244 def key(key_id, options = T.unsafe(nil)); end # Get list of public keys for user. @@ -8921,9 +9243,23 @@ module Octokit::Client::Users # @return [Array] Array of hashes representing public keys. # @see https://developer.github.com/v3/users/keys/#list-your-public-keys # - # source://octokit//lib/octokit/client/users.rb#229 + # source://octokit//lib/octokit/client/users.rb#256 def keys(options = T.unsafe(nil)); end + # Refresh a user's access token with a refresh token. + # + # Applications can refresh an access token without requiring a user to re-authorize using refresh access token. + # + # @example + # client = Octokit::Client.new(:client_id => 'abcdefg12345', :client_secret => 'secret') + # client.refresh_access_token('40-character-refresh-token') + # @param code [String] 40 character GitHub OAuth refresh access token + # @return [Sawyer::Resource] + # @see https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/refreshing-user-access-tokens#refreshing-a-user-access-token-with-a-refresh-token + # + # source://octokit//lib/octokit/client/users.rb#72 + def refresh_access_token(code, app_id = T.unsafe(nil), app_secret = T.unsafe(nil), options = T.unsafe(nil)); end + # Remove email from user. # # Requires authenticated client. @@ -8934,7 +9270,7 @@ module Octokit::Client::Users # @return [Array] Array of all email addresses of the user. # @see https://developer.github.com/v3/users/emails/#delete-email-addresses # - # source://octokit//lib/octokit/client/users.rb#326 + # source://octokit//lib/octokit/client/users.rb#353 def remove_email(email); end # Remove a public key from user account. @@ -8947,7 +9283,7 @@ module Octokit::Client::Users # @return [Boolean] True if removal was successful, false otherwise. # @see https://developer.github.com/v3/users/keys/#delete-a-public-key # - # source://octokit//lib/octokit/client/users.rb#287 + # source://octokit//lib/octokit/client/users.rb#314 def remove_key(id, options = T.unsafe(nil)); end # Get list of repos starred by a user. @@ -8962,7 +9298,7 @@ module Octokit::Client::Users # @return [Array] Array of hashes representing repositories starred by user. # @see https://developer.github.com/v3/activity/starring/#list-repositories-being-starred # - # source://octokit//lib/octokit/client/users.rb#177 + # source://octokit//lib/octokit/client/users.rb#204 def starred(user = T.unsafe(nil), options = T.unsafe(nil)); end # Check if you are starring a repo. @@ -8975,7 +9311,7 @@ module Octokit::Client::Users # @return [Boolean] True if you are following the repo, false otherwise. # @see https://developer.github.com/v3/activity/starring/#check-if-you-are-starring-a-repository # - # source://octokit//lib/octokit/client/users.rb#190 + # source://octokit//lib/octokit/client/users.rb#217 def starred?(repo, options = T.unsafe(nil)); end # Initiates the generation of a migration archive. @@ -8991,7 +9327,7 @@ module Octokit::Client::Users # @return [Sawyer::Resource] Hash representing the new migration. # @see https://docs.github.com/en/rest/reference/migrations#start-a-user-migration # - # source://octokit//lib/octokit/client/users.rb#354 + # source://octokit//lib/octokit/client/users.rb#381 def start_user_migration(repositories, options = T.unsafe(nil)); end # List repositories being watched by a user. @@ -9002,7 +9338,7 @@ module Octokit::Client::Users # @return [Array] Array of repositories. # @see https://developer.github.com/v3/activity/watching/#list-repositories-being-watched # - # source://octokit//lib/octokit/client/users.rb#338 + # source://octokit//lib/octokit/client/users.rb#365 def subscriptions(user = T.unsafe(nil), options = T.unsafe(nil)); end # Unfollow a user. @@ -9015,7 +9351,7 @@ module Octokit::Client::Users # @return [Boolean] True if unfollow was successful, false otherwise. # @see https://developer.github.com/v3/users/followers/#unfollow-a-user # - # source://octokit//lib/octokit/client/users.rb#162 + # source://octokit//lib/octokit/client/users.rb#189 def unfollow(user, options = T.unsafe(nil)); end # Unlock a user repository which has been locked by a migration. @@ -9026,7 +9362,7 @@ module Octokit::Client::Users # @param repo [String] Name of the repository. # @see https://docs.github.com/en/rest/reference/migrations#unlock-a-user-repository # - # source://octokit//lib/octokit/client/users.rb#419 + # source://octokit//lib/octokit/client/users.rb#446 def unlock_user_repository(id, repo, options = T.unsafe(nil)); end # Update a public key @@ -9044,7 +9380,7 @@ module Octokit::Client::Users # @see https://developer.github.com/v3/users/keys/#update-a-public-key # @see https://developer.github.com/changes/2014-02-24-finer-grained-scopes-for-ssh-keys/ # - # source://octokit//lib/octokit/client/users.rb#274 + # source://octokit//lib/octokit/client/users.rb#301 def update_key(key_id, options = T.unsafe(nil)); end # Update the authenticated user @@ -9062,7 +9398,7 @@ module Octokit::Client::Users # @return [Sawyer::Resource] # @see https://developer.github.com/v3/users/#update-the-authenticated-user # - # source://octokit//lib/octokit/client/users.rb#86 + # source://octokit//lib/octokit/client/users.rb#113 def update_user(options); end # Get a single user @@ -9085,7 +9421,7 @@ module Octokit::Client::Users # @return [Array] Array of hashes representing public keys. # @see https://developer.github.com/v3/users/keys/#list-public-keys-for-a-user # - # source://octokit//lib/octokit/client/users.rb#240 + # source://octokit//lib/octokit/client/users.rb#267 def user_keys(user, options = T.unsafe(nil)); end # Fetches the URL to a migration archive. @@ -9095,7 +9431,7 @@ module Octokit::Client::Users # @param id [Integer] ID number of the migration. # @see https://docs.github.com/en/rest/reference/migrations#download-a-user-migration-archive # - # source://octokit//lib/octokit/client/users.rb#385 + # source://octokit//lib/octokit/client/users.rb#412 def user_migration_archive_url(id, options = T.unsafe(nil)); end # List repositories for a user migration. @@ -9105,7 +9441,7 @@ module Octokit::Client::Users # @param id [Integer] ID number of the migration. # @see https://docs.github.com/en/rest/reference/migrations#list-repositories-for-a-user-migration # - # source://octokit//lib/octokit/client/users.rb#408 + # source://octokit//lib/octokit/client/users.rb#435 def user_migration_repositories(id, options = T.unsafe(nil)); end # Fetches the status of a migration. @@ -9115,7 +9451,7 @@ module Octokit::Client::Users # @param id [Integer] ID number of the migration. # @see https://docs.github.com/en/rest/reference/migrations#get-a-user-migration-status # - # source://octokit//lib/octokit/client/users.rb#375 + # source://octokit//lib/octokit/client/users.rb#402 def user_migration_status(id, options = T.unsafe(nil)); end # Lists the most recent migrations. @@ -9125,7 +9461,7 @@ module Octokit::Client::Users # @return [Array] Array of migration resources. # @see https://docs.github.com/en/rest/reference/migrations#list-user-migrations # - # source://octokit//lib/octokit/client/users.rb#365 + # source://octokit//lib/octokit/client/users.rb#392 def user_migrations(options = T.unsafe(nil)); end # Validate user username and password @@ -9135,7 +9471,7 @@ module Octokit::Client::Users # @param options [Hash] User credentials # @return [Boolean] True if credentials are valid # - # source://octokit//lib/octokit/client/users.rb#66 + # source://octokit//lib/octokit/client/users.rb#93 def validate_credentials(options = T.unsafe(nil)); end # List repositories being watched by a user. @@ -9146,19 +9482,19 @@ module Octokit::Client::Users # @return [Array] Array of repositories. # @see https://developer.github.com/v3/activity/watching/#list-repositories-being-watched # - # source://octokit//lib/octokit/client/users.rb#338 + # source://octokit//lib/octokit/client/users.rb#365 def watched(user = T.unsafe(nil), options = T.unsafe(nil)); end end # Raised on errors in the 400-499 range # -# source://octokit//lib/octokit/error.rb#226 +# source://octokit//lib/octokit/error.rb#229 class Octokit::ClientError < ::Octokit::Error; end # Raised when GitHub returns a 422 HTTP status code # and body matches 'PullRequestReviewComment' and 'commit_id (or end_commit_oid) is not part of the pull request' # -# source://octokit//lib/octokit/error.rb#328 +# source://octokit//lib/octokit/error.rb#334 class Octokit::CommitIsNotPartOfPullRequest < ::Octokit::UnprocessableEntity; end # Configuration options for {Client}, defaulting to values @@ -9168,67 +9504,67 @@ class Octokit::CommitIsNotPartOfPullRequest < ::Octokit::UnprocessableEntity; en module Octokit::Configurable # Returns the value of attribute access_token. # - # source://octokit//lib/octokit/configurable.rb#57 + # source://octokit//lib/octokit/configurable.rb#63 def access_token; end # @return [String] OAuth2 access token for authentication # @see https://developer.github.com/v3/oauth/ # - # source://octokit//lib/octokit/configurable.rb#57 + # source://octokit//lib/octokit/configurable.rb#63 def access_token=(_arg0); end # @return [String] Base URL for API requests. default: https://api.github.com/ # - # source://octokit//lib/octokit/configurable.rb#121 + # source://octokit//lib/octokit/configurable.rb#133 def api_endpoint; end # @return [String] Base URL for API requests. default: https://api.github.com/ # - # source://octokit//lib/octokit/configurable.rb#61 + # source://octokit//lib/octokit/configurable.rb#67 def api_endpoint=(_arg0); end # @return [Boolean] Auto fetch next page of results until rate limit reached # - # source://octokit//lib/octokit/configurable.rb#57 + # source://octokit//lib/octokit/configurable.rb#63 def auto_paginate; end # @return [Boolean] Auto fetch next page of results until rate limit reached # - # source://octokit//lib/octokit/configurable.rb#57 + # source://octokit//lib/octokit/configurable.rb#63 def auto_paginate=(_arg0); end # Returns the value of attribute bearer_token. # - # source://octokit//lib/octokit/configurable.rb#57 + # source://octokit//lib/octokit/configurable.rb#63 def bearer_token; end # @return [String] JWT bearer token for authentication # @see https://developer.github.com/early-access/integrations/authentication/#as-an-integration # - # source://octokit//lib/octokit/configurable.rb#57 + # source://octokit//lib/octokit/configurable.rb#63 def bearer_token=(_arg0); end # @return [String] Configure OAuth app key # @see https://developer.github.com/v3/oauth/ # - # source://octokit//lib/octokit/configurable.rb#57 + # source://octokit//lib/octokit/configurable.rb#63 def client_id; end # @return [String] Configure OAuth app key # @see https://developer.github.com/v3/oauth/ # - # source://octokit//lib/octokit/configurable.rb#57 + # source://octokit//lib/octokit/configurable.rb#63 def client_id=(_arg0); end # Returns the value of attribute client_secret. # - # source://octokit//lib/octokit/configurable.rb#57 + # source://octokit//lib/octokit/configurable.rb#63 def client_secret; end # @return [String] Configure OAuth app secret # @see https://developer.github.com/v3/oauth/ # - # source://octokit//lib/octokit/configurable.rb#57 + # source://octokit//lib/octokit/configurable.rb#63 def client_secret=(_arg0); end # Set configuration options using a block @@ -9236,125 +9572,145 @@ module Octokit::Configurable # @yield [_self] # @yieldparam _self [Octokit::Configurable] the object that the method was called on # - # source://octokit//lib/octokit/configurable.rb#94 + # source://octokit//lib/octokit/configurable.rb#106 def configure; end # @return [Hash] Configure connection options for Faraday # @see https://github.com/lostisland/faraday # - # source://octokit//lib/octokit/configurable.rb#57 + # source://octokit//lib/octokit/configurable.rb#63 def connection_options; end # @return [Hash] Configure connection options for Faraday # @see https://github.com/lostisland/faraday # - # source://octokit//lib/octokit/configurable.rb#57 + # source://octokit//lib/octokit/configurable.rb#63 def connection_options=(_arg0); end # @return [String] Configure preferred media type (for API versioning, for example) # @see https://developer.github.com/v3/media/ # - # source://octokit//lib/octokit/configurable.rb#57 + # source://octokit//lib/octokit/configurable.rb#63 def default_media_type; end # @return [String] Configure preferred media type (for API versioning, for example) # @see https://developer.github.com/v3/media/ # - # source://octokit//lib/octokit/configurable.rb#57 + # source://octokit//lib/octokit/configurable.rb#63 def default_media_type=(_arg0); end # @return [String] GitHub username for Basic Authentication # - # source://octokit//lib/octokit/configurable.rb#136 + # source://octokit//lib/octokit/configurable.rb#152 def login; end # @return [String] GitHub username for Basic Authentication # - # source://octokit//lib/octokit/configurable.rb#61 + # source://octokit//lib/octokit/configurable.rb#67 def login=(_arg0); end + # @return [String] Base URL for API requests to the GitHub Enterprise Server Manage API + # + # source://octokit//lib/octokit/configurable.rb#141 + def manage_ghes_endpoint; end + + # @return [String] Base URL for API requests to the GitHub Enterprise Server Manage API + # + # source://octokit//lib/octokit/configurable.rb#67 + def manage_ghes_endpoint=(_arg0); end + + # @return [String] API user password for requests to the GitHub Enterprise Server Manage API + # + # source://octokit//lib/octokit/configurable.rb#67 + def manage_ghes_password=(_arg0); end + + # @return [String] API username for requests to the GitHub Enterprise Server Manage API + # + # source://octokit//lib/octokit/configurable.rb#67 + def manage_ghes_username=(_arg0); end + # @return [String] Base URL for API requests to the GitHub Enterprise management console # - # source://octokit//lib/octokit/configurable.rb#125 + # source://octokit//lib/octokit/configurable.rb#137 def management_console_endpoint; end # @return [String] Base URL for API requests to the GitHub Enterprise management console # - # source://octokit//lib/octokit/configurable.rb#61 + # source://octokit//lib/octokit/configurable.rb#67 def management_console_endpoint=(_arg0); end # @return [String] An admin password set up for your GitHub Enterprise management console # - # source://octokit//lib/octokit/configurable.rb#61 + # source://octokit//lib/octokit/configurable.rb#67 def management_console_password=(_arg0); end # @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday # @see https://github.com/lostisland/faraday # - # source://octokit//lib/octokit/configurable.rb#57 + # source://octokit//lib/octokit/configurable.rb#63 def middleware; end # @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday # @see https://github.com/lostisland/faraday # - # source://octokit//lib/octokit/configurable.rb#57 + # source://octokit//lib/octokit/configurable.rb#63 def middleware=(_arg0); end # @return [Boolean] Instruct Octokit to get credentials from .netrc file # - # source://octokit//lib/octokit/configurable.rb#57 + # source://octokit//lib/octokit/configurable.rb#63 def netrc; end # @return [Boolean] Instruct Octokit to get credentials from .netrc file # - # source://octokit//lib/octokit/configurable.rb#57 + # source://octokit//lib/octokit/configurable.rb#63 def netrc=(_arg0); end # @return [Boolean] # - # source://octokit//lib/octokit/configurable.rb#140 + # source://octokit//lib/octokit/configurable.rb#156 def netrc?; end # @return [String] Path to .netrc file. default: ~/.netrc # - # source://octokit//lib/octokit/configurable.rb#57 + # source://octokit//lib/octokit/configurable.rb#63 def netrc_file; end # @return [String] Path to .netrc file. default: ~/.netrc # - # source://octokit//lib/octokit/configurable.rb#57 + # source://octokit//lib/octokit/configurable.rb#63 def netrc_file=(_arg0); end # @return [String] GitHub password for Basic Authentication # - # source://octokit//lib/octokit/configurable.rb#61 + # source://octokit//lib/octokit/configurable.rb#67 def password=(_arg0); end # @return [String] Configure page size for paginated results. API default: 30 # - # source://octokit//lib/octokit/configurable.rb#57 + # source://octokit//lib/octokit/configurable.rb#63 def per_page; end # @return [String] Configure page size for paginated results. API default: 30 # - # source://octokit//lib/octokit/configurable.rb#57 + # source://octokit//lib/octokit/configurable.rb#63 def per_page=(_arg0); end # @return [String] URI for proxy server # @see https://github.com/lostisland/faraday # - # source://octokit//lib/octokit/configurable.rb#57 + # source://octokit//lib/octokit/configurable.rb#63 def proxy; end # @return [String] URI for proxy server # @see https://github.com/lostisland/faraday # - # source://octokit//lib/octokit/configurable.rb#57 + # source://octokit//lib/octokit/configurable.rb#63 def proxy=(_arg0); end # Reset configuration options to default values # - # source://octokit//lib/octokit/configurable.rb#99 + # source://octokit//lib/octokit/configurable.rb#111 def reset!; end # Compares client options to a Hash of requested options @@ -9362,56 +9718,56 @@ module Octokit::Configurable # @param opts [Hash] Options to compare with current client options # @return [Boolean] # - # source://octokit//lib/octokit/configurable.rb#117 + # source://octokit//lib/octokit/configurable.rb#129 def same_options?(opts); end # Reset configuration options to default values # - # source://octokit//lib/octokit/configurable.rb#99 + # source://octokit//lib/octokit/configurable.rb#111 def setup; end # @return [String] SSL verify mode for ssl connections # @see https://github.com/lostisland/faraday # - # source://octokit//lib/octokit/configurable.rb#57 + # source://octokit//lib/octokit/configurable.rb#63 def ssl_verify_mode; end # @return [String] SSL verify mode for ssl connections # @see https://github.com/lostisland/faraday # - # source://octokit//lib/octokit/configurable.rb#57 + # source://octokit//lib/octokit/configurable.rb#63 def ssl_verify_mode=(_arg0); end # @return [String] Configure User-Agent header for requests. # - # source://octokit//lib/octokit/configurable.rb#57 + # source://octokit//lib/octokit/configurable.rb#63 def user_agent; end # Sets the attribute user_agent # # @param value the value to set the attribute user_agent to. # - # source://octokit//lib/octokit/configurable.rb#57 + # source://octokit//lib/octokit/configurable.rb#63 def user_agent=(_arg0); end # Base URL for generated web URLs # # @return [String] Default: https://github.com/ # - # source://octokit//lib/octokit/configurable.rb#132 + # source://octokit//lib/octokit/configurable.rb#148 def web_endpoint; end # @return [String] Base URL for web URLs. default: https://github.com/ # - # source://octokit//lib/octokit/configurable.rb#61 + # source://octokit//lib/octokit/configurable.rb#67 def web_endpoint=(_arg0); end private - # source://octokit//lib/octokit/configurable.rb#150 + # source://octokit//lib/octokit/configurable.rb#166 def fetch_client_id_and_secret(overrides = T.unsafe(nil)); end - # source://octokit//lib/octokit/configurable.rb#146 + # source://octokit//lib/octokit/configurable.rb#162 def options; end class << self @@ -9419,14 +9775,14 @@ module Octokit::Configurable # # @return [Array] of option keys # - # source://octokit//lib/octokit/configurable.rb#67 + # source://octokit//lib/octokit/configurable.rb#76 def keys; end end end # Raised when GitHub returns a 409 HTTP status code # -# source://octokit//lib/octokit/error.rb#318 +# source://octokit//lib/octokit/error.rb#321 class Octokit::Conflict < ::Octokit::ClientError; end # Network layer for API clients. @@ -9562,84 +9918,105 @@ Octokit::Connection::CONVENIENCE_HEADERS = T.let(T.unsafe(nil), Set) # Default configuration options for {Client} # -# source://octokit//lib/octokit/default.rb#19 +# source://octokit//lib/octokit/default.rb#24 module Octokit::Default class << self # Default access token from ENV # # @return [String] # - # source://octokit//lib/octokit/default.rb#59 + # source://octokit//lib/octokit/default.rb#64 def access_token; end # Default API endpoint from ENV or {API_ENDPOINT} # # @return [String] # - # source://octokit//lib/octokit/default.rb#65 + # source://octokit//lib/octokit/default.rb#70 def api_endpoint; end # Default pagination preference from ENV # # @return [String] # - # source://octokit//lib/octokit/default.rb#71 + # source://octokit//lib/octokit/default.rb#76 def auto_paginate; end # Default bearer token from ENV # # @return [String] # - # source://octokit//lib/octokit/default.rb#77 + # source://octokit//lib/octokit/default.rb#82 def bearer_token; end # Default OAuth app key from ENV # # @return [String] # - # source://octokit//lib/octokit/default.rb#83 + # source://octokit//lib/octokit/default.rb#88 def client_id; end # Default OAuth app secret from ENV # # @return [String] # - # source://octokit//lib/octokit/default.rb#89 + # source://octokit//lib/octokit/default.rb#94 def client_secret; end # Default options for Faraday::Connection # # @return [Hash] # - # source://octokit//lib/octokit/default.rb#107 + # source://octokit//lib/octokit/default.rb#130 def connection_options; end # Default media type from ENV or {MEDIA_TYPE} # # @return [String] # - # source://octokit//lib/octokit/default.rb#118 + # source://octokit//lib/octokit/default.rb#141 def default_media_type; end # Default GitHub username for Basic Auth from ENV # # @return [String] # - # source://octokit//lib/octokit/default.rb#124 + # source://octokit//lib/octokit/default.rb#147 def login; end + # Default GHES Manage API endpoint from ENV + # + # @return [String] + # + # source://octokit//lib/octokit/default.rb#112 + def manage_ghes_endpoint; end + + # Default GHES Manage API password from ENV + # + # @return [String] + # + # source://octokit//lib/octokit/default.rb#124 + def manage_ghes_password; end + + # Default GHES Manage API username from ENV + # + # @return [String] + # + # source://octokit//lib/octokit/default.rb#118 + def manage_ghes_username; end + # Default management console endpoint from ENV # # @return [String] # - # source://octokit//lib/octokit/default.rb#101 + # source://octokit//lib/octokit/default.rb#106 def management_console_endpoint; end # Default management console password from ENV # # @return [String] # - # source://octokit//lib/octokit/default.rb#95 + # source://octokit//lib/octokit/default.rb#100 def management_console_password; end # Default middleware stack for Faraday::Connection @@ -9647,99 +10024,104 @@ module Octokit::Default # # @return [Faraday::RackBuilder or Faraday::Builder] # - # source://octokit//lib/octokit/default.rb#131 + # source://octokit//lib/octokit/default.rb#154 def middleware; end # Default behavior for reading .netrc file # # @return [Boolean] # - # source://octokit//lib/octokit/default.rb#178 + # source://octokit//lib/octokit/default.rb#201 def netrc; end # Default path for .netrc file # # @return [String] # - # source://octokit//lib/octokit/default.rb#184 + # source://octokit//lib/octokit/default.rb#207 def netrc_file; end # Configuration options # # @return [Hash] # - # source://octokit//lib/octokit/default.rb#53 + # source://octokit//lib/octokit/default.rb#58 def options; end # Default GitHub password for Basic Auth from ENV # # @return [String] # - # source://octokit//lib/octokit/default.rb#137 + # source://octokit//lib/octokit/default.rb#160 def password; end # Default pagination page size from ENV # # @return [Integer] Page size # - # source://octokit//lib/octokit/default.rb#143 + # source://octokit//lib/octokit/default.rb#166 def per_page; end # Default proxy server URI for Faraday connection from ENV # # @return [String] # - # source://octokit//lib/octokit/default.rb#151 + # source://octokit//lib/octokit/default.rb#174 def proxy; end # Default SSL verify mode from ENV # # @return [Integer] # - # source://octokit//lib/octokit/default.rb#157 + # source://octokit//lib/octokit/default.rb#180 def ssl_verify_mode; end # Default User-Agent header string from ENV or {USER_AGENT} # # @return [String] # - # source://octokit//lib/octokit/default.rb#166 + # source://octokit//lib/octokit/default.rb#189 def user_agent; end # Default web endpoint from ENV or {WEB_ENDPOINT} # # @return [String] # - # source://octokit//lib/octokit/default.rb#172 + # source://octokit//lib/octokit/default.rb#195 def web_endpoint; end end end # Default API endpoint # -# source://octokit//lib/octokit/default.rb#21 +# source://octokit//lib/octokit/default.rb#26 Octokit::Default::API_ENDPOINT = T.let(T.unsafe(nil), String) # Default media type # -# source://octokit//lib/octokit/default.rb#27 +# source://octokit//lib/octokit/default.rb#32 Octokit::Default::MEDIA_TYPE = T.let(T.unsafe(nil), String) # Default Faraday middleware stack # -# source://octokit//lib/octokit/default.rb#33 +# source://octokit//lib/octokit/default.rb#38 Octokit::Default::MIDDLEWARE = T.let(T.unsafe(nil), Faraday::RackBuilder) # Default User Agent header string # -# source://octokit//lib/octokit/default.rb#24 +# source://octokit//lib/octokit/default.rb#29 Octokit::Default::USER_AGENT = T.let(T.unsafe(nil), String) # Default WEB endpoint # -# source://octokit//lib/octokit/default.rb#30 +# source://octokit//lib/octokit/default.rb#35 Octokit::Default::WEB_ENDPOINT = T.let(T.unsafe(nil), String) +# Raised when GHES Manage return a 410 HTTP status code +# +# source://octokit//lib/octokit/error.rb#324 +class Octokit::Deprecated < ::Octokit::ClientError; end + # EnterpriseAdminClient is only meant to be used by GitHub Enterprise Admins # and provides access the Admin only API endpoints including Admin Stats, # Management Console, and the Search Indexing API. @@ -10180,10 +10562,10 @@ class Octokit::EnterpriseManagementConsoleClient private - # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#160 + # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#171 def faraday_configuration; end - # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#154 + # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#165 def password_hash; end end @@ -10198,28 +10580,28 @@ module Octokit::EnterpriseManagementConsoleClient::ManagementConsole # @param key Either the file path to a key, a File handler to the key, or the contents of the key itself # @return [Sawyer::Resource] An array of authorized SSH keys # - # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#106 + # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#115 def add_authorized_key(key); end # Fetch the authorized SSH keys on the Enterprise install # # @return [Sawyer::Resource] An array of authorized SSH keys # - # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#97 + # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#105 def authorized_keys; end # Get information about the Enterprise installation # # @return [Sawyer::Resource] The installation information # - # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#51 + # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#54 def config_check; end # Get information about the Enterprise installation # # @return [Sawyer::Resource] The installation information # - # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#51 + # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#54 def config_status; end # Removes an authorized SSH keys from the Enterprise install @@ -10227,7 +10609,7 @@ module Octokit::EnterpriseManagementConsoleClient::ManagementConsole # @param key Either the file path to a key, a File handler to the key, or the contents of the key itself # @return [Sawyer::Resource] An array of authorized SSH keys # - # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#130 + # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#140 def delete_authorized_key(key); end # Start (or turn off) the Enterprise maintenance mode @@ -10235,7 +10617,7 @@ module Octokit::EnterpriseManagementConsoleClient::ManagementConsole # @param maintenance [Hash] A hash configuration of the maintenance settings # @return [nil] # - # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#87 + # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#94 def edit_maintenance_status(maintenance); end # Modify the Enterprise settings @@ -10243,35 +10625,35 @@ module Octokit::EnterpriseManagementConsoleClient::ManagementConsole # @param settings [Hash] A hash configuration of the new settings # @return [nil] # - # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#69 + # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#74 def edit_settings(settings); end # Fetch the authorized SSH keys on the Enterprise install # # @return [Sawyer::Resource] An array of authorized SSH keys # - # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#97 + # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#105 def get_authorized_keys; end # Get information about the Enterprise maintenance status # # @return [Sawyer::Resource] The maintenance status # - # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#78 + # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#84 def get_maintenance_status; end # Get information about the Enterprise installation # # @return [Sawyer::Resource] The settings # - # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#59 + # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#63 def get_settings; end # Get information about the Enterprise maintenance status # # @return [Sawyer::Resource] The maintenance status # - # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#78 + # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#84 def maintenance_status; end # Removes an authorized SSH keys from the Enterprise install @@ -10279,7 +10661,7 @@ module Octokit::EnterpriseManagementConsoleClient::ManagementConsole # @param key Either the file path to a key, a File handler to the key, or the contents of the key itself # @return [Sawyer::Resource] An array of authorized SSH keys # - # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#130 + # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#140 def remove_authorized_key(key); end # Start (or turn off) the Enterprise maintenance mode @@ -10287,21 +10669,21 @@ module Octokit::EnterpriseManagementConsoleClient::ManagementConsole # @param maintenance [Hash] A hash configuration of the maintenance settings # @return [nil] # - # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#87 + # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#94 def set_maintenance_status(maintenance); end # Get information about the Enterprise installation # # @return [Sawyer::Resource] The settings # - # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#59 + # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#63 def settings; end # Start a configuration process. # # @return nil # - # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#30 + # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#31 def start_configuration; end # Upgrade an Enterprise installation @@ -10309,7 +10691,7 @@ module Octokit::EnterpriseManagementConsoleClient::ManagementConsole # @param license [String] The path to your .ghl license file. # @return nil # - # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#39 + # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#41 def upgrade(license); end # source://octokit//lib/octokit/enterprise_management_console_client/management_console.rb#16 @@ -10322,10 +10704,10 @@ end class Octokit::Error < ::StandardError # @return [Error] a new instance of Error # - # source://octokit//lib/octokit/error.rb#46 + # source://octokit//lib/octokit/error.rb#49 def initialize(response = T.unsafe(nil)); end - # source://octokit//lib/octokit/error.rb#40 + # source://octokit//lib/octokit/error.rb#43 def build_error_context; end # Returns the value of attribute context. @@ -10337,55 +10719,55 @@ class Octokit::Error < ::StandardError # # @return [String] # - # source://octokit//lib/octokit/error.rb#55 + # source://octokit//lib/octokit/error.rb#58 def documentation_url; end # Array of validation errors # # @return [Array] Error info # - # source://octokit//lib/octokit/error.rb#129 + # source://octokit//lib/octokit/error.rb#132 def errors; end # Body returned by the GitHub server. # # @return [String] # - # source://octokit//lib/octokit/error.rb#154 + # source://octokit//lib/octokit/error.rb#157 def response_body; end # Headers returned by the GitHub server. # # @return [Hash] # - # source://octokit//lib/octokit/error.rb#147 + # source://octokit//lib/octokit/error.rb#150 def response_headers; end # Status code returned by the GitHub server. # # @return [Integer] # - # source://octokit//lib/octokit/error.rb#140 + # source://octokit//lib/octokit/error.rb#143 def response_status; end private - # source://octokit//lib/octokit/error.rb#202 + # source://octokit//lib/octokit/error.rb#205 def build_error_message; end - # source://octokit//lib/octokit/error.rb#160 + # source://octokit//lib/octokit/error.rb#163 def data; end - # source://octokit//lib/octokit/error.rb#215 + # source://octokit//lib/octokit/error.rb#218 def redact_url(url_string); end - # source://octokit//lib/octokit/error.rb#183 + # source://octokit//lib/octokit/error.rb#186 def response_error; end - # source://octokit//lib/octokit/error.rb#187 + # source://octokit//lib/octokit/error.rb#190 def response_error_summary; end - # source://octokit//lib/octokit/error.rb#174 + # source://octokit//lib/octokit/error.rb#177 def response_message; end class << self @@ -10393,44 +10775,45 @@ class Octokit::Error < ::StandardError # # @private # - # source://octokit//lib/octokit/error.rb#62 + # source://octokit//lib/octokit/error.rb#65 def error_for_401(headers); end # Returns most appropriate error for 403 HTTP status code # # @private # - # source://octokit//lib/octokit/error.rb#73 + # source://octokit//lib/octokit/error.rb#76 def error_for_403(body); end # Return most appropriate error for 404 HTTP status code # # @private # - # source://octokit//lib/octokit/error.rb#104 + # source://octokit//lib/octokit/error.rb#107 def error_for_404(body); end # Return most appropriate error for 422 HTTP status code # # @private # - # source://octokit//lib/octokit/error.rb#116 + # source://octokit//lib/octokit/error.rb#119 def error_for_422(body); end # Returns the appropriate Octokit::Error subclass based # on status and response message # + # # @param response [Hash] HTTP response # @return [Octokit::Error] # - # source://octokit//lib/octokit/error.rb#13 + # source://octokit//lib/octokit/error.rb#14 def from_response(response); end end end # Raised when GitHub returns a 403 HTTP status code # -# source://octokit//lib/octokit/error.rb#262 +# source://octokit//lib/octokit/error.rb#265 class Octokit::Forbidden < ::Octokit::ClientError; end # Class to parse and create Gist URLs @@ -10480,17 +10863,17 @@ end # Raised when GitHub returns a 403 HTTP status code # and body matches 'suspended your access' # -# source://octokit//lib/octokit/error.rb#302 +# source://octokit//lib/octokit/error.rb#305 class Octokit::InstallationSuspended < ::Octokit::Forbidden; end # Raised when GitHub returns a 500 HTTP status code # -# source://octokit//lib/octokit/error.rb#341 +# source://octokit//lib/octokit/error.rb#347 class Octokit::InternalServerError < ::Octokit::ServerError; end # Raised when a repository is created with an invalid format # -# source://octokit//lib/octokit/error.rb#360 +# source://octokit//lib/octokit/error.rb#366 class Octokit::InvalidRepository < ::ArgumentError; end # Current major release. @@ -10507,9 +10890,179 @@ Octokit::MAJOR = T.let(T.unsafe(nil), Integer) # source://octokit//lib/octokit/version.rb#10 Octokit::MINOR = T.let(T.unsafe(nil), Integer) +# ManageGHESClient is only meant to be used by GitHub Enterprise Server (GHES) operators +# and provides access to the Manage GHES API endpoints. +# +# @see Octokit::Client Use Octokit::Client for regular API use for GitHub +# and GitHub Enterprise. +# @see https://developer.github.com/v3/enterprise-admin/manage-ghes/ +# +# source://octokit//lib/octokit/manage_ghes_client/manage_ghes.rb#5 +class Octokit::ManageGHESClient + include ::Octokit::Configurable + include ::Octokit::Authentication + include ::Octokit::Connection + include ::Octokit::Warnable + include ::Octokit::ManageGHESClient::ManageAPI + + # @return [ManageGHESClient] a new instance of ManageGHESClient + # + # source://octokit//lib/octokit/manage_ghes_client.rb#21 + def initialize(options = T.unsafe(nil)); end + + # Add an authorized SSH keys on the Enterprise install + # + # @param key Either the file path to a key, a File handler to the key, or the contents of the key itself + # @return [nil] + # + # source://octokit//lib/octokit/manage_ghes_client/manage_ghes.rb#92 + def add_authorized_key(key); end + + # source://octokit//lib/octokit/manage_ghes_client/manage_ghes.rb#82 + def authorized_keys; end + + # Get information about the Enterprise installation + # + # @return [nil] + # + # source://octokit//lib/octokit/manage_ghes_client/manage_ghes.rb#57 + def config_check; end + + # Get information about the Enterprise installation + # + # @return [nil] + # + # source://octokit//lib/octokit/manage_ghes_client/manage_ghes.rb#57 + def config_status; end + + # Removes an authorized SSH keys from the Enterprise install + # + # @param key Either the file path to a key, a File handler to the key, or the contents of the key itself + # @return [nil] + # + # source://octokit//lib/octokit/manage_ghes_client/manage_ghes.rb#117 + def delete_authorized_key(key); end + + # Modify the Enterprise settings + # + # @param settings [Hash] A hash configuration of the new settings + # @return [nil] + # + # source://octokit//lib/octokit/manage_ghes_client/manage_ghes.rb#77 + def edit_settings(settings); end + + # source://octokit//lib/octokit/manage_ghes_client/manage_ghes.rb#82 + def get_authorized_keys; end + + # Get information about the Enterprise installation + # + # @return [nil] + # + # source://octokit//lib/octokit/manage_ghes_client/manage_ghes.rb#66 + def get_settings; end + + # Removes an authorized SSH keys from the Enterprise install + # + # @param key Either the file path to a key, a File handler to the key, or the contents of the key itself + # @return [nil] + # + # source://octokit//lib/octokit/manage_ghes_client/manage_ghes.rb#117 + def remove_authorized_key(key); end + + # Get information about the Enterprise installation + # + # @return [nil] + # + # source://octokit//lib/octokit/manage_ghes_client/manage_ghes.rb#66 + def settings; end + + # Start a configuration process. + # + # @return [nil] + # + # source://octokit//lib/octokit/manage_ghes_client/manage_ghes.rb#49 + def start_configuration; end + + # source://octokit//lib/octokit/manage_ghes_client/manage_ghes.rb#37 + def upload_license(license); end + + protected + + # source://octokit//lib/octokit/manage_ghes_client.rb#36 + def endpoint; end + + # Set Manage GHES API endpoint + # + # @param value [String] Manage GHES API endpoint + # + # source://octokit//lib/octokit/manage_ghes_client.rb#43 + def manage_ghes_endpoint=(value); end + + # Set Manage GHES API password + # + # @param value [String] Manage GHES API password + # + # source://octokit//lib/octokit/manage_ghes_client.rb#59 + def manage_ghes_password=(value); end + + # Set Manage GHES API username + # + # @param value [String] Manage GHES API username + # + # source://octokit//lib/octokit/manage_ghes_client.rb#51 + def manage_ghes_username=(value); end + + private + + # source://octokit//lib/octokit/manage_ghes_client/manage_ghes.rb#150 + def authenticated_client; end + + # @return [Boolean] + # + # source://octokit//lib/octokit/manage_ghes_client/manage_ghes.rb#141 + def basic_authenticated?; end + + # If no username is provided, we assume root site admin should be used + # + # @return [Boolean] + # + # source://octokit//lib/octokit/manage_ghes_client/manage_ghes.rb#146 + def root_site_admin_assumed?; end +end + +# Methods for the Manage GitHub Enterprise Server API +# +# @see https://developer.github.com/v3/enterprise-admin/manage-ghes +# +# source://octokit//lib/octokit/manage_ghes_client/manage_ghes.rb#9 +module Octokit::ManageGHESClient::ManageAPI + # Configure the maintenance mode of the GHES instance + # + # @param maintenance [Hash] A hash configuration of the maintenance mode status + # @return [nil] + # + # source://octokit//lib/octokit/manage_ghes_client/manage_ghes.rb#23 + def configure_maintenance_mode(enabled, options = T.unsafe(nil)); end + + # Get information about the maintenance status of the GHES instance + # + # @return [nil] + # + # source://octokit//lib/octokit/manage_ghes_client/manage_ghes.rb#13 + def maintenance_mode; end + + # Configure the maintenance mode of the GHES instance + # + # @param maintenance [Hash] A hash configuration of the maintenance mode status + # @return [nil] + # + # source://octokit//lib/octokit/manage_ghes_client/manage_ghes.rb#23 + def set_maintenance_mode(enabled, options = T.unsafe(nil)); end +end + # Raised when GitHub returns a 405 HTTP status code # -# source://octokit//lib/octokit/error.rb#312 +# source://octokit//lib/octokit/error.rb#315 class Octokit::MethodNotAllowed < ::Octokit::ClientError; end # source://octokit//lib/octokit/middleware/follow_redirects.rb#12 @@ -10618,52 +11171,52 @@ end # Raised when client fails to provide valid Content-Type # -# source://octokit//lib/octokit/error.rb#353 +# source://octokit//lib/octokit/error.rb#359 class Octokit::MissingContentType < ::ArgumentError; end # Raised when GitHub returns a 406 HTTP status code # -# source://octokit//lib/octokit/error.rb#315 +# source://octokit//lib/octokit/error.rb#318 class Octokit::NotAcceptable < ::Octokit::ClientError; end # Raised when GitHub returns a 404 HTTP status code # -# source://octokit//lib/octokit/error.rb#305 +# source://octokit//lib/octokit/error.rb#308 class Octokit::NotFound < ::Octokit::ClientError; end # Raised when GitHub returns a 501 HTTP status code # -# source://octokit//lib/octokit/error.rb#344 +# source://octokit//lib/octokit/error.rb#350 class Octokit::NotImplemented < ::Octokit::ServerError; end # Raised when GitHub returns a 401 HTTP status code # and headers include "X-GitHub-OTP" # -# source://octokit//lib/octokit/error.rb#236 +# source://octokit//lib/octokit/error.rb#239 class Octokit::OneTimePasswordRequired < ::Octokit::ClientError # Delivery method for the user's OTP # # @return [String] # - # source://octokit//lib/octokit/error.rb#248 + # source://octokit//lib/octokit/error.rb#251 def password_delivery; end private - # source://octokit//lib/octokit/error.rb#254 + # source://octokit//lib/octokit/error.rb#257 def delivery_method_from_header; end class << self # @private # - # source://octokit//lib/octokit/error.rb#241 + # source://octokit//lib/octokit/error.rb#244 def required_header(headers); end end end # @private # -# source://octokit//lib/octokit/error.rb#238 +# source://octokit//lib/octokit/error.rb#241 Octokit::OneTimePasswordRequired::OTP_DELIVERY_PATTERN = T.let(T.unsafe(nil), Regexp) # GitHub organization class to generate API path urls @@ -10691,10 +11244,10 @@ Octokit::PATCH = T.let(T.unsafe(nil), Integer) # Raised when GitHub returns a 422 HTTP status code and body matches 'Path diff too large'. # It could occur when attempting to post review comments on a "too large" file. # -# source://octokit//lib/octokit/error.rb#332 +# source://octokit//lib/octokit/error.rb#338 class Octokit::PathDiffTooLarge < ::Octokit::UnprocessableEntity; end -# source://octokit//lib/octokit/error.rb#362 +# source://octokit//lib/octokit/error.rb#368 Octokit::RATE_LIMITED_ERRORS = T.let(T.unsafe(nil), Array) # Class for API Rate Limit info @@ -10757,7 +11310,7 @@ class Octokit::Repository # @return [String] Api path for id identified repos # - # source://octokit//lib/octokit/repository.rb#67 + # source://octokit//lib/octokit/repository.rb#68 def id_api_path; end # Returns the value of attribute name. @@ -10774,7 +11327,7 @@ class Octokit::Repository # @return [String] Api path for owner/name identified repos # - # source://octokit//lib/octokit/repository.rb#62 + # source://octokit//lib/octokit/repository.rb#63 def named_api_path; end # Returns the value of attribute owner. @@ -10817,7 +11370,7 @@ class Octokit::Repository # # @return [String] # - # source://octokit//lib/octokit/repository.rb#73 + # source://octokit//lib/octokit/repository.rb#74 def url; end # Returns the value of attribute owner. @@ -10834,10 +11387,10 @@ class Octokit::Repository # @raise [Octokit::InvalidRepository] # - # source://octokit//lib/octokit/repository.rb#89 + # source://octokit//lib/octokit/repository.rb#90 def raise_invalid_repository!(repo); end - # source://octokit//lib/octokit/repository.rb#83 + # source://octokit//lib/octokit/repository.rb#84 def validate_owner_and_name!(repo); end class << self @@ -10853,7 +11406,7 @@ class Octokit::Repository # @param repo [Integer, String, Hash, Repository] A GitHub repository. # @return [String] Api path. # - # source://octokit//lib/octokit/repository.rb#57 + # source://octokit//lib/octokit/repository.rb#58 def path(repo); end end end @@ -10864,7 +11417,7 @@ Octokit::Repository::NAME_WITH_OWNER_PATTERN = T.let(T.unsafe(nil), Regexp) # Raised when GitHub returns a 403 HTTP status code # and body matches 'repository access blocked' # -# source://octokit//lib/octokit/error.rb#282 +# source://octokit//lib/octokit/error.rb#285 class Octokit::RepositoryUnavailable < ::Octokit::Forbidden; end # Faraday response middleware @@ -10897,61 +11450,61 @@ end # Raised when GitHub returns a 403 HTTP status code # and body matches 'Resource protected by organization SAML enforcement' # -# source://octokit//lib/octokit/error.rb#298 +# source://octokit//lib/octokit/error.rb#301 class Octokit::SAMLProtected < ::Octokit::Forbidden; end # Raised on errors in the 500-599 range # -# source://octokit//lib/octokit/error.rb#338 +# source://octokit//lib/octokit/error.rb#344 class Octokit::ServerError < ::Octokit::Error; end # Raised when GitHub returns a 503 HTTP status code # -# source://octokit//lib/octokit/error.rb#350 +# source://octokit//lib/octokit/error.rb#356 class Octokit::ServiceUnavailable < ::Octokit::ServerError; end # Raised when GitHub returns a 403 HTTP status code # and body matches 'returns blobs up to [0-9]+ MB' # -# source://octokit//lib/octokit/error.rb#274 +# source://octokit//lib/octokit/error.rb#277 class Octokit::TooLargeContent < ::Octokit::Forbidden; end # Raised when GitHub returns a 403 HTTP status code # and body matches 'login attempts exceeded' # -# source://octokit//lib/octokit/error.rb#270 +# source://octokit//lib/octokit/error.rb#273 class Octokit::TooManyLoginAttempts < ::Octokit::Forbidden; end # Raised when GitHub returns a 403 HTTP status code # and body matches 'rate limit exceeded' # -# source://octokit//lib/octokit/error.rb#266 +# source://octokit//lib/octokit/error.rb#269 class Octokit::TooManyRequests < ::Octokit::Forbidden; end # Raised when GitHub returns a 401 HTTP status code # -# source://octokit//lib/octokit/error.rb#232 +# source://octokit//lib/octokit/error.rb#235 class Octokit::Unauthorized < ::Octokit::ClientError; end # Raised when GitHub returns a 451 HTTP status code # -# source://octokit//lib/octokit/error.rb#335 +# source://octokit//lib/octokit/error.rb#341 class Octokit::UnavailableForLegalReasons < ::Octokit::ClientError; end # Raised when GitHub returns a 422 HTTP status code # -# source://octokit//lib/octokit/error.rb#324 +# source://octokit//lib/octokit/error.rb#330 class Octokit::UnprocessableEntity < ::Octokit::ClientError; end # Raised when GitHub returns a 414 HTTP status code # -# source://octokit//lib/octokit/error.rb#321 +# source://octokit//lib/octokit/error.rb#327 class Octokit::UnsupportedMediaType < ::Octokit::ClientError; end # Raised when GitHub returns a 403 HTTP status code # and body matches 'email address must be verified' # -# source://octokit//lib/octokit/error.rb#286 +# source://octokit//lib/octokit/error.rb#289 class Octokit::UnverifiedEmail < ::Octokit::Forbidden; end # GitHub user class to generate API path urls diff --git a/sorbet/rbi/gems/oj@3.16.0.rbi b/sorbet/rbi/gems/oj@3.16.4.rbi similarity index 95% rename from sorbet/rbi/gems/oj@3.16.0.rbi rename to sorbet/rbi/gems/oj@3.16.4.rbi index 52127422a..0f99799c1 100644 --- a/sorbet/rbi/gems/oj@3.16.0.rbi +++ b/sorbet/rbi/gems/oj@3.16.4.rbi @@ -421,13 +421,14 @@ end # # hash_end # -# When a hash key is encountered the hash_key method is called with the parsed -# hash value key. The return value from the call is then used as the key in -# the key-value pair that follows. +# At the end of a JSON object element the hash_end() callback is called if +# public. # # hash_key # -# At the end of a JSON object element the hash_end() callback is called if public. +# When a hash key is encountered the hash_key() method is called with the +# parsed hash value key. The return value from the call is then used as the +# key in the key-value pair that follows. # # hash_set # @@ -494,39 +495,39 @@ end # Oj.sc_parse(MyHandler.new, f) # end # -# source://oj//lib/oj/schandler.rb#106 +# source://oj//lib/oj/schandler.rb#107 class Oj::ScHandler # Create a new instance of the ScHandler class. # # @return [ScHandler] a new instance of ScHandler # - # source://oj//lib/oj/schandler.rb#108 + # source://oj//lib/oj/schandler.rb#109 def initialize; end private - # source://oj//lib/oj/schandler.rb#135 + # source://oj//lib/oj/schandler.rb#136 def add_value(value); end - # source://oj//lib/oj/schandler.rb#138 + # source://oj//lib/oj/schandler.rb#139 def array_append(a, value); end - # source://oj//lib/oj/schandler.rb#132 + # source://oj//lib/oj/schandler.rb#133 def array_end; end - # source://oj//lib/oj/schandler.rb#129 + # source://oj//lib/oj/schandler.rb#130 def array_start; end - # source://oj//lib/oj/schandler.rb#119 + # source://oj//lib/oj/schandler.rb#120 def hash_end; end - # source://oj//lib/oj/schandler.rb#122 + # source://oj//lib/oj/schandler.rb#123 def hash_key(key); end - # source://oj//lib/oj/schandler.rb#126 + # source://oj//lib/oj/schandler.rb#127 def hash_set(h, key, value); end - # source://oj//lib/oj/schandler.rb#116 + # source://oj//lib/oj/schandler.rb#117 def hash_start; end end diff --git a/sorbet/rbi/gems/pg@1.5.3.rbi b/sorbet/rbi/gems/pg@1.5.7.rbi similarity index 94% rename from sorbet/rbi/gems/pg@1.5.3.rbi rename to sorbet/rbi/gems/pg@1.5.7.rbi index 0dcdb9ad8..2a74684d8 100644 --- a/sorbet/rbi/gems/pg@1.5.3.rbi +++ b/sorbet/rbi/gems/pg@1.5.7.rbi @@ -26,6 +26,13 @@ module PG # source://pg//lib/pg.rb#67 def make_shareable(obj); end + # Ruby-3.4+ prints a warning, if bigdecimal is required but not in the Gemfile. + # But it's a false positive, since we enable bigdecimal depending features only if it's available. + # And most people don't need these features. + # + # source://pg//lib/pg.rb#132 + def require_bigdecimal_without_warning; end + def threadsafe?; end # Get the PG library version. @@ -205,10 +212,10 @@ end # source://pg//lib/pg/basic_type_map_for_queries.rb#37 class PG::BasicTypeMapForQueries::BinaryData < ::String; end -# source://pg//lib/pg/basic_type_map_for_queries.rb#187 +# source://pg//lib/pg/basic_type_map_for_queries.rb#192 PG::BasicTypeMapForQueries::DEFAULT_ARRAY_TYPE_MAP = T.let(T.unsafe(nil), Hash) -# source://pg//lib/pg/basic_type_map_for_queries.rb#169 +# source://pg//lib/pg/basic_type_map_for_queries.rb#175 PG::BasicTypeMapForQueries::DEFAULT_TYPE_MAP = T.let(T.unsafe(nil), Hash) # source://pg//lib/pg/basic_type_map_for_queries.rb#40 @@ -334,19 +341,19 @@ class PG::BasicTypeRegistry # Alias the +old+ type to the +new+ type. # - # source://pg//lib/pg/basic_type_registry.rb#209 + # source://pg//lib/pg/basic_type_registry.rb#216 def alias_type(format, new, old); end # Retrieve a Hash of all en- or decoders for a given wire format. # The hash key is the name as defined in table +pg_type+. # The hash value is the registered coder object. # - # source://pg//lib/pg/basic_type_registry.rb#181 + # source://pg//lib/pg/basic_type_registry.rb#188 def coders_for(format, direction); end # Populate the registry with all builtin types of ruby-pg # - # source://pg//lib/pg/basic_type_registry.rb#222 + # source://pg//lib/pg/basic_type_registry.rb#229 def define_default_types; end # Register an encoder or decoder instance for casting a PostgreSQL type. @@ -354,12 +361,12 @@ class PG::BasicTypeRegistry # Coder#name must correspond to the +typname+ column in the +pg_type+ table. # Coder#format can be 0 for text format and 1 for binary. # - # source://pg//lib/pg/basic_type_registry.rb#190 + # source://pg//lib/pg/basic_type_registry.rb#197 def register_coder(coder); end # Populate the registry with all builtin types of ruby-pg # - # source://pg//lib/pg/basic_type_registry.rb#222 + # source://pg//lib/pg/basic_type_registry.rb#229 def register_default_types; end # Register the given +encoder_class+ and/or +decoder_class+ for casting a PostgreSQL type. @@ -367,7 +374,7 @@ class PG::BasicTypeRegistry # +name+ must correspond to the +typname+ column in the +pg_type+ table. # +format+ can be 0 for text format and 1 for binary. # - # source://pg//lib/pg/basic_type_registry.rb#202 + # source://pg//lib/pg/basic_type_registry.rb#209 def register_type(format, name, encoder_class, decoder_class); end end @@ -470,7 +477,7 @@ class PG::BasicTypeRegistry::CoderMapsBundle def init_maps(registry, result); end end -# source://pg//lib/pg/basic_type_registry.rb#297 +# source://pg//lib/pg/basic_type_registry.rb#308 PG::BasicTypeRegistry::DEFAULT_TYPE_REGISTRY = T.let(T.unsafe(nil), PG::BasicTypeRegistry) # source://pg//lib/pg.rb#76 @@ -824,7 +831,7 @@ class PG::Connection # Returns +nil+ on success, or a string containing the # error message if a failure occurs. # - # source://pg//lib/pg/connection.rb#582 + # source://pg//lib/pg/connection.rb#595 def async_cancel; end def async_describe_portal(_arg0); end @@ -851,15 +858,12 @@ class PG::Connection # Available since PostgreSQL-10. # See also corresponding {libpq function}[https://www.postgresql.org/docs/current/libpq-misc.html#LIBPQ-PQENCRYPTPASSWORDCONN]. # - # source://pg//lib/pg/connection.rb#555 + # source://pg//lib/pg/connection.rb#563 def async_encrypt_password(password, username, algorithm = T.unsafe(nil)); end - # source://rack-mini-profiler/3.1.1/lib/patches/db/pg.rb#109 - def async_exec(*args, &blk); end - + def async_exec(*_arg0); end def async_exec_params(*_arg0); end def async_exec_prepared(*_arg0); end - def async_exec_without_profiling(*_arg0); end def async_flush; end # call-seq: @@ -879,7 +883,7 @@ class PG::Connection # # See also #copy_data. # - # source://pg//lib/pg/connection.rb#423 + # source://pg//lib/pg/connection.rb#431 def async_get_copy_data(async = T.unsafe(nil), decoder = T.unsafe(nil)); end def async_get_last_result; end @@ -899,7 +903,7 @@ class PG::Connection # and the PG::Result object will automatically be cleared when the block terminates. # In this instance, conn.exec returns the value of the block. # - # source://pg//lib/pg/connection.rb#400 + # source://pg//lib/pg/connection.rb#408 def async_get_result; end # call-seq: @@ -908,7 +912,7 @@ class PG::Connection # Returns the blocking status of the database connection. # Returns +true+ if the connection is set to nonblocking mode and +false+ if blocking. # - # source://pg//lib/pg/connection.rb#471 + # source://pg//lib/pg/connection.rb#479 def async_isnonblocking; end def async_prepare(*_arg0); end @@ -931,7 +935,7 @@ class PG::Connection # # See also #copy_data. # - # source://pg//lib/pg/connection.rb#495 + # source://pg//lib/pg/connection.rb#503 def async_put_copy_data(buffer, encoder = T.unsafe(nil)); end # call-seq: @@ -947,7 +951,7 @@ class PG::Connection # not sent (*false* is only possible if the connection # is in nonblocking mode, and this command would block). # - # source://pg//lib/pg/connection.rb#525 + # source://pg//lib/pg/connection.rb#533 def async_put_copy_end(*args); end def async_query(*_arg0); end @@ -958,7 +962,7 @@ class PG::Connection # Resets the backend connection. This method closes the # backend connection and tries to re-connect. # - # source://pg//lib/pg/connection.rb#567 + # source://pg//lib/pg/connection.rb#575 def async_reset; end def async_set_client_encoding(_arg0); end @@ -979,7 +983,7 @@ class PG::Connection # # Returns +nil+. # - # source://pg//lib/pg/connection.rb#457 + # source://pg//lib/pg/connection.rb#465 def async_setnonblocking(enabled); end def backend_key; end @@ -995,7 +999,7 @@ class PG::Connection # Returns +nil+ on success, or a string containing the # error message if a failure occurs. # - # source://pg//lib/pg/connection.rb#582 + # source://pg//lib/pg/connection.rb#595 def cancel; end # Read all pending socket input to internal memory and raise an exception in case of errors. @@ -1009,7 +1013,7 @@ class PG::Connection # The method doesn't verify that the server is still responding. # To verify that the communication to the server works, it is recommended to use something like conn.exec('') instead. # - # source://pg//lib/pg/connection.rb#379 + # source://pg//lib/pg/connection.rb#387 def check_socket; end def client_encoding=(_arg0); end @@ -1018,13 +1022,13 @@ class PG::Connection # Returns an array of Hashes with connection defaults. See ::conndefaults # for details. # - # source://pg//lib/pg/connection.rb#321 + # source://pg//lib/pg/connection.rb#329 def conndefaults; end # Returns a Hash with connection defaults. See ::conndefaults_hash # for details. # - # source://pg//lib/pg/connection.rb#337 + # source://pg//lib/pg/connection.rb#345 def conndefaults_hash; end def connect_poll; end @@ -1037,58 +1041,12 @@ class PG::Connection # # See also #conninfo # - # source://pg//lib/pg/connection.rb#345 + # source://pg//lib/pg/connection.rb#353 def conninfo_hash; end def consume_input; end - # call-seq: - # conn.copy_data( sql [, coder] ) {|sql_result| ... } -> PG::Result - # - # Execute a copy process for transferring data to or from the server. - # - # This issues the SQL COPY command via #exec. The response to this - # (if there is no error in the command) is a PG::Result object that - # is passed to the block, bearing a status code of PGRES_COPY_OUT or - # PGRES_COPY_IN (depending on the specified copy direction). - # The application should then use #put_copy_data or #get_copy_data - # to receive or transmit data rows and should return from the block - # when finished. - # - # #copy_data returns another PG::Result object when the data transfer - # is complete. An exception is raised if some problem was encountered, - # so it isn't required to make use of any of them. - # At this point further SQL commands can be issued via #exec. - # (It is not possible to execute other SQL commands using the same - # connection while the COPY operation is in progress.) - # - # This method ensures, that the copy process is properly terminated - # in case of client side or server side failures. Therefore, in case - # of blocking mode of operation, #copy_data is preferred to raw calls - # of #put_copy_data, #get_copy_data and #put_copy_end. - # - # _coder_ can be a PG::Coder derivation - # (typically PG::TextEncoder::CopyRow or PG::TextDecoder::CopyRow). - # This enables encoding of data fields given to #put_copy_data - # or decoding of fields received by #get_copy_data. - # - # Example with CSV input format: - # conn.exec "create table my_table (a text,b text,c text,d text)" - # conn.copy_data "COPY my_table FROM STDIN CSV" do - # conn.put_copy_data "some,data,to,copy\n" - # conn.put_copy_data "more,data,to,copy\n" - # end - # This creates +my_table+ and inserts two CSV rows. - # - # The same with text format encoder PG::TextEncoder::CopyRow - # and Array input: - # enco = PG::TextEncoder::CopyRow.new - # conn.copy_data "COPY my_table FROM STDIN", enco do - # conn.put_copy_data ['some', 'data', 'to', 'copy'] - # conn.put_copy_data ['more', 'data', 'to', 'copy'] - # end - # - # Also PG::BinaryEncoder::CopyRow can be used to send data in binary format to the server. + # PG::BinaryEncoder::CopyRow can be used to send data in binary format to the server. # In this case copy_data generates the header and trailer data automatically: # enco = PG::BinaryEncoder::CopyRow.new # conn.copy_data "COPY my_table FROM STDIN (FORMAT binary)", enco do @@ -1132,7 +1090,7 @@ class PG::Connection # # @raise [PG::NotInBlockingMode] # - # source://pg//lib/pg/connection.rb#211 + # source://pg//lib/pg/connection.rb#214 def copy_data(sql, coder = T.unsafe(nil)); end def db; end @@ -1165,7 +1123,7 @@ class PG::Connection # Available since PostgreSQL-10. # See also corresponding {libpq function}[https://www.postgresql.org/docs/current/libpq-misc.html#LIBPQ-PQENCRYPTPASSWORDCONN]. # - # source://pg//lib/pg/connection.rb#555 + # source://pg//lib/pg/connection.rb#563 def encrypt_password(password, username, algorithm = T.unsafe(nil)); end def enter_pipeline_mode; end @@ -1175,20 +1133,9 @@ class PG::Connection def escape_identifier(_arg0); end def escape_literal(_arg0); end def escape_string(_arg0); end - - # source://rack-mini-profiler/3.1.1/lib/patches/db/pg.rb#55 - def exec(*args, &blk); end - - # source://rack-mini-profiler/3.1.1/lib/patches/db/pg.rb#68 - def exec_params(*args, &blk); end - - def exec_params_without_profiling(*_arg0); end - - # source://rack-mini-profiler/3.1.1/lib/patches/db/pg.rb#81 - def exec_prepared(*args, &blk); end - - def exec_prepared_without_profiling(*_arg0); end - def exec_without_profiling(*_arg0); end + def exec(*_arg0); end + def exec_params(*_arg0); end + def exec_prepared(*_arg0); end def exit_pipeline_mode; end def external_encoding; end def field_name_type; end @@ -1215,7 +1162,7 @@ class PG::Connection # # See also #copy_data. # - # source://pg//lib/pg/connection.rb#423 + # source://pg//lib/pg/connection.rb#431 def get_copy_data(async = T.unsafe(nil), decoder = T.unsafe(nil)); end def get_last_result; end @@ -1235,7 +1182,7 @@ class PG::Connection # and the PG::Result object will automatically be cleared when the block terminates. # In this instance, conn.exec returns the value of the block. # - # source://pg//lib/pg/connection.rb#400 + # source://pg//lib/pg/connection.rb#408 def get_result; end def host; end @@ -1256,7 +1203,7 @@ class PG::Connection # Returns the blocking status of the database connection. # Returns +true+ if the connection is set to nonblocking mode and +false+ if blocking. # - # source://pg//lib/pg/connection.rb#471 + # source://pg//lib/pg/connection.rb#479 def isnonblocking; end def lo_close(_arg0); end @@ -1293,7 +1240,7 @@ class PG::Connection # Returns the blocking status of the database connection. # Returns +true+ if the connection is set to nonblocking mode and +false+ if blocking. # - # source://pg//lib/pg/connection.rb#471 + # source://pg//lib/pg/connection.rb#479 def nonblocking?; end def notifies; end @@ -1304,11 +1251,7 @@ class PG::Connection def pipeline_status; end def pipeline_sync; end def port; end - - # source://rack-mini-profiler/3.1.1/lib/patches/db/pg.rb#42 - def prepare(*args, &blk); end - - def prepare_without_profiling(*_arg0); end + def prepare(*_arg0); end def protocol_version; end # call-seq: @@ -1329,7 +1272,7 @@ class PG::Connection # # See also #copy_data. # - # source://pg//lib/pg/connection.rb#495 + # source://pg//lib/pg/connection.rb#503 def put_copy_data(buffer, encoder = T.unsafe(nil)); end # call-seq: @@ -1345,12 +1288,10 @@ class PG::Connection # not sent (*false* is only possible if the connection # is in nonblocking mode, and this command would block). # - # source://pg//lib/pg/connection.rb#525 + # source://pg//lib/pg/connection.rb#533 def put_copy_end(*args); end - # source://rack-mini-profiler/3.1.1/lib/patches/db/pg.rb#55 - def query(*args, &blk); end - + def query(*_arg0); end def quote_ident(_arg0); end # call-seq: @@ -1359,7 +1300,7 @@ class PG::Connection # Resets the backend connection. This method closes the # backend connection and tries to re-connect. # - # source://pg//lib/pg/connection.rb#567 + # source://pg//lib/pg/connection.rb#575 def reset; end def reset_poll; end @@ -1370,11 +1311,7 @@ class PG::Connection def send_prepare(*_arg0); end def send_query(*_arg0); end def send_query_params(*_arg0); end - - # source://rack-mini-profiler/3.1.1/lib/patches/db/pg.rb#95 - def send_query_prepared(*args, &blk); end - - def send_query_prepared_without_profiling(*_arg0); end + def send_query_prepared(*_arg0); end def server_version; end def set_client_encoding(_arg0); end def set_default_encoding; end @@ -1400,7 +1337,7 @@ class PG::Connection # # Returns +nil+. # - # source://pg//lib/pg/connection.rb#457 + # source://pg//lib/pg/connection.rb#465 def setnonblocking(enabled); end def socket; end @@ -1418,7 +1355,7 @@ class PG::Connection # # See also #ssl_attribute # - # source://pg//lib/pg/connection.rb#362 + # source://pg//lib/pg/connection.rb#370 def ssl_attributes; end def ssl_in_use?; end @@ -1450,7 +1387,7 @@ class PG::Connection # and a +COMMIT+ at the end of the block, or # +ROLLBACK+ if any exception occurs. # - # source://pg//lib/pg/connection.rb#305 + # source://pg//lib/pg/connection.rb#308 def transaction; end def transaction_status; end @@ -1466,10 +1403,11 @@ class PG::Connection private - # source://pg//lib/pg/connection.rb#637 + # source://pg//lib/pg/connection.rb#650 def async_connect_or_reset(poll_meth); end def flush_data=(_arg0); end + def reset_start2(_arg0); end class << self # Switch between sync and async libpq API. @@ -1488,7 +1426,7 @@ class PG::Connection # Do not use this method in production code. # Any issues with the default setting of async_api=true should be reported to the maintainers instead. # - # source://pg//lib/pg/connection.rb#937 + # source://pg//lib/pg/connection.rb#954 def async_api=(enable); end # call-seq: @@ -1543,7 +1481,7 @@ class PG::Connection # # Raises a PG::Error if the connection fails. # - # source://pg//lib/pg/connection.rb#758 + # source://pg//lib/pg/connection.rb#771 def async_connect(*args); end # call-seq: @@ -1570,10 +1508,10 @@ class PG::Connection # # See also check_socket for a way to check the connection without doing any server communication. # - # source://pg//lib/pg/connection.rb#858 + # source://pg//lib/pg/connection.rb#875 def async_ping(*args); end - # source://pg//lib/pg/connection.rb#914 + # source://pg//lib/pg/connection.rb#931 def async_send_api=(enable); end def conndefaults; end @@ -1583,7 +1521,7 @@ class PG::Connection # # See also #conndefaults # - # source://pg//lib/pg/connection.rb#329 + # source://pg//lib/pg/connection.rb#337 def conndefaults_hash; end # call-seq: @@ -1638,7 +1576,7 @@ class PG::Connection # # Raises a PG::Error if the connection fails. # - # source://pg//lib/pg/connection.rb#758 + # source://pg//lib/pg/connection.rb#771 def connect(*args); end # Convert Hash options to connection String @@ -1708,7 +1646,7 @@ class PG::Connection # # Raises a PG::Error if the connection fails. # - # source://pg//lib/pg/connection.rb#758 + # source://pg//lib/pg/connection.rb#771 def new(*args); end # call-seq: @@ -1763,7 +1701,7 @@ class PG::Connection # # Raises a PG::Error if the connection fails. # - # source://pg//lib/pg/connection.rb#758 + # source://pg//lib/pg/connection.rb#771 def open(*args); end # Parse the connection +args+ into a connection-parameter string. @@ -1806,7 +1744,7 @@ class PG::Connection # # See also check_socket for a way to check the connection without doing any server communication. # - # source://pg//lib/pg/connection.rb#858 + # source://pg//lib/pg/connection.rb#875 def ping(*args); end # Quote a single +value+ for use in a connection-parameter string. @@ -1868,7 +1806,7 @@ class PG::Connection # # Raises a PG::Error if the connection fails. # - # source://pg//lib/pg/connection.rb#758 + # source://pg//lib/pg/connection.rb#771 def setdb(*args); end # call-seq: @@ -1923,7 +1861,7 @@ class PG::Connection # # Raises a PG::Error if the connection fails. # - # source://pg//lib/pg/connection.rb#758 + # source://pg//lib/pg/connection.rb#771 def setdblogin(*args); end def sync_connect(*_arg0); end @@ -1932,11 +1870,14 @@ class PG::Connection private - # source://pg//lib/pg/connection.rb#776 + # source://pg//lib/pg/connection.rb#823 def connect_to_hosts(*args); end - # source://pg//lib/pg/connection.rb#828 + # source://pg//lib/pg/connection.rb#845 def host_is_named_pipe?(host_string); end + + # source://pg//lib/pg/connection.rb#792 + def resolve_hosts(iopts); end end end @@ -2281,12 +2222,8 @@ class PG::Result def cmd_tuples; end def cmdtuples; end def column_values(_arg0); end - - # source://rack-mini-profiler/3.1.1/lib/patches/db/pg.rb#15 - def each(*args, &blk); end - + def each; end def each_row; end - def each_without_profiling; end def error_field(_arg0); end def error_message; end def fformat(_arg0); end @@ -2332,9 +2269,6 @@ class PG::Result # source://pg//lib/pg/result.rb#16 def map_types!(type_map); end - # source://rack-mini-profiler/3.1.1/lib/patches/db/pg.rb#22 - def mp_report_sql(&block); end - def nfields; end def nparams; end def ntuples; end @@ -2354,11 +2288,7 @@ class PG::Result def tuple_values(_arg0); end def type_map; end def type_map=(_arg0); end - - # source://rack-mini-profiler/3.1.1/lib/patches/db/pg.rb#8 - def values(*args, &blk); end - - def values_without_profiling; end + def values; end def verbose_error_message(_arg0, _arg1); end class << self @@ -2366,6 +2296,13 @@ class PG::Result end end +# PG::Connection#transaction uses this exception to distinguish a deliberate rollback from other exceptional situations. +# Normally, raising an exception will cause the .transaction method to rollback the database transaction and pass on the exception. +# But if you raise an PG::RollbackTransaction exception, then the database transaction will be rolled back, without passing on the exception. +# +# source://pg//lib/pg/exceptions.rb#27 +class PG::RollbackTransaction < ::StandardError; end + class PG::SEInvalidSpecification < ::PG::SavepointException; end class PG::SREFunctionExecutedNoReturnStatement < ::PG::SqlRoutineException; end class PG::SREModifyingSqlDataNotPermitted < ::PG::SqlRoutineException; end diff --git a/sorbet/rbi/gems/public_suffix@5.0.3.rbi b/sorbet/rbi/gems/public_suffix@6.0.1.rbi similarity index 100% rename from sorbet/rbi/gems/public_suffix@5.0.3.rbi rename to sorbet/rbi/gems/public_suffix@6.0.1.rbi diff --git a/sorbet/rbi/gems/pundit@2.3.1.rbi b/sorbet/rbi/gems/pundit@2.3.2.rbi similarity index 59% rename from sorbet/rbi/gems/pundit@2.3.1.rbi rename to sorbet/rbi/gems/pundit@2.3.2.rbi index 07a05e555..816114d5a 100644 --- a/sorbet/rbi/gems/pundit@2.3.1.rbi +++ b/sorbet/rbi/gems/pundit@2.3.2.rbi @@ -12,84 +12,41 @@ module Pundit include ::Pundit::Authorization class << self - # Retrieves the policy for the given record, initializing it with the - # record and user and finally throwing an error if the user is not - # authorized to perform the given action. - # # @api public - # @param user [Object] the user that initiated the action - # @param possibly_namespaced_record [Object, Array] the object we're checking permissions of - # @param query [Symbol, String] the predicate method to check on the policy (e.g. `:show?`) - # @param policy_class [Class] the policy class we want to force use of - # @param cache [#[], #[]=] a Hash-like object to cache the found policy instance in - # @raise [NotAuthorizedError] if the given query method returned false - # @return [Object] Always returns the passed object record + # @see [Pundit::Context#authorize] # - # source://pundit//lib/pundit.rb#78 - def authorize(user, possibly_namespaced_record, query, policy_class: T.unsafe(nil), cache: T.unsafe(nil)); end + # source://pundit//lib/pundit.rb#71 + def authorize(user, record, query, policy_class: T.unsafe(nil), cache: T.unsafe(nil)); end # @api public # @private # - # source://pundit//lib/pundit.rb#57 + # source://pundit//lib/pundit.rb#60 def included(base); end - # Retrieves the policy for the given record. - # # @api public - # @param user [Object] the user that initiated the action - # @param record [Object] the object we're retrieving the policy for - # @raise [InvalidConstructorError] if the policy constructor called incorrectly - # @return [Object, nil] instance of policy class with query methods - # @see https://github.com/varvet/pundit#policies + # @see [Pundit::Context#policy] # - # source://pundit//lib/pundit.rb#139 - def policy(user, record); end + # source://pundit//lib/pundit.rb#92 + def policy(user, *args, **kwargs, &block); end - # Retrieves the policy for the given record. - # # @api public - # @param user [Object] the user that initiated the action - # @param record [Object] the object we're retrieving the policy for - # @raise [NotDefinedError] if the policy cannot be found - # @raise [InvalidConstructorError] if the policy constructor called incorrectly - # @return [Object] instance of policy class with query methods - # @see https://github.com/varvet/pundit#policies + # @see [Pundit::Context#policy!] # - # source://pundit//lib/pundit.rb#154 - def policy!(user, record); end + # source://pundit//lib/pundit.rb#97 + def policy!(user, *args, **kwargs, &block); end - # Retrieves the policy scope for the given record. - # # @api public - # @param user [Object] the user that initiated the action - # @param scope [Object] the object we're retrieving the policy scope for - # @raise [InvalidConstructorError] if the policy constructor called incorrectly - # @return [Scope{#resolve}, nil] instance of scope class which can resolve to a scope - # @see https://github.com/varvet/pundit#scopes + # @see [Pundit::Context#policy_scope] # - # source://pundit//lib/pundit.rb#98 - def policy_scope(user, scope); end + # source://pundit//lib/pundit.rb#82 + def policy_scope(user, *args, **kwargs, &block); end - # Retrieves the policy scope for the given record. - # # @api public - # @param user [Object] the user that initiated the action - # @param scope [Object] the object we're retrieving the policy scope for - # @raise [NotDefinedError] if the policy scope cannot be found - # @raise [InvalidConstructorError] if the policy constructor called incorrectly - # @return [Scope{#resolve}] instance of scope class which can resolve to a scope - # @see https://github.com/varvet/pundit#scopes + # @see [Pundit::Context#policy_scope!] # - # source://pundit//lib/pundit.rb#119 - def policy_scope!(user, scope); end - - private - - # @api public - # - # source://pundit//lib/pundit.rb#163 - def pundit_model(record); end + # source://pundit//lib/pundit.rb#87 + def policy_scope!(user, *args, **kwargs, &block); end end end @@ -110,7 +67,7 @@ module Pundit::Authorization # @raise [NotAuthorizedError] if the given query method returned false # @return [Object] Always returns the passed object record # - # source://pundit//lib/pundit/authorization.rb#62 + # source://pundit//lib/pundit/authorization.rb#70 def authorize(record, query = T.unsafe(nil), policy_class: T.unsafe(nil)); end # Retrieves a set of permitted attributes from the policy by instantiating @@ -125,7 +82,7 @@ module Pundit::Authorization # @return [Hash{String => Object}] the permitted attributes # @see https://github.com/varvet/pundit#strong-parameters # - # source://pundit//lib/pundit/authorization.rb#117 + # source://pundit//lib/pundit/authorization.rb#125 def permitted_attributes(record, action = T.unsafe(nil)); end # Cache of policies. You should not rely on this method. @@ -133,16 +90,16 @@ module Pundit::Authorization # # @api private # - # source://pundit//lib/pundit/authorization.rb#139 + # source://pundit//lib/pundit/authorization.rb#147 def policies; end # Retrieves the policy for the given record. # # @param record [Object] the object we're retrieving the policy for - # @return [Object, nil] instance of policy class with query methods + # @return [Object] instance of policy class with query methods # @see https://github.com/varvet/pundit#policies # - # source://pundit//lib/pundit/authorization.rb#102 + # source://pundit//lib/pundit/authorization.rb#110 def policy(record); end # Retrieves the policy scope for the given record. @@ -152,7 +109,7 @@ module Pundit::Authorization # @return [Scope{#resolve}, nil] instance of scope class which can resolve to a scope # @see https://github.com/varvet/pundit#scopes # - # source://pundit//lib/pundit/authorization.rb#92 + # source://pundit//lib/pundit/authorization.rb#100 def policy_scope(scope, policy_scope_class: T.unsafe(nil)); end # Cache of policy scope. You should not rely on this method. @@ -160,27 +117,32 @@ module Pundit::Authorization # # @api private # - # source://pundit//lib/pundit/authorization.rb#148 + # source://pundit//lib/pundit/authorization.rb#156 def policy_scopes; end + # @return [Pundit::Context] a new instance of {Pundit::Context} with the current user + # + # source://pundit//lib/pundit/authorization.rb#19 + def pundit; end + # Retrieves the params for the given record. # # @param record [Object] the object we're retrieving params for # @return [ActionController::Parameters] the params # - # source://pundit//lib/pundit/authorization.rb#131 + # source://pundit//lib/pundit/authorization.rb#139 def pundit_params_for(record); end # @return [Boolean] whether authorization has been performed, i.e. whether # one {#authorize} or {#skip_authorization} has been called # - # source://pundit//lib/pundit/authorization.rb#20 + # source://pundit//lib/pundit/authorization.rb#28 def pundit_policy_authorized?; end # @return [Boolean] whether policy scoping has been performed, i.e. whether # one {#policy_scope} or {#skip_policy_scope} has been called # - # source://pundit//lib/pundit/authorization.rb#26 + # source://pundit//lib/pundit/authorization.rb#34 def pundit_policy_scoped?; end # Hook method which allows customizing which user is passed to policies and @@ -189,7 +151,7 @@ module Pundit::Authorization # @return [Object] the user object to be used with pundit # @see https://github.com/varvet/pundit#customize-pundit-user # - # source://pundit//lib/pundit/authorization.rb#158 + # source://pundit//lib/pundit/authorization.rb#166 def pundit_user; end # Allow this action not to perform authorization. @@ -197,7 +159,7 @@ module Pundit::Authorization # @return [void] # @see https://github.com/varvet/pundit#ensuring-policies-and-scopes-are-used # - # source://pundit//lib/pundit/authorization.rb#74 + # source://pundit//lib/pundit/authorization.rb#82 def skip_authorization; end # Allow this action not to perform policy scoping. @@ -205,7 +167,7 @@ module Pundit::Authorization # @return [void] # @see https://github.com/varvet/pundit#ensuring-policies-and-scopes-are-used # - # source://pundit//lib/pundit/authorization.rb#82 + # source://pundit//lib/pundit/authorization.rb#90 def skip_policy_scope; end # Raises an error if authorization has not been performed, usually used as an @@ -216,7 +178,7 @@ module Pundit::Authorization # @return [void] # @see https://github.com/varvet/pundit#ensuring-policies-and-scopes-are-used # - # source://pundit//lib/pundit/authorization.rb#37 + # source://pundit//lib/pundit/authorization.rb#45 def verify_authorized; end # Raises an error if policy scoping has not been performed, usually used as an @@ -227,12 +189,12 @@ module Pundit::Authorization # @return [void] # @see https://github.com/varvet/pundit#ensuring-policies-and-scopes-are-used # - # source://pundit//lib/pundit/authorization.rb#48 + # source://pundit//lib/pundit/authorization.rb#56 def verify_policy_scoped; end private - # source://pundit//lib/pundit/authorization.rb#164 + # source://pundit//lib/pundit/authorization.rb#172 def pundit_policy_scope(scope); end end @@ -241,29 +203,154 @@ end # # @api public # -# source://pundit//lib/pundit.rb#48 +# source://pundit//lib/pundit.rb#51 class Pundit::AuthorizationNotPerformedError < ::Pundit::Error; end +# source://pundit//lib/pundit/cache_store/null_store.rb#4 +module Pundit::CacheStore; end + +# @api private +# +# source://pundit//lib/pundit/cache_store/legacy_store.rb#6 +class Pundit::CacheStore::LegacyStore + # @api private + # @return [LegacyStore] a new instance of LegacyStore + # + # source://pundit//lib/pundit/cache_store/legacy_store.rb#7 + def initialize(hash = T.unsafe(nil)); end + + # @api private + # + # source://pundit//lib/pundit/cache_store/legacy_store.rb#11 + def fetch(user:, record:); end +end + +# @api private +# +# source://pundit//lib/pundit/cache_store/null_store.rb#6 +class Pundit::CacheStore::NullStore + # @api private + # + # source://pundit//lib/pundit/cache_store/null_store.rb#13 + def fetch(*_arg0, **_arg1); end + + class << self + # @api private + # + # source://pundit//lib/pundit/cache_store/null_store.rb#10 + def instance; end + end +end + +# source://pundit//lib/pundit/context.rb#4 +class Pundit::Context + # @return [Context] a new instance of Context + # + # source://pundit//lib/pundit/context.rb#5 + def initialize(user:, policy_cache: T.unsafe(nil)); end + + # Retrieves the policy for the given record, initializing it with the + # record and user and finally throwing an error if the user is not + # authorized to perform the given action. + # + # @param user [Object] the user that initiated the action + # @param possibly_namespaced_record [Object, Array] the object we're checking permissions of + # @param query [Symbol, String] the predicate method to check on the policy (e.g. `:show?`) + # @param policy_class [Class] the policy class we want to force use of + # @raise [NotAuthorizedError] if the given query method returned false + # @return [Object] Always returns the passed object record + # + # source://pundit//lib/pundit/context.rb#25 + def authorize(possibly_namespaced_record, query:, policy_class:); end + + # Retrieves the policy for the given record. + # + # @param user [Object] the user that initiated the action + # @param record [Object] the object we're retrieving the policy for + # @raise [InvalidConstructorError] if the policy constructor called incorrectly + # @return [Object, nil] instance of policy class with query methods + # @see https://github.com/varvet/pundit#policies + # + # source://pundit//lib/pundit/context.rb#86 + def policy(record); end + + # Retrieves the policy for the given record. Raises if not found. + # + # @param user [Object] the user that initiated the action + # @param record [Object] the object we're retrieving the policy for + # @raise [NotDefinedError] if the policy cannot be found + # @raise [InvalidConstructorError] if the policy constructor called incorrectly + # @return [Object] instance of policy class with query methods + # @see https://github.com/varvet/pundit#policies + # + # source://pundit//lib/pundit/context.rb#98 + def policy!(record); end + + # @api private + # + # source://pundit//lib/pundit/context.rb#13 + def policy_cache; end + + # Retrieves the policy scope for the given record. + # + # @param user [Object] the user that initiated the action + # @param scope [Object] the object we're retrieving the policy scope for + # @raise [InvalidConstructorError] if the policy constructor called incorrectly + # @return [Scope{#resolve}, nil] instance of scope class which can resolve to a scope + # @see https://github.com/varvet/pundit#scopes + # + # source://pundit//lib/pundit/context.rb#45 + def policy_scope(scope); end + + # Retrieves the policy scope for the given record. Raises if not found. + # + # @param user [Object] the user that initiated the action + # @param scope [Object] the object we're retrieving the policy scope for + # @raise [NotDefinedError] if the policy scope cannot be found + # @raise [InvalidConstructorError] if the policy constructor called incorrectly + # @return [Scope{#resolve}] instance of scope class which can resolve to a scope + # @see https://github.com/varvet/pundit#scopes + # + # source://pundit//lib/pundit/context.rb#66 + def policy_scope!(scope); end + + # Returns the value of attribute user. + # + # source://pundit//lib/pundit/context.rb#10 + def user; end + + private + + # source://pundit//lib/pundit/context.rb#104 + def cached_find(record); end + + # source://pundit//lib/pundit/context.rb#119 + def policy_finder(record); end + + # source://pundit//lib/pundit/context.rb#123 + def pundit_model(record); end +end + # To avoid name clashes with common Error naming when mixing in Pundit, # keep it here with compact class style definition. # # @api private # -# source://pundit//lib/pundit.rb#15 +# source://pundit//lib/pundit.rb#18 class Pundit::Error < ::StandardError; end # @api private # -# source://pundit//lib/pundit.rb#22 +# source://pundit//lib/pundit.rb#25 module Pundit::Generators; end # @api private # -# source://pundit//lib/pundit.rb#169 +# source://pundit//lib/pundit.rb#103 module Pundit::Helper # @api private # - # source://pundit//lib/pundit.rb#170 + # source://pundit//lib/pundit.rb#104 def policy_scope(scope); end end @@ -271,34 +358,34 @@ end # # @api public # -# source://pundit//lib/pundit.rb#44 +# source://pundit//lib/pundit.rb#47 class Pundit::InvalidConstructorError < ::Pundit::Error; end # Error that will be raised when authorization has failed # # @api public # -# source://pundit//lib/pundit.rb#25 +# source://pundit//lib/pundit.rb#28 class Pundit::NotAuthorizedError < ::Pundit::Error # @api public # @return [NotAuthorizedError] a new instance of NotAuthorizedError # - # source://pundit//lib/pundit.rb#28 + # source://pundit//lib/pundit.rb#31 def initialize(options = T.unsafe(nil)); end # @api public # - # source://pundit//lib/pundit.rb#26 + # source://pundit//lib/pundit.rb#29 def policy; end # @api public # - # source://pundit//lib/pundit.rb#26 + # source://pundit//lib/pundit.rb#29 def query; end # @api public # - # source://pundit//lib/pundit.rb#26 + # source://pundit//lib/pundit.rb#29 def record; end end @@ -306,7 +393,7 @@ end # # @api public # -# source://pundit//lib/pundit.rb#55 +# source://pundit//lib/pundit.rb#58 class Pundit::NotDefinedError < ::Pundit::Error; end # Finds policy and scope classes for given object. @@ -391,12 +478,12 @@ end # # @api public # -# source://pundit//lib/pundit.rb#52 +# source://pundit//lib/pundit.rb#55 class Pundit::PolicyScopingNotPerformedError < ::Pundit::AuthorizationNotPerformedError; end # @api public # -# source://pundit//lib/pundit.rb#19 +# source://pundit//lib/pundit.rb#22 Pundit::SUFFIX = T.let(T.unsafe(nil), String) # source://pundit//lib/pundit/version.rb#4 diff --git a/sorbet/rbi/gems/rack-mini-profiler@3.1.1.rbi b/sorbet/rbi/gems/rack-mini-profiler@3.3.1.rbi similarity index 78% rename from sorbet/rbi/gems/rack-mini-profiler@3.1.1.rbi rename to sorbet/rbi/gems/rack-mini-profiler@3.3.1.rbi index e869edfac..a30783fbd 100644 --- a/sorbet/rbi/gems/rack-mini-profiler@3.1.1.rbi +++ b/sorbet/rbi/gems/rack-mini-profiler@3.3.1.rbi @@ -5,445 +5,6 @@ # Please instead update this file by running `bin/tapioca gem rack-mini-profiler`. -# source://rack-mini-profiler//lib/patches/db/pg.rb#31 -class PG::Connection - include ::PG::Constants - - # source://pg/1.5.3/lib/pg/connection.rb#582 - def async_cancel; end - - def async_describe_portal(_arg0); end - def async_describe_prepared(_arg0); end - - # source://pg/1.5.3/lib/pg/connection.rb#555 - def async_encrypt_password(password, username, algorithm = T.unsafe(nil)); end - - # source://rack-mini-profiler//lib/patches/db/pg.rb#109 - def async_exec(*args, &blk); end - - def async_exec_params(*_arg0); end - def async_exec_prepared(*_arg0); end - def async_exec_without_profiling(*_arg0); end - def async_flush; end - - # source://pg/1.5.3/lib/pg/connection.rb#423 - def async_get_copy_data(async = T.unsafe(nil), decoder = T.unsafe(nil)); end - - def async_get_last_result; end - - # source://pg/1.5.3/lib/pg/connection.rb#400 - def async_get_result; end - - # source://pg/1.5.3/lib/pg/connection.rb#471 - def async_isnonblocking; end - - def async_prepare(*_arg0); end - - # source://pg/1.5.3/lib/pg/connection.rb#495 - def async_put_copy_data(buffer, encoder = T.unsafe(nil)); end - - # source://pg/1.5.3/lib/pg/connection.rb#525 - def async_put_copy_end(*args); end - - def async_query(*_arg0); end - - # source://pg/1.5.3/lib/pg/connection.rb#567 - def async_reset; end - - def async_set_client_encoding(_arg0); end - - # source://pg/1.5.3/lib/pg/connection.rb#457 - def async_setnonblocking(enabled); end - - def backend_key; end - def backend_pid; end - def block(*_arg0); end - - # source://pg/1.5.3/lib/pg/connection.rb#582 - def cancel; end - - # source://pg/1.5.3/lib/pg/connection.rb#379 - def check_socket; end - - def client_encoding=(_arg0); end - def close; end - - # source://pg/1.5.3/lib/pg/connection.rb#321 - def conndefaults; end - - # source://pg/1.5.3/lib/pg/connection.rb#337 - def conndefaults_hash; end - - def connect_poll; end - def connection_needs_password; end - def connection_used_password; end - def conninfo; end - - # source://pg/1.5.3/lib/pg/connection.rb#345 - def conninfo_hash; end - - def consume_input; end - - # source://pg/1.5.3/lib/pg/connection.rb#211 - def copy_data(sql, coder = T.unsafe(nil)); end - - def db; end - def decoder_for_get_copy_data; end - def decoder_for_get_copy_data=(_arg0); end - def describe_portal(_arg0); end - def describe_prepared(_arg0); end - def discard_results; end - def encoder_for_put_copy_data; end - def encoder_for_put_copy_data=(_arg0); end - - # source://pg/1.5.3/lib/pg/connection.rb#555 - def encrypt_password(password, username, algorithm = T.unsafe(nil)); end - - def enter_pipeline_mode; end - def error_message; end - def escape(_arg0); end - def escape_bytea(_arg0); end - def escape_identifier(_arg0); end - def escape_literal(_arg0); end - def escape_string(_arg0); end - - # source://rack-mini-profiler//lib/patches/db/pg.rb#55 - def exec(*args, &blk); end - - # source://rack-mini-profiler//lib/patches/db/pg.rb#68 - def exec_params(*args, &blk); end - - def exec_params_without_profiling(*_arg0); end - - # source://rack-mini-profiler//lib/patches/db/pg.rb#81 - def exec_prepared(*args, &blk); end - - def exec_prepared_without_profiling(*_arg0); end - def exec_without_profiling(*_arg0); end - def exit_pipeline_mode; end - def external_encoding; end - def field_name_type; end - def field_name_type=(_arg0); end - def finish; end - def finished?; end - def flush; end - def get_client_encoding; end - - # source://pg/1.5.3/lib/pg/connection.rb#423 - def get_copy_data(async = T.unsafe(nil), decoder = T.unsafe(nil)); end - - def get_last_result; end - - # source://pg/1.5.3/lib/pg/connection.rb#400 - def get_result; end - - def host; end - def hostaddr; end - - # source://pg/1.5.3/lib/pg/connection.rb#100 - def inspect; end - - def internal_encoding; end - def internal_encoding=(_arg0); end - def is_busy; end - - # source://pg/1.5.3/lib/pg/connection.rb#471 - def isnonblocking; end - - def lo_close(_arg0); end - def lo_creat(*_arg0); end - def lo_create(_arg0); end - def lo_export(_arg0, _arg1); end - def lo_import(_arg0); end - def lo_lseek(_arg0, _arg1, _arg2); end - def lo_open(*_arg0); end - def lo_read(_arg0, _arg1); end - def lo_seek(_arg0, _arg1, _arg2); end - def lo_tell(_arg0); end - def lo_truncate(_arg0, _arg1); end - def lo_unlink(_arg0); end - def lo_write(_arg0, _arg1); end - def loclose(_arg0); end - def locreat(*_arg0); end - def locreate(_arg0); end - def loexport(_arg0, _arg1); end - def loimport(_arg0); end - def lolseek(_arg0, _arg1, _arg2); end - def loopen(*_arg0); end - def loread(_arg0, _arg1); end - def loseek(_arg0, _arg1, _arg2); end - def lotell(_arg0); end - def lotruncate(_arg0, _arg1); end - def lounlink(_arg0); end - def lowrite(_arg0, _arg1); end - def make_empty_pgresult(_arg0); end - - # source://pg/1.5.3/lib/pg/connection.rb#471 - def nonblocking?; end - - def notifies; end - def notifies_wait(*_arg0); end - def options; end - def parameter_status(_arg0); end - def pass; end - def pipeline_status; end - def pipeline_sync; end - def port; end - - # source://rack-mini-profiler//lib/patches/db/pg.rb#42 - def prepare(*args, &blk); end - - def prepare_without_profiling(*_arg0); end - def protocol_version; end - - # source://pg/1.5.3/lib/pg/connection.rb#495 - def put_copy_data(buffer, encoder = T.unsafe(nil)); end - - # source://pg/1.5.3/lib/pg/connection.rb#525 - def put_copy_end(*args); end - - # source://rack-mini-profiler//lib/patches/db/pg.rb#55 - def query(*args, &blk); end - - def quote_ident(_arg0); end - - # source://pg/1.5.3/lib/pg/connection.rb#567 - def reset; end - - def reset_poll; end - def reset_start; end - def send_describe_portal(_arg0); end - def send_describe_prepared(_arg0); end - def send_flush_request; end - def send_prepare(*_arg0); end - def send_query(*_arg0); end - def send_query_params(*_arg0); end - - # source://rack-mini-profiler//lib/patches/db/pg.rb#95 - def send_query_prepared(*args, &blk); end - - def send_query_prepared_without_profiling(*_arg0); end - def server_version; end - def set_client_encoding(_arg0); end - def set_default_encoding; end - def set_error_context_visibility(_arg0); end - def set_error_verbosity(_arg0); end - def set_notice_processor; end - def set_notice_receiver; end - def set_single_row_mode; end - - # source://pg/1.5.3/lib/pg/connection.rb#457 - def setnonblocking(enabled); end - - def socket; end - def socket_io; end - def ssl_attribute(_arg0); end - def ssl_attribute_names; end - - # source://pg/1.5.3/lib/pg/connection.rb#362 - def ssl_attributes; end - - def ssl_in_use?; end - def status; end - def sync_cancel; end - def sync_describe_portal(_arg0); end - def sync_describe_prepared(_arg0); end - def sync_encrypt_password(*_arg0); end - def sync_exec(*_arg0); end - def sync_exec_params(*_arg0); end - def sync_exec_prepared(*_arg0); end - def sync_flush; end - def sync_get_copy_data(*_arg0); end - def sync_get_last_result; end - def sync_get_result; end - def sync_isnonblocking; end - def sync_prepare(*_arg0); end - def sync_put_copy_data(*_arg0); end - def sync_put_copy_end(*_arg0); end - def sync_reset; end - def sync_set_client_encoding(_arg0); end - def sync_setnonblocking(_arg0); end - def trace(_arg0); end - - # source://pg/1.5.3/lib/pg/connection.rb#305 - def transaction; end - - def transaction_status; end - def tty; end - def type_map_for_queries; end - def type_map_for_queries=(_arg0); end - def type_map_for_results; end - def type_map_for_results=(_arg0); end - def unescape_bytea(_arg0); end - def untrace; end - def user; end - def wait_for_notify(*_arg0); end - - private - - # source://pg/1.5.3/lib/pg/connection.rb#637 - def async_connect_or_reset(poll_meth); end - - def flush_data=(_arg0); end - - class << self - # source://pg/1.5.3/lib/pg/connection.rb#937 - def async_api=(enable); end - - # source://pg/1.5.3/lib/pg/connection.rb#758 - def async_connect(*args); end - - # source://pg/1.5.3/lib/pg/connection.rb#858 - def async_ping(*args); end - - # source://pg/1.5.3/lib/pg/connection.rb#914 - def async_send_api=(enable); end - - def conndefaults; end - - # source://pg/1.5.3/lib/pg/connection.rb#329 - def conndefaults_hash; end - - # source://pg/1.5.3/lib/pg/connection.rb#758 - def connect(*args); end - - # source://pg/1.5.3/lib/pg/connection.rb#44 - def connect_hash_to_string(hash); end - - def connect_start(*_arg0); end - def conninfo_parse(_arg0); end - def encrypt_password(_arg0, _arg1); end - def escape(_arg0); end - def escape_bytea(_arg0); end - def escape_string(_arg0); end - def isthreadsafe; end - - # source://pg/1.5.3/lib/pg/connection.rb#758 - def new(*args); end - - # source://pg/1.5.3/lib/pg/connection.rb#758 - def open(*args); end - - # source://pg/1.5.3/lib/pg/connection.rb#64 - def parse_connect_args(*args); end - - # source://pg/1.5.3/lib/pg/connection.rb#858 - def ping(*args); end - - # source://pg/1.5.3/lib/pg/connection.rb#37 - def quote_connstr(value); end - - def quote_ident(_arg0); end - - # source://pg/1.5.3/lib/pg/connection.rb#758 - def setdb(*args); end - - # source://pg/1.5.3/lib/pg/connection.rb#758 - def setdblogin(*args); end - - def sync_connect(*_arg0); end - def sync_ping(*_arg0); end - def unescape_bytea(_arg0); end - - private - - # source://pg/1.5.3/lib/pg/connection.rb#776 - def connect_to_hosts(*args); end - - # source://pg/1.5.3/lib/pg/connection.rb#828 - def host_is_named_pipe?(host_string); end - end -end - -module PG::Constants; end - -# PG patches, keep in mind exec and async_exec have a exec{|r| } semantics that is yet to be implemented -# -# source://rack-mini-profiler//lib/patches/db/pg.rb#4 -class PG::Result - include ::Enumerable - include ::PG::Constants - - def [](_arg0); end - def autoclear?; end - def binary_tuples; end - def check; end - def check_result; end - def clear; end - def cleared?; end - def cmd_status; end - def cmd_tuples; end - def cmdtuples; end - def column_values(_arg0); end - - # source://rack-mini-profiler//lib/patches/db/pg.rb#15 - def each(*args, &blk); end - - def each_row; end - def each_without_profiling; end - def error_field(_arg0); end - def error_message; end - def fformat(_arg0); end - def field_name_type; end - def field_name_type=(_arg0); end - - # source://pg/1.5.3/lib/pg/result.rb#26 - def field_names_as(type); end - - def field_values(_arg0); end - def fields; end - def fmod(_arg0); end - def fname(_arg0); end - def fnumber(_arg0); end - def freeze; end - def fsize(_arg0); end - def ftable(_arg0); end - def ftablecol(_arg0); end - def ftype(_arg0); end - def getisnull(_arg0, _arg1); end - def getlength(_arg0, _arg1); end - def getvalue(_arg0, _arg1); end - - # source://pg/1.5.3/lib/pg/result.rb#32 - def inspect; end - - # source://pg/1.5.3/lib/pg/result.rb#16 - def map_types!(type_map); end - - # source://rack-mini-profiler//lib/patches/db/pg.rb#22 - def mp_report_sql(&block); end - - def nfields; end - def nparams; end - def ntuples; end - def num_fields; end - def num_tuples; end - def oid_value; end - def paramtype(_arg0); end - def res_status(*_arg0); end - def result_error_field(_arg0); end - def result_error_message; end - def result_status; end - def result_verbose_error_message(_arg0, _arg1); end - def stream_each; end - def stream_each_row; end - def stream_each_tuple; end - def tuple(_arg0); end - def tuple_values(_arg0); end - def type_map; end - def type_map=(_arg0); end - - # source://rack-mini-profiler//lib/patches/db/pg.rb#8 - def values(*args, &blk); end - - def values_without_profiling; end - def verbose_error_message(_arg0, _arg1); end - - class << self - def res_status(_arg0); end - end -end - # based off https://github.com/newrelic/rpm/blob/master/lib/new_relic/agent/instrumentation/active_record.rb # fallback for alls sorts of weird dbs # @@ -460,6 +21,8 @@ end # source://rack-mini-profiler//lib/mini_profiler/version.rb#4 class Rack::MiniProfiler + include ::Rack::MiniProfiler::Actions + include ::Rack::MiniProfiler::Views extend ::Rack::MiniProfiler::ProfilingMethods # options: @@ -467,203 +30,165 @@ class Rack::MiniProfiler # # @return [MiniProfiler] a new instance of MiniProfiler # - # source://rack-mini-profiler//lib/mini_profiler.rb#126 + # source://rack-mini-profiler//lib/mini_profiler.rb#122 def initialize(app, config = T.unsafe(nil)); end + # source://rack-mini-profiler//lib/mini_profiler.rb#419 + def action_parameters(env); end + # @return [Boolean] # - # source://rack-mini-profiler//lib/mini_profiler.rb#217 + # source://rack-mini-profiler//lib/mini_profiler.rb#149 def advanced_debugging_enabled?; end - # source://rack-mini-profiler//lib/mini_profiler.rb#595 + # source://rack-mini-profiler//lib/mini_profiler.rb#525 def analyze_memory; end - # source://rack-mini-profiler//lib/mini_profiler.rb#820 + # source://rack-mini-profiler//lib/mini_profiler.rb#618 def cache_control_value; end - # source://rack-mini-profiler//lib/mini_profiler.rb#225 + # source://rack-mini-profiler//lib/mini_profiler.rb#157 def call(env); end # cancels automatic injection of profile script for the current page # - # source://rack-mini-profiler//lib/mini_profiler.rb#816 + # source://rack-mini-profiler//lib/mini_profiler.rb#614 def cancel_auto_inject(env); end - # source://rack-mini-profiler//lib/mini_profiler.rb#213 + # source://rack-mini-profiler//lib/mini_profiler.rb#145 def config; end - # source://rack-mini-profiler//lib/mini_profiler.rb#205 + # source://rack-mini-profiler//lib/mini_profiler.rb#137 def current; end - # source://rack-mini-profiler//lib/mini_profiler.rb#209 + # source://rack-mini-profiler//lib/mini_profiler.rb#141 def current=(c); end - # source://rack-mini-profiler//lib/mini_profiler.rb#567 + # source://rack-mini-profiler//lib/mini_profiler.rb#497 def dump_env(env); end - # source://rack-mini-profiler//lib/mini_profiler.rb#549 + # source://rack-mini-profiler//lib/mini_profiler.rb#479 def dump_exceptions(exceptions); end - # source://rack-mini-profiler//lib/mini_profiler.rb#708 - def flamegraph(graph, path, env); end - - # source://rack-mini-profiler//lib/mini_profiler.rb#178 - def generate_html(page_struct, env, result_json = T.unsafe(nil)); end - - # get_profile_script returns script to be injected inside current html page - # By default, profile_script is appended to the end of all html requests automatically. - # Calling get_profile_script cancels automatic append for the current page - # Use it when: - # * you have disabled auto append behaviour throught :auto_inject => false flag - # * you do not want script to be automatically appended for the current page. You can also call cancel_auto_inject - # - # source://rack-mini-profiler//lib/mini_profiler.rb#758 - def get_profile_script(env); end + # source://rack-mini-profiler//lib/mini_profiler.rb#609 + def flamegraph_path(env); end - # source://rack-mini-profiler//lib/mini_profiler.rb#671 - def help(client_settings, env); end - - # source://rack-mini-profiler//lib/mini_profiler.rb#739 + # source://rack-mini-profiler//lib/mini_profiler.rb#596 def ids(env); end - # source://rack-mini-profiler//lib/mini_profiler.rb#748 + # source://rack-mini-profiler//lib/mini_profiler.rb#605 def ids_comma_separated(env); end - # source://rack-mini-profiler//lib/mini_profiler.rb#528 + # source://rack-mini-profiler//lib/mini_profiler.rb#458 def inject(fragment, script); end - # source://rack-mini-profiler//lib/mini_profiler.rb#494 + # source://rack-mini-profiler//lib/mini_profiler.rb#423 def inject_profiler(env, status, headers, body); end - # source://rack-mini-profiler//lib/mini_profiler.rb#666 - def make_link(postfix, env); end - - # source://rack-mini-profiler//lib/mini_profiler.rb#190 - def serve_html(env); end - - # source://rack-mini-profiler//lib/mini_profiler.rb#141 - def serve_results(env); end + # @return [Boolean] + # + # source://rack-mini-profiler//lib/mini_profiler.rb#414 + def matches_action?(action, env); end - # source://rack-mini-profiler//lib/mini_profiler.rb#661 + # source://rack-mini-profiler//lib/mini_profiler.rb#591 def text_result(body, status: T.unsafe(nil), headers: T.unsafe(nil)); end - # source://rack-mini-profiler//lib/mini_profiler.rb#221 + # source://rack-mini-profiler//lib/mini_profiler.rb#153 def tool_disabled_message(client_settings); end - # source://rack-mini-profiler//lib/mini_profiler.rb#589 + # source://rack-mini-profiler//lib/mini_profiler.rb#519 def trim_strings(strings, max_size); end - # source://rack-mini-profiler//lib/mini_profiler.rb#137 + # source://rack-mini-profiler//lib/mini_profiler.rb#133 def user(env); end private - # source://rack-mini-profiler//lib/mini_profiler.rb#826 - def handle_snapshots_request(env); end - - # source://rack-mini-profiler//lib/mini_profiler.rb#950 - def public_base_path(env); end - - # source://rack-mini-profiler//lib/mini_profiler.rb#894 + # source://rack-mini-profiler//lib/mini_profiler.rb#624 def rails_route_from_path(path, method); end - # source://rack-mini-profiler//lib/mini_profiler.rb#876 - def serve_flamegraph(env); end - - # source://rack-mini-profiler//lib/mini_profiler.rb#921 + # source://rack-mini-profiler//lib/mini_profiler.rb#641 def take_snapshot(env, start); end # @return [Boolean] # - # source://rack-mini-profiler//lib/mini_profiler.rb#915 + # source://rack-mini-profiler//lib/mini_profiler.rb#635 def take_snapshot?(path); end - # source://rack-mini-profiler//lib/mini_profiler.rb#910 - def url_for_snapshot(id, group_name); end - - # source://rack-mini-profiler//lib/mini_profiler.rb#905 - def url_for_snapshots_group(group_name); end - class << self - # source://rack-mini-profiler//lib/mini_profiler.rb#59 + # source://rack-mini-profiler//lib/mini_profiler.rb#55 def add_snapshot_custom_field(key, value); end - # source://rack-mini-profiler//lib/mini_profiler.rb#95 + # source://rack-mini-profiler//lib/mini_profiler.rb#91 def advanced_tools_message; end - # source://rack-mini-profiler//lib/mini_profiler.rb#83 + # source://rack-mini-profiler//lib/mini_profiler.rb#79 def authorize_request; end - # source://rack-mini-profiler//lib/mini_profiler.rb#101 + # source://rack-mini-profiler//lib/mini_profiler.rb#97 def binds_to_params(binds); end # So we can change the configuration if we want # - # source://rack-mini-profiler//lib/mini_profiler.rb#36 + # source://rack-mini-profiler//lib/mini_profiler.rb#40 def config; end - # source://rack-mini-profiler//lib/mini_profiler.rb#74 + # source://rack-mini-profiler//lib/mini_profiler.rb#70 def create_current(env = T.unsafe(nil), options = T.unsafe(nil)); end - # source://rack-mini-profiler//lib/mini_profiler.rb#48 + # source://rack-mini-profiler//lib/mini_profiler.rb#44 def current; end - # source://rack-mini-profiler//lib/mini_profiler.rb#52 + # source://rack-mini-profiler//lib/mini_profiler.rb#48 def current=(c); end - # source://rack-mini-profiler//lib/mini_profiler.rb#87 + # source://rack-mini-profiler//lib/mini_profiler.rb#83 def deauthorize_request; end # discard existing results, don't track this request # - # source://rack-mini-profiler//lib/mini_profiler.rb#70 + # source://rack-mini-profiler//lib/mini_profiler.rb#66 def discard_results; end - # source://rack-mini-profiler//lib/mini_profiler.rb#27 + # source://rack-mini-profiler//lib/mini_profiler.rb#31 def generate_id; end - # source://rack-mini-profiler//lib/mini_profiler.rb#65 + # source://rack-mini-profiler//lib/mini_profiler.rb#61 def get_snapshot_custom_fields; end # @return [Boolean] # - # source://rack-mini-profiler//lib/mini_profiler.rb#23 + # source://rack-mini-profiler//lib/mini_profiler.rb#27 def patch_rails?; end # @return [Boolean] # - # source://rack-mini-profiler//lib/mini_profiler.rb#117 + # source://rack-mini-profiler//lib/mini_profiler.rb#113 def redact_sql_queries?; end # @return [Boolean] # - # source://rack-mini-profiler//lib/mini_profiler.rb#91 + # source://rack-mini-profiler//lib/mini_profiler.rb#87 def request_authorized?; end - # source://rack-mini-profiler//lib/mini_profiler.rb#31 + # source://rack-mini-profiler//lib/mini_profiler.rb#35 def reset_config; end - # source://rack-mini-profiler//lib/mini_profiler.rb#40 - def resources_root; end - - # source://rack-mini-profiler//lib/mini_profiler.rb#44 - def share_template; end - # @return [Boolean] # - # source://rack-mini-profiler//lib/mini_profiler.rb#112 + # source://rack-mini-profiler//lib/mini_profiler.rb#108 def snapshots_transporter?; end # Returns the value of attribute subscribe_sql_active_record. # - # source://rack-mini-profiler//lib/mini_profiler.rb#21 + # source://rack-mini-profiler//lib/mini_profiler.rb#25 def subscribe_sql_active_record; end # Sets the attribute subscribe_sql_active_record # # @param value the value to set the attribute subscribe_sql_active_record to. # - # source://rack-mini-profiler//lib/mini_profiler.rb#21 + # source://rack-mini-profiler//lib/mini_profiler.rb#25 def subscribe_sql_active_record=(_arg0); end end end @@ -759,6 +284,27 @@ end # source://rack-mini-profiler//lib/mini_profiler/storage/abstract_store.rb#8 Rack::MiniProfiler::AbstractStore::MAX_TOKEN_AGE = T.let(T.unsafe(nil), Integer) +# source://rack-mini-profiler//lib/mini_profiler/actions.rb#4 +module Rack::MiniProfiler::Actions + # source://rack-mini-profiler//lib/mini_profiler/actions.rb#54 + def serve_file(env, file_name:); end + + # source://rack-mini-profiler//lib/mini_profiler/actions.rb#104 + def serve_flamegraph(env); end + + # source://rack-mini-profiler//lib/mini_profiler/actions.rb#122 + def serve_profile_gc(env, client_settings); end + + # source://rack-mini-profiler//lib/mini_profiler/actions.rb#128 + def serve_profile_memory(env, client_settings); end + + # source://rack-mini-profiler//lib/mini_profiler/actions.rb#67 + def serve_results(env); end + + # source://rack-mini-profiler//lib/mini_profiler/actions.rb#5 + def serve_snapshot(env); end +end + # source://rack-mini-profiler//lib/mini_profiler/client_settings.rb#5 class Rack::MiniProfiler::ClientSettings # @return [ClientSettings] a new instance of ClientSettings @@ -841,10 +387,10 @@ Rack::MiniProfiler::ClientSettings::COOKIE_NAME = T.let(T.unsafe(nil), String) class Rack::MiniProfiler::Config # Returns the value of attribute assets_url. # - # source://rack-mini-profiler//lib/mini_profiler/config.rb#95 + # source://rack-mini-profiler//lib/mini_profiler/config.rb#96 def assets_url; end - # source://rack-mini-profiler//lib/mini_profiler/config.rb#113 + # source://rack-mini-profiler//lib/mini_profiler/config.rb#116 def assets_url=(lmbda); end # Returns the value of attribute authorization_mode. @@ -852,11 +398,7 @@ class Rack::MiniProfiler::Config # source://rack-mini-profiler//lib/mini_profiler/config.rb#9 def authorization_mode; end - # Sets the attribute authorization_mode - # - # @param value the value to set the attribute authorization_mode to. - # - # source://rack-mini-profiler//lib/mini_profiler/config.rb#99 + # source://rack-mini-profiler//lib/mini_profiler/config.rb#101 def authorization_mode=(mode); end # Returns the value of attribute auto_inject. @@ -1013,6 +555,18 @@ class Rack::MiniProfiler::Config # source://rack-mini-profiler//lib/mini_profiler/config.rb#9 def enabled=(_arg0); end + # Returns the value of attribute flamegraph_ignore_gc. + # + # source://rack-mini-profiler//lib/mini_profiler/config.rb#9 + def flamegraph_ignore_gc; end + + # Sets the attribute flamegraph_ignore_gc + # + # @param value the value to set the attribute flamegraph_ignore_gc to. + # + # source://rack-mini-profiler//lib/mini_profiler/config.rb#9 + def flamegraph_ignore_gc=(_arg0); end + # Returns the value of attribute flamegraph_mode. # # source://rack-mini-profiler//lib/mini_profiler/config.rb#9 @@ -1037,7 +591,7 @@ class Rack::MiniProfiler::Config # source://rack-mini-profiler//lib/mini_profiler/config.rb#9 def flamegraph_sample_rate=(_arg0); end - # source://rack-mini-profiler//lib/mini_profiler/config.rb#124 + # source://rack-mini-profiler//lib/mini_profiler/config.rb#127 def horizontal_position; end # ui accessors @@ -1104,7 +658,7 @@ class Rack::MiniProfiler::Config # source://rack-mini-profiler//lib/mini_profiler/config.rb#9 def max_traces_to_show=(_arg0); end - # source://rack-mini-profiler//lib/mini_profiler/config.rb#128 + # source://rack-mini-profiler//lib/mini_profiler/config.rb#131 def merge!(config); end # ui accessors @@ -1379,7 +933,7 @@ class Rack::MiniProfiler::Config # source://rack-mini-profiler//lib/mini_profiler/config.rb#9 def user_provider=(_arg0); end - # source://rack-mini-profiler//lib/mini_profiler/config.rb#120 + # source://rack-mini-profiler//lib/mini_profiler/config.rb#123 def vertical_position; end class << self @@ -1505,31 +1059,31 @@ class Rack::MiniProfiler::FileStore < ::Rack::MiniProfiler::AbstractStore # source://rack-mini-profiler//lib/mini_profiler/storage/file_store.rb#51 def initialize(args = T.unsafe(nil)); end - # source://rack-mini-profiler//lib/mini_profiler/storage/file_store.rb#147 + # source://rack-mini-profiler//lib/mini_profiler/storage/file_store.rb#145 def allowed_tokens; end - # source://rack-mini-profiler//lib/mini_profiler/storage/file_store.rb#163 + # source://rack-mini-profiler//lib/mini_profiler/storage/file_store.rb#161 def cleanup_cache; end - # source://rack-mini-profiler//lib/mini_profiler/storage/file_store.rb#141 + # source://rack-mini-profiler//lib/mini_profiler/storage/file_store.rb#139 def flush_tokens; end - # source://rack-mini-profiler//lib/mini_profiler/storage/file_store.rb#135 + # source://rack-mini-profiler//lib/mini_profiler/storage/file_store.rb#133 def get_unviewed_ids(user); end - # source://rack-mini-profiler//lib/mini_profiler/storage/file_store.rb#104 + # source://rack-mini-profiler//lib/mini_profiler/storage/file_store.rb#102 def load(id); end - # source://rack-mini-profiler//lib/mini_profiler/storage/file_store.rb#98 + # source://rack-mini-profiler//lib/mini_profiler/storage/file_store.rb#96 def save(page_struct); end - # source://rack-mini-profiler//lib/mini_profiler/storage/file_store.rb#129 + # source://rack-mini-profiler//lib/mini_profiler/storage/file_store.rb#127 def set_all_unviewed(user, ids); end - # source://rack-mini-profiler//lib/mini_profiler/storage/file_store.rb#110 + # source://rack-mini-profiler//lib/mini_profiler/storage/file_store.rb#108 def set_unviewed(user, id); end - # source://rack-mini-profiler//lib/mini_profiler/storage/file_store.rb#119 + # source://rack-mini-profiler//lib/mini_profiler/storage/file_store.rb#117 def set_viewed(user, id); end end @@ -1593,28 +1147,33 @@ class Rack::MiniProfiler::MemcacheStore < ::Rack::MiniProfiler::AbstractStore # source://rack-mini-profiler//lib/mini_profiler/storage/memcache_store.rb#10 def initialize(args = T.unsafe(nil)); end - # source://rack-mini-profiler//lib/mini_profiler/storage/memcache_store.rb#64 + # @return [Boolean] + # + # source://rack-mini-profiler//lib/mini_profiler/storage/memcache_store.rb#21 + def alive?; end + + # source://rack-mini-profiler//lib/mini_profiler/storage/memcache_store.rb#73 def allowed_tokens; end - # source://rack-mini-profiler//lib/mini_profiler/storage/memcache_store.rb#60 + # source://rack-mini-profiler//lib/mini_profiler/storage/memcache_store.rb#69 def flush_tokens; end - # source://rack-mini-profiler//lib/mini_profiler/storage/memcache_store.rb#56 + # source://rack-mini-profiler//lib/mini_profiler/storage/memcache_store.rb#65 def get_unviewed_ids(user); end - # source://rack-mini-profiler//lib/mini_profiler/storage/memcache_store.rb#25 + # source://rack-mini-profiler//lib/mini_profiler/storage/memcache_store.rb#34 def load(id); end - # source://rack-mini-profiler//lib/mini_profiler/storage/memcache_store.rb#21 + # source://rack-mini-profiler//lib/mini_profiler/storage/memcache_store.rb#30 def save(page_struct); end - # source://rack-mini-profiler//lib/mini_profiler/storage/memcache_store.rb#52 + # source://rack-mini-profiler//lib/mini_profiler/storage/memcache_store.rb#61 def set_all_unviewed(user, ids); end - # source://rack-mini-profiler//lib/mini_profiler/storage/memcache_store.rb#32 + # source://rack-mini-profiler//lib/mini_profiler/storage/memcache_store.rb#41 def set_unviewed(user, id); end - # source://rack-mini-profiler//lib/mini_profiler/storage/memcache_store.rb#42 + # source://rack-mini-profiler//lib/mini_profiler/storage/memcache_store.rb#51 def set_viewed(user, id); end end @@ -1743,44 +1302,47 @@ module Rack::MiniProfiler::ProfilingMethods # # Returns the result of the block, or nil when no block is given. # - # source://rack-mini-profiler//lib/mini_profiler/profiling_methods.rb#143 + # source://rack-mini-profiler//lib/mini_profiler/profiling_methods.rb#147 def counter(type, duration_ms = T.unsafe(nil)); end - # source://rack-mini-profiler//lib/mini_profiler/profiling_methods.rb#64 + # source://rack-mini-profiler//lib/mini_profiler/profiling_methods.rb#68 def counter_method(klass, method, &blk); end - # source://rack-mini-profiler//lib/mini_profiler/profiling_methods.rb#27 + # source://rack-mini-profiler//lib/mini_profiler/profiling_methods.rb#31 def finish_step(obj); end - # source://rack-mini-profiler//lib/mini_profiler/profiling_methods.rb#72 + # source://rack-mini-profiler//lib/mini_profiler/profiling_methods.rb#76 def profile_method(klass, method, type = T.unsafe(nil), &blk); end - # source://rack-mini-profiler//lib/mini_profiler/profiling_methods.rb#124 + # source://rack-mini-profiler//lib/mini_profiler/profiling_methods.rb#128 def profile_singleton_method(klass, method, type = T.unsafe(nil), &blk); end # source://rack-mini-profiler//lib/mini_profiler/profiling_methods.rb#7 def record_sql(query, elapsed_ms, params = T.unsafe(nil)); end # source://rack-mini-profiler//lib/mini_profiler/profiling_methods.rb#20 + def report_reader_duration(elapsed_ms, row_count = T.unsafe(nil), class_name = T.unsafe(nil)); end + + # source://rack-mini-profiler//lib/mini_profiler/profiling_methods.rb#24 def start_step(name); end # perform a profiling step on given block # - # source://rack-mini-profiler//lib/mini_profiler/profiling_methods.rb#35 + # source://rack-mini-profiler//lib/mini_profiler/profiling_methods.rb#39 def step(name, opts = T.unsafe(nil)); end - # source://rack-mini-profiler//lib/mini_profiler/profiling_methods.rb#68 + # source://rack-mini-profiler//lib/mini_profiler/profiling_methods.rb#72 def uncounter_method(klass, method); end - # source://rack-mini-profiler//lib/mini_profiler/profiling_methods.rb#50 + # source://rack-mini-profiler//lib/mini_profiler/profiling_methods.rb#54 def unprofile_method(klass, method); end - # source://rack-mini-profiler//lib/mini_profiler/profiling_methods.rb#128 + # source://rack-mini-profiler//lib/mini_profiler/profiling_methods.rb#132 def unprofile_singleton_method(klass, method); end private - # source://rack-mini-profiler//lib/mini_profiler/profiling_methods.rb#157 + # source://rack-mini-profiler//lib/mini_profiler/profiling_methods.rb#161 def clean_method_name(method); end end @@ -1898,63 +1460,63 @@ Rack::MiniProfiler::SOURCE_CODE_URI = T.let(T.unsafe(nil), String) class Rack::MiniProfiler::SnapshotsTransporter # @return [SnapshotsTransporter] a new instance of SnapshotsTransporter # - # source://rack-mini-profiler//lib/mini_profiler/snapshots_transporter.rb#28 + # source://rack-mini-profiler//lib/mini_profiler/snapshots_transporter.rb#30 def initialize(config); end # Returns the value of attribute buffer. # - # source://rack-mini-profiler//lib/mini_profiler/snapshots_transporter.rb#25 + # source://rack-mini-profiler//lib/mini_profiler/snapshots_transporter.rb#27 def buffer; end - # source://rack-mini-profiler//lib/mini_profiler/snapshots_transporter.rb#49 + # source://rack-mini-profiler//lib/mini_profiler/snapshots_transporter.rb#51 def flush_buffer; end # Returns the value of attribute gzip_requests. # - # source://rack-mini-profiler//lib/mini_profiler/snapshots_transporter.rb#26 + # source://rack-mini-profiler//lib/mini_profiler/snapshots_transporter.rb#28 def gzip_requests; end # Sets the attribute gzip_requests # # @param value the value to set the attribute gzip_requests to. # - # source://rack-mini-profiler//lib/mini_profiler/snapshots_transporter.rb#26 + # source://rack-mini-profiler//lib/mini_profiler/snapshots_transporter.rb#28 def gzip_requests=(_arg0); end # Returns the value of attribute max_buffer_size. # - # source://rack-mini-profiler//lib/mini_profiler/snapshots_transporter.rb#26 + # source://rack-mini-profiler//lib/mini_profiler/snapshots_transporter.rb#28 def max_buffer_size; end # Sets the attribute max_buffer_size # # @param value the value to set the attribute max_buffer_size to. # - # source://rack-mini-profiler//lib/mini_profiler/snapshots_transporter.rb#26 + # source://rack-mini-profiler//lib/mini_profiler/snapshots_transporter.rb#28 def max_buffer_size=(_arg0); end - # source://rack-mini-profiler//lib/mini_profiler/snapshots_transporter.rb#89 + # source://rack-mini-profiler//lib/mini_profiler/snapshots_transporter.rb#91 def requests_interval; end - # source://rack-mini-profiler//lib/mini_profiler/snapshots_transporter.rb#41 + # source://rack-mini-profiler//lib/mini_profiler/snapshots_transporter.rb#43 def ship(snapshot); end private - # source://rack-mini-profiler//lib/mini_profiler/snapshots_transporter.rb#95 + # source://rack-mini-profiler//lib/mini_profiler/snapshots_transporter.rb#97 def backoff_delay; end - # source://rack-mini-profiler//lib/mini_profiler/snapshots_transporter.rb#100 + # source://rack-mini-profiler//lib/mini_profiler/snapshots_transporter.rb#102 def start_thread; end class << self - # source://rack-mini-profiler//lib/mini_profiler/snapshots_transporter.rb#15 + # source://rack-mini-profiler//lib/mini_profiler/snapshots_transporter.rb#17 def failed_http_requests_count; end - # source://rack-mini-profiler//lib/mini_profiler/snapshots_transporter.rb#12 + # source://rack-mini-profiler//lib/mini_profiler/snapshots_transporter.rb#13 def successful_http_requests_count; end - # source://rack-mini-profiler//lib/mini_profiler/snapshots_transporter.rb#19 + # source://rack-mini-profiler//lib/mini_profiler/snapshots_transporter.rb#21 def transport(snapshot); end # source://rack-mini-profiler//lib/mini_profiler/snapshots_transporter.rb#9 @@ -1982,13 +1544,13 @@ class Rack::MiniProfiler::TimerStruct::Base # source://rack-mini-profiler//lib/mini_profiler/timer_struct/base.rb#23 def []=(name, val); end - # source://rack-mini-profiler//lib/mini_profiler/timer_struct/base.rb#34 + # source://rack-mini-profiler//lib/mini_profiler/timer_struct/base.rb#33 def as_json(options = T.unsafe(nil)); end # source://rack-mini-profiler//lib/mini_profiler/timer_struct/base.rb#15 def attributes; end - # source://rack-mini-profiler//lib/mini_profiler/timer_struct/base.rb#28 + # source://rack-mini-profiler//lib/mini_profiler/timer_struct/base.rb#27 def to_json(*a); end end @@ -2057,7 +1619,7 @@ class Rack::MiniProfiler::TimerStruct::Page < ::Rack::MiniProfiler::TimerStruct: # source://rack-mini-profiler//lib/mini_profiler/timer_struct/page.rb#60 def initialize(env); end - # source://rack-mini-profiler//lib/mini_profiler/timer_struct/page.rb#124 + # source://rack-mini-profiler//lib/mini_profiler/timer_struct/page.rb#131 def as_json(options = T.unsafe(nil)); end # Returns the value of attribute attributes. @@ -2065,25 +1627,28 @@ class Rack::MiniProfiler::TimerStruct::Page < ::Rack::MiniProfiler::TimerStruct: # source://rack-mini-profiler//lib/mini_profiler/timer_struct/page.rb#58 def attributes; end - # source://rack-mini-profiler//lib/mini_profiler/timer_struct/page.rb#116 + # source://rack-mini-profiler//lib/mini_profiler/timer_struct/page.rb#123 def attributes_to_serialize; end - # source://rack-mini-profiler//lib/mini_profiler/timer_struct/page.rb#104 + # source://rack-mini-profiler//lib/mini_profiler/timer_struct/page.rb#111 def duration_ms; end - # source://rack-mini-profiler//lib/mini_profiler/timer_struct/page.rb#108 + # source://rack-mini-profiler//lib/mini_profiler/timer_struct/page.rb#115 def duration_ms_in_sql; end - # source://rack-mini-profiler//lib/mini_profiler/timer_struct/page.rb#128 + # source://rack-mini-profiler//lib/mini_profiler/timer_struct/page.rb#135 def extra_json; end - # source://rack-mini-profiler//lib/mini_profiler/timer_struct/page.rb#100 + # source://rack-mini-profiler//lib/mini_profiler/timer_struct/page.rb#99 def name; end - # source://rack-mini-profiler//lib/mini_profiler/timer_struct/page.rb#112 + # source://rack-mini-profiler//lib/mini_profiler/timer_struct/page.rb#103 + def page_name(env); end + + # source://rack-mini-profiler//lib/mini_profiler/timer_struct/page.rb#119 def root; end - # source://rack-mini-profiler//lib/mini_profiler/timer_struct/page.rb#120 + # source://rack-mini-profiler//lib/mini_profiler/timer_struct/page.rb#127 def to_json(*a); end class << self @@ -2110,13 +1675,13 @@ class Rack::MiniProfiler::TimerStruct::Request < ::Rack::MiniProfiler::TimerStru # source://rack-mini-profiler//lib/mini_profiler/timer_struct/request.rb#81 def add_child(name); end - # source://rack-mini-profiler//lib/mini_profiler/timer_struct/request.rb#128 + # source://rack-mini-profiler//lib/mini_profiler/timer_struct/request.rb#134 def add_custom(type, elapsed_ms, page); end # source://rack-mini-profiler//lib/mini_profiler/timer_struct/request.rb#104 def add_sql(query, elapsed_ms, page, params = T.unsafe(nil), skip_backtrace = T.unsafe(nil), full_backtrace = T.unsafe(nil)); end - # source://rack-mini-profiler//lib/mini_profiler/timer_struct/request.rb#172 + # source://rack-mini-profiler//lib/mini_profiler/timer_struct/request.rb#178 def adjust_depth; end # source://rack-mini-profiler//lib/mini_profiler/timer_struct/request.rb#69 @@ -2149,7 +1714,7 @@ class Rack::MiniProfiler::TimerStruct::Request < ::Rack::MiniProfiler::TimerStru # source://rack-mini-profiler//lib/mini_profiler/timer_struct/request.rb#90 def move_child(child, destination); end - # source://rack-mini-profiler//lib/mini_profiler/timer_struct/request.rb#145 + # source://rack-mini-profiler//lib/mini_profiler/timer_struct/request.rb#151 def move_custom(type, custom, destination); end # source://rack-mini-profiler//lib/mini_profiler/timer_struct/request.rb#115 @@ -2170,9 +1735,14 @@ class Rack::MiniProfiler::TimerStruct::Request < ::Rack::MiniProfiler::TimerStru # source://rack-mini-profiler//lib/mini_profiler/timer_struct/request.rb#14 def parent=(_arg0); end - # source://rack-mini-profiler//lib/mini_profiler/timer_struct/request.rb#165 + # source://rack-mini-profiler//lib/mini_profiler/timer_struct/request.rb#171 def record_time(milliseconds = T.unsafe(nil)); end + # please call SqlTiming#report_reader_duration instead + # + # source://rack-mini-profiler//lib/mini_profiler/timer_struct/request.rb#129 + def report_reader_duration(elapsed_ms, row_count = T.unsafe(nil), class_name = T.unsafe(nil)); end + # source://rack-mini-profiler//lib/mini_profiler/timer_struct/request.rb#77 def sql_timings; end @@ -2217,24 +1787,70 @@ class Rack::MiniProfiler::TimerStruct::Sql < ::Rack::MiniProfiler::TimerStruct:: def parent=(_arg0); end # source://rack-mini-profiler//lib/mini_profiler/timer_struct/sql.rb#54 - def report_reader_duration(elapsed_ms); end + def report_reader_duration(elapsed_ms, row_count = T.unsafe(nil), class_name = T.unsafe(nil)); end - # source://rack-mini-profiler//lib/mini_profiler/timer_struct/sql.rb#62 + # source://rack-mini-profiler//lib/mini_profiler/timer_struct/sql.rb#64 def trim_binds(binds); end end # source://rack-mini-profiler//lib/mini_profiler/version.rb#5 Rack::MiniProfiler::VERSION = T.let(T.unsafe(nil), String) +# source://rack-mini-profiler//lib/mini_profiler/views.rb#4 +module Rack::MiniProfiler::Views + # source://rack-mini-profiler//lib/mini_profiler/views.rb#103 + def blank_page_html; end + + # source://rack-mini-profiler//lib/mini_profiler/views.rb#112 + def flamegraph(graph, path, env); end + + # source://rack-mini-profiler//lib/mini_profiler/views.rb#13 + def generate_html(page_struct, env, result_json = T.unsafe(nil)); end + + # get_profile_script returns script to be injected inside current html page + # By default, profile_script is appended to the end of all html requests automatically. + # Calling get_profile_script cancels automatic append for the current page + # Use it when: + # * you have disabled auto append behaviour throught :auto_inject => false flag + # * you do not want script to be automatically appended for the current page. You can also call cancel_auto_inject + # + # source://rack-mini-profiler//lib/mini_profiler/views.rb#31 + def get_profile_script(env, response_headers = T.unsafe(nil)); end + + # source://rack-mini-profiler//lib/mini_profiler/views.rb#143 + def help(client_settings, env); end + + # source://rack-mini-profiler//lib/mini_profiler/views.rb#107 + def make_link(postfix, env); end + + # source://rack-mini-profiler//lib/mini_profiler/views.rb#193 + def public_base_path(env); end + + # source://rack-mini-profiler//lib/mini_profiler/views.rb#5 + def resources_root; end + + # source://rack-mini-profiler//lib/mini_profiler/views.rb#9 + def share_template; end + + # source://rack-mini-profiler//lib/mini_profiler/views.rb#188 + def url_for_snapshot(id, group_name); end + + # source://rack-mini-profiler//lib/mini_profiler/views.rb#183 + def url_for_snapshots_group(group_name); end +end + +# source://rack-mini-profiler//lib/mini_profiler/views.rb#93 +Rack::MiniProfiler::Views::BLANK_PAGE = T.let(T.unsafe(nil), String) + # source://rack-mini-profiler//lib/mini_profiler_rails/railtie.rb#6 module Rack::MiniProfilerRails extend ::Rack::MiniProfilerRailsMethods class << self - # source://rack-mini-profiler//lib/mini_profiler_rails/railtie.rb#122 + # source://rack-mini-profiler//lib/mini_profiler_rails/railtie.rb#132 def create_engine; end - # source://rack-mini-profiler//lib/mini_profiler_rails/railtie.rb#143 + # source://rack-mini-profiler//lib/mini_profiler_rails/railtie.rb#153 def get_key(payload); end # call direct if needed to do a defer init @@ -2244,18 +1860,18 @@ module Rack::MiniProfilerRails # @return [Boolean] # - # source://rack-mini-profiler//lib/mini_profiler_rails/railtie.rb#151 + # source://rack-mini-profiler//lib/mini_profiler_rails/railtie.rb#161 def serves_static_assets?(app); end - # source://rack-mini-profiler//lib/mini_profiler_rails/railtie.rb#147 + # source://rack-mini-profiler//lib/mini_profiler_rails/railtie.rb#157 def shorten_identifier(identifier); end - # source://rack-mini-profiler//lib/mini_profiler_rails/railtie.rb#133 + # source://rack-mini-profiler//lib/mini_profiler_rails/railtie.rb#143 def subscribe(event, &blk); end end end -# source://rack-mini-profiler//lib/mini_profiler_rails/railtie.rb#167 +# source://rack-mini-profiler//lib/mini_profiler_rails/railtie.rb#177 class Rack::MiniProfilerRails::Railtie < ::Rails::Railtie; end # source://rack-mini-profiler//lib/mini_profiler_rails/railtie_methods.rb#3 diff --git a/sorbet/rbi/gems/rails_live_reload@0.3.4.rbi b/sorbet/rbi/gems/rails_live_reload@0.3.6.rbi similarity index 100% rename from sorbet/rbi/gems/rails_live_reload@0.3.4.rbi rename to sorbet/rbi/gems/rails_live_reload@0.3.6.rbi diff --git a/sorbet/rbi/gems/rb-inotify@0.10.1.rbi b/sorbet/rbi/gems/rb-inotify@0.11.1.rbi similarity index 95% rename from sorbet/rbi/gems/rb-inotify@0.10.1.rbi rename to sorbet/rbi/gems/rb-inotify@0.11.1.rbi index 752751ed2..cd508ce9a 100644 --- a/sorbet/rbi/gems/rb-inotify@0.10.1.rbi +++ b/sorbet/rbi/gems/rb-inotify@0.11.1.rbi @@ -367,14 +367,14 @@ class INotify::Notifier # @raise [SystemCallError] if inotify failed to initialize for some reason # @return [Notifier] # - # source://rb-inotify//lib/rb-inotify/notifier.rb#51 + # source://rb-inotify//lib/rb-inotify/notifier.rb#49 def initialize; end # Close the notifier. # # @raise [SystemCallError] if closing the underlying file descriptor fails. # - # source://rb-inotify//lib/rb-inotify/notifier.rb#272 + # source://rb-inotify//lib/rb-inotify/notifier.rb#268 def close; end # The underlying file descriptor for this notifier. @@ -383,7 +383,7 @@ class INotify::Notifier # # @return [Fixnum] # - # source://rb-inotify//lib/rb-inotify/notifier.rb#43 + # source://rb-inotify//lib/rb-inotify/notifier.rb#41 def fd; end # Blocks until there are one or more filesystem events @@ -393,7 +393,7 @@ class INotify::Notifier # # @see #run # - # source://rb-inotify//lib/rb-inotify/notifier.rb#262 + # source://rb-inotify//lib/rb-inotify/notifier.rb#258 def process; end # Blocks until there are one or more filesystem events that this notifier @@ -404,7 +404,7 @@ class INotify::Notifier # # {#run} or {#process} are ususally preferable to calling this directly. # - # source://rb-inotify//lib/rb-inotify/notifier.rb#285 + # source://rb-inotify//lib/rb-inotify/notifier.rb#281 def read_events; end # Starts the notifier watching for filesystem events. @@ -412,14 +412,14 @@ class INotify::Notifier # # @see #process # - # source://rb-inotify//lib/rb-inotify/notifier.rb#231 + # source://rb-inotify//lib/rb-inotify/notifier.rb#227 def run; end # Stop watching for filesystem events. # That is, if we're in a \{#run} loop, # exit out as soon as we finish handling the events. # - # source://rb-inotify//lib/rb-inotify/notifier.rb#245 + # source://rb-inotify//lib/rb-inotify/notifier.rb#241 def stop; end # Returns a Ruby IO object wrapping the underlying file descriptor. @@ -438,7 +438,7 @@ class INotify::Notifier # @raise [NotImplementedError] if this is being called in JRuby # @return [IO] An IO object wrapping the file descriptor # - # source://rb-inotify//lib/rb-inotify/notifier.rb#95 + # source://rb-inotify//lib/rb-inotify/notifier.rb#94 def to_io; end # Watches a file or directory for changes, @@ -540,7 +540,7 @@ class INotify::Notifier # @yieldparam event [Event] The Event object containing information # about the event that occured # - # source://rb-inotify//lib/rb-inotify/notifier.rb#197 + # source://rb-inotify//lib/rb-inotify/notifier.rb#196 def watch(path, *flags, &callback); end # A hash from {Watcher} ids to the instances themselves. @@ -548,23 +548,21 @@ class INotify::Notifier # @private # @return [{Fixnum => Watcher}] # - # source://rb-inotify//lib/rb-inotify/notifier.rb#36 + # source://rb-inotify//lib/rb-inotify/notifier.rb#34 def watchers; end private # Same as IO#readpartial, or as close as we need. # - # source://rb-inotify//lib/rb-inotify/notifier.rb#316 + # source://rb-inotify//lib/rb-inotify/notifier.rb#312 def readpartial(size); end end -# A list of directories that should never be recursively watched. -# # * Files in `/dev/fd` sometimes register as directories, but are not enumerable. # -# source://rb-inotify//lib/rb-inotify/notifier.rb#30 -INotify::Notifier::RECURSIVE_BLACKLIST = T.let(T.unsafe(nil), Array) +# source://rb-inotify//lib/rb-inotify/notifier.rb#28 +INotify::Notifier::NON_RECURSIVE = T.let(T.unsafe(nil), String) # source://rb-inotify//lib/rb-inotify/errors.rb#2 class INotify::QueueOverflowError < ::RuntimeError; end diff --git a/sorbet/rbi/gems/rdf@3.2.11.rbi b/sorbet/rbi/gems/rdf@3.3.2.rbi similarity index 92% rename from sorbet/rbi/gems/rdf@3.2.11.rbi rename to sorbet/rbi/gems/rdf@3.3.2.rbi index 2f934efd7..77cfd7341 100644 --- a/sorbet/rbi/gems/rdf@3.2.11.rbi +++ b/sorbet/rbi/gems/rdf@3.3.2.rbi @@ -51,6 +51,8 @@ module RDF # Alias for `RDF::Literal.new`. # # @param value [Object] + # @param direction [Symbol] (nil) + # Initial text direction. # @param language [Symbol] (nil) # Language is downcased to ensure proper matching # @param lexical [String] (nil) @@ -182,7 +184,7 @@ end # RDF::CLI::Option.new( # symbol: :canonicalize, # on: ["--canonicalize"], -# description: "Canonicalize input/output.") {true}, +# description: "Canonicalize URI/literal forms.") {true}, # RDF::CLI::Option.new( # symbol: :uri, # on: ["--uri STRING"], @@ -818,7 +820,7 @@ class RDF::Dataset # Implements basic query pattern matching over the Dataset, with handling # for a default graph. # - # source://rdf//lib/rdf/model/dataset.rb#116 + # source://rdf//lib/rdf/model/dataset.rb#117 def query_pattern(pattern, **options, &block); end end @@ -943,6 +945,21 @@ module RDF::Enumerable include ::RDF::Countable extend ::RDF::Util::Aliasing::LateBound + # Enumerates each statement using its canonical representation. + # + # @note This is updated by `RDF::Normalize` to also canonicalize blank nodes. + # @return [RDF::Enumerable] + # + # source://rdf//lib/rdf/mixin/enumerable.rb#731 + def canonicalize; end + + # Mutating canonicalization not supported + # + # @raise NotImplementedError + # + # source://rdf//lib/rdf/mixin/enumerable.rb#742 + def canonicalize!; end + # Returns a serialized string representation of `self`. # # Before calling this method you may need to explicitly require a @@ -958,7 +975,7 @@ module RDF::Enumerable # @see RDF::Writer.dump # @since 0.2.0 # - # source://rdf//lib/rdf/mixin/enumerable.rb#781 + # source://rdf//lib/rdf/mixin/enumerable.rb#803 def dump(*args, **options); end # Iterates the given block for each RDF graph in `self`. @@ -972,7 +989,7 @@ module RDF::Enumerable # @see #enum_graph # @since 0.1.9 # - # source://rdf//lib/rdf/mixin/enumerable.rb#699 + # source://rdf//lib/rdf/mixin/enumerable.rb#701 def each_graph; end # Iterates the given block for each unique RDF object term. @@ -985,7 +1002,7 @@ module RDF::Enumerable # @overload each_object # @see #enum_object # - # source://rdf//lib/rdf/mixin/enumerable.rb#504 + # source://rdf//lib/rdf/mixin/enumerable.rb#506 def each_object; end # Iterates the given block for each unique RDF predicate term. @@ -998,7 +1015,7 @@ module RDF::Enumerable # @overload each_predicate # @see #enum_predicate # - # source://rdf//lib/rdf/mixin/enumerable.rb#437 + # source://rdf//lib/rdf/mixin/enumerable.rb#439 def each_predicate; end # Iterates the given block for each RDF quad. @@ -1011,7 +1028,7 @@ module RDF::Enumerable # @overload each_quad # @see #enum_quad # - # source://rdf//lib/rdf/mixin/enumerable.rb#308 + # source://rdf//lib/rdf/mixin/enumerable.rb#310 def each_quad; end # Iterates the given block for each RDF statement. @@ -1024,7 +1041,7 @@ module RDF::Enumerable # @overload each_statement # @see #enum_statement # - # source://rdf//lib/rdf/mixin/enumerable.rb#180 + # source://rdf//lib/rdf/mixin/enumerable.rb#182 def each_statement(&block); end # Iterates the given block for each unique RDF subject term. @@ -1037,7 +1054,7 @@ module RDF::Enumerable # @overload each_subject # @see #enum_subject # - # source://rdf//lib/rdf/mixin/enumerable.rb#371 + # source://rdf//lib/rdf/mixin/enumerable.rb#373 def each_subject; end # Iterates the given block for each unique RDF term (subject, predicate, object, or graph_name). @@ -1051,7 +1068,7 @@ module RDF::Enumerable # @see #enum_term # @since 2.0 # - # source://rdf//lib/rdf/mixin/enumerable.rb#588 + # source://rdf//lib/rdf/mixin/enumerable.rb#590 def each_term; end # Iterates the given block for each RDF triple. @@ -1064,7 +1081,7 @@ module RDF::Enumerable # @overload each_triple # @see #enum_triple # - # source://rdf//lib/rdf/mixin/enumerable.rb#245 + # source://rdf//lib/rdf/mixin/enumerable.rb#247 def each_triple; end # Returns an enumerator for {RDF::Enumerable#each_graph}. @@ -1073,7 +1090,7 @@ module RDF::Enumerable # @see #each_graph # @since 0.1.9 # - # source://rdf//lib/rdf/mixin/enumerable.rb#718 + # source://rdf//lib/rdf/mixin/enumerable.rb#720 def enum_graph; end # Returns an enumerator for {RDF::Enumerable#each_graph}. @@ -1090,7 +1107,7 @@ module RDF::Enumerable # @return [Enumerator] # @see #each_object # - # source://rdf//lib/rdf/mixin/enumerable.rb#523 + # source://rdf//lib/rdf/mixin/enumerable.rb#525 def enum_object; end # Returns an enumerator for {RDF::Enumerable#each_object}. @@ -1106,7 +1123,7 @@ module RDF::Enumerable # @return [Enumerator] # @see #each_predicate # - # source://rdf//lib/rdf/mixin/enumerable.rb#456 + # source://rdf//lib/rdf/mixin/enumerable.rb#458 def enum_predicate; end # Returns an enumerator for {RDF::Enumerable#each_predicate}. @@ -1122,7 +1139,7 @@ module RDF::Enumerable # @return [Enumerator] # @see #each_quad # - # source://rdf//lib/rdf/mixin/enumerable.rb#322 + # source://rdf//lib/rdf/mixin/enumerable.rb#324 def enum_quad; end # Returns an enumerator for {RDF::Enumerable#each_quad}. @@ -1140,7 +1157,7 @@ module RDF::Enumerable # @return [Enumerator] # @see #each_statement # - # source://rdf//lib/rdf/mixin/enumerable.rb#195 + # source://rdf//lib/rdf/mixin/enumerable.rb#197 def enum_statement; end # Returns an enumerator for {RDF::Enumerable#each_statement}. @@ -1158,7 +1175,7 @@ module RDF::Enumerable # @return [Enumerator] # @see #each_subject # - # source://rdf//lib/rdf/mixin/enumerable.rb#390 + # source://rdf//lib/rdf/mixin/enumerable.rb#392 def enum_subject; end # Returns an enumerator for {RDF::Enumerable#each_subject}. @@ -1175,7 +1192,7 @@ module RDF::Enumerable # @see #each_term # @since 2.0 # - # source://rdf//lib/rdf/mixin/enumerable.rb#609 + # source://rdf//lib/rdf/mixin/enumerable.rb#611 def enum_term; end # Returns an enumerator for {RDF::Enumerable#each_term}. @@ -1192,7 +1209,7 @@ module RDF::Enumerable # @return [Enumerator] # @see #each_triple # - # source://rdf//lib/rdf/mixin/enumerable.rb#259 + # source://rdf//lib/rdf/mixin/enumerable.rb#261 def enum_triple; end # Returns an enumerator for {RDF::Enumerable#each_triple}. @@ -1208,7 +1225,7 @@ module RDF::Enumerable # @param graph_name [RDF::Resource, false] Use value `false` to query for the default graph_name # @return [Boolean] # - # source://rdf//lib/rdf/mixin/enumerable.rb#636 + # source://rdf//lib/rdf/mixin/enumerable.rb#638 def graph?(graph_name); end # Returns all unique RDF graph names, other than the default graph. @@ -1219,7 +1236,7 @@ module RDF::Enumerable # @see #enum_graph # @since 2.0 # - # source://rdf//lib/rdf/mixin/enumerable.rb#622 + # source://rdf//lib/rdf/mixin/enumerable.rb#624 def graph_names(unique: T.unsafe(nil)); end # Returns `true` if `self` contains the given RDF graph_name. @@ -1294,7 +1311,7 @@ module RDF::Enumerable # @return [Boolean] `true` or `false` # @since 0.2.1 # - # source://rdf//lib/rdf/mixin/enumerable.rb#115 + # source://rdf//lib/rdf/mixin/enumerable.rb#117 def invalid?; end # Returns `true` if `self` contains the given RDF object term. @@ -1302,7 +1319,7 @@ module RDF::Enumerable # @param value [RDF::Term] # @return [Boolean] # - # source://rdf//lib/rdf/mixin/enumerable.rb#481 + # source://rdf//lib/rdf/mixin/enumerable.rb#483 def object?(value); end # Returns all unique RDF object terms. @@ -1312,7 +1329,7 @@ module RDF::Enumerable # @see #each_object # @see #enum_object # - # source://rdf//lib/rdf/mixin/enumerable.rb#468 + # source://rdf//lib/rdf/mixin/enumerable.rb#470 def objects(unique: T.unsafe(nil)); end # Returns `true` if `self` contains the given RDF predicate term. @@ -1320,7 +1337,7 @@ module RDF::Enumerable # @param value [RDF::URI] # @return [Boolean] # - # source://rdf//lib/rdf/mixin/enumerable.rb#415 + # source://rdf//lib/rdf/mixin/enumerable.rb#417 def predicate?(value); end # Returns all unique RDF predicate terms. @@ -1330,7 +1347,7 @@ module RDF::Enumerable # @see #each_predicate # @see #enum_predicate # - # source://rdf//lib/rdf/mixin/enumerable.rb#402 + # source://rdf//lib/rdf/mixin/enumerable.rb#404 def predicates(unique: T.unsafe(nil)); end # Limits statements to be from a specific graph. @@ -1344,7 +1361,7 @@ module RDF::Enumerable # @see #each_statement # @since 3.0 # - # source://rdf//lib/rdf/mixin/enumerable.rb#666 + # source://rdf//lib/rdf/mixin/enumerable.rb#668 def project_graph(graph_name); end # Returns `true` if `self` contains the given RDF quad. @@ -1352,7 +1369,7 @@ module RDF::Enumerable # @param quad [Array(RDF::Resource, RDF::URI, RDF::Term, RDF::Resource)] # @return [Boolean] # - # source://rdf//lib/rdf/mixin/enumerable.rb#282 + # source://rdf//lib/rdf/mixin/enumerable.rb#284 def quad?(quad); end # Returns all RDF quads. @@ -1362,13 +1379,13 @@ module RDF::Enumerable # @see #each_quad # @see #enum_quad # - # source://rdf//lib/rdf/mixin/enumerable.rb#273 + # source://rdf//lib/rdf/mixin/enumerable.rb#275 def quads(**options); end # @overload statement? # @overload statement? # - # source://rdf//lib/rdf/mixin/enumerable.rb#151 + # source://rdf//lib/rdf/mixin/enumerable.rb#153 def statement?(*args); end # Returns all RDF statements. @@ -1378,7 +1395,7 @@ module RDF::Enumerable # @see #each_statement # @see #enum_statement # - # source://rdf//lib/rdf/mixin/enumerable.rb#137 + # source://rdf//lib/rdf/mixin/enumerable.rb#139 def statements(**options); end # Returns `true` if `self` contains the given RDF subject term. @@ -1386,7 +1403,7 @@ module RDF::Enumerable # @param value [RDF::Resource] # @return [Boolean] # - # source://rdf//lib/rdf/mixin/enumerable.rb#349 + # source://rdf//lib/rdf/mixin/enumerable.rb#351 def subject?(value); end # Returns all unique RDF subject terms. @@ -1396,7 +1413,7 @@ module RDF::Enumerable # @see #each_subject # @see #enum_subject # - # source://rdf//lib/rdf/mixin/enumerable.rb#336 + # source://rdf//lib/rdf/mixin/enumerable.rb#338 def subjects(unique: T.unsafe(nil)); end # Returns `true` if this enumerable supports the given `feature`. @@ -1407,19 +1424,21 @@ module RDF::Enumerable # * `:literal_equality' preserves [term-equality](https://www.w3.org/TR/rdf11-concepts/#dfn-literal-term-equality) for literals. Literals are equal only if their lexical values and datatypes are equal, character by character. Literals may be "inlined" to value-space for efficiency only if `:literal_equality` is `false`. # * `:validity` allows a concrete Enumerable implementation to indicate that it does or does not support valididty checking. By default implementations are assumed to support validity checking. # * `:skolemize` supports [Skolemization](https://www.w3.org/wiki/BnodeSkolemization) of an `Enumerable`. Implementations supporting this feature must implement a `#skolemize` method, taking a base URI used for minting URIs for BNodes as stable identifiers and a `#deskolemize` method, also taking a base URI used for turning URIs having that prefix back into the same BNodes which were originally skolemized. - # * `:rdfstar` supports RDF* where statements may be subjects or objects of other statements. + # * `:rdf_full` supports RDF 1.2 Full profile, including support for embedded Triple Terms. + # * `:quoted_triples` supports RDF-star quoted triples. + # * `:base_direction` supports RDF 1.2 directional language-tagged strings. # # @param feature [Symbol, #to_sym] # @return [Boolean] # @since 0.3.5 # - # source://rdf//lib/rdf/mixin/enumerable.rb#91 + # source://rdf//lib/rdf/mixin/enumerable.rb#93 def supports?(feature); end # @overload term? # @overload term? # - # source://rdf//lib/rdf/mixin/enumerable.rb#561 + # source://rdf//lib/rdf/mixin/enumerable.rb#563 def term?(*args); end # Returns all unique RDF terms (subjects, predicates, objects, and graph_names). @@ -1432,7 +1451,7 @@ module RDF::Enumerable # @see #enum_resource # @since 2.0 # - # source://rdf//lib/rdf/mixin/enumerable.rb#539 + # source://rdf//lib/rdf/mixin/enumerable.rb#541 def terms(unique: T.unsafe(nil)); end # Returns all RDF statements in `self` as an array. @@ -1440,9 +1459,8 @@ module RDF::Enumerable # Mixes in `RDF::Enumerable` into the returned object. # # @return [Array] - # @since 0.2.0 # - # source://rdf//lib/rdf/mixin/enumerable.rb#730 + # source://rdf//lib/rdf/mixin/enumerable.rb#752 def to_a; end # @param method [Symbol, #to_sym] @@ -1461,7 +1479,7 @@ module RDF::Enumerable # # @return [Hash] # - # source://rdf//lib/rdf/mixin/enumerable.rb#754 + # source://rdf//lib/rdf/mixin/enumerable.rb#776 def to_h; end # Returns all RDF statements in `self` as a set. @@ -1471,7 +1489,7 @@ module RDF::Enumerable # @return [Set] # @since 0.2.0 # - # source://rdf//lib/rdf/mixin/enumerable.rb#741 + # source://rdf//lib/rdf/mixin/enumerable.rb#763 def to_set; end # Returns `true` if `self` contains the given RDF triple. @@ -1479,7 +1497,7 @@ module RDF::Enumerable # @param triple [Array(RDF::Resource, RDF::URI, RDF::Term)] # @return [Boolean] # - # source://rdf//lib/rdf/mixin/enumerable.rb#220 + # source://rdf//lib/rdf/mixin/enumerable.rb#222 def triple?(triple); end # Returns all RDF triples. @@ -1489,7 +1507,7 @@ module RDF::Enumerable # @see #each_triple # @see #enum_triple # - # source://rdf//lib/rdf/mixin/enumerable.rb#211 + # source://rdf//lib/rdf/mixin/enumerable.rb#213 def triples(**options); end # Returns `true` if all statements are valid @@ -1498,7 +1516,7 @@ module RDF::Enumerable # @return [Boolean] `true` or `false` # @since 0.3.11 # - # source://rdf//lib/rdf/mixin/enumerable.rb#101 + # source://rdf//lib/rdf/mixin/enumerable.rb#103 def valid?; end # Default validate! implementation, overridden in concrete classes @@ -1516,7 +1534,7 @@ module RDF::Enumerable # @return [RDF::Enumerable] `self` # @since 0.3.9 # - # source://rdf//lib/rdf/mixin/enumerable.rb#124 + # source://rdf//lib/rdf/mixin/enumerable.rb#126 def validate!; end protected @@ -1526,12 +1544,12 @@ module RDF::Enumerable # @return [Enumerator] # @see Object#enum_for # - # source://rdf//lib/rdf/mixin/enumerable.rb#819 + # source://rdf//lib/rdf/mixin/enumerable.rb#841 def enum_for(method = T.unsafe(nil), *args); end # @overload # - # source://rdf//lib/rdf/mixin/enumerable.rb#796 + # source://rdf//lib/rdf/mixin/enumerable.rb#818 def method_missing(meth, *args); end private @@ -1541,7 +1559,7 @@ module RDF::Enumerable # a list of valid format symbols. # @return [Boolean] # - # source://rdf//lib/rdf/mixin/enumerable.rb#809 + # source://rdf//lib/rdf/mixin/enumerable.rb#831 def respond_to_missing?(name, include_private = T.unsafe(nil)); end end @@ -2022,7 +2040,7 @@ class RDF::Graph # @see RDF::Enumerable#each_graph # @since 0.2.0 # - # source://rdf//lib/rdf/model/graph.rb#373 + # source://rdf//lib/rdf/model/graph.rb#377 def each_graph; end # @overload graph? @@ -2058,7 +2076,7 @@ class RDF::Graph # @see RDF::Enumerable#graphs # @since 0.2.0 # - # source://rdf//lib/rdf/model/graph.rb#365 + # source://rdf//lib/rdf/model/graph.rb#369 def graphs; end # @overload statement? @@ -2070,7 +2088,7 @@ class RDF::Graph # @private # @see RDF::Mutable#insert_statements # - # source://rdf//lib/rdf/model/graph.rb#319 + # source://rdf//lib/rdf/model/graph.rb#323 def insert_statements(statements); end # (re)loads the graph from the specified location, or from the location associated with the graph name, if any @@ -2153,19 +2171,19 @@ class RDF::Graph # @private # @see RDF::Transactable#begin_transaction # - # source://rdf//lib/rdf/model/graph.rb#351 + # source://rdf//lib/rdf/model/graph.rb#355 def begin_transaction(mutable: T.unsafe(nil), graph_name: T.unsafe(nil)); end # @private # @see RDF::Mutable#clear # - # source://rdf//lib/rdf/model/graph.rb#343 + # source://rdf//lib/rdf/model/graph.rb#347 def clear_statements; end # @private # @see RDF::Mutable#delete # - # source://rdf//lib/rdf/model/graph.rb#334 + # source://rdf//lib/rdf/model/graph.rb#338 def delete_statement(statement); end # @private @@ -2199,7 +2217,7 @@ end # RDF::IRI is a synonym for RDF::URI # -# source://rdf//lib/rdf/model/uri.rb#1402 +# source://rdf//lib/rdf/model/uri.rb#1403 RDF::IRI = RDF::URI # A mixin that can be used to mark RDF repository implementations as @@ -2999,7 +3017,9 @@ RDF::List::UNSET = T.let(T.unsafe(nil), Object) # # Specific typed literals may have behavior different from the default implementation. See the following defined sub-classes for specific documentation. Additional sub-classes may be defined, and will interoperate by defining `DATATYPE` and `GRAMMAR` constants, in addition other required overrides of RDF::Literal behavior. # -# In RDF 1.1, all literals are typed, including plain literals and language tagged literals. Internally, plain literals are given the `xsd:string` datatype and language tagged literals are given the `rdf:langString` datatype. Creating a plain literal, without a datatype or language, will automatically provide the `xsd:string` datatype; similar for language tagged literals. Note that most serialization formats will remove this datatype. Code which depends on a literal having the `xsd:string` datatype being different from a plain literal (formally, without a datatype) may break. However note that the `#has\_datatype?` will continue to return `false` for plain or language-tagged literals. +# In RDF 1.1, all literals are typed, including plain literals and language-tagged strings. Internally, plain literals are given the `xsd:string` datatype and language-tagged strings are given the `rdf:langString` datatype. Creating a plain literal, without a datatype or language, will automatically provide the `xsd:string` datatype; similar for language-tagged strings. Note that most serialization formats will remove this datatype. Code which depends on a literal having the `xsd:string` datatype being different from a plain literal (formally, without a datatype) may break. However note that the `#has\_datatype?` will continue to return `false` for plain or language-tagged strings. +# +# RDF 1.2 adds **directional language-tagged strings** which are effectively a subclass of **language-tagged strings** contining an additional **direction** component with value either **ltr** or **rtl** for Left-to-Right or Right-to-Left. This determines the general direction of a string when presented in n a user agent, where it might be in conflict with the inherent direction of the leading Unicode code points. Directional language-tagged strings are given the `rdf:langString` datatype. # # * {RDF::Literal::Boolean} # * {RDF::Literal::Date} @@ -3012,14 +3032,20 @@ RDF::List::UNSET = T.let(T.unsafe(nil), Object) # @example Creating a plain literal # value = RDF::Literal.new("Hello, world!") # value.plain? #=> true` -# @example Creating a language-tagged literal (1) +# @example Creating a language-tagged string (1) # value = RDF::Literal.new("Hello!", language: :en) # value.language? #=> true # value.language #=> :en -# @example Creating a language-tagged literal (2) +# @example Creating a language-tagged string (2) # RDF::Literal.new("Wazup?", language: :"en-US") # RDF::Literal.new("Hej!", language: :sv) # RDF::Literal.new("¡Hola!", language: :es) +# @example Creating a directional language-tagged string +# value = RDF::Literal.new("Hello!", language: :en, direction: :ltr) +# value.language? #=> true +# value.language #=> :en +# value.direction? #=> true +# value.direction #=> :ltr # @example Creating an explicitly datatyped literal # value = RDF::Literal.new("2009-12-31", datatype: RDF::XSD.date) # value.datatype? #=> true @@ -3040,16 +3066,18 @@ RDF::List::UNSET = T.let(T.unsafe(nil), Object) # @see http://www.w3.org/TR/rdf11-concepts/#section-Graph-Literal # @see http://www.w3.org/TR/rdf11-concepts/#section-Datatypes # -# source://rdf//lib/rdf/model/literal.rb#58 +# source://rdf//lib/rdf/model/literal.rb#70 class RDF::Literal include ::RDF::Value include ::Comparable include ::RDF::Term - # Literals without a datatype are given either xsd:string or rdf:langString - # depending on if there is language + # Literals without a datatype are given either `xsd:string`, `rdf:langString`, or `rdf:dirLangString`, + # depending on if there is `language` and/or `direction`. # # @param value [Object] + # @param direction [Symbol] (nil) + # Initial text direction. # @param language [Symbol] (nil) # Language is downcased to ensure proper matching # @param lexical [String] (nil) @@ -3065,15 +3093,15 @@ class RDF::Literal # @see http://www.w3.org/TR/rdf11-concepts/#section-Datatypes # @see #to_s # - # source://rdf//lib/rdf/model/literal.rb#166 - def initialize(value, language: T.unsafe(nil), datatype: T.unsafe(nil), lexical: T.unsafe(nil), validate: T.unsafe(nil), canonicalize: T.unsafe(nil), **options); end + # source://rdf//lib/rdf/model/literal.rb#190 + def initialize(value, language: T.unsafe(nil), datatype: T.unsafe(nil), direction: T.unsafe(nil), lexical: T.unsafe(nil), validate: T.unsafe(nil), canonicalize: T.unsafe(nil), **options); end # Compares `self` to `other` for sorting purposes (with type check). # # @param other [Object] # @return [Integer] `-1`, `0`, or `1` # - # source://rdf//lib/rdf/model/literal.rb#317 + # source://rdf//lib/rdf/model/literal.rb#353 def <=>(other); end # Returns `true` if this literal is equivalent to `other` (with type check). @@ -3085,7 +3113,7 @@ class RDF::Literal # @see http://www.w3.org/TR/rdf-sparql-query/#func-RDFterm-equal # @see http://www.w3.org/TR/rdf-concepts/#section-Literal-Equality # - # source://rdf//lib/rdf/model/literal.rb#287 + # source://rdf//lib/rdf/model/literal.rb#320 def ==(other); end # Returns `true` if this literal is equivalent to `other` (with type check). @@ -3097,7 +3125,7 @@ class RDF::Literal # @see http://www.w3.org/TR/rdf-sparql-query/#func-RDFterm-equal # @see http://www.w3.org/TR/rdf-concepts/#section-Literal-Equality # - # source://rdf//lib/rdf/model/literal.rb#287 + # source://rdf//lib/rdf/model/literal.rb#320 def ===(other); end # Converts this literal into its canonical lexical representation. @@ -3107,15 +3135,15 @@ class RDF::Literal # @return [RDF::Literal] `self` # @since 0.3.0 # - # source://rdf//lib/rdf/model/literal.rb#461 + # source://rdf//lib/rdf/model/literal.rb#523 def canonicalize!; end # Term compatibility according to SPARQL # # Compatibility of two arguments is defined as: # * The arguments are simple literals or literals typed as xsd:string - # * The arguments are plain literals with identical language tags - # * The first argument is a plain literal with language tag and the second argument is a simple literal or literal typed as xsd:string + # * The arguments are plain literals with identical language-tags and directions + # * The first argument is a plain literal with language-tag and the second argument is a simple literal or literal typed as xsd:string # # @example # compatible?("abc" "b") #=> true @@ -3133,7 +3161,7 @@ class RDF::Literal # @see http://www.w3.org/TR/sparql11-query/#func-arg-compatibility # @since 2.0 # - # source://rdf//lib/rdf/model/literal.rb#223 + # source://rdf//lib/rdf/model/literal.rb#255 def compatible?(other); end # Returns `true` if the literals are comperable. @@ -3142,7 +3170,7 @@ class RDF::Literal # # @return [Boolean] # - # source://rdf//lib/rdf/model/literal.rb#440 + # source://rdf//lib/rdf/model/literal.rb#502 def comperable_datatype2?(other); end # Returns `true` if the literal has a datatype and the comparison should @@ -3152,17 +3180,17 @@ class RDF::Literal # # @return [Boolean] # - # source://rdf//lib/rdf/model/literal.rb#420 + # source://rdf//lib/rdf/model/literal.rb#482 def comperable_datatype?(other); end # @return [URI] The XML Schema datatype URI (optional). # - # source://rdf//lib/rdf/model/literal.rb#145 + # source://rdf//lib/rdf/model/literal.rb#167 def datatype; end # @return [URI] The XML Schema datatype URI (optional). # - # source://rdf//lib/rdf/model/literal.rb#145 + # source://rdf//lib/rdf/model/literal.rb#167 def datatype=(_arg0); end # Returns `true` if this is a datatyped literal. @@ -3172,7 +3200,7 @@ class RDF::Literal # @return [Boolean] `true` or `false` # @see http://www.w3.org/TR/rdf-concepts/#dfn-typed-literal # - # source://rdf//lib/rdf/model/literal.rb#382 + # source://rdf//lib/rdf/model/literal.rb#431 def datatype?; end # Returns `true` if this is a datatyped literal. @@ -3182,9 +3210,36 @@ class RDF::Literal # @return [Boolean] `true` or `false` # @see http://www.w3.org/TR/rdf-concepts/#dfn-typed-literal # - # source://rdf//lib/rdf/model/literal.rb#382 + # source://rdf//lib/rdf/model/literal.rb#431 def datatyped?; end + # @return [Symbol] The base direction (optional). Implies `datatype` is `rdf:dirLangString`. + # + # source://rdf//lib/rdf/model/literal.rb#164 + def direction; end + + # @return [Symbol] The base direction (optional). Implies `datatype` is `rdf:dirLangString`. + # + # source://rdf//lib/rdf/model/literal.rb#164 + def direction=(_arg0); end + + # Returns `true` if this is a directional language-tagged string. + # + # @return [Boolean] `true` or `false` + # @see https://www.w3.org/TR/rdf-concepts/#dfn-dir-lang-string + # + # source://rdf//lib/rdf/model/literal.rb#420 + def direction?; end + + # Returns `true` if this is a language-tagged literal in the English + # language. + # + # @return [Boolean] `true` or `false` + # @since 3.3.2 + # + # source://rdf//lib/rdf/model/literal.rb#460 + def english?; end + # Determins if `self` is the same term as `other`. # # @example @@ -3192,7 +3247,7 @@ class RDF::Literal # @param other [Object] # @return [Boolean] `true` or `false` # - # source://rdf//lib/rdf/model/literal.rb#267 + # source://rdf//lib/rdf/model/literal.rb#299 def eql?(other); end # Escape a literal using ECHAR escapes. @@ -3204,12 +3259,12 @@ class RDF::Literal # @return [String] # @see RDF::Term#escape # - # source://rdf//lib/rdf/model/literal.rb#499 + # source://rdf//lib/rdf/model/literal.rb#561 def escape(string); end # @private # - # source://rdf//lib/rdf/model/literal.rb#253 + # source://rdf//lib/rdf/model/literal.rb#285 def freeze; end # Returns `true` if this is a datatyped literal. @@ -3219,22 +3274,22 @@ class RDF::Literal # @return [Boolean] `true` or `false` # @see http://www.w3.org/TR/rdf-concepts/#dfn-typed-literal # - # source://rdf//lib/rdf/model/literal.rb#382 + # source://rdf//lib/rdf/model/literal.rb#431 def has_datatype?; end - # Returns `true` if this is a language-tagged literal. + # Returns `true` if this is a language-tagged string. # # @return [Boolean] `true` or `false` - # @see http://www.w3.org/TR/rdf-concepts/#dfn-plain-literal + # @see https://www.w3.org/TR/rdf-concepts/#dfn-language-tagged-string # - # source://rdf//lib/rdf/model/literal.rb#370 + # source://rdf//lib/rdf/model/literal.rb#410 def has_language?; end # Returns a hash code for this literal. # # @return [Integer] # - # source://rdf//lib/rdf/model/literal.rb#238 + # source://rdf//lib/rdf/model/literal.rb#270 def hash; end # Returns a human-readable value for the literal @@ -3242,55 +3297,55 @@ class RDF::Literal # @return [String] # @since 1.1.6 # - # source://rdf//lib/rdf/model/literal.rb#523 + # source://rdf//lib/rdf/model/literal.rb#585 def humanize(lang = T.unsafe(nil)); end # Returns a developer-friendly representation of `self`. # # @return [String] # - # source://rdf//lib/rdf/model/literal.rb#531 + # source://rdf//lib/rdf/model/literal.rb#593 def inspect; end - # @return [Symbol] The language tag (optional). + # @return [Symbol] The language-tag (optional). Implies `datatype` is `rdf:langString`. # - # source://rdf//lib/rdf/model/literal.rb#142 + # source://rdf//lib/rdf/model/literal.rb#161 def language; end - # @return [Symbol] The language tag (optional). + # @return [Symbol] The language-tag (optional). Implies `datatype` is `rdf:langString`. # - # source://rdf//lib/rdf/model/literal.rb#142 + # source://rdf//lib/rdf/model/literal.rb#161 def language=(_arg0); end - # Returns `true` if this is a language-tagged literal. + # Returns `true` if this is a language-tagged string. # # @return [Boolean] `true` or `false` - # @see http://www.w3.org/TR/rdf-concepts/#dfn-plain-literal + # @see https://www.w3.org/TR/rdf-concepts/#dfn-language-tagged-string # - # source://rdf//lib/rdf/model/literal.rb#370 + # source://rdf//lib/rdf/model/literal.rb#410 def language?; end # Returns `true`. # # @return [Boolean] `true` or `false` # - # source://rdf//lib/rdf/model/literal.rb#196 + # source://rdf//lib/rdf/model/literal.rb#228 def literal?; end # @return [Object] # - # source://rdf//lib/rdf/model/literal.rb#188 + # source://rdf//lib/rdf/model/literal.rb#220 def object; end # Returns `true` if this is a plain literal. A plain literal - # may have a language, but may not have a datatype. For + # may have a language and direction, but may not have a datatype. For # all practical purposes, this includes xsd:string literals # too. # # @return [Boolean] `true` or `false` # @see http://www.w3.org/TR/rdf-concepts/#dfn-plain-literal # - # source://rdf//lib/rdf/model/literal.rb#351 + # source://rdf//lib/rdf/model/literal.rb#387 def plain?; end # Returns `true` if this is a simple literal. @@ -3299,7 +3354,7 @@ class RDF::Literal # @return [Boolean] `true` or `false` # @see http://www.w3.org/TR/sparql11-query/#simple_literal # - # source://rdf//lib/rdf/model/literal.rb#361 + # source://rdf//lib/rdf/model/literal.rb#401 def simple?; end # Returns the literal, first removing all whitespace on both ends of the value, and then changing remaining consecutive whitespace groups into one space each. @@ -3309,7 +3364,7 @@ class RDF::Literal # @return [RDF::Literal] a new literal based on `self`. # @see [String#squish](http://apidock.com/rails/String/squish) # - # source://rdf//lib/rdf/model/literal.rb#472 + # source://rdf//lib/rdf/model/literal.rb#534 def squish(*other_string); end # Performs a destructive {#squish}. @@ -3317,14 +3372,14 @@ class RDF::Literal # @return self # @see [String#squish!](http://apidock.com/rails/String/squish%21) # - # source://rdf//lib/rdf/model/literal.rb#481 + # source://rdf//lib/rdf/model/literal.rb#543 def squish!; end # Returns the value as a string. # # @return [String] # - # source://rdf//lib/rdf/model/literal.rb#514 + # source://rdf//lib/rdf/model/literal.rb#576 def to_s; end # Returns `true` if this is a datatyped literal. @@ -3334,7 +3389,7 @@ class RDF::Literal # @return [Boolean] `true` or `false` # @see http://www.w3.org/TR/rdf-concepts/#dfn-typed-literal # - # source://rdf//lib/rdf/model/literal.rb#382 + # source://rdf//lib/rdf/model/literal.rb#431 def typed?; end # Returns `true` if the value adheres to the defined grammar of the @@ -3343,7 +3398,7 @@ class RDF::Literal # @return [Boolean] `true` or `false` # @since 0.2.1 # - # source://rdf//lib/rdf/model/literal.rb#395 + # source://rdf//lib/rdf/model/literal.rb#444 def valid?; end # Validates the value using {RDF::Value#valid?}, raising an error if the value is @@ -3353,35 +3408,35 @@ class RDF::Literal # @return [RDF::Literal] `self` # @since 0.2.1 # - # source://rdf//lib/rdf/model/literal.rb#409 + # source://rdf//lib/rdf/model/literal.rb#471 def validate!; end # Returns the value as a string. # # @return [String] # - # source://rdf//lib/rdf/model/literal.rb#182 + # source://rdf//lib/rdf/model/literal.rb#214 def value; end # Returns a hash code for the value. # # @return [Integer] # - # source://rdf//lib/rdf/model/literal.rb#247 + # source://rdf//lib/rdf/model/literal.rb#279 def value_hash; end protected # @overload # - # source://rdf//lib/rdf/model/literal.rb#541 + # source://rdf//lib/rdf/model/literal.rb#603 def method_missing(name, *args); end private # @return [Boolean] # - # source://rdf//lib/rdf/model/literal.rb#549 + # source://rdf//lib/rdf/model/literal.rb#611 def respond_to_missing?(name, include_private = T.unsafe(nil)); end class << self @@ -3389,27 +3444,26 @@ class RDF::Literal # # @private # - # source://rdf//lib/rdf/model/literal.rb#91 + # source://rdf//lib/rdf/model/literal.rb#103 def datatype_map; end # Return datatype class for uri, or nil if none is found # # @private # - # source://rdf//lib/rdf/model/literal.rb#102 + # source://rdf//lib/rdf/model/literal.rb#114 def datatyped_class(uri); end # @private # @return [void] # - # source://rdf//lib/rdf/model/literal.rb#67 + # source://rdf//lib/rdf/model/literal.rb#79 def inherited(child); end # @private - # @raise [ArgumentError] # - # source://rdf//lib/rdf/model/literal.rb#108 - def new(value, language: T.unsafe(nil), datatype: T.unsafe(nil), lexical: T.unsafe(nil), validate: T.unsafe(nil), canonicalize: T.unsafe(nil), **options); end + # source://rdf//lib/rdf/model/literal.rb#120 + def new(value, language: T.unsafe(nil), datatype: T.unsafe(nil), direction: T.unsafe(nil), lexical: T.unsafe(nil), validate: T.unsafe(nil), canonicalize: T.unsafe(nil), **options); end end end @@ -3422,6 +3476,8 @@ end class RDF::Literal::Boolean < ::RDF::Literal # @param value [String, Boolean] # @param value [Object] + # @param direction [Symbol] (nil) + # Initial text direction. # @param language [Symbol] (nil) # Language is downcased to ensure proper matching # @param lexical [String] (nil) @@ -3537,6 +3593,8 @@ class RDF::Literal::Date < ::RDF::Literal::Temporal # @note If initialized using the `#to_datetime` method, time component is unchanged. Otherewise, it is set to 00:00 (midnight). # @param value [String, Date, #to_datetime] # @param value [Object] + # @param direction [Symbol] (nil) + # Initial text direction. # @param language [Symbol] (nil) # Language is downcased to ensure proper matching # @param lexical [String] (nil) @@ -3632,6 +3690,8 @@ RDF::Literal::DateTime::GRAMMAR = T.let(T.unsafe(nil), Regexp) class RDF::Literal::Decimal < ::RDF::Literal::Numeric # @param value [String, BidDecimal, Numeric] # @param value [Object] + # @param direction [Symbol] (nil) + # Initial text direction. # @param language [Symbol] (nil) # Language is downcased to ensure proper matching # @param lexical [String] (nil) @@ -3753,6 +3813,8 @@ RDF::Literal::Decimal::GRAMMAR = T.let(T.unsafe(nil), Regexp) class RDF::Literal::Double < ::RDF::Literal::Numeric # @param value [String, Float, #to_f] # @param value [Object] + # @param direction [Symbol] (nil) + # Initial text direction. # @param language [Symbol] (nil) # Language is downcased to ensure proper matching # @param lexical [String] (nil) @@ -3932,7 +3994,7 @@ RDF::Literal::Double::GRAMMAR = T.let(T.unsafe(nil), Regexp) # source://rdf//lib/rdf/model/literal/double.rb#43 RDF::Literal::Double::PI = T.let(T.unsafe(nil), RDF::Literal::Double) -# source://rdf//lib/rdf/model/literal.rb#138 +# source://rdf//lib/rdf/model/literal.rb#156 RDF::Literal::FALSE = T.let(T.unsafe(nil), RDF::Literal::Boolean) # An integer literal. @@ -3950,6 +4012,8 @@ RDF::Literal::FALSE = T.let(T.unsafe(nil), RDF::Literal::Boolean) class RDF::Literal::Integer < ::RDF::Literal::Decimal # @param value [String, Integer, #to_i] # @param value [Object] + # @param direction [Symbol] (nil) + # Initial text direction. # @param language [Symbol] (nil) # Language is downcased to ensure proper matching # @param lexical [String] (nil) @@ -4409,7 +4473,7 @@ class RDF::Literal::Numeric < ::RDF::Literal def to_r; end end -# source://rdf//lib/rdf/model/literal.rb#137 +# source://rdf//lib/rdf/model/literal.rb#155 RDF::Literal::TRUE = T.let(T.unsafe(nil), RDF::Literal::Boolean) # Shared methods and class ancestry for date, time, and dateTime literal classes. @@ -4726,6 +4790,8 @@ class RDF::Literal::Time < ::RDF::Literal::Temporal # # @param value [String, DateTime, #to_datetime] # @param value [Object] + # @param direction [Symbol] (nil) + # Initial text direction. # @param language [Symbol] (nil) # Language is downcased to ensure proper matching # @param lexical [String] (nil) @@ -4773,6 +4839,8 @@ RDF::Literal::Time::GRAMMAR = T.let(T.unsafe(nil), Regexp) class RDF::Literal::Token < ::RDF::Literal # @param value [String, Symbol, #to_sym] # @param value [Object] + # @param direction [Symbol] (nil) + # Initial text direction. # @param language [Symbol] (nil) # Language is downcased to ensure proper matching # @param lexical [String] (nil) @@ -4825,7 +4893,10 @@ RDF::Literal::Token::DATATYPE = T.let(T.unsafe(nil), RDF::URI) # source://rdf//lib/rdf/model/literal/token.rb#9 RDF::Literal::Token::GRAMMAR = T.let(T.unsafe(nil), Regexp) -# source://rdf//lib/rdf/model/literal.rb#139 +# source://rdf//lib/rdf/model/literal.rb#158 +RDF::Literal::XSD_STRING = T.let(T.unsafe(nil), RDF::URI) + +# source://rdf//lib/rdf/model/literal.rb#157 RDF::Literal::ZERO = T.let(T.unsafe(nil), RDF::Literal::Integer) # Classes that include this module must implement the methods @@ -5143,19 +5214,19 @@ class RDF::NQuads::Format < ::RDF::Format # @return [Boolean] # @since 0.4.0 # - # source://rdf//lib/rdf/nquads.rb#41 + # source://rdf//lib/rdf/nquads.rb#40 def detect(sample); end # Human readable name for this format # # @since 0.4.0 # - # source://rdf//lib/rdf/nquads.rb#58 + # source://rdf//lib/rdf/nquads.rb#57 def name; end end end -# source://rdf//lib/rdf/nquads.rb#61 +# source://rdf//lib/rdf/nquads.rb#60 class RDF::NQuads::Reader < ::RDF::NTriples::Reader # Read a Quad, where the graph_name is optional # @@ -5163,7 +5234,7 @@ class RDF::NQuads::Reader < ::RDF::NTriples::Reader # @see http://sw.deri.org/2008/07/n-quads/#grammar # @since 0.4.0 # - # source://rdf//lib/rdf/nquads.rb#68 + # source://rdf//lib/rdf/nquads.rb#67 def read_triple; end end @@ -5204,22 +5275,7 @@ class RDF::NQuads::Writer < ::RDF::NTriples::Writer def write_quad(subject, predicate, object, graph_name); end end -# **`RDF::NTriples`** provides support for the N-Triples serialization -# format. -# -# N-Triples is a line-based plain-text format for encoding an RDF graph. -# It is a very restricted, explicit and well-defined subset of both -# [Turtle](http://www.w3.org/TeamSubmission/turtle/) and -# [Notation3](http://www.w3.org/TeamSubmission/n3/) (N3). -# -# The MIME content type for N-Triples files is `text/plain` and the -# recommended file extension is `.nt`. -# -# An example of an RDF statement in N-Triples format: -# -# "rdf" . -# -# ## RDFStar (RDF*) +# ## Quoted Triples (Deprecated) # # Supports statements as resources using `<>`. # @@ -5241,7 +5297,7 @@ end # @see http://www.w3.org/TR/n-triples/ # @see http://en.wikipedia.org/wiki/N-Triples # -# source://rdf//lib/rdf/ntriples.rb#41 +# source://rdf//lib/rdf/ntriples.rb#45 module RDF::NTriples class << self # @param string [String] @@ -5249,7 +5305,7 @@ module RDF::NTriples # @see RDF::NTriples::Writer.escape # @since 0.2.2 # - # source://rdf//lib/rdf/ntriples.rb#84 + # source://rdf//lib/rdf/ntriples.rb#88 def escape(string); end # Returns the serialized N-Triples representation of the given RDF @@ -5260,7 +5316,7 @@ module RDF::NTriples # @see RDF::NTriples::Writer.serialize # @since 0.1.5 # - # source://rdf//lib/rdf/ntriples.rb#66 + # source://rdf//lib/rdf/ntriples.rb#70 def serialize(value); end # @param string [String] @@ -5268,7 +5324,7 @@ module RDF::NTriples # @see RDF::NTriples::Reader.unescape # @since 0.2.2 # - # source://rdf//lib/rdf/ntriples.rb#75 + # source://rdf//lib/rdf/ntriples.rb#79 def unescape(string); end # Reconstructs an RDF value from its serialized N-Triples @@ -5279,7 +5335,7 @@ module RDF::NTriples # @see RDF::NTriples::Reader.unserialize # @since 0.1.5 # - # source://rdf//lib/rdf/ntriples.rb#54 + # source://rdf//lib/rdf/ntriples.rb#58 def unserialize(data); end end end @@ -5311,19 +5367,19 @@ class RDF::NTriples::Format < ::RDF::Format # @param sample [String] Beginning several bytes (about 1K) of input. # @return [Boolean] # - # source://rdf//lib/rdf/ntriples/format.rb#37 + # source://rdf//lib/rdf/ntriples/format.rb#36 def detect(sample); end # Human readable name for this format # - # source://rdf//lib/rdf/ntriples/format.rb#52 + # source://rdf//lib/rdf/ntriples/format.rb#51 def name; end end end # N-Triples parser. # -# ** RDFStar (RDF*) +# ** RDF=star # # Supports statements as resources using `<>`. # @@ -5354,48 +5410,54 @@ class RDF::NTriples::Reader < ::RDF::Reader # @return [Boolean] # @see http://www.w3.org/TR/rdf-testcases/#ntrip_grammar (comment) # - # source://rdf//lib/rdf/ntriples/reader.rb#265 + # source://rdf//lib/rdf/ntriples/reader.rb#280 def read_comment; end # @return [Boolean] # @see http://www.w3.org/TR/rdf-testcases/#ntrip_grammar (triple) # - # source://rdf//lib/rdf/ntriples/reader.rb#318 + # source://rdf//lib/rdf/ntriples/reader.rb#339 def read_eos; end # @return [RDF::Literal] # @see http://www.w3.org/TR/rdf-testcases/#ntrip_grammar (literal) # - # source://rdf//lib/rdf/ntriples/reader.rb#298 + # source://rdf//lib/rdf/ntriples/reader.rb#313 def read_literal; end # @return [RDF::Node] # @see http://www.w3.org/TR/rdf-testcases/#ntrip_grammar (nodeID) # - # source://rdf//lib/rdf/ntriples/reader.rb#288 + # source://rdf//lib/rdf/ntriples/reader.rb#303 def read_node; end + # @deprecated Quoted triples are now deprecated # @return [RDF::Statement] # - # source://rdf//lib/rdf/ntriples/reader.rb#250 + # source://rdf//lib/rdf/ntriples/reader.rb#263 def read_quotedTriple; end # @return [Array] # @see http://www.w3.org/TR/rdf-testcases/#ntrip_grammar # - # source://rdf//lib/rdf/ntriples/reader.rb#225 + # source://rdf//lib/rdf/ntriples/reader.rb#223 def read_triple; end + # @return [RDF::Statement] + # + # source://rdf//lib/rdf/ntriples/reader.rb#248 + def read_tripleTerm; end + # @param intern [Boolean] (false) Use Interned Node # @return [RDF::URI] # @see http://www.w3.org/TR/rdf-testcases/#ntrip_grammar (uriref) # - # source://rdf//lib/rdf/ntriples/reader.rb#273 + # source://rdf//lib/rdf/ntriples/reader.rb#288 def read_uriref(intern: T.unsafe(nil), **options); end # @return [RDF::Term] # - # source://rdf//lib/rdf/ntriples/reader.rb#212 + # source://rdf//lib/rdf/ntriples/reader.rb#210 def read_value; end class << self @@ -5408,7 +5470,7 @@ class RDF::NTriples::Reader < ::RDF::Reader # @return [RDF::Term] # @return [RDF::Literal] # - # source://rdf//lib/rdf/ntriples/reader.rb#156 + # source://rdf//lib/rdf/ntriples/reader.rb#154 def parse_literal(input, **options); end # Reconstructs an RDF value from its serialized N-Triples @@ -5420,7 +5482,7 @@ class RDF::NTriples::Reader < ::RDF::Reader # @return [RDF::Term] # @return [RDF::Node] # - # source://rdf//lib/rdf/ntriples/reader.rb#137 + # source://rdf//lib/rdf/ntriples/reader.rb#135 def parse_node(input, **options); end # Reconstructs an RDF value from its serialized N-Triples @@ -5431,7 +5493,7 @@ class RDF::NTriples::Reader < ::RDF::Reader # @param options [{Symbol => Object}] From {RDF::Reader#initialize} # @return [RDF::Term] # - # source://rdf//lib/rdf/ntriples/reader.rb#130 + # source://rdf//lib/rdf/ntriples/reader.rb#128 def parse_object(input, **options); end # Reconstructs an RDF value from its serialized N-Triples @@ -5443,7 +5505,7 @@ class RDF::NTriples::Reader < ::RDF::Reader # @return [RDF::Term] # @return [RDF::URI] # - # source://rdf//lib/rdf/ntriples/reader.rb#124 + # source://rdf//lib/rdf/ntriples/reader.rb#122 def parse_predicate(input, **options); end # Reconstructs an RDF value from its serialized N-Triples @@ -5455,7 +5517,7 @@ class RDF::NTriples::Reader < ::RDF::Reader # @return [RDF::Term] # @return [RDF::Resource] # - # source://rdf//lib/rdf/ntriples/reader.rb#117 + # source://rdf//lib/rdf/ntriples/reader.rb#115 def parse_subject(input, **options); end # Reconstructs an RDF value from its serialized N-Triples @@ -5468,7 +5530,7 @@ class RDF::NTriples::Reader < ::RDF::Reader # @return [RDF::Term] # @return [RDF::URI] # - # source://rdf//lib/rdf/ntriples/reader.rb#147 + # source://rdf//lib/rdf/ntriples/reader.rb#145 def parse_uri(input, intern: T.unsafe(nil), **options); end # @param string [String] @@ -5477,7 +5539,7 @@ class RDF::NTriples::Reader < ::RDF::Reader # @see http://blog.grayproductions.net/articles/understanding_m17n # @see http://yehudakatz.com/2010/05/17/encodings-unabridged/ # - # source://rdf//lib/rdf/ntriples/reader.rb#188 + # source://rdf//lib/rdf/ntriples/reader.rb#186 def unescape(string); end # Reconstructs an RDF value from its serialized N-Triples @@ -5488,30 +5550,26 @@ class RDF::NTriples::Reader < ::RDF::Reader # @param options [{Symbol => Object}] From {RDF::Reader#initialize} # @return [RDF::Term] # - # source://rdf//lib/rdf/ntriples/reader.rb#107 + # source://rdf//lib/rdf/ntriples/reader.rb#105 def unserialize(input, **options); end end end -# 141s -# -# source://rdf//lib/rdf/ntriples/reader.rb#74 +# source://rdf//lib/rdf/ntriples/reader.rb#69 RDF::NTriples::Reader::BLANK_NODE_LABEL = T.let(T.unsafe(nil), Regexp) # @see http://www.w3.org/TR/rdf-testcases/#ntrip_grammar # -# source://rdf//lib/rdf/ntriples/reader.rb#85 +# source://rdf//lib/rdf/ntriples/reader.rb#80 RDF::NTriples::Reader::COMMENT = T.let(T.unsafe(nil), Regexp) -# source://rdf//lib/rdf/ntriples/reader.rb#91 +# source://rdf//lib/rdf/ntriples/reader.rb#86 RDF::NTriples::Reader::DATATYPE_URI = T.let(T.unsafe(nil), Regexp) -# 159s -# -# source://rdf//lib/rdf/ntriples/reader.rb#70 +# source://rdf//lib/rdf/ntriples/reader.rb#66 RDF::NTriples::Reader::ECHAR = T.let(T.unsafe(nil), Regexp) -# source://rdf//lib/rdf/ntriples/reader.rb#96 +# source://rdf//lib/rdf/ntriples/reader.rb#91 RDF::NTriples::Reader::END_OF_STATEMENT = T.let(T.unsafe(nil), Regexp) # @see http://www.w3.org/TR/rdf-testcases/#ntrip_strings @@ -5521,77 +5579,74 @@ RDF::NTriples::Reader::ESCAPE_CHARS = T.let(T.unsafe(nil), Array) # cache constants to optimize escaping the escape chars in self.unescape # -# source://rdf//lib/rdf/ntriples/reader.rb#168 +# source://rdf//lib/rdf/ntriples/reader.rb#166 RDF::NTriples::Reader::ESCAPE_CHARS_ESCAPED = T.let(T.unsafe(nil), Hash) -# source://rdf//lib/rdf/ntriples/reader.rb#178 +# source://rdf//lib/rdf/ntriples/reader.rb#176 RDF::NTriples::Reader::ESCAPE_CHARS_ESCAPED_REGEXP = T.let(T.unsafe(nil), Regexp) -# 18 -# -# source://rdf//lib/rdf/ntriples/reader.rb#72 +# source://rdf//lib/rdf/ntriples/reader.rb#68 RDF::NTriples::Reader::IRIREF = T.let(T.unsafe(nil), Regexp) # source://rdf//lib/rdf/ntriples/reader.rb#61 RDF::NTriples::Reader::IRI_RANGE = T.let(T.unsafe(nil), Regexp) -# 144s +# LANGTAG is deprecated # -# source://rdf//lib/rdf/ntriples/reader.rb#76 +# source://rdf//lib/rdf/ntriples/reader.rb#94 RDF::NTriples::Reader::LANGTAG = T.let(T.unsafe(nil), Regexp) -# source://rdf//lib/rdf/ntriples/reader.rb#92 +# source://rdf//lib/rdf/ntriples/reader.rb#70 +RDF::NTriples::Reader::LANG_DIR = T.let(T.unsafe(nil), Regexp) + +# source://rdf//lib/rdf/ntriples/reader.rb#87 RDF::NTriples::Reader::LITERAL = T.let(T.unsafe(nil), Regexp) -# source://rdf//lib/rdf/ntriples/reader.rb#88 +# source://rdf//lib/rdf/ntriples/reader.rb#83 RDF::NTriples::Reader::LITERAL_PLAIN = T.let(T.unsafe(nil), Regexp) -# source://rdf//lib/rdf/ntriples/reader.rb#90 +# source://rdf//lib/rdf/ntriples/reader.rb#85 RDF::NTriples::Reader::LITERAL_WITH_DATATYPE = T.let(T.unsafe(nil), Regexp) -# source://rdf//lib/rdf/ntriples/reader.rb#89 +# source://rdf//lib/rdf/ntriples/reader.rb#84 RDF::NTriples::Reader::LITERAL_WITH_LANGUAGE = T.let(T.unsafe(nil), Regexp) -# source://rdf//lib/rdf/ntriples/reader.rb#86 +# source://rdf//lib/rdf/ntriples/reader.rb#81 RDF::NTriples::Reader::NODEID = T.let(T.unsafe(nil), Regexp) -# source://rdf//lib/rdf/ntriples/reader.rb#95 +# source://rdf//lib/rdf/ntriples/reader.rb#90 RDF::NTriples::Reader::OBJECT = T.let(T.unsafe(nil), Regexp) -# 166s -# -# source://rdf//lib/rdf/ntriples/reader.rb#68 +# source://rdf//lib/rdf/ntriples/reader.rb#65 RDF::NTriples::Reader::PN_CHARS = T.let(T.unsafe(nil), Regexp) -# 163s -# -# source://rdf//lib/rdf/ntriples/reader.rb#64 +# source://rdf//lib/rdf/ntriples/reader.rb#63 RDF::NTriples::Reader::PN_CHARS_BASE = T.let(T.unsafe(nil), Regexp) -# 164s -# -# source://rdf//lib/rdf/ntriples/reader.rb#66 +# source://rdf//lib/rdf/ntriples/reader.rb#64 RDF::NTriples::Reader::PN_CHARS_U = T.let(T.unsafe(nil), Regexp) -# source://rdf//lib/rdf/ntriples/reader.rb#94 +# source://rdf//lib/rdf/ntriples/reader.rb#89 RDF::NTriples::Reader::PREDICATE = T.let(T.unsafe(nil), Regexp) -# 22 -# -# source://rdf//lib/rdf/ntriples/reader.rb#78 -RDF::NTriples::Reader::STRING_LITERAL_QUOTE = T.let(T.unsafe(nil), Regexp) +# source://rdf//lib/rdf/ntriples/reader.rb#77 +RDF::NTriples::Reader::QT_END = T.let(T.unsafe(nil), Regexp) -# source://rdf//lib/rdf/ntriples/reader.rb#82 -RDF::NTriples::Reader::ST_END = T.let(T.unsafe(nil), Regexp) +# source://rdf//lib/rdf/ntriples/reader.rb#76 +RDF::NTriples::Reader::QT_START = T.let(T.unsafe(nil), Regexp) -# RDF* -# -# source://rdf//lib/rdf/ntriples/reader.rb#81 -RDF::NTriples::Reader::ST_START = T.let(T.unsafe(nil), Regexp) +# source://rdf//lib/rdf/ntriples/reader.rb#71 +RDF::NTriples::Reader::STRING_LITERAL_QUOTE = T.let(T.unsafe(nil), Regexp) -# source://rdf//lib/rdf/ntriples/reader.rb#93 +# source://rdf//lib/rdf/ntriples/reader.rb#88 RDF::NTriples::Reader::SUBJECT = T.let(T.unsafe(nil), Regexp) +# source://rdf//lib/rdf/ntriples/reader.rb#74 +RDF::NTriples::Reader::TT_END = T.let(T.unsafe(nil), Regexp) + +# source://rdf//lib/rdf/ntriples/reader.rb#73 +RDF::NTriples::Reader::TT_START = T.let(T.unsafe(nil), Regexp) + # source://rdf//lib/rdf/ntriples/reader.rb#45 RDF::NTriples::Reader::UCHAR = T.let(T.unsafe(nil), Regexp) @@ -5601,7 +5656,7 @@ RDF::NTriples::Reader::UCHAR4 = T.let(T.unsafe(nil), Regexp) # source://rdf//lib/rdf/ntriples/reader.rb#44 RDF::NTriples::Reader::UCHAR8 = T.let(T.unsafe(nil), Regexp) -# source://rdf//lib/rdf/ntriples/reader.rb#87 +# source://rdf//lib/rdf/ntriples/reader.rb#82 RDF::NTriples::Reader::URIREF = T.let(T.unsafe(nil), Regexp) # Terminals from rdf-turtle. @@ -5668,7 +5723,7 @@ class RDF::NTriples::Writer < ::RDF::Writer # @private # - # source://rdf//lib/rdf/ntriples/writer.rb#324 + # source://rdf//lib/rdf/ntriples/writer.rb#338 def escaped(string); end # Returns the N-Triples representation of a literal. @@ -5677,7 +5732,7 @@ class RDF::NTriples::Writer < ::RDF::Writer # @param options [Hash{Symbol => Object}] ({}) # @return [String] # - # source://rdf//lib/rdf/ntriples/writer.rb#309 + # source://rdf//lib/rdf/ntriples/writer.rb#322 def format_literal(literal, **options); end # Returns the N-Triples representation of a blank node. @@ -5688,16 +5743,17 @@ class RDF::NTriples::Writer < ::RDF::Writer # @param options [Hash{Symbol => Object}] ({}) # @return [String] # - # source://rdf//lib/rdf/ntriples/writer.rb#255 + # source://rdf//lib/rdf/ntriples/writer.rb#268 def format_node(node, unique_bnodes: T.unsafe(nil), **options); end - # Returns the N-Triples representation of an RDF* reified statement. + # Returns the N-Triples representation of an RDF-star quoted triple. # + # @deprecated Quoted triples are now deprecated # @param statement [RDF::Statement] # @param options [Hash{Symbol => Object}] ({}) # @return [String] # - # source://rdf//lib/rdf/ntriples/writer.rb#232 + # source://rdf//lib/rdf/ntriples/writer.rb#243 def format_quotedTriple(statement, **options); end # Returns the N-Triples representation of a statement. @@ -5717,16 +5773,25 @@ class RDF::NTriples::Writer < ::RDF::Writer # @param options [Hash{Symbol => Object}] ({}) # @return [String] # - # source://rdf//lib/rdf/ntriples/writer.rb#243 + # source://rdf//lib/rdf/ntriples/writer.rb#256 def format_triple(subject, predicate, object, **options); end + # Returns the N-Triples representation of an RDF 1.2 triple term. + # + # @param statement [RDF::Statement] + # @param options [Hash{Symbol => Object}] ({}) + # @return [String] + # + # source://rdf//lib/rdf/ntriples/writer.rb#232 + def format_tripleTerm(statement, **options); end + # Returns the N-Triples representation of a URI reference using write encoding. # # @param uri [RDF::URI] # @param options [Hash{Symbol => Object}] ({}) # @return [String] # - # source://rdf//lib/rdf/ntriples/writer.rb#265 + # source://rdf//lib/rdf/ntriples/writer.rb#278 def format_uri(uri, **options); end # Outputs an N-Triples comment line. @@ -6341,7 +6406,7 @@ class RDF::Query # @return [Query] a new instance of Query # @since 0.3.0 # - # source://rdf//lib/rdf/query.rb#185 + # source://rdf//lib/rdf/query.rb#183 def initialize(*patterns, solutions: T.unsafe(nil), graph_name: T.unsafe(nil), name: T.unsafe(nil), validate: T.unsafe(nil), **options, &block); end # Add patterns from another query to form a new Query @@ -6350,7 +6415,7 @@ class RDF::Query # @return [RDF::Query] # @since 0.3.0 # - # source://rdf//lib/rdf/query.rb#416 + # source://rdf//lib/rdf/query.rb#413 def +(other); end # Appends the given query `pattern` to this query. @@ -6359,7 +6424,7 @@ class RDF::Query # @return [void] self # @since 0.3.0 # - # source://rdf//lib/rdf/query.rb#215 + # source://rdf//lib/rdf/query.rb#213 def <<(pattern); end # Apply the graph name specified (or configured) to all patterns that have no graph name @@ -6367,7 +6432,7 @@ class RDF::Query # @param graph_name [RDF::IRI, RDF::Query::Variable] (self.graph_name) # @since 0.3.0 # - # source://rdf//lib/rdf/query.rb#441 + # source://rdf//lib/rdf/query.rb#438 def apply_graph_name(graph_name = T.unsafe(nil)); end # Is this query scoped to the default graph? @@ -6375,7 +6440,7 @@ class RDF::Query # @return [Boolean] # @since 0.3.0 # - # source://rdf//lib/rdf/query.rb#428 + # source://rdf//lib/rdf/query.rb#425 def default?; end # Duplicate query, including patterns and solutions @@ -6383,7 +6448,7 @@ class RDF::Query # @return [RDF::Query] # @since 0.3.0 # - # source://rdf//lib/rdf/query.rb#528 + # source://rdf//lib/rdf/query.rb#525 def dup; end # Enumerates over each matching query solution. @@ -6393,7 +6458,7 @@ class RDF::Query # @yield [solution] # @yieldparam solution [RDF::Query::Solution] # - # source://rdf//lib/rdf/query.rb#509 + # source://rdf//lib/rdf/query.rb#506 def each(&block); end # Enumerates over each matching query solution. @@ -6403,7 +6468,7 @@ class RDF::Query # @yield [solution] # @yieldparam solution [RDF::Query::Solution] # - # source://rdf//lib/rdf/query.rb#509 + # source://rdf//lib/rdf/query.rb#506 def each_solution(&block); end # Enumerates over each statement (pattern). @@ -6413,7 +6478,7 @@ class RDF::Query # @yield [RDF::Query::Pattern] # @yieldparam pattern [::Query::Pattern] # - # source://rdf//lib/rdf/query.rb#520 + # source://rdf//lib/rdf/query.rb#517 def each_statement(&block); end # Query has no patterns @@ -6421,7 +6486,7 @@ class RDF::Query # @return [Boolean] # @since 0.3.0 # - # source://rdf//lib/rdf/query.rb#498 + # source://rdf//lib/rdf/query.rb#495 def empty?; end # Executes this query on the given `queryable` graph or repository. @@ -6443,10 +6508,9 @@ class RDF::Query # @param solutions [RDF::Query::Solutions] (Solutions.new) # @param graph_name [RDF::Resource, RDF::Query::Variable, false] (nil) # Default graph name for matching against queryable. - # Named queries either match against a specifically named + # Queries with a graph name match against a specifically named # graphs if the name is an {RDF::Resource} or bound {RDF::Query::Variable}. - # Names that are against unbound variables match either default - # or named graphs. + # Queries using an unbound variable as a graph name only match against named graphs, and will not match the default graph. # The name of `false` will only match against the default graph. # @param name [RDF::Resource, RDF::Query::Variable, false] (nil) # Alias for `:graph_name`. @@ -6459,7 +6523,7 @@ class RDF::Query # @yieldparam solution [RDF::Query::Solution] # @yieldreturn [void] ignored # - # source://rdf//lib/rdf/query.rb#311 + # source://rdf//lib/rdf/query.rb#308 def execute(queryable, bindings: T.unsafe(nil), solutions: T.unsafe(nil), graph_name: T.unsafe(nil), name: T.unsafe(nil), **options, &block); end # Returns `true` if this query did not match when last executed. @@ -6471,7 +6535,7 @@ class RDF::Query # @see #matched? # @since 0.3.0 # - # source://rdf//lib/rdf/query.rb#397 + # source://rdf//lib/rdf/query.rb#394 def failed?; end # Scope the query to named graphs matching value @@ -6495,14 +6559,14 @@ class RDF::Query # @return [Boolean] # @since 2.0 # - # source://rdf//lib/rdf/query.rb#492 + # source://rdf//lib/rdf/query.rb#489 def has_blank_nodes?; end # @overload variable? # @overload variable? # @since 0.3.0 # - # source://rdf//lib/rdf/query.rb#456 + # source://rdf//lib/rdf/query.rb#453 def has_variables?(*args); end # Returns `true` if this query matched when last executed. @@ -6514,7 +6578,7 @@ class RDF::Query # @see #failed? # @since 0.3.0 # - # source://rdf//lib/rdf/query.rb#409 + # source://rdf//lib/rdf/query.rb#406 def matched?; end # Is this query scoped to a named graph? @@ -6522,7 +6586,7 @@ class RDF::Query # @return [Boolean] # @since 0.3.0 # - # source://rdf//lib/rdf/query.rb#422 + # source://rdf//lib/rdf/query.rb#419 def named?; end # Returns `true` if any pattern contains a blank node. @@ -6530,7 +6594,7 @@ class RDF::Query # @return [Boolean] # @since 2.0 # - # source://rdf//lib/rdf/query.rb#492 + # source://rdf//lib/rdf/query.rb#489 def node?; end # Returns an optimized copy of this query. @@ -6539,7 +6603,7 @@ class RDF::Query # @return [RDF::Query] a copy of `self` # @since 0.3.0 # - # source://rdf//lib/rdf/query.rb#242 + # source://rdf//lib/rdf/query.rb#240 def optimize(**options); end # Optimizes this query by reordering its constituent triple patterns @@ -6552,7 +6616,7 @@ class RDF::Query # @see RDF::Query::Pattern#cost # @since 0.3.0 # - # source://rdf//lib/rdf/query.rb#257 + # source://rdf//lib/rdf/query.rb#255 def optimize!(**options); end # Any additional options for this query. @@ -6571,7 +6635,7 @@ class RDF::Query # @return [void] self # @since 0.3.0 # - # source://rdf//lib/rdf/query.rb#230 + # source://rdf//lib/rdf/query.rb#228 def pattern(pattern, **options); end # The patterns that constitute this query. @@ -6596,7 +6660,7 @@ class RDF::Query # @return [Boolean] # @since 0.3.0 # - # source://rdf//lib/rdf/query.rb#435 + # source://rdf//lib/rdf/query.rb#432 def unnamed?; end # Determine if the query containts valid patterns @@ -6604,7 +6668,7 @@ class RDF::Query # @return [Boolean] `true` or `false` # @since 0.3.9 # - # source://rdf//lib/rdf/query.rb#538 + # source://rdf//lib/rdf/query.rb#535 def valid?; end # Validate this query, making sure it can be executed by our query engine. @@ -6615,14 +6679,14 @@ class RDF::Query # @return [RDF::Query] `self` # @since 0.3.0 # - # source://rdf//lib/rdf/query.rb#551 + # source://rdf//lib/rdf/query.rb#548 def validate!; end # @overload variable? # @overload variable? # @since 0.3.0 # - # source://rdf//lib/rdf/query.rb#456 + # source://rdf//lib/rdf/query.rb#453 def variable?(*args); end # Returns the number of variables in this query. @@ -6630,7 +6694,7 @@ class RDF::Query # @return [Integer] (0..3) # @since 0.3.0 # - # source://rdf//lib/rdf/query.rb#483 + # source://rdf//lib/rdf/query.rb#480 def variable_count; end # The variables used in this query. This includes variables used in patterns along with the graph_name itself, if it is a variable. @@ -6638,14 +6702,14 @@ class RDF::Query # @return [Hash{Symbol => RDF::Query::Variable}] # @since 0.3.0 # - # source://rdf//lib/rdf/query.rb#471 + # source://rdf//lib/rdf/query.rb#468 def variables; end # @overload variable? # @overload variable? # @since 0.3.0 # - # source://rdf//lib/rdf/query.rb#456 + # source://rdf//lib/rdf/query.rb#453 def variables?(*args); end protected @@ -6653,7 +6717,7 @@ class RDF::Query # @private # @since 0.3.0 # - # source://rdf//lib/rdf/query.rb#569 + # source://rdf//lib/rdf/query.rb#566 def compile_hash_patterns(hash_patterns); end class << self @@ -7324,7 +7388,7 @@ class RDF::Query::Solution # Merges the bindings from the given `other` query solution into this # one, overwriting any existing ones having the same name. # - # ## RDFStar (RDF*) + # ## RDF-star # # If merging a binding for a statement to a pattern, # merge their embedded solutions. @@ -7801,11 +7865,12 @@ class RDF::Query::Variable # Returns `true` if this variable is equivalent to a given `other` # variable. Or, to another Term if bound, or to any other Term # + # @note when comparing against the default graph in an {RDF::Dataset}, `other` will be `false` and not be equal to an unbound variable. # @param other [Object] # @return [Boolean] `true` or `false` # @since 0.3.0 # - # source://rdf//lib/rdf/query/variable.rb#239 + # source://rdf//lib/rdf/query/variable.rb#241 def ==(other); end # Compares this variable with the given value. @@ -7813,7 +7878,7 @@ class RDF::Query::Variable # @param other [RDF::Term] # @return [Boolean] # - # source://rdf//lib/rdf/query/variable.rb#255 + # source://rdf//lib/rdf/query/variable.rb#257 def ===(other); end # Rebinds this variable to the given `value`. @@ -7864,11 +7929,12 @@ class RDF::Query::Variable # Returns `true` if this variable is equivalent to a given `other` # variable. Or, to another Term if bound, or to any other Term # + # @note when comparing against the default graph in an {RDF::Dataset}, `other` will be `false` and not be equal to an unbound variable. # @param other [Object] # @return [Boolean] `true` or `false` # @since 0.3.0 # - # source://rdf//lib/rdf/query/variable.rb#239 + # source://rdf//lib/rdf/query/variable.rb#241 def eql?(other); end # Sets if variable is existential or univeresal. @@ -7930,7 +7996,7 @@ class RDF::Query::Variable # v.to_s => '??a' # @return [String] # - # source://rdf//lib/rdf/query/variable.rb#288 + # source://rdf//lib/rdf/query/variable.rb#290 def to_base; end # Returns this variable as `Hash`. @@ -7955,7 +8021,7 @@ class RDF::Query::Variable # v.to_s => '??a' # @return [String] # - # source://rdf//lib/rdf/query/variable.rb#288 + # source://rdf//lib/rdf/query/variable.rb#290 def to_s; end # The variable's name. @@ -8006,7 +8072,7 @@ class RDF::Query::Variable # @param term [RDF::Term] # @return [RDF::Term] # - # source://rdf//lib/rdf/query/variable.rb#269 + # source://rdf//lib/rdf/query/variable.rb#271 def var_values(var, term); end # @overload variable? @@ -8043,7 +8109,7 @@ module RDF::Queryable # @return [Enumerator] # @see Object#enum_for # - # source://rdf//lib/rdf/mixin/queryable.rb#307 + # source://rdf//lib/rdf/mixin/queryable.rb#309 def enum_for(method = T.unsafe(nil), *args); end # Queries `self` for an RDF statement matching the given `pattern` and @@ -8056,7 +8122,7 @@ module RDF::Queryable # @return [RDF::Statement] # @since 0.1.9 # - # source://rdf//lib/rdf/mixin/queryable.rb#186 + # source://rdf//lib/rdf/mixin/queryable.rb#188 def first(pattern = T.unsafe(nil)); end # Queries `self` for RDF statements matching the given `pattern` and @@ -8070,7 +8136,7 @@ module RDF::Queryable # @return [RDF::Literal] # @since 0.1.9 # - # source://rdf//lib/rdf/mixin/queryable.rb#277 + # source://rdf//lib/rdf/mixin/queryable.rb#279 def first_literal(pattern = T.unsafe(nil)); end # Queries `self` for an RDF statement matching the given `pattern` and @@ -8082,7 +8148,7 @@ module RDF::Queryable # @overload first_object # @since 0.1.9 # - # source://rdf//lib/rdf/mixin/queryable.rb#254 + # source://rdf//lib/rdf/mixin/queryable.rb#256 def first_object(pattern = T.unsafe(nil)); end # Queries `self` for an RDF statement matching the given `pattern` and @@ -8094,7 +8160,7 @@ module RDF::Queryable # @overload first_predicate # @since 0.1.9 # - # source://rdf//lib/rdf/mixin/queryable.rb#234 + # source://rdf//lib/rdf/mixin/queryable.rb#236 def first_predicate(pattern = T.unsafe(nil)); end # Queries `self` for an RDF statement matching the given `pattern` and @@ -8106,7 +8172,7 @@ module RDF::Queryable # @overload first_subject # @since 0.1.9 # - # source://rdf//lib/rdf/mixin/queryable.rb#214 + # source://rdf//lib/rdf/mixin/queryable.rb#216 def first_subject(pattern = T.unsafe(nil)); end # Queries `self` for RDF statements matching the given `pattern` and @@ -8119,7 +8185,7 @@ module RDF::Queryable # @overload first_value # @since 0.1.9 # - # source://rdf//lib/rdf/mixin/queryable.rb#298 + # source://rdf//lib/rdf/mixin/queryable.rb#300 def first_value(pattern = T.unsafe(nil)); end # Queries `self` for RDF statements matching the given `pattern`. @@ -8155,7 +8221,7 @@ module RDF::Queryable # @return [Enumerator] # @see Object#enum_for # - # source://rdf//lib/rdf/mixin/queryable.rb#307 + # source://rdf//lib/rdf/mixin/queryable.rb#309 def to_enum(method = T.unsafe(nil), *args); end protected @@ -8188,12 +8254,14 @@ module RDF::Queryable # method in order to provide for storage-specific optimized triple # pattern matching. # - # ## RDFStar (RDF*) + # ## RDF-star # # Statements may have embedded statements as either a subject or object, recursively. # # Patterns may also have embedded patterns as either a subject or object, recursively. # + # Patterns with a variable `graph_name` do not match the default graph. + # # When matching, match an embedded pattern against embedded statements, recursively. (see {RDF::Query::Pattern#eql?}) # # @param pattern [RDF::Query::Pattern] the query pattern to match @@ -8207,7 +8275,7 @@ module RDF::Queryable # @yieldparam statement [RDF::Statement] # @yieldreturn [void] ignored # - # source://rdf//lib/rdf/mixin/queryable.rb#162 + # source://rdf//lib/rdf/mixin/queryable.rb#164 def query_pattern(pattern, **options, &block); end end @@ -8290,7 +8358,7 @@ end # # This is the RDF Schema for the RDF vocabulary terms in the RDF Namespace, defined in RDF 1.1 Concepts. # -# source://rdf//lib/rdf/vocab/rdfv.rb#131 +# source://rdf//lib/rdf/vocab/rdfv.rb#139 class RDF::RDFV < ::RDF::StrictVocabulary class << self # source://rdf//lib/rdf/vocabulary.rb#264 @@ -8332,7 +8400,7 @@ class RDF::RDFV < ::RDF::StrictVocabulary # source://rdf//lib/rdf/vocabulary.rb#264 def XMLLiteral; end - # source://rdf//lib/rdf/vocab/rdfv.rb#134 + # source://rdf//lib/rdf/vocab/rdfv.rb#142 def __name__; end # source://rdf//lib/rdf/vocabulary.rb#264 @@ -8341,6 +8409,9 @@ class RDF::RDFV < ::RDF::StrictVocabulary # source://rdf//lib/rdf/vocabulary.rb#264 def datatype; end + # source://rdf//lib/rdf/vocabulary.rb#264 + def dirLangString; end + # source://rdf//lib/rdf/vocabulary.rb#264 def direction; end @@ -8356,7 +8427,7 @@ class RDF::RDFV < ::RDF::StrictVocabulary # source://rdf//lib/rdf/vocabulary.rb#264 def li; end - # source://rdf//lib/rdf/vocab/rdfv.rb#134 + # source://rdf//lib/rdf/vocab/rdfv.rb#142 def name; end # source://rdf//lib/rdf/vocabulary.rb#264 @@ -8374,6 +8445,9 @@ class RDF::RDFV < ::RDF::StrictVocabulary # source://rdf//lib/rdf/vocabulary.rb#264 def predicate; end + # source://rdf//lib/rdf/vocabulary.rb#264 + def reifies; end + # source://rdf//lib/rdf/vocabulary.rb#264 def resource; end @@ -8459,13 +8533,13 @@ class RDF::Reader # the base URI to use when resolving relative URIs (not supported by # all readers) # @param canonicalize [Boolean] (false) - # whether to canonicalize parsed literals + # whether to canonicalize parsed URIs and Literals. # @param encoding [Encoding] (Encoding::UTF_8) # the encoding of the input stream # @param intern [Boolean] (true) # whether to intern all parsed URIs # @param rdfstar [Boolean] (false) - # support parsing RDF* statement resources. + # Preliminary support for RDF 1.2. # @param prefixes [Hash] (Hash.new) # the prefix mappings to use (not supported by all readers) # @param options [Hash{Symbol => Object}] any additional options @@ -8489,12 +8563,13 @@ class RDF::Reader # source://rdf//lib/rdf/reader.rb#340 def base_uri; end - # Returns `true` if parsed values should be canonicalized. + # Returns `true` if parsed values should be in canonical form. # + # @note This is for term canonicalization, for graph/dataset canonicalization use `RDF::Normalize`. # @return [Boolean] `true` or `false` # @since 0.3.0 # - # source://rdf//lib/rdf/reader.rb#615 + # source://rdf//lib/rdf/reader.rb#617 def canonicalize?; end # Closes the input stream, after which an `IOError` will be raised for @@ -8580,7 +8655,7 @@ class RDF::Reader # @return [Boolean] `true` or `false` # @since 0.3.0 # - # source://rdf//lib/rdf/reader.rb#624 + # source://rdf//lib/rdf/reader.rb#626 def intern?; end # Current line number being processed. For formats that can associate generated {Statement} with a particular line number from input, this value reflects that line number. @@ -8750,29 +8825,29 @@ class RDF::Reader # @return [Boolean] # - # source://rdf//lib/rdf/reader.rb#676 + # source://rdf//lib/rdf/reader.rb#678 def blank?; end # @private # @return [String] The most recently read line of the input # - # source://rdf//lib/rdf/reader.rb#643 + # source://rdf//lib/rdf/reader.rb#645 def current_line; end # @param pattern [Regexp] # @return [Object] # - # source://rdf//lib/rdf/reader.rb#683 + # source://rdf//lib/rdf/reader.rb#685 def match(pattern); end # @return [String] # - # source://rdf//lib/rdf/reader.rb#649 + # source://rdf//lib/rdf/reader.rb#651 def readline; end # @return [void] # - # source://rdf//lib/rdf/reader.rb#670 + # source://rdf//lib/rdf/reader.rb#672 def strip!; end class << self @@ -8814,7 +8889,7 @@ class RDF::Reader # @private # @return [void] # - # source://rdf//lib/rdf/reader.rb#635 + # source://rdf//lib/rdf/reader.rb#637 def inherited(child); end # Parses input from the given file name or URL. @@ -8855,7 +8930,7 @@ end # The base class for RDF parsing errors. # -# source://rdf//lib/rdf/reader.rb#693 +# source://rdf//lib/rdf/reader.rb#695 class RDF::ReaderError < ::IOError # Initializes a new lexer error instance. # @@ -8864,21 +8939,21 @@ class RDF::ReaderError < ::IOError # @param lineno [Integer] (nil) # @return [ReaderError] a new instance of ReaderError # - # source://rdf//lib/rdf/reader.rb#712 + # source://rdf//lib/rdf/reader.rb#714 def initialize(message, token: T.unsafe(nil), lineno: T.unsafe(nil)); end # The line number where the error occurred. # # @return [Integer] # - # source://rdf//lib/rdf/reader.rb#704 + # source://rdf//lib/rdf/reader.rb#706 def lineno; end # The invalid token which triggered the error. # # @return [String] # - # source://rdf//lib/rdf/reader.rb#698 + # source://rdf//lib/rdf/reader.rb#700 def token; end end @@ -8983,12 +9058,12 @@ class RDF::Repository < ::RDF::Dataset # # @see RDF::Mutable#delete_insert # - # source://rdf//lib/rdf/repository.rb#197 + # source://rdf//lib/rdf/repository.rb#200 def delete_insert(deletes, inserts); end # @see RDF::Dataset#isolation_level # - # source://rdf//lib/rdf/repository.rb#217 + # source://rdf//lib/rdf/repository.rb#220 def isolation_level; end # Returns the options passed to this repository when it was constructed. @@ -9001,7 +9076,7 @@ class RDF::Repository < ::RDF::Dataset # @private # @see RDF::Enumerable#project_graph # - # source://rdf//lib/rdf/repository.rb#209 + # source://rdf//lib/rdf/repository.rb#212 def project_graph(graph_name, &block); end # A queryable snapshot of the repository for isolated reads. @@ -9010,7 +9085,7 @@ class RDF::Repository < ::RDF::Dataset # @return [Dataset] an immutable Dataset containing a current snapshot of # the Repository contents. # - # source://rdf//lib/rdf/repository.rb#226 + # source://rdf//lib/rdf/repository.rb#229 def snapshot; end # Returns `true` if this respository supports the given `feature`. @@ -9054,7 +9129,7 @@ class RDF::Repository < ::RDF::Dataset # @see RDF::Transactable#begin_transaction # @since 0.3.0 # - # source://rdf//lib/rdf/repository.rb#236 + # source://rdf//lib/rdf/repository.rb#239 def begin_transaction(mutable: T.unsafe(nil), graph_name: T.unsafe(nil)); end class << self @@ -9079,64 +9154,64 @@ RDF::Repository::DEFAULT_TX_CLASS = RDF::Transaction # # @see RDF::Repository # -# source://rdf//lib/rdf/repository.rb#245 +# source://rdf//lib/rdf/repository.rb#248 module RDF::Repository::Implementation # @see Mutable#apply_changeset # - # source://rdf//lib/rdf/repository.rb#369 + # source://rdf//lib/rdf/repository.rb#374 def apply_changeset(changeset); end # @private # @see RDF::Countable#count # - # source://rdf//lib/rdf/repository.rb#281 + # source://rdf//lib/rdf/repository.rb#286 def count; end # @private # @see RDF::Enumerable#each_statement # - # source://rdf//lib/rdf/repository.rb#351 + # source://rdf//lib/rdf/repository.rb#356 def each(&block); end # @private # @see RDF::Enumerable#each_graph # - # source://rdf//lib/rdf/repository.rb#321 + # source://rdf//lib/rdf/repository.rb#326 def each_graph(&block); end # @private # @see RDF::Enumerable#each_statement # - # source://rdf//lib/rdf/repository.rb#351 + # source://rdf//lib/rdf/repository.rb#356 def each_statement(&block); end # @overload graph? # @overload graph? # - # source://rdf//lib/rdf/repository.rb#302 + # source://rdf//lib/rdf/repository.rb#307 def graph?(*args); end # @private # @see RDF::Enumerable#each_graph # - # source://rdf//lib/rdf/repository.rb#314 + # source://rdf//lib/rdf/repository.rb#319 def graph_names(options = T.unsafe(nil), &block); end # @overload graph? # @overload graph? # - # source://rdf//lib/rdf/repository.rb#302 + # source://rdf//lib/rdf/repository.rb#307 def has_graph?(*args); end # @overload statement? # @overload statement? # - # source://rdf//lib/rdf/repository.rb#339 + # source://rdf//lib/rdf/repository.rb#344 def has_statement?(*args); end # @see RDF::Dataset#isolation_level # - # source://rdf//lib/rdf/repository.rb#385 + # source://rdf//lib/rdf/repository.rb#390 def isolation_level; end # A readable & queryable snapshot of the repository for isolated reads. @@ -9145,20 +9220,20 @@ module RDF::Repository::Implementation # the Repository contents. # @see Mutable#snapshot # - # source://rdf//lib/rdf/repository.rb#396 + # source://rdf//lib/rdf/repository.rb#401 def snapshot; end # @overload statement? # @overload statement? # - # source://rdf//lib/rdf/repository.rb#339 + # source://rdf//lib/rdf/repository.rb#344 def statement?(*args); end # @private # @return [Boolean] # @see RDF::Enumerable#supports? # - # source://rdf//lib/rdf/repository.rb#266 + # source://rdf//lib/rdf/repository.rb#269 def supports?(feature); end protected @@ -9166,31 +9241,31 @@ module RDF::Repository::Implementation # @private # @see RDF::Mutable#clear # - # source://rdf//lib/rdf/repository.rb#475 + # source://rdf//lib/rdf/repository.rb#480 def clear_statements; end # @private # @return [Hamster::Hash] # - # source://rdf//lib/rdf/repository.rb#482 + # source://rdf//lib/rdf/repository.rb#487 def data; end # @private # @return [Hamster::Hash] # - # source://rdf//lib/rdf/repository.rb#489 + # source://rdf//lib/rdf/repository.rb#494 def data=(hash); end # @private # @see RDF::Mutable#delete # - # source://rdf//lib/rdf/repository.rb#468 + # source://rdf//lib/rdf/repository.rb#473 def delete_statement(statement); end # @private # @see RDF::Mutable#insert # - # source://rdf//lib/rdf/repository.rb#461 + # source://rdf//lib/rdf/repository.rb#466 def insert_statement(statement); end # Match elements with `eql?`, not `==` @@ -9201,7 +9276,7 @@ module RDF::Repository::Implementation # @private # @see RDF::Queryable#query_pattern # - # source://rdf//lib/rdf/repository.rb#410 + # source://rdf//lib/rdf/repository.rb#415 def query_pattern(pattern, **options, &block); end private @@ -9209,44 +9284,44 @@ module RDF::Repository::Implementation # @private # @return [Hamster::Hash] a new, updated hamster hash # - # source://rdf//lib/rdf/repository.rb#530 + # source://rdf//lib/rdf/repository.rb#535 def delete_from(data, statement); end # @private # @return [Boolean] # @see #statement? # - # source://rdf//lib/rdf/repository.rb#498 + # source://rdf//lib/rdf/repository.rb#503 def has_statement_in?(data, statement); end # @private # @raise [ArgumentError] # @return [Hamster::Hash] a new, updated hamster hash # - # source://rdf//lib/rdf/repository.rb#512 + # source://rdf//lib/rdf/repository.rb#517 def insert_to(data, statement); end # @private # @return [Boolean] # @see #statement? # - # source://rdf//lib/rdf/repository.rb#498 + # source://rdf//lib/rdf/repository.rb#503 def statement_in?(data, statement); end class << self # @private # - # source://rdf//lib/rdf/repository.rb#254 + # source://rdf//lib/rdf/repository.rb#257 def extend_object(obj); end end end -# source://rdf//lib/rdf/repository.rb#246 +# source://rdf//lib/rdf/repository.rb#249 RDF::Repository::Implementation::DEFAULT_GRAPH = T.let(T.unsafe(nil), FalseClass) # @deprecated moved to {RDF::Transaction::SerializedTransaction} # -# source://rdf//lib/rdf/repository.rb#250 +# source://rdf//lib/rdf/repository.rb#253 RDF::Repository::Implementation::SerializedTransaction = RDF::Transaction::SerializedTransaction # An RDF resource. @@ -9307,7 +9382,7 @@ class RDF::Statement # @overload initialize # @return [Statement] a new instance of Statement # - # source://rdf//lib/rdf/model/statement.rb#89 + # source://rdf//lib/rdf/model/statement.rb#91 def initialize(subject = T.unsafe(nil), predicate = T.unsafe(nil), object = T.unsafe(nil), options = T.unsafe(nil)); end # Checks statement equality as a triple. @@ -9319,7 +9394,7 @@ class RDF::Statement # @see RDF::Literal#== # @see RDF::Query::Variable#== # - # source://rdf//lib/rdf/model/statement.rb#325 + # source://rdf//lib/rdf/model/statement.rb#335 def ==(other); end # Checks statement equality with patterns. @@ -9347,25 +9422,25 @@ class RDF::Statement # @see RDF::Literal#eql? # @see RDF::Query::Variable#eql? # - # source://rdf//lib/rdf/model/statement.rb#357 + # source://rdf//lib/rdf/model/statement.rb#367 def ===(other); end # @param index [Integer] # @return [RDF::Term] # - # source://rdf//lib/rdf/model/statement.rb#368 + # source://rdf//lib/rdf/model/statement.rb#378 def [](index); end # @param index [Integer] # @param value [RDF::Term] # @return [RDF::Term] # - # source://rdf//lib/rdf/model/statement.rb#382 + # source://rdf//lib/rdf/model/statement.rb#392 def []=(index, value); end # @return [Boolean] # - # source://rdf//lib/rdf/model/statement.rb#207 + # source://rdf//lib/rdf/model/statement.rb#210 def asserted?; end # Returns a version of the statement with each position in canonical form @@ -9373,16 +9448,16 @@ class RDF::Statement # @return [RDF::Statement] `self` or nil if statement cannot be canonicalized # @since 1.0.8 # - # source://rdf//lib/rdf/model/statement.rb#433 + # source://rdf//lib/rdf/model/statement.rb#443 def canonicalize; end - # Canonicalizes each unfrozen term in the statement + # Canonicalizes each unfrozen term in the statement. # # @raise [ArgumentError] if any element cannot be canonicalized. # @return [RDF::Statement] `self` # @since 1.0.8 # - # source://rdf//lib/rdf/model/statement.rb#418 + # source://rdf//lib/rdf/model/statement.rb#428 def canonicalize!; end # Determines if the statement is complete, vs. invalid. A complete statement is one in which none of `subject`, `predicate`, or `object`, are nil. @@ -9390,14 +9465,23 @@ class RDF::Statement # @return [Boolean] # @since 3.0 # - # source://rdf//lib/rdf/model/statement.rb#237 + # source://rdf//lib/rdf/model/statement.rb#247 def complete?; end + # New statement with duplicated components (other than blank nodes) + # + # @return [RDF::Statement] + # + # source://rdf//lib/rdf/model/statement.rb#452 + def dup; end + # Returns `true` if any element of the statement is, itself, a statement. # + # Note: Nomenclature is evolving, alternatives could include `#complex?` and `#nested?` + # # @return [Boolean] # - # source://rdf//lib/rdf/model/statement.rb#186 + # source://rdf//lib/rdf/model/statement.rb#189 def embedded?; end # Checks statement equality as a quad. @@ -9409,13 +9493,13 @@ class RDF::Statement # @see RDF::Literal#== # @see RDF::Query::Variable#== # - # source://rdf//lib/rdf/model/statement.rb#305 + # source://rdf//lib/rdf/model/statement.rb#315 def eql?(other); end # @overload graph? # @overload graph? # - # source://rdf//lib/rdf/model/statement.rb#252 + # source://rdf//lib/rdf/model/statement.rb#262 def graph?(*args); end # @return [RDF::Resource] @@ -9434,39 +9518,39 @@ class RDF::Statement # @return [Boolean] # @since 2.0 # - # source://rdf//lib/rdf/model/statement.rb#290 + # source://rdf//lib/rdf/model/statement.rb#300 def has_blank_nodes?; end # @overload graph? # @overload graph? # - # source://rdf//lib/rdf/model/statement.rb#252 + # source://rdf//lib/rdf/model/statement.rb#262 def has_graph?(*args); end # @overload graph? # @overload graph? # - # source://rdf//lib/rdf/model/statement.rb#252 + # source://rdf//lib/rdf/model/statement.rb#262 def has_name?(*args); end # @return [Boolean] # - # source://rdf//lib/rdf/model/statement.rb#279 + # source://rdf//lib/rdf/model/statement.rb#289 def has_object?; end # @return [Boolean] # - # source://rdf//lib/rdf/model/statement.rb#272 + # source://rdf//lib/rdf/model/statement.rb#282 def has_predicate?; end # @return [Boolean] # - # source://rdf//lib/rdf/model/statement.rb#265 + # source://rdf//lib/rdf/model/statement.rb#275 def has_subject?; end # Generates a Integer hash value as a quad. # - # source://rdf//lib/rdf/model/statement.rb#311 + # source://rdf//lib/rdf/model/statement.rb#321 def hash; end # @return [Object] @@ -9484,28 +9568,28 @@ class RDF::Statement # @return [Boolean] # @since 3.0 # - # source://rdf//lib/rdf/model/statement.rb#228 + # source://rdf//lib/rdf/model/statement.rb#238 def incomplete?; end # @return [Boolean] # - # source://rdf//lib/rdf/model/statement.rb#219 + # source://rdf//lib/rdf/model/statement.rb#229 def inferred?; end # @private # - # source://rdf//lib/rdf/model/statement.rb#108 + # source://rdf//lib/rdf/model/statement.rb#110 def initialize!; end # @return [Boolean] # - # source://rdf//lib/rdf/model/statement.rb#192 + # source://rdf//lib/rdf/model/statement.rb#195 def invalid?; end # @overload graph? # @overload graph? # - # source://rdf//lib/rdf/model/statement.rb#252 + # source://rdf//lib/rdf/model/statement.rb#262 def name?(*args); end # Returns `true` if any resource of this statement is a blank node @@ -9514,7 +9598,7 @@ class RDF::Statement # @return [Boolean] # @since 2.0 # - # source://rdf//lib/rdf/model/statement.rb#290 + # source://rdf//lib/rdf/model/statement.rb#300 def node?; end # @return [RDF::Term] @@ -9529,7 +9613,7 @@ class RDF::Statement # @return [Boolean] # - # source://rdf//lib/rdf/model/statement.rb#279 + # source://rdf//lib/rdf/model/statement.rb#289 def object?; end # @return [Hash{Symbol => Object}] @@ -9554,12 +9638,13 @@ class RDF::Statement # @return [Boolean] # - # source://rdf//lib/rdf/model/statement.rb#272 + # source://rdf//lib/rdf/model/statement.rb#282 def predicate?; end + # @deprecated Quoted triples are now deprecated # @return [Boolean] # - # source://rdf//lib/rdf/model/statement.rb#213 + # source://rdf//lib/rdf/model/statement.rb#223 def quoted?; end # Returns a graph containing this statement in reified form. @@ -9573,13 +9658,13 @@ class RDF::Statement # @return [RDF::Graph] # @see http://www.w3.org/TR/rdf-primer/#reification # - # source://rdf//lib/rdf/model/statement.rb#477 + # source://rdf//lib/rdf/model/statement.rb#499 def reified(subject: T.unsafe(nil), id: T.unsafe(nil), graph_name: T.unsafe(nil)); end # @overload statement? # @overload statement? # - # source://rdf//lib/rdf/model/statement.rb#150 + # source://rdf//lib/rdf/model/statement.rb#152 def statement?(*args); end # @return [RDF::Resource] @@ -9594,19 +9679,19 @@ class RDF::Statement # @return [Boolean] # - # source://rdf//lib/rdf/model/statement.rb#265 + # source://rdf//lib/rdf/model/statement.rb#275 def subject?; end # Returns an array of all the non-nil non-statement terms. # # @return [Array(RDF::Term)] # - # source://rdf//lib/rdf/model/statement.rb#408 + # source://rdf//lib/rdf/model/statement.rb#418 def terms; end # @return [Array(RDF::Term)] # - # source://rdf//lib/rdf/model/statement.rb#400 + # source://rdf//lib/rdf/model/statement.rb#410 def to_a; end # Returns the terms of this statement as a `Hash`. @@ -9616,29 +9701,34 @@ class RDF::Statement # @param object_key [Symbol] # @return [Hash{Symbol => RDF::Term}] # - # source://rdf//lib/rdf/model/statement.rb#446 + # source://rdf//lib/rdf/model/statement.rb#468 def to_h(subject_key = T.unsafe(nil), predicate_key = T.unsafe(nil), object_key = T.unsafe(nil), graph_key = T.unsafe(nil)); end # @return [Array(RDF::Term)] # - # source://rdf//lib/rdf/model/statement.rb#394 + # source://rdf//lib/rdf/model/statement.rb#404 def to_quad; end # Returns a string representation of this statement. # # @return [String] # - # source://rdf//lib/rdf/model/statement.rb#454 + # source://rdf//lib/rdf/model/statement.rb#476 def to_s; end # @return [Array(RDF::Term)] # - # source://rdf//lib/rdf/model/statement.rb#400 + # source://rdf//lib/rdf/model/statement.rb#410 def to_triple; end # @return [Boolean] # - # source://rdf//lib/rdf/model/statement.rb#198 + # source://rdf//lib/rdf/model/statement.rb#216 + def tripleTerm?; end + + # @return [Boolean] + # + # source://rdf//lib/rdf/model/statement.rb#201 def valid?; end # URI, Node or Literal. @@ -9648,7 +9738,7 @@ class RDF::Statement # @overload variable? # @overload variable? # - # source://rdf//lib/rdf/model/statement.rb#169 + # source://rdf//lib/rdf/model/statement.rb#171 def variable?(*args); end class << self @@ -10433,7 +10523,7 @@ class RDF::URI # @param level [Integer] The maximum depth of objects to dump. # @return [String] The dump of data needed to reconsitute this object. # - # source://rdf//lib/rdf/model/uri.rb#1331 + # source://rdf//lib/rdf/model/uri.rb#1332 def _dump(level); end # A URI is absolute when it has a scheme @@ -10852,7 +10942,7 @@ class RDF::URI # # => "flag&key=value" # @param value [Hash, #to_hash, Array] The new query values. # - # source://rdf//lib/rdf/model/uri.rb#1284 + # source://rdf//lib/rdf/model/uri.rb#1285 def query_values=(value); end # A URI is relative when it does not have a scheme @@ -10875,7 +10965,7 @@ class RDF::URI # # @return [String] The request URI required for an HTTP request. # - # source://rdf//lib/rdf/model/uri.rb#1318 + # source://rdf//lib/rdf/model/uri.rb#1319 def request_uri; end # Returns a copy of this URI with the path component set to `/`. @@ -11035,10 +11125,10 @@ class RDF::URI private - # source://rdf//lib/rdf/model/uri.rb#1371 + # source://rdf//lib/rdf/model/uri.rb#1372 def format_authority; end - # source://rdf//lib/rdf/model/uri.rb#1363 + # source://rdf//lib/rdf/model/uri.rb#1364 def format_userinfo(append = T.unsafe(nil)); end # Normalize a segment using a character range @@ -11048,7 +11138,7 @@ class RDF::URI # @param downcase [Boolean] # @return [String] # - # source://rdf//lib/rdf/model/uri.rb#1354 + # source://rdf//lib/rdf/model/uri.rb#1355 def normalize_segment(value, expr, downcase = T.unsafe(nil)); end class << self @@ -11058,7 +11148,7 @@ class RDF::URI # @param data [String] The dump of data needed to reconsitute this object. # @return [RDF::URI] The reconsituted object. # - # source://rdf//lib/rdf/model/uri.rb#1341 + # source://rdf//lib/rdf/model/uri.rb#1342 def _load(data); end # Cache size may be set through {RDF.config} using `uri_cache_size`. @@ -11072,13 +11162,13 @@ class RDF::URI # URI decode escape sequences in value # From URI gem, as this is now generally deprecated # - # source://rdf//lib/rdf/model/uri.rb#1394 + # source://rdf//lib/rdf/model/uri.rb#1395 def decode(str); end # URI encode matching characters in value # From URI gem, as this is now generally deprecated # - # source://rdf//lib/rdf/model/uri.rb#1381 + # source://rdf//lib/rdf/model/uri.rb#1382 def encode(str, expr); end # Returns an interned `RDF::URI` instance based on the given `uri` @@ -11456,7 +11546,7 @@ class RDF::Util::Cache::ObjectSpaceCache < ::RDF::Util::Cache end # This implementation uses the `WeakRef` class from Ruby's standard -# library, and provides adequate performance on JRuby and on Ruby 2.x. +# library, and provides adequate performance on JRuby and on Ruby 3.x. # # @see http://ruby-doc.org/stdlib-2.2.0/libdoc/weakref/rdoc/WeakRef.html # @since 0.2.0 @@ -11992,680 +12082,680 @@ end # # source://rdf//lib/rdf/util/logger.rb#0 class RDF::Util::Logger::IOWrapper - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def <<(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def <=>(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#402 + # source://delegate/0.3.1/delegate.rb#402 def __getobj__; end - # source://delegate/0.3.0/delegate.rb#409 + # source://delegate/0.3.1/delegate.rb#409 def __setobj__(obj); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def abort(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def acts_like?(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def advise(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def all?(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def any?(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def as_json(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def autoclose=(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def autoclose?(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def beep(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def binmode(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def binmode?(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def blank?(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def chain(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def check_winsize_changed(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def chunk(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def chunk_while(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def clear_screen(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def close(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def close_on_exec=(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def close_on_exec?(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def close_read(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def close_write(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def closed?(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def collect(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def collect_concat(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def compact(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def compact_blank(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def console_mode(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def console_mode=(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def cooked(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def cooked!(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def count(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def cursor(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def cursor=(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def cursor_down(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def cursor_left(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def cursor_right(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def cursor_up(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def cycle(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def deep_dup(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def detect(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def drop(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def drop_while(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def duplicable?(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def each(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def each_byte(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def each_char(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def each_codepoint(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def each_cons(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def each_entry(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def each_line(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def each_slice(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def each_with_index(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def each_with_object(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def echo=(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def echo?(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def entries(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def eof(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def eof?(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def erase_line(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def erase_screen(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def exclude?(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def excluding(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def exit(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def external_encoding(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def fcntl(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def fdatasync(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def fileno(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def filter(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def filter_map(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def find(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def find_all(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def find_index(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def first(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def flat_map(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def flush(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def fsync(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def getbyte(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def getc(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def getch(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def getpass(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def gets(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def goto(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def goto_column(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def grep(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def grep_v(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def group_by(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def hash(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def html_safe?(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def iflush(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def in?(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def in_order_of(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def include?(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def including(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def index_by(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def index_with(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def inject(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def instance_values(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def instance_variable_names(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def internal_encoding(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def ioctl(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def ioflush(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def isatty(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def lazy(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def lineno(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def lineno=(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def many?(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def map(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def max(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def max_by(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def maximum(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def member?(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def min(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def min_by(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def minimum(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def minmax(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def minmax_by(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def noecho(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def nonblock(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def nonblock=(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def nonblock?(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def none?(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def nread(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def oflush(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def one?(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def partition(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def path(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def pathconf(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def pick(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def pid(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def pluck(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def pos(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def pos=(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def pread(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def presence(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def presence_in(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def present?(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def pressed?(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def pretty_print(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def pretty_print_cycle(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def pretty_print_inspect(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def pretty_print_instance_variables(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def print(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def printf(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def putc(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def puts(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def pwrite(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def raw(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def raw!(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def read(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def read_nonblock(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def readbyte(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def readchar(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def readline(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def readlines(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def readpartial(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def ready?(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def reduce(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def reject(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def reopen(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def require_dependency(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def reverse_each(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def rewind(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def scroll_backward(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def scroll_forward(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def seek(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def select(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def set_encoding(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def set_encoding_by_bom(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def slice_after(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def slice_before(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def slice_when(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def sole(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def sort(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def sort_by(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def stat(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def sum(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def sync(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def sync=(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def sysread(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def sysseek(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def syswrite(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def take(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def take_while(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def tally(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def tell(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def timeout(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def timeout=(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def to_a(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def to_h(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def to_i(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def to_io(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def to_json(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def to_param(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def to_path(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def to_query(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def to_set(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def to_yaml(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def try(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def try!(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def tty?(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def ungetbyte(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def ungetc(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def uniq(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def wait(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def wait_priority(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def wait_readable(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def wait_writable(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def winsize(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def winsize=(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def with_options(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def without(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def write(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def write_nonblock(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def zeitwerk_original_require(*args, **_arg1, &block); end - # source://delegate/0.3.0/delegate.rb#347 + # source://delegate/0.3.1/delegate.rb#347 def zip(*args, **_arg1, &block); end class << self - # source://delegate/0.3.0/delegate.rb#436 + # source://delegate/0.3.1/delegate.rb#436 def instance_method(name); end - # source://delegate/0.3.0/delegate.rb#427 + # source://delegate/0.3.1/delegate.rb#427 def instance_methods(all = T.unsafe(nil)); end - # source://delegate/0.3.0/delegate.rb#424 + # source://delegate/0.3.1/delegate.rb#424 def protected_instance_methods(all = T.unsafe(nil)); end - # source://delegate/0.3.0/delegate.rb#430 + # source://delegate/0.3.1/delegate.rb#430 def public_instance_method(name); end - # source://delegate/0.3.0/delegate.rb#421 + # source://delegate/0.3.1/delegate.rb#421 def public_instance_methods(all = T.unsafe(nil)); end end end @@ -12808,7 +12898,7 @@ module RDF::Value # @return [RDF::Value] # @since 1.0.8 # - # source://rdf//lib/rdf/model/value.rb#222 + # source://rdf//lib/rdf/model/value.rb#223 def canonicalize; end # Converts this value into its canonical representation. @@ -12818,7 +12908,7 @@ module RDF::Value # @return [RDF::Value] `self` # @since 1.0.8 # - # source://rdf//lib/rdf/model/value.rb#233 + # source://rdf//lib/rdf/model/value.rb#234 def canonicalize!; end # Is this constant, or are all of its components constant? @@ -12844,14 +12934,14 @@ module RDF::Value # # @return [String] # - # source://rdf//lib/rdf/model/value.rb#260 + # source://rdf//lib/rdf/model/value.rb#261 def inspect; end # Outputs a developer-friendly representation of `self` to `stderr`. # # @return [void] # - # source://rdf//lib/rdf/model/value.rb#268 + # source://rdf//lib/rdf/model/value.rb#269 def inspect!; end # Is this value invalid, or is it composed of any invalid components? @@ -12899,33 +12989,35 @@ module RDF::Value # source://rdf//lib/rdf/model/value.rb#95 def resource?; end - # Returns `true` if this Value starts with the given `string`. + # Returns `true` if this Value starts with any of the given strings. # # @example # RDF::URI('http://example.org/').start_with?('http') #=> true # RDF::Node('_:foo').start_with?('_:bar') #=> false # RDF::Litera('Apple').start_with?('Orange') #=> false - # @param string [String, #to_s] + # RDF::Litera('Apple').start_with?('Orange', 'Apple') #=> true + # @param *args [Array<#to_s>] Any number of strings to check against. # @return [Boolean] `true` or `false` # @see String#start_with? # @since 0.3.0 # - # source://rdf//lib/rdf/model/value.rb#211 - def start_with?(string); end + # source://rdf//lib/rdf/model/value.rb#212 + def start_with?(*args); end - # Returns `true` if this Value starts with the given `string`. + # Returns `true` if this Value starts with any of the given strings. # # @example # RDF::URI('http://example.org/').start_with?('http') #=> true # RDF::Node('_:foo').start_with?('_:bar') #=> false # RDF::Litera('Apple').start_with?('Orange') #=> false - # @param string [String, #to_s] + # RDF::Litera('Apple').start_with?('Orange', 'Apple') #=> true + # @param *args [Array<#to_s>] Any number of strings to check against. # @return [Boolean] `true` or `false` # @see String#start_with? # @since 0.3.0 # - # source://rdf//lib/rdf/model/value.rb#211 - def starts_with?(string); end + # source://rdf//lib/rdf/model/value.rb#212 + def starts_with?(*args); end # @overload statement? # @overload statement? @@ -12958,14 +13050,14 @@ module RDF::Value # @return [String] # @since 0.2.1 # - # source://rdf//lib/rdf/ntriples.rb#100 + # source://rdf//lib/rdf/ntriples.rb#104 def to_ntriples; end # Returns an `RDF::Value` representation of `self`. # # @return [RDF::Value] # - # source://rdf//lib/rdf/model/value.rb#241 + # source://rdf//lib/rdf/model/value.rb#242 def to_rdf; end # Returns an `RDF::Term` representation of `self`. @@ -12973,7 +13065,7 @@ module RDF::Value # @raise [NotImplementedError] # @return [RDF::Value] # - # source://rdf//lib/rdf/model/value.rb#249 + # source://rdf//lib/rdf/model/value.rb#250 def to_term; end # Default implementation of `type_error`, which returns false. @@ -12982,7 +13074,7 @@ module RDF::Value # # @return [false] # - # source://rdf//lib/rdf/model/value.rb#278 + # source://rdf//lib/rdf/model/value.rb#279 def type_error(message); end # Is this an {RDF::URI}? @@ -13914,7 +14006,7 @@ module RDF::Writable # @raise [ArgumentError] on an attempt to insert an embedded statement when it is not supported # @return [void] # - # source://rdf//lib/rdf/mixin/writable.rb#149 + # source://rdf//lib/rdf/mixin/writable.rb#153 def insert_statement(statement); end # Inserts the given RDF statements into the underlying storage or output @@ -14015,12 +14107,13 @@ class RDF::Writer # source://rdf//lib/rdf/writer.rb#316 def base_uri; end - # Returns `true` if terms should be canonicalized. + # Returns `true` if terms should be in canonical form. # + # @note This is for term canonicalization, for graph/dataset canonicalization use `RDF::Normalize`. # @return [Boolean] `true` or `false` # @since 1.0.8 # - # source://rdf//lib/rdf/writer.rb#399 + # source://rdf//lib/rdf/writer.rb#401 def canonicalize?; end # Returns the encoding of the output stream. @@ -14034,7 +14127,7 @@ class RDF::Writer # # @return [self] # - # source://rdf//lib/rdf/writer.rb#407 + # source://rdf//lib/rdf/writer.rb#409 def flush; end # Flushes the underlying output buffer. @@ -14050,7 +14143,7 @@ class RDF::Writer # @return [String] # @since 0.2.3 # - # source://rdf//lib/rdf/writer.rb#562 + # source://rdf//lib/rdf/writer.rb#565 def format_list(value, **options); end # @abstract @@ -14059,7 +14152,7 @@ class RDF::Writer # @raise [NotImplementedError] unless implemented in subclass # @return [String] # - # source://rdf//lib/rdf/writer.rb#552 + # source://rdf//lib/rdf/writer.rb#555 def format_literal(value, **options); end # @abstract @@ -14069,12 +14162,13 @@ class RDF::Writer # @raise [NotImplementedError] unless implemented in subclass # @return [String] # - # source://rdf//lib/rdf/writer.rb#532 + # source://rdf//lib/rdf/writer.rb#535 def format_node(value, **options); end - # Formats a referenced triple. + # Formats a referenced quoted triple. # # @abstract + # @deprecated Quoted Triples are now deprecated in favor of Triple Terms # @example # <<

>>

. # @param value [RDF::Statement] @@ -14082,23 +14176,36 @@ class RDF::Writer # @raise [NotImplementedError] unless implemented in subclass # @return [String] # - # source://rdf//lib/rdf/writer.rb#577 + # source://rdf//lib/rdf/writer.rb#596 def format_quotedTriple(value, **options); end # @param term [RDF::Term] # @return [String] # @since 0.3.0 # - # source://rdf//lib/rdf/writer.rb#512 + # source://rdf//lib/rdf/writer.rb#514 def format_term(term, **options); end + # Formats a referenced triple term. + # + # @abstract + # @example + # <<

>>

. + # @param value [RDF::Statement] + # @param options [Hash{Symbol => Object}] = ({}) + # @raise [NotImplementedError] unless implemented in subclass + # @return [String] + # + # source://rdf//lib/rdf/writer.rb#580 + def format_tripleTerm(value, **options); end + # @abstract # @param value [RDF::URI] # @param options [Hash{Symbol => Object}] = ({}) # @raise [NotImplementedError] unless implemented in subclass # @return [String] # - # source://rdf//lib/rdf/writer.rb#542 + # source://rdf//lib/rdf/writer.rb#545 def format_uri(value, **options); end # Add a statement to the writer. This will check to ensure that the statement is complete (no nil terms) and is valid, if the `:validation` option is set. @@ -14189,20 +14296,20 @@ class RDF::Writer # @param text [String] # @return [self] # - # source://rdf//lib/rdf/writer.rb#436 + # source://rdf//lib/rdf/writer.rb#438 def write_comment(text); end # @abstract # @raise [RDF::WriterError] if errors logged during processing. # @return [self] # - # source://rdf//lib/rdf/writer.rb#425 + # source://rdf//lib/rdf/writer.rb#427 def write_epilogue; end # @abstract # @return [self] # - # source://rdf//lib/rdf/writer.rb#416 + # source://rdf//lib/rdf/writer.rb#418 def write_prologue; end # Add a statement to the writer. This will check to ensure that the statement is complete (no nil terms) and is valid, if the `:validation` option is set. @@ -14213,7 +14320,7 @@ class RDF::Writer # @param statement [RDF::Statement] # @return [self] # - # source://rdf//lib/rdf/writer.rb#448 + # source://rdf//lib/rdf/writer.rb#450 def write_statement(statement); end # @abstract @@ -14224,14 +14331,14 @@ class RDF::Writer # @raise [NotImplementedError] unless implemented in subclass # @return [self] # - # source://rdf//lib/rdf/writer.rb#504 + # source://rdf//lib/rdf/writer.rb#506 def write_triple(subject, predicate, object); end # @note logs error if attempting to write an invalid {RDF::Statement} or if canonicalizing a statement which cannot be canonicalized. # @param triples [Array] # @return [self] # - # source://rdf//lib/rdf/writer.rb#491 + # source://rdf//lib/rdf/writer.rb#493 def write_triples(*triples); end protected @@ -14239,29 +14346,29 @@ class RDF::Writer # @param string [String] # @return [String] # - # source://rdf//lib/rdf/writer.rb#612 + # source://rdf//lib/rdf/writer.rb#631 def escaped(string); end # @return [String] # - # source://rdf//lib/rdf/writer.rb#605 + # source://rdf//lib/rdf/writer.rb#624 def node_id; end # @return [void] # - # source://rdf//lib/rdf/writer.rb#585 + # source://rdf//lib/rdf/writer.rb#604 def puts(*args); end # @param string [String] # @return [String] # - # source://rdf//lib/rdf/writer.rb#625 + # source://rdf//lib/rdf/writer.rb#644 def quoted(string); end # @param term [RDF::Resource] # @return [String] # - # source://rdf//lib/rdf/writer.rb#592 + # source://rdf//lib/rdf/writer.rb#611 def uri_for(term); end class << self @@ -14336,7 +14443,7 @@ class RDF::Writer # @private # @return [void] # - # source://rdf//lib/rdf/writer.rb#636 + # source://rdf//lib/rdf/writer.rb#655 def inherited(child); end # Writes output to the given `filename`. @@ -14367,7 +14474,7 @@ end # The base class for RDF serialization errors. # -# source://rdf//lib/rdf/writer.rb#644 +# source://rdf//lib/rdf/writer.rb#663 class RDF::WriterError < ::IOError; end # Vocabulary for diff --git a/sorbet/rbi/gems/recaptcha@5.14.0.rbi b/sorbet/rbi/gems/recaptcha@5.17.0.rbi similarity index 99% rename from sorbet/rbi/gems/recaptcha@5.14.0.rbi rename to sorbet/rbi/gems/recaptcha@5.17.0.rbi index 7045c138f..0b2c60b10 100644 --- a/sorbet/rbi/gems/recaptcha@5.14.0.rbi +++ b/sorbet/rbi/gems/recaptcha@5.17.0.rbi @@ -13,11 +13,11 @@ module Recaptcha # source://recaptcha//lib/recaptcha.rb#125 def action_valid?(action, expected_action); end - # source://recaptcha//lib/recaptcha.rb#163 + # source://recaptcha//lib/recaptcha.rb#170 def api_verification_enterprise(query_params, body, project_id, timeout: T.unsafe(nil)); end # source://recaptcha//lib/recaptcha.rb#155 - def api_verification_free(verify_hash, timeout: T.unsafe(nil)); end + def api_verification_free(verify_hash, timeout: T.unsafe(nil), json: T.unsafe(nil)); end # Gives access to the current Configuration. # diff --git a/sorbet/rbi/gems/responders@3.1.0.rbi b/sorbet/rbi/gems/responders@3.1.1.rbi similarity index 100% rename from sorbet/rbi/gems/responders@3.1.0.rbi rename to sorbet/rbi/gems/responders@3.1.1.rbi diff --git a/sorbet/rbi/gems/rgeo-shapefile@3.0.0.rbi b/sorbet/rbi/gems/rgeo-shapefile@3.1.0.rbi similarity index 84% rename from sorbet/rbi/gems/rgeo-shapefile@3.0.0.rbi rename to sorbet/rbi/gems/rgeo-shapefile@3.1.0.rbi index 024c52242..43f0c5d45 100644 --- a/sorbet/rbi/gems/rgeo-shapefile@3.0.0.rbi +++ b/sorbet/rbi/gems/rgeo-shapefile@3.1.0.rbi @@ -110,37 +110,39 @@ module RGeo::Shapefile; end # # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#94 class RGeo::Shapefile::Reader + include ::Enumerable + # Low-level creation of a Reader. The arguments are the same as # those passed to Reader::open, except that this doesn't take a # block. You should use Reader::open instead. # # @return [Reader] a new instance of Reader # - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#177 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#178 def initialize(path_, opts_ = T.unsafe(nil)); end # Get the given record number. Equivalent to seeking to that index # and calling next. # - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#375 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#399 def [](index_); end - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#650 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#676 def _read_multipatch(data_); end - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#431 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#455 def _read_multipoint(data_, opt_ = T.unsafe(nil)); end - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#380 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#404 def _read_next_record; end - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#413 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#437 def _read_point(data_, opt_ = T.unsafe(nil)); end - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#509 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#533 def _read_polygon(data_, opt_ = T.unsafe(nil)); end - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#466 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#490 def _read_polyline(data_, opt_ = T.unsafe(nil)); end # Returns true if attributes are available. This may be false @@ -149,58 +151,60 @@ class RGeo::Shapefile::Reader # # @return [Boolean] # - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#256 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#270 def attributes_available?; end # Close the shapefile. # You should not use this Reader after it has been closed. # Most methods will return nil. # - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#237 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#251 def close; end # Returns the current file pointer as a record index (0-based). # This is the record number that will be read when Reader#next # is called. # - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#331 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#346 def cur_index; end # Read the remaining records starting with the current record index, # and yield the Reader::Record for each one. # - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#344 + # @raise [IOError] + # + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#359 def each; end # Returns the factory used by this reader. # - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#262 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#276 def factory; end # Get the given record number. Equivalent to seeking to that index # and calling next. # - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#375 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#399 def get(index_); end # Returns the maximum m, or nil if the shapefile does not contain m. # - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#323 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#338 def mmax; end # Returns the minimum m, or nil if the shapefile does not contain m. # - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#317 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#332 def mmin; end # Read and return the next record as a Reader::Record. # - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#337 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#352 def next; end # Returns the number of records in the shapefile. # - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#268 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#282 def num_records; end # Returns true if this Reader is still open, or false if it has @@ -208,58 +212,58 @@ class RGeo::Shapefile::Reader # # @return [Boolean] # - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#248 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#262 def open?; end # Rewind to the beginning of the file. # Equivalent to seek_index(0). # - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#368 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#392 def rewind; end # Seek to the given record index. # - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#351 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#375 def seek_index(index_); end # Returns the shape type code. # - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#275 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#290 def shape_type_code; end # Returns the number of records in the shapefile. # - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#268 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#282 def size; end # Returns the maximum x. # - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#287 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#302 def xmax; end # Returns the minimum x. # - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#281 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#296 def xmin; end # Returns the maximum y. # - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#299 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#314 def ymax; end # Returns the minimum y. # - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#293 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#308 def ymin; end # Returns the maximum z, or nil if the shapefile does not contain z. # - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#311 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#326 def zmax; end # Returns the minimum z, or nil if the shapefile does not contain z. # - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#305 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#320 def zmin; end class << self @@ -324,7 +328,7 @@ class RGeo::Shapefile::Reader # a platform without GEOS, you have no choice but to turn on this # switch and make this assumption about your input shapefiles. # - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#160 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#161 def open(path_, opts_ = T.unsafe(nil), &block_); end end end @@ -332,7 +336,7 @@ end # Values less than this value are considered "no value" in the # shapefile format specification. # -# source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#97 +# source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#98 RGeo::Shapefile::Reader::NODATA_LIMIT = T.let(T.unsafe(nil), Float) # Shapefile records are provided to the caller as objects of this @@ -342,36 +346,36 @@ RGeo::Shapefile::Reader::NODATA_LIMIT = T.let(T.unsafe(nil), Float) # # You should not need to create objects of this type yourself. # -# source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#800 +# source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#827 class RGeo::Shapefile::Reader::Record # @return [Record] a new instance of Record # - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#801 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#828 def initialize(index_, geometry_, attributes_); end # Returns the value for the given attribute key. # - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#822 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#849 def [](key_); end # The attributes as a hash. # - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#814 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#841 def attributes; end # The geometry contained in this shapefile record # - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#811 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#838 def geometry; end # The 0-based record number # - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#808 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#835 def index; end # Returns an array of keys for all this record's attributes. # - # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#817 + # source://rgeo-shapefile//lib/rgeo/shapefile/reader.rb#844 def keys; end end diff --git a/sorbet/rbi/gems/rgeo@3.0.0.rbi b/sorbet/rbi/gems/rgeo@3.0.1.rbi similarity index 87% rename from sorbet/rbi/gems/rgeo@3.0.0.rbi rename to sorbet/rbi/gems/rgeo@3.0.1.rbi index 06d4f3e3a..b40475ea2 100644 --- a/sorbet/rbi/gems/rgeo@3.0.0.rbi +++ b/sorbet/rbi/gems/rgeo@3.0.1.rbi @@ -2882,12 +2882,12 @@ RGeo::CoordSys::CS::AO_WEST = T.let(T.unsafe(nil), Integer) # # Definition of angular units. # -# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#546 +# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#550 class RGeo::CoordSys::CS::AngularUnit < ::RGeo::CoordSys::CS::Unit # Returns the number of radians per AngularUnit. # Also available as Unit#conversion_factor. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#550 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#554 def radians_per_unit; end class << self @@ -2895,7 +2895,7 @@ class RGeo::CoordSys::CS::AngularUnit < ::RGeo::CoordSys::CS::Unit # factor in radians per unit. You may also provide the optional # parameters specified by the Info interface. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#559 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#563 def create(name, radians_per_unit, *optional); end end end @@ -2917,20 +2917,20 @@ class RGeo::CoordSys::CS::AxisInfo < ::RGeo::CoordSys::CS::Base # Human readable name for axis. Possible values are "X", "Y", # "Long", "Lat" or any other short string. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#266 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#267 def name; end # Gets enumerated value for orientation. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#269 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#270 def orientation; end - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#271 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#272 def wkt_typename; end private - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#291 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#292 def wkt_content(_); end class << self @@ -2942,7 +2942,7 @@ class RGeo::CoordSys::CS::AxisInfo < ::RGeo::CoordSys::CS::Base # "UP", and "DOWN", or the corresponding # integer values 0-5. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#284 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#285 def create(name, orientation); end end end @@ -3054,39 +3054,39 @@ RGeo::CoordSys::CS::CT_DF_OUTSIDE = T.let(T.unsafe(nil), Integer) # datum. The other is a vertical CRS which is a one-dimensional # coordinate system with a vertical datum. # -# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#983 +# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#987 class RGeo::CoordSys::CS::CompoundCoordinateSystem < ::RGeo::CoordSys::CS::CoordinateSystem # @return [CompoundCoordinateSystem] a new instance of CompoundCoordinateSystem # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#984 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#988 def initialize(name, head, tail, *optional); end # Implements CoordinateSystem#get_axis # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#998 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1002 def get_axis(index); end # Implements CoordinateSystem#get_units # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1005 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1009 def get_units(index); end # Gets first sub-coordinate system. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#991 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#995 def head; end # Gets second sub-coordinate system. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#994 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#998 def tail; end - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1010 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1014 def wkt_typename; end private - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1026 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1030 def wkt_content(standard_brackets); end class << self @@ -3094,7 +3094,7 @@ class RGeo::CoordSys::CS::CompoundCoordinateSystem < ::RGeo::CoordSys::CS::Coord # systems. You may also provide the optional parameters # specified by the Info interface. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1019 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1023 def create(name, head, tail, *optional); end end end @@ -3128,59 +3128,59 @@ end # VerticalCoordinateSystem, LocalCoordinateSystem, or # CompoundCoordinateSystem. # -# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#907 +# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#911 class RGeo::CoordSys::CS::CoordinateSystem < ::RGeo::CoordSys::CS::Info # @return [CoordinateSystem] a new instance of CoordinateSystem # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#908 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#912 def initialize(name, dimension, *optional); end # Dimension of the coordinate system # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#914 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#918 def dimension; end # @return [Boolean] # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#930 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#934 def geographic?; end # Gets axis details for dimension within coordinate system. Each # dimension in the coordinate system has a corresponding axis. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#919 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#923 def get_axis(_dimension); end # Gets units for dimension within coordinate system. Each # dimension in the coordinate system has corresponding units. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#926 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#930 def get_units(_dimension); end # @return [Boolean] # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#934 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#938 def projected?; end # Not an OGC method, but useful for being able to # transform directly from a CoordinateSystem object. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#944 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#948 def transform_coords(target_cs, x, y, z = T.unsafe(nil)); end - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#938 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#942 def wkt_typename; end private - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#971 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#975 def wkt_content(_); end class << self - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#950 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#954 def create(defn, dimension = T.unsafe(nil), *optional); end - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#964 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#968 def create_from_wkt(str); end end end @@ -3287,7 +3287,7 @@ end # # @see https://portal.ogc.org/files/?artifact_id=999 page 79 # -# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1413 +# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1417 class RGeo::CoordSys::CS::CoordinateTransform < ::RGeo::CoordSys::CS::Info # Initialize a new CoordinateTransform # @@ -3300,7 +3300,7 @@ class RGeo::CoordSys::CS::CoordinateTransform < ::RGeo::CoordSys::CS::Info # @param optional [Array] any params for Info or Base # @return [CoordinateTransform] # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1424 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1428 def initialize(source_cs, target_cs, *optional); end # Human readable description of domain in source coordinate system. @@ -3308,7 +3308,7 @@ class RGeo::CoordSys::CS::CoordinateTransform < ::RGeo::CoordSys::CS::Info # @raise [NotImplementedError] # @return [String] # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1446 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1450 def area_of_use; end # Gets transformed convex hull. The supplied ordinates are interpreted as a sequence of points, @@ -3323,21 +3323,21 @@ class RGeo::CoordSys::CS::CoordinateTransform < ::RGeo::CoordSys::CS::Info # @raise [NotImplementedError] # @return [Array<>]] Array<>] # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1500 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1504 def codomain_convex_hull(points); end # Dimension of the source_cs # # @return [Integer] # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1460 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1464 def dim_source; end # Dimension of the target_cs # # @return [Integer] # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1467 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1471 def dim_target; end # Gets flags classifying domain points within a convex hull. The supplied ordinates are interpreted @@ -3350,7 +3350,7 @@ class RGeo::CoordSys::CS::CoordinateTransform < ::RGeo::CoordSys::CS::Info # @raise [NotImplementedError] # @return [Array] the domain_flags of the input points # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1486 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1490 def domain_flags(points); end # Tests whether this transform does not move any points @@ -3358,10 +3358,10 @@ class RGeo::CoordSys::CS::CoordinateTransform < ::RGeo::CoordSys::CS::Info # @raise [NotImplementedError] # @return [Boolean] # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1474 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1478 def identity?; end - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1439 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1443 def inspect; end # Creates the inverse transform of this object. This method may fail if the transform is not one to @@ -3369,31 +3369,31 @@ class RGeo::CoordSys::CS::CoordinateTransform < ::RGeo::CoordSys::CS::Info # # @return [CoordinateTransform] # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1526 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1530 def inverse; end # Returns the value of attribute source_cs. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1429 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1433 def source_cs; end # Sets the attribute source_cs # # @param value the value to set the attribute source_cs to. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1429 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1433 def source_cs=(_arg0); end # Returns the value of attribute target_cs. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1429 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1433 def target_cs; end # Sets the attribute target_cs # # @param value the value to set the attribute target_cs to. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1429 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1433 def target_cs=(_arg0); end # Transforms a coordinate point. The passed parameter point should not be modified. @@ -3404,7 +3404,7 @@ class RGeo::CoordSys::CS::CoordinateTransform < ::RGeo::CoordSys::CS::Info # @raise [NotImplementedError] # @return [Array] transformed point coordinates in (x,y,z) order # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1510 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1514 def transform_coords(x, y, z = T.unsafe(nil)); end # Transforms a coordinate point. The passed parameter point should not be modified. @@ -3412,7 +3412,7 @@ class RGeo::CoordSys::CS::CoordinateTransform < ::RGeo::CoordSys::CS::Info # @param points [Array>] in (x,y,z) tuples where z is optional # @return [Array>] list of transformed point coordinates in (x,y,z) order # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1518 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1522 def transform_list(points); end # Semantic type of transform. For example, a datum transformation or a coordinate conversion. @@ -3420,7 +3420,7 @@ class RGeo::CoordSys::CS::CoordinateTransform < ::RGeo::CoordSys::CS::Info # @raise [NotImplementedError] # @return [String] # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1453 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1457 def transform_type; end # TODO: This changes depending on what type of conversion is done @@ -3428,12 +3428,12 @@ class RGeo::CoordSys::CS::CoordinateTransform < ::RGeo::CoordSys::CS::Info # We should delegate all of the wkt generation to the library # if possible. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1435 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1439 def wkt_typename; end private - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1548 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1552 def wkt_content(standard_brackets); end class << self @@ -3448,7 +3448,7 @@ class RGeo::CoordSys::CS::CoordinateTransform < ::RGeo::CoordSys::CS::Info # @param optional [Array] any params for Info or Base # @return [CoordinateTransform] # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1541 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1545 def create(source_cs, target_cs, *optional); end end end @@ -3473,21 +3473,21 @@ end # one of the subclasses HorizontalDatum, VerticalDatum, or # LocalDatum. # -# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#714 +# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#718 class RGeo::CoordSys::CS::Datum < ::RGeo::CoordSys::CS::Info # @return [Datum] a new instance of Datum # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#715 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#719 def initialize(name, datum_type, *optional); end # Gets the type of the datum as an enumerated code. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#721 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#725 def datum_type; end private - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#725 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#729 def wkt_content(_); end end @@ -3495,17 +3495,17 @@ end # # An approximation of the Earth's surface as a squashed sphere. # -# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#607 +# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#611 class RGeo::CoordSys::CS::Ellipsoid < ::RGeo::CoordSys::CS::Info # @return [Ellipsoid] a new instance of Ellipsoid # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#608 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#612 def initialize(name, semi_major_axis, semi_minor_axis, inverse_flattening, ivf_definitive, linear_unit, *optional); end # Returns the LinearUnit. The units of the semi-major and # semi-minor axis values. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#641 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#645 def axisunit; end # Returns the value of the inverse of the flattening constant. The @@ -3513,7 +3513,7 @@ class RGeo::CoordSys::CS::Ellipsoid < ::RGeo::CoordSys::CS::Info # the formula ivf=re/(re-rp). For perfect spheres, this formula # breaks down, and a special IVF value of zero is used. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#630 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#634 def inverse_flattening; end # Is the Inverse Flattening definitive for this ellipsoid? Some @@ -3522,27 +3522,27 @@ class RGeo::CoordSys::CS::Ellipsoid < ::RGeo::CoordSys::CS::Info # radius to calculate the IVF whenever asked. This distinction can # be important to avoid floating-point rounding errors. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#637 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#641 def ivf_definitive; end # Gets the equatorial radius. The returned length is expressed in # this object's axis units. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#620 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#624 def semi_major_axis; end # Gets the polar radius. The returned length is expressed in this # object's axis units. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#624 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#628 def semi_minor_axis; end - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#643 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#647 def wkt_typename; end private - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#690 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#694 def wkt_content(_); end class << self @@ -3553,7 +3553,7 @@ class RGeo::CoordSys::CS::Ellipsoid < ::RGeo::CoordSys::CS::Info # may be set to nil. You may also provide the optional parameters # specified by the Info interface. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#655 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#659 def create(name, semi_major_axis, semi_minor_axis, inverse_flattening, ivf_definitive, linear_unit, *optional); end # Create an Ellipsoid given a name, semi-major and semi-minor @@ -3562,7 +3562,7 @@ class RGeo::CoordSys::CS::Ellipsoid < ::RGeo::CoordSys::CS::Info # The LinearUnit is optional and may be set to nil. You may also # provide the optional parameters specified by the Info interface. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#665 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#669 def create_ellipsoid(name, semi_major_axis, semi_minor_axis, linear_unit, *optional); end # Create an Ellipsoid given a name, semi-major axis, inverse @@ -3571,7 +3571,7 @@ class RGeo::CoordSys::CS::Ellipsoid < ::RGeo::CoordSys::CS::Info # The LinearUnit is optional and may be set to nil. You may also # provide the optional parameters specified by the Info interface. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#679 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#683 def create_flattened_sphere(name, semi_major_axis, inverse_flattening, linear_unit, *optional); end end end @@ -3585,26 +3585,26 @@ end # a right handed system), but you should check the axes for # non-default values. # -# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1105 +# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1109 class RGeo::CoordSys::CS::GeocentricCoordinateSystem < ::RGeo::CoordSys::CS::CoordinateSystem # @return [GeocentricCoordinateSystem] a new instance of GeocentricCoordinateSystem # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1106 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1110 def initialize(name, horizontal_datum, prime_meridian, linear_unit, axis0, axis1, axis2, *optional); end # @return [Boolean] # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1140 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1144 def geographic?; end # Implements CoordinateSystem#get_axis # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1136 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1140 def get_axis(index); end # Implements CoordinateSystem#get_units # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1130 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1134 def get_units(_index); end # Returns the HorizontalDatum. The horizontal datum is used to @@ -3612,25 +3612,25 @@ class RGeo::CoordSys::CS::GeocentricCoordinateSystem < ::RGeo::CoordSys::CS::Coo # All coordinate points will be measured from the centre of the # Earth, and not the surface. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1120 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1124 def horizontal_datum; end # Gets the units used along all the axes. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1126 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1130 def linear_unit; end # Returns the PrimeMeridian. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1123 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1127 def prime_meridian; end - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1144 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1148 def wkt_typename; end private - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1162 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1166 def wkt_content(standard_brackets); end class << self @@ -3640,7 +3640,7 @@ class RGeo::CoordSys::CS::GeocentricCoordinateSystem < ::RGeo::CoordSys::CS::Coo # You may also provide the optional parameters specified by the # Info interface. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1155 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1159 def create(name, horizontal_datum, prime_meridian, linear_unit, axis0, axis1, axis2, *optional); end end end @@ -3653,32 +3653,32 @@ end # also check the angular units, since not all geographic coordinate # systems use degrees. # -# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1259 +# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1263 class RGeo::CoordSys::CS::GeographicCoordinateSystem < ::RGeo::CoordSys::CS::HorizontalCoordinateSystem # @return [GeographicCoordinateSystem] a new instance of GeographicCoordinateSystem # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1260 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1264 def initialize(name, angular_unit, horizontal_datum, prime_meridian, axis0, axis1, *optional); end # Returns the AngularUnit. The angular unit must be the same as # the CS_CoordinateSystem units. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1273 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1277 def angular_unit; end # @return [Boolean] # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1303 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1307 def geographic?; end # Implements CoordinateSystem#get_axis # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1283 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1287 def get_axis(index); end # Implements CoordinateSystem#get_units # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1277 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1281 def get_units(_index); end # Gets details on a conversion to WGS84. Some geographic @@ -3687,25 +3687,25 @@ class RGeo::CoordSys::CS::GeographicCoordinateSystem < ::RGeo::CoordSys::CS::Hor # of interest. The first conversion (with index=0) should provide # acceptable accuracy over the largest possible area of interest. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1299 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1303 def get_wgs84_conversion_info(_index); end # Gets the number of available conversions to WGS84 coordinates. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1289 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1293 def num_conversion_to_wgs84; end # Returns the PrimeMeridian. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1269 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1273 def prime_meridian; end - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1307 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1311 def wkt_typename; end private - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1325 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1329 def wkt_content(standard_brackets); end class << self @@ -3715,7 +3715,7 @@ class RGeo::CoordSys::CS::GeographicCoordinateSystem < ::RGeo::CoordSys::CS::Hor # be set to nil. You may also provide the optional parameters # specified by the Info interface. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1318 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1322 def create(name, angular_unit, horizontal_datum, prime_meridian, axis0, axis1, *optional); end end end @@ -3771,16 +3771,16 @@ RGeo::CoordSys::CS::HD_OTHER = T.let(T.unsafe(nil), Integer) # one of the subclasses GeographicCoordinateSystem or # ProjectedCoordinateSystem. # -# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1242 +# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1246 class RGeo::CoordSys::CS::HorizontalCoordinateSystem < ::RGeo::CoordSys::CS::CoordinateSystem # @return [HorizontalCoordinateSystem] a new instance of HorizontalCoordinateSystem # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1243 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1247 def initialize(name, horizontal_datum, *optional); end # Returns the HorizontalDatum. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1249 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1253 def horizontal_datum; end end @@ -3788,31 +3788,31 @@ end # # Procedure used to measure positions on the surface of the Earth. # -# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#787 +# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#791 class RGeo::CoordSys::CS::HorizontalDatum < ::RGeo::CoordSys::CS::Datum # @return [HorizontalDatum] a new instance of HorizontalDatum # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#788 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#792 def initialize(name, datum_type, ellipsoid, wgs84_parameters, *optional); end # Returns the Ellipsoid. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#795 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#799 def ellipsoid; end # Gets preferred parameters for a Bursa Wolf transformation into # WGS84. The 7 returned values correspond to (dx,dy,dz) in meters, # (ex,ey,ez) in arc-seconds, and scaling in parts-per-million. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#800 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#804 def wgs84_parameters; end - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#802 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#806 def wkt_typename; end private - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#819 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#823 def wkt_content(standard_brackets); end class << self @@ -3821,7 +3821,7 @@ class RGeo::CoordSys::CS::HorizontalDatum < ::RGeo::CoordSys::CS::Datum # is optional and may be set to nil. You may also provide the # optional parameters specified by the Info interface. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#812 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#816 def create(name, datum_type, ellipsoid, wgs84_parameters, *optional); end end end @@ -3865,21 +3865,21 @@ end # * remarks: provider-supplied remarks. # * extensions: a hash of extension keys and values # -# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#427 +# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#430 class RGeo::CoordSys::CS::Info < ::RGeo::CoordSys::CS::Base # @return [Info] a new instance of Info # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#428 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#431 def initialize(name, authority = T.unsafe(nil), authority_code = T.unsafe(nil), abbreviation = T.unsafe(nil), init_alias = T.unsafe(nil), remarks = T.unsafe(nil), extensions = T.unsafe(nil)); end # Gets the abbreviation. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#441 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#445 def abbreviation; end # Gets the alias. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#444 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#448 def alias; end # Gets the authority name. @@ -3890,7 +3890,7 @@ class RGeo::CoordSys::CS::Info < ::RGeo::CoordSys::CS::Base # ID. For example, the EPSG code for a WGS84 Lat/Lon coordinate # system is "4326". # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#453 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#457 def authority; end # Gets the authority-specific identification code. @@ -3901,7 +3901,7 @@ class RGeo::CoordSys::CS::Info < ::RGeo::CoordSys::CS::Base # consist of a few digits. The EPSG code for WGS84 Lat/Lon is # "4326". # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#462 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#466 def authority_code; end # Gets the value of a keyed extension. @@ -3909,17 +3909,17 @@ class RGeo::CoordSys::CS::Info < ::RGeo::CoordSys::CS::Base # some coordinate system databases (such as the spatial_ref_sys # table for PostGIS 2.0) include it. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#474 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#478 def extension(key); end # Gets the name. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#465 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#469 def name; end # Gets the provider-supplied remarks. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#468 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#472 def remarks; end end @@ -3939,12 +3939,12 @@ RGeo::CoordSys::CS::LD_MIN = T.let(T.unsafe(nil), Integer) # # Definition of linear units. # -# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#524 +# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#528 class RGeo::CoordSys::CS::LinearUnit < ::RGeo::CoordSys::CS::Unit # Returns the number of meters per LinearUnit. # Also available as Unit#conversion_factor. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#528 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#532 def meters_per_unit; end class << self @@ -3952,7 +3952,7 @@ class RGeo::CoordSys::CS::LinearUnit < ::RGeo::CoordSys::CS::Unit # in meters per unit. You may also provide the optional # parameters specified by the Info interface. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#537 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#541 def create(name, meters_per_unit, *optional); end end end @@ -3976,34 +3976,34 @@ end # RGeo's implementation does not provide the Coordinate # Transformation (CT) package. # -# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1049 +# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1053 class RGeo::CoordSys::CS::LocalCoordinateSystem < ::RGeo::CoordSys::CS::CoordinateSystem # @return [LocalCoordinateSystem] a new instance of LocalCoordinateSystem # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1050 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1054 def initialize(name, local_datum, unit, axes, *optional); end # Implements CoordinateSystem#get_axis # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1062 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1066 def get_axis(index); end # Implements CoordinateSystem#get_units # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1068 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1072 def get_units(_index); end # Gets the local datum. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1058 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1062 def local_datum; end - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1072 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1076 def wkt_typename; end private - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1089 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1093 def wkt_content(standard_brackets); end class << self @@ -4012,7 +4012,7 @@ class RGeo::CoordSys::CS::LocalCoordinateSystem < ::RGeo::CoordSys::CS::Coordina # provide the optional parameters specified by the Info # interface. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1082 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1086 def create(name, local_datum, unit, axes, *optional); end end end @@ -4025,14 +4025,14 @@ end # coordinate systems, as long as they are based on the same local # datum. # -# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#762 +# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#766 class RGeo::CoordSys::CS::LocalDatum < ::RGeo::CoordSys::CS::Datum - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#763 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#767 def wkt_typename; end private - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#779 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#783 def wkt_content(_); end class << self @@ -4040,7 +4040,7 @@ class RGeo::CoordSys::CS::LocalDatum < ::RGeo::CoordSys::CS::Datum # may also provide the optional parameters specified by the # Info interface. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#772 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#776 def create(name, datum_type, *optional); end end end @@ -4049,30 +4049,30 @@ end # # A meridian used to take longitude measurements from. # -# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#568 +# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#572 class RGeo::CoordSys::CS::PrimeMeridian < ::RGeo::CoordSys::CS::Info # @return [PrimeMeridian] a new instance of PrimeMeridian # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#569 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#573 def initialize(name, angular_unit, longitude, *optional); end # Returns the AngularUnits. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#576 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#580 def angular_unit; end # Returns the longitude value relative to the Greenwich Meridian. # The longitude is expressed in this objects angular units. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#580 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#584 def longitude; end - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#582 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#586 def wkt_typename; end private - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#599 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#603 def wkt_content(_); end class << self @@ -4081,7 +4081,7 @@ class RGeo::CoordSys::CS::PrimeMeridian < ::RGeo::CoordSys::CS::Info # the AngularUnits. You may also provide the optional parameters # specified by the Info interface. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#592 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#596 def create(name, angular_unit, longitude, *optional); end end end @@ -4090,50 +4090,50 @@ end # # A 2D cartographic coordinate system. # -# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1340 +# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1344 class RGeo::CoordSys::CS::ProjectedCoordinateSystem < ::RGeo::CoordSys::CS::HorizontalCoordinateSystem # @return [ProjectedCoordinateSystem] a new instance of ProjectedCoordinateSystem # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1341 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1345 def initialize(name, geographic_coordinate_system, projection, linear_unit, axis0, axis1, *optional); end # Returns the GeographicCoordinateSystem. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1351 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1355 def geographic_coordinate_system; end # Implements CoordinateSystem#get_axis # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1368 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1372 def get_axis(index); end # Implements CoordinateSystem#get_units # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1362 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1366 def get_units(_index); end # Returns the LinearUnits. The linear unit must be the same as # the CS_CoordinateSystem units. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1358 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1362 def linear_unit; end # @return [Boolean] # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1372 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1376 def projected?; end # Gets the projection. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1354 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1358 def projection; end - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1376 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1380 def wkt_typename; end private - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1394 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1398 def wkt_content(standard_brackets); end class << self @@ -4143,7 +4143,7 @@ class RGeo::CoordSys::CS::ProjectedCoordinateSystem < ::RGeo::CoordSys::CS::Hori # may be set to nil. You may also provide the optional # parameters specified by the Info interface. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1387 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1391 def create(name, geographic_coordinate_system, projection, linear_unit, axis0, axis1, *optional); end end end @@ -4152,40 +4152,40 @@ end # # A projection from geographic coordinates to projected coordinates. # -# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#829 +# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#833 class RGeo::CoordSys::CS::Projection < ::RGeo::CoordSys::CS::Info # @return [Projection] a new instance of Projection # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#830 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#834 def initialize(name, class_name, parameters, *optional); end # Gets the projection classification name # (e.g. "Transverse_Mercator"). # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#838 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#842 def class_name; end # Iterates over the parameters of the projection. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#854 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#858 def each_parameter(&block); end # Gets an inexed parameter of the projection. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#848 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#852 def get_parameter(index); end # Gets number of parameters of the projection. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#842 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#846 def num_parameters; end - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#858 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#862 def wkt_typename; end private - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#874 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#878 def wkt_content(_); end class << self @@ -4193,7 +4193,7 @@ class RGeo::CoordSys::CS::Projection < ::RGeo::CoordSys::CS::Info # array of ProjectionParameter. You may also provide the # optional parameters specified by the Info interface. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#867 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#871 def create(name, class_name, parameters, *optional); end end end @@ -4206,35 +4206,35 @@ end # values match the angular units of the geographic coordinate # system that the projected coordinate system is based on. # -# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#303 +# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#304 class RGeo::CoordSys::CS::ProjectionParameter < ::RGeo::CoordSys::CS::Base # @return [ProjectionParameter] a new instance of ProjectionParameter # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#304 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#305 def initialize(name, value); end # The parameter name. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#310 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#312 def name; end # The parameter value. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#313 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#315 def value; end - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#315 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#317 def wkt_typename; end private - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#329 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#331 def wkt_content(_); end class << self # Create a parameter given the name and value. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#322 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#324 def create(name, value); end end end @@ -4249,26 +4249,26 @@ end # AngularUnit. However, it is possible to instantiate Unit if it is # not clear whether the data refers to a LinearUnit or AngularUnit. # -# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#488 +# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#492 class RGeo::CoordSys::CS::Unit < ::RGeo::CoordSys::CS::Info # @return [Unit] a new instance of Unit # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#489 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#493 def initialize(name, conversion_factor, *optional); end # This field is not part of the OGC CT spec, but is part of the # SFS. It is an alias of the appropriate field in the subclass, # i.e. LinearUnit#meters_per_unit or AngularUnit#radians_per_unit. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#497 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#501 def conversion_factor; end - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#499 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#503 def wkt_typename; end private - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#516 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#520 def wkt_content(_); end class << self @@ -4277,7 +4277,7 @@ class RGeo::CoordSys::CS::Unit < ::RGeo::CoordSys::CS::Info # conversion factor. You may also provide the optional # parameters specified by the Info interface. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#509 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#513 def create(name, conversion_factor, *optional); end end end @@ -4358,40 +4358,40 @@ RGeo::CoordSys::CS::VD_OTHER = T.let(T.unsafe(nil), Integer) # A one-dimensional coordinate system suitable for vertical # measurements. # -# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1179 +# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1183 class RGeo::CoordSys::CS::VerticalCoordinateSystem < ::RGeo::CoordSys::CS::CoordinateSystem # @return [VerticalCoordinateSystem] a new instance of VerticalCoordinateSystem # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1180 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1184 def initialize(name, vertical_datum, vertical_unit, axis, *optional); end # Implements CoordinateSystem#get_axis # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1202 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1206 def get_axis(_index); end # Implements CoordinateSystem#get_units # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1196 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1200 def get_units(_index); end # Gets the vertical datum, which indicates the measurement method. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1188 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1192 def vertical_datum; end # Gets the units used along the vertical axis. The vertical units # must be the same as the CS_CoordinateSystem units. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1192 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1196 def vertical_unit; end - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1206 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1210 def wkt_typename; end private - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1223 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1227 def wkt_content(standard_brackets); end class << self @@ -4400,7 +4400,7 @@ class RGeo::CoordSys::CS::VerticalCoordinateSystem < ::RGeo::CoordSys::CS::Coord # optional and may be nil. You may also provide the optional # parameters specified by the Info interface. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1216 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#1220 def create(name, vertical_datum, vertical_unit, axis, *optional); end end end @@ -4409,14 +4409,14 @@ end # # Procedure used to measure vertical distances. # -# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#733 +# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#737 class RGeo::CoordSys::CS::VerticalDatum < ::RGeo::CoordSys::CS::Datum - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#734 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#738 def wkt_typename; end private - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#750 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#754 def wkt_content(_); end class << self @@ -4424,7 +4424,7 @@ class RGeo::CoordSys::CS::VerticalDatum < ::RGeo::CoordSys::CS::Datum # You may also provide the optional parameters specified by the # Info interface. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#743 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#747 def create(name, datum_type, *optional); end end end @@ -4436,49 +4436,49 @@ end # the X axis points towards the Greenwich Prime Meridian, the Y axis # points East, and the Z axis points North. # -# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#340 +# source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#342 class RGeo::CoordSys::CS::WGS84ConversionInfo < ::RGeo::CoordSys::CS::Base # @return [WGS84ConversionInfo] a new instance of WGS84ConversionInfo # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#341 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#343 def initialize(dx_meters, dy_meters, dz_meters, ex_arc_seconds, ey_arc_seconds, ez_arc_seconds, ppm); end # Bursa Wolf shift in meters. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#352 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#355 def dx; end # Bursa Wolf shift in meters. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#355 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#358 def dy; end # Bursa Wolf shift in meters. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#358 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#361 def dz; end # Bursa Wolf rotation in arc seconds. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#361 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#364 def ex; end # Bursa Wolf rotation in arc seconds. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#364 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#367 def ey; end # Bursa Wolf rotation in arc seconds. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#367 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#370 def ez; end # Bursa Wolf scaling in in parts per million. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#370 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#373 def ppm; end - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#372 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#375 def to_wkt(standard_brackets: T.unsafe(nil)); end class << self @@ -4487,7 +4487,7 @@ class RGeo::CoordSys::CS::WGS84ConversionInfo < ::RGeo::CoordSys::CS::Base # The Bursa Wolf shift should be in meters, the rotation in arc # seconds, and the scaling in parts per million. # - # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#383 + # source://rgeo//lib/rgeo/coord_sys/cs/entities.rb#386 def create(dx_meters, dy_meters, dz_meters, ex_arc_seconds, ey_arc_seconds, ez_arc_seconds, ppm); end end end @@ -7018,10 +7018,10 @@ module RGeo::Geographic private # source://rgeo//lib/rgeo/geographic/interface.rb#382 - def coord_sys_4055; end + def coord_sys4055; end # source://rgeo//lib/rgeo/geographic/interface.rb#388 - def coord_sys_4326; end + def coord_sys4326; end end end @@ -9240,7 +9240,7 @@ class RGeo::Geographic::SimpleMercatorProjector class << self # source://rgeo//lib/rgeo/geographic/simple_mercator_projector.rb#107 - def _coordsys_3857; end + def _coordsys3857; end end end @@ -11157,285 +11157,1915 @@ module RGeo::Geos end end -# continue -# -# source://rgeo//lib/rgeo/geos.rb#31 -RGeo::Geos::CAPI_SUPPORTED = T.let(T.unsafe(nil), FalseClass) - -# source://rgeo//lib/rgeo/geos.rb#67 -RGeo::Geos::CAP_FLAT = T.let(T.unsafe(nil), Integer) - -# source://rgeo//lib/rgeo/geos.rb#66 -RGeo::Geos::CAP_ROUND = T.let(T.unsafe(nil), Integer) - -# source://rgeo//lib/rgeo/geos.rb#68 -RGeo::Geos::CAP_SQUARE = T.let(T.unsafe(nil), Integer) - -# source://rgeo//lib/rgeo/geos.rb#49 -RGeo::Geos::FFI_SUPPORTED = T.let(T.unsafe(nil), FalseClass) - -# source://rgeo//lib/rgeo/geos.rb#50 -RGeo::Geos::FFI_SUPPORT_EXCEPTION = T.let(T.unsafe(nil), LoadError) - -# source://rgeo//lib/rgeo/geos.rb#72 -RGeo::Geos::JOIN_BEVEL = T.let(T.unsafe(nil), Integer) - -# source://rgeo//lib/rgeo/geos.rb#71 -RGeo::Geos::JOIN_MITRE = T.let(T.unsafe(nil), Integer) - -# source://rgeo//lib/rgeo/geos.rb#70 -RGeo::Geos::JOIN_ROUND = T.let(T.unsafe(nil), Integer) - -# source://rgeo//lib/rgeo/geos/utils.rb#11 -module RGeo::Geos::Utils +module RGeo::Geos::Analysis class << self - # source://rgeo//lib/rgeo/geos/utils.rb#28 - def ffi_compute_dimension(geom); end - - # source://rgeo//lib/rgeo/geos/utils.rb#52 - def ffi_coord_seq_hash(coord_seq, init_hash = T.unsafe(nil)); end - - # @return [Boolean] - # - # source://rgeo//lib/rgeo/geos/utils.rb#13 - def ffi_coord_seqs_equal?(cs1, cs2, check_z); end - - # source://rgeo//lib/rgeo/geos/utils.rb#58 - def ffi_supports_prepared_level_1; end - - # source://rgeo//lib/rgeo/geos/utils.rb#62 - def ffi_supports_prepared_level_2; end - - # source://rgeo//lib/rgeo/geos/utils.rb#66 - def ffi_supports_set_output_dimension; end - - # source://rgeo//lib/rgeo/geos/utils.rb#70 - def ffi_supports_unary_union; end - - # source://rgeo//lib/rgeo/geos/utils.rb#78 - def marshal_wkb_generator; end - - # source://rgeo//lib/rgeo/geos/utils.rb#74 - def psych_wkt_generator; end + def ccw?(_arg0); end + def ccw_supported?; end end end -# A factory for Geos that handles both Z and M. +# This the GEOS CAPI implementation of RGeo::Feature::Factory. # -# source://rgeo//lib/rgeo/geos/zm_factory.rb#12 -class RGeo::Geos::ZMFactory +# source://rgeo//lib/rgeo/geos/capi_factory.rb#12 +class RGeo::Geos::CAPIFactory include ::RGeo::Feature::Factory::Instance include ::RGeo::ImplHelper::Utils - # @return [ZMFactory] a new instance of ZMFactory - # - # source://rgeo//lib/rgeo/geos/zm_factory.rb#42 - def initialize(opts = T.unsafe(nil)); end - # Factory equivalence test. # # @return [Boolean] # - # source://rgeo//lib/rgeo/geos/zm_factory.rb#195 + # source://rgeo//lib/rgeo/geos/capi_factory.rb#99 def ==(other); end + def _buffer_resolution; end + def _coord_sys; end + def _flags; end + def _parse_wkb_impl(_arg0); end + def _parse_wkt_impl(_arg0); end + def _set_wkrep_parsers(_arg0, _arg1); end + def _srid; end + def _wkb_generator; end + def _wkb_parser; end + def _wkt_generator; end + def _wkt_parser; end + + # source://rgeo//lib/rgeo/geos/capi_factory.rb#351 + def auto_prepare; end + # Returns the resolution used by buffer calculations on geometries # created by this factory # - # source://rgeo//lib/rgeo/geos/zm_factory.rb#177 + # source://rgeo//lib/rgeo/geos/capi_factory.rb#199 def buffer_resolution; end # See RGeo::Feature::Factory#collection # - # source://rgeo//lib/rgeo/geos/zm_factory.rb#267 - def collection(elems); end + # source://rgeo//lib/rgeo/geos/capi_factory.rb#277 + def collection(elems_); end # See RGeo::Feature::Factory#coord_sys # - # source://rgeo//lib/rgeo/geos/zm_factory.rb#291 + # source://rgeo//lib/rgeo/geos/capi_factory.rb#306 def coord_sys; end - # source://rgeo//lib/rgeo/geos/zm_factory.rb#328 - def create_feature(klass, zgeometry, mgeometry); end - # Psych support # - # source://rgeo//lib/rgeo/geos/zm_factory.rb#134 - def encode_with(coder); end + # source://rgeo//lib/rgeo/geos/capi_factory.rb#154 + def encode_with(coder_); end # Factory equivalence test. # # @return [Boolean] # - # source://rgeo//lib/rgeo/geos/zm_factory.rb#195 + # source://rgeo//lib/rgeo/geos/capi_factory.rb#99 def eql?(other); end # Standard hash code # - # source://rgeo//lib/rgeo/geos/zm_factory.rb#202 + # source://rgeo//lib/rgeo/geos/capi_factory.rb#108 def hash; end - # source://rgeo//lib/rgeo/geos/zm_factory.rb#149 - def init_with(coder); end + # source://rgeo//lib/rgeo/geos/capi_factory.rb#170 + def init_with(coder_); end + + # Standard object inspection output + # + # source://rgeo//lib/rgeo/geos/capi_factory.rb#93 + def inspect; end # See RGeo::Feature::Factory#line # - # source://rgeo//lib/rgeo/geos/zm_factory.rb#245 - def line(start, stop); end + # source://rgeo//lib/rgeo/geos/capi_factory.rb#257 + def line(start_, end_); end # See RGeo::Feature::Factory#line_string # - # source://rgeo//lib/rgeo/geos/zm_factory.rb#239 - def line_string(points); end + # source://rgeo//lib/rgeo/geos/capi_factory.rb#249 + def line_string(points_); end # See RGeo::Feature::Factory#linear_ring # - # source://rgeo//lib/rgeo/geos/zm_factory.rb#251 - def linear_ring(points); end - - # Returns the m-only factory corresponding to this factory. - # - # source://rgeo//lib/rgeo/geos/zm_factory.rb#189 - def m_factory; end + # source://rgeo//lib/rgeo/geos/capi_factory.rb#263 + def linear_ring(points_); end # Marshal support # - # source://rgeo//lib/rgeo/geos/zm_factory.rb#97 + # source://rgeo//lib/rgeo/geos/capi_factory.rb#114 def marshal_dump; end - # source://rgeo//lib/rgeo/geos/zm_factory.rb#113 - def marshal_load(data); end - - # source://rgeo//lib/rgeo/geos/zm_factory.rb#333 - def marshal_wkb_generator; end - - # source://rgeo//lib/rgeo/geos/zm_factory.rb#337 - def marshal_wkb_parser; end + # source://rgeo//lib/rgeo/geos/capi_factory.rb#132 + def marshal_load(data_); end # See RGeo::Feature::Factory#multi_line_string # - # source://rgeo//lib/rgeo/geos/zm_factory.rb#279 - def multi_line_string(elems); end + # source://rgeo//lib/rgeo/geos/capi_factory.rb#291 + def multi_line_string(elems_); end # See RGeo::Feature::Factory#multi_point # - # source://rgeo//lib/rgeo/geos/zm_factory.rb#273 - def multi_point(elems); end + # source://rgeo//lib/rgeo/geos/capi_factory.rb#284 + def multi_point(elems_); end # See RGeo::Feature::Factory#multi_polygon # - # source://rgeo//lib/rgeo/geos/zm_factory.rb#285 - def multi_polygon(elems); end + # source://rgeo//lib/rgeo/geos/capi_factory.rb#298 + def multi_polygon(elems_); end # See RGeo::Feature::Factory#override_cast # - # source://rgeo//lib/rgeo/geos/zm_factory.rb#297 + # source://rgeo//lib/rgeo/geos/capi_factory.rb#312 def override_cast(original, ntype, flags); end # See RGeo::Feature::Factory#parse_wkb # - # source://rgeo//lib/rgeo/geos/zm_factory.rb#223 - def parse_wkb(str); end + # source://rgeo//lib/rgeo/geos/capi_factory.rb#231 + def parse_wkb(str_); end # See RGeo::Feature::Factory#parse_wkt # - # source://rgeo//lib/rgeo/geos/zm_factory.rb#217 - def parse_wkt(str); end + # source://rgeo//lib/rgeo/geos/capi_factory.rb#221 + def parse_wkt(str_); end # See RGeo::Feature::Factory#point # - # source://rgeo//lib/rgeo/geos/zm_factory.rb#229 - def point(x, y, z = T.unsafe(nil), m = T.unsafe(nil)); end + # @raise [RGeo::Error::InvalidGeometry] + # + # source://rgeo//lib/rgeo/geos/capi_factory.rb#241 + def point(x, y, *extra); end # See RGeo::Feature::Factory#polygon # - # source://rgeo//lib/rgeo/geos/zm_factory.rb#257 - def polygon(outer_ring, inner_rings = T.unsafe(nil)); end + # source://rgeo//lib/rgeo/geos/capi_factory.rb#270 + def polygon(outer_ring_, inner_rings_ = T.unsafe(nil)); end + + def prepare_heuristic?; end # See RGeo::Feature::Factory#property # - # source://rgeo//lib/rgeo/geos/zm_factory.rb#208 - def property(name); end + # source://rgeo//lib/rgeo/geos/capi_factory.rb#204 + def property(name_); end - # source://rgeo//lib/rgeo/geos/zm_factory.rb#341 - def psych_wkt_generator; end - - # source://rgeo//lib/rgeo/geos/zm_factory.rb#345 - def psych_wkt_parser; end + def read_for_marshal(_arg0); end + def read_for_psych(_arg0); end # Returns the SRID of geometries created by this factory. # - # source://rgeo//lib/rgeo/geos/zm_factory.rb#170 + # source://rgeo//lib/rgeo/geos/capi_factory.rb#192 def srid; end - # Returns the z-only factory corresponding to this factory. - # - # source://rgeo//lib/rgeo/geos/zm_factory.rb#183 - def z_factory; end + def supports_m?; end + def supports_z?; end + def supports_z_or_m?; end + def write_for_marshal(_arg0); end + def write_for_psych(_arg0); end + + private + + def _create(_arg0, _arg1, _arg2, _arg3, _arg4, _arg5); end + def _geos_version; end + def _supports_unary_union?; end + def initialize_copy(_arg0); end class << self - # Create a new factory. Returns nil if the GEOS implementation is - # not supported. + def _create(_arg0, _arg1, _arg2, _arg3, _arg4, _arg5); end + def _geos_version; end + def _supports_unary_union?; end + + # Create a new factory. Returns nil if the GEOS CAPI implementation + # is not supported. # - # source://rgeo//lib/rgeo/geos/zm_factory.rb#36 + # See RGeo::Geos.factory for a list of supported options. + # + # source://rgeo//lib/rgeo/geos/capi_factory.rb#22 def create(opts = T.unsafe(nil)); end + + # Create a new factory. Returns nil if the GEOS CAPI implementation + # is not supported. + # + # See RGeo::Geos.factory for a list of supported options. + # + # source://rgeo//lib/rgeo/geos/capi_factory.rb#22 + def new(opts = T.unsafe(nil)); end end end +RGeo::Geos::CAPIFactory::FLAG_PREPARE_HEURISTIC = T.let(T.unsafe(nil), Integer) +RGeo::Geos::CAPIFactory::FLAG_SUPPORTS_M = T.let(T.unsafe(nil), Integer) +RGeo::Geos::CAPIFactory::FLAG_SUPPORTS_Z = T.let(T.unsafe(nil), Integer) +RGeo::Geos::CAPIFactory::FLAG_SUPPORTS_Z_OR_M = T.let(T.unsafe(nil), Integer) + # :stopdoc: # -# source://rgeo//lib/rgeo/geos/zm_factory.rb#18 -RGeo::Geos::ZMFactory::TYPE_KLASSES = T.let(T.unsafe(nil), Hash) +# source://rgeo//lib/rgeo/geos/capi_factory.rb#357 +RGeo::Geos::CAPIFactory::IMPL_CLASSES = T.let(T.unsafe(nil), Hash) -# source://rgeo//lib/rgeo/geos/zm_feature_classes.rb#36 -class RGeo::Geos::ZMGeometryCollectionImpl - include ::RGeo::Feature::Instance - include ::RGeo::Geos::ZMGeometryMethods +# source://rgeo//lib/rgeo/geos/capi_feature_classes.rb#125 +class RGeo::Geos::CAPIGeometryCollectionImpl + include ::RGeo::Feature::Geometry include ::Enumerable - include ::RGeo::Geos::ZMGeometryCollectionMethods -end + include ::RGeo::Feature::GeometryCollection + include ::RGeo::ImplHelper::ValidityCheck + include ::RGeo::Feature::Instance + include ::RGeo::Geos::CAPIGeometryMethods + include ::RGeo::Geos::CAPIGeometryCollectionMethods -# source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#319 -module RGeo::Geos::ZMGeometryCollectionMethods - include ::Enumerable - include ::ActiveSupport::ToJsonWithActiveSupportEncoder + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def *(*args); end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#325 - def [](idx); end + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def +(*args); end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#330 - def each; end + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def -(*args); end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#325 - def geometry_n(idx); end + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def boundary(*args); end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#320 - def num_geometries; end + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def buffer(*args); end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#320 - def size; end -end + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def contains?(*args); end -# source://rgeo//lib/rgeo/geos/zm_feature_classes.rb#58 -class RGeo::Geos::ZMGeometryImpl - include ::RGeo::Feature::Instance - include ::RGeo::Geos::ZMGeometryMethods -end + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def convex_hull(*args); end -# source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#11 -module RGeo::Geos::ZMGeometryMethods + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def crosses?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def difference(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def disjoint?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def distance(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def envelope(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def intersection(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def intersects?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def node(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def overlaps?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def point_on_surface(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def relate?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def size(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def sym_difference(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def touches?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def transform(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def unary_union(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def union(*args); end + + def unsafe_add(_arg0); end + def unsafe_boundary; end + def unsafe_buffer(_arg0); end + def unsafe_contains?(_arg0); end + def unsafe_convex_hull; end + def unsafe_crosses?(_arg0); end + def unsafe_difference(_arg0); end + def unsafe_disjoint?(_arg0); end + def unsafe_distance(_arg0); end + def unsafe_envelope; end + def unsafe_intersection(_arg0); end + def unsafe_intersects?(_arg0); end + def unsafe_multiply(_arg0); end + def unsafe_node; end + def unsafe_overlaps?(_arg0); end + def unsafe_point_on_surface; end + def unsafe_relate?(_arg0, _arg1); end + def unsafe_remove(_arg0); end + def unsafe_size; end + def unsafe_sym_difference(_arg0); end + def unsafe_touches?(_arg0); end + + # source://rgeo//lib/rgeo/feature/geometry.rb#722 + def unsafe_transform(other_factory); end + + def unsafe_unary_union; end + def unsafe_union(_arg0); end + def unsafe_within?(_arg0); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def within?(*args); end + + private + + def create(_arg0, _arg1); end + + class << self + def create(_arg0, _arg1); end + end +end + +# source://rgeo//lib/rgeo/geos/capi_feature_classes.rb#74 +module RGeo::Geos::CAPIGeometryCollectionMethods + include ::Enumerable + include ::ActiveSupport::ToJsonWithActiveSupportEncoder + + def [](_arg0); end + def each; end + def eql?(_arg0); end + def geometry_n(_arg0); end + def geometry_type; end + def hash; end + def node; end + def num_geometries; end + def rep_equals?(_arg0); end + def size; end +end + +# source://rgeo//lib/rgeo/geos/capi_feature_classes.rb#78 +class RGeo::Geos::CAPIGeometryImpl + include ::RGeo::Feature::Geometry + include ::RGeo::ImplHelper::ValidityCheck + include ::RGeo::Feature::Instance + include ::RGeo::Geos::CAPIGeometryMethods + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def *(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def +(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def -(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def boundary(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def buffer(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def contains?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def convex_hull(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def crosses?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def difference(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def disjoint?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def distance(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def envelope(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def intersection(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def intersects?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def overlaps?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def relate?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def sym_difference(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def touches?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def transform(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def unary_union(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def union(*args); end + + def unsafe_add(_arg0); end + def unsafe_boundary; end + def unsafe_buffer(_arg0); end + def unsafe_contains?(_arg0); end + def unsafe_convex_hull; end + def unsafe_crosses?(_arg0); end + def unsafe_difference(_arg0); end + def unsafe_disjoint?(_arg0); end + def unsafe_distance(_arg0); end + def unsafe_envelope; end + def unsafe_intersection(_arg0); end + def unsafe_intersects?(_arg0); end + def unsafe_multiply(_arg0); end + def unsafe_overlaps?(_arg0); end + def unsafe_relate?(_arg0, _arg1); end + def unsafe_remove(_arg0); end + def unsafe_sym_difference(_arg0); end + def unsafe_touches?(_arg0); end + + # source://rgeo//lib/rgeo/feature/geometry.rb#722 + def unsafe_transform(other_factory); end + + def unsafe_unary_union; end + def unsafe_union(_arg0); end + def unsafe_within?(_arg0); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def within?(*args); end +end + +# source://rgeo//lib/rgeo/geos/capi_feature_classes.rb#13 +module RGeo::Geos::CAPIGeometryMethods + include ::RGeo::Feature::Instance + + def *(_arg0); end + def +(_arg0); end + def -(_arg0); end + def ==(_arg0); end + def _as_text; end + def _steal(_arg0); end + def as_binary; end + + # source://rgeo//lib/rgeo/geos/capi_feature_classes.rb#66 + def as_text; end + + def boundary; end + def buffer(_arg0); end + def buffer_with_style(_arg0, _arg1, _arg2, _arg3); end + def contains?(_arg0); end + def convex_hull; end + + # source://rgeo//lib/rgeo/geos/capi_feature_classes.rb#16 + def coordinate_dimension; end + + def crosses?(_arg0); end + def difference(_arg0); end + def dimension; end + def disjoint?(_arg0); end + def distance(_arg0); end + def empty?; end + + # Psych support + # + # source://rgeo//lib/rgeo/geos/capi_feature_classes.rb#53 + def encode_with(coder); end + + def envelope; end + def eql?(_arg0); end + def equals?(_arg0); end + def factory; end + def factory=(_arg0); end + def geometry_type; end + + # source://rgeo//lib/rgeo/geos/capi_feature_classes.rb#61 + def init_with(coder); end + + def initialized?; end + + # source://rgeo//lib/rgeo/geos/capi_feature_classes.rb#35 + def inspect; end + + def intersection(_arg0); end + def intersects?(_arg0); end + def invalid_reason; end + def invalid_reason_location; end + + # @return [Boolean] + # + # source://rgeo//lib/rgeo/geos/capi_feature_classes.rb#27 + def is_3d?; end + + def make_valid; end + + # Marshal support + # + # source://rgeo//lib/rgeo/geos/capi_feature_classes.rb#41 + def marshal_dump; end + + # source://rgeo//lib/rgeo/geos/capi_feature_classes.rb#46 + def marshal_load(data_); end + + # @return [Boolean] + # + # source://rgeo//lib/rgeo/geos/capi_feature_classes.rb#31 + def measured?; end + + def overlaps?(_arg0); end + def point_on_surface; end + def polygonize; end + def prepare!; end + def prepared?; end + def relate?(_arg0, _arg1); end + def rep_equals?(_arg0); end + def segmentize(_arg0); end + def simple?; end + def simplify(_arg0); end + def simplify_preserve_topology(_arg0); end + + # source://rgeo//lib/rgeo/geos/capi_feature_classes.rb#23 + def spatial_dimension; end + + def srid; end + def sym_difference(_arg0); end + + # source://rgeo//lib/rgeo/geos/capi_feature_classes.rb#66 + def to_s; end + + def touches?(_arg0); end + def unary_union; end + def union(_arg0); end + def valid?; end + def within?(_arg0); end + + private + + def initialize_copy(_arg0); end +end + +# source://rgeo//lib/rgeo/geos/capi_feature_classes.rb#110 +class RGeo::Geos::CAPILineImpl + include ::RGeo::Feature::Geometry + include ::RGeo::Feature::Curve + include ::RGeo::Feature::LineString + include ::RGeo::Feature::Line + include ::RGeo::ImplHelper::ValidityCheck + include ::RGeo::Feature::Instance + include ::RGeo::Geos::CAPIGeometryMethods + include ::RGeo::Geos::CAPILineStringMethods + include ::RGeo::Geos::CAPILineMethods + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def *(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def +(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def -(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def boundary(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def buffer(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def contains?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def convex_hull(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def crosses?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def difference(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def disjoint?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def distance(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def envelope(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def intersection(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def intersects?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def length(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def overlaps?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def relate?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def ring?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def sym_difference(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def touches?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def transform(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def unary_union(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def union(*args); end + + def unsafe_add(_arg0); end + def unsafe_boundary; end + def unsafe_buffer(_arg0); end + def unsafe_contains?(_arg0); end + def unsafe_convex_hull; end + def unsafe_crosses?(_arg0); end + def unsafe_difference(_arg0); end + def unsafe_disjoint?(_arg0); end + def unsafe_distance(_arg0); end + def unsafe_envelope; end + def unsafe_intersection(_arg0); end + def unsafe_intersects?(_arg0); end + def unsafe_length; end + def unsafe_multiply(_arg0); end + def unsafe_overlaps?(_arg0); end + def unsafe_relate?(_arg0, _arg1); end + def unsafe_remove(_arg0); end + def unsafe_ring?; end + def unsafe_sym_difference(_arg0); end + def unsafe_touches?(_arg0); end + + # source://rgeo//lib/rgeo/feature/geometry.rb#722 + def unsafe_transform(other_factory); end + + def unsafe_unary_union; end + def unsafe_union(_arg0); end + def unsafe_within?(_arg0); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def within?(*args); end + + private + + def _copy_from(_arg0, _arg1); end + def create(_arg0, _arg1, _arg2); end + + class << self + def _copy_from(_arg0, _arg1); end + def create(_arg0, _arg1, _arg2); end + end +end + +module RGeo::Geos::CAPILineMethods + def geometry_type; end + def hash; end +end + +# source://rgeo//lib/rgeo/geos/capi_feature_classes.rb#91 +class RGeo::Geos::CAPILineStringImpl + include ::RGeo::Feature::Geometry + include ::RGeo::Feature::Curve + include ::RGeo::Feature::LineString + include ::RGeo::ImplHelper::ValidityCheck + include ::RGeo::Feature::Instance + include ::RGeo::Geos::CAPIGeometryMethods + include ::RGeo::Geos::CAPILineStringMethods + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def *(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def +(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def -(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def boundary(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def buffer(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def contains?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def convex_hull(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def crosses?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def difference(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def disjoint?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def distance(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def envelope(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def intersection(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def intersects?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def length(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def overlaps?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def relate?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def ring?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def sym_difference(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def touches?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def transform(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def unary_union(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def union(*args); end + + def unsafe_add(_arg0); end + def unsafe_boundary; end + def unsafe_buffer(_arg0); end + def unsafe_contains?(_arg0); end + def unsafe_convex_hull; end + def unsafe_crosses?(_arg0); end + def unsafe_difference(_arg0); end + def unsafe_disjoint?(_arg0); end + def unsafe_distance(_arg0); end + def unsafe_envelope; end + def unsafe_intersection(_arg0); end + def unsafe_intersects?(_arg0); end + def unsafe_length; end + def unsafe_multiply(_arg0); end + def unsafe_overlaps?(_arg0); end + def unsafe_relate?(_arg0, _arg1); end + def unsafe_remove(_arg0); end + def unsafe_ring?; end + def unsafe_sym_difference(_arg0); end + def unsafe_touches?(_arg0); end + + # source://rgeo//lib/rgeo/feature/geometry.rb#722 + def unsafe_transform(other_factory); end + + def unsafe_unary_union; end + def unsafe_union(_arg0); end + def unsafe_within?(_arg0); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def within?(*args); end + + private + + def _copy_from(_arg0, _arg1); end + def create(_arg0, _arg1); end + + class << self + def _copy_from(_arg0, _arg1); end + def create(_arg0, _arg1); end + end +end + +module RGeo::Geos::CAPILineStringMethods + def closed?; end + def coordinates; end + def end_point; end + def eql?(_arg0); end + def geometry_type; end + def hash; end + def interpolate_point(_arg0); end + def length; end + def num_points; end + def point_n(_arg0); end + def points; end + def project_point(_arg0); end + def rep_equals?(_arg0); end + def ring?; end + def start_point; end +end + +# source://rgeo//lib/rgeo/geos/capi_feature_classes.rb#98 +class RGeo::Geos::CAPILinearRingImpl + include ::RGeo::Feature::Geometry + include ::RGeo::Feature::Curve + include ::RGeo::Feature::LineString + include ::RGeo::Feature::LinearRing + include ::RGeo::ImplHelper::ValidityCheck + include ::RGeo::Feature::Instance + include ::RGeo::Geos::CAPIGeometryMethods + include ::RGeo::Geos::CAPILineStringMethods + include ::RGeo::Geos::CAPILinearRingMethods + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def *(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def +(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def -(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def boundary(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def buffer(*args); end + + # @return [Boolean] + # + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def ccw?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def contains?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def convex_hull(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def crosses?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def difference(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def disjoint?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def distance(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def envelope(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def intersection(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def intersects?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def length(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def overlaps?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def relate?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def ring?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def sym_difference(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def touches?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def transform(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def unary_union(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def union(*args); end + + def unsafe_add(_arg0); end + def unsafe_boundary; end + def unsafe_buffer(_arg0); end + + # source://rgeo//lib/rgeo/geos/capi_feature_classes.rb#105 + def unsafe_ccw?; end + + def unsafe_contains?(_arg0); end + def unsafe_convex_hull; end + def unsafe_crosses?(_arg0); end + def unsafe_difference(_arg0); end + def unsafe_disjoint?(_arg0); end + def unsafe_distance(_arg0); end + def unsafe_envelope; end + def unsafe_intersection(_arg0); end + def unsafe_intersects?(_arg0); end + def unsafe_length; end + def unsafe_multiply(_arg0); end + def unsafe_overlaps?(_arg0); end + def unsafe_relate?(_arg0, _arg1); end + def unsafe_remove(_arg0); end + def unsafe_ring?; end + def unsafe_sym_difference(_arg0); end + def unsafe_touches?(_arg0); end + + # source://rgeo//lib/rgeo/feature/geometry.rb#722 + def unsafe_transform(other_factory); end + + def unsafe_unary_union; end + def unsafe_union(_arg0); end + def unsafe_within?(_arg0); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def within?(*args); end + + private + + def _copy_from(_arg0, _arg1); end + def create(_arg0, _arg1); end + + class << self + def _copy_from(_arg0, _arg1); end + def create(_arg0, _arg1); end + end +end + +module RGeo::Geos::CAPILinearRingMethods + def geometry_type; end + def hash; end +end + +# source://rgeo//lib/rgeo/geos/capi_feature_classes.rb#140 +class RGeo::Geos::CAPIMultiLineStringImpl + include ::RGeo::Feature::Geometry + include ::Enumerable + include ::RGeo::Feature::GeometryCollection + include ::RGeo::Feature::MultiCurve + include ::RGeo::Feature::MultiLineString + include ::RGeo::ImplHelper::ValidityCheck + include ::RGeo::Feature::Instance + include ::RGeo::Geos::CAPIGeometryMethods + include ::RGeo::Geos::CAPIGeometryCollectionMethods + include ::RGeo::Geos::CAPIMultiLineStringMethods + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def *(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def +(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def -(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def boundary(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def buffer(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def contains?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def convex_hull(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def crosses?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def difference(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def disjoint?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def distance(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def envelope(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def intersection(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def intersects?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def length(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def node(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def overlaps?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def point_on_surface(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def relate?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def size(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def sym_difference(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def touches?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def transform(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def unary_union(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def union(*args); end + + def unsafe_add(_arg0); end + def unsafe_boundary; end + def unsafe_buffer(_arg0); end + def unsafe_contains?(_arg0); end + def unsafe_convex_hull; end + def unsafe_crosses?(_arg0); end + def unsafe_difference(_arg0); end + def unsafe_disjoint?(_arg0); end + def unsafe_distance(_arg0); end + def unsafe_envelope; end + def unsafe_intersection(_arg0); end + def unsafe_intersects?(_arg0); end + def unsafe_length; end + def unsafe_multiply(_arg0); end + def unsafe_node; end + def unsafe_overlaps?(_arg0); end + def unsafe_point_on_surface; end + def unsafe_relate?(_arg0, _arg1); end + def unsafe_remove(_arg0); end + def unsafe_size; end + def unsafe_sym_difference(_arg0); end + def unsafe_touches?(_arg0); end + + # source://rgeo//lib/rgeo/feature/geometry.rb#722 + def unsafe_transform(other_factory); end + + def unsafe_unary_union; end + def unsafe_union(_arg0); end + def unsafe_within?(_arg0); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def within?(*args); end + + private + + def create(_arg0, _arg1); end + + class << self + def create(_arg0, _arg1); end + end +end + +module RGeo::Geos::CAPIMultiLineStringMethods + def closed?; end + def coordinates; end + def geometry_type; end + def hash; end + def length; end +end + +# source://rgeo//lib/rgeo/geos/capi_feature_classes.rb#132 +class RGeo::Geos::CAPIMultiPointImpl + include ::RGeo::Feature::Geometry + include ::Enumerable + include ::RGeo::Feature::GeometryCollection + include ::RGeo::Feature::MultiPoint + include ::RGeo::ImplHelper::ValidityCheck + include ::RGeo::Feature::Instance + include ::RGeo::Geos::CAPIGeometryMethods + include ::RGeo::Geos::CAPIGeometryCollectionMethods + include ::RGeo::Geos::CAPIMultiPointMethods + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def *(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def +(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def -(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def boundary(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def buffer(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def contains?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def convex_hull(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def crosses?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def difference(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def disjoint?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def distance(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def envelope(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def intersection(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def intersects?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def node(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def overlaps?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def point_on_surface(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def relate?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def size(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def sym_difference(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def touches?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def transform(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def unary_union(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def union(*args); end + + def unsafe_add(_arg0); end + def unsafe_boundary; end + def unsafe_buffer(_arg0); end + def unsafe_contains?(_arg0); end + def unsafe_convex_hull; end + def unsafe_crosses?(_arg0); end + def unsafe_difference(_arg0); end + def unsafe_disjoint?(_arg0); end + def unsafe_distance(_arg0); end + def unsafe_envelope; end + def unsafe_intersection(_arg0); end + def unsafe_intersects?(_arg0); end + def unsafe_multiply(_arg0); end + def unsafe_node; end + def unsafe_overlaps?(_arg0); end + def unsafe_point_on_surface; end + def unsafe_relate?(_arg0, _arg1); end + def unsafe_remove(_arg0); end + def unsafe_size; end + def unsafe_sym_difference(_arg0); end + def unsafe_touches?(_arg0); end + + # source://rgeo//lib/rgeo/feature/geometry.rb#722 + def unsafe_transform(other_factory); end + + def unsafe_unary_union; end + def unsafe_union(_arg0); end + def unsafe_within?(_arg0); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def within?(*args); end + + private + + def create(_arg0, _arg1); end + + class << self + def create(_arg0, _arg1); end + end +end + +module RGeo::Geos::CAPIMultiPointMethods + def coordinates; end + def geometry_type; end + def hash; end +end + +# source://rgeo//lib/rgeo/geos/capi_feature_classes.rb#148 +class RGeo::Geos::CAPIMultiPolygonImpl + include ::RGeo::Feature::Geometry + include ::Enumerable + include ::RGeo::Feature::GeometryCollection + include ::RGeo::Feature::MultiSurface + include ::RGeo::Feature::MultiPolygon + include ::RGeo::ImplHelper::ValidityCheck + include ::RGeo::Feature::Instance + include ::RGeo::Geos::CAPIGeometryMethods + include ::RGeo::Geos::CAPIGeometryCollectionMethods + include ::RGeo::Geos::CAPIMultiPolygonMethods + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def *(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def +(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def -(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def area(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def boundary(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def buffer(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def centroid(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def contains?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def convex_hull(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def crosses?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def difference(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def disjoint?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def distance(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def envelope(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def intersection(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def intersects?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def node(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def overlaps?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def point_on_surface(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def relate?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def size(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def sym_difference(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def touches?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def transform(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def unary_union(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def union(*args); end + + def unsafe_add(_arg0); end + def unsafe_area; end + def unsafe_boundary; end + def unsafe_buffer(_arg0); end + def unsafe_centroid; end + def unsafe_contains?(_arg0); end + def unsafe_convex_hull; end + def unsafe_crosses?(_arg0); end + def unsafe_difference(_arg0); end + def unsafe_disjoint?(_arg0); end + def unsafe_distance(_arg0); end + def unsafe_envelope; end + def unsafe_intersection(_arg0); end + def unsafe_intersects?(_arg0); end + def unsafe_multiply(_arg0); end + def unsafe_node; end + def unsafe_overlaps?(_arg0); end + def unsafe_point_on_surface; end + def unsafe_relate?(_arg0, _arg1); end + def unsafe_remove(_arg0); end + def unsafe_size; end + def unsafe_sym_difference(_arg0); end + def unsafe_touches?(_arg0); end + + # source://rgeo//lib/rgeo/feature/geometry.rb#722 + def unsafe_transform(other_factory); end + + def unsafe_unary_union; end + def unsafe_union(_arg0); end + def unsafe_within?(_arg0); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def within?(*args); end + + private + + def create(_arg0, _arg1); end + + class << self + def create(_arg0, _arg1); end + end +end + +module RGeo::Geos::CAPIMultiPolygonMethods + def area; end + def centroid; end + def coordinates; end + def geometry_type; end + def hash; end +end + +# source://rgeo//lib/rgeo/geos/capi_feature_classes.rb#84 +class RGeo::Geos::CAPIPointImpl + include ::RGeo::Feature::Geometry + include ::RGeo::Feature::Point + include ::RGeo::ImplHelper::ValidityCheck + include ::RGeo::Feature::Instance + include ::RGeo::Geos::CAPIGeometryMethods + include ::RGeo::Geos::CAPIPointMethods + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def *(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def +(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def -(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def boundary(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def buffer(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def contains?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def convex_hull(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def crosses?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def difference(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def disjoint?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def distance(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def envelope(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def intersection(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def intersects?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def overlaps?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def relate?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def sym_difference(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def touches?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def transform(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def unary_union(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def union(*args); end + + def unsafe_add(_arg0); end + def unsafe_boundary; end + def unsafe_buffer(_arg0); end + def unsafe_contains?(_arg0); end + def unsafe_convex_hull; end + def unsafe_crosses?(_arg0); end + def unsafe_difference(_arg0); end + def unsafe_disjoint?(_arg0); end + def unsafe_distance(_arg0); end + def unsafe_envelope; end + def unsafe_intersection(_arg0); end + def unsafe_intersects?(_arg0); end + def unsafe_multiply(_arg0); end + def unsafe_overlaps?(_arg0); end + def unsafe_relate?(_arg0, _arg1); end + def unsafe_remove(_arg0); end + def unsafe_sym_difference(_arg0); end + def unsafe_touches?(_arg0); end + + # source://rgeo//lib/rgeo/feature/geometry.rb#722 + def unsafe_transform(other_factory); end + + def unsafe_unary_union; end + def unsafe_union(_arg0); end + def unsafe_within?(_arg0); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def within?(*args); end + + private + + def create(_arg0, _arg1, _arg2, _arg3); end + + class << self + def create(_arg0, _arg1, _arg2, _arg3); end + end +end + +module RGeo::Geos::CAPIPointMethods + def coordinates; end + def eql?(_arg0); end + def geometry_type; end + def hash; end + def m; end + def rep_equals?(_arg0); end + def x; end + def y; end + def z; end +end + +# source://rgeo//lib/rgeo/geos/capi_feature_classes.rb#118 +class RGeo::Geos::CAPIPolygonImpl + include ::RGeo::Feature::Geometry + include ::RGeo::Feature::Surface + include ::RGeo::Feature::Polygon + include ::RGeo::ImplHelper::ValidityCheck + include ::RGeo::Feature::Instance + include ::RGeo::Geos::CAPIGeometryMethods + include ::RGeo::Geos::CAPIPolygonMethods + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def *(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def +(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def -(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def area(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def boundary(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def buffer(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def centroid(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def contains?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def convex_hull(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def crosses?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def difference(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def disjoint?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def distance(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def envelope(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def interior_ring_n(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def intersection(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def intersects?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def overlaps?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def point_on_surface(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def relate?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def sym_difference(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def touches?(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def transform(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def unary_union(*args); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def union(*args); end + + def unsafe_add(_arg0); end + def unsafe_area; end + def unsafe_boundary; end + def unsafe_buffer(_arg0); end + def unsafe_centroid; end + def unsafe_contains?(_arg0); end + def unsafe_convex_hull; end + def unsafe_crosses?(_arg0); end + def unsafe_difference(_arg0); end + def unsafe_disjoint?(_arg0); end + def unsafe_distance(_arg0); end + def unsafe_envelope; end + def unsafe_interior_ring_n(_arg0); end + def unsafe_intersection(_arg0); end + def unsafe_intersects?(_arg0); end + def unsafe_multiply(_arg0); end + def unsafe_overlaps?(_arg0); end + def unsafe_point_on_surface; end + def unsafe_relate?(_arg0, _arg1); end + def unsafe_remove(_arg0); end + def unsafe_sym_difference(_arg0); end + def unsafe_touches?(_arg0); end + + # source://rgeo//lib/rgeo/feature/geometry.rb#722 + def unsafe_transform(other_factory); end + + def unsafe_unary_union; end + def unsafe_union(_arg0); end + def unsafe_within?(_arg0); end + + # source://rgeo//lib/rgeo/impl_helper/validity_check.rb#77 + def within?(*args); end + + private + + def create(_arg0, _arg1, _arg2); end + + class << self + def create(_arg0, _arg1, _arg2); end + end +end + +module RGeo::Geos::CAPIPolygonMethods + def area; end + def centroid; end + def coordinates; end + def eql?(_arg0); end + def exterior_ring; end + def geometry_type; end + def hash; end + def interior_ring_n(_arg0); end + def interior_rings; end + def num_interior_rings; end + def point_on_surface; end + def rep_equals?(_arg0); end +end + +# continue +# +# source://rgeo//lib/rgeo/geos.rb#31 +RGeo::Geos::CAPI_SUPPORTED = T.let(T.unsafe(nil), TrueClass) + +# source://rgeo//lib/rgeo/geos.rb#67 +RGeo::Geos::CAP_FLAT = T.let(T.unsafe(nil), Integer) + +# source://rgeo//lib/rgeo/geos.rb#66 +RGeo::Geos::CAP_ROUND = T.let(T.unsafe(nil), Integer) + +# source://rgeo//lib/rgeo/geos.rb#68 +RGeo::Geos::CAP_SQUARE = T.let(T.unsafe(nil), Integer) + +# source://rgeo//lib/rgeo/geos.rb#49 +RGeo::Geos::FFI_SUPPORTED = T.let(T.unsafe(nil), FalseClass) + +# source://rgeo//lib/rgeo/geos.rb#50 +RGeo::Geos::FFI_SUPPORT_EXCEPTION = T.let(T.unsafe(nil), LoadError) + +# source://rgeo//lib/rgeo/geos.rb#72 +RGeo::Geos::JOIN_BEVEL = T.let(T.unsafe(nil), Integer) + +# source://rgeo//lib/rgeo/geos.rb#71 +RGeo::Geos::JOIN_MITRE = T.let(T.unsafe(nil), Integer) + +# source://rgeo//lib/rgeo/geos.rb#70 +RGeo::Geos::JOIN_ROUND = T.let(T.unsafe(nil), Integer) + +# source://rgeo//lib/rgeo/geos/utils.rb#11 +module RGeo::Geos::Utils + class << self + # source://rgeo//lib/rgeo/geos/utils.rb#28 + def ffi_compute_dimension(geom); end + + # source://rgeo//lib/rgeo/geos/utils.rb#52 + def ffi_coord_seq_hash(coord_seq, init_hash = T.unsafe(nil)); end + + # @return [Boolean] + # + # source://rgeo//lib/rgeo/geos/utils.rb#13 + def ffi_coord_seqs_equal?(cs1, cs2, check_z); end + + # source://rgeo//lib/rgeo/geos/utils.rb#58 + def ffi_supports_prepared_level1; end + + # source://rgeo//lib/rgeo/geos/utils.rb#62 + def ffi_supports_prepared_level2; end + + # source://rgeo//lib/rgeo/geos/utils.rb#66 + def ffi_supports_set_output_dimension; end + + # source://rgeo//lib/rgeo/geos/utils.rb#70 + def ffi_supports_unary_union; end + + # source://rgeo//lib/rgeo/geos/utils.rb#78 + def marshal_wkb_generator; end + + # source://rgeo//lib/rgeo/geos/utils.rb#74 + def psych_wkt_generator; end + end +end + +# A factory for Geos that handles both Z and M. +# +# source://rgeo//lib/rgeo/geos/zm_factory.rb#12 +class RGeo::Geos::ZMFactory + include ::RGeo::Feature::Factory::Instance + include ::RGeo::ImplHelper::Utils + + # @return [ZMFactory] a new instance of ZMFactory + # + # source://rgeo//lib/rgeo/geos/zm_factory.rb#42 + def initialize(opts = T.unsafe(nil)); end + + # Factory equivalence test. + # + # @return [Boolean] + # + # source://rgeo//lib/rgeo/geos/zm_factory.rb#195 + def ==(other); end + + # Returns the resolution used by buffer calculations on geometries + # created by this factory + # + # source://rgeo//lib/rgeo/geos/zm_factory.rb#177 + def buffer_resolution; end + + # See RGeo::Feature::Factory#collection + # + # source://rgeo//lib/rgeo/geos/zm_factory.rb#267 + def collection(elems); end + + # See RGeo::Feature::Factory#coord_sys + # + # source://rgeo//lib/rgeo/geos/zm_factory.rb#291 + def coord_sys; end + + # source://rgeo//lib/rgeo/geos/zm_factory.rb#328 + def create_feature(klass, zgeometry, mgeometry); end + + # Psych support + # + # source://rgeo//lib/rgeo/geos/zm_factory.rb#134 + def encode_with(coder); end + + # Factory equivalence test. + # + # @return [Boolean] + # + # source://rgeo//lib/rgeo/geos/zm_factory.rb#195 + def eql?(other); end + + # Standard hash code + # + # source://rgeo//lib/rgeo/geos/zm_factory.rb#202 + def hash; end + + # source://rgeo//lib/rgeo/geos/zm_factory.rb#149 + def init_with(coder); end + + # See RGeo::Feature::Factory#line + # + # source://rgeo//lib/rgeo/geos/zm_factory.rb#245 + def line(start, stop); end + + # See RGeo::Feature::Factory#line_string + # + # source://rgeo//lib/rgeo/geos/zm_factory.rb#239 + def line_string(points); end + + # See RGeo::Feature::Factory#linear_ring + # + # source://rgeo//lib/rgeo/geos/zm_factory.rb#251 + def linear_ring(points); end + + # Returns the m-only factory corresponding to this factory. + # + # source://rgeo//lib/rgeo/geos/zm_factory.rb#189 + def m_factory; end + + # Marshal support + # + # source://rgeo//lib/rgeo/geos/zm_factory.rb#97 + def marshal_dump; end + + # source://rgeo//lib/rgeo/geos/zm_factory.rb#113 + def marshal_load(data); end + + # source://rgeo//lib/rgeo/geos/zm_factory.rb#333 + def marshal_wkb_generator; end + + # source://rgeo//lib/rgeo/geos/zm_factory.rb#337 + def marshal_wkb_parser; end + + # See RGeo::Feature::Factory#multi_line_string + # + # source://rgeo//lib/rgeo/geos/zm_factory.rb#279 + def multi_line_string(elems); end + + # See RGeo::Feature::Factory#multi_point + # + # source://rgeo//lib/rgeo/geos/zm_factory.rb#273 + def multi_point(elems); end + + # See RGeo::Feature::Factory#multi_polygon + # + # source://rgeo//lib/rgeo/geos/zm_factory.rb#285 + def multi_polygon(elems); end + + # See RGeo::Feature::Factory#override_cast + # + # source://rgeo//lib/rgeo/geos/zm_factory.rb#297 + def override_cast(original, ntype, flags); end + + # See RGeo::Feature::Factory#parse_wkb + # + # source://rgeo//lib/rgeo/geos/zm_factory.rb#223 + def parse_wkb(str); end + + # See RGeo::Feature::Factory#parse_wkt + # + # source://rgeo//lib/rgeo/geos/zm_factory.rb#217 + def parse_wkt(str); end + + # See RGeo::Feature::Factory#point + # + # source://rgeo//lib/rgeo/geos/zm_factory.rb#229 + def point(x, y, z = T.unsafe(nil), m = T.unsafe(nil)); end + + # See RGeo::Feature::Factory#polygon + # + # source://rgeo//lib/rgeo/geos/zm_factory.rb#257 + def polygon(outer_ring, inner_rings = T.unsafe(nil)); end + + # See RGeo::Feature::Factory#property + # + # source://rgeo//lib/rgeo/geos/zm_factory.rb#208 + def property(name); end + + # source://rgeo//lib/rgeo/geos/zm_factory.rb#341 + def psych_wkt_generator; end + + # source://rgeo//lib/rgeo/geos/zm_factory.rb#345 + def psych_wkt_parser; end + + # Returns the SRID of geometries created by this factory. + # + # source://rgeo//lib/rgeo/geos/zm_factory.rb#170 + def srid; end + + # Returns the z-only factory corresponding to this factory. + # + # source://rgeo//lib/rgeo/geos/zm_factory.rb#183 + def z_factory; end + + class << self + # Create a new factory. Returns nil if the GEOS implementation is + # not supported. + # + # source://rgeo//lib/rgeo/geos/zm_factory.rb#36 + def create(opts = T.unsafe(nil)); end + end +end + +# :stopdoc: +# +# source://rgeo//lib/rgeo/geos/zm_factory.rb#18 +RGeo::Geos::ZMFactory::TYPE_KLASSES = T.let(T.unsafe(nil), Hash) + +# source://rgeo//lib/rgeo/geos/zm_feature_classes.rb#36 +class RGeo::Geos::ZMGeometryCollectionImpl + include ::RGeo::Feature::Instance + include ::RGeo::Geos::ZMGeometryMethods + include ::Enumerable + include ::RGeo::Geos::ZMGeometryCollectionMethods +end + +# source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#318 +module RGeo::Geos::ZMGeometryCollectionMethods + include ::Enumerable + include ::ActiveSupport::ToJsonWithActiveSupportEncoder + + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#324 + def [](idx); end + + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#329 + def each; end + + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#324 + def geometry_n(idx); end + + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#319 + def num_geometries; end + + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#319 + def size; end +end + +# source://rgeo//lib/rgeo/geos/zm_feature_classes.rb#58 +class RGeo::Geos::ZMGeometryImpl + include ::RGeo::Feature::Instance + include ::RGeo::Geos::ZMGeometryMethods +end + +# source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#11 +module RGeo::Geos::ZMGeometryMethods include ::RGeo::Feature::Instance # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#14 def initialize(factory, zgeometry, mgeometry); end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#145 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#144 def *(rhs); end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#150 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#149 def +(rhs); end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#155 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#154 def -(rhs); end # @return [Boolean] @@ -11452,7 +13082,7 @@ module RGeo::Geos::ZMGeometryMethods # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#92 def boundary; end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#137 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#136 def buffer(distance_); end # @return [Boolean] @@ -11460,7 +13090,7 @@ module RGeo::Geos::ZMGeometryMethods # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#120 def contains?(rhs); end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#141 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#140 def convex_hull; end # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#48 @@ -11471,7 +13101,7 @@ module RGeo::Geos::ZMGeometryMethods # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#112 def crosses?(rhs); end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#155 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#154 def difference(rhs); end # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#44 @@ -11482,7 +13112,7 @@ module RGeo::Geos::ZMGeometryMethods # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#100 def disjoint?(rhs); end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#133 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#132 def distance(rhs); end # @return [Boolean] @@ -11490,7 +13120,7 @@ module RGeo::Geos::ZMGeometryMethods # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#76 def empty?; end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#192 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#191 def encode_with(coder); end # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#64 @@ -11498,7 +13128,7 @@ module RGeo::Geos::ZMGeometryMethods # @return [Boolean] # - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#169 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#168 def eql?(rhs); end # @return [Boolean] @@ -11515,13 +13145,13 @@ module RGeo::Geos::ZMGeometryMethods # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#28 def hash; end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#197 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#196 def init_with(coder); end # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#20 def inspect; end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#145 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#144 def intersection(rhs); end # @return [Boolean] @@ -11537,10 +13167,10 @@ module RGeo::Geos::ZMGeometryMethods # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#40 def m_geometry; end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#184 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#183 def marshal_dump; end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#188 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#187 def marshal_load(data); end # @return [Boolean] @@ -11553,13 +13183,6 @@ module RGeo::Geos::ZMGeometryMethods # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#124 def overlaps?(rhs); end - # DEPRECATED - # - # @return [Boolean] - # - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#128 - def relate(rhs, pattern); end - # @return [Boolean] # # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#128 @@ -11567,7 +13190,7 @@ module RGeo::Geos::ZMGeometryMethods # @return [Boolean] # - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#169 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#168 def rep_equals?(rhs); end # @return [Boolean] @@ -11581,7 +13204,7 @@ module RGeo::Geos::ZMGeometryMethods # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#60 def srid; end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#160 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#159 def sym_difference(rhs); end # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#24 @@ -11592,7 +13215,7 @@ module RGeo::Geos::ZMGeometryMethods # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#108 def touches?(rhs); end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#150 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#149 def union(rhs); end # @return [Boolean] @@ -11605,7 +13228,7 @@ module RGeo::Geos::ZMGeometryMethods private - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#203 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#202 def copy_state_from(obj); end end @@ -11623,37 +13246,37 @@ class RGeo::Geos::ZMLineStringImpl include ::RGeo::Geos::ZMLineStringMethods end -# source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#235 +# source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#234 module RGeo::Geos::ZMLineStringMethods # @return [Boolean] # - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#248 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#247 def closed?; end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#274 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#273 def coordinates; end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#244 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#243 def end_point; end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#236 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#235 def length; end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#256 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#255 def num_points; end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#260 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#259 def point_n(idx); end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#264 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#263 def points; end # @return [Boolean] # - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#252 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#251 def ring?; end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#240 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#239 def start_point; end end @@ -11673,17 +13296,17 @@ class RGeo::Geos::ZMMultiLineStringImpl include ::RGeo::Geos::ZMMultiLineStringMethods end -# source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#344 +# source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#343 module RGeo::Geos::ZMMultiLineStringMethods # @return [Boolean] # - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#349 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#348 def closed?; end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#353 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#352 def coordinates; end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#345 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#344 def length; end end @@ -11704,18 +13327,18 @@ class RGeo::Geos::ZMMultiPolygonImpl include ::RGeo::Geos::ZMMultiPolygonMethods end -# source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#358 +# source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#357 module RGeo::Geos::ZMMultiPolygonMethods - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#359 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#358 def area; end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#363 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#362 def centroid; end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#371 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#370 def coordinates; end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#367 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#366 def point_on_surface; end end @@ -11726,21 +13349,21 @@ class RGeo::Geos::ZMPointImpl include ::RGeo::Geos::ZMPointMethods end -# source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#210 +# source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#209 module RGeo::Geos::ZMPointMethods - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#227 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#226 def coordinates; end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#223 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#222 def m; end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#211 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#210 def x; end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#215 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#214 def y; end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#219 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#218 def z; end end @@ -11751,30 +13374,30 @@ class RGeo::Geos::ZMPolygonImpl include ::RGeo::Geos::ZMPolygonMethods end -# source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#279 +# source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#278 module RGeo::Geos::ZMPolygonMethods - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#280 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#279 def area; end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#284 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#283 def centroid; end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#314 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#313 def coordinates; end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#292 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#291 def exterior_ring; end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#300 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#299 def interior_ring_n(idx); end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#304 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#303 def interior_rings; end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#296 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#295 def num_interior_rings; end - # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#288 + # source://rgeo//lib/rgeo/geos/zm_feature_methods.rb#287 def point_on_surface; end end diff --git a/sorbet/rbi/gems/rouge@4.1.3.rbi b/sorbet/rbi/gems/rouge@4.3.0.rbi similarity index 98% rename from sorbet/rbi/gems/rouge@4.1.3.rbi rename to sorbet/rbi/gems/rouge@4.3.0.rbi index fb250ada3..43024a025 100644 --- a/sorbet/rbi/gems/rouge@4.1.3.rbi +++ b/sorbet/rbi/gems/rouge@4.3.0.rbi @@ -1599,6 +1599,9 @@ class Rouge::Lexers::Clojure < ::Rouge::RegexLexer end end +# source://rouge//lib/rouge/lexers/codeowners.rb#6 +class Rouge::Lexers::Codeowners < ::Rouge::RegexLexer; end + # source://rouge//lib/rouge/lexers/coffeescript.rb#6 class Rouge::Lexers::Coffeescript < ::Rouge::RegexLexer class << self @@ -1921,7 +1924,14 @@ Rouge::Lexers::Eiffel::SimpleString = T.let(T.unsafe(nil), Regexp) # See: https://bitbucket.org/birkenfeld/pygments-main/src/7304e4759ae65343d89a51359ca538912519cc31/pygments/lexers/functional.py?at=default#cl-2362 # # source://rouge//lib/rouge/lexers/elixir.rb#8 -class Rouge::Lexers::Elixir < ::Rouge::RegexLexer; end +class Rouge::Lexers::Elixir < ::Rouge::RegexLexer + class << self + # @return [Boolean] + # + # source://rouge//lib/rouge/lexers/elixir.rb#17 + def detect?(text); end + end +end # source://rouge//lib/rouge/lexers/elm.rb#6 class Rouge::Lexers::Elm < ::Rouge::RegexLexer; end @@ -2424,19 +2434,19 @@ end # source://rouge//lib/rouge/lexers/hcl.rb#6 class Rouge::Lexers::Hcl < ::Rouge::RegexLexer class << self - # source://rouge//lib/rouge/lexers/hcl.rb#55 + # source://rouge//lib/rouge/lexers/hcl.rb#56 def builtins; end - # source://rouge//lib/rouge/lexers/hcl.rb#51 + # source://rouge//lib/rouge/lexers/hcl.rb#52 def constants; end - # source://rouge//lib/rouge/lexers/hcl.rb#43 + # source://rouge//lib/rouge/lexers/hcl.rb#44 def declarations; end - # source://rouge//lib/rouge/lexers/hcl.rb#39 + # source://rouge//lib/rouge/lexers/hcl.rb#40 def keywords; end - # source://rouge//lib/rouge/lexers/hcl.rb#47 + # source://rouge//lib/rouge/lexers/hcl.rb#48 def reserved; end end end @@ -2554,6 +2564,23 @@ class Rouge::Lexers::Idris < ::Rouge::RegexLexer end end +# source://rouge//lib/rouge/lexers/iecst.rb#6 +class Rouge::Lexers::IecST < ::Rouge::RegexLexer + class << self + # source://rouge//lib/rouge/lexers/iecst.rb#14 + def keywords; end + + # source://rouge//lib/rouge/lexers/iecst.rb#39 + def literals; end + + # source://rouge//lib/rouge/lexers/iecst.rb#43 + def operators; end + + # source://rouge//lib/rouge/lexers/iecst.rb#29 + def types; end + end +end + # source://rouge//lib/rouge/lexers/igorpro.rb#6 class Rouge::Lexers::IgorPro < ::Rouge::RegexLexer class << self @@ -2788,6 +2815,9 @@ Rouge::Lexers::Julia::BUILTINS = T.let(T.unsafe(nil), Regexp) # source://rouge//lib/rouge/lexers/julia.rb#30 Rouge::Lexers::Julia::KEYWORDS = T.let(T.unsafe(nil), Regexp) +# source://rouge//lib/rouge/lexers/julia.rb#255 +Rouge::Lexers::Julia::NAME_RE = T.let(T.unsafe(nil), Regexp) + # source://rouge//lib/rouge/lexers/julia.rb#170 Rouge::Lexers::Julia::OPERATORS = T.let(T.unsafe(nil), Regexp) @@ -3113,7 +3143,7 @@ end # source://rouge//lib/rouge/lexers/meson.rb#6 class Rouge::Lexers::Meson < ::Rouge::RegexLexer - # source://rouge//lib/rouge/lexers/meson.rb#43 + # source://rouge//lib/rouge/lexers/meson.rb#42 def current_string; end class << self @@ -3128,22 +3158,22 @@ class Rouge::Lexers::Meson < ::Rouge::RegexLexer end end -# source://rouge//lib/rouge/lexers/meson.rb#138 +# source://rouge//lib/rouge/lexers/meson.rb#137 class Rouge::Lexers::Meson::StringRegister < ::Array # @return [Boolean] # - # source://rouge//lib/rouge/lexers/meson.rb#139 + # source://rouge//lib/rouge/lexers/meson.rb#138 def delim?(delim); end - # source://rouge//lib/rouge/lexers/meson.rb#143 + # source://rouge//lib/rouge/lexers/meson.rb#142 def register(type: T.unsafe(nil), delim: T.unsafe(nil)); end - # source://rouge//lib/rouge/lexers/meson.rb#147 + # source://rouge//lib/rouge/lexers/meson.rb#146 def remove; end # @return [Boolean] # - # source://rouge//lib/rouge/lexers/meson.rb#151 + # source://rouge//lib/rouge/lexers/meson.rb#150 def type?(type); end end @@ -3308,19 +3338,19 @@ end # source://rouge//lib/rouge/lexers/objective_c/common.rb#6 module Rouge::Lexers::ObjectiveCCommon - # source://rouge//lib/rouge/lexers/objective_c/common.rb#17 + # source://rouge//lib/rouge/lexers/objective_c/common.rb#15 def at_builtins; end - # source://rouge//lib/rouge/lexers/objective_c/common.rb#9 + # source://rouge//lib/rouge/lexers/objective_c/common.rb#7 def at_keywords; end - # source://rouge//lib/rouge/lexers/objective_c/common.rb#21 + # source://rouge//lib/rouge/lexers/objective_c/common.rb#19 def builtins; end class << self # @private # - # source://rouge//lib/rouge/lexers/objective_c/common.rb#25 + # source://rouge//lib/rouge/lexers/objective_c/common.rb#23 def extended(base); end end end @@ -3333,13 +3363,13 @@ end # source://rouge//lib/rouge/lexers/openedge.rb#6 class Rouge::Lexers::OpenEdge < ::Rouge::RegexLexer class << self - # source://rouge//lib/rouge/lexers/openedge.rb#19 + # source://rouge//lib/rouge/lexers/openedge.rb#17 def keywords; end - # source://rouge//lib/rouge/lexers/openedge.rb#495 + # source://rouge//lib/rouge/lexers/openedge.rb#493 def keywords_prepro; end - # source://rouge//lib/rouge/lexers/openedge.rb#504 + # source://rouge//lib/rouge/lexers/openedge.rb#502 def keywords_type; end end end @@ -4041,6 +4071,14 @@ class Rouge::Lexers::SuperCollider < ::Rouge::RegexLexer end end +# source://rouge//lib/rouge/lexers/svelte.rb#8 +class Rouge::Lexers::Svelte < ::Rouge::Lexers::HTML + # @return [Svelte] a new instance of Svelte + # + # source://rouge//lib/rouge/lexers/svelte.rb#14 + def initialize(*_arg0); end +end + # source://rouge//lib/rouge/lexers/swift.rb#6 class Rouge::Lexers::Swift < ::Rouge::RegexLexer; end @@ -5047,32 +5085,33 @@ end # source://rouge//lib/rouge/themes/thankful_eyes.rb#5 module Rouge::Themes; end -# default base16 theme -# by Chris Kempson (http://chriskempson.com) +# author Chris Kempson +# base16 default dark +# https://github.com/chriskempson/base16-default-schemes # -# source://rouge//lib/rouge/themes/base16.rb#8 +# source://rouge//lib/rouge/themes/base16.rb#9 class Rouge::Themes::Base16 < ::Rouge::CSSTheme extend ::Rouge::HasModes class << self - # source://rouge//lib/rouge/themes/base16.rb#35 + # source://rouge//lib/rouge/themes/base16.rb#36 def dark!; end - # source://rouge//lib/rouge/themes/base16.rb#30 + # source://rouge//lib/rouge/themes/base16.rb#31 def light!; end - # source://rouge//lib/rouge/themes/base16.rb#40 + # source://rouge//lib/rouge/themes/base16.rb#41 def make_dark!; end - # source://rouge//lib/rouge/themes/base16.rb#44 + # source://rouge//lib/rouge/themes/base16.rb#45 def make_light!; end end end -# source://rouge//lib/rouge/themes/base16.rb#108 +# source://rouge//lib/rouge/themes/base16.rb#113 class Rouge::Themes::Base16::Monokai < ::Rouge::Themes::Base16; end -# source://rouge//lib/rouge/themes/base16.rb#85 +# source://rouge//lib/rouge/themes/base16.rb#90 class Rouge::Themes::Base16::Solarized < ::Rouge::Themes::Base16; end # A port of the bw style from Pygments. @@ -5450,6 +5489,9 @@ class Rouge::Token::Tokens::Generic::Deleted < ::Rouge::Token::Tokens::Generic; # source://rouge//lib/rouge/token.rb#48 class Rouge::Token::Tokens::Generic::Emph < ::Rouge::Token::Tokens::Generic; end +# source://rouge//lib/rouge/token.rb#48 +class Rouge::Token::Tokens::Generic::EmphStrong < ::Rouge::Token::Tokens::Generic; end + # source://rouge//lib/rouge/token.rb#48 class Rouge::Token::Tokens::Generic::Error < ::Rouge::Token::Tokens::Generic; end @@ -5638,7 +5680,7 @@ class Rouge::Token::Tokens::Name::Variable::Magic < ::Rouge::Token::Tokens::Name # convenience # -# source://rouge//lib/rouge/token.rb#187 +# source://rouge//lib/rouge/token.rb#188 Rouge::Token::Tokens::Num = Rouge::Token::Tokens::Literal::Number # source://rouge//lib/rouge/token.rb#48 @@ -5656,7 +5698,7 @@ class Rouge::Token::Tokens::Punctuation < ::Rouge::Token; end # source://rouge//lib/rouge/token.rb#48 class Rouge::Token::Tokens::Punctuation::Indicator < ::Rouge::Token::Tokens::Punctuation; end -# source://rouge//lib/rouge/token.rb#188 +# source://rouge//lib/rouge/token.rb#189 Rouge::Token::Tokens::Str = Rouge::Token::Tokens::Literal::String # source://rouge//lib/rouge/token.rb#48 diff --git a/sorbet/rbi/gems/rspec-activemodel-mocks@1.1.0.rbi b/sorbet/rbi/gems/rspec-activemodel-mocks@1.2.0.rbi similarity index 98% rename from sorbet/rbi/gems/rspec-activemodel-mocks@1.1.0.rbi rename to sorbet/rbi/gems/rspec-activemodel-mocks@1.2.0.rbi index 61e573aa0..84b77de85 100644 --- a/sorbet/rbi/gems/rspec-activemodel-mocks@1.1.0.rbi +++ b/sorbet/rbi/gems/rspec-activemodel-mocks@1.2.0.rbi @@ -5,7 +5,7 @@ # Please instead update this file by running `bin/tapioca gem rspec-activemodel-mocks`. -# source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/version.rb#1 +# source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/version.rb#2 module RSpec class << self # source://rspec-core/3.13.0/lib/rspec/core.rb#70 @@ -76,16 +76,16 @@ module RSpec end end -# source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/version.rb#2 +# source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/version.rb#3 module RSpec::ActiveModel; end -# source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/version.rb#3 +# source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/version.rb#4 module RSpec::ActiveModel::Mocks; end -# source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/mocks.rb#6 +# source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/mocks.rb#7 class RSpec::ActiveModel::Mocks::IllegalDataAccessException < ::StandardError; end -# source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/mocks.rb#7 +# source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/mocks.rb#8 module RSpec::ActiveModel::Mocks::Mocks # Creates a test double representing `string_or_model_class` with common # ActiveModel methods stubbed out. Additional methods may be easily @@ -105,7 +105,7 @@ module RSpec::ActiveModel::Mocks::Mocks # * A String representing a Class that extends ActiveModel::Naming # * A Class that extends ActiveModel::Naming # - # source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/mocks.rb#94 + # source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/mocks.rb#96 def mock_model(string_or_model_class, stubs = T.unsafe(nil)); end # Creates an instance of `Model` with `to_param` stubbed using a @@ -136,12 +136,12 @@ module RSpec::ActiveModel::Mocks::Mocks # stub_model(Person, :to_param => 37) # stub_model(Person) {|person| person.first_name = "David"} # - # source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/mocks.rb#243 + # source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/mocks.rb#264 def stub_model(model_class, stubs = T.unsafe(nil)); end private - # source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/mocks.rb#273 + # source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/mocks.rb#300 def next_id; end end @@ -170,18 +170,18 @@ module RSpec::ActiveModel::Mocks::Mocks::ActiveModelInstanceMethods def respond_to?(message, include_private = T.unsafe(nil)); end end -# source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/mocks.rb#183 +# source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/mocks.rb#201 module RSpec::ActiveModel::Mocks::Mocks::ActiveModelStubExtensions # Stubs `persisted` to return false and `id` to return nil # - # source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/mocks.rb#185 + # source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/mocks.rb#203 def as_new_record; end # Returns `true` by default. Override with a stub. # # @return [Boolean] # - # source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/mocks.rb#192 + # source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/mocks.rb#210 def persisted?; end end @@ -218,25 +218,25 @@ module RSpec::ActiveModel::Mocks::Mocks::ActiveRecordInstanceMethods def new_record?; end end -# source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/mocks.rb#197 +# source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/mocks.rb#215 module RSpec::ActiveModel::Mocks::Mocks::ActiveRecordStubExtensions # Stubs `id` (or other primary key method) to return nil # - # source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/mocks.rb#199 + # source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/mocks.rb#217 def as_new_record; end # Raises an IllegalDataAccessException (stubbed models are not allowed to access the database) # # @raise [RSpec::ActiveModel::Mocks::IllegalDataAccessException] # - # source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/mocks.rb#211 + # source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/mocks.rb#229 def connection; end # Returns the opposite of `persisted?`. # # @return [Boolean] # - # source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/mocks.rb#205 + # source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/mocks.rb#223 def new_record?; end end @@ -281,8 +281,8 @@ class RSpec::ActiveModel::Mocks::Mocks::Association def target=(_arg0); end end -# source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/version.rb#4 +# source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/version.rb#5 module RSpec::ActiveModel::Mocks::Version; end -# source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/version.rb#5 +# source://rspec-activemodel-mocks//lib/rspec/active_model/mocks/version.rb#6 RSpec::ActiveModel::Mocks::Version::STRING = T.let(T.unsafe(nil), String) diff --git a/sorbet/rbi/gems/rspec-rails@6.0.3.rbi b/sorbet/rbi/gems/rspec-rails@6.1.3.rbi similarity index 98% rename from sorbet/rbi/gems/rspec-rails@6.0.3.rbi rename to sorbet/rbi/gems/rspec-rails@6.1.3.rbi index 27abf78b5..3d2e3e614 100644 --- a/sorbet/rbi/gems/rspec-rails@6.0.3.rbi +++ b/sorbet/rbi/gems/rspec-rails@6.1.3.rbi @@ -184,7 +184,7 @@ end class RSpec::Rails::Railtie < ::Rails::Railtie private - # source://rspec-rails//lib/rspec-rails.rb#50 + # source://rspec-rails//lib/rspec-rails.rb#57 def config_default_preview_path(options); end # @return [Boolean] @@ -197,6 +197,6 @@ class RSpec::Rails::Railtie < ::Rails::Railtie # @return [Boolean] # - # source://rspec-rails//lib/rspec-rails.rb#56 + # source://rspec-rails//lib/rspec-rails.rb#64 def supports_action_mailer_previews?(config); end end diff --git a/sorbet/rbi/gems/sanitize@6.1.1.rbi b/sorbet/rbi/gems/sanitize@6.1.2.rbi similarity index 98% rename from sorbet/rbi/gems/sanitize@6.1.1.rbi rename to sorbet/rbi/gems/sanitize@6.1.2.rbi index eaa555785..c1234daaf 100644 --- a/sorbet/rbi/gems/sanitize@6.1.1.rbi +++ b/sorbet/rbi/gems/sanitize@6.1.2.rbi @@ -246,13 +246,21 @@ class Sanitize::CSS # source://sanitize//lib/sanitize/css.rb#247 def property!(prop); end + # Returns `true` if the given node (which is an `image` or `image-set` function) contains only strings + # using an allowlisted protocol. + # + # @return [Boolean] + # + # source://sanitize//lib/sanitize/css.rb#354 + def valid_image?(node); end + # Returns `true` if the given node (which may be of type `:url` or # `:function`, since the CSS syntax can produce both) uses an allowlisted # protocol. # # @return [Boolean] # - # source://sanitize//lib/sanitize/css.rb#301 + # source://sanitize//lib/sanitize/css.rb#305 def valid_url?(node); end class << self diff --git a/sorbet/rbi/gems/searchkick@5.3.0.rbi b/sorbet/rbi/gems/searchkick@5.3.1.rbi similarity index 100% rename from sorbet/rbi/gems/searchkick@5.3.0.rbi rename to sorbet/rbi/gems/searchkick@5.3.1.rbi diff --git a/sorbet/rbi/gems/sidekiq-cron@1.10.1.rbi b/sorbet/rbi/gems/sidekiq-cron@1.12.0.rbi similarity index 78% rename from sorbet/rbi/gems/sidekiq-cron@1.10.1.rbi rename to sorbet/rbi/gems/sidekiq-cron@1.12.0.rbi index a35482c4c..9c54e9cac 100644 --- a/sorbet/rbi/gems/sidekiq-cron@1.10.1.rbi +++ b/sorbet/rbi/gems/sidekiq-cron@1.12.0.rbi @@ -142,10 +142,10 @@ class Sidekiq::Cron::Job # Active Job has different structure how it is loading data from Sidekiq # queue, it creates a wrapper around job. # - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#135 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#136 def active_job_message; end - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#489 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#491 def add_jid_history(jid); end # Returns the value of attribute args. @@ -157,8 +157,8 @@ class Sidekiq::Cron::Job # # @param value the value to set the attribute args to. # - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#269 - def args=(_arg0); end + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#569 + def args=(args); end # Returns the value of attribute cron. # @@ -174,7 +174,7 @@ class Sidekiq::Cron::Job # @return [Boolean] # - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#87 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#88 def date_as_argument?; end # Returns the value of attribute description. @@ -189,45 +189,45 @@ class Sidekiq::Cron::Job # source://sidekiq-cron//lib/sidekiq/cron/job.rb#269 def description=(_arg0); end - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#504 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#506 def destroy; end - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#348 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#349 def disable!; end # @return [Boolean] # - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#362 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#363 def disabled?; end - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#353 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#354 def enable!; end # @return [Boolean] # - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#358 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#359 def enabled?; end # Enqueue cron job to queue. # - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#51 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#52 def enque!(time = T.unsafe(nil)); end - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#96 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#97 def enqueue_active_job(klass_const); end - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#91 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#92 def enqueue_args; end - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#100 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#101 def enqueue_sidekiq_worker(klass_const); end - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#428 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#430 def errors; end # @return [Boolean] # - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#559 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#561 def exists?; end # Returns the value of attribute fetch_missing_args. @@ -235,18 +235,18 @@ class Sidekiq::Cron::Job # source://sidekiq-cron//lib/sidekiq/cron/job.rb#270 def fetch_missing_args; end - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#544 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#546 def formatted_enqueue_time(now = T.unsafe(nil)); end - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#548 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#550 def formatted_last_time(now = T.unsafe(nil)); end # @return [Boolean] # - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#81 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#82 def is_active_job?(klass = T.unsafe(nil)); end - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#393 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#394 def jid_history_from_redis; end # Returns the value of attribute klass. @@ -261,7 +261,7 @@ class Sidekiq::Cron::Job # source://sidekiq-cron//lib/sidekiq/cron/job.rb#269 def klass=(_arg0); end - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#452 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#454 def klass_valid; end # Returns the value of attribute last_enqueue_time. @@ -269,13 +269,13 @@ class Sidekiq::Cron::Job # source://sidekiq-cron//lib/sidekiq/cron/job.rb#270 def last_enqueue_time; end - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#383 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#384 def last_enqueue_time_from_redis; end # Parse cron specification '* * * * *' and returns # time when last run should be performed # - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#540 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#542 def last_time(now = T.unsafe(nil)); end # Returns the value of attribute message. @@ -302,22 +302,22 @@ class Sidekiq::Cron::Job # source://sidekiq-cron//lib/sidekiq/cron/job.rb#269 def name=(_arg0); end - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#366 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#367 def pretty_message; end - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#111 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#112 def queue_name_with_prefix; end # Remove previous information about run times, # this will clear Redis and make sure that Redis will not overflow with memory. # - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#35 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#36 def remove_previous_enques(time); end - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#462 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#464 def save; end - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#482 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#484 def save_last_enqueue_time; end # Crucial part of whole enqueuing job. @@ -329,104 +329,109 @@ class Sidekiq::Cron::Job # Sidekiq worker message. # - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#105 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#106 def sidekiq_worker_message; end - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#563 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#565 def sort_name; end - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#344 + # Returns the value of attribute source. + # + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#270 + def source; end + + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#345 def status; end - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#372 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#373 def status_from_redis; end # Test if job should be enqueued. # - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#42 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#43 def test_and_enque_for_time!(time); end # Export job data to hash. # - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#405 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#406 def to_hash; end # @return [Boolean] # - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#432 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#434 def valid?; end private - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#670 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#676 def convert_to_global_id_hash(argument); end - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#677 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#683 def deserialize_argument(argument); end - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#698 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#704 def deserialize_global_id(hash); end - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#662 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#668 def jid_history_key; end - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#658 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#664 def job_enqueued_key; end # @return [Boolean] # - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#573 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#579 def not_enqueued_after?(time); end # @return [Boolean] # - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#628 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#634 def not_past_scheduled_time?(current_time); end # Try parsing inbound args into an array. # Args from Redis will be encoded JSON, # try to load JSON, then failover to string array. # - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#580 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#586 def parse_args(args); end - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#622 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#628 def parse_enqueue_time(timestamp); end - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#569 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#575 def parsed_cron; end # Redis key for storing one cron job. # - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#645 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#651 def redis_key; end - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#702 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#708 def serialize_argument(argument); end # @return [Boolean] # - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#694 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#700 def serialized_global_id?(hash); end - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#666 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#672 def serialized_last_enqueue_time; end - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#606 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#612 def symbolize_args(input); end # @return [Boolean] # - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#602 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#608 def symbolize_args?; end class << self # Get all cron jobs. # - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#215 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#216 def all; end - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#231 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#232 def count; end # Create new instance of cron job. @@ -441,33 +446,33 @@ class Sidekiq::Cron::Job # Remove all job from cron. # - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#523 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#525 def destroy_all!; end # Remove "removed jobs" between current jobs and new jobs # - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#531 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#533 def destroy_removed_jobs(new_job_names); end # @return [Boolean] # - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#552 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#554 def exists?(name); end - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#239 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#240 def find(name); end - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#654 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#660 def jid_history_key(name); end # Redis key for storing one cron job run times (when poller added job to queue) # - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#650 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#656 def job_enqueued_key(name); end # Redis key for set of all cron jobs. # - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#635 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#641 def jobs_key; end # Load cron jobs from Array. @@ -487,14 +492,14 @@ class Sidekiq::Cron::Job # } # ] # - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#197 - def load_from_array(array); end + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#198 + def load_from_array(array, options = T.unsafe(nil)); end # Like #load_from_array. # If exists old jobs in Redis but removed from args, destroy old jobs. # - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#208 - def load_from_array!(array); end + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#209 + def load_from_array!(array, options = T.unsafe(nil)); end # Load cron jobs from Hash. # Input structure should look like: @@ -511,18 +516,18 @@ class Sidekiq::Cron::Job # } # } # - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#165 - def load_from_hash(hash); end + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#166 + def load_from_hash(hash, options = T.unsafe(nil)); end # Like #load_from_hash. # If exists old jobs in Redis but removed from args, destroy old jobs. # - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#175 - def load_from_hash!(hash); end + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#176 + def load_from_hash!(hash, options = T.unsafe(nil)); end # Redis key for storing one cron job. # - # source://sidekiq-cron//lib/sidekiq/cron/job.rb#640 + # source://sidekiq-cron//lib/sidekiq/cron/job.rb#646 def redis_key(name); end end end @@ -620,6 +625,9 @@ module Sidekiq::Options def []=(key, value); end # source://sidekiq-cron//lib/sidekiq/options.rb#13 + def config; end + + # source://sidekiq-cron//lib/sidekiq/options.rb#17 def options_field; end end end diff --git a/sorbet/rbi/gems/simpleidn@0.2.3.rbi b/sorbet/rbi/gems/simpleidn@0.2.3.rbi new file mode 100644 index 000000000..9585ef591 --- /dev/null +++ b/sorbet/rbi/gems/simpleidn@0.2.3.rbi @@ -0,0 +1,200 @@ +# typed: true + +# DO NOT EDIT MANUALLY +# This is an autogenerated file for types exported from the `simpleidn` gem. +# Please instead update this file by running `bin/tapioca gem simpleidn`. + + +# IdnaMappingTable.txt +# Date: 2023-08-10, 22:32:27 GMT +# © 2023 Unicode®, Inc. +# Unicode and the Unicode Logo are registered trademarks of Unicode, Inc. in the U.S. and other countries. +# For terms of use, see https://www.unicode.org/terms_of_use.html +# +# Unicode IDNA Compatible Preprocessing for UTS #46 +# Version: 15.1.0 +# +# For documentation and usage, see https://www.unicode.org/reports/tr46 +# +# Total code points: 1114112 +# +# source://simpleidn//lib/simpleidn/version.rb#1 +module SimpleIDN + private + + # Converts a UTF-8 unicode string to a punycode ACE string. + # == Example + # SimpleIDN.to_ascii("møllerriis.com") + # => "xn--mllerriis-l8a.com" + # + # source://simpleidn//lib/simpleidn.rb#232 + def to_ascii(domain, transitional = T.unsafe(nil)); end + + # Converts a punycode ACE string to a UTF-8 unicode string. + # == Example + # SimpleIDN.to_unicode("xn--mllerriis-l8a.com") + # => "møllerriis.com" + # + # source://simpleidn//lib/simpleidn.rb#256 + def to_unicode(domain, transitional = T.unsafe(nil)); end + + # Applies UTS46 mapping to a Unicode string + # Returns a UTF-8 string in Normalization Form C (NFC) + # + # source://simpleidn//lib/simpleidn.rb#221 + def uts46map(str, transitional = T.unsafe(nil)); end + + class << self + # Converts a UTF-8 unicode string to a punycode ACE string. + # == Example + # SimpleIDN.to_ascii("møllerriis.com") + # => "xn--mllerriis-l8a.com" + # + # source://simpleidn//lib/simpleidn.rb#232 + def to_ascii(domain, transitional = T.unsafe(nil)); end + + # Converts a punycode ACE string to a UTF-8 unicode string. + # == Example + # SimpleIDN.to_unicode("xn--mllerriis-l8a.com") + # => "møllerriis.com" + # + # source://simpleidn//lib/simpleidn.rb#256 + def to_unicode(domain, transitional = T.unsafe(nil)); end + + # Applies UTS46 mapping to a Unicode string + # Returns a UTF-8 string in Normalization Form C (NFC) + # + # source://simpleidn//lib/simpleidn.rb#221 + def uts46map(str, transitional = T.unsafe(nil)); end + end +end + +# source://simpleidn//lib/simpleidn.rb#198 +SimpleIDN::ACE_PREFIX = T.let(T.unsafe(nil), String) + +# source://simpleidn//lib/simpleidn.rb#199 +SimpleIDN::ASCII_MAX = T.let(T.unsafe(nil), Integer) + +# The ConversionError is raised when an error occurs during a +# Punycode <-> Unicode conversion. +# +# source://simpleidn//lib/simpleidn.rb#7 +class SimpleIDN::ConversionError < ::RangeError; end + +# source://simpleidn//lib/simpleidn.rb#200 +SimpleIDN::DOT = T.let(T.unsafe(nil), String) + +# source://simpleidn//lib/simpleidn.rb#201 +SimpleIDN::EMPTY = T.let(T.unsafe(nil), String) + +# source://simpleidn//lib/simpleidn.rb#202 +SimpleIDN::LABEL_SEPERATOR_RE = T.let(T.unsafe(nil), Regexp) + +# source://simpleidn//lib/simpleidn.rb#10 +module SimpleIDN::Punycode + private + + # Bias adaptation function + # + # source://simpleidn//lib/simpleidn.rb#43 + def adapt(delta, numpoints, firsttime); end + + # Main decode + # + # source://simpleidn//lib/simpleidn.rb#56 + def decode(input); end + + # decode_digit(cp) returns the numeric value of a basic code + # point (for use in representing integers) in the range 0 to + # base-1, or base if cp is does not represent a value. + # + # source://simpleidn//lib/simpleidn.rb#29 + def decode_digit(cp); end + + # Main encode function + # + # source://simpleidn//lib/simpleidn.rb#128 + def encode(input); end + + # encode_digit(d) returns the basic code point whose value + # (when used for representing integers) is d, which needs to be in + # the range 0 to base-1. + # + # source://simpleidn//lib/simpleidn.rb#36 + def encode_digit(d); end + + class << self + # Bias adaptation function + # + # source://simpleidn//lib/simpleidn.rb#43 + def adapt(delta, numpoints, firsttime); end + + # Main decode + # + # source://simpleidn//lib/simpleidn.rb#56 + def decode(input); end + + # decode_digit(cp) returns the numeric value of a basic code + # point (for use in representing integers) in the range 0 to + # base-1, or base if cp is does not represent a value. + # + # source://simpleidn//lib/simpleidn.rb#29 + def decode_digit(cp); end + + # Main encode function + # + # source://simpleidn//lib/simpleidn.rb#128 + def encode(input); end + + # encode_digit(d) returns the basic code point whose value + # (when used for representing integers) is d, which needs to be in + # the range 0 to base-1. + # + # source://simpleidn//lib/simpleidn.rb#36 + def encode_digit(d); end + end +end + +# source://simpleidn//lib/simpleidn.rb#20 +SimpleIDN::Punycode::ASCII_MAX = T.let(T.unsafe(nil), Integer) + +# source://simpleidn//lib/simpleidn.rb#14 +SimpleIDN::Punycode::BASE = T.let(T.unsafe(nil), Integer) + +# source://simpleidn//lib/simpleidn.rb#15 +SimpleIDN::Punycode::DAMP = T.let(T.unsafe(nil), Integer) + +# source://simpleidn//lib/simpleidn.rb#13 +SimpleIDN::Punycode::DELIMITER = T.let(T.unsafe(nil), Integer) + +# source://simpleidn//lib/simpleidn.rb#22 +SimpleIDN::Punycode::EMPTY = T.let(T.unsafe(nil), String) + +# source://simpleidn//lib/simpleidn.rb#12 +SimpleIDN::Punycode::INITIAL_BIAS = T.let(T.unsafe(nil), Integer) + +# source://simpleidn//lib/simpleidn.rb#11 +SimpleIDN::Punycode::INITIAL_N = T.let(T.unsafe(nil), Integer) + +# source://simpleidn//lib/simpleidn.rb#19 +SimpleIDN::Punycode::MAXINT = T.let(T.unsafe(nil), Integer) + +# source://simpleidn//lib/simpleidn.rb#18 +SimpleIDN::Punycode::SKEW = T.let(T.unsafe(nil), Integer) + +# source://simpleidn//lib/simpleidn.rb#17 +SimpleIDN::Punycode::TMAX = T.let(T.unsafe(nil), Integer) + +# source://simpleidn//lib/simpleidn.rb#16 +SimpleIDN::Punycode::TMIN = T.let(T.unsafe(nil), Integer) + +# See UTS46 Table 1 +# +# source://simpleidn//lib/simpleidn.rb#210 +SimpleIDN::TRANSITIONAL = T.let(T.unsafe(nil), Hash) + +# source://simpleidn//lib/simpleidn/uts46mapping.rb#17 +SimpleIDN::UTS64MAPPING = T.let(T.unsafe(nil), Hash) + +# source://simpleidn//lib/simpleidn/version.rb#2 +SimpleIDN::VERSION = T.let(T.unsafe(nil), String) diff --git a/sorbet/rbi/gems/sparql-client@3.2.2.rbi b/sorbet/rbi/gems/sparql-client@3.3.0.rbi similarity index 100% rename from sorbet/rbi/gems/sparql-client@3.2.2.rbi rename to sorbet/rbi/gems/sparql-client@3.3.0.rbi diff --git a/sorbet/rbi/gems/sshkit@1.21.5.rbi b/sorbet/rbi/gems/sshkit@1.23.0.rbi similarity index 100% rename from sorbet/rbi/gems/sshkit@1.21.5.rbi rename to sorbet/rbi/gems/sshkit@1.23.0.rbi diff --git a/sorbet/rbi/gems/tailwindcss-rails@2.3.0.rbi b/sorbet/rbi/gems/tailwindcss-rails@2.6.4.rbi similarity index 100% rename from sorbet/rbi/gems/tailwindcss-rails@2.3.0.rbi rename to sorbet/rbi/gems/tailwindcss-rails@2.6.4.rbi diff --git a/sorbet/rbi/gems/timecop@0.9.8.rbi b/sorbet/rbi/gems/timecop@0.9.10.rbi similarity index 65% rename from sorbet/rbi/gems/timecop@0.9.8.rbi rename to sorbet/rbi/gems/timecop@0.9.10.rbi index 114c9eaac..440bb5ca7 100644 --- a/sorbet/rbi/gems/timecop@0.9.8.rbi +++ b/sorbet/rbi/gems/timecop@0.9.10.rbi @@ -45,7 +45,7 @@ class DateTime < ::Date # source://timecop//lib/timecop/time_extensions.rb#122 def mock_time; end - # source://timecop//lib/timecop/time_extensions.rb#156 + # source://timecop//lib/timecop/time_extensions.rb#165 def mocked_time_stack_item; end # source://timecop//lib/timecop/time_extensions.rb#126 @@ -62,6 +62,29 @@ class DateTime < ::Date end end +# source://timecop//lib/timecop/time_extensions.rb#172 +module Process + extend ::Dalli::PIDCache::CoreExt + extend ::ConnectionPool::ForkTracker + extend ::ActiveSupport::ForkTracker::ModernCoreExt + + class << self + # source://timecop//lib/timecop/time_extensions.rb#176 + def clock_gettime(clock_id, unit = T.unsafe(nil)); end + + # source://timecop//lib/timecop/time_extensions.rb#176 + def clock_gettime_mock_time(clock_id, unit = T.unsafe(nil)); end + + private + + # source://timecop//lib/timecop/time_extensions.rb#210 + def mock_time_monotonic; end + + # source://timecop//lib/timecop/time_extensions.rb#215 + def mock_time_realtime; end + end +end + # source://timecop//lib/timecop/time_extensions.rb#4 class Time include ::Comparable @@ -100,49 +123,49 @@ class Timecop # @return [Timecop] a new instance of Timecop # - # source://timecop//lib/timecop/timecop.rb#174 + # source://timecop//lib/timecop/timecop.rb#198 def initialize; end - # source://timecop//lib/timecop/timecop.rb#141 + # source://timecop//lib/timecop/timecop.rb#165 def baseline; end - # source://timecop//lib/timecop/timecop.rb#136 + # source://timecop//lib/timecop/timecop.rb#160 def baseline=(b); end - # source://timecop//lib/timecop/timecop.rb#209 + # source://timecop//lib/timecop/timecop.rb#233 def return(&block); end - # source://timecop//lib/timecop/timecop.rb#224 + # source://timecop//lib/timecop/timecop.rb#248 def return_to_baseline; end - # source://timecop//lib/timecop/timecop.rb#149 + # source://timecop//lib/timecop/timecop.rb#173 def set_baseline(b); end - # source://timecop//lib/timecop/timecop.rb#166 + # source://timecop//lib/timecop/timecop.rb#190 def set_stack(s); end - # source://timecop//lib/timecop/timecop.rb#157 + # source://timecop//lib/timecop/timecop.rb#181 def stack; end - # source://timecop//lib/timecop/timecop.rb#185 + # source://timecop//lib/timecop/timecop.rb#209 def thread_safe; end - # source://timecop//lib/timecop/timecop.rb#180 + # source://timecop//lib/timecop/timecop.rb#204 def thread_safe=(t); end # @raise [SafeModeException] # - # source://timecop//lib/timecop/timecop.rb#189 + # source://timecop//lib/timecop/timecop.rb#213 def travel(mock_type, *args, &block); end - # source://timecop//lib/timecop/timecop.rb#219 + # source://timecop//lib/timecop/timecop.rb#243 def unmock!; end class << self - # source://timecop//lib/timecop/timecop.rb#78 + # source://timecop//lib/timecop/timecop.rb#84 def baseline; end - # source://timecop//lib/timecop/timecop.rb#82 + # source://timecop//lib/timecop/timecop.rb#88 def baseline=(baseline); end # Allows you to run a block of code and "fake" a time throughout the execution of that block. @@ -168,6 +191,12 @@ class Timecop # previous values after the block has finished executing. This allows us to nest multiple # calls to Timecop.travel and have each block maintain it's concept of "now." # + # The Process.clock_gettime call mocks both CLOCK::MONOTIC and CLOCK::REALTIME + # + # CLOCK::MONOTONIC works slightly differently than other clocks. This clock cannot move to a + # particular date/time. So the only option that changes this clock is #4 which will move the + # clock the requested offset. Otherwise the clock is frozen to the current tick. + # # * Note: Timecop.freeze will actually freeze time. This can cause unanticipated problems if # benchmark or other timing calls are executed, which implicitly expect Time to actually move # forward. @@ -179,32 +208,40 @@ class Timecop # # Returns the value of the block if one is given, or the mocked time. # - # source://timecop//lib/timecop/timecop.rb#51 + # source://timecop//lib/timecop/timecop.rb#57 def freeze(*args, &block); end # Returns whether or not Timecop is currently frozen # # @return [Boolean] # - # source://timecop//lib/timecop/timecop.rb#125 + # source://timecop//lib/timecop/timecop.rb#131 def frozen?; end + # source://timecop//lib/timecop/timecop.rb#145 + def mock_process_clock=(mock); end + + # @return [Boolean] + # + # source://timecop//lib/timecop/timecop.rb#149 + def mock_process_clock?; end + # Reverts back to system's Time.now, Date.today and DateTime.now (if it exists) permamently when # no block argument is given, or temporarily reverts back to the system's time temporarily for # the given block. # - # source://timecop//lib/timecop/timecop.rb#89 + # source://timecop//lib/timecop/timecop.rb#95 def return(&block); end - # source://timecop//lib/timecop/timecop.rb#99 + # source://timecop//lib/timecop/timecop.rb#105 def return_to_baseline; end - # source://timecop//lib/timecop/timecop.rb#108 + # source://timecop//lib/timecop/timecop.rb#114 def safe_mode=(safe); end # @return [Boolean] # - # source://timecop//lib/timecop/timecop.rb#112 + # source://timecop//lib/timecop/timecop.rb#118 def safe_mode?; end # Allows you to run a block of code and "scale" a time throughout the execution of that block. @@ -216,16 +253,23 @@ class Timecop # # Returns the value of the block if one is given, or the mocked time. # - # source://timecop//lib/timecop/timecop.rb#74 + # source://timecop//lib/timecop/timecop.rb#80 def scale(*args, &block); end - # source://timecop//lib/timecop/timecop.rb#120 + # Returns whether or not Timecop is currently scaled + # + # @return [Boolean] + # + # source://timecop//lib/timecop/timecop.rb#141 + def scaled?; end + + # source://timecop//lib/timecop/timecop.rb#126 def thread_safe; end - # source://timecop//lib/timecop/timecop.rb#116 + # source://timecop//lib/timecop/timecop.rb#122 def thread_safe=(t); end - # source://timecop//lib/timecop/timecop.rb#104 + # source://timecop//lib/timecop/timecop.rb#110 def top_stack_item; end # Allows you to run a block of code and "fake" a time throughout the execution of that block. @@ -236,35 +280,42 @@ class Timecop # # Returns the value of the block if one is given, or the mocked time. # - # source://timecop//lib/timecop/timecop.rb#62 + # source://timecop//lib/timecop/timecop.rb#68 def travel(*args, &block); end + # Returns whether or not Timecop is currently travelled + # + # @return [Boolean] + # + # source://timecop//lib/timecop/timecop.rb#136 + def travelled?; end + # Reverts back to system's Time.now, Date.today and DateTime.now (if it exists) permamently when # no block argument is given, or temporarily reverts back to the system's time temporarily for # the given block. # - # source://timecop//lib/timecop/timecop.rb#89 + # source://timecop//lib/timecop/timecop.rb#95 def unfreeze(&block); end private def allocate; end - # source://singleton/0.1.1/singleton.rb#123 + # source://singleton/0.2.0/singleton.rb#123 def instance; end def new(*_arg0); end - # source://timecop//lib/timecop/timecop.rb#130 + # source://timecop//lib/timecop/timecop.rb#154 def send_travel(mock_type, *args, &block); end end end -# source://timecop//lib/timecop/timecop.rb#232 +# source://timecop//lib/timecop/timecop.rb#256 class Timecop::SafeModeException < ::StandardError # @return [SafeModeException] a new instance of SafeModeException # - # source://timecop//lib/timecop/timecop.rb#233 + # source://timecop//lib/timecop/timecop.rb#257 def initialize; end end @@ -278,69 +329,81 @@ class Timecop::TimeStackItem # source://timecop//lib/timecop/time_stack_item.rb#7 def initialize(mock_type, *args); end - # source://timecop//lib/timecop/time_stack_item.rb#77 + # source://timecop//lib/timecop/time_stack_item.rb#69 + def current_monotonic; end + + # source://timecop//lib/timecop/time_stack_item.rb#73 + def current_monotonic_with_mock; end + + # source://timecop//lib/timecop/time_stack_item.rb#98 def date(date_klass = T.unsafe(nil)); end - # source://timecop//lib/timecop/time_stack_item.rb#81 + # source://timecop//lib/timecop/time_stack_item.rb#102 def datetime(datetime_klass = T.unsafe(nil)); end - # source://timecop//lib/timecop/time_stack_item.rb#25 + # source://timecop//lib/timecop/time_stack_item.rb#26 def day; end - # source://timecop//lib/timecop/time_stack_item.rb#29 + # source://timecop//lib/timecop/time_stack_item.rb#30 def hour; end - # source://timecop//lib/timecop/time_stack_item.rb#33 + # source://timecop//lib/timecop/time_stack_item.rb#34 def min; end # source://timecop//lib/timecop/time_stack_item.rb#5 def mock_type; end - # source://timecop//lib/timecop/time_stack_item.rb#21 + # source://timecop//lib/timecop/time_stack_item.rb#59 + def monotonic; end + + # source://timecop//lib/timecop/time_stack_item.rb#22 def month; end - # source://timecop//lib/timecop/time_stack_item.rb#73 + # source://timecop//lib/timecop/time_stack_item.rb#94 def scaled_time; end - # source://timecop//lib/timecop/time_stack_item.rb#53 + # source://timecop//lib/timecop/time_stack_item.rb#54 def scaling_factor; end - # source://timecop//lib/timecop/time_stack_item.rb#37 + # source://timecop//lib/timecop/time_stack_item.rb#38 def sec; end - # source://timecop//lib/timecop/time_stack_item.rb#57 + # source://timecop//lib/timecop/time_stack_item.rb#78 def time(time_klass = T.unsafe(nil)); end - # source://timecop//lib/timecop/time_stack_item.rb#45 + # source://timecop//lib/timecop/time_stack_item.rb#46 def travel_offset; end - # source://timecop//lib/timecop/time_stack_item.rb#49 + # source://timecop//lib/timecop/time_stack_item.rb#50 def travel_offset_days; end - # source://timecop//lib/timecop/time_stack_item.rb#41 + # source://timecop//lib/timecop/time_stack_item.rb#42 def utc_offset; end - # source://timecop//lib/timecop/time_stack_item.rb#17 + # source://timecop//lib/timecop/time_stack_item.rb#18 def year; end private - # source://timecop//lib/timecop/time_stack_item.rb#128 + # source://timecop//lib/timecop/time_stack_item.rb#159 def compute_travel_offset; end - # source://timecop//lib/timecop/time_stack_item.rb#100 + # source://timecop//lib/timecop/time_stack_item.rb#121 + def parse_monotonic_time(*args); end + + # source://timecop//lib/timecop/time_stack_item.rb#131 def parse_time(*args); end - # source://timecop//lib/timecop/time_stack_item.rb#92 + # source://timecop//lib/timecop/time_stack_item.rb#113 def rational_to_utc_offset(rational); end - # source://timecop//lib/timecop/time_stack_item.rb#136 + # source://timecop//lib/timecop/time_stack_item.rb#167 def time_klass; end - # source://timecop//lib/timecop/time_stack_item.rb#132 + # source://timecop//lib/timecop/time_stack_item.rb#163 def times_are_equal_within_epsilon(t1, t2, epsilon_in_seconds); end - # source://timecop//lib/timecop/time_stack_item.rb#96 + # source://timecop//lib/timecop/time_stack_item.rb#117 def utc_offset_to_rational(utc_offset); end end diff --git a/sorbet/rbi/gems/typhoeus@1.4.0.rbi b/sorbet/rbi/gems/typhoeus@1.4.1.rbi similarity index 94% rename from sorbet/rbi/gems/typhoeus@1.4.0.rbi rename to sorbet/rbi/gems/typhoeus@1.4.1.rbi index dae1550e5..0ed22956c 100644 --- a/sorbet/rbi/gems/typhoeus@1.4.0.rbi +++ b/sorbet/rbi/gems/typhoeus@1.4.1.rbi @@ -535,7 +535,7 @@ module Typhoeus::Config # @see Typhoeus::Hydra::Cacheable # @see Typhoeus::Request::Cacheable # - # source://typhoeus//lib/typhoeus/config.rb#53 + # source://typhoeus//lib/typhoeus/config.rb#69 def cache; end # Defines whether requests are cached. @@ -544,9 +544,27 @@ module Typhoeus::Config # @see Typhoeus::Hydra::Cacheable # @see Typhoeus::Request::Cacheable # - # source://typhoeus//lib/typhoeus/config.rb#53 + # source://typhoeus//lib/typhoeus/config.rb#69 def cache=(_arg0); end + # Defines the default HTTP timeout for the connection phase in seconds + # See README for more details about timeouts + # + # @return [Integer, Float] + # @see https://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTCONNECTTIMEOUT + # + # source://typhoeus//lib/typhoeus/config.rb#61 + def connecttimeout; end + + # Defines the default HTTP timeout for the connection phase in seconds + # See README for more details about timeouts + # + # @return [Integer, Float] + # @see https://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTCONNECTTIMEOUT + # + # source://typhoeus//lib/typhoeus/config.rb#61 + def connecttimeout=(_arg0); end + # Defines whether GET requests are memoized when using the {Typhoeus::Hydra}. # # @return [Boolean] @@ -570,7 +588,7 @@ module Typhoeus::Config # @return [String] # @see Typhoeus::Request#set_defaults # - # source://typhoeus//lib/typhoeus/config.rb#67 + # source://typhoeus//lib/typhoeus/config.rb#83 def proxy; end # Defines wether to use a proxy server for every request. @@ -578,15 +596,33 @@ module Typhoeus::Config # @return [String] # @see Typhoeus::Request#set_defaults # - # source://typhoeus//lib/typhoeus/config.rb#67 + # source://typhoeus//lib/typhoeus/config.rb#83 def proxy=(_arg0); end + # Defines the default HTTP timeout for the entire request in seconds + # See README for more details about timeouts + # + # @return [Integer, Float] + # @see https://curl.haxx.se/libcurl/c/curl_easy_setopt#CURLOPTTIMEOUT + # + # source://typhoeus//lib/typhoeus/config.rb#53 + def timeout; end + + # Defines the default HTTP timeout for the entire request in seconds + # See README for more details about timeouts + # + # @return [Integer, Float] + # @see https://curl.haxx.se/libcurl/c/curl_easy_setopt#CURLOPTTIMEOUT + # + # source://typhoeus//lib/typhoeus/config.rb#53 + def timeout=(_arg0); end + # Defines whether to use a default user agent. # # @return [String] # @see Typhoeus::Request#set_defaults # - # source://typhoeus//lib/typhoeus/config.rb#60 + # source://typhoeus//lib/typhoeus/config.rb#76 def user_agent; end # Defines whether to use a default user agent. @@ -594,7 +630,7 @@ module Typhoeus::Config # @return [String] # @see Typhoeus::Request#set_defaults # - # source://typhoeus//lib/typhoeus/config.rb#60 + # source://typhoeus//lib/typhoeus/config.rb#76 def user_agent=(_arg0); end # Defines whether curls debug output is shown. @@ -677,17 +713,17 @@ class Typhoeus::EasyFactory # @api private # - # source://typhoeus//lib/typhoeus/easy_factory.rb#172 + # source://typhoeus//lib/typhoeus/easy_factory.rb#198 def provide_help(option); end # @api private # - # source://typhoeus//lib/typhoeus/easy_factory.rb#96 + # source://typhoeus//lib/typhoeus/easy_factory.rb#102 def sanitize(options); end # @api private # - # source://typhoeus//lib/typhoeus/easy_factory.rb#123 + # source://typhoeus//lib/typhoeus/easy_factory.rb#129 def sanitize_timeout!(options, timeout); end # Sets on_complete callback on easy in order to be able to @@ -698,8 +734,18 @@ class Typhoeus::EasyFactory # easy_factory.set_callback # @return [Ethon::Easy] The easy. # - # source://typhoeus//lib/typhoeus/easy_factory.rb#141 + # source://typhoeus//lib/typhoeus/easy_factory.rb#147 def set_callback; end + + # Sets up an easy upload with CURLOPT_READFUNCTION + # along with CURLOPT_INFILESIZE_LARGE and CURLOPT_UPLOAD + # + # @api private + # @param body [String/File] The body read by the readfunction. + # @return [Ethon::Easy] The easy. + # + # source://typhoeus//lib/typhoeus/easy_factory.rb#184 + def set_read_callback(body); end end # @api private @@ -2226,7 +2272,7 @@ module Typhoeus::Response::Informations # source://typhoeus//lib/typhoeus/response/informations.rb#151 def connect_time; end - # source://typhoeus//lib/typhoeus/response/informations.rb#217 + # source://typhoeus//lib/typhoeus/response/informations.rb#274 def debug_info; end # Return the last used effective url. @@ -2244,7 +2290,7 @@ module Typhoeus::Response::Informations # response.headers # @return [Typhoeus::Header] The response header. # - # source://typhoeus//lib/typhoeus/response/informations.rb#227 + # source://typhoeus//lib/typhoeus/response/informations.rb#284 def headers; end # Returns the response header. @@ -2253,7 +2299,7 @@ module Typhoeus::Response::Informations # response.headers # @return [Typhoeus::Header] The response header. # - # source://typhoeus//lib/typhoeus/response/informations.rb#227 + # source://typhoeus//lib/typhoeus/response/informations.rb#284 def headers_hash; end # Return the available http auth methods. @@ -2334,6 +2380,15 @@ module Typhoeus::Response::Informations # source://typhoeus//lib/typhoeus/response/informations.rb#176 def redirect_time; end + # Return the URL a redirect would take you to, had you enabled redirects. + # + # @example Get redirect_url. + # response.redirect_url + # @return [String] The redirect_url. + # + # source://typhoeus//lib/typhoeus/response/informations.rb#219 + def redirect_url; end + # Return all redirections in between as multiple # responses with header. # @@ -2341,10 +2396,10 @@ module Typhoeus::Response::Informations # response.redirections # @return [Array] The redirections # - # source://typhoeus//lib/typhoeus/response/informations.rb#241 + # source://typhoeus//lib/typhoeus/response/informations.rb#298 def redirections; end - # source://typhoeus//lib/typhoeus/response/informations.rb#213 + # source://typhoeus//lib/typhoeus/response/informations.rb#223 def request_size; end # Return the http response body. @@ -2396,6 +2451,48 @@ module Typhoeus::Response::Informations # source://typhoeus//lib/typhoeus/response/informations.rb#26 def return_message; end + # Return the bytes, the total amount of bytes that were downloaded. + # The amount is only for the latest transfer and will be reset again + # for each new transfer. This counts actual payload data, what's + # also commonly called body. All meta and header data are excluded + # and will not be counted in this number. + # + # @example Get size_download + # response.size_download + # @return [Float] The size_download. + # + # source://typhoeus//lib/typhoeus/response/informations.rb#248 + def size_download; end + + # Return the bytes, the total amount of bytes that were uploaded + # + # @example Get size_upload. + # response.size_upload + # @return [Float] The size_upload. + # + # source://typhoeus//lib/typhoeus/response/informations.rb#233 + def size_upload; end + + # Return the bytes/second, the average download speed that curl + # measured for the complete download + # + # @example Get speed_download. + # response.speed_download + # @return [Float] The speed_download. + # + # source://typhoeus//lib/typhoeus/response/informations.rb#270 + def speed_download; end + + # Return the bytes/second, the average upload speed that curl + # measured for the complete upload + # + # @example Get speed_upload. + # response.speed_upload + # @return [Float] The speed_upload. + # + # source://typhoeus//lib/typhoeus/response/informations.rb#259 + def speed_upload; end + # Return the time, in seconds, it took from the start # until the first byte is received by libcurl. This # includes pretransfer time and also the time the diff --git a/sorbet/rbi/gems/unf@0.1.4.rbi b/sorbet/rbi/gems/unf@0.1.4.rbi deleted file mode 100644 index 61c8c251d..000000000 --- a/sorbet/rbi/gems/unf@0.1.4.rbi +++ /dev/null @@ -1,39 +0,0 @@ -# typed: true - -# DO NOT EDIT MANUALLY -# This is an autogenerated file for types exported from the `unf` gem. -# Please instead update this file by running `bin/tapioca gem unf`. - - -# source://unf//lib/unf/version.rb#1 -module UNF; end - -# UTF-8 string normalizer class. Implementations may vary depending -# on the platform. -# -# source://unf//lib/unf/normalizer.rb#10 -class UNF::Normalizer - include ::Singleton - extend ::Singleton::SingletonClassMethods - - # @return [Normalizer] a new instance of Normalizer - def initialize; end - - def normalize(_arg0, _arg1); end - - class << self - def new(*_arg0); end - - # A shortcut for instance.normalize(string, form). - # - # source://unf//lib/unf/normalizer.rb#24 - def normalize(string, form); end - - private - - def allocate; end - end -end - -# source://unf//lib/unf/version.rb#2 -UNF::VERSION = T.let(T.unsafe(nil), String) diff --git a/sorbet/rbi/gems/unf_ext@0.0.8.2.rbi b/sorbet/rbi/gems/unf_ext@0.0.8.2.rbi deleted file mode 100644 index a66d33f04..000000000 --- a/sorbet/rbi/gems/unf_ext@0.0.8.2.rbi +++ /dev/null @@ -1,9 +0,0 @@ -# typed: true - -# DO NOT EDIT MANUALLY -# This is an autogenerated file for types exported from the `unf_ext` gem. -# Please instead update this file by running `bin/tapioca gem unf_ext`. - - -# THIS IS AN EMPTY RBI FILE. -# see https://github.com/Shopify/tapioca#manually-requiring-parts-of-a-gem diff --git a/sorbet/rbi/gems/validates_email_format_of@1.7.2.rbi b/sorbet/rbi/gems/validates_email_format_of@1.8.2.rbi similarity index 95% rename from sorbet/rbi/gems/validates_email_format_of@1.7.2.rbi rename to sorbet/rbi/gems/validates_email_format_of@1.8.2.rbi index 2e541e0fa..cfadb6946 100644 --- a/sorbet/rbi/gems/validates_email_format_of@1.7.2.rbi +++ b/sorbet/rbi/gems/validates_email_format_of@1.8.2.rbi @@ -134,17 +134,20 @@ end # source://validates_email_format_of//lib/validates_email_format_of/version.rb#1 module ValidatesEmailFormatOf class << self - # source://validates_email_format_of//lib/validates_email_format_of.rb#111 + # source://validates_email_format_of//lib/validates_email_format_of.rb#114 def default_message; end - # source://validates_email_format_of//lib/validates_email_format_of.rb#4 + # source://validates_email_format_of//lib/validates_email_format_of.rb#298 + def deprecation_warn(msg); end + + # source://validates_email_format_of//lib/validates_email_format_of.rb#5 def load_i18n_locales; end - # source://validates_email_format_of//lib/validates_email_format_of.rb#234 - def validate_domain_part_syntax(domain); end + # source://validates_email_format_of//lib/validates_email_format_of.rb#271 + def validate_domain_part_syntax(domain, idn: T.unsafe(nil)); end - # source://validates_email_format_of//lib/validates_email_format_of.rb#97 - def validate_email_domain(email, check_mx_timeout: T.unsafe(nil)); end + # source://validates_email_format_of//lib/validates_email_format_of.rb#98 + def validate_email_domain(email, idn: T.unsafe(nil), check_mx_timeout: T.unsafe(nil)); end # Validates whether the specified value is a valid email address. Returns nil if the value is valid, otherwise returns an array # containing one or more validation error messages. @@ -153,16 +156,16 @@ module ValidatesEmailFormatOf # * message - A custom error message (default is: "does not appear to be valid") # * check_mx - Check for MX records (default is false) # * check_mx_timeout - Timeout in seconds for checking MX records before a `ResolvTimeout` is raised (default is 3) + # * idn - Enable or disable Internationalized Domain Names (default is true) # * mx_message - A custom error message when an MX record validation fails (default is: "is not routable.") - # * with The regex to use for validating the format of the email address (deprecated) # * local_length Maximum number of characters allowed in the local part (default is 64) # * domain_length Maximum number of characters allowed in the domain part (default is 255) # * generate_message Return the I18n key of the error message instead of the error message itself (default is false) # - # source://validates_email_format_of//lib/validates_email_format_of.rb#127 + # source://validates_email_format_of//lib/validates_email_format_of.rb#130 def validate_email_format(email, options = T.unsafe(nil)); end - # source://validates_email_format_of//lib/validates_email_format_of.rb#169 + # source://validates_email_format_of//lib/validates_email_format_of.rb#174 def validate_local_part_syntax(local); end end end @@ -187,7 +190,7 @@ end # dot-atom-text = 1*atext *("." 1*atext) # dot-atom = [CFWS] dot-atom-text [CFWS] # -# source://validates_email_format_of//lib/validates_email_format_of.rb#30 +# source://validates_email_format_of//lib/validates_email_format_of.rb#31 ValidatesEmailFormatOf::ATEXT = T.let(T.unsafe(nil), Regexp) # Characters that are allowed to appear unquoted in comments @@ -198,13 +201,13 @@ ValidatesEmailFormatOf::ATEXT = T.let(T.unsafe(nil), Regexp) # comment = "(" *([FWS] ccontent) [FWS] ")" # CFWS = (1*([FWS] comment) [FWS]) / FWS # -# source://validates_email_format_of//lib/validates_email_format_of.rb#39 +# source://validates_email_format_of//lib/validates_email_format_of.rb#40 ValidatesEmailFormatOf::CTEXT = T.let(T.unsafe(nil), Regexp) -# source://validates_email_format_of//lib/validates_email_format_of.rb#106 +# source://validates_email_format_of//lib/validates_email_format_of.rb#109 ValidatesEmailFormatOf::DEFAULT_MESSAGE = T.let(T.unsafe(nil), String) -# source://validates_email_format_of//lib/validates_email_format_of.rb#107 +# source://validates_email_format_of//lib/validates_email_format_of.rb#110 ValidatesEmailFormatOf::DEFAULT_MX_MESSAGE = T.let(T.unsafe(nil), String) # From https://datatracker.ietf.org/doc/html/rfc1035#section-2.3.1 @@ -227,7 +230,7 @@ ValidatesEmailFormatOf::DEFAULT_MX_MESSAGE = T.let(T.unsafe(nil), String) # > letter or a digit. Host software MUST support this more liberal # > syntax. # -# source://validates_email_format_of//lib/validates_email_format_of.rb#80 +# source://validates_email_format_of//lib/validates_email_format_of.rb#81 ValidatesEmailFormatOf::DOMAIN_PART_LABEL = T.let(T.unsafe(nil), Regexp) # From https://tools.ietf.org/id/draft-liman-tld-names-00.html#rfc.section.2 @@ -244,16 +247,16 @@ ValidatesEmailFormatOf::DOMAIN_PART_LABEL = T.let(T.unsafe(nil), Regexp) # ALPHA = %x41-5A / %x61-7A ; A-Z / a-z # DIGIT = %x30-39 ; 0-9 # -# source://validates_email_format_of//lib/validates_email_format_of.rb#95 +# source://validates_email_format_of//lib/validates_email_format_of.rb#96 ValidatesEmailFormatOf::DOMAIN_PART_TLD = T.let(T.unsafe(nil), Regexp) -# source://validates_email_format_of//lib/validates_email_format_of.rb#108 +# source://validates_email_format_of//lib/validates_email_format_of.rb#111 ValidatesEmailFormatOf::ERROR_MESSAGE_I18N_KEY = T.let(T.unsafe(nil), Symbol) -# source://validates_email_format_of//lib/validates_email_format_of.rb#109 +# source://validates_email_format_of//lib/validates_email_format_of.rb#112 ValidatesEmailFormatOf::ERROR_MX_MESSAGE_I18N_KEY = T.let(T.unsafe(nil), Symbol) -# source://validates_email_format_of//lib/validates_email_format_of.rb#59 +# source://validates_email_format_of//lib/validates_email_format_of.rb#60 ValidatesEmailFormatOf::IP_OCTET = T.let(T.unsafe(nil), Regexp) # https://www.rfc-editor.org/rfc/rfc5322#section-3.2.4 @@ -273,7 +276,7 @@ ValidatesEmailFormatOf::IP_OCTET = T.let(T.unsafe(nil), Regexp) # DQUOTE *([FWS] qcontent) [FWS] DQUOTE # [CFWS] # -# source://validates_email_format_of//lib/validates_email_format_of.rb#57 +# source://validates_email_format_of//lib/validates_email_format_of.rb#58 ValidatesEmailFormatOf::QTEXT = T.let(T.unsafe(nil), Regexp) # source://validates_email_format_of//lib/validates_email_format_of/railtie.rb#2 diff --git a/sorbet/rbi/gems/view_component@3.12.1.rbi b/sorbet/rbi/gems/view_component@3.13.0.rbi similarity index 99% rename from sorbet/rbi/gems/view_component@3.12.1.rbi rename to sorbet/rbi/gems/view_component@3.13.0.rbi index c01bb4610..5c7a44554 100644 --- a/sorbet/rbi/gems/view_component@3.12.1.rbi +++ b/sorbet/rbi/gems/view_component@3.13.0.rbi @@ -1825,8 +1825,16 @@ end # source://view_component//lib/view_component/use_helpers.rb#0 module ViewComponent::UseHelpers::ClassMethods + # source://view_component//lib/view_component/use_helpers.rb#11 + def use_helper(helper_method, from: T.unsafe(nil)); end + # source://view_component//lib/view_component/use_helpers.rb#7 - def use_helpers(*args); end + def use_helpers(*args, from: T.unsafe(nil)); end + + private + + # source://view_component//lib/view_component/use_helpers.rb#24 + def define_helper(helper_method:, source:); end end # source://view_component//lib/view_component/with_content_helper.rb#4 diff --git a/sorbet/rbi/gems/webmock@3.18.1.rbi b/sorbet/rbi/gems/webmock@3.23.1.rbi similarity index 67% rename from sorbet/rbi/gems/webmock@3.18.1.rbi rename to sorbet/rbi/gems/webmock@3.23.1.rbi index f639d371f..c20c529bf 100644 --- a/sorbet/rbi/gems/webmock@3.18.1.rbi +++ b/sorbet/rbi/gems/webmock@3.23.1.rbi @@ -5,89 +5,89 @@ # Please instead update this file by running `bin/tapioca gem webmock`. -# source://webmock//lib/webmock/http_lib_adapters/net_http_response.rb#16 +# source://webmock//lib/webmock/http_lib_adapters/net_http_response.rb#18 module Net::WebMockHTTPResponse - # source://webmock//lib/webmock/http_lib_adapters/net_http_response.rb#17 + # source://webmock//lib/webmock/http_lib_adapters/net_http_response.rb#19 def read_body(dest = T.unsafe(nil), &block); end end -# source://webmock//lib/webmock/http_lib_adapters/net_http.rb#206 +# source://webmock//lib/webmock/http_lib_adapters/net_http.rb#210 class StubSocket # @return [StubSocket] a new instance of StubSocket # - # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#210 + # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#214 def initialize(*args); end - # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#218 + # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#222 def close; end # @return [Boolean] # - # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#214 + # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#218 def closed?; end # Returns the value of attribute continue_timeout. # - # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#208 + # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#212 def continue_timeout; end # Sets the attribute continue_timeout # # @param value the value to set the attribute continue_timeout to. # - # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#208 + # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#212 def continue_timeout=(_arg0); end - # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#226 + # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#230 def io; end # Returns the value of attribute read_timeout. # - # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#208 + # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#212 def read_timeout; end # Sets the attribute read_timeout # # @param value the value to set the attribute read_timeout to. # - # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#208 + # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#212 def read_timeout=(_arg0); end - # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#223 + # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#227 def readuntil(*args); end # Returns the value of attribute write_timeout. # - # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#208 + # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#212 def write_timeout; end # Sets the attribute write_timeout # # @param value the value to set the attribute write_timeout to. # - # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#208 + # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#212 def write_timeout=(_arg0); end end -# source://webmock//lib/webmock/http_lib_adapters/net_http.rb#230 +# source://webmock//lib/webmock/http_lib_adapters/net_http.rb#234 class StubSocket::StubIO - # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#235 + # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#239 def cipher; end - # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#232 + # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#236 def peer_cert; end - # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#233 + # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#237 def peeraddr; end - # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#231 + # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#235 def setsockopt(*args); end - # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#234 + # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#238 def ssl_version; end end -# source://webmock//lib/webmock/deprecation.rb#1 +# source://webmock//lib/webmock/deprecation.rb#3 module WebMock include ::WebMock::API extend ::WebMock::API @@ -101,111 +101,111 @@ module WebMock def reset_webmock(*args, &block); end class << self - # source://webmock//lib/webmock/webmock.rb#141 + # source://webmock//lib/webmock/webmock.rb#143 def after_request(options = T.unsafe(nil), &block); end - # source://webmock//lib/webmock/webmock.rb#44 + # source://webmock//lib/webmock/webmock.rb#46 def allow_net_connect!(options = T.unsafe(nil)); end - # source://webmock//lib/webmock/webmock.rb#28 + # source://webmock//lib/webmock/webmock.rb#30 def disable!(options = T.unsafe(nil)); end - # source://webmock//lib/webmock/webmock.rb#49 + # source://webmock//lib/webmock/webmock.rb#51 def disable_net_connect!(options = T.unsafe(nil)); end - # source://webmock//lib/webmock/webmock.rb#49 + # source://webmock//lib/webmock/webmock.rb#51 def disallow_net_connect!(options = T.unsafe(nil)); end - # source://webmock//lib/webmock/webmock.rb#36 + # source://webmock//lib/webmock/webmock.rb#38 def enable!(options = T.unsafe(nil)); end - # source://webmock//lib/webmock/webmock.rb#44 + # source://webmock//lib/webmock/webmock.rb#46 def enable_net_connect!(options = T.unsafe(nil)); end - # source://webmock//lib/webmock/webmock.rb#153 + # source://webmock//lib/webmock/webmock.rb#155 def globally_stub_request(order = T.unsafe(nil), &block); end - # source://webmock//lib/webmock/webmock.rb#107 + # source://webmock//lib/webmock/webmock.rb#109 def hide_body_diff!; end - # source://webmock//lib/webmock/webmock.rb#115 + # source://webmock//lib/webmock/webmock.rb#117 def hide_stubbing_instructions!; end # @private # - # source://webmock//lib/webmock/webmock.rb#3 + # source://webmock//lib/webmock/webmock.rb#5 def included(clazz); end # @return [Boolean] # - # source://webmock//lib/webmock/webmock.rb#61 + # source://webmock//lib/webmock/webmock.rb#63 def net_connect_allowed?(uri = T.unsafe(nil)); end # @return [Boolean] # - # source://webmock//lib/webmock/webmock.rb#83 + # source://webmock//lib/webmock/webmock.rb#85 def net_connect_explicit_allowed?(allowed, uri = T.unsafe(nil)); end # @return [Boolean] # - # source://webmock//lib/webmock/webmock.rb#73 + # source://webmock//lib/webmock/webmock.rb#75 def net_http_connect_on_start?(uri); end - # source://webmock//lib/webmock/webmock.rb#149 + # source://webmock//lib/webmock/webmock.rb#151 def print_executed_requests; end # @return [Boolean] # - # source://webmock//lib/webmock/webmock.rb#145 + # source://webmock//lib/webmock/webmock.rb#147 def registered_request?(request_signature); end - # source://webmock//lib/webmock/api.rb#12 + # source://webmock//lib/webmock/api.rb#14 def request(method, uri); end - # source://webmock//lib/webmock/webmock.rb#127 + # source://webmock//lib/webmock/webmock.rb#129 def reset!; end - # source://webmock//lib/webmock/webmock.rb#137 + # source://webmock//lib/webmock/webmock.rb#139 def reset_callbacks; end - # source://webmock//lib/webmock/webmock.rb#132 + # source://webmock//lib/webmock/webmock.rb#134 def reset_webmock; end - # source://webmock//lib/webmock/webmock.rb#103 + # source://webmock//lib/webmock/webmock.rb#105 def show_body_diff!; end # @return [Boolean] # - # source://webmock//lib/webmock/webmock.rb#111 + # source://webmock//lib/webmock/webmock.rb#113 def show_body_diff?; end - # source://webmock//lib/webmock/webmock.rb#119 + # source://webmock//lib/webmock/webmock.rb#121 def show_stubbing_instructions!; end # @return [Boolean] # - # source://webmock//lib/webmock/webmock.rb#123 + # source://webmock//lib/webmock/webmock.rb#125 def show_stubbing_instructions?; end - # source://webmock//lib/webmock/webmock.rb#24 + # source://webmock//lib/webmock/webmock.rb#26 def version; end end end -# source://webmock//lib/webmock/api.rb#2 +# source://webmock//lib/webmock/api.rb#4 module WebMock::API extend ::WebMock::API - # source://webmock//lib/webmock/api.rb#12 + # source://webmock//lib/webmock/api.rb#14 def a_request(method, uri); end - # source://webmock//lib/webmock/api.rb#29 + # source://webmock//lib/webmock/api.rb#31 def assert_not_requested(*args, &block); end - # source://webmock//lib/webmock/api.rb#20 + # source://webmock//lib/webmock/api.rb#22 def assert_requested(*args, &block); end - # source://webmock//lib/webmock/api.rb#57 + # source://webmock//lib/webmock/api.rb#59 def hash_excluding(*args); end # Similar to RSpec::Mocks::ArgumentMatchers#hash_including() @@ -219,109 +219,109 @@ module WebMock::API # object.should_receive(:message).with(hash_including(:key)) # object.should_receive(:message).with(hash_including(:key, :key2 => val2)) # - # source://webmock//lib/webmock/api.rb#49 + # source://webmock//lib/webmock/api.rb#51 def hash_including(*args); end - # source://webmock//lib/webmock/api.rb#29 + # source://webmock//lib/webmock/api.rb#31 def refute_requested(*args, &block); end - # source://webmock//lib/webmock/api.rb#65 + # source://webmock//lib/webmock/api.rb#67 def remove_request_stub(stub); end - # source://webmock//lib/webmock/api.rb#69 + # source://webmock//lib/webmock/api.rb#71 def reset_executed_requests!; end - # source://webmock//lib/webmock/api.rb#5 + # source://webmock//lib/webmock/api.rb#7 def stub_http_request(method, uri); end - # source://webmock//lib/webmock/api.rb#5 + # source://webmock//lib/webmock/api.rb#7 def stub_request(method, uri); end private # this is a based on RSpec::Mocks::ArgumentMatchers#anythingize_lonely_keys # - # source://webmock//lib/webmock/api.rb#102 + # source://webmock//lib/webmock/api.rb#104 def anythingize_lonely_keys(*args); end - # source://webmock//lib/webmock/api.rb#93 + # source://webmock//lib/webmock/api.rb#95 def assert_request_not_requested(request, options = T.unsafe(nil)); end - # source://webmock//lib/webmock/api.rb#84 + # source://webmock//lib/webmock/api.rb#86 def assert_request_requested(request, options = T.unsafe(nil)); end - # source://webmock//lib/webmock/api.rb#75 + # source://webmock//lib/webmock/api.rb#77 def convert_uri_method_and_options_to_request_and_options(method, uri, options, &block); end class << self - # source://webmock//lib/webmock/api.rb#12 + # source://webmock//lib/webmock/api.rb#14 def request(method, uri); end end end -# source://webmock//lib/webmock/assertion_failure.rb#2 +# source://webmock//lib/webmock/assertion_failure.rb#4 class WebMock::AssertionFailure class << self # Returns the value of attribute error_class. # - # source://webmock//lib/webmock/assertion_failure.rb#5 + # source://webmock//lib/webmock/assertion_failure.rb#7 def error_class; end # Sets the attribute error_class # # @param value the value to set the attribute error_class to. # - # source://webmock//lib/webmock/assertion_failure.rb#5 + # source://webmock//lib/webmock/assertion_failure.rb#7 def error_class=(_arg0); end # @raise [@error_class] # - # source://webmock//lib/webmock/assertion_failure.rb#6 + # source://webmock//lib/webmock/assertion_failure.rb#8 def failure(message); end end end -# source://webmock//lib/webmock/request_pattern.rb#250 +# source://webmock//lib/webmock/request_pattern.rb#252 class WebMock::BodyPattern include ::WebMock::RSpecMatcherDetector # @return [BodyPattern] a new instance of BodyPattern # - # source://webmock//lib/webmock/request_pattern.rb#268 + # source://webmock//lib/webmock/request_pattern.rb#270 def initialize(pattern); end # @return [Boolean] # - # source://webmock//lib/webmock/request_pattern.rb#278 + # source://webmock//lib/webmock/request_pattern.rb#280 def matches?(body, content_type = T.unsafe(nil)); end # Returns the value of attribute pattern. # - # source://webmock//lib/webmock/request_pattern.rb#266 + # source://webmock//lib/webmock/request_pattern.rb#268 def pattern; end - # source://webmock//lib/webmock/request_pattern.rb#295 + # source://webmock//lib/webmock/request_pattern.rb#297 def to_s; end private - # source://webmock//lib/webmock/request_pattern.rb#317 + # source://webmock//lib/webmock/request_pattern.rb#319 def assert_non_multipart_body(content_type); end - # source://webmock//lib/webmock/request_pattern.rb#301 + # source://webmock//lib/webmock/request_pattern.rb#303 def body_as_hash(body, content_type); end - # source://webmock//lib/webmock/request_pattern.rb#312 + # source://webmock//lib/webmock/request_pattern.rb#314 def body_format(content_type); end # @return [Boolean] # - # source://webmock//lib/webmock/request_pattern.rb#376 + # source://webmock//lib/webmock/request_pattern.rb#378 def empty_string?(string); end # @return [Boolean] # - # source://webmock//lib/webmock/request_pattern.rb#356 + # source://webmock//lib/webmock/request_pattern.rb#358 def matching_body_array?(query_parameters, pattern, content_type); end # Compare two hashes for equality @@ -346,138 +346,138 @@ class WebMock::BodyPattern # @return [Boolean] true if the paramaters match the comparison # hash, false if not. # - # source://webmock//lib/webmock/request_pattern.rb#346 + # source://webmock//lib/webmock/request_pattern.rb#348 def matching_body_hashes?(query_parameters, pattern, content_type); end - # source://webmock//lib/webmock/request_pattern.rb#368 + # source://webmock//lib/webmock/request_pattern.rb#370 def matching_values(actual, expected, content_type); end - # source://webmock//lib/webmock/request_pattern.rb#380 + # source://webmock//lib/webmock/request_pattern.rb#382 def normalize_hash(hash); end # @return [Boolean] # - # source://webmock//lib/webmock/request_pattern.rb#384 + # source://webmock//lib/webmock/request_pattern.rb#386 def url_encoded_body?(content_type); end end -# source://webmock//lib/webmock/request_pattern.rb#253 +# source://webmock//lib/webmock/request_pattern.rb#255 WebMock::BodyPattern::BODY_FORMATS = T.let(T.unsafe(nil), Hash) -# source://webmock//lib/webmock/callback_registry.rb#2 +# source://webmock//lib/webmock/callback_registry.rb#4 class WebMock::CallbackRegistry class << self - # source://webmock//lib/webmock/callback_registry.rb#5 + # source://webmock//lib/webmock/callback_registry.rb#7 def add_callback(options, block); end # @return [Boolean] # - # source://webmock//lib/webmock/callback_registry.rb#30 + # source://webmock//lib/webmock/callback_registry.rb#32 def any_callbacks?; end - # source://webmock//lib/webmock/callback_registry.rb#9 + # source://webmock//lib/webmock/callback_registry.rb#11 def callbacks; end - # source://webmock//lib/webmock/callback_registry.rb#13 + # source://webmock//lib/webmock/callback_registry.rb#15 def invoke_callbacks(options, request_signature, response); end - # source://webmock//lib/webmock/callback_registry.rb#26 + # source://webmock//lib/webmock/callback_registry.rb#28 def reset; end end end -# source://webmock//lib/webmock/config.rb#2 +# source://webmock//lib/webmock/config.rb#4 class WebMock::Config include ::Singleton extend ::Singleton::SingletonClassMethods # @return [Config] a new instance of Config # - # source://webmock//lib/webmock/config.rb#5 + # source://webmock//lib/webmock/config.rb#7 def initialize; end # Returns the value of attribute allow. # - # source://webmock//lib/webmock/config.rb#12 + # source://webmock//lib/webmock/config.rb#14 def allow; end # Sets the attribute allow # # @param value the value to set the attribute allow to. # - # source://webmock//lib/webmock/config.rb#12 + # source://webmock//lib/webmock/config.rb#14 def allow=(_arg0); end # Returns the value of attribute allow_localhost. # - # source://webmock//lib/webmock/config.rb#11 + # source://webmock//lib/webmock/config.rb#13 def allow_localhost; end # Sets the attribute allow_localhost # # @param value the value to set the attribute allow_localhost to. # - # source://webmock//lib/webmock/config.rb#11 + # source://webmock//lib/webmock/config.rb#13 def allow_localhost=(_arg0); end # Returns the value of attribute allow_net_connect. # - # source://webmock//lib/webmock/config.rb#10 + # source://webmock//lib/webmock/config.rb#12 def allow_net_connect; end # Sets the attribute allow_net_connect # # @param value the value to set the attribute allow_net_connect to. # - # source://webmock//lib/webmock/config.rb#10 + # source://webmock//lib/webmock/config.rb#12 def allow_net_connect=(_arg0); end # Returns the value of attribute net_http_connect_on_start. # - # source://webmock//lib/webmock/config.rb#13 + # source://webmock//lib/webmock/config.rb#15 def net_http_connect_on_start; end # Sets the attribute net_http_connect_on_start # # @param value the value to set the attribute net_http_connect_on_start to. # - # source://webmock//lib/webmock/config.rb#13 + # source://webmock//lib/webmock/config.rb#15 def net_http_connect_on_start=(_arg0); end # Returns the value of attribute query_values_notation. # - # source://webmock//lib/webmock/config.rb#15 + # source://webmock//lib/webmock/config.rb#17 def query_values_notation; end # Sets the attribute query_values_notation # # @param value the value to set the attribute query_values_notation to. # - # source://webmock//lib/webmock/config.rb#15 + # source://webmock//lib/webmock/config.rb#17 def query_values_notation=(_arg0); end # Returns the value of attribute show_body_diff. # - # source://webmock//lib/webmock/config.rb#16 + # source://webmock//lib/webmock/config.rb#18 def show_body_diff; end # Sets the attribute show_body_diff # # @param value the value to set the attribute show_body_diff to. # - # source://webmock//lib/webmock/config.rb#16 + # source://webmock//lib/webmock/config.rb#18 def show_body_diff=(_arg0); end # Returns the value of attribute show_stubbing_instructions. # - # source://webmock//lib/webmock/config.rb#14 + # source://webmock//lib/webmock/config.rb#16 def show_stubbing_instructions; end # Sets the attribute show_stubbing_instructions # # @param value the value to set the attribute show_stubbing_instructions to. # - # source://webmock//lib/webmock/config.rb#14 + # source://webmock//lib/webmock/config.rb#16 def show_stubbing_instructions=(_arg0); end class << self @@ -488,110 +488,110 @@ class WebMock::Config end end -# source://webmock//lib/webmock/deprecation.rb#2 +# source://webmock//lib/webmock/deprecation.rb#4 class WebMock::Deprecation class << self - # source://webmock//lib/webmock/deprecation.rb#4 + # source://webmock//lib/webmock/deprecation.rb#6 def warning(message); end end end -# source://webmock//lib/webmock/response.rb#147 +# source://webmock//lib/webmock/response.rb#149 class WebMock::DynamicResponse < ::WebMock::Response # @return [DynamicResponse] a new instance of DynamicResponse # - # source://webmock//lib/webmock/response.rb#150 + # source://webmock//lib/webmock/response.rb#152 def initialize(responder); end - # source://webmock//lib/webmock/response.rb#154 + # source://webmock//lib/webmock/response.rb#156 def evaluate(request_signature); end # Returns the value of attribute responder. # - # source://webmock//lib/webmock/response.rb#148 + # source://webmock//lib/webmock/response.rb#150 def responder; end # Sets the attribute responder # # @param value the value to set the attribute responder to. # - # source://webmock//lib/webmock/response.rb#148 + # source://webmock//lib/webmock/response.rb#150 def responder=(_arg0); end end -# source://webmock//lib/webmock/util/hash_validator.rb#2 +# source://webmock//lib/webmock/util/hash_validator.rb#4 class WebMock::HashValidator # @return [HashValidator] a new instance of HashValidator # - # source://webmock//lib/webmock/util/hash_validator.rb#3 + # source://webmock//lib/webmock/util/hash_validator.rb#5 def initialize(hash); end # This code is based on https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/hash/keys.rb # - # source://webmock//lib/webmock/util/hash_validator.rb#8 + # source://webmock//lib/webmock/util/hash_validator.rb#10 def validate_keys(*valid_keys); end end -# source://webmock//lib/webmock/request_pattern.rb#389 +# source://webmock//lib/webmock/request_pattern.rb#391 class WebMock::HeadersPattern # @return [HeadersPattern] a new instance of HeadersPattern # - # source://webmock//lib/webmock/request_pattern.rb#390 + # source://webmock//lib/webmock/request_pattern.rb#392 def initialize(pattern); end # @return [Boolean] # - # source://webmock//lib/webmock/request_pattern.rb#394 + # source://webmock//lib/webmock/request_pattern.rb#396 def matches?(headers); end - # source://webmock//lib/webmock/request_pattern.rb#410 + # source://webmock//lib/webmock/request_pattern.rb#412 def pp_to_s; end - # source://webmock//lib/webmock/request_pattern.rb#406 + # source://webmock//lib/webmock/request_pattern.rb#408 def to_s; end private # @return [Boolean] # - # source://webmock//lib/webmock/request_pattern.rb#416 + # source://webmock//lib/webmock/request_pattern.rb#418 def empty_headers?(headers); end end -# source://webmock//lib/webmock/http_lib_adapters/http_lib_adapter.rb#2 +# source://webmock//lib/webmock/http_lib_adapters/http_lib_adapter.rb#4 class WebMock::HttpLibAdapter class << self - # source://webmock//lib/webmock/http_lib_adapters/http_lib_adapter.rb#3 + # source://webmock//lib/webmock/http_lib_adapters/http_lib_adapter.rb#5 def adapter_for(lib); end end end -# source://webmock//lib/webmock/http_lib_adapters/http_lib_adapter_registry.rb#2 +# source://webmock//lib/webmock/http_lib_adapters/http_lib_adapter_registry.rb#4 class WebMock::HttpLibAdapterRegistry include ::Singleton extend ::Singleton::SingletonClassMethods # @return [HttpLibAdapterRegistry] a new instance of HttpLibAdapterRegistry # - # source://webmock//lib/webmock/http_lib_adapters/http_lib_adapter_registry.rb#7 + # source://webmock//lib/webmock/http_lib_adapters/http_lib_adapter_registry.rb#9 def initialize; end - # source://webmock//lib/webmock/http_lib_adapters/http_lib_adapter_registry.rb#15 + # source://webmock//lib/webmock/http_lib_adapters/http_lib_adapter_registry.rb#17 def each_adapter(&block); end # Returns the value of attribute http_lib_adapters. # - # source://webmock//lib/webmock/http_lib_adapters/http_lib_adapter_registry.rb#5 + # source://webmock//lib/webmock/http_lib_adapters/http_lib_adapter_registry.rb#7 def http_lib_adapters; end # Sets the attribute http_lib_adapters # # @param value the value to set the attribute http_lib_adapters to. # - # source://webmock//lib/webmock/http_lib_adapters/http_lib_adapter_registry.rb#5 + # source://webmock//lib/webmock/http_lib_adapters/http_lib_adapter_registry.rb#7 def http_lib_adapters=(_arg0); end - # source://webmock//lib/webmock/http_lib_adapters/http_lib_adapter_registry.rb#11 + # source://webmock//lib/webmock/http_lib_adapters/http_lib_adapter_registry.rb#13 def register(lib, adapter); end class << self @@ -602,100 +602,100 @@ class WebMock::HttpLibAdapterRegistry end end -# source://webmock//lib/webmock/http_lib_adapters/net_http.rb#8 +# source://webmock//lib/webmock/http_lib_adapters/net_http.rb#10 module WebMock::HttpLibAdapters; end -# source://webmock//lib/webmock/http_lib_adapters/net_http.rb#9 +# source://webmock//lib/webmock/http_lib_adapters/net_http.rb#11 class WebMock::HttpLibAdapters::NetHttpAdapter < ::WebMock::HttpLibAdapter class << self - # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#21 + # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#23 def disable!; end - # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#14 + # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#16 def enable!; end end end -# source://webmock//lib/webmock/http_lib_adapters/net_http.rb#12 +# source://webmock//lib/webmock/http_lib_adapters/net_http.rb#14 WebMock::HttpLibAdapters::NetHttpAdapter::OriginalNetHTTP = Net::HTTP -# source://webmock//lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb#12 +# source://webmock//lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb#14 class WebMock::HttpLibAdapters::TyphoeusAdapter < ::WebMock::HttpLibAdapter class << self - # source://webmock//lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb#43 + # source://webmock//lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb#45 def add_after_request_callback; end - # source://webmock//lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb#33 + # source://webmock//lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb#35 def add_before_callback; end - # source://webmock//lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb#53 + # source://webmock//lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb#55 def build_request_signature(req); end - # source://webmock//lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb#82 + # source://webmock//lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb#84 def build_webmock_response(typhoeus_response); end - # source://webmock//lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb#22 + # source://webmock//lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb#24 def disable!; end # @return [Boolean] # - # source://webmock//lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb#29 + # source://webmock//lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb#31 def disabled?; end - # source://webmock//lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb#15 + # source://webmock//lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb#17 def enable!; end - # source://webmock//lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb#90 + # source://webmock//lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb#92 def generate_typhoeus_response(request_signature, webmock_response); end - # source://webmock//lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb#49 + # source://webmock//lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb#51 def remove_after_request_callback; end - # source://webmock//lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb#39 + # source://webmock//lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb#41 def remove_before_callback; end - # source://webmock//lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb#112 + # source://webmock//lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb#128 def request_hash(request_signature); end end end -# source://webmock//lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb#121 +# source://webmock//lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb#137 WebMock::HttpLibAdapters::TyphoeusAdapter::AFTER_REQUEST_CALLBACK = T.let(T.unsafe(nil), Proc) -# source://webmock//lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb#142 +# source://webmock//lib/webmock/http_lib_adapters/typhoeus_hydra_adapter.rb#158 WebMock::HttpLibAdapters::TyphoeusAdapter::BEFORE_CALLBACK = T.let(T.unsafe(nil), Proc) -# source://webmock//lib/webmock/matchers/hash_argument_matcher.rb#2 +# source://webmock//lib/webmock/matchers/hash_argument_matcher.rb#4 module WebMock::Matchers; end # this is a based on RSpec::Mocks::ArgumentMatchers::AnyArgMatcher # -# source://webmock//lib/webmock/matchers/any_arg_matcher.rb#4 +# source://webmock//lib/webmock/matchers/any_arg_matcher.rb#6 class WebMock::Matchers::AnyArgMatcher # @return [AnyArgMatcher] a new instance of AnyArgMatcher # - # source://webmock//lib/webmock/matchers/any_arg_matcher.rb#5 + # source://webmock//lib/webmock/matchers/any_arg_matcher.rb#7 def initialize(ignore); end - # source://webmock//lib/webmock/matchers/any_arg_matcher.rb#8 + # source://webmock//lib/webmock/matchers/any_arg_matcher.rb#10 def ==(other); end end # Base class for Hash matchers # https://github.com/rspec/rspec-mocks/blob/master/lib/rspec/mocks/argument_matchers.rb # -# source://webmock//lib/webmock/matchers/hash_argument_matcher.rb#5 +# source://webmock//lib/webmock/matchers/hash_argument_matcher.rb#7 class WebMock::Matchers::HashArgumentMatcher # @return [HashArgumentMatcher] a new instance of HashArgumentMatcher # - # source://webmock//lib/webmock/matchers/hash_argument_matcher.rb#6 + # source://webmock//lib/webmock/matchers/hash_argument_matcher.rb#8 def initialize(expected); end - # source://webmock//lib/webmock/matchers/hash_argument_matcher.rb#10 + # source://webmock//lib/webmock/matchers/hash_argument_matcher.rb#12 def ==(_actual, &block); end class << self - # source://webmock//lib/webmock/matchers/hash_argument_matcher.rb#16 + # source://webmock//lib/webmock/matchers/hash_argument_matcher.rb#18 def from_rspec_matcher(matcher); end end end @@ -703,348 +703,348 @@ end # this is a based on RSpec::Mocks::ArgumentMatchers::HashExcludingMatcher # https://github.com/rspec/rspec-mocks/blob/master/lib/rspec/mocks/argument_matchers.rb # -# source://webmock//lib/webmock/matchers/hash_excluding_matcher.rb#5 +# source://webmock//lib/webmock/matchers/hash_excluding_matcher.rb#7 class WebMock::Matchers::HashExcludingMatcher < ::WebMock::Matchers::HashArgumentMatcher - # source://webmock//lib/webmock/matchers/hash_excluding_matcher.rb#6 + # source://webmock//lib/webmock/matchers/hash_excluding_matcher.rb#8 def ==(actual); end - # source://webmock//lib/webmock/matchers/hash_excluding_matcher.rb#10 + # source://webmock//lib/webmock/matchers/hash_excluding_matcher.rb#12 def inspect; end end # this is a based on RSpec::Mocks::ArgumentMatchers::HashIncludingMatcher # https://github.com/rspec/rspec-mocks/blob/master/lib/rspec/mocks/argument_matchers.rb # -# source://webmock//lib/webmock/matchers/hash_including_matcher.rb#5 +# source://webmock//lib/webmock/matchers/hash_including_matcher.rb#7 class WebMock::Matchers::HashIncludingMatcher < ::WebMock::Matchers::HashArgumentMatcher - # source://webmock//lib/webmock/matchers/hash_including_matcher.rb#6 + # source://webmock//lib/webmock/matchers/hash_including_matcher.rb#8 def ==(actual); end - # source://webmock//lib/webmock/matchers/hash_including_matcher.rb#12 + # source://webmock//lib/webmock/matchers/hash_including_matcher.rb#14 def inspect; end end -# source://webmock//lib/webmock/request_pattern.rb#93 +# source://webmock//lib/webmock/request_pattern.rb#95 class WebMock::MethodPattern # @return [MethodPattern] a new instance of MethodPattern # - # source://webmock//lib/webmock/request_pattern.rb#94 + # source://webmock//lib/webmock/request_pattern.rb#96 def initialize(pattern); end # @return [Boolean] # - # source://webmock//lib/webmock/request_pattern.rb#98 + # source://webmock//lib/webmock/request_pattern.rb#100 def matches?(method); end - # source://webmock//lib/webmock/request_pattern.rb#102 + # source://webmock//lib/webmock/request_pattern.rb#104 def to_s; end end -# source://webmock//lib/webmock/errors.rb#3 +# source://webmock//lib/webmock/errors.rb#5 class WebMock::NetConnectNotAllowedError < ::Exception # @return [NetConnectNotAllowedError] a new instance of NetConnectNotAllowedError # - # source://webmock//lib/webmock/errors.rb#4 + # source://webmock//lib/webmock/errors.rb#6 def initialize(request_signature); end end -# source://webmock//lib/webmock/http_lib_adapters/net_http.rb#240 +# source://webmock//lib/webmock/http_lib_adapters/net_http.rb#244 module WebMock::NetHTTPUtility class << self - # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#279 + # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#283 def check_right_http_connection; end - # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#270 + # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#274 def get_uri(net_http, path = T.unsafe(nil)); end - # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#283 + # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#287 def puts_warning_for_right_http_if_needed; end - # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#242 + # source://webmock//lib/webmock/http_lib_adapters/net_http.rb#246 def request_signature_from_request(net_http, request, body = T.unsafe(nil)); end end end -# source://webmock//lib/webmock/request_pattern.rb#3 +# source://webmock//lib/webmock/request_pattern.rb#5 module WebMock::RSpecMatcherDetector # @return [Boolean] # - # source://webmock//lib/webmock/request_pattern.rb#8 + # source://webmock//lib/webmock/request_pattern.rb#10 def rSpecHashExcludingMatcher?(matcher); end # @return [Boolean] # - # source://webmock//lib/webmock/request_pattern.rb#4 + # source://webmock//lib/webmock/request_pattern.rb#6 def rSpecHashIncludingMatcher?(matcher); end end -# source://webmock//lib/webmock/rack_response.rb#2 +# source://webmock//lib/webmock/rack_response.rb#4 class WebMock::RackResponse < ::WebMock::Response # @return [RackResponse] a new instance of RackResponse # - # source://webmock//lib/webmock/rack_response.rb#3 + # source://webmock//lib/webmock/rack_response.rb#5 def initialize(app); end - # source://webmock//lib/webmock/rack_response.rb#19 + # source://webmock//lib/webmock/rack_response.rb#21 def body_from_rack_response(response); end - # source://webmock//lib/webmock/rack_response.rb#26 + # source://webmock//lib/webmock/rack_response.rb#28 def build_rack_env(request); end - # source://webmock//lib/webmock/rack_response.rb#7 + # source://webmock//lib/webmock/rack_response.rb#9 def evaluate(request); end - # source://webmock//lib/webmock/rack_response.rb#61 + # source://webmock//lib/webmock/rack_response.rb#65 def session; end - # source://webmock//lib/webmock/rack_response.rb#65 + # source://webmock//lib/webmock/rack_response.rb#69 def session_options; end end -# source://webmock//lib/webmock/request_body_diff.rb#5 +# source://webmock//lib/webmock/request_body_diff.rb#7 class WebMock::RequestBodyDiff # @return [RequestBodyDiff] a new instance of RequestBodyDiff # - # source://webmock//lib/webmock/request_body_diff.rb#7 + # source://webmock//lib/webmock/request_body_diff.rb#9 def initialize(request_signature, request_stub); end - # source://webmock//lib/webmock/request_body_diff.rb#12 + # source://webmock//lib/webmock/request_body_diff.rb#14 def body_diff; end private # @return [Boolean] # - # source://webmock//lib/webmock/request_body_diff.rb#55 + # source://webmock//lib/webmock/request_body_diff.rb#57 def parseable_json?(body_pattern); end # Returns the value of attribute request_signature. # - # source://webmock//lib/webmock/request_body_diff.rb#18 + # source://webmock//lib/webmock/request_body_diff.rb#20 def request_signature; end - # source://webmock//lib/webmock/request_body_diff.rb#31 + # source://webmock//lib/webmock/request_body_diff.rb#33 def request_signature_body_hash; end # @return [Boolean] # - # source://webmock//lib/webmock/request_body_diff.rb#23 + # source://webmock//lib/webmock/request_body_diff.rb#25 def request_signature_diffable?; end # @return [Boolean] # - # source://webmock//lib/webmock/request_body_diff.rb#47 + # source://webmock//lib/webmock/request_body_diff.rb#49 def request_signature_parseable_json?; end # Returns the value of attribute request_stub. # - # source://webmock//lib/webmock/request_body_diff.rb#18 + # source://webmock//lib/webmock/request_body_diff.rb#20 def request_stub; end - # source://webmock//lib/webmock/request_body_diff.rb#41 + # source://webmock//lib/webmock/request_body_diff.rb#43 def request_stub_body; end - # source://webmock//lib/webmock/request_body_diff.rb#35 + # source://webmock//lib/webmock/request_body_diff.rb#37 def request_stub_body_hash; end # @return [Boolean] # - # source://webmock//lib/webmock/request_body_diff.rb#27 + # source://webmock//lib/webmock/request_body_diff.rb#29 def request_stub_diffable?; end # @return [Boolean] # - # source://webmock//lib/webmock/request_body_diff.rb#51 + # source://webmock//lib/webmock/request_body_diff.rb#53 def request_stub_parseable_json?; end end -# source://webmock//lib/webmock/request_execution_verifier.rb#2 +# source://webmock//lib/webmock/request_execution_verifier.rb#4 class WebMock::RequestExecutionVerifier # @return [RequestExecutionVerifier] a new instance of RequestExecutionVerifier # - # source://webmock//lib/webmock/request_execution_verifier.rb#6 + # source://webmock//lib/webmock/request_execution_verifier.rb#8 def initialize(request_pattern = T.unsafe(nil), expected_times_executed = T.unsafe(nil), at_least_times_executed = T.unsafe(nil), at_most_times_executed = T.unsafe(nil)); end # Returns the value of attribute at_least_times_executed. # - # source://webmock//lib/webmock/request_execution_verifier.rb#4 + # source://webmock//lib/webmock/request_execution_verifier.rb#6 def at_least_times_executed; end # Sets the attribute at_least_times_executed # # @param value the value to set the attribute at_least_times_executed to. # - # source://webmock//lib/webmock/request_execution_verifier.rb#4 + # source://webmock//lib/webmock/request_execution_verifier.rb#6 def at_least_times_executed=(_arg0); end # Returns the value of attribute at_most_times_executed. # - # source://webmock//lib/webmock/request_execution_verifier.rb#4 + # source://webmock//lib/webmock/request_execution_verifier.rb#6 def at_most_times_executed; end # Sets the attribute at_most_times_executed # # @param value the value to set the attribute at_most_times_executed to. # - # source://webmock//lib/webmock/request_execution_verifier.rb#4 + # source://webmock//lib/webmock/request_execution_verifier.rb#6 def at_most_times_executed=(_arg0); end - # source://webmock//lib/webmock/request_execution_verifier.rb#36 + # source://webmock//lib/webmock/request_execution_verifier.rb#38 def description; end # @return [Boolean] # - # source://webmock//lib/webmock/request_execution_verifier.rb#26 + # source://webmock//lib/webmock/request_execution_verifier.rb#28 def does_not_match?; end # Returns the value of attribute expected_times_executed. # - # source://webmock//lib/webmock/request_execution_verifier.rb#4 + # source://webmock//lib/webmock/request_execution_verifier.rb#6 def expected_times_executed; end # Sets the attribute expected_times_executed # # @param value the value to set the attribute expected_times_executed to. # - # source://webmock//lib/webmock/request_execution_verifier.rb#4 + # source://webmock//lib/webmock/request_execution_verifier.rb#6 def expected_times_executed=(_arg0); end - # source://webmock//lib/webmock/request_execution_verifier.rb#40 + # source://webmock//lib/webmock/request_execution_verifier.rb#42 def failure_message; end - # source://webmock//lib/webmock/request_execution_verifier.rb#44 + # source://webmock//lib/webmock/request_execution_verifier.rb#46 def failure_message_when_negated; end # @return [Boolean] # - # source://webmock//lib/webmock/request_execution_verifier.rb#13 + # source://webmock//lib/webmock/request_execution_verifier.rb#15 def matches?; end # Returns the value of attribute request_pattern. # - # source://webmock//lib/webmock/request_execution_verifier.rb#4 + # source://webmock//lib/webmock/request_execution_verifier.rb#6 def request_pattern; end # Sets the attribute request_pattern # # @param value the value to set the attribute request_pattern to. # - # source://webmock//lib/webmock/request_execution_verifier.rb#4 + # source://webmock//lib/webmock/request_execution_verifier.rb#6 def request_pattern=(_arg0); end # Returns the value of attribute times_executed. # - # source://webmock//lib/webmock/request_execution_verifier.rb#4 + # source://webmock//lib/webmock/request_execution_verifier.rb#6 def times_executed; end # Sets the attribute times_executed # # @param value the value to set the attribute times_executed to. # - # source://webmock//lib/webmock/request_execution_verifier.rb#4 + # source://webmock//lib/webmock/request_execution_verifier.rb#6 def times_executed=(_arg0); end private - # source://webmock//lib/webmock/request_execution_verifier.rb#54 + # source://webmock//lib/webmock/request_execution_verifier.rb#56 def failure_message_phrase(is_negated = T.unsafe(nil)); end - # source://webmock//lib/webmock/request_execution_verifier.rb#60 + # source://webmock//lib/webmock/request_execution_verifier.rb#62 def quantity_phrase(is_negated = T.unsafe(nil)); end - # source://webmock//lib/webmock/request_execution_verifier.rb#72 + # source://webmock//lib/webmock/request_execution_verifier.rb#74 def times(times); end class << self - # source://webmock//lib/webmock/request_execution_verifier.rb#48 + # source://webmock//lib/webmock/request_execution_verifier.rb#50 def executed_requests_message; end end end -# source://webmock//lib/webmock/request_pattern.rb#13 +# source://webmock//lib/webmock/request_pattern.rb#15 class WebMock::RequestPattern # @return [RequestPattern] a new instance of RequestPattern # - # source://webmock//lib/webmock/request_pattern.rb#17 + # source://webmock//lib/webmock/request_pattern.rb#19 def initialize(method, uri, options = T.unsafe(nil)); end # Returns the value of attribute body_pattern. # - # source://webmock//lib/webmock/request_pattern.rb#15 + # source://webmock//lib/webmock/request_pattern.rb#17 def body_pattern; end # Returns the value of attribute headers_pattern. # - # source://webmock//lib/webmock/request_pattern.rb#15 + # source://webmock//lib/webmock/request_pattern.rb#17 def headers_pattern; end # @return [Boolean] # - # source://webmock//lib/webmock/request_pattern.rb#33 + # source://webmock//lib/webmock/request_pattern.rb#35 def matches?(request_signature); end # Returns the value of attribute method_pattern. # - # source://webmock//lib/webmock/request_pattern.rb#15 + # source://webmock//lib/webmock/request_pattern.rb#17 def method_pattern; end - # source://webmock//lib/webmock/request_pattern.rb#43 + # source://webmock//lib/webmock/request_pattern.rb#45 def to_s; end # Returns the value of attribute uri_pattern. # - # source://webmock//lib/webmock/request_pattern.rb#15 + # source://webmock//lib/webmock/request_pattern.rb#17 def uri_pattern; end # @raise [ArgumentError] # - # source://webmock//lib/webmock/request_pattern.rb#26 + # source://webmock//lib/webmock/request_pattern.rb#28 def with(options = T.unsafe(nil), &block); end private - # source://webmock//lib/webmock/request_pattern.rb#55 + # source://webmock//lib/webmock/request_pattern.rb#57 def assign_options(options); end - # source://webmock//lib/webmock/request_pattern.rb#78 + # source://webmock//lib/webmock/request_pattern.rb#80 def create_uri_pattern(uri); end - # source://webmock//lib/webmock/request_pattern.rb#64 + # source://webmock//lib/webmock/request_pattern.rb#66 def set_basic_auth_as_headers!(options); end - # source://webmock//lib/webmock/request_pattern.rb#72 + # source://webmock//lib/webmock/request_pattern.rb#74 def validate_basic_auth!(basic_auth); end end -# source://webmock//lib/webmock/request_registry.rb#3 +# source://webmock//lib/webmock/request_registry.rb#5 class WebMock::RequestRegistry include ::Singleton extend ::Singleton::SingletonClassMethods # @return [RequestRegistry] a new instance of RequestRegistry # - # source://webmock//lib/webmock/request_registry.rb#8 + # source://webmock//lib/webmock/request_registry.rb#10 def initialize; end # Returns the value of attribute requested_signatures. # - # source://webmock//lib/webmock/request_registry.rb#6 + # source://webmock//lib/webmock/request_registry.rb#8 def requested_signatures; end # Sets the attribute requested_signatures # # @param value the value to set the attribute requested_signatures to. # - # source://webmock//lib/webmock/request_registry.rb#6 + # source://webmock//lib/webmock/request_registry.rb#8 def requested_signatures=(_arg0); end - # source://webmock//lib/webmock/request_registry.rb#12 + # source://webmock//lib/webmock/request_registry.rb#14 def reset!; end - # source://webmock//lib/webmock/request_registry.rb#16 + # source://webmock//lib/webmock/request_registry.rb#18 def times_executed(request_pattern); end - # source://webmock//lib/webmock/request_registry.rb#22 + # source://webmock//lib/webmock/request_registry.rb#24 def to_s; end class << self @@ -1055,363 +1055,363 @@ class WebMock::RequestRegistry end end -# source://webmock//lib/webmock/request_signature.rb#3 +# source://webmock//lib/webmock/request_signature.rb#5 class WebMock::RequestSignature # @return [RequestSignature] a new instance of RequestSignature # - # source://webmock//lib/webmock/request_signature.rb#8 + # source://webmock//lib/webmock/request_signature.rb#10 def initialize(method, uri, options = T.unsafe(nil)); end # @return [Boolean] # - # source://webmock//lib/webmock/request_signature.rb#32 + # source://webmock//lib/webmock/request_signature.rb#34 def ==(other); end # Returns the value of attribute body. # - # source://webmock//lib/webmock/request_signature.rb#5 + # source://webmock//lib/webmock/request_signature.rb#7 def body; end # Sets the attribute body # # @param value the value to set the attribute body to. # - # source://webmock//lib/webmock/request_signature.rb#5 + # source://webmock//lib/webmock/request_signature.rb#7 def body=(_arg0); end # @return [Boolean] # - # source://webmock//lib/webmock/request_signature.rb#32 + # source://webmock//lib/webmock/request_signature.rb#34 def eql?(other); end - # source://webmock//lib/webmock/request_signature.rb#28 + # source://webmock//lib/webmock/request_signature.rb#30 def hash; end # Returns the value of attribute headers. # - # source://webmock//lib/webmock/request_signature.rb#6 + # source://webmock//lib/webmock/request_signature.rb#8 def headers; end - # source://webmock//lib/webmock/request_signature.rb#24 + # source://webmock//lib/webmock/request_signature.rb#26 def headers=(headers); end # @return [Boolean] # - # source://webmock//lib/webmock/request_signature.rb#41 + # source://webmock//lib/webmock/request_signature.rb#43 def json_headers?; end # Returns the value of attribute method. # - # source://webmock//lib/webmock/request_signature.rb#5 + # source://webmock//lib/webmock/request_signature.rb#7 def method; end # Sets the attribute method # # @param value the value to set the attribute method to. # - # source://webmock//lib/webmock/request_signature.rb#5 + # source://webmock//lib/webmock/request_signature.rb#7 def method=(_arg0); end - # source://webmock//lib/webmock/request_signature.rb#14 + # source://webmock//lib/webmock/request_signature.rb#16 def to_s; end # Returns the value of attribute uri. # - # source://webmock//lib/webmock/request_signature.rb#5 + # source://webmock//lib/webmock/request_signature.rb#7 def uri; end # Sets the attribute uri # # @param value the value to set the attribute uri to. # - # source://webmock//lib/webmock/request_signature.rb#5 + # source://webmock//lib/webmock/request_signature.rb#7 def uri=(_arg0); end # @return [Boolean] # - # source://webmock//lib/webmock/request_signature.rb#37 + # source://webmock//lib/webmock/request_signature.rb#39 def url_encoded?; end private - # source://webmock//lib/webmock/request_signature.rb#47 + # source://webmock//lib/webmock/request_signature.rb#49 def assign_options(options); end end -# source://webmock//lib/webmock/request_signature_snippet.rb#4 +# source://webmock//lib/webmock/request_signature_snippet.rb#6 class WebMock::RequestSignatureSnippet # @return [RequestSignatureSnippet] a new instance of RequestSignatureSnippet # - # source://webmock//lib/webmock/request_signature_snippet.rb#8 + # source://webmock//lib/webmock/request_signature_snippet.rb#10 def initialize(request_signature); end # Returns the value of attribute request_signature. # - # source://webmock//lib/webmock/request_signature_snippet.rb#6 + # source://webmock//lib/webmock/request_signature_snippet.rb#8 def request_signature; end # Returns the value of attribute request_stub. # - # source://webmock//lib/webmock/request_signature_snippet.rb#6 + # source://webmock//lib/webmock/request_signature_snippet.rb#8 def request_stub; end - # source://webmock//lib/webmock/request_signature_snippet.rb#20 + # source://webmock//lib/webmock/request_signature_snippet.rb#22 def request_stubs; end - # source://webmock//lib/webmock/request_signature_snippet.rb#13 + # source://webmock//lib/webmock/request_signature_snippet.rb#15 def stubbing_instructions; end private - # source://webmock//lib/webmock/request_signature_snippet.rb#33 + # source://webmock//lib/webmock/request_signature_snippet.rb#35 def add_body_diff(stub, text); end - # source://webmock//lib/webmock/request_signature_snippet.rb#52 + # source://webmock//lib/webmock/request_signature_snippet.rb#54 def pretty_print_to_string(string_to_print); end - # source://webmock//lib/webmock/request_signature_snippet.rb#43 + # source://webmock//lib/webmock/request_signature_snippet.rb#45 def request_params; end - # source://webmock//lib/webmock/request_signature_snippet.rb#38 + # source://webmock//lib/webmock/request_signature_snippet.rb#40 def signature_stub_body_diff(stub); end end -# source://webmock//lib/webmock/request_stub.rb#2 +# source://webmock//lib/webmock/request_stub.rb#4 class WebMock::RequestStub # @return [RequestStub] a new instance of RequestStub # - # source://webmock//lib/webmock/request_stub.rb#6 + # source://webmock//lib/webmock/request_stub.rb#8 def initialize(method, uri); end - # source://webmock//lib/webmock/request_stub.rb#46 + # source://webmock//lib/webmock/request_stub.rb#65 def and_raise(*exceptions); end - # source://webmock//lib/webmock/request_stub.rb#17 + # source://webmock//lib/webmock/request_stub.rb#19 def and_return(*response_hashes, &block); end # @raise [ArgumentError] # - # source://webmock//lib/webmock/request_stub.rb#27 + # source://webmock//lib/webmock/request_stub.rb#29 def and_return_json(*response_hashes); end - # source://webmock//lib/webmock/request_stub.rb#54 + # source://webmock//lib/webmock/request_stub.rb#73 def and_timeout; end # @return [Boolean] # - # source://webmock//lib/webmock/request_stub.rb#71 + # source://webmock//lib/webmock/request_stub.rb#90 def has_responses?; end # @return [Boolean] # - # source://webmock//lib/webmock/request_stub.rb#89 + # source://webmock//lib/webmock/request_stub.rb#108 def matches?(request_signature); end # Returns the value of attribute request_pattern. # - # source://webmock//lib/webmock/request_stub.rb#4 + # source://webmock//lib/webmock/request_stub.rb#6 def request_pattern; end # Sets the attribute request_pattern # # @param value the value to set the attribute request_pattern to. # - # source://webmock//lib/webmock/request_stub.rb#4 + # source://webmock//lib/webmock/request_stub.rb#6 def request_pattern=(_arg0); end - # source://webmock//lib/webmock/request_stub.rb#60 + # source://webmock//lib/webmock/request_stub.rb#79 def response; end - # source://webmock//lib/webmock/request_stub.rb#75 + # source://webmock//lib/webmock/request_stub.rb#94 def then; end - # source://webmock//lib/webmock/request_stub.rb#79 + # source://webmock//lib/webmock/request_stub.rb#98 def times(number); end - # source://webmock//lib/webmock/request_stub.rb#42 + # source://webmock//lib/webmock/request_stub.rb#61 def to_rack(app, options = T.unsafe(nil)); end - # source://webmock//lib/webmock/request_stub.rb#46 + # source://webmock//lib/webmock/request_stub.rb#65 def to_raise(*exceptions); end - # source://webmock//lib/webmock/request_stub.rb#17 + # source://webmock//lib/webmock/request_stub.rb#19 def to_return(*response_hashes, &block); end # @raise [ArgumentError] # - # source://webmock//lib/webmock/request_stub.rb#27 + # source://webmock//lib/webmock/request_stub.rb#29 def to_return_json(*response_hashes); end - # source://webmock//lib/webmock/request_stub.rb#93 + # source://webmock//lib/webmock/request_stub.rb#112 def to_s; end - # source://webmock//lib/webmock/request_stub.rb#54 + # source://webmock//lib/webmock/request_stub.rb#73 def to_timeout; end - # source://webmock//lib/webmock/request_stub.rb#12 + # source://webmock//lib/webmock/request_stub.rb#14 def with(params = T.unsafe(nil), &block); end class << self - # source://webmock//lib/webmock/request_stub.rb#97 + # source://webmock//lib/webmock/request_stub.rb#116 def from_request_signature(signature); end end end -# source://webmock//lib/webmock/response.rb#15 +# source://webmock//lib/webmock/response.rb#17 class WebMock::Response # @return [Response] a new instance of Response # - # source://webmock//lib/webmock/response.rb#16 + # source://webmock//lib/webmock/response.rb#18 def initialize(options = T.unsafe(nil)); end - # source://webmock//lib/webmock/response.rb#95 + # source://webmock//lib/webmock/response.rb#97 def ==(other); end - # source://webmock//lib/webmock/response.rb#38 + # source://webmock//lib/webmock/response.rb#40 def body; end - # source://webmock//lib/webmock/response.rb#42 + # source://webmock//lib/webmock/response.rb#44 def body=(body); end - # source://webmock//lib/webmock/response.rb#86 + # source://webmock//lib/webmock/response.rb#88 def evaluate(request_signature); end - # source://webmock//lib/webmock/response.rb#56 + # source://webmock//lib/webmock/response.rb#58 def exception; end - # source://webmock//lib/webmock/response.rb#60 + # source://webmock//lib/webmock/response.rb#62 def exception=(exception); end - # source://webmock//lib/webmock/response.rb#27 + # source://webmock//lib/webmock/response.rb#29 def headers; end - # source://webmock//lib/webmock/response.rb#31 + # source://webmock//lib/webmock/response.rb#33 def headers=(headers); end - # source://webmock//lib/webmock/response.rb#76 + # source://webmock//lib/webmock/response.rb#78 def options=(options); end # @raise [@exception] # - # source://webmock//lib/webmock/response.rb#68 + # source://webmock//lib/webmock/response.rb#70 def raise_error_if_any; end - # source://webmock//lib/webmock/response.rb#72 + # source://webmock//lib/webmock/response.rb#74 def should_timeout; end - # source://webmock//lib/webmock/response.rb#48 + # source://webmock//lib/webmock/response.rb#50 def status; end - # source://webmock//lib/webmock/response.rb#52 + # source://webmock//lib/webmock/response.rb#54 def status=(status); end private - # source://webmock//lib/webmock/response.rb#113 + # source://webmock//lib/webmock/response.rb#115 def assert_valid_body!; end - # source://webmock//lib/webmock/response.rb#126 + # source://webmock//lib/webmock/response.rb#128 def read_raw_response(io); end - # source://webmock//lib/webmock/response.rb#105 + # source://webmock//lib/webmock/response.rb#107 def stringify_body!; end end -# source://webmock//lib/webmock/response.rb#143 +# source://webmock//lib/webmock/response.rb#145 class WebMock::Response::InvalidBody < ::StandardError; end -# source://webmock//lib/webmock/response.rb#5 +# source://webmock//lib/webmock/response.rb#7 class WebMock::ResponseFactory class << self - # source://webmock//lib/webmock/response.rb#6 + # source://webmock//lib/webmock/response.rb#8 def response_for(options); end end end -# source://webmock//lib/webmock/responses_sequence.rb#3 +# source://webmock//lib/webmock/responses_sequence.rb#5 class WebMock::ResponsesSequence # @return [ResponsesSequence] a new instance of ResponsesSequence # - # source://webmock//lib/webmock/responses_sequence.rb#7 + # source://webmock//lib/webmock/responses_sequence.rb#9 def initialize(responses); end # @return [Boolean] # - # source://webmock//lib/webmock/responses_sequence.rb#13 + # source://webmock//lib/webmock/responses_sequence.rb#15 def end?; end - # source://webmock//lib/webmock/responses_sequence.rb#17 + # source://webmock//lib/webmock/responses_sequence.rb#19 def next_response; end # Returns the value of attribute times_to_repeat. # - # source://webmock//lib/webmock/responses_sequence.rb#5 + # source://webmock//lib/webmock/responses_sequence.rb#7 def times_to_repeat; end # Sets the attribute times_to_repeat # # @param value the value to set the attribute times_to_repeat to. # - # source://webmock//lib/webmock/responses_sequence.rb#5 + # source://webmock//lib/webmock/responses_sequence.rb#7 def times_to_repeat=(_arg0); end private - # source://webmock//lib/webmock/responses_sequence.rb#29 + # source://webmock//lib/webmock/responses_sequence.rb#31 def increase_position; end end -# source://webmock//lib/webmock/stub_registry.rb#3 +# source://webmock//lib/webmock/stub_registry.rb#5 class WebMock::StubRegistry include ::Singleton extend ::Singleton::SingletonClassMethods # @return [StubRegistry] a new instance of StubRegistry # - # source://webmock//lib/webmock/stub_registry.rb#8 + # source://webmock//lib/webmock/stub_registry.rb#10 def initialize; end - # source://webmock//lib/webmock/stub_registry.rb#12 + # source://webmock//lib/webmock/stub_registry.rb#14 def global_stubs; end - # source://webmock//lib/webmock/stub_registry.rb#20 + # source://webmock//lib/webmock/stub_registry.rb#22 def register_global_stub(order = T.unsafe(nil), &block); end - # source://webmock//lib/webmock/stub_registry.rb#48 + # source://webmock//lib/webmock/stub_registry.rb#50 def register_request_stub(stub); end # @return [Boolean] # - # source://webmock//lib/webmock/stub_registry.rb#59 + # source://webmock//lib/webmock/stub_registry.rb#61 def registered_request?(request_signature); end - # source://webmock//lib/webmock/stub_registry.rb#53 + # source://webmock//lib/webmock/stub_registry.rb#55 def remove_request_stub(stub); end # Returns the value of attribute request_stubs. # - # source://webmock//lib/webmock/stub_registry.rb#6 + # source://webmock//lib/webmock/stub_registry.rb#8 def request_stubs; end # Sets the attribute request_stubs # # @param value the value to set the attribute request_stubs to. # - # source://webmock//lib/webmock/stub_registry.rb#6 + # source://webmock//lib/webmock/stub_registry.rb#8 def request_stubs=(_arg0); end - # source://webmock//lib/webmock/stub_registry.rb#16 + # source://webmock//lib/webmock/stub_registry.rb#18 def reset!; end - # source://webmock//lib/webmock/stub_registry.rb#63 + # source://webmock//lib/webmock/stub_registry.rb#65 def response_for_request(request_signature); end private - # source://webmock//lib/webmock/stub_registry.rb#77 + # source://webmock//lib/webmock/stub_registry.rb#79 def evaluate_response_for_request(response, request_signature); end - # source://webmock//lib/webmock/stub_registry.rb#70 + # source://webmock//lib/webmock/stub_registry.rb#72 def request_stub_for(request_signature); end class << self @@ -1422,152 +1422,152 @@ class WebMock::StubRegistry end end -# source://webmock//lib/webmock/stub_request_snippet.rb#2 +# source://webmock//lib/webmock/stub_request_snippet.rb#4 class WebMock::StubRequestSnippet # @return [StubRequestSnippet] a new instance of StubRequestSnippet # - # source://webmock//lib/webmock/stub_request_snippet.rb#3 + # source://webmock//lib/webmock/stub_request_snippet.rb#5 def initialize(request_stub); end - # source://webmock//lib/webmock/stub_request_snippet.rb#7 + # source://webmock//lib/webmock/stub_request_snippet.rb#9 def body_pattern; end - # source://webmock//lib/webmock/stub_request_snippet.rb#11 + # source://webmock//lib/webmock/stub_request_snippet.rb#13 def to_s(with_response = T.unsafe(nil)); end end -# source://webmock//lib/webmock/request_pattern.rb#175 +# source://webmock//lib/webmock/request_pattern.rb#177 class WebMock::URIAddressablePattern < ::WebMock::URIPattern - # source://webmock//lib/webmock/request_pattern.rb#176 + # source://webmock//lib/webmock/request_pattern.rb#178 def add_query_params(query_params); end private # @return [Boolean] # - # source://webmock//lib/webmock/request_pattern.rb#201 + # source://webmock//lib/webmock/request_pattern.rb#203 def matches_with_variations?(uri); end - # source://webmock//lib/webmock/request_pattern.rb#197 + # source://webmock//lib/webmock/request_pattern.rb#199 def pattern_inspect; end # @return [Boolean] # - # source://webmock//lib/webmock/request_pattern.rb#187 + # source://webmock//lib/webmock/request_pattern.rb#189 def pattern_matches?(uri); end # @return [Boolean] # - # source://webmock//lib/webmock/request_pattern.rb#213 + # source://webmock//lib/webmock/request_pattern.rb#215 def template_matches_uri?(template, uri); end end -# source://webmock//lib/webmock/request_pattern.rb#159 +# source://webmock//lib/webmock/request_pattern.rb#161 class WebMock::URICallablePattern < ::WebMock::URIPattern private # @return [Boolean] # - # source://webmock//lib/webmock/request_pattern.rb#162 + # source://webmock//lib/webmock/request_pattern.rb#164 def pattern_matches?(uri); end end -# source://webmock//lib/webmock/request_pattern.rb#108 +# source://webmock//lib/webmock/request_pattern.rb#110 class WebMock::URIPattern include ::WebMock::RSpecMatcherDetector # @return [URIPattern] a new instance of URIPattern # - # source://webmock//lib/webmock/request_pattern.rb#111 + # source://webmock//lib/webmock/request_pattern.rb#113 def initialize(pattern); end - # source://webmock//lib/webmock/request_pattern.rb#123 + # source://webmock//lib/webmock/request_pattern.rb#125 def add_query_params(query_params); end # @return [Boolean] # - # source://webmock//lib/webmock/request_pattern.rb#138 + # source://webmock//lib/webmock/request_pattern.rb#140 def matches?(uri); end - # source://webmock//lib/webmock/request_pattern.rb#142 + # source://webmock//lib/webmock/request_pattern.rb#144 def to_s; end private - # source://webmock//lib/webmock/request_pattern.rb#150 + # source://webmock//lib/webmock/request_pattern.rb#152 def pattern_inspect; end # @return [Boolean] # - # source://webmock//lib/webmock/request_pattern.rb#154 + # source://webmock//lib/webmock/request_pattern.rb#156 def query_params_matches?(uri); end end -# source://webmock//lib/webmock/request_pattern.rb#167 +# source://webmock//lib/webmock/request_pattern.rb#169 class WebMock::URIRegexpPattern < ::WebMock::URIPattern private # @return [Boolean] # - # source://webmock//lib/webmock/request_pattern.rb#170 + # source://webmock//lib/webmock/request_pattern.rb#172 def pattern_matches?(uri); end end -# source://webmock//lib/webmock/request_pattern.rb#220 +# source://webmock//lib/webmock/request_pattern.rb#222 class WebMock::URIStringPattern < ::WebMock::URIPattern - # source://webmock//lib/webmock/request_pattern.rb#221 + # source://webmock//lib/webmock/request_pattern.rb#223 def add_query_params(query_params); end private - # source://webmock//lib/webmock/request_pattern.rb#244 + # source://webmock//lib/webmock/request_pattern.rb#246 def pattern_inspect; end # @return [Boolean] # - # source://webmock//lib/webmock/request_pattern.rb#232 + # source://webmock//lib/webmock/request_pattern.rb#234 def pattern_matches?(uri); end end -# source://webmock//lib/webmock/util/query_mapper.rb#1 +# source://webmock//lib/webmock/util/query_mapper.rb#3 module WebMock::Util; end -# source://webmock//lib/webmock/util/hash_counter.rb#5 +# source://webmock//lib/webmock/util/hash_counter.rb#7 class WebMock::Util::HashCounter # @return [HashCounter] a new instance of HashCounter # - # source://webmock//lib/webmock/util/hash_counter.rb#7 + # source://webmock//lib/webmock/util/hash_counter.rb#10 def initialize; end - # source://webmock//lib/webmock/util/hash_counter.rb#32 + # source://webmock//lib/webmock/util/hash_counter.rb#38 def each(&block); end - # source://webmock//lib/webmock/util/hash_counter.rb#19 + # source://webmock//lib/webmock/util/hash_counter.rb#24 def get(key); end # Returns the value of attribute hash. # - # source://webmock//lib/webmock/util/hash_counter.rb#6 + # source://webmock//lib/webmock/util/hash_counter.rb#8 def hash; end # Sets the attribute hash # # @param value the value to set the attribute hash to. # - # source://webmock//lib/webmock/util/hash_counter.rb#6 + # source://webmock//lib/webmock/util/hash_counter.rb#8 def hash=(_arg0); end - # source://webmock//lib/webmock/util/hash_counter.rb#13 + # source://webmock//lib/webmock/util/hash_counter.rb#17 def put(key, num = T.unsafe(nil)); end - # source://webmock//lib/webmock/util/hash_counter.rb#25 + # source://webmock//lib/webmock/util/hash_counter.rb#30 def select(&block); end end -# source://webmock//lib/webmock/util/hash_keys_stringifier.rb#3 +# source://webmock//lib/webmock/util/hash_keys_stringifier.rb#5 class WebMock::Util::HashKeysStringifier class << self - # source://webmock//lib/webmock/util/hash_keys_stringifier.rb#5 + # source://webmock//lib/webmock/util/hash_keys_stringifier.rb#7 def stringify_keys!(arg, options = T.unsafe(nil)); end end end @@ -1575,67 +1575,79 @@ end # source://webmock//lib/webmock/util/headers.rb#7 class WebMock::Util::Headers class << self - # source://webmock//lib/webmock/util/headers.rb#56 + # source://webmock//lib/webmock/util/headers.rb#59 def basic_auth_header(*credentials); end - # source://webmock//lib/webmock/util/headers.rb#52 + # source://webmock//lib/webmock/util/headers.rb#55 def decode_userinfo_from_header(header); end - # source://webmock//lib/webmock/util/headers.rb#9 + # source://webmock//lib/webmock/util/headers.rb#13 def normalize_headers(headers); end - # source://webmock//lib/webmock/util/headers.rb#37 + # source://webmock//lib/webmock/util/headers.rb#64 + def normalize_name(name); end + + # source://webmock//lib/webmock/util/headers.rb#40 def pp_headers_string(headers); end - # source://webmock//lib/webmock/util/headers.rb#23 + # source://webmock//lib/webmock/util/headers.rb#26 def sorted_headers_string(headers); end end end -# source://webmock//lib/webmock/util/json.rb#10 +# source://webmock//lib/webmock/util/headers.rb#11 +WebMock::Util::Headers::JOIN = T.let(T.unsafe(nil), String) + +# source://webmock//lib/webmock/util/headers.rb#10 +WebMock::Util::Headers::NONSTANDARD_HEADER_DELIMITER = T.let(T.unsafe(nil), String) + +# source://webmock//lib/webmock/util/headers.rb#9 +WebMock::Util::Headers::STANDARD_HEADER_DELIMITER = T.let(T.unsafe(nil), String) + +# source://webmock//lib/webmock/util/json.rb#12 class WebMock::Util::JSON class << self # Ensure that ":" and "," are always followed by a space # - # source://webmock//lib/webmock/util/json.rb#26 + # source://webmock//lib/webmock/util/json.rb#28 def convert_json_to_yaml(json); end - # source://webmock//lib/webmock/util/json.rb#13 + # source://webmock//lib/webmock/util/json.rb#15 def parse(json); end - # source://webmock//lib/webmock/util/json.rb#21 + # source://webmock//lib/webmock/util/json.rb#23 def unescape(str); end end end -# source://webmock//lib/webmock/util/json.rb#11 +# source://webmock//lib/webmock/util/json.rb#13 class WebMock::Util::JSON::ParseError < ::StandardError; end -# source://webmock//lib/webmock/util/query_mapper.rb#2 +# source://webmock//lib/webmock/util/query_mapper.rb#4 class WebMock::Util::QueryMapper class << self - # source://webmock//lib/webmock/util/query_mapper.rb#79 + # source://webmock//lib/webmock/util/query_mapper.rb#81 def collect_query_hash(query_array, empty_accumulator, options); end - # source://webmock//lib/webmock/util/query_mapper.rb#72 + # source://webmock//lib/webmock/util/query_mapper.rb#74 def collect_query_parts(query); end - # source://webmock//lib/webmock/util/query_mapper.rb#219 + # source://webmock//lib/webmock/util/query_mapper.rb#221 def dehash(hash); end - # source://webmock//lib/webmock/util/query_mapper.rb#104 + # source://webmock//lib/webmock/util/query_mapper.rb#106 def fill_accumulator_for_dot(accumulator, key, value); end - # source://webmock//lib/webmock/util/query_mapper.rb#93 + # source://webmock//lib/webmock/util/query_mapper.rb#95 def fill_accumulator_for_flat(accumulator, key, value); end - # source://webmock//lib/webmock/util/query_mapper.rb#100 + # source://webmock//lib/webmock/util/query_mapper.rb#102 def fill_accumulator_for_flat_array(accumulator, key, value); end - # source://webmock//lib/webmock/util/query_mapper.rb#123 + # source://webmock//lib/webmock/util/query_mapper.rb#125 def fill_accumulator_for_subscript(accumulator, key, value); end - # source://webmock//lib/webmock/util/query_mapper.rb#61 + # source://webmock//lib/webmock/util/query_mapper.rb#63 def normalize_query_hash(query_hash, empty_accumulator, options); end # Converts the query component to a Hash value. @@ -1668,12 +1680,12 @@ class WebMock::Util::QueryMapper # @param [Symbol] [Hash] a customizable set of options # @return [Hash, Array] The query string parsed as a Hash or Array object. # - # source://webmock//lib/webmock/util/query_mapper.rb#40 + # source://webmock//lib/webmock/util/query_mapper.rb#42 def query_to_values(query, options = T.unsafe(nil)); end # new_query_values have form [['key1', 'value1'], ['key2', 'value2']] # - # source://webmock//lib/webmock/util/query_mapper.rb#245 + # source://webmock//lib/webmock/util/query_mapper.rb#247 def to_query(parent, value, options = T.unsafe(nil)); end # Sets the query component for this URI from a Hash object. @@ -1682,122 +1694,122 @@ class WebMock::Util::QueryMapper # # @param new_query_values [Hash, #to_hash, Array] The new query values. # - # source://webmock//lib/webmock/util/query_mapper.rb#177 + # source://webmock//lib/webmock/util/query_mapper.rb#179 def values_to_query(new_query_values, options = T.unsafe(nil)); end end end -# source://webmock//lib/webmock/util/uri.rb#5 +# source://webmock//lib/webmock/util/uri.rb#7 class WebMock::Util::URI class << self - # source://webmock//lib/webmock/util/uri.rb#65 + # source://webmock//lib/webmock/util/uri.rb#67 def encode_unsafe_chars_in_userinfo(userinfo); end - # source://webmock//lib/webmock/util/uri.rb#26 + # source://webmock//lib/webmock/util/uri.rb#28 def heuristic_parse(uri); end # @return [Boolean] # - # source://webmock//lib/webmock/util/uri.rb#69 + # source://webmock//lib/webmock/util/uri.rb#71 def is_uri_localhost?(uri); end - # source://webmock//lib/webmock/util/uri.rb#30 + # source://webmock//lib/webmock/util/uri.rb#32 def normalize_uri(uri); end - # source://webmock//lib/webmock/util/uri.rb#76 + # source://webmock//lib/webmock/util/uri.rb#78 def sort_query_values(query_values); end - # source://webmock//lib/webmock/util/uri.rb#57 + # source://webmock//lib/webmock/util/uri.rb#59 def strip_default_port_from_uri_string(uri_string); end - # source://webmock//lib/webmock/util/uri.rb#87 + # source://webmock//lib/webmock/util/uri.rb#89 def uris_encoded_and_unencoded(uris); end - # source://webmock//lib/webmock/util/uri.rb#81 + # source://webmock//lib/webmock/util/uri.rb#83 def uris_with_inferred_port_and_without(uris); end - # source://webmock//lib/webmock/util/uri.rb#96 + # source://webmock//lib/webmock/util/uri.rb#98 def uris_with_scheme_and_without(uris); end - # source://webmock//lib/webmock/util/uri.rb#102 + # source://webmock//lib/webmock/util/uri.rb#104 def uris_with_trailing_slash_and_without(uris); end - # source://webmock//lib/webmock/util/uri.rb#36 + # source://webmock//lib/webmock/util/uri.rb#38 def variations_of_uri_as_strings(uri_object, only_with_scheme: T.unsafe(nil)); end end end -# source://webmock//lib/webmock/util/uri.rb#10 +# source://webmock//lib/webmock/util/uri.rb#12 WebMock::Util::URI::ADDRESSABLE_URIS = T.let(T.unsafe(nil), Hash) -# source://webmock//lib/webmock/util/uri.rb#6 +# source://webmock//lib/webmock/util/uri.rb#8 module WebMock::Util::URI::CharacterClasses; end -# source://webmock//lib/webmock/util/uri.rb#7 +# source://webmock//lib/webmock/util/uri.rb#9 WebMock::Util::URI::CharacterClasses::USERINFO = T.let(T.unsafe(nil), String) -# source://webmock//lib/webmock/util/uri.rb#14 +# source://webmock//lib/webmock/util/uri.rb#16 WebMock::Util::URI::NORMALIZED_URIS = T.let(T.unsafe(nil), Hash) -# source://webmock//lib/webmock/util/values_stringifier.rb#1 +# source://webmock//lib/webmock/util/values_stringifier.rb#3 class WebMock::Util::ValuesStringifier class << self - # source://webmock//lib/webmock/util/values_stringifier.rb#2 + # source://webmock//lib/webmock/util/values_stringifier.rb#4 def stringify_values(value); end end end -# source://webmock//lib/webmock/version.rb#2 +# source://webmock//lib/webmock/version.rb#4 WebMock::VERSION = T.let(T.unsafe(nil), String) -# source://webmock//lib/webmock/util/version_checker.rb#26 +# source://webmock//lib/webmock/util/version_checker.rb#28 class WebMock::VersionChecker # @return [VersionChecker] a new instance of VersionChecker # - # source://webmock//lib/webmock/util/version_checker.rb#27 + # source://webmock//lib/webmock/util/version_checker.rb#29 def initialize(library_name, library_version, min_patch_level, max_minor_version = T.unsafe(nil), unsupported_versions = T.unsafe(nil)); end - # source://webmock//lib/webmock/util/version_checker.rb#43 + # source://webmock//lib/webmock/util/version_checker.rb#45 def check_version!; end private - # source://webmock//lib/webmock/util/version_checker.rb#107 + # source://webmock//lib/webmock/util/version_checker.rb#109 def colorize(text, color_code); end - # source://webmock//lib/webmock/util/version_checker.rb#84 + # source://webmock//lib/webmock/util/version_checker.rb#86 def compare_version; end - # source://webmock//lib/webmock/util/version_checker.rb#103 + # source://webmock//lib/webmock/util/version_checker.rb#105 def parse_version(version); end # @return [Boolean] # - # source://webmock//lib/webmock/util/version_checker.rb#55 + # source://webmock//lib/webmock/util/version_checker.rb#57 def too_high?; end # @return [Boolean] # - # source://webmock//lib/webmock/util/version_checker.rb#51 + # source://webmock//lib/webmock/util/version_checker.rb#53 def too_low?; end # @return [Boolean] # - # source://webmock//lib/webmock/util/version_checker.rb#59 + # source://webmock//lib/webmock/util/version_checker.rb#61 def unsupported_version?; end - # source://webmock//lib/webmock/util/version_checker.rb#96 + # source://webmock//lib/webmock/util/version_checker.rb#98 def version_requirement; end - # source://webmock//lib/webmock/util/version_checker.rb#68 + # source://webmock//lib/webmock/util/version_checker.rb#70 def warn_about_too_high; end - # source://webmock//lib/webmock/util/version_checker.rb#63 + # source://webmock//lib/webmock/util/version_checker.rb#65 def warn_about_too_low; end - # source://webmock//lib/webmock/util/version_checker.rb#74 + # source://webmock//lib/webmock/util/version_checker.rb#76 def warn_about_unsupported_version; end - # source://webmock//lib/webmock/util/version_checker.rb#80 + # source://webmock//lib/webmock/util/version_checker.rb#82 def warn_in_red(text); end end diff --git a/sorbet/rbi/gems/websocket@1.2.9.rbi b/sorbet/rbi/gems/websocket@1.2.11.rbi similarity index 98% rename from sorbet/rbi/gems/websocket@1.2.9.rbi rename to sorbet/rbi/gems/websocket@1.2.11.rbi index 04050dbf4..6fb984a3b 100644 --- a/sorbet/rbi/gems/websocket@1.2.9.rbi +++ b/sorbet/rbi/gems/websocket@1.2.11.rbi @@ -669,7 +669,7 @@ class WebSocket::Frame::Incoming::Server < ::WebSocket::Frame::Incoming def outgoing_masking?; end end -# Construct or parse incoming WebSocket Frame. +# Construct or parse outgoing WebSocket Frame. # # @example # frame = WebSocket::Frame::Outgoing::Server.new(version: @handshake.version, data: "Hello", type: :text) @@ -755,6 +755,18 @@ class WebSocket::Handshake::Base # source://websocket//lib/websocket/handshake/base.rb#34 def <<(data); end + # Return default port for protocol (80 for ws, 443 for wss) + # + # source://websocket//lib/websocket/handshake/base.rb#70 + def default_port; end + + # Check if provided port is a default one + # + # @return [Boolean] + # + # source://websocket//lib/websocket/handshake/base.rb#75 + def default_port?; end + # Is parsing of data finished? # # @return [Boolena] True if request was completely parsed or error occured. False otherwise @@ -784,9 +796,7 @@ class WebSocket::Handshake::Base # source://websocket//lib/websocket/handshake/base.rb#10 def path; end - # Returns the value of attribute port. - # - # source://websocket//lib/websocket/handshake/base.rb#10 + # source://websocket//lib/websocket/handshake/base.rb#79 def port; end # Returns the value of attribute protocols. @@ -835,7 +845,7 @@ class WebSocket::Handshake::Base # @handshake.uri #=> "ws://example.com/path?query=true" # @return [String] Full URI with protocol # - # source://websocket//lib/websocket/handshake/base.rb#73 + # source://websocket//lib/websocket/handshake/base.rb#87 def uri; end # Is parsed data valid? @@ -856,25 +866,25 @@ class WebSocket::Handshake::Base # # @param message [String] Error message to set # - # source://websocket//lib/websocket/handshake/base.rb#92 + # source://websocket//lib/websocket/handshake/base.rb#106 def error=(message); end # Parse data imported to handshake and sets state to finished if necessary. # # @return [Boolean] True if finished parsing. False if not all data received yet. # - # source://websocket//lib/websocket/handshake/base.rb#101 + # source://websocket//lib/websocket/handshake/base.rb#115 def parse_data; end # Number of lines after header that should be handled as belonging to handshake. Any data after those lines will be handled as leftovers. # # @return [Integer] Number of lines # - # source://websocket//lib/websocket/handshake/base.rb#86 + # source://websocket//lib/websocket/handshake/base.rb#100 def reserved_leftover_lines; end end -# source://websocket//lib/websocket/handshake/base.rb#97 +# source://websocket//lib/websocket/handshake/base.rb#111 WebSocket::Handshake::Base::HEADER = T.let(T.unsafe(nil), Regexp) # Construct or parse a client WebSocket handshake. @@ -1069,12 +1079,12 @@ class WebSocket::Handshake::Handler::Client01 < ::WebSocket::Handshake::Handler: def handshake_keys; end end -# source://websocket//lib/websocket/handshake/handler/client04.rb#9 +# source://websocket//lib/websocket/handshake/handler/client04.rb#8 class WebSocket::Handshake::Handler::Client04 < ::WebSocket::Handshake::Handler::Client # @return [Boolean] # @see WebSocket::Handshake::Base#valid? # - # source://websocket//lib/websocket/handshake/handler/client04.rb#11 + # source://websocket//lib/websocket/handshake/handler/client04.rb#10 def valid?; end private @@ -1083,25 +1093,25 @@ class WebSocket::Handshake::Handler::Client04 < ::WebSocket::Handshake::Handler: # # @return [Sering] accept # - # source://websocket//lib/websocket/handshake/handler/client04.rb#42 + # source://websocket//lib/websocket/handshake/handler/client04.rb#41 def accept; end # @see WebSocket::Handshake::Handler::Base#handshake_keys # - # source://websocket//lib/websocket/handshake/handler/client04.rb#18 + # source://websocket//lib/websocket/handshake/handler/client04.rb#17 def handshake_keys; end # Sec-WebSocket-Key value # # @return [String] key # - # source://websocket//lib/websocket/handshake/handler/client04.rb#36 + # source://websocket//lib/websocket/handshake/handler/client04.rb#35 def key; end - # source://websocket//lib/websocket/handshake/handler/client04.rb#57 + # source://websocket//lib/websocket/handshake/handler/client04.rb#56 def provided_protocols; end - # source://websocket//lib/websocket/handshake/handler/client04.rb#53 + # source://websocket//lib/websocket/handshake/handler/client04.rb#52 def supported_protocols; end # Verify if received header Sec-WebSocket-Accept matches generated one. @@ -1109,7 +1119,7 @@ class WebSocket::Handshake::Handler::Client04 < ::WebSocket::Handshake::Handler: # @raise [WebSocket::Error::Handshake::InvalidAuthentication] # @return [Boolean] True if accept is matching. False otherwise(appropriate error is set) # - # source://websocket//lib/websocket/handshake/handler/client04.rb#48 + # source://websocket//lib/websocket/handshake/handler/client04.rb#47 def verify_accept; end end @@ -1229,42 +1239,42 @@ WebSocket::Handshake::Handler::Client76::NOISE_CHARS = T.let(T.unsafe(nil), Arra # source://websocket//lib/websocket/handshake/handler/server.rb#6 class WebSocket::Handshake::Handler::Server < ::WebSocket::Handshake::Handler::Base; end -# source://websocket//lib/websocket/handshake/handler/server04.rb#9 +# source://websocket//lib/websocket/handshake/handler/server04.rb#8 class WebSocket::Handshake::Handler::Server04 < ::WebSocket::Handshake::Handler::Server # @return [Boolean] # @see WebSocket::Handshake::Base#valid? # - # source://websocket//lib/websocket/handshake/handler/server04.rb#11 + # source://websocket//lib/websocket/handshake/handler/server04.rb#10 def valid?; end private # @see WebSocket::Handshake::Handler::Base#handshake_keys # - # source://websocket//lib/websocket/handshake/handler/server04.rb#23 + # source://websocket//lib/websocket/handshake/handler/server04.rb#22 def handshake_keys; end # @see WebSocket::Handshake::Handler::Base#header_line # - # source://websocket//lib/websocket/handshake/handler/server04.rb#18 + # source://websocket//lib/websocket/handshake/handler/server04.rb#17 def header_line; end - # source://websocket//lib/websocket/handshake/handler/server04.rb#44 + # source://websocket//lib/websocket/handshake/handler/server04.rb#43 def key; end - # source://websocket//lib/websocket/handshake/handler/server04.rb#48 + # source://websocket//lib/websocket/handshake/handler/server04.rb#47 def protocol; end # Signature of response, created from client request Sec-WebSocket-Key # # @return [String] signature # - # source://websocket//lib/websocket/handshake/handler/server04.rb#33 + # source://websocket//lib/websocket/handshake/handler/server04.rb#32 def signature; end # @raise [WebSocket::Error::Handshake::InvalidAuthentication] # - # source://websocket//lib/websocket/handshake/handler/server04.rb#39 + # source://websocket//lib/websocket/handshake/handler/server04.rb#38 def verify_key; end end @@ -1426,7 +1436,7 @@ class WebSocket::Handshake::Server < ::WebSocket::Handshake::Base # Port of server according to client header # - # @return [String] port + # @return [Integer] port # # source://websocket//lib/websocket/handshake/server.rb#137 def port; end