Class: OCI::Events::Models::StreamingServiceAction

Inherits:
Action
  • Object
show all
Defined in:
lib/oci/events/models/streaming_service_action.rb

Overview

An action that delivers to an Oracle Stream Service stream.

Constant Summary

Constants inherited from Action

Action::ACTION_TYPE_ENUM, Action::LIFECYCLE_STATE_ENUM

Instance Attribute Summary collapse

Attributes inherited from Action

#action_type, #description, #id, #is_enabled, #lifecycle_message, #lifecycle_state

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Action

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ StreamingServiceAction

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id proprety

  • :lifecycle_message (String) —

    The value to assign to the #lifecycle_message proprety

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state proprety

  • :is_enabled (BOOLEAN) —

    The value to assign to the #is_enabled proprety

  • :description (String) —

    The value to assign to the #description proprety

  • :stream_id (String) —

    The value to assign to the #stream_id property



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/oci/events/models/streaming_service_action.rb', line 59

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['actionType'] = 'OSS'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.stream_id = attributes[:'streamId'] if attributes[:'streamId']

  raise 'You cannot provide both :streamId and :stream_id' if attributes.key?(:'streamId') && attributes.key?(:'stream_id')

  self.stream_id = attributes[:'stream_id'] if attributes[:'stream_id']
end

Instance Attribute Details

#stream_id ⇒ String

The OCID of the stream to which messages are delivered.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/events/models/streaming_service_action.rb', line 15

def stream_id
  @stream_id
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/oci/events/models/streaming_service_action.rb', line 18

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'action_type': :'actionType',
    'id': :'id',
    'lifecycle_message': :'lifecycleMessage',
    'lifecycle_state': :'lifecycleState',
    'is_enabled': :'isEnabled',
    'description': :'description',
    'stream_id': :'streamId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/oci/events/models/streaming_service_action.rb', line 33

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'action_type': :'String',
    'id': :'String',
    'lifecycle_message': :'String',
    'lifecycle_state': :'String',
    'is_enabled': :'BOOLEAN',
    'description': :'String',
    'stream_id': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/oci/events/models/streaming_service_action.rb', line 83

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    action_type == other.action_type &&
    id == other.id &&
    lifecycle_message == other.lifecycle_message &&
    lifecycle_state == other.lifecycle_state &&
    is_enabled == other.is_enabled &&
    description == other.description &&
    stream_id == other.stream_id
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/oci/events/models/streaming_service_action.rb', line 119

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


99
100
101
 
# File 'lib/oci/events/models/streaming_service_action.rb', line 99

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



108
109
110
 
# File 'lib/oci/events/models/streaming_service_action.rb', line 108

def hash
  [action_type, id, lifecycle_message, lifecycle_state, is_enabled, description, stream_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



152
153
154
155
156
157
158
159
160
161
 
# File 'lib/oci/events/models/streaming_service_action.rb', line 152

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



146
147
148
 
# File 'lib/oci/events/models/streaming_service_action.rb', line 146

def to_s
  to_hash.to_s
end