travelimpactmodel

package
v0.149.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 31, 2023 License: BSD-3-Clause Imports: 16 Imported by: 0

Documentation

Overview

Package travelimpactmodel provides access to the Travel Impact Model API.

For product documentation, see: https://developers.google.com/travel/impact-model

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example: 

import "google.golang.org/api/travelimpactmodel/v1"
...
ctx := context.Background()
travelimpactmodelService, err := travelimpactmodel.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey: 

travelimpactmodelService, err := travelimpactmodel.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource: 

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
travelimpactmodelService, err := travelimpactmodel.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ComputeFlightEmissionsRequest 

type ComputeFlightEmissionsRequest struct {
	// Flights: Required. Direct flights to return emission estimates for.
	Flights []*Flight `json:"flights,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Flights") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Flights") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ComputeFlightEmissionsRequest: Input definition for the ComputeFlightEmissions request.

func (*ComputeFlightEmissionsRequest) MarshalJSON 

func (s *ComputeFlightEmissionsRequest) MarshalJSON() ([]byte, error)

type ComputeFlightEmissionsResponse 

type ComputeFlightEmissionsResponse struct {
	// FlightEmissions: List of flight legs with emission estimates.
	FlightEmissions []*FlightWithEmissions `json:"flightEmissions,omitempty"`

	// ModelVersion: The model version under which emission estimates for
	// all flights in this response were computed.
	ModelVersion *ModelVersion `json:"modelVersion,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "FlightEmissions") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "FlightEmissions") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

ComputeFlightEmissionsResponse: Output definition for the ComputeFlightEmissions response.

func (*ComputeFlightEmissionsResponse) MarshalJSON 

func (s *ComputeFlightEmissionsResponse) MarshalJSON() ([]byte, error)

type Date 

type Date struct {
	// Day: Day of a month. Must be from 1 to 31 and valid for the year and
	// month, or 0 to specify a year by itself or a year and month where the
	// day isn't significant.
	Day int64 `json:"day,omitempty"`

	// Month: Month of a year. Must be from 1 to 12, or 0 to specify a year
	// without a month and day.
	Month int64 `json:"month,omitempty"`

	// Year: Year of the date. Must be from 1 to 9999, or 0 to specify a
	// date without a year.
	Year int64 `json:"year,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Day") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Day") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Date: Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp

func (*Date) MarshalJSON 

func (s *Date) MarshalJSON() ([]byte, error)

type EmissionsGramsPerPax 

type EmissionsGramsPerPax struct {
	// Business: Emissions for one passenger in business class in grams.
	// This field is always computed and populated, regardless of whether
	// the aircraft has business class seats or not.
	Business int64 `json:"business,omitempty"`

	// Economy: Emissions for one passenger in economy class in grams. This
	// field is always computed and populated, regardless of whether the
	// aircraft has economy class seats or not.
	Economy int64 `json:"economy,omitempty"`

	// First: Emissions for one passenger in first class in grams. This
	// field is always computed and populated, regardless of whether the
	// aircraft has first class seats or not.
	First int64 `json:"first,omitempty"`

	// PremiumEconomy: Emissions for one passenger in premium economy class
	// in grams. This field is always computed and populated, regardless of
	// whether the aircraft has premium economy class seats or not.
	PremiumEconomy int64 `json:"premiumEconomy,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Business") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Business") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

EmissionsGramsPerPax: Grouped emissions per seating class results.

func (*EmissionsGramsPerPax) MarshalJSON 

func (s *EmissionsGramsPerPax) MarshalJSON() ([]byte, error)

type Flight 

type Flight struct {
	// DepartureDate: Required. Date of the flight in the time zone of the
	// origin airport. Must be a date in the present or future.
	DepartureDate *Date `json:"departureDate,omitempty"`

	// Destination: Required. IATA airport code for flight destination, e.g.
	// "JFK".
	Destination string `json:"destination,omitempty"`

	// FlightNumber: Required. Flight number, e.g. 324.
	FlightNumber int64 `json:"flightNumber,omitempty"`

	// OperatingCarrierCode: Required. IATA carrier code, e.g. "AA".
	OperatingCarrierCode string `json:"operatingCarrierCode,omitempty"`

	// Origin: Required. IATA airport code for flight origin, e.g. "LHR".
	Origin string `json:"origin,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DepartureDate") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DepartureDate") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Flight: All details related to a single request item for a direct flight emission estimates.

func (*Flight) MarshalJSON 

func (s *Flight) MarshalJSON() ([]byte, error)

type FlightWithEmissions 

type FlightWithEmissions struct {
	// EmissionsGramsPerPax: Optional. Per-passenger emission estimate
	// numbers. Will not be present if emissions could not be computed. For
	// the list of reasons why emissions could not be computed, see
	// ComputeFlightEmissions. Note this field is currently equivalent to
	// ttw_emissions_grams_per_pax until TIM version 1.X.0 which will update
	// this to be total wtw emissions aka wtt_emissions_grams_per_pax +
	// ttw_emissions_grams_per_pax.
	EmissionsGramsPerPax *EmissionsGramsPerPax `json:"emissionsGramsPerPax,omitempty"`

	// Flight: Required. Matches the flight identifiers in the request.
	// Note: all IATA codes are capitalized.
	Flight *Flight `json:"flight,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "EmissionsGramsPerPax") to unconditionally include in API requests.
	// By default, fields with empty or default values are omitted from API
	// requests. However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "EmissionsGramsPerPax") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

FlightWithEmissions: Direct flight with emission estimates.

func (*FlightWithEmissions) MarshalJSON 

func (s *FlightWithEmissions) MarshalJSON() ([]byte, error)

type FlightsComputeFlightEmissionsCall 

type FlightsComputeFlightEmissionsCall struct {
	// contains filtered or unexported fields
}

func (*FlightsComputeFlightEmissionsCall) Context 

func (c *FlightsComputeFlightEmissionsCall) Context(ctx context.Context) *FlightsComputeFlightEmissionsCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*FlightsComputeFlightEmissionsCall) Do 

func (c *FlightsComputeFlightEmissionsCall) Do(opts ...googleapi.CallOption) (*ComputeFlightEmissionsResponse, error)

Do executes the "travelimpactmodel.flights.computeFlightEmissions" call. Exactly one of *ComputeFlightEmissionsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ComputeFlightEmissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*FlightsComputeFlightEmissionsCall) Fields 

func (c *FlightsComputeFlightEmissionsCall) Fields(s ...googleapi.Field) *FlightsComputeFlightEmissionsCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*FlightsComputeFlightEmissionsCall) Header 

func (c *FlightsComputeFlightEmissionsCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type FlightsService 

type FlightsService struct {
	// contains filtered or unexported fields
}

func NewFlightsService 

func NewFlightsService(s *Service) *FlightsService

func (*FlightsService) ComputeFlightEmissions 

func (r *FlightsService) ComputeFlightEmissions(computeflightemissionsrequest *ComputeFlightEmissionsRequest) *FlightsComputeFlightEmissionsCall

ComputeFlightEmissions: Stateless method to retrieve emission estimates. Details on how emission estimates are computed: https://github.com/google/travel-impact-model The response will contain all entries that match the input flight legs, in the same order. If there are no estimates available for a certain flight leg, the response will return the flight leg object with empty emission fields. The request will still be considered successful. Reasons for missing emission estimates include: - The flight is unknown to the server. - The input flight leg is missing one or more identifiers. - The flight date is in the past. - The aircraft type is not supported by the model. - Missing seat configuration. The request can contain up to 1000 flight legs. If the request has more than 1000 direct flights, if will fail with an INVALID_ARGUMENT error.

type ModelVersion 

type ModelVersion struct {
	// Dated: Dated versions: Model datasets are recreated with refreshed
	// input data but no change to the algorithms regularly.
	Dated string `json:"dated,omitempty"`

	// Major: Major versions: Major changes to methodology (e.g. adding new
	// data sources to the model that lead to major output changes). Such
	// changes will be infrequent and announced well in advance. Might
	// involve API version changes, which will respect guidelines in
	// https://cloud.google.com/endpoints/docs/openapi/versioning-an-api#backwards-incompatible
	Major int64 `json:"major,omitempty"`

	// Minor: Minor versions: Changes to the model that, while being
	// consistent across schema versions, change the model parameters or
	// implementation.
	Minor int64 `json:"minor,omitempty"`

	// Patch: Patch versions: Implementation changes meant to address bugs
	// or inaccuracies in the model implementation.
	Patch int64 `json:"patch,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Dated") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Dated") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ModelVersion: Travel Impact Model version. For more information about the model versioning see https://github.com/google/travel-impact-model/#versioning.

func (*ModelVersion) MarshalJSON 

func (s *ModelVersion) MarshalJSON() ([]byte, error)

type Service 

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Flights *FlightsService
	// contains filtered or unexported fields
}

func New deprecated 

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService 

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.