whitelists

Documentation

Index

• type CreateOpts
  • func (opts CreateOpts) ToWhitelistCreateMap() (map[string]interface{}, error)
• type CreateOptsBuilder
• type CreateResult
  • func Create(c *golangsdk.ServiceClient, opts CreateOptsBuilder) (r CreateResult)
  • func (r CreateResult) Extract() (*Whitelist, error)
  • func (r CreateResult) ExtractInto(v interface{}) error
• type DeleteResult
  • func Delete(c *golangsdk.ServiceClient, id string) (r DeleteResult)
• type GetResult
  • func Get(c *golangsdk.ServiceClient, id string) (r GetResult)
  • func (r GetResult) Extract() (*Whitelist, error)
  • func (r GetResult) ExtractInto(v interface{}) error
• type UpdateOpts
  • func (opts UpdateOpts) ToWhitelistUpdateMap() (map[string]interface{}, error)
• type UpdateOptsBuilder
• type UpdateResult
  • func Update(c *golangsdk.ServiceClient, id string, opts UpdateOpts) (r UpdateResult)
  • func (r UpdateResult) Extract() (*Whitelist, error)
  • func (r UpdateResult) ExtractInto(v interface{}) error
• type Whitelist

Types

type CreateOpts

type CreateOpts struct {
	TenantId        string `json:"tenant_id,omitempty"`
	ListenerId      string `json:"listener_id" required:"true"`
	EnableWhitelist *bool  `json:"enable_whitelist,omitempty"`
	Whitelist       string `json:"whitelist,omitempty"`
}

CreateOpts is the common options struct used in this package's Create operation.

func (CreateOpts) ToWhitelistCreateMap

func (opts CreateOpts) ToWhitelistCreateMap() (map[string]interface{}, error)

ToWhitelistCreateMap casts a CreateOpts struct to a map.

type CreateOptsBuilder

type CreateOptsBuilder interface {
	ToWhitelistCreateMap() (map[string]interface{}, error)
}

CreateOptsBuilder is the interface options structs have to satisfy in order to be used in the main Create operation in this package. Since many extensions decorate or modify the common logic, it is useful for them to satisfy a basic interface in order for them to be used.

type CreateResult

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

func Create

func Create(c *golangsdk.ServiceClient, opts CreateOptsBuilder) (r CreateResult)

Create is an operation which provisions a new whitelist based on the configuration defined in the CreateOpts struct. Once the request is validated and progress has started on the provisioning process, a CreateResult will be returned.

Users with an admin role can create loadbalancers on behalf of other tenants by specifying a TenantID attribute different than their own.

func (CreateResult) Extract

func (r CreateResult) Extract() (*Whitelist, error)

func (CreateResult) ExtractInto

func (r CreateResult) ExtractInto(v interface{}) error

type DeleteResult

type DeleteResult struct {
	golangsdk.ErrResult
}

DeleteResult represents the result of a delete operation.

func Delete

func Delete(c *golangsdk.ServiceClient, id string) (r DeleteResult)

Delete will permanently delete a particular Whitelist based on its unique ID.

type GetResult

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

GetResult represents the result of a get operation.

func Get

func Get(c *golangsdk.ServiceClient, id string) (r GetResult)

Get retrieves a particular Whitelist based on its unique ID.

func (GetResult) Extract

func (r GetResult) Extract() (*Whitelist, error)

func (GetResult) ExtractInto

func (r GetResult) ExtractInto(v interface{}) error

type UpdateOpts

type UpdateOpts struct {
	EnableWhitelist *bool  `json:"enable_whitelist,omitempty"`
	Whitelist       string `json:"whitelist,omitempty"`
}

UpdateOpts is the common options struct used in this package's Update operation.

func (UpdateOpts) ToWhitelistUpdateMap

func (opts UpdateOpts) ToWhitelistUpdateMap() (map[string]interface{}, error)

ToWhitelistUpdateMap casts a UpdateOpts struct to a map.

type UpdateOptsBuilder

type UpdateOptsBuilder interface {
	ToWhitelistUpdateMap() (map[string]interface{}, error)
}

UpdateOptsBuilder is the interface options structs have to satisfy in order to be used in the main Update operation in this package. Since many extensions decorate or modify the common logic, it is useful for them to satisfy a basic interface in order for them to be used.

type UpdateResult

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

func Update

func Update(c *golangsdk.ServiceClient, id string, opts UpdateOpts) (r UpdateResult)

Update is an operation which modifies the attributes of the specified Whitelist.

func (UpdateResult) Extract

func (r UpdateResult) Extract() (*Whitelist, error)

func (UpdateResult) ExtractInto

func (r UpdateResult) ExtractInto(v interface{}) error

type Whitelist

type Whitelist struct {
	ID              string `json:"id"`
	TenantId        string `json:"tenant_id"`
	ListenerId      string `json:"listener_id"`
	EnableWhitelist bool   `json:"enable_whitelist"`
	Whitelist       string `json:"whitelist"`
}