flexibleip

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

type AttachFlexibleIPRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`
	// FipsIDs: a list of Flexible IP IDs to attach.
	// Multiple IDs can be provided as long as Flexible IPs belong to the same MAC groups (see details about MAC groups).
	FipsIDs []string `json:"fips_ids"`
	// ServerID: a server ID on which to attach the Flexible IPs.
	ServerID string `json:"server_id"`
}

type AttachFlexibleIPsResponse struct {
	// TotalCount: total count of Flexible IPs being updated.
	TotalCount uint32 `json:"total_count"`
	// FlexibleIPs: listing of Flexible IPs in updating state.
	FlexibleIPs []*FlexibleIP `json:"flexible_ips"`
}

type CreateFlexibleIPRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`
	// ProjectID: ID of the project to associate with the Flexible IP.
	ProjectID string `json:"project_id"`
	// Description: description to associate with the Flexible IP, max 255 characters.
	Description string `json:"description"`
	// Tags: tags to associate to the Flexible IP.
	Tags []string `json:"tags"`
	// ServerID: server ID on which to attach the created Flexible IP.
	ServerID *string `json:"server_id"`
	// Reverse: reverse DNS value.
	Reverse *string `json:"reverse"`
	// IsIPv6: if true, creates a Flexible IP with an ipv6 address.
	IsIPv6 bool `json:"is_ipv6"`
}

type DeleteFlexibleIPRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`
	// FipID: ID of the Flexible IP to delete.
	FipID string `json:"-"`
}

type DeleteMACAddrRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`
	// FipID: flexible IP ID from which to delete the Virtual MAC.
	// If the Flexible IP belongs to a MAC group, the MAC will be removed from the MAC group and from the Flexible IP.
	FipID string `json:"-"`
}

type DetachFlexibleIPRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`
	// FipsIDs: a list of Flexible IP IDs to detach.
	// Multiple IDs can be provided as long as Flexible IPs belong to the same MAC groups (see details about MAC groups).
	FipsIDs []string `json:"fips_ids"`
}

type DetachFlexibleIPsResponse struct {
	// TotalCount: total count of Flexible IPs being detached.
	TotalCount uint32 `json:"total_count"`
	// FlexibleIPs: listing of Flexible IPs in detaching state.
	FlexibleIPs []*FlexibleIP `json:"flexible_ips"`
}

type DuplicateMACAddrRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`
	// FipID: flexible IP ID on which to duplicate the Virtual MAC.
	// Flexible IPs need to be attached to the same server.
	FipID string `json:"-"`
	// DuplicateFromFipID: flexible IP ID to duplicate the Virtual MAC from.
	// Flexible IPs need to be attached to the same server.
	DuplicateFromFipID string `json:"duplicate_from_fip_id"`
}

type FlexibleIP struct {
	// ID: ID of the Flexible IP.
	ID string `json:"id"`
	// OrganizationID: organization ID the Flexible IP is attached to.
	OrganizationID string `json:"organization_id"`
	// ProjectID: project ID the Flexible IP is attached to.
	ProjectID string `json:"project_id"`
	// Description: description of the Flexible IP.
	Description string `json:"description"`
	// Tags: tags associated with the Flexible IP.
	Tags []string `json:"tags"`
	// UpdatedAt: date of last update of the Flexible IP.
	UpdatedAt *time.Time `json:"updated_at"`
	// CreatedAt: date of creation of the Flexible IP.
	CreatedAt *time.Time `json:"created_at"`
	// Status: status of the Flexible IP.
	// - ready : Flexible IP is created and ready to be attached to a server or to have a virtual MAC generated.
	// - updating: Flexible IP is being attached to a server or a virtual MAC operation is ongoing
	// - attached: Flexible IP is attached to a server
	// - error: a Flexible IP operation resulted in an error
	// - detaching: Flexible IP is being detached from a server
	// - locked: Flexible IP resource is locked.
	// Default value: unknown
	Status FlexibleIPStatus `json:"status"`
	// IPAddress: IP of the Flexible IP.
	IPAddress scw.IPNet `json:"ip_address"`
	// MacAddress: mAC address of the Flexible IP.
	MacAddress *MACAddress `json:"mac_address"`
	// ServerID: ID of the server linked to the Flexible IP.
	ServerID *string `json:"server_id"`
	// Reverse: reverse DNS value.
	Reverse string `json:"reverse"`
	// Zone: flexible IP Availability Zone.
	Zone scw.Zone `json:"zone"`
}

type FlexibleIPStatus string

type GenerateMACAddrRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`
	// FipID: flexible IP ID on which to generate a Virtual MAC.
	FipID string `json:"-"`
	// MacType: tODO.
	// Default value: unknown_type
	MacType MACAddressType `json:"mac_type"`
}

type GetFlexibleIPRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`
	// FipID: flexible IP ID.
	FipID string `json:"-"`
}

type ListFlexibleIPsRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`
	// OrderBy: the sort order of the returned Flexible IPs.
	// Default value: created_at_asc
	OrderBy ListFlexibleIPsRequestOrderBy `json:"-"`
	// Page: the page number for the returned Flexible IPs.
	Page *int32 `json:"-"`
	// PageSize: the maximum number of Flexible IPs per page.
	PageSize *uint32 `json:"-"`
	// Tags: filter Flexible IPs with one or more matching tags.
	Tags []string `json:"-"`
	// Status: filter Flexible IPs by status.
	Status []FlexibleIPStatus `json:"-"`
	// ServerIDs: filter Flexible IPs by server IDs.
	ServerIDs []string `json:"-"`
	// OrganizationID: filter Flexible IPs by organization ID.
	OrganizationID *string `json:"-"`
	// ProjectID: filter Flexible IPs by project ID.
	ProjectID *string `json:"-"`
}

type ListFlexibleIPsRequestOrderBy string

type ListFlexibleIPsResponse struct {
	// TotalCount: total count of matching Flexible IPs.
	TotalCount uint32 `json:"total_count"`
	// FlexibleIPs: listing of Flexible IPs.
	FlexibleIPs []*FlexibleIP `json:"flexible_ips"`
}

type MACAddress struct {
	// ID: ID of the Flexible IP.
	ID string `json:"id"`
	// MacAddress: mAC address of the Virtual MAC.
	MacAddress string `json:"mac_address"`
	// MacType: virtual MAC type.
	// Default value: unknown_type
	MacType MACAddressType `json:"mac_type"`
	// Status: virtual MAC status.
	// Default value: unknown
	Status MACAddressStatus `json:"status"`
	// UpdatedAt: date of last update of the Virtual MAC.
	UpdatedAt *time.Time `json:"updated_at"`
	// CreatedAt: date of creation of the Virtual MAC.
	CreatedAt *time.Time `json:"created_at"`
	// Zone: mAC Addr IP Availability Zone.
	Zone scw.Zone `json:"zone"`
}

type MACAddressStatus string

type MACAddressType string

type MoveMACAddrRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`

	FipID string `json:"-"`

	DstFipID string `json:"dst_fip_id"`
}

type UpdateFlexibleIPRequest struct {
	// Zone: zone to target. If none is passed will use default zone from the config.
	Zone scw.Zone `json:"-"`
	// FipID: ID of the Flexible IP to update.
	FipID string `json:"-"`
	// Description: description to associate with the Flexible IP, max 255 characters.
	Description *string `json:"description"`
	// Tags: tags to associate with the Flexible IP.
	Tags *[]string `json:"tags"`
	// Reverse: reverse DNS value.
	Reverse *string `json:"reverse"`
}

type WaitForFlexibleIPRequest struct {
	FipID         string
	Zone          scw.Zone
	Timeout       *time.Duration
	RetryInterval *time.Duration
}