class Aws::Resources::Documenter::ResourceOperationDocumenter

Attributes

plural[R]

@return [Boolean] Returns `true` if this operation returns an

array of resource objects. Returns `false` if this method returns
a single resource object.
plural?[R]

@return [Boolean] Returns `true` if this operation returns an

array of resource objects. Returns `false` if this method returns
a single resource object.

Public Class Methods

new(*args) click to toggle source
# File lib/aws-sdk-resources/documenter/resource_operation_documenter.rb, line 6
def initialize(*args)
  super
  @plural = @operation.builder.plural?
end

Public Instance Methods

example_tags() click to toggle source
# File lib/aws-sdk-resources/documenter/resource_operation_documenter.rb, line 26
def example_tags
  id = target_resource_class.identifiers.last.to_s
  idv = target_resource_class_name.downcase + '-' + id.gsub('_', '-')
  example = []
  example << "@example Basic usage"
  example << "  #{resp_variable} = #{variable_name}.#{operation_name}(options)"
  if plural?
    example << "  #{resp_variable}.map(&:#{id})"
    example << "  #=> [#{idv.inspect}, ...]"
  else
    example << "  #{resp_variable}.#{id}"
    example << "  #=> #{idv.inspect}"
  end
  super + [tag(example.join("\n"))]
end
resp_variable() click to toggle source
# File lib/aws-sdk-resources/documenter/resource_operation_documenter.rb, line 42
def resp_variable
  if plural?
    target_resource_class_name.downcase + 's'
  else
    target_resource_class_name.downcase
  end
end
return_tag() click to toggle source
# File lib/aws-sdk-resources/documenter/resource_operation_documenter.rb, line 18
def return_tag
  if plural?
    tag("@return [Array<#{target_resource_class_name}>]")
  else
    tag("@return [#{target_resource_class_name}]")
  end
end