Class: Google::Maps::FleetEngine::V1::RequestHeader

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/maps/fleetengine/v1/header.rb

Overview

A RequestHeader contains fields common to all Fleet Engine RPC requests.

Defined Under Namespace

Modules: Platform, SdkType

Instance Attribute Summary collapse

Instance Attribute Details

#android_api_level ⇒ ::Integer

Returns Android API level of the calling SDK, only applicable for the Android SDKs. Field value example: 23.

Returns:

  • (::Integer) —

    Android API level of the calling SDK, only applicable for the Android SDKs. Field value example: 23.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/maps/fleetengine/v1/header.rb', line 74

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

  # Possible types of SDK.
  module SdkType
    # The default value. This value is used if the `sdk_type` is omitted.
    SDK_TYPE_UNSPECIFIED = 0

    # The calling SDK is Consumer.
    CONSUMER = 1

    # The calling SDK is Driver.
    DRIVER = 2

    # The calling SDK is JavaScript.
    JAVASCRIPT = 3
  end

  # The platform of the calling SDK.
  module Platform
    # The default value. This value is used if the platform is omitted.
    PLATFORM_UNSPECIFIED = 0

    # The request is coming from Android.
    ANDROID = 1

    # The request is coming from iOS.
    IOS = 2

    # The request is coming from the web.
    WEB = 3
  end
end

#device_model ⇒ ::String

Returns Model of the device on which the calling SDK is running. Field value examples: iPhone12,1, SM-G920F.

Returns:

  • (::String) —

    Model of the device on which the calling SDK is running. Field value examples: iPhone12,1, SM-G920F.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/maps/fleetengine/v1/header.rb', line 74

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

  # Possible types of SDK.
  module SdkType
    # The default value. This value is used if the `sdk_type` is omitted.
    SDK_TYPE_UNSPECIFIED = 0

    # The calling SDK is Consumer.
    CONSUMER = 1

    # The calling SDK is Driver.
    DRIVER = 2

    # The calling SDK is JavaScript.
    JAVASCRIPT = 3
  end

  # The platform of the calling SDK.
  module Platform
    # The default value. This value is used if the platform is omitted.
    PLATFORM_UNSPECIFIED = 0

    # The request is coming from Android.
    ANDROID = 1

    # The request is coming from iOS.
    IOS = 2

    # The request is coming from the web.
    WEB = 3
  end
end

#language_code ⇒ ::String

Returns The BCP-47 language code, such as en-US or sr-Latn. For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If none is specified, the response may be in any language, with a preference for English if such a name exists. Field value example: en-US.

Returns:



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/maps/fleetengine/v1/header.rb', line 74

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

  # Possible types of SDK.
  module SdkType
    # The default value. This value is used if the `sdk_type` is omitted.
    SDK_TYPE_UNSPECIFIED = 0

    # The calling SDK is Consumer.
    CONSUMER = 1

    # The calling SDK is Driver.
    DRIVER = 2

    # The calling SDK is JavaScript.
    JAVASCRIPT = 3
  end

  # The platform of the calling SDK.
  module Platform
    # The default value. This value is used if the platform is omitted.
    PLATFORM_UNSPECIFIED = 0

    # The request is coming from Android.
    ANDROID = 1

    # The request is coming from iOS.
    IOS = 2

    # The request is coming from the web.
    WEB = 3
  end
end

#manufacturer ⇒ ::String

Returns Manufacturer of the Android device from the calling SDK, only applicable for the Android SDKs. Field value example: Samsung.

Returns:

  • (::String) —

    Manufacturer of the Android device from the calling SDK, only applicable for the Android SDKs. Field value example: Samsung.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/maps/fleetengine/v1/header.rb', line 74

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

  # Possible types of SDK.
  module SdkType
    # The default value. This value is used if the `sdk_type` is omitted.
    SDK_TYPE_UNSPECIFIED = 0

    # The calling SDK is Consumer.
    CONSUMER = 1

    # The calling SDK is Driver.
    DRIVER = 2

    # The calling SDK is JavaScript.
    JAVASCRIPT = 3
  end

  # The platform of the calling SDK.
  module Platform
    # The default value. This value is used if the platform is omitted.
    PLATFORM_UNSPECIFIED = 0

    # The request is coming from Android.
    ANDROID = 1

    # The request is coming from iOS.
    IOS = 2

    # The request is coming from the web.
    WEB = 3
  end
end

#maps_sdk_version ⇒ ::String

Returns Version of the MapSDK which the calling SDK depends on, if applicable. The version format is "major.minor.patch", example: 5.2.1.

Returns:

  • (::String) —

    Version of the MapSDK which the calling SDK depends on, if applicable. The version format is "major.minor.patch", example: 5.2.1.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/maps/fleetengine/v1/header.rb', line 74

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

  # Possible types of SDK.
  module SdkType
    # The default value. This value is used if the `sdk_type` is omitted.
    SDK_TYPE_UNSPECIFIED = 0

    # The calling SDK is Consumer.
    CONSUMER = 1

    # The calling SDK is Driver.
    DRIVER = 2

    # The calling SDK is JavaScript.
    JAVASCRIPT = 3
  end

  # The platform of the calling SDK.
  module Platform
    # The default value. This value is used if the platform is omitted.
    PLATFORM_UNSPECIFIED = 0

    # The request is coming from Android.
    ANDROID = 1

    # The request is coming from iOS.
    IOS = 2

    # The request is coming from the web.
    WEB = 3
  end
end

#nav_sdk_version ⇒ ::String

Returns Version of the NavSDK which the calling SDK depends on, if applicable. The version format is "major.minor.patch", example: 2.1.0.

Returns:

  • (::String) —

    Version of the NavSDK which the calling SDK depends on, if applicable. The version format is "major.minor.patch", example: 2.1.0.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/maps/fleetengine/v1/header.rb', line 74

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

  # Possible types of SDK.
  module SdkType
    # The default value. This value is used if the `sdk_type` is omitted.
    SDK_TYPE_UNSPECIFIED = 0

    # The calling SDK is Consumer.
    CONSUMER = 1

    # The calling SDK is Driver.
    DRIVER = 2

    # The calling SDK is JavaScript.
    JAVASCRIPT = 3
  end

  # The platform of the calling SDK.
  module Platform
    # The default value. This value is used if the platform is omitted.
    PLATFORM_UNSPECIFIED = 0

    # The request is coming from Android.
    ANDROID = 1

    # The request is coming from iOS.
    IOS = 2

    # The request is coming from the web.
    WEB = 3
  end
end

#os_version ⇒ ::String

Returns Version of the operating system on which the calling SDK is running. Field value examples: 4.4.1, 12.1.

Returns:

  • (::String) —

    Version of the operating system on which the calling SDK is running. Field value examples: 4.4.1, 12.1.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/maps/fleetengine/v1/header.rb', line 74

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

  # Possible types of SDK.
  module SdkType
    # The default value. This value is used if the `sdk_type` is omitted.
    SDK_TYPE_UNSPECIFIED = 0

    # The calling SDK is Consumer.
    CONSUMER = 1

    # The calling SDK is Driver.
    DRIVER = 2

    # The calling SDK is JavaScript.
    JAVASCRIPT = 3
  end

  # The platform of the calling SDK.
  module Platform
    # The default value. This value is used if the platform is omitted.
    PLATFORM_UNSPECIFIED = 0

    # The request is coming from Android.
    ANDROID = 1

    # The request is coming from iOS.
    IOS = 2

    # The request is coming from the web.
    WEB = 3
  end
end

#platform ⇒ ::Google::Maps::FleetEngine::V1::RequestHeader::Platform

Returns Platform of the calling SDK.

Returns:



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/maps/fleetengine/v1/header.rb', line 74

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

  # Possible types of SDK.
  module SdkType
    # The default value. This value is used if the `sdk_type` is omitted.
    SDK_TYPE_UNSPECIFIED = 0

    # The calling SDK is Consumer.
    CONSUMER = 1

    # The calling SDK is Driver.
    DRIVER = 2

    # The calling SDK is JavaScript.
    JAVASCRIPT = 3
  end

  # The platform of the calling SDK.
  module Platform
    # The default value. This value is used if the platform is omitted.
    PLATFORM_UNSPECIFIED = 0

    # The request is coming from Android.
    ANDROID = 1

    # The request is coming from iOS.
    IOS = 2

    # The request is coming from the web.
    WEB = 3
  end
end

#region_code ⇒ ::String

Returns Required. CLDR region code of the region where the request originates. Field value example: US.

Returns:

  • (::String) —

    Required. CLDR region code of the region where the request originates. Field value example: US.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/maps/fleetengine/v1/header.rb', line 74

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

  # Possible types of SDK.
  module SdkType
    # The default value. This value is used if the `sdk_type` is omitted.
    SDK_TYPE_UNSPECIFIED = 0

    # The calling SDK is Consumer.
    CONSUMER = 1

    # The calling SDK is Driver.
    DRIVER = 2

    # The calling SDK is JavaScript.
    JAVASCRIPT = 3
  end

  # The platform of the calling SDK.
  module Platform
    # The default value. This value is used if the platform is omitted.
    PLATFORM_UNSPECIFIED = 0

    # The request is coming from Android.
    ANDROID = 1

    # The request is coming from iOS.
    IOS = 2

    # The request is coming from the web.
    WEB = 3
  end
end

#sdk_type ⇒ ::Google::Maps::FleetEngine::V1::RequestHeader::SdkType

Returns The type of SDK sending the request.

Returns:



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/maps/fleetengine/v1/header.rb', line 74

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

  # Possible types of SDK.
  module SdkType
    # The default value. This value is used if the `sdk_type` is omitted.
    SDK_TYPE_UNSPECIFIED = 0

    # The calling SDK is Consumer.
    CONSUMER = 1

    # The calling SDK is Driver.
    DRIVER = 2

    # The calling SDK is JavaScript.
    JAVASCRIPT = 3
  end

  # The platform of the calling SDK.
  module Platform
    # The default value. This value is used if the platform is omitted.
    PLATFORM_UNSPECIFIED = 0

    # The request is coming from Android.
    ANDROID = 1

    # The request is coming from iOS.
    IOS = 2

    # The request is coming from the web.
    WEB = 3
  end
end

#sdk_version ⇒ ::String

Returns Version of the calling SDK, if applicable. The version format is "major.minor.patch", example: 1.1.2.

Returns:

  • (::String) —

    Version of the calling SDK, if applicable. The version format is "major.minor.patch", example: 1.1.2.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/maps/fleetengine/v1/header.rb', line 74

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

  # Possible types of SDK.
  module SdkType
    # The default value. This value is used if the `sdk_type` is omitted.
    SDK_TYPE_UNSPECIFIED = 0

    # The calling SDK is Consumer.
    CONSUMER = 1

    # The calling SDK is Driver.
    DRIVER = 2

    # The calling SDK is JavaScript.
    JAVASCRIPT = 3
  end

  # The platform of the calling SDK.
  module Platform
    # The default value. This value is used if the platform is omitted.
    PLATFORM_UNSPECIFIED = 0

    # The request is coming from Android.
    ANDROID = 1

    # The request is coming from iOS.
    IOS = 2

    # The request is coming from the web.
    WEB = 3
  end
end

#trace_id ⇒ ::String

Returns Optional ID that can be provided for logging purposes in order to identify the request.

Returns:

  • (::String) —

    Optional ID that can be provided for logging purposes in order to identify the request.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'proto_docs/google/maps/fleetengine/v1/header.rb', line 74

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

  # Possible types of SDK.
  module SdkType
    # The default value. This value is used if the `sdk_type` is omitted.
    SDK_TYPE_UNSPECIFIED = 0

    # The calling SDK is Consumer.
    CONSUMER = 1

    # The calling SDK is Driver.
    DRIVER = 2

    # The calling SDK is JavaScript.
    JAVASCRIPT = 3
  end

  # The platform of the calling SDK.
  module Platform
    # The default value. This value is used if the platform is omitted.
    PLATFORM_UNSPECIFIED = 0

    # The request is coming from Android.
    ANDROID = 1

    # The request is coming from iOS.
    IOS = 2

    # The request is coming from the web.
    WEB = 3
  end
end