Class: Google::Rpc::BadRequest

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

Overview

Describes violations in a client request. This error type focuses on the syntactic aspects of the request.

Defined Under Namespace

Classes: FieldViolation

Instance Attribute Summary collapse

Instance Attribute Details

#field_violations ⇒ ::Array<::Google::Rpc::BadRequest::FieldViolation>

Returns Describes all violations in a client request.

Returns:



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'proto_docs/google/rpc/error_details.rb', line 198

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

  # A message type used to describe a single bad request field.
  # @!attribute [rw] field
  #   @return [::String]
  #     A path that leads to a field in the request body. The value will be a
  #     sequence of dot-separated identifiers that identify a protocol buffer
  #     field.
  #
  #     Consider the following:
  #
  #         message CreateContactRequest {
  #           message EmailAddress {
  #             enum Type {
  #               TYPE_UNSPECIFIED = 0;
  #               HOME = 1;
  #               WORK = 2;
  #             }
  #
  #             optional string email = 1;
  #             repeated EmailType type = 2;
  #           }
  #
  #           string full_name = 1;
  #           repeated EmailAddress email_addresses = 2;
  #         }
  #
  #     In this example, in proto `field` could take one of the following values:
  #
  #     * `full_name` for a violation in the `full_name` value
  #     * `email_addresses[1].email` for a violation in the `email` field of the
  #       first `email_addresses` message
  #     * `email_addresses[3].type[2]` for a violation in the second `type`
  #       value in the third `email_addresses` message.
  #
  #     In JSON, the same values are represented as:
  #
  #     * `fullName` for a violation in the `fullName` value
  #     * `emailAddresses[1].email` for a violation in the `email` field of the
  #       first `emailAddresses` message
  #     * `emailAddresses[3].type[2]` for a violation in the second `type`
  #       value in the third `emailAddresses` message.
  # @!attribute [rw] description
  #   @return [::String]
  #     A description of why the request element is bad.
  class FieldViolation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end