Class: Google::Cloud::Optimization::V1::OptimizeToursValidationError::FieldReference

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/optimization/v1/fleet_routing.rb

Overview

Specifies a context for the validation error. A FieldReference always refers to a given field in this file and follows the same hierarchical structure. For example, we may specify element #2 of start_time_windows of vehicle #5 using:

name: "vehicles" index: 5 sub_field { name: "end_time_windows" index: 2 }

We however omit top-level entities such as OptimizeToursRequest or ShipmentModel to avoid crowding the message.

Instance Attribute Summary collapse

Instance Attribute Details

#index ⇒ ::Integer

Returns Index of the field if repeated.

Note: The following fields are mutually exclusive: index, key. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Integer) —

    Index of the field if repeated.

    Note: The following fields are mutually exclusive: index, key. If a field in that set is populated, all other fields in the set will automatically be cleared.



2963
2964
2965
2966
 
# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 2963

class FieldReference
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#key ⇒ ::String

Returns Key if the field is a map.

Note: The following fields are mutually exclusive: key, index. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::String) —

    Key if the field is a map.

    Note: The following fields are mutually exclusive: key, index. If a field in that set is populated, all other fields in the set will automatically be cleared.



2963
2964
2965
2966
 
# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 2963

class FieldReference
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns Name of the field, e.g., "vehicles".

Returns:

  • (::String) —

    Name of the field, e.g., "vehicles".



2963
2964
2965
2966
 
# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 2963

class FieldReference
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#sub_field ⇒ ::Google::Cloud::Optimization::V1::OptimizeToursValidationError::FieldReference

Returns Recursively nested sub-field, if needed.

Returns:



2963
2964
2965
2966
 
# File 'proto_docs/google/cloud/optimization/v1/fleet_routing.rb', line 2963

class FieldReference
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end