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: multiple IDs can be provided, but note that flexible IPs must belong to the same MAC group (see details about MAC groups).
	FipsIDs []string `json:"fips_ids"`

	// ServerID: ID of the server on which to attach the flexible IPs.
	ServerID string `json:"server_id"`
}

type AttachFlexibleIPsResponse struct {
	// TotalCount: total count of flexible IPs that are being updated.
	TotalCount uint32 `json:"total_count"`

	// FlexibleIPs: list of flexible IPs in an 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: flexible IP description (max. of 255 characters).
	Description string `json:"description"`

	// Tags: tags to associate to the flexible IP.
	Tags []string `json:"tags"`

	// ServerID: ID of the server to which the newly created flexible IP will be attached.
	ServerID *string `json:"server_id,omitempty"`

	// Reverse: value of the reverse DNS.
	Reverse *string `json:"reverse,omitempty"`

	// IsIPv6: defines whether the flexible IP has 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: if the flexible IP belongs to a MAC group, the MAC will be removed from both the MAC group and 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: list of flexible IP IDs to detach from a server. Multiple IDs can be provided. Note that flexible IPs must belong to the same MAC group.
	FipsIDs []string `json:"fips_ids"`
}

type DetachFlexibleIPsResponse struct {
	// TotalCount: total count of flexible IPs that are being detached.
	TotalCount uint32 `json:"total_count"`

	// FlexibleIPs: list of flexible IPs in a 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: note that the flexible IPs need to be attached to the same server.
	FipID string `json:"-"`

	// DuplicateFromFipID: note that 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: ID of the Organization the flexible IP is attached to.
	OrganizationID string `json:"organization_id"`

	// ProjectID: ID of the Project the flexible IP is attached to.
	ProjectID string `json:"project_id"`

	// Description: flexible IP description.
	Description string `json:"description"`

	// Tags: flexible IP tags.
	Tags []string `json:"tags"`

	// UpdatedAt: date on which the flexible IP was last updated.
	UpdatedAt *time.Time `json:"updated_at"`

	// CreatedAt: date on which the flexible IP was created.
	CreatedAt *time.Time `json:"created_at"`

	// Status: - ready : flexible IP is created and ready to be attached to a server or to be associated with a virtual MAC.
	// - 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: the resource of the flexible IP 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: availability Zone of the flexible IP.
	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: ID of the flexible IP for 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: ID of the flexible IP.
	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: sort order of the returned flexible IPs.
	// Default value: created_at_asc
	OrderBy ListFlexibleIPsRequestOrderBy `json:"-"`

	// Page: page number.
	Page *int32 `json:"-"`

	// PageSize: maximum number of flexible IPs per page.
	PageSize *uint32 `json:"-"`

	// Tags: filter by tag, only flexible IPs with one or more matching tags will be returned.
	Tags []string `json:"-"`

	// Status: filter by status, only flexible IPs with this status will be returned.
	Status []FlexibleIPStatus `json:"-"`

	// ServerIDs: filter by server IDs, only flexible IPs with these server IDs will be returned.
	ServerIDs []string `json:"-"`

	// OrganizationID: filter by Organization ID, only flexible IPs from this Organization will be returned.
	OrganizationID *string `json:"-"`

	// ProjectID: filter by Project ID, only flexible IPs from this Project will be returned.
	ProjectID *string `json:"-"`
}

type ListFlexibleIPsRequestOrderBy string

type ListFlexibleIPsResponse struct {
	// TotalCount: total count of matching flexible IPs.
	TotalCount uint32 `json:"total_count"`

	// FlexibleIPs: list of all 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: type of virtual MAC.
	// Default value: unknown_type
	MacType MACAddressType `json:"mac_type"`

	// Status: status of virtual MAC.
	// Default value: unknown
	Status MACAddressStatus `json:"status"`

	// UpdatedAt: date on which the virtual MAC was last updated.
	UpdatedAt *time.Time `json:"updated_at"`

	// CreatedAt: date on which the virtual MAC was created.
	CreatedAt *time.Time `json:"created_at"`

	// Zone: mAC address 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: flexible IP description (max. 255 characters).
	Description *string `json:"description,omitempty"`

	// Tags: tags associated with the flexible IP.
	Tags *[]string `json:"tags,omitempty"`

	// Reverse: value of the reverse DNS.
	Reverse *string `json:"reverse,omitempty"`
}

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