client

package
v0.0.0-...-6ca850d Latest Latest
Warning

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

 Go to latest Published: Jan 11, 2020 License: MIT Imports: 13 Imported by: 0

README

client

import "github.com/ronny/ptvapi/client"

Overview

Imported Packages

Index

Package files

doc.go ptv_timetable_api_v3_client.go

Constants

const (
    // DefaultHost is the default Host
    // found in Meta (info) section of spec file
    DefaultHost string = "timetableapi.ptv.vic.gov.au"
    // DefaultBasePath is the default BasePath
    // found in Meta (info) section of spec file
    DefaultBasePath string = "/"
)

Variables

var Default = NewHTTPClient(nil)

Default PTV timetable API v3 HTTP client.

var DefaultSchemes = []string{"http", "https"}

DefaultSchemes are the default schemes found in Meta (info) section of spec file

type PTVTimetableAPIV3

type PTVTimetableAPIV3 struct {
    Departures *departures.Client

    Directions *directions.Client

    Disruptions *disruptions.Client

    Outlets *outlets.Client

    Patterns *patterns.Client

    RouteTypes *route_types.Client

    Routes *routes.Client

    Runs *runs.Client

    Search *search.Client

    Stops *stops.Client

    Transport runtime.ClientTransport
}

PTVTimetableAPIV3 is a client for PTV timetable API v3

func New
func New(transport runtime.ClientTransport, formats strfmt.Registry) *PTVTimetableAPIV3

New creates a new PTV timetable API v3 client

func NewHTTPClient
func NewHTTPClient(formats strfmt.Registry) *PTVTimetableAPIV3

NewHTTPClient creates a new PTV timetable API v3 HTTP client.

func NewHTTPClientWithConfig
func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *PTVTimetableAPIV3

NewHTTPClientWithConfig creates a new PTV timetable API v3 HTTP client, using a customizable transport config.

func (*PTVTimetableAPIV3) SetTransport
func (c *PTVTimetableAPIV3) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client and all its subresources

type TransportConfig

type TransportConfig struct {
    Host     string
    BasePath string
    Schemes  []string
}

TransportConfig contains the transport related info, found in the meta section of the spec file.

func DefaultTransportConfig
func DefaultTransportConfig() *TransportConfig

DefaultTransportConfig creates a TransportConfig with the default settings taken from the meta section of the spec file.

func (*TransportConfig) WithBasePath
func (cfg *TransportConfig) WithBasePath(basePath string) *TransportConfig

WithBasePath overrides the default basePath, provided by the meta section of the spec file.

func (*TransportConfig) WithHost
func (cfg *TransportConfig) WithHost(host string) *TransportConfig

WithHost overrides the default host, provided by the meta section of the spec file.

func (*TransportConfig) WithSchemes
func (cfg *TransportConfig) WithSchemes(schemes []string) *TransportConfig

WithSchemes overrides the default schemes, provided by the meta section of the spec file.

Generated by godoc2ghmd

Documentation

Index

Constants

View Source 
const (
	// DefaultHost is the default Host
	// found in Meta (info) section of spec file
	DefaultHost string = "timetableapi.ptv.vic.gov.au"
	// DefaultBasePath is the default BasePath
	// found in Meta (info) section of spec file
	DefaultBasePath string = "/"
)

Variables

View Source 
var Default = NewHTTPClient(nil)

Default PTV timetable API v3 HTTP client.

View Source 
var DefaultSchemes = []string{"http", "https"}

DefaultSchemes are the default schemes found in Meta (info) section of spec file

Functions

This section is empty.

Types

type PTVTimetableAPIV3 

type PTVTimetableAPIV3 struct {
	Departures *departures.Client

	Directions *directions.Client

	Disruptions *disruptions.Client

	Outlets *outlets.Client

	Patterns *patterns.Client

	RouteTypes *route_types.Client

	Routes *routes.Client

	Runs *runs.Client

	Search *search.Client

	Stops *stops.Client

	Transport runtime.ClientTransport
}

PTVTimetableAPIV3 is a client for PTV timetable API v3

func New 

func New(transport runtime.ClientTransport, formats strfmt.Registry) *PTVTimetableAPIV3

New creates a new PTV timetable API v3 client

func NewHTTPClient 

func NewHTTPClient(formats strfmt.Registry) *PTVTimetableAPIV3

NewHTTPClient creates a new PTV timetable API v3 HTTP client.

func NewHTTPClientWithConfig 

func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *PTVTimetableAPIV3

NewHTTPClientWithConfig creates a new PTV timetable API v3 HTTP client, using a customizable transport config.

func (*PTVTimetableAPIV3) SetTransport 

func (c *PTVTimetableAPIV3) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client and all its subresources

type TransportConfig 

type TransportConfig struct {
	Host     string
	BasePath string
	Schemes  []string
}

TransportConfig contains the transport related info, found in the meta section of the spec file.

func DefaultTransportConfig 

func DefaultTransportConfig() *TransportConfig

DefaultTransportConfig creates a TransportConfig with the default settings taken from the meta section of the spec file.

func (*TransportConfig) WithBasePath 

func (cfg *TransportConfig) WithBasePath(basePath string) *TransportConfig

WithBasePath overrides the default basePath, provided by the meta section of the spec file.

func (*TransportConfig) WithHost 

func (cfg *TransportConfig) WithHost(host string) *TransportConfig

WithHost overrides the default host, provided by the meta section of the spec file.

func (*TransportConfig) WithSchemes 

func (cfg *TransportConfig) WithSchemes(schemes []string) *TransportConfig

WithSchemes overrides the default schemes, provided by the meta section of the spec file.

Source Files

View all Source files

Directories

Path Synopsis

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.