Navigation Connect API v1 - Package cloud.google.com/go/maps/navconnect/apiv1 (v1.40.0)

Package navconnect is an auto-generated package for the Navigation Connect API.

Navigation Connect API.

General documentation

For information that is relevant for all client libraries please reference https://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on this page includes:

Example usage

To get started with this package, create a client.

// go get cloud.google.com/go/maps/navconnect/apiv1@latest
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := navconnect.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.

Using the Client

The following is an example of making an API call with the newly created client, mentioned above.

req := &navconnectpb.CreateTripRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/cloud.google.com/go/maps/navconnect/apiv1/navconnectpb#CreateTripRequest.
}
resp, err := c.CreateTrip(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

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.

Functions

func DefaultAuthScopes 

func DefaultAuthScopes() []string

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

CallOptions

type CallOptions struct {
	CreateTrip []gax.CallOption
	GetTrip    []gax.CallOption
}

CallOptions contains the retry settings for each method of Client.

Client

type Client struct {

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

Client is a client for interacting with Navigation Connect API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service for NavConnect clients to create and get trips.

func NewClient 

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

NewClient creates a new nav connect service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Service for NavConnect clients to create and get trips.

Example

package main

import (
	"context"

	navconnect "cloud.google.com/go/maps/navconnect/apiv1"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := navconnect.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func NewRESTClient 

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

NewRESTClient creates a new nav connect service rest client.

Service for NavConnect clients to create and get trips.

Example

package main

import (
	"context"

	navconnect "cloud.google.com/go/maps/navconnect/apiv1"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := navconnect.NewRESTClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func (*Client) Close 

func (c *Client) Close() error

Close closes the connection to the API service. Always call Close() when the client is no longer required.

func (*Client) Connection (deprecated)

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

Connection returns a connection to the API service.

Deprecated: Connections are now pooled so this method does not always return the same resource.

func (*Client) CreateTrip 

func (c *Client) CreateTrip(ctx context.Context, req *navconnectpb.CreateTripRequest, opts ...gax.CallOption) (*navconnectpb.Trip, error)

CreateTrip creates a trip. This must be called before the mobile application can start the trip. The returned trip will have the auth_token field set.

Example

package main

import (
	"context"

	navconnect "cloud.google.com/go/maps/navconnect/apiv1"
	navconnectpb "cloud.google.com/go/maps/navconnect/apiv1/navconnectpb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := navconnect.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &navconnectpb.CreateTripRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/maps/navconnect/apiv1/navconnectpb#CreateTripRequest.
	}
	resp, err := c.CreateTrip(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) GetTrip 

func (c *Client) GetTrip(ctx context.Context, req *navconnectpb.GetTripRequest, opts ...gax.CallOption) (*navconnectpb.Trip, error)

GetTrip gets a trip.

Example

package main

import (
	"context"

	navconnect "cloud.google.com/go/maps/navconnect/apiv1"
	navconnectpb "cloud.google.com/go/maps/navconnect/apiv1/navconnectpb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := navconnect.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &navconnectpb.GetTripRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/maps/navconnect/apiv1/navconnectpb#GetTripRequest.
	}
	resp, err := c.GetTrip(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}