routes

Documentation

Overview

Package routes is an auto-generated package for the Routes Preferred API.

Use of Context

The ctx passed to NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.

To close the open connection, use the Close() method.

For information about setting deadlines, reusing contexts, and more please visit https://pkg.go.dev/cloud.google.com/go.

Index

• func DefaultAuthScopes() []string
• type RoutesPreferredCallOptions
• type RoutesPreferredClient
  • func NewRoutesPreferredClient(ctx context.Context, opts ...option.ClientOption) (*RoutesPreferredClient, error)
  • func (c *RoutesPreferredClient) Close() error
  • func (c *RoutesPreferredClient) ComputeRouteMatrix(ctx context.Context, req *routespb.ComputeRouteMatrixRequest, ...) (routespb.RoutesPreferred_ComputeRouteMatrixClient, error)
  • func (c *RoutesPreferredClient) ComputeRoutes(ctx context.Context, req *routespb.ComputeRoutesRequest, ...) (*routespb.ComputeRoutesResponse, error)
  • func (c *RoutesPreferredClient) Connection() *grpc.ClientConn

Examples

• NewRoutesPreferredClient
• RoutesPreferredClient.ComputeRoutes

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

DefaultAuthScopes reports the default set of authentication scopes to use with this package.

Types

type RoutesPreferredCallOptions

type RoutesPreferredCallOptions struct {
	ComputeRoutes      []gax.CallOption
	ComputeRouteMatrix []gax.CallOption
}

RoutesPreferredCallOptions contains the retry settings for each method of RoutesPreferredClient.

type RoutesPreferredClient

type RoutesPreferredClient struct {

	// The call options for this service.
	CallOptions *RoutesPreferredCallOptions
	// contains filtered or unexported fields
}

RoutesPreferredClient is a client for interacting with Routes Preferred API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

The Routes Preferred API.

func NewRoutesPreferredClient

func NewRoutesPreferredClient(ctx context.Context, opts ...option.ClientOption) (*RoutesPreferredClient, error)

NewRoutesPreferredClient creates a new routes preferred client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

The Routes Preferred API.

Example

package main

import (
	"context"

	routes "developers.google.com/maps/go/routespreferred/v1"
)

func main() {
	ctx := context.Background()
	c, err := routes.NewRoutesPreferredClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func (*RoutesPreferredClient) Close

func (c *RoutesPreferredClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*RoutesPreferredClient) ComputeRouteMatrix

func (c *RoutesPreferredClient) ComputeRouteMatrix(ctx context.Context, req *routespb.ComputeRouteMatrixRequest, opts ...gax.CallOption) (routespb.RoutesPreferred_ComputeRouteMatrixClient, error)

ComputeRouteMatrix takes in a list of origins and destinations and returns a stream containing route information for each combination of origin and destination.

NOTE: This method requires that you specify a response field mask in 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 (at 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 (at https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/field_mask.proto).

For example, in this method:

Field mask of all available fields (for manual inspection):
X-Goog-FieldMask: *

Field mask of route durations, distances, element status, condition, and
element indices (an example production setup):
X-Goog-FieldMask: originIndex,destinationIndex,status,condition,distanceMeters,duration

It is critical that you include status in your field mask as otherwise all messages will appear to be OK. Google discourages the use of the wildcard (*) response field mask, because:

Selecting only the fields that you need helps our server save computation
cycles, allowing us to return the result to you with a lower latency.

Selecting only the fields that you need in your production job ensures
stable latency performance. We might add more response fields in the
future, and those new fields might require extra computation time. If you
select all fields, or if you select all fields at the top level, then you
might experience performance degradation because any new field we add will
be automatically included in the response.

Selecting only the fields that you need results in a smaller response
size, and thus higher network throughput.

func (*RoutesPreferredClient) ComputeRoutes

func (c *RoutesPreferredClient) ComputeRoutes(ctx context.Context, req *routespb.ComputeRoutesRequest, opts ...gax.CallOption) (*routespb.ComputeRoutesResponse, error)

ComputeRoutes returns the primary route along with optional alternate routes, given a set of terminal and intermediate waypoints.

NOTE: This method requires that you specify a response field mask in 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 (at 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 (at https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/field_mask.proto).

For example, in this method:

Field mask of all available fields (for manual inspection):
X-Goog-FieldMask: *

Field mask of Route-level duration, distance, and polyline (an example
production setup):
X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline.encodedPolyline

Google discourage the use of the wildcard (*) response field mask, or specifying the field mask at the top level (routes), because:

Selecting only the fields that you need helps our server save computation
cycles, allowing us to return the result to you with a lower latency.

Selecting only the fields that you need
in your production job ensures stable latency performance. We might add
more response fields in the future, and those new fields might require
extra computation time. If you select all fields, or if you select all
fields at the top level, then you might experience performance degradation
because any new field we add will be automatically included in the
response.

Selecting only the fields that you need results in a smaller response
size, and thus higher network throughput.

Example

package main

import (
	"context"

	routes "developers.google.com/maps/go/routespreferred/v1"
	routespb "google.golang.org/genproto/googleapis/maps/routes/v1"
)

func main() {
	ctx := context.Background()
	c, err := routes.NewRoutesPreferredClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &routespb.ComputeRoutesRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.ComputeRoutes(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*RoutesPreferredClient) Connection

func (c *RoutesPreferredClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.