search

package
v3.0.0-rc1 Latest Latest
Warning

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

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

Client for search API

func New 

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

New creates a new search API client.

func (*Client) SearchSearch 

func (a *Client) SearchSearch(params *SearchSearchParams) (*SearchSearchOK, error)

SearchSearch views stops routes and myki ticket outlets that match the search term

func (*Client) SetTransport 

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

type SearchSearchBadRequest 

type SearchSearchBadRequest struct {
	Payload *models.V3ErrorResponse
}

SearchSearchBadRequest handles this case with default header values.

Invalid Request

func NewSearchSearchBadRequest 

func NewSearchSearchBadRequest() *SearchSearchBadRequest

NewSearchSearchBadRequest creates a SearchSearchBadRequest with default headers values

func (*SearchSearchBadRequest) Error 

func (o *SearchSearchBadRequest) Error() string

func (*SearchSearchBadRequest) GetPayload 

func (o *SearchSearchBadRequest) GetPayload() *models.V3ErrorResponse

type SearchSearchForbidden 

type SearchSearchForbidden struct {
	Payload *models.V3ErrorResponse
}

SearchSearchForbidden handles this case with default header values.

Access Denied

func NewSearchSearchForbidden 

func NewSearchSearchForbidden() *SearchSearchForbidden

NewSearchSearchForbidden creates a SearchSearchForbidden with default headers values

func (*SearchSearchForbidden) Error 

func (o *SearchSearchForbidden) Error() string

func (*SearchSearchForbidden) GetPayload 

func (o *SearchSearchForbidden) GetPayload() *models.V3ErrorResponse

type SearchSearchOK 

type SearchSearchOK struct {
	Payload *models.V3SearchResult
}

SearchSearchOK handles this case with default header values.

Stops, routes and myki ticket outlets that contain the search term (note: stops and routes are ordered by route_type by default).

func NewSearchSearchOK 

func NewSearchSearchOK() *SearchSearchOK

NewSearchSearchOK creates a SearchSearchOK with default headers values

func (*SearchSearchOK) Error 

func (o *SearchSearchOK) Error() string

func (*SearchSearchOK) GetPayload 

func (o *SearchSearchOK) GetPayload() *models.V3SearchResult

type SearchSearchParams 

type SearchSearchParams struct {

	/*Devid
	  Your developer id

	*/
	Devid *string
	/*IncludeAddresses
	  Placeholder for future development; currently unavailable

	*/
	IncludeAddresses *bool
	/*IncludeOutlets
	  Indicates if outlets will be returned in response (default = true)

	*/
	IncludeOutlets *bool
	/*Latitude
	  Filter by geographic coordinate of latitude

	*/
	Latitude *float32
	/*Longitude
	  Filter by geographic coordinate of longitude

	*/
	Longitude *float32
	/*MatchRouteBySuburb
	  Indicates whether to find routes by suburbs in the search term (default = true)

	*/
	MatchRouteBySuburb *bool
	/*MatchStopByGtfsStopID
	  Indicates whether to search for stops according to a metlink stop ID (default = false)

	*/
	MatchStopByGtfsStopID *bool
	/*MatchStopBySuburb
	  Indicates whether to find stops by suburbs in the search term (default = true)

	*/
	MatchStopBySuburb *bool
	/*MaxDistance
	  Filter by maximum distance (in metres) from location specified via latitude and longitude parameters

	*/
	MaxDistance *float32
	/*RouteTypes
	  Filter by route_type; values returned via RouteTypes API (note: stops and routes are ordered by route_types specified)

	*/
	RouteTypes []int32
	/*SearchTerm
	  Search text (note: if search text is numeric and/or less than 3 characters, the API will only return routes)

	*/
	SearchTerm string
	/*Signature
	  Authentication signature for request

	*/
	Signature *string
	/*Token
	  Please ignore

	*/
	Token *string

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

SearchSearchParams contains all the parameters to send to the API endpoint for the search search operation typically these are written to a http.Request

func NewSearchSearchParams 

func NewSearchSearchParams() *SearchSearchParams

NewSearchSearchParams creates a new SearchSearchParams object with the default values initialized.

func NewSearchSearchParamsWithContext 

func NewSearchSearchParamsWithContext(ctx context.Context) *SearchSearchParams

NewSearchSearchParamsWithContext creates a new SearchSearchParams object with the default values initialized, and the ability to set a context for a request

func NewSearchSearchParamsWithHTTPClient 

func NewSearchSearchParamsWithHTTPClient(client *http.Client) *SearchSearchParams

NewSearchSearchParamsWithHTTPClient creates a new SearchSearchParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewSearchSearchParamsWithTimeout 

func NewSearchSearchParamsWithTimeout(timeout time.Duration) *SearchSearchParams

NewSearchSearchParamsWithTimeout creates a new SearchSearchParams object with the default values initialized, and the ability to set a timeout on a request

func (*SearchSearchParams) SetContext 

func (o *SearchSearchParams) SetContext(ctx context.Context)

SetContext adds the context to the search search params

func (*SearchSearchParams) SetDevid 

func (o *SearchSearchParams) SetDevid(devid *string)

SetDevid adds the devid to the search search params

func (*SearchSearchParams) SetHTTPClient 

func (o *SearchSearchParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the search search params

func (*SearchSearchParams) SetIncludeAddresses 

func (o *SearchSearchParams) SetIncludeAddresses(includeAddresses *bool)

SetIncludeAddresses adds the includeAddresses to the search search params

func (*SearchSearchParams) SetIncludeOutlets 

func (o *SearchSearchParams) SetIncludeOutlets(includeOutlets *bool)

SetIncludeOutlets adds the includeOutlets to the search search params

func (*SearchSearchParams) SetLatitude 

func (o *SearchSearchParams) SetLatitude(latitude *float32)

SetLatitude adds the latitude to the search search params

func (*SearchSearchParams) SetLongitude 

func (o *SearchSearchParams) SetLongitude(longitude *float32)

SetLongitude adds the longitude to the search search params

func (*SearchSearchParams) SetMatchRouteBySuburb 

func (o *SearchSearchParams) SetMatchRouteBySuburb(matchRouteBySuburb *bool)

SetMatchRouteBySuburb adds the matchRouteBySuburb to the search search params

func (*SearchSearchParams) SetMatchStopByGtfsStopID 

func (o *SearchSearchParams) SetMatchStopByGtfsStopID(matchStopByGtfsStopID *bool)

SetMatchStopByGtfsStopID adds the matchStopByGtfsStopId to the search search params

func (*SearchSearchParams) SetMatchStopBySuburb 

func (o *SearchSearchParams) SetMatchStopBySuburb(matchStopBySuburb *bool)

SetMatchStopBySuburb adds the matchStopBySuburb to the search search params

func (*SearchSearchParams) SetMaxDistance 

func (o *SearchSearchParams) SetMaxDistance(maxDistance *float32)

SetMaxDistance adds the maxDistance to the search search params

func (*SearchSearchParams) SetRouteTypes 

func (o *SearchSearchParams) SetRouteTypes(routeTypes []int32)

SetRouteTypes adds the routeTypes to the search search params

func (*SearchSearchParams) SetSearchTerm 

func (o *SearchSearchParams) SetSearchTerm(searchTerm string)

SetSearchTerm adds the searchTerm to the search search params

func (*SearchSearchParams) SetSignature 

func (o *SearchSearchParams) SetSignature(signature *string)

SetSignature adds the signature to the search search params

func (*SearchSearchParams) SetTimeout 

func (o *SearchSearchParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the search search params

func (*SearchSearchParams) SetToken 

func (o *SearchSearchParams) SetToken(token *string)

SetToken adds the token to the search search params

func (*SearchSearchParams) WithContext 

func (o *SearchSearchParams) WithContext(ctx context.Context) *SearchSearchParams

WithContext adds the context to the search search params

func (*SearchSearchParams) WithDevid 

func (o *SearchSearchParams) WithDevid(devid *string) *SearchSearchParams

WithDevid adds the devid to the search search params

func (*SearchSearchParams) WithHTTPClient 

func (o *SearchSearchParams) WithHTTPClient(client *http.Client) *SearchSearchParams

WithHTTPClient adds the HTTPClient to the search search params

func (*SearchSearchParams) WithIncludeAddresses 

func (o *SearchSearchParams) WithIncludeAddresses(includeAddresses *bool) *SearchSearchParams

WithIncludeAddresses adds the includeAddresses to the search search params

func (*SearchSearchParams) WithIncludeOutlets 

func (o *SearchSearchParams) WithIncludeOutlets(includeOutlets *bool) *SearchSearchParams

WithIncludeOutlets adds the includeOutlets to the search search params

func (*SearchSearchParams) WithLatitude 

func (o *SearchSearchParams) WithLatitude(latitude *float32) *SearchSearchParams

WithLatitude adds the latitude to the search search params

func (*SearchSearchParams) WithLongitude 

func (o *SearchSearchParams) WithLongitude(longitude *float32) *SearchSearchParams

WithLongitude adds the longitude to the search search params

func (*SearchSearchParams) WithMatchRouteBySuburb 

func (o *SearchSearchParams) WithMatchRouteBySuburb(matchRouteBySuburb *bool) *SearchSearchParams

WithMatchRouteBySuburb adds the matchRouteBySuburb to the search search params

func (*SearchSearchParams) WithMatchStopByGtfsStopID 

func (o *SearchSearchParams) WithMatchStopByGtfsStopID(matchStopByGtfsStopID *bool) *SearchSearchParams

WithMatchStopByGtfsStopID adds the matchStopByGtfsStopID to the search search params

func (*SearchSearchParams) WithMatchStopBySuburb 

func (o *SearchSearchParams) WithMatchStopBySuburb(matchStopBySuburb *bool) *SearchSearchParams

WithMatchStopBySuburb adds the matchStopBySuburb to the search search params

func (*SearchSearchParams) WithMaxDistance 

func (o *SearchSearchParams) WithMaxDistance(maxDistance *float32) *SearchSearchParams

WithMaxDistance adds the maxDistance to the search search params

func (*SearchSearchParams) WithRouteTypes 

func (o *SearchSearchParams) WithRouteTypes(routeTypes []int32) *SearchSearchParams

WithRouteTypes adds the routeTypes to the search search params

func (*SearchSearchParams) WithSearchTerm 

func (o *SearchSearchParams) WithSearchTerm(searchTerm string) *SearchSearchParams

WithSearchTerm adds the searchTerm to the search search params

func (*SearchSearchParams) WithSignature 

func (o *SearchSearchParams) WithSignature(signature *string) *SearchSearchParams

WithSignature adds the signature to the search search params

func (*SearchSearchParams) WithTimeout 

func (o *SearchSearchParams) WithTimeout(timeout time.Duration) *SearchSearchParams

WithTimeout adds the timeout to the search search params

func (*SearchSearchParams) WithToken 

func (o *SearchSearchParams) WithToken(token *string) *SearchSearchParams

WithToken adds the token to the search search params

func (*SearchSearchParams) WriteToRequest 

func (o *SearchSearchParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type SearchSearchReader 

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

SearchSearchReader is a Reader for the SearchSearch structure.

func (*SearchSearchReader) ReadResponse 

func (o *SearchSearchReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

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.