Class: MintPress::Aws::Lightsail::ContainerLog

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/container_log.rb

Properties (Read/Write)

  • #service_name ⇒ [String]
    'The name of the container service for which to get a container log.'
    Property Attributes
    • get_container_log_prop ⇒ 'service_name'
    • read_only ⇒ false
    • source ⇒ "get_container_log"
    

17
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/container_log.rb', line 17

property :service_name, get_container_log_prop: 'service_name', type: [String], read_only: false, source: "get_container_log", description: 'The name of the container service for which to get a container log.'
  • #container_name ⇒ [String]
    'The name of the container that is either running or previously ran on the container service for which to return a log.'
    Property Attributes
    • get_container_log_prop ⇒ 'container_name'
    • read_only ⇒ false
    • source ⇒ "get_container_log"
    

18
19
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/container_log.rb', line 18

property :container_name, get_container_log_prop: 'container_name', type: [String], read_only: false, source: "get_container_log", description: 'The name of the container that is either running or previously ran on
the container service for which to return a log.'
  • #start_time ⇒ [Time,DateTime,Integer]
    'The start of the time interval for which to get log data. Constraints: Specified in Coordinated Universal Time (UTC). Specified in the Unix time format. For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time. You can convert a human-friendly time to Unix time format using a converter like Epoch converter.'
    Property Attributes
    • get_container_log_prop ⇒ 'start_time'
    • read_only ⇒ false
    • source ⇒ "get_container_log"
    

20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/container_log.rb', line 20

property :start_time, get_container_log_prop: 'start_time', type: [Time,DateTime,Integer], read_only: false, source: "get_container_log", description: 'The start of the time interval for which to get log data.

Constraints:


Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.

For example, if you wish to use a start time of October 1, 2018, at
8 PM UTC, specify 1538424000 as the start time.



You can convert a human-friendly time to Unix time format using a
converter like Epoch converter.'
  • #end_time ⇒ [Time,DateTime,Integer]
    'The end of the time interval for which to get log data. Constraints: Specified in Coordinated Universal Time (UTC). Specified in the Unix time format. For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time. You can convert a human-friendly time to Unix time format using a converter like Epoch converter.'
    Property Attributes
    • get_container_log_prop ⇒ 'end_time'
    • read_only ⇒ false
    • source ⇒ "get_container_log"
    

35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/container_log.rb', line 35

property :end_time, get_container_log_prop: 'end_time', type: [Time,DateTime,Integer], read_only: false, source: "get_container_log", description: 'The end of the time interval for which to get log data.

Constraints:


Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.

For example, if you wish to use an end time of October 1, 2018, at 9
PM UTC, specify 1538427600 as the end time.



You can convert a human-friendly time to Unix time format using a
converter like Epoch converter.'
  • #filter_pattern ⇒ [String]
    'The pattern to use to filter the returned log events to a specific term. The following are a few examples of filter patterns that you can specify: To return all log events, specify a filter pattern of "". To exclude log events that contain the ERROR term, and return all other log events, specify a filter pattern of "-ERROR". To return log events that contain the ERROR term, specify a filter pattern of "ERROR". To return log events that contain both the ERROR and Exception terms, specify a filter pattern of "ERROR Exception". To return log events that contain the ERROR or the Exception term, specify a filter pattern of "?ERROR ?Exception".'
    Property Attributes
    • get_container_log_prop ⇒ 'filter_pattern'
    • read_only ⇒ false
    • source ⇒ "get_container_log"
    

50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/container_log.rb', line 50

property :filter_pattern, get_container_log_prop: 'filter_pattern', type: [String], read_only: false, source: "get_container_log", description: 'The pattern to use to filter the returned log events to a specific
term.

The following are a few examples of filter patterns that you can
specify:


To return all log events, specify a filter pattern of "".
To exclude log events that contain the ERROR term, and return all
other log events, specify a filter pattern of "-ERROR".
To return log events that contain the ERROR term, specify a filter
pattern of "ERROR".
To return log events that contain both the ERROR and Exception
terms, specify a filter pattern of "ERROR Exception".
To return log events that contain the ERROR or the Exception
term, specify a filter pattern of "?ERROR ?Exception".'
  • #page_token ⇒ [String]
    'The token to advance to the next page of results from your request. To get a page token, perform an initial GetContainerLog request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.'
    Property Attributes
    • get_container_log_prop ⇒ 'page_token'
    • read_only ⇒ false
    • source ⇒ "get_container_log"
    

66
67
68
69
70
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/container_log.rb', line 66

property :page_token, get_container_log_prop: 'page_token', type: [String], read_only: false, source: "get_container_log", description: 'The token to advance to the next page of results from your request.

To get a page token, perform an initial GetContainerLog request. If
your results are paginated, the response will return a next page token
that you can specify as the page token in a subsequent request.'
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
    Property Attributes 
    

74
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/container_log.rb', line 74

property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
    Property Attributes
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

77
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/container_log.rb', line 77

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ ContainerLog

Returns a new instance of ContainerLog.

Instance Method Details

#get ⇒ Object