ComputeFlightEmissionsRequest: Input definition for the ComputeFlightEmissions request.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ComputeFlightEmissionsRequest) MarshalJSON() ([]byte, error)
ComputeFlightEmissionsResponse: Output definition for the ComputeFlightEmissions response.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ComputeFlightEmissionsResponse) MarshalJSON() ([]byte, error)
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
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Date) MarshalJSON() ([]byte, error)
EmissionsGramsPerPax: Grouped emissions per seating class results.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EmissionsGramsPerPax) MarshalJSON() ([]byte, error)
Flight: All details related to a single request item for a direct flight emission estimates.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Flight) MarshalJSON() ([]byte, error)
FlightWithEmissions: Direct flight with emission estimates.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *FlightWithEmissions) MarshalJSON() ([]byte, error)
type FlightsComputeFlightEmissionsCall struct {
// contains filtered or unexported fields
}
func (c *FlightsComputeFlightEmissionsCall) Context(ctx context.Context) *FlightsComputeFlightEmissionsCall
Context sets the context to be used in this call's Do method.
func (c *FlightsComputeFlightEmissionsCall) Do(opts ...googleapi.CallOption) (*ComputeFlightEmissionsResponse, error)
Do executes the "travelimpactmodel.flights.computeFlightEmissions" call. 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 (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 details.
func (c *FlightsComputeFlightEmissionsCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type FlightsService struct {
// contains filtered or unexported fields
}
func NewFlightsService(s *Service) *FlightsService
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.
ModelVersion: Travel Impact Model version. For more information about the model versioning see https://github.com/google/travel-impact-model/#versioning.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
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. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ModelVersion) MarshalJSON() ([]byte, error)
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(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(ctx context.Context, opts ...option.ClientOption) (*Service, error)
NewService creates a new Service.