Class: DockerEngineAPI::Models::ServiceLogsParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/docker_engine_api/models/service_logs_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(details: nil, follow: nil, since: nil, stderr: nil, stdout: nil, tail: nil, timestamps: nil, request_options: {}) ⇒ Object

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

Parameters:

  • details (Boolean) (defaults to: nil) —

    Show service context and extra details provided to logs.

  • follow (Boolean) (defaults to: nil) —

    Keep connection after returning logs.

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

    Only return logs since this time, as a UNIX timestamp

  • stderr (Boolean) (defaults to: nil) —

    Return logs from stderr

  • stdout (Boolean) (defaults to: nil) —

    Return logs from stdout

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

    Only return this number of log lines from the end of the logs.

  • timestamps (Boolean) (defaults to: nil) —

    Add timestamps to every log line

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



# File 'lib/docker_engine_api/models/service_logs_params.rb', line 53

Instance Attribute Details

#details ⇒ Boolean?

Show service context and extra details provided to logs.

Returns:

  • (Boolean, nil) 


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

optional :details, DockerEngineAPI::Internal::Type::Boolean

#follow ⇒ Boolean?

Keep connection after returning logs.

Returns:

  • (Boolean, nil) 


20
 
# File 'lib/docker_engine_api/models/service_logs_params.rb', line 20

optional :follow, DockerEngineAPI::Internal::Type::Boolean

#since ⇒ Integer?

Only return logs since this time, as a UNIX timestamp

Returns:

  • (Integer, nil) 


26
 
# File 'lib/docker_engine_api/models/service_logs_params.rb', line 26

optional :since, Integer

#stderr ⇒ Boolean?

Return logs from stderr

Returns:

  • (Boolean, nil) 


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

optional :stderr, DockerEngineAPI::Internal::Type::Boolean

#stdout ⇒ Boolean?

Return logs from stdout

Returns:

  • (Boolean, nil) 


38
 
# File 'lib/docker_engine_api/models/service_logs_params.rb', line 38

optional :stdout, DockerEngineAPI::Internal::Type::Boolean

#tail ⇒ String?

Only return this number of log lines from the end of the logs. Specify as an integer or all to output all log lines.

Returns:

  • (String, nil) 


45
 
# File 'lib/docker_engine_api/models/service_logs_params.rb', line 45

optional :tail, String

#timestamps ⇒ Boolean?

Add timestamps to every log line

Returns:

  • (Boolean, nil) 


51
 
# File 'lib/docker_engine_api/models/service_logs_params.rb', line 51

optional :timestamps, DockerEngineAPI::Internal::Type::Boolean