Sha256: 2b276e6ed2a2b391d89c40aea24349cbc09a04c54302cc371de4cffb4db35095

Contents?: true

Size: 1.31 KB

Versions: 8

Compression:

Stored size: 1.31 KB

Contents

<%- assert_locals method -%>
# @overload <%= method.name %>(request, options = nil)
#   Pass arguments to `<%= method.name %>` via a request object, either of type
#   {<%= method.request_type %>} or an equivalent Hash.
#
#   @param request [<%= method.request_type %>, ::Hash]
#     A request object representing the call parameters. Required. To specify no
#     parameters, or to keep all the default parameter values, pass an empty Hash.
#   @param options [::Gapic::CallOptions, ::Hash]
#     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#     Note: currently retry functionality is not implemented. While it is possible
#     to set it using ::Gapic::CallOptions, it will not be applied
<%-if method.arguments.any?-%>
#
<%- arg_list = method.arguments.map { |arg| "#{arg.name}: nil"}.join ", " -%>
# @overload <%= method.name %>(<%= arg_list %>)
#   Pass arguments to `<%= method.name %>` via keyword arguments. Note that at
#   least one keyword argument is required. To specify no parameters, or to keep all
#   the default parameter values, pass an empty Hash as a request object (see above).
#
<%- method.arguments.each do |arg| -%>
#   @param <%= arg.name %> [<%= arg.doc_types %>]
<%- if arg.doc_description -%>
<%= indent arg.doc_description, "#     " %>
<%- end -%>
<%- end -%>
<%- end -%>

Version data entries

8 entries across 8 versions & 1 rubygems

Version Path
gapic-generator-0.11.0 templates/default/service/rest/client/method/docs/_request.erb
gapic-generator-0.10.1 templates/default/service/rest/client/method/docs/_request.erb
gapic-generator-0.10.0 templates/default/service/rest/client/method/docs/_request.erb
gapic-generator-0.9.1 templates/default/service/rest/client/method/docs/_request.erb
gapic-generator-0.9.0 templates/default/service/rest/client/method/docs/_request.erb
gapic-generator-0.8.0 templates/default/service/rest/client/method/docs/_request.erb
gapic-generator-0.7.5 templates/default/service/rest/client/method/docs/_request.erb
gapic-generator-0.7.4 templates/default/service/rest/client/method/docs/_request.erb