Class: Google::Cloud::Notebooks::V1::Event

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/notebooks/v1/event.rb

Overview

The definition of an Event for a managed / semi-managed notebook instance.

Defined Under Namespace

Modules: EventType Classes: DetailsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#details ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Optional. Event details. This field is used to pass event information.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Optional. Event details. This field is used to pass event information.



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'proto_docs/google/cloud/notebooks/v1/event.rb', line 34

class Event
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DetailsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The definition of the event types.
  module EventType
    # Event is not specified.
    EVENT_TYPE_UNSPECIFIED = 0

    # The instance / runtime is idle
    IDLE = 1

    # The instance / runtime is available.
    # This event indicates that instance / runtime underlying compute is
    # operational.
    HEARTBEAT = 2

    # The instance / runtime health is available.
    # This event indicates that instance / runtime health information.
    HEALTH = 3

    # The instance / runtime is available.
    # This event allows instance / runtime to send Host maintenance
    # information to Control Plane.
    # https://cloud.google.com/compute/docs/gpus/gpu-host-maintenance
    MAINTENANCE = 4
  end
end

#report_time ⇒ ::Google::Protobuf::Timestamp

Returns Event report time.

Returns:



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'proto_docs/google/cloud/notebooks/v1/event.rb', line 34

class Event
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DetailsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The definition of the event types.
  module EventType
    # Event is not specified.
    EVENT_TYPE_UNSPECIFIED = 0

    # The instance / runtime is idle
    IDLE = 1

    # The instance / runtime is available.
    # This event indicates that instance / runtime underlying compute is
    # operational.
    HEARTBEAT = 2

    # The instance / runtime health is available.
    # This event indicates that instance / runtime health information.
    HEALTH = 3

    # The instance / runtime is available.
    # This event allows instance / runtime to send Host maintenance
    # information to Control Plane.
    # https://cloud.google.com/compute/docs/gpus/gpu-host-maintenance
    MAINTENANCE = 4
  end
end

#type ⇒ ::Google::Cloud::Notebooks::V1::Event::EventType

Returns Event type.

Returns:



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'proto_docs/google/cloud/notebooks/v1/event.rb', line 34

class Event
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class DetailsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The definition of the event types.
  module EventType
    # Event is not specified.
    EVENT_TYPE_UNSPECIFIED = 0

    # The instance / runtime is idle
    IDLE = 1

    # The instance / runtime is available.
    # This event indicates that instance / runtime underlying compute is
    # operational.
    HEARTBEAT = 2

    # The instance / runtime health is available.
    # This event indicates that instance / runtime health information.
    HEALTH = 3

    # The instance / runtime is available.
    # This event allows instance / runtime to send Host maintenance
    # information to Control Plane.
    # https://cloud.google.com/compute/docs/gpus/gpu-host-maintenance
    MAINTENANCE = 4
  end
end