github.com/chnsz/golangsdk@v0.0.0-20240506093406-85a3fbfa605b/openstack/apigw/dedicated/v2/instances/results.go

package instances

import (
	"encoding/json"

	"github.com/chnsz/golangsdk"
	"github.com/chnsz/golangsdk/pagination"
)

type commonResult struct {
	golangsdk.Result
}

// GetResult represents the result of a create operation.
type CreateResult struct {
	commonResult
}

type CreateResp struct {
	Id      string `json:"instance_id"`
	Message string `json:"message"`
}

// Call its Extract method to interpret it as a Instance Id.
func (r CreateResult) Extract() (*CreateResp, error) {
	var s CreateResp
	err := r.ExtractInto(&s)
	return &s, err
}

// GetResult represents the result of a Get operation.
type GetResult struct {
	commonResult
}

// UpdateResult represents the result of a Update operation.
type UpdateResult struct {
	commonResult
}

type Instance struct {
	// Instance ID.
	Id string `json:"id"`
	// Project ID.
	ProjectId string `json:"project_id"`
	// Instance name.
	Name string `json:"instance_name"`
	// Instance status. The value are as following:
	//   Creating, CreateSuccess, CreateFail, Initing, Registering, Running, InitingFailed, RegisterFailed, Installing
	//   InstallFailed, Updating, UpdateFailed, Rollbacking, RollbackSuccess, RollbackFailed, Deleting, DeleteFailed
	//   Unregistering, UnRegisterFailed, CreateTimeout, InitTimeout, RegisterTimeout, InstallTimeout, UpdateTimeout
	//   RollbackTimeout, DeleteTimeout, UnregisterTimeout, Starting, Freezing, Frozen, Restarting, RestartFail
	//   Unhealthy, RestartTimeout
	// The status 'Deleting' is not supported, it's a BUG. --2021/06/15
	Status string `json:"status"`
	// Instance status ID.
	//   1:Creating, 2:CreateSuccess, 3:CreateFail, 4:Initing, 5:Registering, 6:Running, 7:InitingFailed
	//   8:RegisterFailed, 10:Installing, 11:InstallFailed, 12:Updating, 13:UpdateFailed, 20:Rollbacking
	//   21:RollbackSuccess, 22:RollbackFailed, 23:Deleting, 24:DeleteFailed, 25:Unregistering, 26:UnRegisterFailed
	//   27:CreateTimeout, 28:InitTimeout, 29:RegisterTimeout, 30:InstallTimeout, 31:UpdateTimeout
	//   32:RollbackTimeout, 33:DeleteTimeout, 34:UnregisterTimeout, 35:Starting, 36:Freezing, 37:Frozen, 38:Restarting
	//   39:RestartFail, 40:Unhealthy, 41:RestartTimeout
	// Ditto: Issue of status id 23 (Deleting). --2021/06/15
	StatusId int `json:"instance_status"`
	// Instance type.
	Type string `json:"type"`
	// Instance edition.
	Edition string `json:"spec"`
	// Time when the APIG dedicated instance is created, in Unix timestamp format.
	CreateTimestamp int64 `json:"create_time"`
	// Enterprise project ID.
	EnterpriseProjectId string `json:"enterprise_project_id"`
	// Billing mode of the APIG dedicated instance.
	//   0:Pay per use
	//   1:Pay per use
	ChargeMode int `json:"charging_mode"`
	// Yearly/Monthly subscription order ID.
	CbcMetadata string `json:"cbc_metadata"`
	// The type of load balancer used by the instance.
	// The valid values are as follows:
	// + lvs: Linux virtual server
	// + elb: Elastic load balance
	LoadbalancerProvider string `json:"loadbalancer_provider"`
	// The operation locks of the CBC serivce.
	CbcOperationLocks []CbcOperationLock `json:"cbc_operation_locks"`
	// Description about the APIG dedicated instance.
	Description string `json:"description"`
	// VPC ID.
	VpcId string `json:"vpc_id"`
	// Subnet network ID.
	SubnetId string `json:"subnet_id"`
	// ID of the security group to which the APIG dedicated instance belongs to.
	SecurityGroupId string `json:"security_group_id"`
	// Start time of the maintenance time window in the format "xx:00:00".
	MaintainBegin string `json:"maintain_begin"`
	// End time of the maintenance time window in the format "xx:00:00".
	MaintainEnd string `json:"maintain_end"`
	// VPC ingress private address.
	Ipv4VpcIngressAddress string `json:"ingress_ip"`
	// VPC ingress private address (IPv6).
	Ipv6VpcIngressAddress string `json:"ingress_ip_v6"`
	// ID of the account to which the APIG dedicated instance belongs.
	UserId string `json:"user_id"`
	// EIP bound to the APIG dedicated instance.
	Ipv4IngressEipAddress string `json:"eip_address"`
	// EIP (IPv6).
	Ipv6IngressEipAddress string `json:"eip_ipv6_address"`
	// Public egress address (IPv6).
	Ipv6EgressCidr string `json:"nat_eip_ipv6_cidr"`
	// IP address for public outbound access.
	Ipv4EgressAddress string `json:"nat_eip_address"`
	// Outbound access bandwidth.
	BandwidthSize int `json:"bandwidth_size"`
	// Billing type of the public inbound access bandwidth.
	BandwidthChargingMode string `json:"bandwidth_charging_mode"`
	// AZs.
	AvailableZoneIds string `json:"available_zone_ids"`
	// Instance version.
	Version string `json:"instance_version"`
	// Supported features.
	SupportedFeatures []string `json:"supported_features"`
	// THe list of endpoint service.
	EndpointServices []EndpointService `json:"endpoint_services"`
	// The IP of the serivce node.
	NodeIp NodeIp `json:"node_ips"`
	// The ingress address list of public network.
	PublicIps []IpDetail `json:"publicips"`
	// The ingress address list of private network.
	PrivateIps []IpDetail `json:"privateips"`
	// Whether the gateway can be released.
	// + true: The gateway can be released.
	// + false: The gateway cannot be released.
	IsReleasable bool `json:"is_releasable"`
	// Billing mode of the public inbound access bandwidth.
	IngressBandwidthChargingMode string `json:"ingress_bandwidth_charging_mode"`
}

// CbcOperationLock is the structure that represents the restricted operation lock for CBC service.
type CbcOperationLock struct {
	// Restricted operation scenarios:
	// + TO_PERIOD_LOCK: On-demand subcontracting period scene lock, which does not allow deletion, specification
	//                   changes, on-demand subcontracting periods, etc.
	// + SPEC_CHG_LOCK: Package cycle specification change scene lock, which does not allow deletion, specification
	//                  change, etc.
	LockScene string `json:"lock_scene"`
	// The ID of the object that initiated the restriction operation.
	LockSourceId string `json:"lock_source_id"`
}

type EndpointService struct {
	// The service name of the endpoint node.
	ServiceName string `json:"service_name"`
	// The create time of the endpoint node.
	CreatedAt string `json:"created_at"`
}

type NodeIp struct {
	// The IP address list of the livedata node.
	LiveData []string `json:"livedata"`
	// The IP address list of the shubao node.
	Shubao []string `json:"shubao"`
}

type IpDetail struct {
	// IP address.
	IpAddress string `json:"ip_address"`
	// Bandwidth size.
	BandwidthSize int `json:"bandwidth_size"`
}

// Call its Extract method to interpret it as a Instance.
func (r commonResult) Extract() (*Instance, error) {
	var s Instance
	err := r.ExtractInto(&s)
	return &s, err
}

type BaseInstance struct {
	// Instance ID.
	Id string `json:"id"`
	// Project ID
	ProjectId string `json:"project_id"`
	// Instance name.
	Name string `json:"instance_name"`
	// Instance status. The value are as following:
	//   Creating, CreateSuccess, CreateFail, Initing, Registering, Running, InitingFailed, RegisterFailed, Installing
	//   InstallFailed, Updating, UpdateFailed, Rollbacking, RollbackSuccess, RollbackFailed, Deleting, DeleteFailed
	//   Unregistering, UnRegisterFailed, CreateTimeout, InitTimeout, RegisterTimeout, InstallTimeout, UpdateTimeout
	//   RollbackTimeout, DeleteTimeout, UnregisterTimeout, Starting, Freezing, Frozen, Restarting, RestartFail
	//   Unhealthy, RestartTimeout
	// Ditto: Issue of status 'Deleting'. --2021/06/15
	Status string `json:"status"`
	// Instance status ID.
	//   1:Creating, 2:CreateSuccess, 3:CreateFail, 4:Initing, 5:Registering, 6:Running, 7:InitingFailed
	//   8:RegisterFailed, 10:Installing, 11:InstallFailed, 12:Updating, 13:UpdateFailed, 20:Rollbacking
	//   21:RollbackSuccess, 22:RollbackFailed, 23:Deleting, 24:DeleteFailed, 25:Unregistering, 26:UnRegisterFailed
	//   27:CreateTimeout, 28:InitTimeout, 29:RegisterTimeout, 30:InstallTimeout, 31:UpdateTimeout
	//   32:RollbackTimeout, 33:DeleteTimeout, 34:UnregisterTimeout, 35:Starting, 36:Freezing, 37:Frozen, 38:Restarting
	//   39:RestartFail, 40:Unhealthy, 41:RestartTimeout
	// Ditto: Issue of status id 23 (Deleting). --2021/06/15
	StatusId int `json:"instance_status"`
	// Instance type.
	Type string `json:"type"`
	// Instance edition.
	Edition string `json:"spec"`
	// Time when the APIG dedicated instance is created, in Unix timestamp format.
	CreateTimestamp int64 `json:"create_time"`
	// Enterprise project ID.
	EnterpriseProjectId string `json:"enterprise_project_id"`
	// EIP bound to the APIG dedicated instance.
	Ipv4Address string `json:"eip_address"`
	// Billing mode of the APIG dedicated instance.
	//   0:Pay per use
	//   1:Pay per use
	ChargeMode int `json:"charging_mode"`
	// Yearly/Monthly subscription order ID.
	CbcMetadata string `json:"cbc_metadata"`
}

// InstancePage represents the result of a List operation.
type InstancePage struct {
	pagination.SinglePageBase
}

// Call its Extract method to interpret it as a BaseInstance array.
func ExtractInstances(r pagination.Page) ([]BaseInstance, error) {
	var s []BaseInstance
	err := r.(InstancePage).Result.ExtractIntoSlicePtr(&s, "instances")
	return s, err
}

// DeleteResult represents the result of a Delete operation.
type DeleteResult struct {
	golangsdk.ErrResult
}

// EnableEgressResult represents the result of a EnableEgressAccess operation.
type EnableEgressResult struct {
	golangsdk.Result
}

// UdpateEgressResult represents the result of a UpdateEgressBandwidth operation.
type UdpateEgressResult struct {
	golangsdk.Result
}

type EgressResult struct {
	golangsdk.Result
}

type Egress struct {
	Id               string `json:"id"`
	CloudEipId       string `json:"cloudEipId"`
	CloudEipAddress  string `json:"cloudEipAddress"`
	InstanceId       string `json:"instanceId"`
	CloudBandwidthId string `json:"cloudBandwidthId"`
	BandwidthName    string `json:"bandwidthName"`
	BandwidthSize    int    `json:"bandwidthSize"`
}

// Extract is a method to interpret the response body or json string as an Egress.
func (r UdpateEgressResult) Extract() (*Egress, error) {
	var s Egress
	if r.Err != nil {
		return &s, r.Err
	}
	body, ok := r.Body.(string)
	if ok {
		err := json.Unmarshal([]byte(body), &s)
		return &s, err
	}
	err := r.ExtractInto(&s)
	return &s, err
}

// Extract is a method to interpret the response body as an Egress.
func (r EnableEgressResult) Extract() (*Egress, error) {
	var s Egress
	err := r.ExtractInto(&s)
	return &s, err
}

// DisableEgressResult represents the result of a DisableEgressAccess operation.
type DisableEgressResult struct {
	golangsdk.ErrResult
}

// EnableIngressResult represents the result of a EnableIngressAccess operation.
type EnableIngressResult struct {
	commonResult
}

type Ingress struct {
	Id          string `json:"eip_id"`
	EipAddress  string `json:"eip_address"`
	Status      string `json:"eip_status"`
	Ipv6Address string `json:"eip_ipv6_address"`
}

// Call its Extract method to interpret it as a Ingress.
func (r EnableIngressResult) Extract() (*Ingress, error) {
	var s Ingress
	err := r.ExtractInto(&s)
	return &s, err
}

// DisableIngressResult represents the result of a DisableIngressAccess operation.
type DisableIngressResult struct {
	golangsdk.ErrResult
}

// Feature represents the result of a feature configuration.
type Feature struct {
	// Feature ID.
	ID string `json:"id"`
	// Feature name.
	Name string `json:"name"`
	// Whether to enable the feature.
	Enable bool `json:"enable"`
	// Parameter configuration.
	Config string `json:"config"`
	// Dedicated APIG instance ID.
	InstanceId string `json:"instance_id"`
	// Feature update time.
	UpdatedAt string `json:"update_time"`
}

// FeaturePage is a single page maximum result representing a query by offset page.
type FeaturePage struct {
	pagination.OffsetPageBase
}

// IsEmpty checks whether a FeaturePage struct is empty.
func (b FeaturePage) IsEmpty() (bool, error) {
	arr, err := ExtractFeatures(b)
	return len(arr) == 0, err
}

// ExtractFeatures is a method to extract the list of feature configuration details for APIG instance.
func ExtractFeatures(r pagination.Page) ([]Feature, error) {
	var s []Feature
	err := r.(FeaturePage).Result.ExtractIntoSlicePtr(&s, "features")
	return s, err
}

type EnableElbIngressResp struct {
	// ID of the APIG dedicated instance.
	Instance_id string `json:"instance_id"`
	// Task information of binding the ingress EIP.
	Message string `json:"message"`
	// Job ID of binding the ingress EIP.
	JobId string `json:"job_id"`
}