You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Seahorse::Model::Shapes::ShapeRef

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-core/lib/seahorse/model/shapes.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ ShapeRef

Returns a new instance of ShapeRef



9
10
11
12
13
14
15
16
17
18
19
20
21
22
# File 'gems/aws-sdk-core/lib/seahorse/model/shapes.rb', line 9

def initialize(options = {})
  @metadata = {}
  @required = false
  @deprecated = false
  options.each do |key, value|
    if key == :metadata
      value.each do |k,v|
        self[k] = v
      end
    else
      send("#{key}=", value)
    end
  end
end

Instance Attribute Details

#deprecatedBoolean

Returns:

  • (Boolean)


34
35
36
# File 'gems/aws-sdk-core/lib/seahorse/model/shapes.rb', line 34

def deprecated
  @deprecated
end

#documentationString?

Returns:

  • (String, nil)


31
32
33
# File 'gems/aws-sdk-core/lib/seahorse/model/shapes.rb', line 31

def documentation
  @documentation
end

#requiredBoolean

Returns:

  • (Boolean)


28
29
30
# File 'gems/aws-sdk-core/lib/seahorse/model/shapes.rb', line 28

def required
  @required
end

#shapeShape

Returns:



25
26
27
# File 'gems/aws-sdk-core/lib/seahorse/model/shapes.rb', line 25

def shape
  @shape
end

Instance Method Details

#[](key) ⇒ Object

Gets metadata for the given key.



55
56
57
58
59
60
61
# File 'gems/aws-sdk-core/lib/seahorse/model/shapes.rb', line 55

def [](key)
  if @metadata.key?(key.to_s)
    @metadata[key.to_s]
  else
    @shape[key.to_s]
  end
end

#[]=(key, value) ⇒ Object

Sets metadata for the given key.



64
65
66
# File 'gems/aws-sdk-core/lib/seahorse/model/shapes.rb', line 64

def []=(key, value)
  @metadata[key.to_s] = value
end

#locationString?

Returns:

  • (String, nil)


37
38
39
# File 'gems/aws-sdk-core/lib/seahorse/model/shapes.rb', line 37

def location
  @location || (shape && shape[:location])
end

#location=(location) ⇒ Object



41
42
43
# File 'gems/aws-sdk-core/lib/seahorse/model/shapes.rb', line 41

def location= location
  @location = location
end

#location_nameString?

Returns:

  • (String, nil)


46
47
48
# File 'gems/aws-sdk-core/lib/seahorse/model/shapes.rb', line 46

def location_name
  @location_name || (shape && shape[:location_name])
end

#location_name=(location_name) ⇒ Object



50
51
52
# File 'gems/aws-sdk-core/lib/seahorse/model/shapes.rb', line 50

def location_name= location_name
  @location_name = location_name
end