filteredgroupapi

package
v1.2.30 Latest Latest
Warning

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

Go to latest
Published: Feb 19, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Create

func Create(params CreateParams) (*models.ProxiesFilteredGroup, error)

Create creates proxies filtered group with passed parameters

func Delete

func Delete(params DeleteParams) error

Delete deletes proxies filtered group by group id

func Get

Get returns information about a specific proxies filtered group

func List

List gets the list of proxies filter groups for a region

func Update

func Update(params UpdateParams) (*models.ProxiesFilteredGroup, error)

Update updates information for already existing proxies filtered group

Types

type CreateParams

type CreateParams struct {
	*api.API

	ID                   string
	Region               string
	Filters              map[string]string
	ExpectedProxiesCount int32
}

CreateParams is the set of parameters required for creating or updating proxies filtered group

func (CreateParams) Validate

func (params CreateParams) Validate() error

Validate parameters for Create function

type DeleteParams

type DeleteParams struct {
	*api.API

	ID     string
	Region string
}

DeleteParams is the set of parameters required for retrieving a proxies filtered group information

func (DeleteParams) Validate

func (params DeleteParams) Validate() error

Validate parameters for get and delete functions

type GetParams

type GetParams struct {
	*api.API

	ID     string
	Region string
}

GetParams is the set of parameters required for retrieving a proxies filtered group information

func (GetParams) Validate

func (params GetParams) Validate() error

Validate parameters for get and delete functions

type ListParams

type ListParams struct {
	*api.API
	Region string
}

ListParams is the set of parameters required for retrieving a proxies filtered group information

func (ListParams) Validate

func (params ListParams) Validate() error

Validate parameters for get and delete functions

type UpdateParams

type UpdateParams struct {
	*api.API

	ID                   string
	Region               string
	Filters              map[string]string
	ExpectedProxiesCount int32
	Version              string
}

UpdateParams is the set of parameters required for updating proxies filtered group

func (UpdateParams) Validate

func (params UpdateParams) Validate() error

Validate parameters for Update function

Jump to

Keyboard shortcuts

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