Class: Google::Rpc::Help

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/rpc/error_details.rb

Overview

Provides links to documentation or for performing an out of band action.

For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.

Defined Under Namespace

Classes: Link

Instance Attribute Summary collapse

Instance Attribute Details

Returns URL(s) pointing to additional information on handling the current error.

Returns:



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'proto_docs/google/rpc/error_details.rb', line 301

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

  # Describes a URL link.
  # @!attribute [rw] description
  #   @return [::String]
  #     Describes what the link offers.
  # @!attribute [rw] url
  #   @return [::String]
  #     The URL of the link.
  class Link
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end