geo_region

package
v0.17.56 Latest Latest
Warning

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

 Go to latest Published: Feb 2, 2021 License: Apache-2.0 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 geo region API

func (*Client) DetailGeoRegion 

func (a *Client) DetailGeoRegion(params *DetailGeoRegionParams, authInfo runtime.ClientAuthInfoWriter) (*DetailGeoRegionOK, error)

DetailGeoRegion retrieves a geo region

Retrieves a single geo-region by id. Requires admin access.

func (*Client) ListGeoRegions 

func (a *Client) ListGeoRegions(params *ListGeoRegionsParams, authInfo runtime.ClientAuthInfoWriter) (*ListGeoRegionsOK, error)

ListGeoRegions lists available geo regions

Retrieves a list of geo-regions; supports filtering, sorting, and pagination. Requires admin access.

func (*Client) SetTransport 

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

SetTransport changes the transport on the client

type ClientService 

type ClientService interface {
	DetailGeoRegion(params *DetailGeoRegionParams, authInfo runtime.ClientAuthInfoWriter) (*DetailGeoRegionOK, error)

	ListGeoRegions(params *ListGeoRegionsParams, authInfo runtime.ClientAuthInfoWriter) (*ListGeoRegionsOK, error)

	SetTransport(transport runtime.ClientTransport)
}

ClientService is the interface for Client methods

func New 

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

New creates a new geo region API client.

type DetailGeoRegionNotFound 

type DetailGeoRegionNotFound struct {
	Payload *rest_model.APIErrorEnvelope
}

DetailGeoRegionNotFound handles this case with default header values.

The requested resource does not exist

func NewDetailGeoRegionNotFound 

func NewDetailGeoRegionNotFound() *DetailGeoRegionNotFound

NewDetailGeoRegionNotFound creates a DetailGeoRegionNotFound with default headers values

func (*DetailGeoRegionNotFound) Error 

func (o *DetailGeoRegionNotFound) Error() string

func (*DetailGeoRegionNotFound) GetPayload 

func (o *DetailGeoRegionNotFound) GetPayload() *rest_model.APIErrorEnvelope

type DetailGeoRegionOK 

type DetailGeoRegionOK struct {
	Payload *rest_model.DetailGeoRegionEnvelope
}

DetailGeoRegionOK handles this case with default header values.

A single geo-region

func NewDetailGeoRegionOK 

func NewDetailGeoRegionOK() *DetailGeoRegionOK

NewDetailGeoRegionOK creates a DetailGeoRegionOK with default headers values

func (*DetailGeoRegionOK) Error 

func (o *DetailGeoRegionOK) Error() string

func (*DetailGeoRegionOK) GetPayload 

func (o *DetailGeoRegionOK) GetPayload() *rest_model.DetailGeoRegionEnvelope

type DetailGeoRegionParams 

type DetailGeoRegionParams struct {

	/*ID
	  The id of the requested resource

	*/
	ID string

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

DetailGeoRegionParams contains all the parameters to send to the API endpoint for the detail geo region operation typically these are written to a http.Request

func NewDetailGeoRegionParams 

func NewDetailGeoRegionParams() *DetailGeoRegionParams

NewDetailGeoRegionParams creates a new DetailGeoRegionParams object with the default values initialized.

func NewDetailGeoRegionParamsWithContext 

func NewDetailGeoRegionParamsWithContext(ctx context.Context) *DetailGeoRegionParams

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

func NewDetailGeoRegionParamsWithHTTPClient 

func NewDetailGeoRegionParamsWithHTTPClient(client *http.Client) *DetailGeoRegionParams

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

func NewDetailGeoRegionParamsWithTimeout 

func NewDetailGeoRegionParamsWithTimeout(timeout time.Duration) *DetailGeoRegionParams

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

func (*DetailGeoRegionParams) SetContext 

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

SetContext adds the context to the detail geo region params

func (*DetailGeoRegionParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the detail geo region params

func (*DetailGeoRegionParams) SetID 

func (o *DetailGeoRegionParams) SetID(id string)

SetID adds the id to the detail geo region params

func (*DetailGeoRegionParams) SetTimeout 

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

SetTimeout adds the timeout to the detail geo region params

func (*DetailGeoRegionParams) WithContext 

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

WithContext adds the context to the detail geo region params

func (*DetailGeoRegionParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the detail geo region params

func (*DetailGeoRegionParams) WithID 

func (o *DetailGeoRegionParams) WithID(id string) *DetailGeoRegionParams

WithID adds the id to the detail geo region params

func (*DetailGeoRegionParams) WithTimeout 

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

WithTimeout adds the timeout to the detail geo region params

func (*DetailGeoRegionParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type DetailGeoRegionReader 

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

DetailGeoRegionReader is a Reader for the DetailGeoRegion structure.

func (*DetailGeoRegionReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type DetailGeoRegionUnauthorized 

type DetailGeoRegionUnauthorized struct {
	Payload *rest_model.APIErrorEnvelope
}

DetailGeoRegionUnauthorized handles this case with default header values.

The currently supplied session does not have the correct access rights to request this resource

func NewDetailGeoRegionUnauthorized 

func NewDetailGeoRegionUnauthorized() *DetailGeoRegionUnauthorized

NewDetailGeoRegionUnauthorized creates a DetailGeoRegionUnauthorized with default headers values

func (*DetailGeoRegionUnauthorized) Error 

func (o *DetailGeoRegionUnauthorized) Error() string

func (*DetailGeoRegionUnauthorized) GetPayload 

func (o *DetailGeoRegionUnauthorized) GetPayload() *rest_model.APIErrorEnvelope

type ListGeoRegionsOK 

type ListGeoRegionsOK struct {
	Payload *rest_model.ListGeoRegionsEnvelope
}

ListGeoRegionsOK handles this case with default header values.

A list of geo-regions

func NewListGeoRegionsOK 

func NewListGeoRegionsOK() *ListGeoRegionsOK

NewListGeoRegionsOK creates a ListGeoRegionsOK with default headers values

func (*ListGeoRegionsOK) Error 

func (o *ListGeoRegionsOK) Error() string

func (*ListGeoRegionsOK) GetPayload 

func (o *ListGeoRegionsOK) GetPayload() *rest_model.ListGeoRegionsEnvelope

type ListGeoRegionsParams 

type ListGeoRegionsParams struct {

	/*Filter*/
	Filter *string
	/*Limit*/
	Limit *int64
	/*Offset*/
	Offset *int64

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

ListGeoRegionsParams contains all the parameters to send to the API endpoint for the list geo regions operation typically these are written to a http.Request

func NewListGeoRegionsParams 

func NewListGeoRegionsParams() *ListGeoRegionsParams

NewListGeoRegionsParams creates a new ListGeoRegionsParams object with the default values initialized.

func NewListGeoRegionsParamsWithContext 

func NewListGeoRegionsParamsWithContext(ctx context.Context) *ListGeoRegionsParams

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

func NewListGeoRegionsParamsWithHTTPClient 

func NewListGeoRegionsParamsWithHTTPClient(client *http.Client) *ListGeoRegionsParams

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

func NewListGeoRegionsParamsWithTimeout 

func NewListGeoRegionsParamsWithTimeout(timeout time.Duration) *ListGeoRegionsParams

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

func (*ListGeoRegionsParams) SetContext 

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

SetContext adds the context to the list geo regions params

func (*ListGeoRegionsParams) SetFilter 

func (o *ListGeoRegionsParams) SetFilter(filter *string)

SetFilter adds the filter to the list geo regions params

func (*ListGeoRegionsParams) SetHTTPClient 

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

SetHTTPClient adds the HTTPClient to the list geo regions params

func (*ListGeoRegionsParams) SetLimit 

func (o *ListGeoRegionsParams) SetLimit(limit *int64)

SetLimit adds the limit to the list geo regions params

func (*ListGeoRegionsParams) SetOffset 

func (o *ListGeoRegionsParams) SetOffset(offset *int64)

SetOffset adds the offset to the list geo regions params

func (*ListGeoRegionsParams) SetTimeout 

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

SetTimeout adds the timeout to the list geo regions params

func (*ListGeoRegionsParams) WithContext 

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

WithContext adds the context to the list geo regions params

func (*ListGeoRegionsParams) WithFilter 

func (o *ListGeoRegionsParams) WithFilter(filter *string) *ListGeoRegionsParams

WithFilter adds the filter to the list geo regions params

func (*ListGeoRegionsParams) WithHTTPClient 

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

WithHTTPClient adds the HTTPClient to the list geo regions params

func (*ListGeoRegionsParams) WithLimit 

func (o *ListGeoRegionsParams) WithLimit(limit *int64) *ListGeoRegionsParams

WithLimit adds the limit to the list geo regions params

func (*ListGeoRegionsParams) WithOffset 

func (o *ListGeoRegionsParams) WithOffset(offset *int64) *ListGeoRegionsParams

WithOffset adds the offset to the list geo regions params

func (*ListGeoRegionsParams) WithTimeout 

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

WithTimeout adds the timeout to the list geo regions params

func (*ListGeoRegionsParams) WriteToRequest 

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

WriteToRequest writes these params to a swagger request

type ListGeoRegionsReader 

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

ListGeoRegionsReader is a Reader for the ListGeoRegions structure.

func (*ListGeoRegionsReader) ReadResponse 

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

ReadResponse reads a server response into the received o.

type ListGeoRegionsUnauthorized 

type ListGeoRegionsUnauthorized struct {
	Payload *rest_model.APIErrorEnvelope
}

ListGeoRegionsUnauthorized handles this case with default header values.

The currently supplied session does not have the correct access rights to request this resource

func NewListGeoRegionsUnauthorized 

func NewListGeoRegionsUnauthorized() *ListGeoRegionsUnauthorized

NewListGeoRegionsUnauthorized creates a ListGeoRegionsUnauthorized with default headers values

func (*ListGeoRegionsUnauthorized) Error 

func (o *ListGeoRegionsUnauthorized) Error() string

func (*ListGeoRegionsUnauthorized) GetPayload 

func (o *ListGeoRegionsUnauthorized) GetPayload() *rest_model.APIErrorEnvelope

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.