Skip to content

Commit

Permalink
docs: various formatting and grammar fixes for proto documentation
Browse files Browse the repository at this point in the history
feat: adds support for new toll passes
feat: adds support for specifying units in the ComputeRouteMatrix request

PiperOrigin-RevId: 623543022

Source-Link: googleapis/googleapis@fc89055

Source-Link: googleapis/googleapis-gen@e586c15
Copy-Tag: eyJwIjoiYXBpcy9Hb29nbGUuTWFwcy5Sb3V0aW5nLlYyLy5Pd2xCb3QueWFtbCIsImgiOiJlNTg2YzE1NmQ4M2EyNTg0NTk4ODU3ODQ0NGYxYzFlMGE4NDJmYzRmIn0=
  • Loading branch information
gcf-owl-bot[bot] authored and amanda-tarafa committed Apr 10, 2024
1 parent af6b424 commit 7a7acef
Show file tree
Hide file tree
Showing 22 changed files with 269 additions and 197 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ public async Task ComputeRouteMatrixRequestObject()
RoutingPreference = RoutingPreference.Unspecified,
DepartureTime = new Timestamp(),
LanguageCode = "",
Units = Units.Unspecified,
ExtraComputations =
{
ComputeRouteMatrixRequest.Types.ExtraComputation.Unspecified,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -145,12 +145,12 @@
"segments": [
{
"start": 20,
"end": 76,
"end": 77,
"type": "FULL"
},
{
"start": 37,
"end": 74,
"end": 75,
"type": "SHORT"
}
]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@ public async Task ComputeRouteMatrixRequestObject()
RoutingPreference = RoutingPreference.Unspecified,
DepartureTime = new Timestamp(),
LanguageCode = "",
Units = Units.Unspecified,
ExtraComputations =
{
ComputeRouteMatrixRequest.Types.ExtraComputation.Unspecified,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,13 +79,14 @@ public enum FallbackRoutingMode {
/// </summary>
[pbr::OriginalName("FALLBACK_ROUTING_MODE_UNSPECIFIED")] Unspecified = 0,
/// <summary>
/// Indicates the `TRAFFIC_UNAWARE` [google.maps.routing.v2.RoutingPreference]
/// was used to compute the response.
/// Indicates the `TRAFFIC_UNAWARE`
/// [`RoutingPreference`][google.maps.routing.v2.RoutingPreference] was used to
/// compute the response.
/// </summary>
[pbr::OriginalName("FALLBACK_TRAFFIC_UNAWARE")] FallbackTrafficUnaware = 1,
/// <summary>
/// Indicates the `TRAFFIC_AWARE`
/// [RoutingPreference][google.maps.routing.v2.RoutingPreference] was used to
/// [`RoutingPreference`][google.maps.routing.v2.RoutingPreference] was used to
/// compute the response.
/// </summary>
[pbr::OriginalName("FALLBACK_TRAFFIC_AWARE")] FallbackTrafficAware = 2,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ public static partial class GeocodingResultsReflection {
}
#region Messages
/// <summary>
/// Contains [GeocodedWaypoints][google.maps.routing.v2.GeocodedWaypoint] for
/// Contains [`GeocodedWaypoints`][google.maps.routing.v2.GeocodedWaypoint] for
/// origin, destination and intermediate waypoints. Only populated for address
/// waypoints.
/// </summary>
Expand Down Expand Up @@ -449,8 +449,8 @@ public sealed partial class GeocodedWaypoint : pb::IMessage<GeocodedWaypoint>
private readonly pbc::RepeatedField<string> type_ = new pbc::RepeatedField<string>();
/// <summary>
/// The type(s) of the result, in the form of zero or more type tags.
/// Supported types:
/// https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types
/// Supported types: [Address types and address component
/// types](https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types).
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ public sealed partial class Location : pb::IMessage<Location>
/// values can be from 0 to 360, where 0 specifies a heading of due North, 90
/// specifies a heading of due East, and so on. You can use this field only for
/// `DRIVE` and `TWO_WHEELER`
/// [RouteTravelMode][google.maps.routing.v2.RouteTravelMode].
/// [`RouteTravelMode`][google.maps.routing.v2.RouteTravelMode].
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ public static partial class ManeuverReflection {
#region Enums
/// <summary>
/// A set of values that specify the navigation action to take for the current
/// step (e.g., turn left, merge, straight, etc.).
/// step (for example, turn left, merge, or straight).
/// </summary>
public enum Maneuver {
/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ public static partial class NavigationInstructionReflection {
#region Messages
/// <summary>
/// Encapsulates navigation instructions for a
/// [RouteLegStep][google.maps.routing.v2.RouteLegStep]
/// [`RouteLegStep`][google.maps.routing.v2.RouteLegStep].
/// </summary>
[global::System.Diagnostics.DebuggerDisplayAttribute("{ToString(),nq}")]
public sealed partial class NavigationInstruction : pb::IMessage<NavigationInstruction>
Expand Down Expand Up @@ -98,8 +98,9 @@ public sealed partial class NavigationInstruction : pb::IMessage<NavigationInstr
public const int ManeuverFieldNumber = 1;
private global::Google.Maps.Routing.V2.Maneuver maneuver_ = global::Google.Maps.Routing.V2.Maneuver.Unspecified;
/// <summary>
/// Encapsulates the navigation instructions for the current step (e.g., turn
/// left, merge, straight, etc.). This field determines which icon to display.
/// Encapsulates the navigation instructions for the current step (for example,
/// turn left, merge, or straight). This field determines which icon to
/// display.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ public enum PolylineEncoding {
[pbr::OriginalName("POLYLINE_ENCODING_UNSPECIFIED")] Unspecified = 0,
/// <summary>
/// Specifies a polyline encoded using the [polyline encoding
/// algorithm](https://developers.google.com/maps/documentation/utilities/polylinealgorithm).
/// algorithm](/maps/documentation/utilities/polylinealgorithm).
/// </summary>
[pbr::OriginalName("ENCODED_POLYLINE")] EncodedPolyline = 1,
/// <summary>
Expand Down Expand Up @@ -184,7 +184,7 @@ public sealed partial class Polyline : pb::IMessage<Polyline>
public const int GeoJsonLinestringFieldNumber = 2;
/// <summary>
/// Specifies a polyline using the [GeoJSON LineString
/// format](https://tools.ietf.org/html/rfc7946#section-3.1.4)
/// format](https://tools.ietf.org/html/rfc7946#section-3.1.4).
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand Down
20 changes: 10 additions & 10 deletions apis/Google.Maps.Routing.V2/Google.Maps.Routing.V2/Route.g.cs
Original file line number Diff line number Diff line change
Expand Up @@ -235,8 +235,8 @@ public sealed partial class Route : pb::IMessage<Route>
/// <summary>
/// A collection of legs (path segments between waypoints) that make up the
/// route. Each leg corresponds to the trip between two non-`via`
/// [Waypoints][google.maps.routing.v2.Waypoint]. For example, a route with no
/// intermediate waypoints has only one leg. A route that includes one
/// [`Waypoints`][google.maps.routing.v2.Waypoint]. For example, a route with
/// no intermediate waypoints has only one leg. A route that includes one
/// non-`via` intermediate waypoint has two legs. A route that includes one
/// `via` intermediate waypoint has one leg. The order of the legs matches the
/// order of waypoints from `origin` to `intermediates` to `destination`.
Expand Down Expand Up @@ -379,7 +379,7 @@ public sealed partial class Route : pb::IMessage<Route>
private readonly pbc::RepeatedField<int> optimizedIntermediateWaypointIndex_ = new pbc::RepeatedField<int>();
/// <summary>
/// If you set
/// [optimize_waypoint_order][google.maps.routing.v2.ComputeRoutesRequest.optimize_waypoint_order]
/// [`optimize_waypoint_order`][google.maps.routing.v2.ComputeRoutesRequest.optimize_waypoint_order]
/// to true, this field contains the optimized ordering of intermediate
/// waypoints. Otherwise, this field is empty.
/// For example, if you give an input of Origin: LA; Intermediate waypoints:
Expand Down Expand Up @@ -946,7 +946,7 @@ public sealed partial class RouteLocalizedValues : pb::IMessage<RouteLocalizedVa
/// <summary>
/// Duration taking traffic conditions into consideration, represented in
/// text form. Note: If you did not request traffic information, this value
/// will be the same value as static_duration.
/// will be the same value as `static_duration`.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand All @@ -961,8 +961,8 @@ public sealed partial class RouteLocalizedValues : pb::IMessage<RouteLocalizedVa
public const int StaticDurationFieldNumber = 3;
private global::Google.Type.LocalizedText staticDuration_;
/// <summary>
/// Duration without taking traffic conditions into
/// consideration, represented in text form.
/// Duration without taking traffic conditions into consideration,
/// represented in text form.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand Down Expand Up @@ -1293,7 +1293,7 @@ public sealed partial class RouteTravelAdvisory : pb::IMessage<RouteTravelAdviso
/// <summary>
/// Contains information about tolls on the route. This field is only populated
/// if tolls are expected on the route. If this field is set, but the
/// estimatedPrice subfield is not populated, then the route contains tolls,
/// `estimatedPrice` subfield is not populated, then the route contains tolls,
/// but the estimated price is unknown. If this field is not set, then there
/// are no tolls expected on the route.
/// </summary>
Expand Down Expand Up @@ -3552,7 +3552,7 @@ public sealed partial class MultiModalSegment : pb::IMessage<MultiModalSegment>
}

/// <summary>
/// Contains a segment of a [RouteLeg][google.maps.routing.v2.RouteLeg]. A
/// Contains a segment of a [`RouteLeg`][google.maps.routing.v2.RouteLeg]. A
/// step corresponds to a single navigation instruction. Route legs are made up
/// of steps.
/// </summary>
Expand Down Expand Up @@ -4934,7 +4934,7 @@ public sealed partial class RouteLegStepTransitDetails : pb::IMessage<RouteLegSt
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
public static partial class Types {
/// <summary>
/// Details about the transit stops for the `RouteLegStep`
/// Details about the transit stops for the `RouteLegStep`.
/// </summary>
[global::System.Diagnostics.DebuggerDisplayAttribute("{ToString(),nq}")]
public sealed partial class TransitStopDetails : pb::IMessage<TransitStopDetails>
Expand Down Expand Up @@ -5286,7 +5286,7 @@ public sealed partial class TransitStopDetails : pb::IMessage<TransitStopDetails
}

/// <summary>
/// Localized descriptions of values for RouteTransitDetails.
/// Localized descriptions of values for `RouteTransitDetails`.
/// </summary>
[global::System.Diagnostics.DebuggerDisplayAttribute("{ToString(),nq}")]
public sealed partial class TransitDetailsLocalizedValues : pb::IMessage<TransitDetailsLocalizedValues>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public static partial class RouteLabelReflection {
}
#region Enums
/// <summary>
/// Labels for the [Route][google.maps.routing.v2.Route] that are useful to
/// Labels for the [`Route`][google.maps.routing.v2.Route] that are useful to
/// identify specific properties of the route to compare against others.
/// </summary>
public enum RouteLabel {
Expand All @@ -57,7 +57,7 @@ public enum RouteLabel {
/// <summary>
/// An alternative to the default "best" route. Routes like this will be
/// returned when
/// [compute_alternative_routes][google.maps.routing.v2.ComputeRoutesRequest.compute_alternative_routes]
/// [`compute_alternative_routes`][google.maps.routing.v2.ComputeRoutesRequest.compute_alternative_routes]
/// is specified.
/// </summary>
[pbr::OriginalName("DEFAULT_ROUTE_ALTERNATE")] DefaultRouteAlternate = 2,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ public sealed partial class RouteModifiers : pb::IMessage<RouteModifiers>
/// <summary>
/// When set to true, avoids toll roads where reasonable, giving preference to
/// routes not containing toll roads. Applies only to the `DRIVE` and
/// `TWO_WHEELER` [RouteTravelMode][google.maps.routing.v2.RouteTravelMode].
/// `TWO_WHEELER` [`RouteTravelMode`][google.maps.routing.v2.RouteTravelMode].
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand All @@ -125,7 +125,7 @@ public sealed partial class RouteModifiers : pb::IMessage<RouteModifiers>
/// <summary>
/// When set to true, avoids highways where reasonable, giving preference to
/// routes not containing highways. Applies only to the `DRIVE` and
/// `TWO_WHEELER` [RouteTravelMode][google.maps.routing.v2.RouteTravelMode].
/// `TWO_WHEELER` [`RouteTravelMode`][google.maps.routing.v2.RouteTravelMode].
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand All @@ -142,7 +142,7 @@ public sealed partial class RouteModifiers : pb::IMessage<RouteModifiers>
/// <summary>
/// When set to true, avoids ferries where reasonable, giving preference to
/// routes not containing ferries. Applies only to the `DRIVE` and`TWO_WHEELER`
/// [RouteTravelMode][google.maps.routing.v2.RouteTravelMode].
/// [`RouteTravelMode`][google.maps.routing.v2.RouteTravelMode].
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand All @@ -159,7 +159,7 @@ public sealed partial class RouteModifiers : pb::IMessage<RouteModifiers>
/// <summary>
/// When set to true, avoids navigating indoors where reasonable, giving
/// preference to routes not containing indoor navigation. Applies only to the
/// `WALK` [RouteTravelMode][google.maps.routing.v2.RouteTravelMode].
/// `WALK` [`RouteTravelMode`][google.maps.routing.v2.RouteTravelMode].
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand Down Expand Up @@ -196,7 +196,7 @@ public sealed partial class RouteModifiers : pb::IMessage<RouteModifiers>
/// toll passes are not provided, the API treats the toll pass as unknown and
/// tries to return the cash price.
/// Applies only to the `DRIVE` and `TWO_WHEELER`
/// [RouteTravelMode][google.maps.routing.v2.RouteTravelMode].
/// [`RouteTravelMode`][google.maps.routing.v2.RouteTravelMode].
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ internal static RoutesClient Create(grpccore::CallInvoker callInvoker, RoutesSet
/// the input. You can provide the response field mask by using URL parameter
/// `$fields` or `fields`, or by using an HTTP/gRPC header `X-Goog-FieldMask`
/// (see the [available URL parameters and
/// headers](https://cloud.google.com/apis/docs/system-parameters). The value
/// headers](https://cloud.google.com/apis/docs/system-parameters)). The value
/// is a comma separated list of field paths. See detailed documentation about
/// [how to construct the field
/// paths](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/field_mask.proto).
Expand Down Expand Up @@ -257,7 +257,7 @@ internal static RoutesClient Create(grpccore::CallInvoker callInvoker, RoutesSet
/// the input. You can provide the response field mask by using URL parameter
/// `$fields` or `fields`, or by using an HTTP/gRPC header `X-Goog-FieldMask`
/// (see the [available URL parameters and
/// headers](https://cloud.google.com/apis/docs/system-parameters). The value
/// headers](https://cloud.google.com/apis/docs/system-parameters)). The value
/// is a comma separated list of field paths. See detailed documentation about
/// [how to construct the field
/// paths](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/field_mask.proto).
Expand Down Expand Up @@ -300,7 +300,7 @@ internal static RoutesClient Create(grpccore::CallInvoker callInvoker, RoutesSet
/// the input. You can provide the response field mask by using URL parameter
/// `$fields` or `fields`, or by using an HTTP/gRPC header `X-Goog-FieldMask`
/// (see the [available URL parameters and
/// headers](https://cloud.google.com/apis/docs/system-parameters). The value
/// headers](https://cloud.google.com/apis/docs/system-parameters)). The value
/// is a comma separated list of field paths. See detailed documentation about
/// [how to construct the field
/// paths](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/field_mask.proto).
Expand Down Expand Up @@ -351,9 +351,9 @@ public abstract partial class ComputeRouteMatrixStream : gaxgrpc::ServerStreamin
/// the input. You can provide the response field mask by using the URL
/// parameter `$fields` or `fields`, or by using the HTTP/gRPC header
/// `X-Goog-FieldMask` (see the [available URL parameters and
/// headers](https://cloud.google.com/apis/docs/system-parameters). The value
/// is a comma separated list of field paths. See this detailed documentation
/// about [how to construct the field
/// headers](https://cloud.google.com/apis/docs/system-parameters)).
/// The value is a comma separated list of field paths. See this detailed
/// documentation about [how to construct the field
/// paths](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/field_mask.proto).
///
/// For example, in this method:
Expand Down Expand Up @@ -446,7 +446,7 @@ public RoutesClientImpl(Routes.RoutesClient grpcClient, RoutesSettings settings,
/// the input. You can provide the response field mask by using URL parameter
/// `$fields` or `fields`, or by using an HTTP/gRPC header `X-Goog-FieldMask`
/// (see the [available URL parameters and
/// headers](https://cloud.google.com/apis/docs/system-parameters). The value
/// headers](https://cloud.google.com/apis/docs/system-parameters)). The value
/// is a comma separated list of field paths. See detailed documentation about
/// [how to construct the field
/// paths](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/field_mask.proto).
Expand Down Expand Up @@ -492,7 +492,7 @@ public override ComputeRoutesResponse ComputeRoutes(ComputeRoutesRequest request
/// the input. You can provide the response field mask by using URL parameter
/// `$fields` or `fields`, or by using an HTTP/gRPC header `X-Goog-FieldMask`
/// (see the [available URL parameters and
/// headers](https://cloud.google.com/apis/docs/system-parameters). The value
/// headers](https://cloud.google.com/apis/docs/system-parameters)). The value
/// is a comma separated list of field paths. See detailed documentation about
/// [how to construct the field
/// paths](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/field_mask.proto).
Expand Down Expand Up @@ -547,9 +547,9 @@ internal sealed partial class ComputeRouteMatrixStreamImpl : ComputeRouteMatrixS
/// the input. You can provide the response field mask by using the URL
/// parameter `$fields` or `fields`, or by using the HTTP/gRPC header
/// `X-Goog-FieldMask` (see the [available URL parameters and
/// headers](https://cloud.google.com/apis/docs/system-parameters). The value
/// is a comma separated list of field paths. See this detailed documentation
/// about [how to construct the field
/// headers](https://cloud.google.com/apis/docs/system-parameters)).
/// The value is a comma separated list of field paths. See this detailed
/// documentation about [how to construct the field
/// paths](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/field_mask.proto).
///
/// For example, in this method:
Expand Down
Loading

0 comments on commit 7a7acef

Please sign in to comment.