roads

Documentation

Overview

Package roads is an auto-generated package for the Roads API.

Snap GPS points to roads to identify the roads a vehicle was traveling along, making up for GPS error.

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 godoc.org/cloud.google.com/go.

Index

• func DefaultAuthScopes() []string
• type CallOptions
• type Client
  • func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) Connection() *grpc.ClientConn
  • func (c *Client) ListNearestRoads(ctx context.Context, req *roadspb.ListNearestRoadsRequest, ...) (*roadspb.ListNearestRoadsResponse, error)
  • func (c *Client) SnapToRoads(ctx context.Context, req *roadspb.SnapToRoadsRequest, opts ...gax.CallOption) (*roadspb.SnapToRoadsResponse, error)

Examples

• Client.ListNearestRoads
• Client.SnapToRoads
• NewClient

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

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

Types

type CallOptions

type CallOptions struct {
	SnapToRoads      []gax.CallOption
	ListNearestRoads []gax.CallOption
}

CallOptions contains the retry settings for each method of Client.

type Client

type Client struct {

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

Client is a client for interacting with Roads API.

Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

func NewClient

func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error)

NewClient creates a new roads service client.

Example

package main

import (
	"context"

	roads "developers.google.com/maps/go/roads/v1op"
)

func main() {
	ctx := context.Background()
	c, err := roads.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use client.
	_ = c
}

func (*Client) Close

func (c *Client) Close() error

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

func (*Client) Connection

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

Connection returns a connection to the API service.

Deprecated.

func (*Client) ListNearestRoads

func (c *Client) ListNearestRoads(ctx context.Context, req *roadspb.ListNearestRoadsRequest, opts ...gax.CallOption) (*roadspb.ListNearestRoadsResponse, error)

ListNearestRoads this method takes a list of latitude,longitude points and snaps them each to their nearest road. Also returns a place ID for each snapped point.

Example

package main

import (
	"context"

	roads "developers.google.com/maps/go/roads/v1op"
	roadspb "google.golang.org/genproto/googleapis/maps/roads/v1op"
)

func main() {
	// import roadspb "google.golang.org/genproto/googleapis/maps/roads/v1op"

	ctx := context.Background()
	c, err := roads.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}

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

func (*Client) SnapToRoads

func (c *Client) SnapToRoads(ctx context.Context, req *roadspb.SnapToRoadsRequest, opts ...gax.CallOption) (*roadspb.SnapToRoadsResponse, error)

SnapToRoads this method takes a sequence of latitude,longitude points and snaps them to the most likely road segments. Optionally returns additional points giving the full road geometry. Also returns a place ID for each snapped point.

Example

package main

import (
	"context"

	roads "developers.google.com/maps/go/roads/v1op"
	roadspb "google.golang.org/genproto/googleapis/maps/roads/v1op"
)

func main() {
	// import roadspb "google.golang.org/genproto/googleapis/maps/roads/v1op"

	ctx := context.Background()
	c, err := roads.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}

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