Class: DockerEngineAPI::Models::ImageSearchParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/docker_engine_api/models/image_search_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(term:, filters: nil, limit: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see DockerEngineAPI::Models::ImageSearchParams for more details.

Parameters:

  • term (String) —

    Term to search

  • filters (String) (defaults to: nil) —

    A JSON encoded value of the filters (a map[string][]string) to process on the

  • limit (Integer) (defaults to: nil) —

    Maximum number of results to return

  • request_options (DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/docker_engine_api/models/image_search_params.rb', line 32

Instance Attribute Details

#filters ⇒ String?

A JSON encoded value of the filters (a map[string][]string) to process on the images list. Available filters:

  • ‘is-official=(true|false)`

  • ‘stars=<number>` Matches images that has at least ’number’ stars.

Returns:

  • (String, nil) 


24
 
# File 'lib/docker_engine_api/models/image_search_params.rb', line 24

optional :filters, String

#limit ⇒ Integer?

Maximum number of results to return

Returns:

  • (Integer, nil) 


30
 
# File 'lib/docker_engine_api/models/image_search_params.rb', line 30

optional :limit, Integer

#term ⇒ String

Term to search

Returns:

  • (String) 


14
 
# File 'lib/docker_engine_api/models/image_search_params.rb', line 14

required :term, String