regions

package
v0.0.0-...-4ac4f36 Latest Latest
Warning

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

Go to latest
Published: May 8, 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 regions API

func (*Client) GetByRegionCode

func (a *Client) GetByRegionCode(params *GetByRegionCodeParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetByRegionCodeOK, error)

GetByRegionCode get by region code API

func (*Client) GetRegions

func (a *Client) GetRegions(params *GetRegionsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetRegionsOK, error)

GetRegions get regions API

func (*Client) SetTransport

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

SetTransport changes the transport on the client

type ClientOption

type ClientOption func(*runtime.ClientOperation)

ClientOption is the option for Client methods

type ClientService

type ClientService interface {
	GetByRegionCode(params *GetByRegionCodeParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetByRegionCodeOK, error)

	GetRegions(params *GetRegionsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetRegionsOK, 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 regions API client.

type GetByRegionCodeOK

type GetByRegionCodeOK struct {
	Payload *models.Region
}
GetByRegionCodeOK describes a response with status code 200, with default header values.

Success

func NewGetByRegionCodeOK

func NewGetByRegionCodeOK() *GetByRegionCodeOK

NewGetByRegionCodeOK creates a GetByRegionCodeOK with default headers values

func (*GetByRegionCodeOK) Error

func (o *GetByRegionCodeOK) Error() string

func (*GetByRegionCodeOK) GetPayload

func (o *GetByRegionCodeOK) GetPayload() *models.Region

type GetByRegionCodeParams

type GetByRegionCodeParams struct {

	// RegionCode.
	RegionCode *string

	// RegionList.
	RegionList *string

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

GetByRegionCodeParams contains all the parameters to send to the API endpoint

for the get by region code operation.

Typically these are written to a http.Request.

func NewGetByRegionCodeParams

func NewGetByRegionCodeParams() *GetByRegionCodeParams

NewGetByRegionCodeParams creates a new GetByRegionCodeParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewGetByRegionCodeParamsWithContext

func NewGetByRegionCodeParamsWithContext(ctx context.Context) *GetByRegionCodeParams

NewGetByRegionCodeParamsWithContext creates a new GetByRegionCodeParams object with the ability to set a context for a request.

func NewGetByRegionCodeParamsWithHTTPClient

func NewGetByRegionCodeParamsWithHTTPClient(client *http.Client) *GetByRegionCodeParams

NewGetByRegionCodeParamsWithHTTPClient creates a new GetByRegionCodeParams object with the ability to set a custom HTTPClient for a request.

func NewGetByRegionCodeParamsWithTimeout

func NewGetByRegionCodeParamsWithTimeout(timeout time.Duration) *GetByRegionCodeParams

NewGetByRegionCodeParamsWithTimeout creates a new GetByRegionCodeParams object with the ability to set a timeout on a request.

func (*GetByRegionCodeParams) SetContext

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

SetContext adds the context to the get by region code params

func (*GetByRegionCodeParams) SetDefaults

func (o *GetByRegionCodeParams) SetDefaults()

SetDefaults hydrates default values in the get by region code params (not the query body).

All values with no default are reset to their zero value.

func (*GetByRegionCodeParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the get by region code params

func (*GetByRegionCodeParams) SetRegionCode

func (o *GetByRegionCodeParams) SetRegionCode(regionCode *string)

SetRegionCode adds the regionCode to the get by region code params

func (*GetByRegionCodeParams) SetRegionList

func (o *GetByRegionCodeParams) SetRegionList(regionList *string)

SetRegionList adds the regionList to the get by region code params

func (*GetByRegionCodeParams) SetTimeout

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

SetTimeout adds the timeout to the get by region code params

func (*GetByRegionCodeParams) WithContext

WithContext adds the context to the get by region code params

func (*GetByRegionCodeParams) WithDefaults

func (o *GetByRegionCodeParams) WithDefaults() *GetByRegionCodeParams

WithDefaults hydrates default values in the get by region code params (not the query body).

All values with no default are reset to their zero value.

func (*GetByRegionCodeParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the get by region code params

func (*GetByRegionCodeParams) WithRegionCode

func (o *GetByRegionCodeParams) WithRegionCode(regionCode *string) *GetByRegionCodeParams

WithRegionCode adds the regionCode to the get by region code params

func (*GetByRegionCodeParams) WithRegionList

func (o *GetByRegionCodeParams) WithRegionList(regionList *string) *GetByRegionCodeParams

WithRegionList adds the regionList to the get by region code params

func (*GetByRegionCodeParams) WithTimeout

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

WithTimeout adds the timeout to the get by region code params

func (*GetByRegionCodeParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type GetByRegionCodeReader

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

GetByRegionCodeReader is a Reader for the GetByRegionCode structure.

func (*GetByRegionCodeReader) ReadResponse

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

ReadResponse reads a server response into the received o.

type GetRegionsOK

type GetRegionsOK struct {
	Payload *models.APICollectionOfRegion
}
GetRegionsOK describes a response with status code 200, with default header values.

Success

func NewGetRegionsOK

func NewGetRegionsOK() *GetRegionsOK

NewGetRegionsOK creates a GetRegionsOK with default headers values

func (*GetRegionsOK) Error

func (o *GetRegionsOK) Error() string

func (*GetRegionsOK) GetPayload

func (o *GetRegionsOK) GetPayload() *models.APICollectionOfRegion

type GetRegionsParams

type GetRegionsParams struct {

	// OrganizationID.
	//
	// Format: int32
	OrganizationID *int32

	// Page.
	//
	// Format: int32
	Page *int32

	// PageSize.
	//
	// Format: int32
	PageSize *int32

	// RegionList.
	RegionList *string

	// Search.
	Search *string

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

GetRegionsParams contains all the parameters to send to the API endpoint

for the get regions operation.

Typically these are written to a http.Request.

func NewGetRegionsParams

func NewGetRegionsParams() *GetRegionsParams

NewGetRegionsParams creates a new GetRegionsParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewGetRegionsParamsWithContext

func NewGetRegionsParamsWithContext(ctx context.Context) *GetRegionsParams

NewGetRegionsParamsWithContext creates a new GetRegionsParams object with the ability to set a context for a request.

func NewGetRegionsParamsWithHTTPClient

func NewGetRegionsParamsWithHTTPClient(client *http.Client) *GetRegionsParams

NewGetRegionsParamsWithHTTPClient creates a new GetRegionsParams object with the ability to set a custom HTTPClient for a request.

func NewGetRegionsParamsWithTimeout

func NewGetRegionsParamsWithTimeout(timeout time.Duration) *GetRegionsParams

NewGetRegionsParamsWithTimeout creates a new GetRegionsParams object with the ability to set a timeout on a request.

func (*GetRegionsParams) SetContext

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

SetContext adds the context to the get regions params

func (*GetRegionsParams) SetDefaults

func (o *GetRegionsParams) SetDefaults()

SetDefaults hydrates default values in the get regions params (not the query body).

All values with no default are reset to their zero value.

func (*GetRegionsParams) SetHTTPClient

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

SetHTTPClient adds the HTTPClient to the get regions params

func (*GetRegionsParams) SetOrganizationID

func (o *GetRegionsParams) SetOrganizationID(organizationID *int32)

SetOrganizationID adds the organizationId to the get regions params

func (*GetRegionsParams) SetPage

func (o *GetRegionsParams) SetPage(page *int32)

SetPage adds the page to the get regions params

func (*GetRegionsParams) SetPageSize

func (o *GetRegionsParams) SetPageSize(pageSize *int32)

SetPageSize adds the pageSize to the get regions params

func (*GetRegionsParams) SetRegionList

func (o *GetRegionsParams) SetRegionList(regionList *string)

SetRegionList adds the regionList to the get regions params

func (*GetRegionsParams) SetSearch

func (o *GetRegionsParams) SetSearch(search *string)

SetSearch adds the search to the get regions params

func (*GetRegionsParams) SetTimeout

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

SetTimeout adds the timeout to the get regions params

func (*GetRegionsParams) WithContext

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

WithContext adds the context to the get regions params

func (*GetRegionsParams) WithDefaults

func (o *GetRegionsParams) WithDefaults() *GetRegionsParams

WithDefaults hydrates default values in the get regions params (not the query body).

All values with no default are reset to their zero value.

func (*GetRegionsParams) WithHTTPClient

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

WithHTTPClient adds the HTTPClient to the get regions params

func (*GetRegionsParams) WithOrganizationID

func (o *GetRegionsParams) WithOrganizationID(organizationID *int32) *GetRegionsParams

WithOrganizationID adds the organizationID to the get regions params

func (*GetRegionsParams) WithPage

func (o *GetRegionsParams) WithPage(page *int32) *GetRegionsParams

WithPage adds the page to the get regions params

func (*GetRegionsParams) WithPageSize

func (o *GetRegionsParams) WithPageSize(pageSize *int32) *GetRegionsParams

WithPageSize adds the pageSize to the get regions params

func (*GetRegionsParams) WithRegionList

func (o *GetRegionsParams) WithRegionList(regionList *string) *GetRegionsParams

WithRegionList adds the regionList to the get regions params

func (*GetRegionsParams) WithSearch

func (o *GetRegionsParams) WithSearch(search *string) *GetRegionsParams

WithSearch adds the search to the get regions params

func (*GetRegionsParams) WithTimeout

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

WithTimeout adds the timeout to the get regions params

func (*GetRegionsParams) WriteToRequest

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

WriteToRequest writes these params to a swagger request

type GetRegionsReader

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

GetRegionsReader is a Reader for the GetRegions structure.

func (*GetRegionsReader) ReadResponse

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

ReadResponse reads a server response into the received o.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL