From ddc289962372de6ef3b9b96df835ae8c4c7ce020 Mon Sep 17 00:00:00 2001 From: Ryan Kes Date: Thu, 18 Apr 2024 14:31:38 +0200 Subject: [PATCH] chore: add docs --- .gitignore | 2 + bmp/docs/BmpAPI.md | 2782 +++++++++++++++++ bmp/docs/ConfigureHardwareRaidOpts.md | 155 + bmp/docs/ControlPanel.md | 82 + bmp/docs/ControlPanelList.md | 82 + .../CreateNetworkEquipmentCredentialOpts.md | 93 + bmp/docs/CreateServerCredentialOpts.md | 93 + bmp/docs/CreateServerDhcpReservationOpts.md | 77 + bmp/docs/Credential.md | 108 + bmp/docs/CredentialList.md | 82 + bmp/docs/CredentialType.md | 25 + bmp/docs/Defaults.md | 82 + bmp/docs/EnableServerRescueModeOpts.md | 181 ++ bmp/docs/ErrorResult.md | 134 + .../GetNetworkEquipmentPowerStatusResult.md | 56 + bmp/docs/GetOperatingSystemListResult.md | 82 + bmp/docs/GetOperatingSystemResult.md | 316 ++ bmp/docs/GetRescueImageListResult.md | 82 + .../GetServerDhcpReservationListResult.md | 82 + bmp/docs/GetServerPowerStatusResult.md | 82 + bmp/docs/InstallOperatingSystemOpts.md | 337 ++ bmp/docs/Ipmi.md | 56 + bmp/docs/IpmiResetServerOpts.md | 82 + bmp/docs/LastClientRequest.md | 118 + bmp/docs/Lease.md | 290 ++ bmp/docs/Metadata.md | 56 + bmp/docs/OperatingSystem.md | 82 + bmp/docs/Partition.md | 108 + bmp/docs/Pdu.md | 56 + bmp/docs/Raid.md | 108 + bmp/docs/RaidType.md | 15 + bmp/docs/RescueImage.md | 82 + bmp/docs/ScanHardwareOpts.md | 82 + bmp/docs/ServerJob.md | 394 +++ bmp/docs/ServerJobList.md | 82 + bmp/docs/Task.md | 222 ++ .../UpdateNetworkEquipmentCredentialOpts.md | 51 + bmp/docs/UpdateServerCredentialOpts.md | 51 + bmsdb/docs/BmsdbAPI.md | 230 ++ bmsdb/docs/ErrorResult.md | 134 + bmsdb/docs/GetServerHardwareResult.md | 160 + bmsdb/docs/GetServerHardwareScanListResult.md | 82 + bmsdb/docs/GetServerHardwareScanResult.md | 160 + bmsdb/docs/HardwareScan.md | 134 + bmsdb/docs/Metadata.md | 108 + bmsdb/docs/Results.md | 186 ++ bmusage/docs/Actions.md | 92 + bmusage/docs/BandwidthNotificationSetting.md | 232 ++ .../docs/BandwidthNotificationSettingOpts.md | 93 + bmusage/docs/BmusageAPI.md | 908 ++++++ .../docs/DataTrafficNotificationSetting.md | 232 ++ .../DataTrafficNotificationSettingOpts.md | 93 + bmusage/docs/ErrorResult.md | 134 + ...rBandwidthNotificationSettingListResult.md | 82 + ...ataTrafficNotificationSettingListResult.md | 82 + bmusage/docs/Metadata.md | 108 + bmusage/docs/Metric.md | 82 + bmusage/docs/MetricValue.md | 82 + bmusage/docs/MetricValues.md | 82 + bmusage/docs/Metrics.md | 82 + bmusage/docs/MetricsMetadata.md | 134 + bmusage/docs/NotificationSetting.md | 206 ++ .../docs/AddServerToPrivateNetworkOpts.md | 51 + dedicatedserver/docs/Cpu.md | 82 + dedicatedserver/docs/DDos.md | 82 + dedicatedserver/docs/DedicatedserverAPI.md | 1516 +++++++++ dedicatedserver/docs/ErrorResult.md | 134 + .../docs/GetNetworkEquipmentIpListResult.md | 82 + .../docs/GetNetworkEquipmentListResult.md | 82 + ...tNetworkEquipmentNullRouteHistoryResult.md | 82 + dedicatedserver/docs/GetServerListResult.md | 82 + .../docs/GetServerNullRouteHistoryResult.md | 82 + dedicatedserver/docs/Hdd.md | 196 ++ dedicatedserver/docs/Ip.md | 264 ++ dedicatedserver/docs/LinkSpeed.md | 15 + dedicatedserver/docs/Metadata.md | 108 + dedicatedserver/docs/NetworkEquipment.md | 316 ++ dedicatedserver/docs/NetworkEquipmentSpecs.md | 82 + dedicatedserver/docs/NullRoute.md | 186 ++ dedicatedserver/docs/PciCard.md | 56 + dedicatedserver/docs/Powerport.md | 82 + dedicatedserver/docs/PrivateNetwork.md | 160 + dedicatedserver/docs/Rack.md | 108 + dedicatedserver/docs/Ram.md | 82 + dedicatedserver/docs/Server.md | 316 ++ dedicatedserver/docs/ServerSpecs.md | 186 ++ dedicatedserver/docs/UpdateIpProfileOpts.md | 82 + .../docs/UpdateNetworkEquipmentIpOpts.md | 82 + .../UpdateNetworkEquipmentReferenceOpts.md | 51 + .../docs/UpdateServerReferenceOpts.md | 51 + nse/docs/ErrorResult.md | 134 + nse/docs/GetDdosNotificationSettingResult.md | 82 + nse/docs/GetNetworkInterfaceListResult.md | 82 + nse/docs/Metadata.md | 108 + nse/docs/NetworkInterface.md | 186 ++ nse/docs/NseAPI.md | 644 ++++ nse/docs/UpdateDdosNotificationSettingOpts.md | 82 + nse/docs/UpdateNullRouteAcceptedResult.md | 56 + nse/docs/UpdateNullRouteBadRequestResult.md | 134 + nse/docs/UpdateNullRouteOpts.md | 72 + publicCloud/docs/AttachIsoOpts.md | 51 + publicCloud/docs/BaseFirewallRule.md | 118 + publicCloud/docs/Billing.md | 82 + publicCloud/docs/Central.md | 82 + publicCloud/docs/Compute.md | 82 + publicCloud/docs/ContractType.md | 13 + publicCloud/docs/Cpu.md | 82 + .../docs/CreateFirewallRulesCreatedResult.md | 82 + publicCloud/docs/CreateFirewallRulesOpts.md | 51 + publicCloud/docs/CreateRule.md | 233 ++ publicCloud/docs/Credential.md | 82 + publicCloud/docs/CredentialType.md | 13 + publicCloud/docs/Ddos.md | 82 + publicCloud/docs/DeleteFirewallRulesOpts.md | 51 + publicCloud/docs/DeleteFirewallRulesResult.md | 82 + publicCloud/docs/DeletionRule.md | 51 + publicCloud/docs/EditFirewallRulesOpts.md | 51 + publicCloud/docs/EditFirewallRulesResult.md | 82 + publicCloud/docs/EditRule.md | 228 ++ publicCloud/docs/ErrorResult.md | 134 + publicCloud/docs/ExpenseResultInstance.md | 420 +++ publicCloud/docs/FailedRule.md | 82 + publicCloud/docs/FirewallRule.md | 248 ++ .../docs/GetConsoleAccessToInstanceResult.md | 56 + .../docs/GetCredentialListByTypeResult.md | 82 + publicCloud/docs/GetCredentialListResult.md | 82 + publicCloud/docs/GetCredentialResult.md | 108 + publicCloud/docs/GetExpensesResult.md | 56 + publicCloud/docs/GetFirewallRuleListResult.md | 82 + publicCloud/docs/GetInstanceListResult.md | 82 + publicCloud/docs/GetInstanceResult.md | 586 ++++ publicCloud/docs/GetInstanceTypeListResult.md | 82 + publicCloud/docs/GetIsoListResult.md | 82 + publicCloud/docs/GetMarketAppListResult.md | 82 + .../docs/GetOperatingSystemListResult.md | 82 + publicCloud/docs/GetRegionListResult.md | 82 + .../docs/GetUpdateInstanceTypeListResult.md | 82 + publicCloud/docs/IcmpFirewallRule.md | 258 ++ publicCloud/docs/Instance.md | 524 ++++ publicCloud/docs/InstanceResources.md | 134 + publicCloud/docs/InstanceState.md | 19 + publicCloud/docs/InstanceTypeDetails.md | 144 + publicCloud/docs/Ip.md | 222 ++ publicCloud/docs/Iso.md | 82 + .../docs/LaunchInstanceCreatedResult.md | 642 ++++ publicCloud/docs/LaunchInstanceOpts.md | 286 ++ publicCloud/docs/Local.md | 82 + publicCloud/docs/MarketApp.md | 196 ++ publicCloud/docs/Memory.md | 82 + publicCloud/docs/Metadata.md | 108 + publicCloud/docs/OperatingSystem.md | 238 ++ publicCloud/docs/OperatingSystemDetail.md | 238 ++ publicCloud/docs/Price.md | 134 + publicCloud/docs/PrivateNetwork.md | 108 + publicCloud/docs/PrivateNetworkSpeed.md | 82 + publicCloud/docs/PublicCloudAPI.md | 2297 ++++++++++++++ publicCloud/docs/PublicNetworkSpeed.md | 82 + publicCloud/docs/Region.md | 82 + publicCloud/docs/Storage.md | 82 + publicCloud/docs/StoreCredentialOpts.md | 93 + publicCloud/docs/StoreCredentialResult.md | 108 + publicCloud/docs/TcpUdpFirewallRule.md | 258 ++ publicCloud/docs/Tier.md | 82 + publicCloud/docs/Traffic.md | 82 + publicCloud/docs/UpdateCredentialOpts.md | 51 + publicCloud/docs/UpdateCredentialResult.md | 108 + publicCloud/docs/UpdateInstanceOpts.md | 186 ++ publicCloud/docs/UpdateInstanceResult.md | 632 ++++ publicCloud/docs/UpdateInstanceType.md | 144 + publicCloud/docs/Values.md | 134 + 170 files changed, 29254 insertions(+) create mode 100644 bmp/docs/BmpAPI.md create mode 100644 bmp/docs/ConfigureHardwareRaidOpts.md create mode 100644 bmp/docs/ControlPanel.md create mode 100644 bmp/docs/ControlPanelList.md create mode 100644 bmp/docs/CreateNetworkEquipmentCredentialOpts.md create mode 100644 bmp/docs/CreateServerCredentialOpts.md create mode 100644 bmp/docs/CreateServerDhcpReservationOpts.md create mode 100644 bmp/docs/Credential.md create mode 100644 bmp/docs/CredentialList.md create mode 100644 bmp/docs/CredentialType.md create mode 100644 bmp/docs/Defaults.md create mode 100644 bmp/docs/EnableServerRescueModeOpts.md create mode 100644 bmp/docs/ErrorResult.md create mode 100644 bmp/docs/GetNetworkEquipmentPowerStatusResult.md create mode 100644 bmp/docs/GetOperatingSystemListResult.md create mode 100644 bmp/docs/GetOperatingSystemResult.md create mode 100644 bmp/docs/GetRescueImageListResult.md create mode 100644 bmp/docs/GetServerDhcpReservationListResult.md create mode 100644 bmp/docs/GetServerPowerStatusResult.md create mode 100644 bmp/docs/InstallOperatingSystemOpts.md create mode 100644 bmp/docs/Ipmi.md create mode 100644 bmp/docs/IpmiResetServerOpts.md create mode 100644 bmp/docs/LastClientRequest.md create mode 100644 bmp/docs/Lease.md create mode 100644 bmp/docs/Metadata.md create mode 100644 bmp/docs/OperatingSystem.md create mode 100644 bmp/docs/Partition.md create mode 100644 bmp/docs/Pdu.md create mode 100644 bmp/docs/Raid.md create mode 100644 bmp/docs/RaidType.md create mode 100644 bmp/docs/RescueImage.md create mode 100644 bmp/docs/ScanHardwareOpts.md create mode 100644 bmp/docs/ServerJob.md create mode 100644 bmp/docs/ServerJobList.md create mode 100644 bmp/docs/Task.md create mode 100644 bmp/docs/UpdateNetworkEquipmentCredentialOpts.md create mode 100644 bmp/docs/UpdateServerCredentialOpts.md create mode 100644 bmsdb/docs/BmsdbAPI.md create mode 100644 bmsdb/docs/ErrorResult.md create mode 100644 bmsdb/docs/GetServerHardwareResult.md create mode 100644 bmsdb/docs/GetServerHardwareScanListResult.md create mode 100644 bmsdb/docs/GetServerHardwareScanResult.md create mode 100644 bmsdb/docs/HardwareScan.md create mode 100644 bmsdb/docs/Metadata.md create mode 100644 bmsdb/docs/Results.md create mode 100644 bmusage/docs/Actions.md create mode 100644 bmusage/docs/BandwidthNotificationSetting.md create mode 100644 bmusage/docs/BandwidthNotificationSettingOpts.md create mode 100644 bmusage/docs/BmusageAPI.md create mode 100644 bmusage/docs/DataTrafficNotificationSetting.md create mode 100644 bmusage/docs/DataTrafficNotificationSettingOpts.md create mode 100644 bmusage/docs/ErrorResult.md create mode 100644 bmusage/docs/GetServerBandwidthNotificationSettingListResult.md create mode 100644 bmusage/docs/GetServerDataTrafficNotificationSettingListResult.md create mode 100644 bmusage/docs/Metadata.md create mode 100644 bmusage/docs/Metric.md create mode 100644 bmusage/docs/MetricValue.md create mode 100644 bmusage/docs/MetricValues.md create mode 100644 bmusage/docs/Metrics.md create mode 100644 bmusage/docs/MetricsMetadata.md create mode 100644 bmusage/docs/NotificationSetting.md create mode 100644 dedicatedserver/docs/AddServerToPrivateNetworkOpts.md create mode 100644 dedicatedserver/docs/Cpu.md create mode 100644 dedicatedserver/docs/DDos.md create mode 100644 dedicatedserver/docs/DedicatedserverAPI.md create mode 100644 dedicatedserver/docs/ErrorResult.md create mode 100644 dedicatedserver/docs/GetNetworkEquipmentIpListResult.md create mode 100644 dedicatedserver/docs/GetNetworkEquipmentListResult.md create mode 100644 dedicatedserver/docs/GetNetworkEquipmentNullRouteHistoryResult.md create mode 100644 dedicatedserver/docs/GetServerListResult.md create mode 100644 dedicatedserver/docs/GetServerNullRouteHistoryResult.md create mode 100644 dedicatedserver/docs/Hdd.md create mode 100644 dedicatedserver/docs/Ip.md create mode 100644 dedicatedserver/docs/LinkSpeed.md create mode 100644 dedicatedserver/docs/Metadata.md create mode 100644 dedicatedserver/docs/NetworkEquipment.md create mode 100644 dedicatedserver/docs/NetworkEquipmentSpecs.md create mode 100644 dedicatedserver/docs/NullRoute.md create mode 100644 dedicatedserver/docs/PciCard.md create mode 100644 dedicatedserver/docs/Powerport.md create mode 100644 dedicatedserver/docs/PrivateNetwork.md create mode 100644 dedicatedserver/docs/Rack.md create mode 100644 dedicatedserver/docs/Ram.md create mode 100644 dedicatedserver/docs/Server.md create mode 100644 dedicatedserver/docs/ServerSpecs.md create mode 100644 dedicatedserver/docs/UpdateIpProfileOpts.md create mode 100644 dedicatedserver/docs/UpdateNetworkEquipmentIpOpts.md create mode 100644 dedicatedserver/docs/UpdateNetworkEquipmentReferenceOpts.md create mode 100644 dedicatedserver/docs/UpdateServerReferenceOpts.md create mode 100644 nse/docs/ErrorResult.md create mode 100644 nse/docs/GetDdosNotificationSettingResult.md create mode 100644 nse/docs/GetNetworkInterfaceListResult.md create mode 100644 nse/docs/Metadata.md create mode 100644 nse/docs/NetworkInterface.md create mode 100644 nse/docs/NseAPI.md create mode 100644 nse/docs/UpdateDdosNotificationSettingOpts.md create mode 100644 nse/docs/UpdateNullRouteAcceptedResult.md create mode 100644 nse/docs/UpdateNullRouteBadRequestResult.md create mode 100644 nse/docs/UpdateNullRouteOpts.md create mode 100644 publicCloud/docs/AttachIsoOpts.md create mode 100644 publicCloud/docs/BaseFirewallRule.md create mode 100644 publicCloud/docs/Billing.md create mode 100644 publicCloud/docs/Central.md create mode 100644 publicCloud/docs/Compute.md create mode 100644 publicCloud/docs/ContractType.md create mode 100644 publicCloud/docs/Cpu.md create mode 100644 publicCloud/docs/CreateFirewallRulesCreatedResult.md create mode 100644 publicCloud/docs/CreateFirewallRulesOpts.md create mode 100644 publicCloud/docs/CreateRule.md create mode 100644 publicCloud/docs/Credential.md create mode 100644 publicCloud/docs/CredentialType.md create mode 100644 publicCloud/docs/Ddos.md create mode 100644 publicCloud/docs/DeleteFirewallRulesOpts.md create mode 100644 publicCloud/docs/DeleteFirewallRulesResult.md create mode 100644 publicCloud/docs/DeletionRule.md create mode 100644 publicCloud/docs/EditFirewallRulesOpts.md create mode 100644 publicCloud/docs/EditFirewallRulesResult.md create mode 100644 publicCloud/docs/EditRule.md create mode 100644 publicCloud/docs/ErrorResult.md create mode 100644 publicCloud/docs/ExpenseResultInstance.md create mode 100644 publicCloud/docs/FailedRule.md create mode 100644 publicCloud/docs/FirewallRule.md create mode 100644 publicCloud/docs/GetConsoleAccessToInstanceResult.md create mode 100644 publicCloud/docs/GetCredentialListByTypeResult.md create mode 100644 publicCloud/docs/GetCredentialListResult.md create mode 100644 publicCloud/docs/GetCredentialResult.md create mode 100644 publicCloud/docs/GetExpensesResult.md create mode 100644 publicCloud/docs/GetFirewallRuleListResult.md create mode 100644 publicCloud/docs/GetInstanceListResult.md create mode 100644 publicCloud/docs/GetInstanceResult.md create mode 100644 publicCloud/docs/GetInstanceTypeListResult.md create mode 100644 publicCloud/docs/GetIsoListResult.md create mode 100644 publicCloud/docs/GetMarketAppListResult.md create mode 100644 publicCloud/docs/GetOperatingSystemListResult.md create mode 100644 publicCloud/docs/GetRegionListResult.md create mode 100644 publicCloud/docs/GetUpdateInstanceTypeListResult.md create mode 100644 publicCloud/docs/IcmpFirewallRule.md create mode 100644 publicCloud/docs/Instance.md create mode 100644 publicCloud/docs/InstanceResources.md create mode 100644 publicCloud/docs/InstanceState.md create mode 100644 publicCloud/docs/InstanceTypeDetails.md create mode 100644 publicCloud/docs/Ip.md create mode 100644 publicCloud/docs/Iso.md create mode 100644 publicCloud/docs/LaunchInstanceCreatedResult.md create mode 100644 publicCloud/docs/LaunchInstanceOpts.md create mode 100644 publicCloud/docs/Local.md create mode 100644 publicCloud/docs/MarketApp.md create mode 100644 publicCloud/docs/Memory.md create mode 100644 publicCloud/docs/Metadata.md create mode 100644 publicCloud/docs/OperatingSystem.md create mode 100644 publicCloud/docs/OperatingSystemDetail.md create mode 100644 publicCloud/docs/Price.md create mode 100644 publicCloud/docs/PrivateNetwork.md create mode 100644 publicCloud/docs/PrivateNetworkSpeed.md create mode 100644 publicCloud/docs/PublicCloudAPI.md create mode 100644 publicCloud/docs/PublicNetworkSpeed.md create mode 100644 publicCloud/docs/Region.md create mode 100644 publicCloud/docs/Storage.md create mode 100644 publicCloud/docs/StoreCredentialOpts.md create mode 100644 publicCloud/docs/StoreCredentialResult.md create mode 100644 publicCloud/docs/TcpUdpFirewallRule.md create mode 100644 publicCloud/docs/Tier.md create mode 100644 publicCloud/docs/Traffic.md create mode 100644 publicCloud/docs/UpdateCredentialOpts.md create mode 100644 publicCloud/docs/UpdateCredentialResult.md create mode 100644 publicCloud/docs/UpdateInstanceOpts.md create mode 100644 publicCloud/docs/UpdateInstanceResult.md create mode 100644 publicCloud/docs/UpdateInstanceType.md create mode 100644 publicCloud/docs/Values.md diff --git a/.gitignore b/.gitignore index 53c207a..64557f5 100644 --- a/.gitignore +++ b/.gitignore @@ -41,6 +41,8 @@ go.work !README.md !LICENSE +!**/*.md + # !Makefile # ...even if they are in subdirectories diff --git a/bmp/docs/BmpAPI.md b/bmp/docs/BmpAPI.md new file mode 100644 index 0000000..2c568aa --- /dev/null +++ b/bmp/docs/BmpAPI.md @@ -0,0 +1,2782 @@ +# \BmpAPI + +All URIs are relative to *https://api.leaseweb.com/internal/bmpapi/v2* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**AddServerCredential**](BmpAPI.md#AddServerCredential) | **Post** /servers/{serverId}/credentials | Create new credentials +[**CancelActiveJob**](BmpAPI.md#CancelActiveJob) | **Post** /servers/{serverId}/cancelActiveJob | Cancel active job +[**ConfigureHardwareRaid**](BmpAPI.md#ConfigureHardwareRaid) | **Post** /servers/{serverId}/configureHardwareRaid | Configure Hardware Raid +[**CreateServerDhcpReservation**](BmpAPI.md#CreateServerDhcpReservation) | **Post** /servers/{serverId}/leases | Create a DHCP reservation +[**DeleteNetworkEquipmentCredential**](BmpAPI.md#DeleteNetworkEquipmentCredential) | **Delete** /networkEquipments/{networkEquipmentId}/credentials/{type}/{username} | Delete user credentials +[**DeleteServerCredential**](BmpAPI.md#DeleteServerCredential) | **Delete** /servers/{serverId}/credentials/{type}/{username} | Delete server credential +[**EnableServerRescueMode**](BmpAPI.md#EnableServerRescueMode) | **Post** /servers/{serverId}/rescueMode | Launch rescue mode +[**ExpireActiveJob**](BmpAPI.md#ExpireActiveJob) | **Post** /servers/{serverId}/expireActiveJob | Expire active job +[**GetControlPanelList**](BmpAPI.md#GetControlPanelList) | **Get** /controlPanels | List control panels +[**GetControlPanelListByOperatingSystem**](BmpAPI.md#GetControlPanelListByOperatingSystem) | **Get** /operatingSystems/{operatingSystemId}/controlPanels | List control panels +[**GetNetworkEquipmentCredentialListByType**](BmpAPI.md#GetNetworkEquipmentCredentialListByType) | **Get** /networkEquipments/{networkEquipmentId}/credentials/{type} | List credentials by type +[**GetNetworkEquipmentPowerStatus**](BmpAPI.md#GetNetworkEquipmentPowerStatus) | **Get** /networkEquipments/{networkEquipmentId}/powerInfo | Show power status +[**GetOperatingSystem**](BmpAPI.md#GetOperatingSystem) | **Get** /operatingSystems/{operatingSystemId} | Show an operating system +[**GetOperatingSystemList**](BmpAPI.md#GetOperatingSystemList) | **Get** /operatingSystems | List Operating Systems +[**GetRescueImageList**](BmpAPI.md#GetRescueImageList) | **Get** /rescueImages | Rescue Images +[**GetServerCredentialList**](BmpAPI.md#GetServerCredentialList) | **Get** /servers/{serverId}/credentials | List credentials +[**GetServerDhcpReservationList**](BmpAPI.md#GetServerDhcpReservationList) | **Get** /servers/{serverId}/leases | List DHCP reservations +[**GetServerJobList**](BmpAPI.md#GetServerJobList) | **Get** /servers/{serverId}/jobs | List jobs +[**GetServerPowerStatus**](BmpAPI.md#GetServerPowerStatus) | **Get** /servers/{serverId}/powerInfo | Show power status +[**InstallOperatingSystem**](BmpAPI.md#InstallOperatingSystem) | **Post** /servers/{serverId}/install | Launch installation +[**IpmiResetServer**](BmpAPI.md#IpmiResetServer) | **Post** /servers/{serverId}/ipmiReset | Launch IPMI reset +[**NetworkEquipmentsCredentialsGet**](BmpAPI.md#NetworkEquipmentsCredentialsGet) | **Get** /networkEquipments/{networkEquipmentId}/credentials/{type}/{username} | Show user credentials +[**NetworkEquipmentsCredentialsList**](BmpAPI.md#NetworkEquipmentsCredentialsList) | **Get** /networkEquipments/{networkEquipmentId}/credentials | List credentials +[**NetworkEquipmentsCredentialsPost**](BmpAPI.md#NetworkEquipmentsCredentialsPost) | **Post** /networkEquipments/{networkEquipmentId}/credentials | Create new credentials +[**PowerCycleNetworkEquipment**](BmpAPI.md#PowerCycleNetworkEquipment) | **Post** /networkEquipments/{networkEquipmentId}/powerCycle | Power cycle a network equipment +[**PowerCycleServer**](BmpAPI.md#PowerCycleServer) | **Post** /servers/{serverId}/powerCycle | Power cycle a server +[**PowerNetworkEquipmentOff**](BmpAPI.md#PowerNetworkEquipmentOff) | **Post** /networkEquipments/{networkEquipmentId}/powerOff | Power off network equipment +[**PowerNetworkEquipmentOn**](BmpAPI.md#PowerNetworkEquipmentOn) | **Post** /networkEquipments/{networkEquipmentId}/powerOn | Power on network equipment +[**PowerServerOff**](BmpAPI.md#PowerServerOff) | **Post** /servers/{serverId}/powerOff | Power off server +[**PowerServerOn**](BmpAPI.md#PowerServerOn) | **Post** /servers/{serverId}/powerOn | Power on server +[**RetryServerJob**](BmpAPI.md#RetryServerJob) | **Post** /servers/{serverId}/jobs/{jobId}/retry | Retry a job +[**ScanHardware**](BmpAPI.md#ScanHardware) | **Post** /servers/{serverId}/hardwareScan | Launch hardware scan +[**ServersCredentialsGet**](BmpAPI.md#ServersCredentialsGet) | **Get** /servers/{serverId}/credentials/{type}/{username} | Show user credentials +[**ServersCredentialsListType**](BmpAPI.md#ServersCredentialsListType) | **Get** /servers/{serverId}/credentials/{type} | List credentials by type +[**ServersCredentialsPut**](BmpAPI.md#ServersCredentialsPut) | **Put** /servers/{serverId}/credentials/{type}/{username} | Update user credentials +[**ServersJobsGet**](BmpAPI.md#ServersJobsGet) | **Get** /servers/{serverId}/jobs/{jobId} | Show a job +[**ServersLeasesDelete**](BmpAPI.md#ServersLeasesDelete) | **Delete** /servers/{serverId}/leases | Delete a DHCP reservation +[**UpdateNetworkEquipmentCredential**](BmpAPI.md#UpdateNetworkEquipmentCredential) | **Put** /networkEquipments/{networkEquipmentId}/credentials/{type}/{username} | Update user credentials + + + +## AddServerCredential + +> Credential AddServerCredential(ctx, serverId).CreateServerCredentialOpts(createServerCredentialOpts).Execute() + +Create new credentials + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + serverId := "12345" // string | The ID of a server + createServerCredentialOpts := *openapiclient.NewCreateServerCredentialOpts("Password_example", openapiclient.credentialType("OPERATING_SYSTEM"), "Username_example") // CreateServerCredentialOpts | (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmpAPI.AddServerCredential(context.Background(), serverId).CreateServerCredentialOpts(createServerCredentialOpts).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.AddServerCredential``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `AddServerCredential`: Credential + fmt.Fprintf(os.Stdout, "Response from `BmpAPI.AddServerCredential`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiAddServerCredentialRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **createServerCredentialOpts** | [**CreateServerCredentialOpts**](CreateServerCredentialOpts.md) | | + +### Return type + +[**Credential**](Credential.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## CancelActiveJob + +> ServerJob CancelActiveJob(ctx, serverId).Execute() + +Cancel active job + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + serverId := "12345" // string | The ID of a server + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmpAPI.CancelActiveJob(context.Background(), serverId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.CancelActiveJob``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CancelActiveJob`: ServerJob + fmt.Fprintf(os.Stdout, "Response from `BmpAPI.CancelActiveJob`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCancelActiveJobRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ServerJob**](ServerJob.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ConfigureHardwareRaid + +> ServerJobList ConfigureHardwareRaid(ctx, serverId).ConfigureHardwareRaidOpts(configureHardwareRaidOpts).Execute() + +Configure Hardware Raid + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + serverId := "12345" // string | The ID of a server + configureHardwareRaidOpts := *openapiclient.NewConfigureHardwareRaidOpts(openapiclient.raidType("HW")) // ConfigureHardwareRaidOpts | (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmpAPI.ConfigureHardwareRaid(context.Background(), serverId).ConfigureHardwareRaidOpts(configureHardwareRaidOpts).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.ConfigureHardwareRaid``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ConfigureHardwareRaid`: ServerJobList + fmt.Fprintf(os.Stdout, "Response from `BmpAPI.ConfigureHardwareRaid`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiConfigureHardwareRaidRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **configureHardwareRaidOpts** | [**ConfigureHardwareRaidOpts**](ConfigureHardwareRaidOpts.md) | | + +### Return type + +[**ServerJobList**](ServerJobList.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## CreateServerDhcpReservation + +> CreateServerDhcpReservation(ctx, serverId).CreateServerDhcpReservationOpts(createServerDhcpReservationOpts).Execute() + +Create a DHCP reservation + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + serverId := "12345" // string | The ID of a server + createServerDhcpReservationOpts := *openapiclient.NewCreateServerDhcpReservationOpts("Bootfile_example") // CreateServerDhcpReservationOpts | (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.BmpAPI.CreateServerDhcpReservation(context.Background(), serverId).CreateServerDhcpReservationOpts(createServerDhcpReservationOpts).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.CreateServerDhcpReservation``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateServerDhcpReservationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **createServerDhcpReservationOpts** | [**CreateServerDhcpReservationOpts**](CreateServerDhcpReservationOpts.md) | | + +### Return type + + (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteNetworkEquipmentCredential + +> DeleteNetworkEquipmentCredential(ctx, networkEquipmentId, type_, username).Execute() + +Delete user credentials + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + networkEquipmentId := "12345" // string | The ID of a dedicated network equipment + type_ := "OPERATING_SYSTEM" // string | Credential type + username := "root" // string | Username + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.BmpAPI.DeleteNetworkEquipmentCredential(context.Background(), networkEquipmentId, type_, username).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.DeleteNetworkEquipmentCredential``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**networkEquipmentId** | **string** | The ID of a dedicated network equipment | +**type_** | **string** | Credential type | +**username** | **string** | Username | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteNetworkEquipmentCredentialRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + + (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteServerCredential + +> DeleteServerCredential(ctx, serverId, type_, username).Execute() + +Delete server credential + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + serverId := "12345" // string | The ID of a server + type_ := "OPERATING_SYSTEM" // string | Credential type + username := "root" // string | Username + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.BmpAPI.DeleteServerCredential(context.Background(), serverId, type_, username).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.DeleteServerCredential``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | +**type_** | **string** | Credential type | +**username** | **string** | Username | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteServerCredentialRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + + (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## EnableServerRescueMode + +> ServerJob EnableServerRescueMode(ctx, serverId).EnableServerRescueModeOpts(enableServerRescueModeOpts).Execute() + +Launch rescue mode + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + serverId := "12345" // string | The ID of a server + enableServerRescueModeOpts := *openapiclient.NewEnableServerRescueModeOpts("RescueImageId_example") // EnableServerRescueModeOpts | (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmpAPI.EnableServerRescueMode(context.Background(), serverId).EnableServerRescueModeOpts(enableServerRescueModeOpts).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.EnableServerRescueMode``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `EnableServerRescueMode`: ServerJob + fmt.Fprintf(os.Stdout, "Response from `BmpAPI.EnableServerRescueMode`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiEnableServerRescueModeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **enableServerRescueModeOpts** | [**EnableServerRescueModeOpts**](EnableServerRescueModeOpts.md) | | + +### Return type + +[**ServerJob**](ServerJob.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ExpireActiveJob + +> ServerJob ExpireActiveJob(ctx, serverId).Execute() + +Expire active job + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + serverId := "12345" // string | The ID of a server + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmpAPI.ExpireActiveJob(context.Background(), serverId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.ExpireActiveJob``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ExpireActiveJob`: ServerJob + fmt.Fprintf(os.Stdout, "Response from `BmpAPI.ExpireActiveJob`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiExpireActiveJobRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**ServerJob**](ServerJob.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetControlPanelList + +> ControlPanelList GetControlPanelList(ctx).Limit(limit).Offset(offset).Execute() + +List control panels + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + limit := int32(20) // int32 | Limit the number of results returned. (optional) + offset := int32(10) // int32 | Return results starting from the given offset. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmpAPI.GetControlPanelList(context.Background()).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.GetControlPanelList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetControlPanelList`: ControlPanelList + fmt.Fprintf(os.Stdout, "Response from `BmpAPI.GetControlPanelList`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetControlPanelListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **limit** | **int32** | Limit the number of results returned. | + **offset** | **int32** | Return results starting from the given offset. | + +### Return type + +[**ControlPanelList**](ControlPanelList.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetControlPanelListByOperatingSystem + +> ControlPanelList GetControlPanelListByOperatingSystem(ctx, operatingSystemId).Limit(limit).Offset(offset).Execute() + +List control panels + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + operatingSystemId := "UBUNTU_22_04_64BIT" // string | Operating system ID + limit := int32(20) // int32 | Limit the number of results returned. (optional) + offset := int32(10) // int32 | Return results starting from the given offset. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmpAPI.GetControlPanelListByOperatingSystem(context.Background(), operatingSystemId).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.GetControlPanelListByOperatingSystem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetControlPanelListByOperatingSystem`: ControlPanelList + fmt.Fprintf(os.Stdout, "Response from `BmpAPI.GetControlPanelListByOperatingSystem`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**operatingSystemId** | **string** | Operating system ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetControlPanelListByOperatingSystemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **limit** | **int32** | Limit the number of results returned. | + **offset** | **int32** | Return results starting from the given offset. | + +### Return type + +[**ControlPanelList**](ControlPanelList.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetNetworkEquipmentCredentialListByType + +> CredentialList GetNetworkEquipmentCredentialListByType(ctx, networkEquipmentId, type_).Limit(limit).Offset(offset).Execute() + +List credentials by type + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + networkEquipmentId := "12345" // string | The ID of a dedicated network equipment + type_ := "OPERATING_SYSTEM" // string | Credential type + limit := int32(20) // int32 | Limit the number of results returned. (optional) + offset := int32(10) // int32 | Return results starting from the given offset. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmpAPI.GetNetworkEquipmentCredentialListByType(context.Background(), networkEquipmentId, type_).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.GetNetworkEquipmentCredentialListByType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNetworkEquipmentCredentialListByType`: CredentialList + fmt.Fprintf(os.Stdout, "Response from `BmpAPI.GetNetworkEquipmentCredentialListByType`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**networkEquipmentId** | **string** | The ID of a dedicated network equipment | +**type_** | **string** | Credential type | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNetworkEquipmentCredentialListByTypeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **limit** | **int32** | Limit the number of results returned. | + **offset** | **int32** | Return results starting from the given offset. | + +### Return type + +[**CredentialList**](CredentialList.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetNetworkEquipmentPowerStatus + +> GetNetworkEquipmentPowerStatusResult GetNetworkEquipmentPowerStatus(ctx, networkEquipmentId).Execute() + +Show power status + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + networkEquipmentId := "12345" // string | The ID of a dedicated network equipment + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmpAPI.GetNetworkEquipmentPowerStatus(context.Background(), networkEquipmentId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.GetNetworkEquipmentPowerStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNetworkEquipmentPowerStatus`: GetNetworkEquipmentPowerStatusResult + fmt.Fprintf(os.Stdout, "Response from `BmpAPI.GetNetworkEquipmentPowerStatus`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**networkEquipmentId** | **string** | The ID of a dedicated network equipment | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNetworkEquipmentPowerStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**GetNetworkEquipmentPowerStatusResult**](GetNetworkEquipmentPowerStatusResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetOperatingSystem + +> GetOperatingSystemResult GetOperatingSystem(ctx, operatingSystemId).ControlPanelId(controlPanelId).Execute() + +Show an operating system + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + operatingSystemId := "UBUNTU_22_04_64BIT" // string | Operating system ID + controlPanelId := "controlPanelId_example" // string | The Control Panel ID + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmpAPI.GetOperatingSystem(context.Background(), operatingSystemId).ControlPanelId(controlPanelId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.GetOperatingSystem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetOperatingSystem`: GetOperatingSystemResult + fmt.Fprintf(os.Stdout, "Response from `BmpAPI.GetOperatingSystem`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**operatingSystemId** | **string** | Operating system ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetOperatingSystemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **controlPanelId** | **string** | The Control Panel ID | + +### Return type + +[**GetOperatingSystemResult**](GetOperatingSystemResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetOperatingSystemList + +> GetOperatingSystemListResult GetOperatingSystemList(ctx).Limit(limit).Offset(offset).ControlPanelId(controlPanelId).Execute() + +List Operating Systems + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + limit := int32(20) // int32 | Limit the number of results returned. (optional) + offset := int32(10) // int32 | Return results starting from the given offset. (optional) + controlPanelId := "controlPanelId_example" // string | Filter operating systems by control panel id (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmpAPI.GetOperatingSystemList(context.Background()).Limit(limit).Offset(offset).ControlPanelId(controlPanelId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.GetOperatingSystemList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetOperatingSystemList`: GetOperatingSystemListResult + fmt.Fprintf(os.Stdout, "Response from `BmpAPI.GetOperatingSystemList`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetOperatingSystemListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **limit** | **int32** | Limit the number of results returned. | + **offset** | **int32** | Return results starting from the given offset. | + **controlPanelId** | **string** | Filter operating systems by control panel id | + +### Return type + +[**GetOperatingSystemListResult**](GetOperatingSystemListResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetRescueImageList + +> GetRescueImageListResult GetRescueImageList(ctx).Limit(limit).Offset(offset).Execute() + +Rescue Images + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + limit := int32(20) // int32 | Limit the number of results returned. (optional) + offset := int32(10) // int32 | Return results starting from the given offset. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmpAPI.GetRescueImageList(context.Background()).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.GetRescueImageList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetRescueImageList`: GetRescueImageListResult + fmt.Fprintf(os.Stdout, "Response from `BmpAPI.GetRescueImageList`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetRescueImageListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **limit** | **int32** | Limit the number of results returned. | + **offset** | **int32** | Return results starting from the given offset. | + +### Return type + +[**GetRescueImageListResult**](GetRescueImageListResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetServerCredentialList + +> CredentialList GetServerCredentialList(ctx, serverId).Limit(limit).Offset(offset).Execute() + +List credentials + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + serverId := "12345" // string | The ID of a server + limit := int32(20) // int32 | Limit the number of results returned. (optional) + offset := int32(10) // int32 | Return results starting from the given offset. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmpAPI.GetServerCredentialList(context.Background(), serverId).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.GetServerCredentialList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServerCredentialList`: CredentialList + fmt.Fprintf(os.Stdout, "Response from `BmpAPI.GetServerCredentialList`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServerCredentialListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **limit** | **int32** | Limit the number of results returned. | + **offset** | **int32** | Return results starting from the given offset. | + +### Return type + +[**CredentialList**](CredentialList.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetServerDhcpReservationList + +> GetServerDhcpReservationListResult GetServerDhcpReservationList(ctx, serverId).Execute() + +List DHCP reservations + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + serverId := "12345" // string | The ID of a server + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmpAPI.GetServerDhcpReservationList(context.Background(), serverId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.GetServerDhcpReservationList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServerDhcpReservationList`: GetServerDhcpReservationListResult + fmt.Fprintf(os.Stdout, "Response from `BmpAPI.GetServerDhcpReservationList`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServerDhcpReservationListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**GetServerDhcpReservationListResult**](GetServerDhcpReservationListResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetServerJobList + +> ServerJobList GetServerJobList(ctx, serverId).Limit(limit).Offset(offset).Type_(type_).Status(status).IsRunning(isRunning).Execute() + +List jobs + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + serverId := "12345" // string | The ID of a server + limit := int32(20) // int32 | Limit the number of results returned. (optional) + offset := int32(10) // int32 | Return results starting from the given offset. (optional) + type_ := "install" // string | Filter the list of jobs by type. (optional) + status := "CANCELED" // string | Filter the list of jobs by status. (optional) + isRunning := "true" // string | Filter the list for running jobs (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmpAPI.GetServerJobList(context.Background(), serverId).Limit(limit).Offset(offset).Type_(type_).Status(status).IsRunning(isRunning).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.GetServerJobList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServerJobList`: ServerJobList + fmt.Fprintf(os.Stdout, "Response from `BmpAPI.GetServerJobList`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServerJobListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **limit** | **int32** | Limit the number of results returned. | + **offset** | **int32** | Return results starting from the given offset. | + **type_** | **string** | Filter the list of jobs by type. | + **status** | **string** | Filter the list of jobs by status. | + **isRunning** | **string** | Filter the list for running jobs | + +### Return type + +[**ServerJobList**](ServerJobList.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetServerPowerStatus + +> GetServerPowerStatusResult GetServerPowerStatus(ctx, serverId).Execute() + +Show power status + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + serverId := "12345" // string | The ID of a server + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmpAPI.GetServerPowerStatus(context.Background(), serverId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.GetServerPowerStatus``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServerPowerStatus`: GetServerPowerStatusResult + fmt.Fprintf(os.Stdout, "Response from `BmpAPI.GetServerPowerStatus`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServerPowerStatusRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**GetServerPowerStatusResult**](GetServerPowerStatusResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## InstallOperatingSystem + +> ServerJob InstallOperatingSystem(ctx, serverId).InstallOperatingSystemOpts(installOperatingSystemOpts).Execute() + +Launch installation + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + serverId := "12345" // string | The ID of a server + installOperatingSystemOpts := *openapiclient.NewInstallOperatingSystemOpts("OperatingSystemId_example") // InstallOperatingSystemOpts | (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmpAPI.InstallOperatingSystem(context.Background(), serverId).InstallOperatingSystemOpts(installOperatingSystemOpts).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.InstallOperatingSystem``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `InstallOperatingSystem`: ServerJob + fmt.Fprintf(os.Stdout, "Response from `BmpAPI.InstallOperatingSystem`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiInstallOperatingSystemRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **installOperatingSystemOpts** | [**InstallOperatingSystemOpts**](InstallOperatingSystemOpts.md) | | + +### Return type + +[**ServerJob**](ServerJob.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## IpmiResetServer + +> ServerJob IpmiResetServer(ctx, serverId).IpmiResetServerOpts(ipmiResetServerOpts).Execute() + +Launch IPMI reset + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + serverId := "12345" // string | The ID of a server + ipmiResetServerOpts := *openapiclient.NewIpmiResetServerOpts() // IpmiResetServerOpts | (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmpAPI.IpmiResetServer(context.Background(), serverId).IpmiResetServerOpts(ipmiResetServerOpts).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.IpmiResetServer``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `IpmiResetServer`: ServerJob + fmt.Fprintf(os.Stdout, "Response from `BmpAPI.IpmiResetServer`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiIpmiResetServerRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **ipmiResetServerOpts** | [**IpmiResetServerOpts**](IpmiResetServerOpts.md) | | + +### Return type + +[**ServerJob**](ServerJob.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## NetworkEquipmentsCredentialsGet + +> Credential NetworkEquipmentsCredentialsGet(ctx, networkEquipmentId, type_, username).Execute() + +Show user credentials + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + networkEquipmentId := "12345" // string | The ID of a dedicated network equipment + type_ := "OPERATING_SYSTEM" // string | Credential type + username := "root" // string | Username + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmpAPI.NetworkEquipmentsCredentialsGet(context.Background(), networkEquipmentId, type_, username).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.NetworkEquipmentsCredentialsGet``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `NetworkEquipmentsCredentialsGet`: Credential + fmt.Fprintf(os.Stdout, "Response from `BmpAPI.NetworkEquipmentsCredentialsGet`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**networkEquipmentId** | **string** | The ID of a dedicated network equipment | +**type_** | **string** | Credential type | +**username** | **string** | Username | + +### Other Parameters + +Other parameters are passed through a pointer to a apiNetworkEquipmentsCredentialsGetRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +[**Credential**](Credential.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## NetworkEquipmentsCredentialsList + +> CredentialList NetworkEquipmentsCredentialsList(ctx, networkEquipmentId).Limit(limit).Offset(offset).Execute() + +List credentials + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + networkEquipmentId := "12345" // string | The ID of a dedicated network equipment + limit := int32(20) // int32 | Limit the number of results returned. (optional) + offset := int32(10) // int32 | Return results starting from the given offset. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmpAPI.NetworkEquipmentsCredentialsList(context.Background(), networkEquipmentId).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.NetworkEquipmentsCredentialsList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `NetworkEquipmentsCredentialsList`: CredentialList + fmt.Fprintf(os.Stdout, "Response from `BmpAPI.NetworkEquipmentsCredentialsList`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**networkEquipmentId** | **string** | The ID of a dedicated network equipment | + +### Other Parameters + +Other parameters are passed through a pointer to a apiNetworkEquipmentsCredentialsListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **limit** | **int32** | Limit the number of results returned. | + **offset** | **int32** | Return results starting from the given offset. | + +### Return type + +[**CredentialList**](CredentialList.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## NetworkEquipmentsCredentialsPost + +> Credential NetworkEquipmentsCredentialsPost(ctx, networkEquipmentId).CreateNetworkEquipmentCredentialOpts(createNetworkEquipmentCredentialOpts).Execute() + +Create new credentials + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + networkEquipmentId := "12345" // string | The ID of a dedicated network equipment + createNetworkEquipmentCredentialOpts := *openapiclient.NewCreateNetworkEquipmentCredentialOpts("Password_example", openapiclient.credentialType("OPERATING_SYSTEM"), "Username_example") // CreateNetworkEquipmentCredentialOpts | (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmpAPI.NetworkEquipmentsCredentialsPost(context.Background(), networkEquipmentId).CreateNetworkEquipmentCredentialOpts(createNetworkEquipmentCredentialOpts).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.NetworkEquipmentsCredentialsPost``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `NetworkEquipmentsCredentialsPost`: Credential + fmt.Fprintf(os.Stdout, "Response from `BmpAPI.NetworkEquipmentsCredentialsPost`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**networkEquipmentId** | **string** | The ID of a dedicated network equipment | + +### Other Parameters + +Other parameters are passed through a pointer to a apiNetworkEquipmentsCredentialsPostRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **createNetworkEquipmentCredentialOpts** | [**CreateNetworkEquipmentCredentialOpts**](CreateNetworkEquipmentCredentialOpts.md) | | + +### Return type + +[**Credential**](Credential.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## PowerCycleNetworkEquipment + +> PowerCycleNetworkEquipment(ctx, networkEquipmentId).Execute() + +Power cycle a network equipment + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + networkEquipmentId := "12345" // string | The ID of a dedicated network equipment + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.BmpAPI.PowerCycleNetworkEquipment(context.Background(), networkEquipmentId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.PowerCycleNetworkEquipment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**networkEquipmentId** | **string** | The ID of a dedicated network equipment | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPowerCycleNetworkEquipmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## PowerCycleServer + +> PowerCycleServer(ctx, serverId).Execute() + +Power cycle a server + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + serverId := "12345" // string | The ID of a server + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.BmpAPI.PowerCycleServer(context.Background(), serverId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.PowerCycleServer``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPowerCycleServerRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## PowerNetworkEquipmentOff + +> PowerNetworkEquipmentOff(ctx, networkEquipmentId).Execute() + +Power off network equipment + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + networkEquipmentId := "12345" // string | The ID of a dedicated network equipment + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.BmpAPI.PowerNetworkEquipmentOff(context.Background(), networkEquipmentId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.PowerNetworkEquipmentOff``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**networkEquipmentId** | **string** | The ID of a dedicated network equipment | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPowerNetworkEquipmentOffRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## PowerNetworkEquipmentOn + +> PowerNetworkEquipmentOn(ctx, networkEquipmentId).Execute() + +Power on network equipment + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + networkEquipmentId := "12345" // string | The ID of a dedicated network equipment + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.BmpAPI.PowerNetworkEquipmentOn(context.Background(), networkEquipmentId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.PowerNetworkEquipmentOn``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**networkEquipmentId** | **string** | The ID of a dedicated network equipment | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPowerNetworkEquipmentOnRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## PowerServerOff + +> PowerServerOff(ctx, serverId).Execute() + +Power off server + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + serverId := "12345" // string | The ID of a server + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.BmpAPI.PowerServerOff(context.Background(), serverId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.PowerServerOff``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPowerServerOffRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## PowerServerOn + +> PowerServerOn(ctx, serverId).Execute() + +Power on server + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + serverId := "12345" // string | The ID of a server + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.BmpAPI.PowerServerOn(context.Background(), serverId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.PowerServerOn``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPowerServerOnRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## RetryServerJob + +> ServerJob RetryServerJob(ctx, serverId, jobId).Execute() + +Retry a job + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + serverId := "12345" // string | The ID of a server + jobId := "3a867358-5b4b-44ee-88ac-4274603ef641" // string | The ID of a Job + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmpAPI.RetryServerJob(context.Background(), serverId, jobId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.RetryServerJob``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `RetryServerJob`: ServerJob + fmt.Fprintf(os.Stdout, "Response from `BmpAPI.RetryServerJob`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | +**jobId** | **string** | The ID of a Job | + +### Other Parameters + +Other parameters are passed through a pointer to a apiRetryServerJobRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**ServerJob**](ServerJob.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ScanHardware + +> ServerJob ScanHardware(ctx, serverId).ScanHardwareOpts(scanHardwareOpts).Execute() + +Launch hardware scan + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + serverId := "12345" // string | The ID of a server + scanHardwareOpts := *openapiclient.NewScanHardwareOpts() // ScanHardwareOpts | (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmpAPI.ScanHardware(context.Background(), serverId).ScanHardwareOpts(scanHardwareOpts).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.ScanHardware``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ScanHardware`: ServerJob + fmt.Fprintf(os.Stdout, "Response from `BmpAPI.ScanHardware`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiScanHardwareRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **scanHardwareOpts** | [**ScanHardwareOpts**](ScanHardwareOpts.md) | | + +### Return type + +[**ServerJob**](ServerJob.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ServersCredentialsGet + +> Credential ServersCredentialsGet(ctx, serverId, type_, username).Execute() + +Show user credentials + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + serverId := "12345" // string | The ID of a server + type_ := "OPERATING_SYSTEM" // string | Credential type + username := "root" // string | Username + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmpAPI.ServersCredentialsGet(context.Background(), serverId, type_, username).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.ServersCredentialsGet``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ServersCredentialsGet`: Credential + fmt.Fprintf(os.Stdout, "Response from `BmpAPI.ServersCredentialsGet`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | +**type_** | **string** | Credential type | +**username** | **string** | Username | + +### Other Parameters + +Other parameters are passed through a pointer to a apiServersCredentialsGetRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +[**Credential**](Credential.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ServersCredentialsListType + +> CredentialList ServersCredentialsListType(ctx, serverId, type_).Limit(limit).Offset(offset).Execute() + +List credentials by type + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + serverId := "12345" // string | The ID of a server + type_ := "OPERATING_SYSTEM" // string | Credential type + limit := int32(20) // int32 | Limit the number of results returned. (optional) + offset := int32(10) // int32 | Return results starting from the given offset. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmpAPI.ServersCredentialsListType(context.Background(), serverId, type_).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.ServersCredentialsListType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ServersCredentialsListType`: CredentialList + fmt.Fprintf(os.Stdout, "Response from `BmpAPI.ServersCredentialsListType`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | +**type_** | **string** | Credential type | + +### Other Parameters + +Other parameters are passed through a pointer to a apiServersCredentialsListTypeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **limit** | **int32** | Limit the number of results returned. | + **offset** | **int32** | Return results starting from the given offset. | + +### Return type + +[**CredentialList**](CredentialList.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ServersCredentialsPut + +> Credential ServersCredentialsPut(ctx, serverId, type_, username).UpdateServerCredentialOpts(updateServerCredentialOpts).Execute() + +Update user credentials + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + serverId := "12345" // string | The ID of a server + type_ := "OPERATING_SYSTEM" // string | Credential type + username := "root" // string | Username + updateServerCredentialOpts := *openapiclient.NewUpdateServerCredentialOpts("Password_example") // UpdateServerCredentialOpts | (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmpAPI.ServersCredentialsPut(context.Background(), serverId, type_, username).UpdateServerCredentialOpts(updateServerCredentialOpts).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.ServersCredentialsPut``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ServersCredentialsPut`: Credential + fmt.Fprintf(os.Stdout, "Response from `BmpAPI.ServersCredentialsPut`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | +**type_** | **string** | Credential type | +**username** | **string** | Username | + +### Other Parameters + +Other parameters are passed through a pointer to a apiServersCredentialsPutRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + **updateServerCredentialOpts** | [**UpdateServerCredentialOpts**](UpdateServerCredentialOpts.md) | | + +### Return type + +[**Credential**](Credential.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ServersJobsGet + +> ServerJob ServersJobsGet(ctx, serverId, jobId).Execute() + +Show a job + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + serverId := "12345" // string | The ID of a server + jobId := "3a867358-5b4b-44ee-88ac-4274603ef641" // string | The ID of a Job + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmpAPI.ServersJobsGet(context.Background(), serverId, jobId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.ServersJobsGet``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ServersJobsGet`: ServerJob + fmt.Fprintf(os.Stdout, "Response from `BmpAPI.ServersJobsGet`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | +**jobId** | **string** | The ID of a Job | + +### Other Parameters + +Other parameters are passed through a pointer to a apiServersJobsGetRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**ServerJob**](ServerJob.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ServersLeasesDelete + +> ServersLeasesDelete(ctx, serverId).Execute() + +Delete a DHCP reservation + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + serverId := "12345" // string | The ID of a server + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.BmpAPI.ServersLeasesDelete(context.Background(), serverId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.ServersLeasesDelete``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiServersLeasesDeleteRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateNetworkEquipmentCredential + +> Credential UpdateNetworkEquipmentCredential(ctx, networkEquipmentId, type_, username).UpdateNetworkEquipmentCredentialOpts(updateNetworkEquipmentCredentialOpts).Execute() + +Update user credentials + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmp" +) + +func main() { + networkEquipmentId := "12345" // string | The ID of a dedicated network equipment + type_ := "OPERATING_SYSTEM" // string | Credential type + username := "root" // string | Username + updateNetworkEquipmentCredentialOpts := *openapiclient.NewUpdateNetworkEquipmentCredentialOpts("Password_example") // UpdateNetworkEquipmentCredentialOpts | (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmpAPI.UpdateNetworkEquipmentCredential(context.Background(), networkEquipmentId, type_, username).UpdateNetworkEquipmentCredentialOpts(updateNetworkEquipmentCredentialOpts).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmpAPI.UpdateNetworkEquipmentCredential``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateNetworkEquipmentCredential`: Credential + fmt.Fprintf(os.Stdout, "Response from `BmpAPI.UpdateNetworkEquipmentCredential`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**networkEquipmentId** | **string** | The ID of a dedicated network equipment | +**type_** | **string** | Credential type | +**username** | **string** | Username | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateNetworkEquipmentCredentialRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + **updateNetworkEquipmentCredentialOpts** | [**UpdateNetworkEquipmentCredentialOpts**](UpdateNetworkEquipmentCredentialOpts.md) | | + +### Return type + +[**Credential**](Credential.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/bmp/docs/ConfigureHardwareRaidOpts.md b/bmp/docs/ConfigureHardwareRaidOpts.md new file mode 100644 index 0000000..97c9f30 --- /dev/null +++ b/bmp/docs/ConfigureHardwareRaidOpts.md @@ -0,0 +1,155 @@ +# ConfigureHardwareRaidOpts + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CallbackUrl** | Pointer to **string** | Url which will receive callbacks | [optional] +**Level** | Pointer to **int32** | RAID level to apply, this value is only required if you specify a type HW | [optional] +**NumberOfDisks** | Pointer to **int32** | The number of disks you want to apply RAID on. If not specified all disks are used. | [optional] +**PowerCycle** | Pointer to **bool** | If set to `true`, server will be power cycled in order to complete the operation | [optional] [default to true] +**Type** | [**RaidType**](RaidType.md) | | + +## Methods + +### NewConfigureHardwareRaidOpts + +`func NewConfigureHardwareRaidOpts(type_ RaidType, ) *ConfigureHardwareRaidOpts` + +NewConfigureHardwareRaidOpts instantiates a new ConfigureHardwareRaidOpts object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewConfigureHardwareRaidOptsWithDefaults + +`func NewConfigureHardwareRaidOptsWithDefaults() *ConfigureHardwareRaidOpts` + +NewConfigureHardwareRaidOptsWithDefaults instantiates a new ConfigureHardwareRaidOpts object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCallbackUrl + +`func (o *ConfigureHardwareRaidOpts) GetCallbackUrl() string` + +GetCallbackUrl returns the CallbackUrl field if non-nil, zero value otherwise. + +### GetCallbackUrlOk + +`func (o *ConfigureHardwareRaidOpts) GetCallbackUrlOk() (*string, bool)` + +GetCallbackUrlOk returns a tuple with the CallbackUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCallbackUrl + +`func (o *ConfigureHardwareRaidOpts) SetCallbackUrl(v string)` + +SetCallbackUrl sets CallbackUrl field to given value. + +### HasCallbackUrl + +`func (o *ConfigureHardwareRaidOpts) HasCallbackUrl() bool` + +HasCallbackUrl returns a boolean if a field has been set. + +### GetLevel + +`func (o *ConfigureHardwareRaidOpts) GetLevel() int32` + +GetLevel returns the Level field if non-nil, zero value otherwise. + +### GetLevelOk + +`func (o *ConfigureHardwareRaidOpts) GetLevelOk() (*int32, bool)` + +GetLevelOk returns a tuple with the Level field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLevel + +`func (o *ConfigureHardwareRaidOpts) SetLevel(v int32)` + +SetLevel sets Level field to given value. + +### HasLevel + +`func (o *ConfigureHardwareRaidOpts) HasLevel() bool` + +HasLevel returns a boolean if a field has been set. + +### GetNumberOfDisks + +`func (o *ConfigureHardwareRaidOpts) GetNumberOfDisks() int32` + +GetNumberOfDisks returns the NumberOfDisks field if non-nil, zero value otherwise. + +### GetNumberOfDisksOk + +`func (o *ConfigureHardwareRaidOpts) GetNumberOfDisksOk() (*int32, bool)` + +GetNumberOfDisksOk returns a tuple with the NumberOfDisks field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumberOfDisks + +`func (o *ConfigureHardwareRaidOpts) SetNumberOfDisks(v int32)` + +SetNumberOfDisks sets NumberOfDisks field to given value. + +### HasNumberOfDisks + +`func (o *ConfigureHardwareRaidOpts) HasNumberOfDisks() bool` + +HasNumberOfDisks returns a boolean if a field has been set. + +### GetPowerCycle + +`func (o *ConfigureHardwareRaidOpts) GetPowerCycle() bool` + +GetPowerCycle returns the PowerCycle field if non-nil, zero value otherwise. + +### GetPowerCycleOk + +`func (o *ConfigureHardwareRaidOpts) GetPowerCycleOk() (*bool, bool)` + +GetPowerCycleOk returns a tuple with the PowerCycle field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPowerCycle + +`func (o *ConfigureHardwareRaidOpts) SetPowerCycle(v bool)` + +SetPowerCycle sets PowerCycle field to given value. + +### HasPowerCycle + +`func (o *ConfigureHardwareRaidOpts) HasPowerCycle() bool` + +HasPowerCycle returns a boolean if a field has been set. + +### GetType + +`func (o *ConfigureHardwareRaidOpts) GetType() RaidType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ConfigureHardwareRaidOpts) GetTypeOk() (*RaidType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ConfigureHardwareRaidOpts) SetType(v RaidType)` + +SetType sets Type field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/ControlPanel.md b/bmp/docs/ControlPanel.md new file mode 100644 index 0000000..f66177d --- /dev/null +++ b/bmp/docs/ControlPanel.md @@ -0,0 +1,82 @@ +# ControlPanel + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of this control panel | [optional] +**Name** | Pointer to **string** | A human readable name describing the control panel | [optional] + +## Methods + +### NewControlPanel + +`func NewControlPanel() *ControlPanel` + +NewControlPanel instantiates a new ControlPanel object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewControlPanelWithDefaults + +`func NewControlPanelWithDefaults() *ControlPanel` + +NewControlPanelWithDefaults instantiates a new ControlPanel object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *ControlPanel) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ControlPanel) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ControlPanel) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ControlPanel) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *ControlPanel) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *ControlPanel) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *ControlPanel) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *ControlPanel) HasName() bool` + +HasName returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/ControlPanelList.md b/bmp/docs/ControlPanelList.md new file mode 100644 index 0000000..96ae159 --- /dev/null +++ b/bmp/docs/ControlPanelList.md @@ -0,0 +1,82 @@ +# ControlPanelList + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Metadata** | Pointer to [**Metadata**](Metadata.md) | | [optional] +**ControlPanels** | Pointer to [**[]ControlPanel**](ControlPanel.md) | A list of control panels | [optional] + +## Methods + +### NewControlPanelList + +`func NewControlPanelList() *ControlPanelList` + +NewControlPanelList instantiates a new ControlPanelList object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewControlPanelListWithDefaults + +`func NewControlPanelListWithDefaults() *ControlPanelList` + +NewControlPanelListWithDefaults instantiates a new ControlPanelList object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMetadata + +`func (o *ControlPanelList) GetMetadata() Metadata` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *ControlPanelList) GetMetadataOk() (*Metadata, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *ControlPanelList) SetMetadata(v Metadata)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *ControlPanelList) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + +### GetControlPanels + +`func (o *ControlPanelList) GetControlPanels() []ControlPanel` + +GetControlPanels returns the ControlPanels field if non-nil, zero value otherwise. + +### GetControlPanelsOk + +`func (o *ControlPanelList) GetControlPanelsOk() (*[]ControlPanel, bool)` + +GetControlPanelsOk returns a tuple with the ControlPanels field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetControlPanels + +`func (o *ControlPanelList) SetControlPanels(v []ControlPanel)` + +SetControlPanels sets ControlPanels field to given value. + +### HasControlPanels + +`func (o *ControlPanelList) HasControlPanels() bool` + +HasControlPanels returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/CreateNetworkEquipmentCredentialOpts.md b/bmp/docs/CreateNetworkEquipmentCredentialOpts.md new file mode 100644 index 0000000..45f4b27 --- /dev/null +++ b/bmp/docs/CreateNetworkEquipmentCredentialOpts.md @@ -0,0 +1,93 @@ +# CreateNetworkEquipmentCredentialOpts + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Password** | **string** | The password for the credentials | +**Type** | [**CredentialType**](CredentialType.md) | | +**Username** | **string** | The username for the credentials | + +## Methods + +### NewCreateNetworkEquipmentCredentialOpts + +`func NewCreateNetworkEquipmentCredentialOpts(password string, type_ CredentialType, username string, ) *CreateNetworkEquipmentCredentialOpts` + +NewCreateNetworkEquipmentCredentialOpts instantiates a new CreateNetworkEquipmentCredentialOpts object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCreateNetworkEquipmentCredentialOptsWithDefaults + +`func NewCreateNetworkEquipmentCredentialOptsWithDefaults() *CreateNetworkEquipmentCredentialOpts` + +NewCreateNetworkEquipmentCredentialOptsWithDefaults instantiates a new CreateNetworkEquipmentCredentialOpts object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetPassword + +`func (o *CreateNetworkEquipmentCredentialOpts) GetPassword() string` + +GetPassword returns the Password field if non-nil, zero value otherwise. + +### GetPasswordOk + +`func (o *CreateNetworkEquipmentCredentialOpts) GetPasswordOk() (*string, bool)` + +GetPasswordOk returns a tuple with the Password field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPassword + +`func (o *CreateNetworkEquipmentCredentialOpts) SetPassword(v string)` + +SetPassword sets Password field to given value. + + +### GetType + +`func (o *CreateNetworkEquipmentCredentialOpts) GetType() CredentialType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CreateNetworkEquipmentCredentialOpts) GetTypeOk() (*CredentialType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CreateNetworkEquipmentCredentialOpts) SetType(v CredentialType)` + +SetType sets Type field to given value. + + +### GetUsername + +`func (o *CreateNetworkEquipmentCredentialOpts) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *CreateNetworkEquipmentCredentialOpts) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *CreateNetworkEquipmentCredentialOpts) SetUsername(v string)` + +SetUsername sets Username field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/CreateServerCredentialOpts.md b/bmp/docs/CreateServerCredentialOpts.md new file mode 100644 index 0000000..8e09f1b --- /dev/null +++ b/bmp/docs/CreateServerCredentialOpts.md @@ -0,0 +1,93 @@ +# CreateServerCredentialOpts + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Password** | **string** | The password for the credentials | +**Type** | [**CredentialType**](CredentialType.md) | | +**Username** | **string** | The username for the credentials | + +## Methods + +### NewCreateServerCredentialOpts + +`func NewCreateServerCredentialOpts(password string, type_ CredentialType, username string, ) *CreateServerCredentialOpts` + +NewCreateServerCredentialOpts instantiates a new CreateServerCredentialOpts object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCreateServerCredentialOptsWithDefaults + +`func NewCreateServerCredentialOptsWithDefaults() *CreateServerCredentialOpts` + +NewCreateServerCredentialOptsWithDefaults instantiates a new CreateServerCredentialOpts object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetPassword + +`func (o *CreateServerCredentialOpts) GetPassword() string` + +GetPassword returns the Password field if non-nil, zero value otherwise. + +### GetPasswordOk + +`func (o *CreateServerCredentialOpts) GetPasswordOk() (*string, bool)` + +GetPasswordOk returns a tuple with the Password field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPassword + +`func (o *CreateServerCredentialOpts) SetPassword(v string)` + +SetPassword sets Password field to given value. + + +### GetType + +`func (o *CreateServerCredentialOpts) GetType() CredentialType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *CreateServerCredentialOpts) GetTypeOk() (*CredentialType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *CreateServerCredentialOpts) SetType(v CredentialType)` + +SetType sets Type field to given value. + + +### GetUsername + +`func (o *CreateServerCredentialOpts) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *CreateServerCredentialOpts) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *CreateServerCredentialOpts) SetUsername(v string)` + +SetUsername sets Username field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/CreateServerDhcpReservationOpts.md b/bmp/docs/CreateServerDhcpReservationOpts.md new file mode 100644 index 0000000..86c2e60 --- /dev/null +++ b/bmp/docs/CreateServerDhcpReservationOpts.md @@ -0,0 +1,77 @@ +# CreateServerDhcpReservationOpts + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Bootfile** | **string** | The URL of PXE boot you want your server to boot from | +**Hostname** | Pointer to **string** | The hostname for the server | [optional] + +## Methods + +### NewCreateServerDhcpReservationOpts + +`func NewCreateServerDhcpReservationOpts(bootfile string, ) *CreateServerDhcpReservationOpts` + +NewCreateServerDhcpReservationOpts instantiates a new CreateServerDhcpReservationOpts object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCreateServerDhcpReservationOptsWithDefaults + +`func NewCreateServerDhcpReservationOptsWithDefaults() *CreateServerDhcpReservationOpts` + +NewCreateServerDhcpReservationOptsWithDefaults instantiates a new CreateServerDhcpReservationOpts object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetBootfile + +`func (o *CreateServerDhcpReservationOpts) GetBootfile() string` + +GetBootfile returns the Bootfile field if non-nil, zero value otherwise. + +### GetBootfileOk + +`func (o *CreateServerDhcpReservationOpts) GetBootfileOk() (*string, bool)` + +GetBootfileOk returns a tuple with the Bootfile field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBootfile + +`func (o *CreateServerDhcpReservationOpts) SetBootfile(v string)` + +SetBootfile sets Bootfile field to given value. + + +### GetHostname + +`func (o *CreateServerDhcpReservationOpts) GetHostname() string` + +GetHostname returns the Hostname field if non-nil, zero value otherwise. + +### GetHostnameOk + +`func (o *CreateServerDhcpReservationOpts) GetHostnameOk() (*string, bool)` + +GetHostnameOk returns a tuple with the Hostname field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHostname + +`func (o *CreateServerDhcpReservationOpts) SetHostname(v string)` + +SetHostname sets Hostname field to given value. + +### HasHostname + +`func (o *CreateServerDhcpReservationOpts) HasHostname() bool` + +HasHostname returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/Credential.md b/bmp/docs/Credential.md new file mode 100644 index 0000000..ad6279a --- /dev/null +++ b/bmp/docs/Credential.md @@ -0,0 +1,108 @@ +# Credential + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Password** | Pointer to **string** | The password | [optional] +**Type** | Pointer to [**CredentialType**](CredentialType.md) | | [optional] +**Username** | Pointer to **string** | The username | [optional] + +## Methods + +### NewCredential + +`func NewCredential() *Credential` + +NewCredential instantiates a new Credential object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCredentialWithDefaults + +`func NewCredentialWithDefaults() *Credential` + +NewCredentialWithDefaults instantiates a new Credential object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetPassword + +`func (o *Credential) GetPassword() string` + +GetPassword returns the Password field if non-nil, zero value otherwise. + +### GetPasswordOk + +`func (o *Credential) GetPasswordOk() (*string, bool)` + +GetPasswordOk returns a tuple with the Password field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPassword + +`func (o *Credential) SetPassword(v string)` + +SetPassword sets Password field to given value. + +### HasPassword + +`func (o *Credential) HasPassword() bool` + +HasPassword returns a boolean if a field has been set. + +### GetType + +`func (o *Credential) GetType() CredentialType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Credential) GetTypeOk() (*CredentialType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Credential) SetType(v CredentialType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Credential) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetUsername + +`func (o *Credential) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *Credential) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *Credential) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *Credential) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/CredentialList.md b/bmp/docs/CredentialList.md new file mode 100644 index 0000000..eea43ed --- /dev/null +++ b/bmp/docs/CredentialList.md @@ -0,0 +1,82 @@ +# CredentialList + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Metadata** | Pointer to [**Metadata**](Metadata.md) | | [optional] +**Credentials** | Pointer to [**[]Credential**](Credential.md) | An array of credentials | [optional] + +## Methods + +### NewCredentialList + +`func NewCredentialList() *CredentialList` + +NewCredentialList instantiates a new CredentialList object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCredentialListWithDefaults + +`func NewCredentialListWithDefaults() *CredentialList` + +NewCredentialListWithDefaults instantiates a new CredentialList object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMetadata + +`func (o *CredentialList) GetMetadata() Metadata` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *CredentialList) GetMetadataOk() (*Metadata, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *CredentialList) SetMetadata(v Metadata)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *CredentialList) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + +### GetCredentials + +`func (o *CredentialList) GetCredentials() []Credential` + +GetCredentials returns the Credentials field if non-nil, zero value otherwise. + +### GetCredentialsOk + +`func (o *CredentialList) GetCredentialsOk() (*[]Credential, bool)` + +GetCredentialsOk returns a tuple with the Credentials field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentials + +`func (o *CredentialList) SetCredentials(v []Credential)` + +SetCredentials sets Credentials field to given value. + +### HasCredentials + +`func (o *CredentialList) HasCredentials() bool` + +HasCredentials returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/CredentialType.md b/bmp/docs/CredentialType.md new file mode 100644 index 0000000..0d9c895 --- /dev/null +++ b/bmp/docs/CredentialType.md @@ -0,0 +1,25 @@ +# CredentialType + +## Enum + + +* `OPERATING_SYSTEM` (value: `"OPERATING_SYSTEM"`) + +* `CONTROL_PANEL` (value: `"CONTROL_PANEL"`) + +* `REMOTE_MANAGEMENT` (value: `"REMOTE_MANAGEMENT"`) + +* `RESCUE_MODE` (value: `"RESCUE_MODE"`) + +* `SWITCH` (value: `"SWITCH"`) + +* `PDU` (value: `"PDU"`) + +* `FIREWALL` (value: `"FIREWALL"`) + +* `LOAD_BALANCER` (value: `"LOAD_BALANCER"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/Defaults.md b/bmp/docs/Defaults.md new file mode 100644 index 0000000..24a10ac --- /dev/null +++ b/bmp/docs/Defaults.md @@ -0,0 +1,82 @@ +# Defaults + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Device** | Pointer to **string** | Device name | [optional] +**Partitions** | Pointer to [**[]Partition**](Partition.md) | | [optional] + +## Methods + +### NewDefaults + +`func NewDefaults() *Defaults` + +NewDefaults instantiates a new Defaults object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDefaultsWithDefaults + +`func NewDefaultsWithDefaults() *Defaults` + +NewDefaultsWithDefaults instantiates a new Defaults object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDevice + +`func (o *Defaults) GetDevice() string` + +GetDevice returns the Device field if non-nil, zero value otherwise. + +### GetDeviceOk + +`func (o *Defaults) GetDeviceOk() (*string, bool)` + +GetDeviceOk returns a tuple with the Device field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDevice + +`func (o *Defaults) SetDevice(v string)` + +SetDevice sets Device field to given value. + +### HasDevice + +`func (o *Defaults) HasDevice() bool` + +HasDevice returns a boolean if a field has been set. + +### GetPartitions + +`func (o *Defaults) GetPartitions() []Partition` + +GetPartitions returns the Partitions field if non-nil, zero value otherwise. + +### GetPartitionsOk + +`func (o *Defaults) GetPartitionsOk() (*[]Partition, bool)` + +GetPartitionsOk returns a tuple with the Partitions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPartitions + +`func (o *Defaults) SetPartitions(v []Partition)` + +SetPartitions sets Partitions field to given value. + +### HasPartitions + +`func (o *Defaults) HasPartitions() bool` + +HasPartitions returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/EnableServerRescueModeOpts.md b/bmp/docs/EnableServerRescueModeOpts.md new file mode 100644 index 0000000..61d61b2 --- /dev/null +++ b/bmp/docs/EnableServerRescueModeOpts.md @@ -0,0 +1,181 @@ +# EnableServerRescueModeOpts + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CallbackUrl** | Pointer to **string** | Url which will receive callbacks | [optional] +**Password** | Pointer to **string** | Rescue mode password. If not provided, it would be automatically generated | [optional] +**PostInstallScript** | Pointer to **string** | Base64 Encoded string containing a valid bash script to be run right after rescue mode is launched | [optional] +**PowerCycle** | Pointer to **bool** | If set to `true`, server will be power cycled in order to complete the operation | [optional] [default to true] +**RescueImageId** | **string** | Rescue image identifier | [default to "GRML"] +**SshKeys** | Pointer to **string** | User ssh keys | [optional] + +## Methods + +### NewEnableServerRescueModeOpts + +`func NewEnableServerRescueModeOpts(rescueImageId string, ) *EnableServerRescueModeOpts` + +NewEnableServerRescueModeOpts instantiates a new EnableServerRescueModeOpts object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewEnableServerRescueModeOptsWithDefaults + +`func NewEnableServerRescueModeOptsWithDefaults() *EnableServerRescueModeOpts` + +NewEnableServerRescueModeOptsWithDefaults instantiates a new EnableServerRescueModeOpts object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCallbackUrl + +`func (o *EnableServerRescueModeOpts) GetCallbackUrl() string` + +GetCallbackUrl returns the CallbackUrl field if non-nil, zero value otherwise. + +### GetCallbackUrlOk + +`func (o *EnableServerRescueModeOpts) GetCallbackUrlOk() (*string, bool)` + +GetCallbackUrlOk returns a tuple with the CallbackUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCallbackUrl + +`func (o *EnableServerRescueModeOpts) SetCallbackUrl(v string)` + +SetCallbackUrl sets CallbackUrl field to given value. + +### HasCallbackUrl + +`func (o *EnableServerRescueModeOpts) HasCallbackUrl() bool` + +HasCallbackUrl returns a boolean if a field has been set. + +### GetPassword + +`func (o *EnableServerRescueModeOpts) GetPassword() string` + +GetPassword returns the Password field if non-nil, zero value otherwise. + +### GetPasswordOk + +`func (o *EnableServerRescueModeOpts) GetPasswordOk() (*string, bool)` + +GetPasswordOk returns a tuple with the Password field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPassword + +`func (o *EnableServerRescueModeOpts) SetPassword(v string)` + +SetPassword sets Password field to given value. + +### HasPassword + +`func (o *EnableServerRescueModeOpts) HasPassword() bool` + +HasPassword returns a boolean if a field has been set. + +### GetPostInstallScript + +`func (o *EnableServerRescueModeOpts) GetPostInstallScript() string` + +GetPostInstallScript returns the PostInstallScript field if non-nil, zero value otherwise. + +### GetPostInstallScriptOk + +`func (o *EnableServerRescueModeOpts) GetPostInstallScriptOk() (*string, bool)` + +GetPostInstallScriptOk returns a tuple with the PostInstallScript field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPostInstallScript + +`func (o *EnableServerRescueModeOpts) SetPostInstallScript(v string)` + +SetPostInstallScript sets PostInstallScript field to given value. + +### HasPostInstallScript + +`func (o *EnableServerRescueModeOpts) HasPostInstallScript() bool` + +HasPostInstallScript returns a boolean if a field has been set. + +### GetPowerCycle + +`func (o *EnableServerRescueModeOpts) GetPowerCycle() bool` + +GetPowerCycle returns the PowerCycle field if non-nil, zero value otherwise. + +### GetPowerCycleOk + +`func (o *EnableServerRescueModeOpts) GetPowerCycleOk() (*bool, bool)` + +GetPowerCycleOk returns a tuple with the PowerCycle field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPowerCycle + +`func (o *EnableServerRescueModeOpts) SetPowerCycle(v bool)` + +SetPowerCycle sets PowerCycle field to given value. + +### HasPowerCycle + +`func (o *EnableServerRescueModeOpts) HasPowerCycle() bool` + +HasPowerCycle returns a boolean if a field has been set. + +### GetRescueImageId + +`func (o *EnableServerRescueModeOpts) GetRescueImageId() string` + +GetRescueImageId returns the RescueImageId field if non-nil, zero value otherwise. + +### GetRescueImageIdOk + +`func (o *EnableServerRescueModeOpts) GetRescueImageIdOk() (*string, bool)` + +GetRescueImageIdOk returns a tuple with the RescueImageId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRescueImageId + +`func (o *EnableServerRescueModeOpts) SetRescueImageId(v string)` + +SetRescueImageId sets RescueImageId field to given value. + + +### GetSshKeys + +`func (o *EnableServerRescueModeOpts) GetSshKeys() string` + +GetSshKeys returns the SshKeys field if non-nil, zero value otherwise. + +### GetSshKeysOk + +`func (o *EnableServerRescueModeOpts) GetSshKeysOk() (*string, bool)` + +GetSshKeysOk returns a tuple with the SshKeys field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSshKeys + +`func (o *EnableServerRescueModeOpts) SetSshKeys(v string)` + +SetSshKeys sets SshKeys field to given value. + +### HasSshKeys + +`func (o *EnableServerRescueModeOpts) HasSshKeys() bool` + +HasSshKeys returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/ErrorResult.md b/bmp/docs/ErrorResult.md new file mode 100644 index 0000000..af3c285 --- /dev/null +++ b/bmp/docs/ErrorResult.md @@ -0,0 +1,134 @@ +# ErrorResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CorrelationId** | Pointer to **string** | The correlation ID of the current request. | [optional] +**ErrorCode** | Pointer to **string** | The error code. | [optional] +**ErrorMessage** | Pointer to **string** | A human friendly description of the error. | [optional] +**ErrorDetails** | Pointer to [**[]map[string][]string**](map[string][]string.md) | | [optional] + +## Methods + +### NewErrorResult + +`func NewErrorResult() *ErrorResult` + +NewErrorResult instantiates a new ErrorResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewErrorResultWithDefaults + +`func NewErrorResultWithDefaults() *ErrorResult` + +NewErrorResultWithDefaults instantiates a new ErrorResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCorrelationId + +`func (o *ErrorResult) GetCorrelationId() string` + +GetCorrelationId returns the CorrelationId field if non-nil, zero value otherwise. + +### GetCorrelationIdOk + +`func (o *ErrorResult) GetCorrelationIdOk() (*string, bool)` + +GetCorrelationIdOk returns a tuple with the CorrelationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelationId + +`func (o *ErrorResult) SetCorrelationId(v string)` + +SetCorrelationId sets CorrelationId field to given value. + +### HasCorrelationId + +`func (o *ErrorResult) HasCorrelationId() bool` + +HasCorrelationId returns a boolean if a field has been set. + +### GetErrorCode + +`func (o *ErrorResult) GetErrorCode() string` + +GetErrorCode returns the ErrorCode field if non-nil, zero value otherwise. + +### GetErrorCodeOk + +`func (o *ErrorResult) GetErrorCodeOk() (*string, bool)` + +GetErrorCodeOk returns a tuple with the ErrorCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorCode + +`func (o *ErrorResult) SetErrorCode(v string)` + +SetErrorCode sets ErrorCode field to given value. + +### HasErrorCode + +`func (o *ErrorResult) HasErrorCode() bool` + +HasErrorCode returns a boolean if a field has been set. + +### GetErrorMessage + +`func (o *ErrorResult) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *ErrorResult) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *ErrorResult) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *ErrorResult) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### GetErrorDetails + +`func (o *ErrorResult) GetErrorDetails() []map[string][]string` + +GetErrorDetails returns the ErrorDetails field if non-nil, zero value otherwise. + +### GetErrorDetailsOk + +`func (o *ErrorResult) GetErrorDetailsOk() (*[]map[string][]string, bool)` + +GetErrorDetailsOk returns a tuple with the ErrorDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorDetails + +`func (o *ErrorResult) SetErrorDetails(v []map[string][]string)` + +SetErrorDetails sets ErrorDetails field to given value. + +### HasErrorDetails + +`func (o *ErrorResult) HasErrorDetails() bool` + +HasErrorDetails returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/GetNetworkEquipmentPowerStatusResult.md b/bmp/docs/GetNetworkEquipmentPowerStatusResult.md new file mode 100644 index 0000000..8236e72 --- /dev/null +++ b/bmp/docs/GetNetworkEquipmentPowerStatusResult.md @@ -0,0 +1,56 @@ +# GetNetworkEquipmentPowerStatusResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Pdu** | Pointer to [**Pdu**](Pdu.md) | | [optional] + +## Methods + +### NewGetNetworkEquipmentPowerStatusResult + +`func NewGetNetworkEquipmentPowerStatusResult() *GetNetworkEquipmentPowerStatusResult` + +NewGetNetworkEquipmentPowerStatusResult instantiates a new GetNetworkEquipmentPowerStatusResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetNetworkEquipmentPowerStatusResultWithDefaults + +`func NewGetNetworkEquipmentPowerStatusResultWithDefaults() *GetNetworkEquipmentPowerStatusResult` + +NewGetNetworkEquipmentPowerStatusResultWithDefaults instantiates a new GetNetworkEquipmentPowerStatusResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetPdu + +`func (o *GetNetworkEquipmentPowerStatusResult) GetPdu() Pdu` + +GetPdu returns the Pdu field if non-nil, zero value otherwise. + +### GetPduOk + +`func (o *GetNetworkEquipmentPowerStatusResult) GetPduOk() (*Pdu, bool)` + +GetPduOk returns a tuple with the Pdu field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPdu + +`func (o *GetNetworkEquipmentPowerStatusResult) SetPdu(v Pdu)` + +SetPdu sets Pdu field to given value. + +### HasPdu + +`func (o *GetNetworkEquipmentPowerStatusResult) HasPdu() bool` + +HasPdu returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/GetOperatingSystemListResult.md b/bmp/docs/GetOperatingSystemListResult.md new file mode 100644 index 0000000..ba87302 --- /dev/null +++ b/bmp/docs/GetOperatingSystemListResult.md @@ -0,0 +1,82 @@ +# GetOperatingSystemListResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Metadata** | Pointer to [**Metadata**](Metadata.md) | | [optional] +**OperatingSystems** | Pointer to [**[]OperatingSystem**](OperatingSystem.md) | A list of operating systems | [optional] + +## Methods + +### NewGetOperatingSystemListResult + +`func NewGetOperatingSystemListResult() *GetOperatingSystemListResult` + +NewGetOperatingSystemListResult instantiates a new GetOperatingSystemListResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetOperatingSystemListResultWithDefaults + +`func NewGetOperatingSystemListResultWithDefaults() *GetOperatingSystemListResult` + +NewGetOperatingSystemListResultWithDefaults instantiates a new GetOperatingSystemListResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMetadata + +`func (o *GetOperatingSystemListResult) GetMetadata() Metadata` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *GetOperatingSystemListResult) GetMetadataOk() (*Metadata, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *GetOperatingSystemListResult) SetMetadata(v Metadata)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *GetOperatingSystemListResult) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + +### GetOperatingSystems + +`func (o *GetOperatingSystemListResult) GetOperatingSystems() []OperatingSystem` + +GetOperatingSystems returns the OperatingSystems field if non-nil, zero value otherwise. + +### GetOperatingSystemsOk + +`func (o *GetOperatingSystemListResult) GetOperatingSystemsOk() (*[]OperatingSystem, bool)` + +GetOperatingSystemsOk returns a tuple with the OperatingSystems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperatingSystems + +`func (o *GetOperatingSystemListResult) SetOperatingSystems(v []OperatingSystem)` + +SetOperatingSystems sets OperatingSystems field to given value. + +### HasOperatingSystems + +`func (o *GetOperatingSystemListResult) HasOperatingSystems() bool` + +HasOperatingSystems returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/GetOperatingSystemResult.md b/bmp/docs/GetOperatingSystemResult.md new file mode 100644 index 0000000..6dd4b1c --- /dev/null +++ b/bmp/docs/GetOperatingSystemResult.md @@ -0,0 +1,316 @@ +# GetOperatingSystemResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Architecture** | Pointer to **string** | The architecture of the operating system | [optional] +**Configurable** | Pointer to **bool** | If the default options are configurable or not | [optional] +**Defaults** | Pointer to [**Defaults**](Defaults.md) | | [optional] +**Family** | Pointer to **string** | The operating system family | [optional] +**Id** | Pointer to **string** | The operating system ID | [optional] +**Name** | Pointer to **string** | A human readable name for the operating system | [optional] +**Type** | Pointer to **string** | The type of operating system | [optional] +**Version** | Pointer to **string** | The version of the operating system | [optional] +**Features** | Pointer to **[]string** | Operating system features | [optional] +**SupportedFileSystems** | Pointer to **[]string** | Operating system supported file systems | [optional] +**SupportedBootDevices** | Pointer to **[]string** | Operating system supported boot devices | [optional] + +## Methods + +### NewGetOperatingSystemResult + +`func NewGetOperatingSystemResult() *GetOperatingSystemResult` + +NewGetOperatingSystemResult instantiates a new GetOperatingSystemResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetOperatingSystemResultWithDefaults + +`func NewGetOperatingSystemResultWithDefaults() *GetOperatingSystemResult` + +NewGetOperatingSystemResultWithDefaults instantiates a new GetOperatingSystemResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetArchitecture + +`func (o *GetOperatingSystemResult) GetArchitecture() string` + +GetArchitecture returns the Architecture field if non-nil, zero value otherwise. + +### GetArchitectureOk + +`func (o *GetOperatingSystemResult) GetArchitectureOk() (*string, bool)` + +GetArchitectureOk returns a tuple with the Architecture field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetArchitecture + +`func (o *GetOperatingSystemResult) SetArchitecture(v string)` + +SetArchitecture sets Architecture field to given value. + +### HasArchitecture + +`func (o *GetOperatingSystemResult) HasArchitecture() bool` + +HasArchitecture returns a boolean if a field has been set. + +### GetConfigurable + +`func (o *GetOperatingSystemResult) GetConfigurable() bool` + +GetConfigurable returns the Configurable field if non-nil, zero value otherwise. + +### GetConfigurableOk + +`func (o *GetOperatingSystemResult) GetConfigurableOk() (*bool, bool)` + +GetConfigurableOk returns a tuple with the Configurable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetConfigurable + +`func (o *GetOperatingSystemResult) SetConfigurable(v bool)` + +SetConfigurable sets Configurable field to given value. + +### HasConfigurable + +`func (o *GetOperatingSystemResult) HasConfigurable() bool` + +HasConfigurable returns a boolean if a field has been set. + +### GetDefaults + +`func (o *GetOperatingSystemResult) GetDefaults() Defaults` + +GetDefaults returns the Defaults field if non-nil, zero value otherwise. + +### GetDefaultsOk + +`func (o *GetOperatingSystemResult) GetDefaultsOk() (*Defaults, bool)` + +GetDefaultsOk returns a tuple with the Defaults field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDefaults + +`func (o *GetOperatingSystemResult) SetDefaults(v Defaults)` + +SetDefaults sets Defaults field to given value. + +### HasDefaults + +`func (o *GetOperatingSystemResult) HasDefaults() bool` + +HasDefaults returns a boolean if a field has been set. + +### GetFamily + +`func (o *GetOperatingSystemResult) GetFamily() string` + +GetFamily returns the Family field if non-nil, zero value otherwise. + +### GetFamilyOk + +`func (o *GetOperatingSystemResult) GetFamilyOk() (*string, bool)` + +GetFamilyOk returns a tuple with the Family field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFamily + +`func (o *GetOperatingSystemResult) SetFamily(v string)` + +SetFamily sets Family field to given value. + +### HasFamily + +`func (o *GetOperatingSystemResult) HasFamily() bool` + +HasFamily returns a boolean if a field has been set. + +### GetId + +`func (o *GetOperatingSystemResult) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GetOperatingSystemResult) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GetOperatingSystemResult) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *GetOperatingSystemResult) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *GetOperatingSystemResult) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *GetOperatingSystemResult) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *GetOperatingSystemResult) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *GetOperatingSystemResult) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *GetOperatingSystemResult) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *GetOperatingSystemResult) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *GetOperatingSystemResult) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *GetOperatingSystemResult) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetVersion + +`func (o *GetOperatingSystemResult) GetVersion() string` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *GetOperatingSystemResult) GetVersionOk() (*string, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *GetOperatingSystemResult) SetVersion(v string)` + +SetVersion sets Version field to given value. + +### HasVersion + +`func (o *GetOperatingSystemResult) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + +### GetFeatures + +`func (o *GetOperatingSystemResult) GetFeatures() []string` + +GetFeatures returns the Features field if non-nil, zero value otherwise. + +### GetFeaturesOk + +`func (o *GetOperatingSystemResult) GetFeaturesOk() (*[]string, bool)` + +GetFeaturesOk returns a tuple with the Features field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatures + +`func (o *GetOperatingSystemResult) SetFeatures(v []string)` + +SetFeatures sets Features field to given value. + +### HasFeatures + +`func (o *GetOperatingSystemResult) HasFeatures() bool` + +HasFeatures returns a boolean if a field has been set. + +### GetSupportedFileSystems + +`func (o *GetOperatingSystemResult) GetSupportedFileSystems() []string` + +GetSupportedFileSystems returns the SupportedFileSystems field if non-nil, zero value otherwise. + +### GetSupportedFileSystemsOk + +`func (o *GetOperatingSystemResult) GetSupportedFileSystemsOk() (*[]string, bool)` + +GetSupportedFileSystemsOk returns a tuple with the SupportedFileSystems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedFileSystems + +`func (o *GetOperatingSystemResult) SetSupportedFileSystems(v []string)` + +SetSupportedFileSystems sets SupportedFileSystems field to given value. + +### HasSupportedFileSystems + +`func (o *GetOperatingSystemResult) HasSupportedFileSystems() bool` + +HasSupportedFileSystems returns a boolean if a field has been set. + +### GetSupportedBootDevices + +`func (o *GetOperatingSystemResult) GetSupportedBootDevices() []string` + +GetSupportedBootDevices returns the SupportedBootDevices field if non-nil, zero value otherwise. + +### GetSupportedBootDevicesOk + +`func (o *GetOperatingSystemResult) GetSupportedBootDevicesOk() (*[]string, bool)` + +GetSupportedBootDevicesOk returns a tuple with the SupportedBootDevices field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSupportedBootDevices + +`func (o *GetOperatingSystemResult) SetSupportedBootDevices(v []string)` + +SetSupportedBootDevices sets SupportedBootDevices field to given value. + +### HasSupportedBootDevices + +`func (o *GetOperatingSystemResult) HasSupportedBootDevices() bool` + +HasSupportedBootDevices returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/GetRescueImageListResult.md b/bmp/docs/GetRescueImageListResult.md new file mode 100644 index 0000000..1c768e6 --- /dev/null +++ b/bmp/docs/GetRescueImageListResult.md @@ -0,0 +1,82 @@ +# GetRescueImageListResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Metadata** | Pointer to [**Metadata**](Metadata.md) | | [optional] +**RescueImages** | Pointer to [**[]RescueImage**](RescueImage.md) | A list of operating systems | [optional] + +## Methods + +### NewGetRescueImageListResult + +`func NewGetRescueImageListResult() *GetRescueImageListResult` + +NewGetRescueImageListResult instantiates a new GetRescueImageListResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetRescueImageListResultWithDefaults + +`func NewGetRescueImageListResultWithDefaults() *GetRescueImageListResult` + +NewGetRescueImageListResultWithDefaults instantiates a new GetRescueImageListResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMetadata + +`func (o *GetRescueImageListResult) GetMetadata() Metadata` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *GetRescueImageListResult) GetMetadataOk() (*Metadata, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *GetRescueImageListResult) SetMetadata(v Metadata)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *GetRescueImageListResult) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + +### GetRescueImages + +`func (o *GetRescueImageListResult) GetRescueImages() []RescueImage` + +GetRescueImages returns the RescueImages field if non-nil, zero value otherwise. + +### GetRescueImagesOk + +`func (o *GetRescueImageListResult) GetRescueImagesOk() (*[]RescueImage, bool)` + +GetRescueImagesOk returns a tuple with the RescueImages field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRescueImages + +`func (o *GetRescueImageListResult) SetRescueImages(v []RescueImage)` + +SetRescueImages sets RescueImages field to given value. + +### HasRescueImages + +`func (o *GetRescueImageListResult) HasRescueImages() bool` + +HasRescueImages returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/GetServerDhcpReservationListResult.md b/bmp/docs/GetServerDhcpReservationListResult.md new file mode 100644 index 0000000..b2f4d32 --- /dev/null +++ b/bmp/docs/GetServerDhcpReservationListResult.md @@ -0,0 +1,82 @@ +# GetServerDhcpReservationListResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Metadata** | Pointer to [**Metadata**](Metadata.md) | | [optional] +**Leases** | Pointer to [**[]Lease**](Lease.md) | An array of active DHCP reservations | [optional] + +## Methods + +### NewGetServerDhcpReservationListResult + +`func NewGetServerDhcpReservationListResult() *GetServerDhcpReservationListResult` + +NewGetServerDhcpReservationListResult instantiates a new GetServerDhcpReservationListResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetServerDhcpReservationListResultWithDefaults + +`func NewGetServerDhcpReservationListResultWithDefaults() *GetServerDhcpReservationListResult` + +NewGetServerDhcpReservationListResultWithDefaults instantiates a new GetServerDhcpReservationListResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMetadata + +`func (o *GetServerDhcpReservationListResult) GetMetadata() Metadata` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *GetServerDhcpReservationListResult) GetMetadataOk() (*Metadata, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *GetServerDhcpReservationListResult) SetMetadata(v Metadata)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *GetServerDhcpReservationListResult) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + +### GetLeases + +`func (o *GetServerDhcpReservationListResult) GetLeases() []Lease` + +GetLeases returns the Leases field if non-nil, zero value otherwise. + +### GetLeasesOk + +`func (o *GetServerDhcpReservationListResult) GetLeasesOk() (*[]Lease, bool)` + +GetLeasesOk returns a tuple with the Leases field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLeases + +`func (o *GetServerDhcpReservationListResult) SetLeases(v []Lease)` + +SetLeases sets Leases field to given value. + +### HasLeases + +`func (o *GetServerDhcpReservationListResult) HasLeases() bool` + +HasLeases returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/GetServerPowerStatusResult.md b/bmp/docs/GetServerPowerStatusResult.md new file mode 100644 index 0000000..6e131f5 --- /dev/null +++ b/bmp/docs/GetServerPowerStatusResult.md @@ -0,0 +1,82 @@ +# GetServerPowerStatusResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ipmi** | Pointer to [**Ipmi**](Ipmi.md) | | [optional] +**Pdu** | Pointer to [**Pdu**](Pdu.md) | | [optional] + +## Methods + +### NewGetServerPowerStatusResult + +`func NewGetServerPowerStatusResult() *GetServerPowerStatusResult` + +NewGetServerPowerStatusResult instantiates a new GetServerPowerStatusResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetServerPowerStatusResultWithDefaults + +`func NewGetServerPowerStatusResultWithDefaults() *GetServerPowerStatusResult` + +NewGetServerPowerStatusResultWithDefaults instantiates a new GetServerPowerStatusResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetIpmi + +`func (o *GetServerPowerStatusResult) GetIpmi() Ipmi` + +GetIpmi returns the Ipmi field if non-nil, zero value otherwise. + +### GetIpmiOk + +`func (o *GetServerPowerStatusResult) GetIpmiOk() (*Ipmi, bool)` + +GetIpmiOk returns a tuple with the Ipmi field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIpmi + +`func (o *GetServerPowerStatusResult) SetIpmi(v Ipmi)` + +SetIpmi sets Ipmi field to given value. + +### HasIpmi + +`func (o *GetServerPowerStatusResult) HasIpmi() bool` + +HasIpmi returns a boolean if a field has been set. + +### GetPdu + +`func (o *GetServerPowerStatusResult) GetPdu() Pdu` + +GetPdu returns the Pdu field if non-nil, zero value otherwise. + +### GetPduOk + +`func (o *GetServerPowerStatusResult) GetPduOk() (*Pdu, bool)` + +GetPduOk returns a tuple with the Pdu field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPdu + +`func (o *GetServerPowerStatusResult) SetPdu(v Pdu)` + +SetPdu sets Pdu field to given value. + +### HasPdu + +`func (o *GetServerPowerStatusResult) HasPdu() bool` + +HasPdu returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/InstallOperatingSystemOpts.md b/bmp/docs/InstallOperatingSystemOpts.md new file mode 100644 index 0000000..c4eec87 --- /dev/null +++ b/bmp/docs/InstallOperatingSystemOpts.md @@ -0,0 +1,337 @@ +# InstallOperatingSystemOpts + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CallbackUrl** | Pointer to **string** | Url which will receive callbacks when the installation is finished or failed | [optional] +**ControlPanelId** | Pointer to **string** | Control panel identifier | [optional] +**Device** | Pointer to **string** | Block devices in a disk set in which the partitions will be installed. Supported values are any disk set id, SATA_SAS or NVME | [optional] +**Hostname** | Pointer to **string** | Hostname to be used in your installation | [optional] +**OperatingSystemId** | **string** | Operating system identifier | +**Partitions** | Pointer to [**[]Partition**](Partition.md) | Array of partition objects that should be installed per partition | [optional] +**Password** | Pointer to **string** | Server root password. If not provided, it would be automatically generated | [optional] +**PostInstallScript** | Pointer to **string** | Base64 Encoded string containing a valid bash script to be run right after the installation | [optional] +**PowerCycle** | Pointer to **bool** | If true, allows system reboots to happen automatically within the process. Otherwise, you should do them manually | [optional] +**Raid** | Pointer to [**Raid**](Raid.md) | | [optional] +**SshKeys** | Pointer to **string** | List of public sshKeys to be setup in your installation, separated by new lines | [optional] +**Timezone** | Pointer to **string** | Timezone represented as Geographical_Area/City | [optional] + +## Methods + +### NewInstallOperatingSystemOpts + +`func NewInstallOperatingSystemOpts(operatingSystemId string, ) *InstallOperatingSystemOpts` + +NewInstallOperatingSystemOpts instantiates a new InstallOperatingSystemOpts object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewInstallOperatingSystemOptsWithDefaults + +`func NewInstallOperatingSystemOptsWithDefaults() *InstallOperatingSystemOpts` + +NewInstallOperatingSystemOptsWithDefaults instantiates a new InstallOperatingSystemOpts object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCallbackUrl + +`func (o *InstallOperatingSystemOpts) GetCallbackUrl() string` + +GetCallbackUrl returns the CallbackUrl field if non-nil, zero value otherwise. + +### GetCallbackUrlOk + +`func (o *InstallOperatingSystemOpts) GetCallbackUrlOk() (*string, bool)` + +GetCallbackUrlOk returns a tuple with the CallbackUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCallbackUrl + +`func (o *InstallOperatingSystemOpts) SetCallbackUrl(v string)` + +SetCallbackUrl sets CallbackUrl field to given value. + +### HasCallbackUrl + +`func (o *InstallOperatingSystemOpts) HasCallbackUrl() bool` + +HasCallbackUrl returns a boolean if a field has been set. + +### GetControlPanelId + +`func (o *InstallOperatingSystemOpts) GetControlPanelId() string` + +GetControlPanelId returns the ControlPanelId field if non-nil, zero value otherwise. + +### GetControlPanelIdOk + +`func (o *InstallOperatingSystemOpts) GetControlPanelIdOk() (*string, bool)` + +GetControlPanelIdOk returns a tuple with the ControlPanelId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetControlPanelId + +`func (o *InstallOperatingSystemOpts) SetControlPanelId(v string)` + +SetControlPanelId sets ControlPanelId field to given value. + +### HasControlPanelId + +`func (o *InstallOperatingSystemOpts) HasControlPanelId() bool` + +HasControlPanelId returns a boolean if a field has been set. + +### GetDevice + +`func (o *InstallOperatingSystemOpts) GetDevice() string` + +GetDevice returns the Device field if non-nil, zero value otherwise. + +### GetDeviceOk + +`func (o *InstallOperatingSystemOpts) GetDeviceOk() (*string, bool)` + +GetDeviceOk returns a tuple with the Device field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDevice + +`func (o *InstallOperatingSystemOpts) SetDevice(v string)` + +SetDevice sets Device field to given value. + +### HasDevice + +`func (o *InstallOperatingSystemOpts) HasDevice() bool` + +HasDevice returns a boolean if a field has been set. + +### GetHostname + +`func (o *InstallOperatingSystemOpts) GetHostname() string` + +GetHostname returns the Hostname field if non-nil, zero value otherwise. + +### GetHostnameOk + +`func (o *InstallOperatingSystemOpts) GetHostnameOk() (*string, bool)` + +GetHostnameOk returns a tuple with the Hostname field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHostname + +`func (o *InstallOperatingSystemOpts) SetHostname(v string)` + +SetHostname sets Hostname field to given value. + +### HasHostname + +`func (o *InstallOperatingSystemOpts) HasHostname() bool` + +HasHostname returns a boolean if a field has been set. + +### GetOperatingSystemId + +`func (o *InstallOperatingSystemOpts) GetOperatingSystemId() string` + +GetOperatingSystemId returns the OperatingSystemId field if non-nil, zero value otherwise. + +### GetOperatingSystemIdOk + +`func (o *InstallOperatingSystemOpts) GetOperatingSystemIdOk() (*string, bool)` + +GetOperatingSystemIdOk returns a tuple with the OperatingSystemId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperatingSystemId + +`func (o *InstallOperatingSystemOpts) SetOperatingSystemId(v string)` + +SetOperatingSystemId sets OperatingSystemId field to given value. + + +### GetPartitions + +`func (o *InstallOperatingSystemOpts) GetPartitions() []Partition` + +GetPartitions returns the Partitions field if non-nil, zero value otherwise. + +### GetPartitionsOk + +`func (o *InstallOperatingSystemOpts) GetPartitionsOk() (*[]Partition, bool)` + +GetPartitionsOk returns a tuple with the Partitions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPartitions + +`func (o *InstallOperatingSystemOpts) SetPartitions(v []Partition)` + +SetPartitions sets Partitions field to given value. + +### HasPartitions + +`func (o *InstallOperatingSystemOpts) HasPartitions() bool` + +HasPartitions returns a boolean if a field has been set. + +### GetPassword + +`func (o *InstallOperatingSystemOpts) GetPassword() string` + +GetPassword returns the Password field if non-nil, zero value otherwise. + +### GetPasswordOk + +`func (o *InstallOperatingSystemOpts) GetPasswordOk() (*string, bool)` + +GetPasswordOk returns a tuple with the Password field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPassword + +`func (o *InstallOperatingSystemOpts) SetPassword(v string)` + +SetPassword sets Password field to given value. + +### HasPassword + +`func (o *InstallOperatingSystemOpts) HasPassword() bool` + +HasPassword returns a boolean if a field has been set. + +### GetPostInstallScript + +`func (o *InstallOperatingSystemOpts) GetPostInstallScript() string` + +GetPostInstallScript returns the PostInstallScript field if non-nil, zero value otherwise. + +### GetPostInstallScriptOk + +`func (o *InstallOperatingSystemOpts) GetPostInstallScriptOk() (*string, bool)` + +GetPostInstallScriptOk returns a tuple with the PostInstallScript field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPostInstallScript + +`func (o *InstallOperatingSystemOpts) SetPostInstallScript(v string)` + +SetPostInstallScript sets PostInstallScript field to given value. + +### HasPostInstallScript + +`func (o *InstallOperatingSystemOpts) HasPostInstallScript() bool` + +HasPostInstallScript returns a boolean if a field has been set. + +### GetPowerCycle + +`func (o *InstallOperatingSystemOpts) GetPowerCycle() bool` + +GetPowerCycle returns the PowerCycle field if non-nil, zero value otherwise. + +### GetPowerCycleOk + +`func (o *InstallOperatingSystemOpts) GetPowerCycleOk() (*bool, bool)` + +GetPowerCycleOk returns a tuple with the PowerCycle field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPowerCycle + +`func (o *InstallOperatingSystemOpts) SetPowerCycle(v bool)` + +SetPowerCycle sets PowerCycle field to given value. + +### HasPowerCycle + +`func (o *InstallOperatingSystemOpts) HasPowerCycle() bool` + +HasPowerCycle returns a boolean if a field has been set. + +### GetRaid + +`func (o *InstallOperatingSystemOpts) GetRaid() Raid` + +GetRaid returns the Raid field if non-nil, zero value otherwise. + +### GetRaidOk + +`func (o *InstallOperatingSystemOpts) GetRaidOk() (*Raid, bool)` + +GetRaidOk returns a tuple with the Raid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRaid + +`func (o *InstallOperatingSystemOpts) SetRaid(v Raid)` + +SetRaid sets Raid field to given value. + +### HasRaid + +`func (o *InstallOperatingSystemOpts) HasRaid() bool` + +HasRaid returns a boolean if a field has been set. + +### GetSshKeys + +`func (o *InstallOperatingSystemOpts) GetSshKeys() string` + +GetSshKeys returns the SshKeys field if non-nil, zero value otherwise. + +### GetSshKeysOk + +`func (o *InstallOperatingSystemOpts) GetSshKeysOk() (*string, bool)` + +GetSshKeysOk returns a tuple with the SshKeys field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSshKeys + +`func (o *InstallOperatingSystemOpts) SetSshKeys(v string)` + +SetSshKeys sets SshKeys field to given value. + +### HasSshKeys + +`func (o *InstallOperatingSystemOpts) HasSshKeys() bool` + +HasSshKeys returns a boolean if a field has been set. + +### GetTimezone + +`func (o *InstallOperatingSystemOpts) GetTimezone() string` + +GetTimezone returns the Timezone field if non-nil, zero value otherwise. + +### GetTimezoneOk + +`func (o *InstallOperatingSystemOpts) GetTimezoneOk() (*string, bool)` + +GetTimezoneOk returns a tuple with the Timezone field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimezone + +`func (o *InstallOperatingSystemOpts) SetTimezone(v string)` + +SetTimezone sets Timezone field to given value. + +### HasTimezone + +`func (o *InstallOperatingSystemOpts) HasTimezone() bool` + +HasTimezone returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/Ipmi.md b/bmp/docs/Ipmi.md new file mode 100644 index 0000000..2ceb040 --- /dev/null +++ b/bmp/docs/Ipmi.md @@ -0,0 +1,56 @@ +# Ipmi + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Status** | Pointer to **string** | The current power status of the server. | [optional] + +## Methods + +### NewIpmi + +`func NewIpmi() *Ipmi` + +NewIpmi instantiates a new Ipmi object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewIpmiWithDefaults + +`func NewIpmiWithDefaults() *Ipmi` + +NewIpmiWithDefaults instantiates a new Ipmi object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetStatus + +`func (o *Ipmi) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *Ipmi) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *Ipmi) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *Ipmi) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/IpmiResetServerOpts.md b/bmp/docs/IpmiResetServerOpts.md new file mode 100644 index 0000000..c124e54 --- /dev/null +++ b/bmp/docs/IpmiResetServerOpts.md @@ -0,0 +1,82 @@ +# IpmiResetServerOpts + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CallbackUrl** | Pointer to **string** | Url which will receive callbacks | [optional] +**PowerCycle** | Pointer to **bool** | If set to `true`, server will be power cycled in order to complete the operation | [optional] [default to true] + +## Methods + +### NewIpmiResetServerOpts + +`func NewIpmiResetServerOpts() *IpmiResetServerOpts` + +NewIpmiResetServerOpts instantiates a new IpmiResetServerOpts object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewIpmiResetServerOptsWithDefaults + +`func NewIpmiResetServerOptsWithDefaults() *IpmiResetServerOpts` + +NewIpmiResetServerOptsWithDefaults instantiates a new IpmiResetServerOpts object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCallbackUrl + +`func (o *IpmiResetServerOpts) GetCallbackUrl() string` + +GetCallbackUrl returns the CallbackUrl field if non-nil, zero value otherwise. + +### GetCallbackUrlOk + +`func (o *IpmiResetServerOpts) GetCallbackUrlOk() (*string, bool)` + +GetCallbackUrlOk returns a tuple with the CallbackUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCallbackUrl + +`func (o *IpmiResetServerOpts) SetCallbackUrl(v string)` + +SetCallbackUrl sets CallbackUrl field to given value. + +### HasCallbackUrl + +`func (o *IpmiResetServerOpts) HasCallbackUrl() bool` + +HasCallbackUrl returns a boolean if a field has been set. + +### GetPowerCycle + +`func (o *IpmiResetServerOpts) GetPowerCycle() bool` + +GetPowerCycle returns the PowerCycle field if non-nil, zero value otherwise. + +### GetPowerCycleOk + +`func (o *IpmiResetServerOpts) GetPowerCycleOk() (*bool, bool)` + +GetPowerCycleOk returns a tuple with the PowerCycle field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPowerCycle + +`func (o *IpmiResetServerOpts) SetPowerCycle(v bool)` + +SetPowerCycle sets PowerCycle field to given value. + +### HasPowerCycle + +`func (o *IpmiResetServerOpts) HasPowerCycle() bool` + +HasPowerCycle returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/LastClientRequest.md b/bmp/docs/LastClientRequest.md new file mode 100644 index 0000000..d644289 --- /dev/null +++ b/bmp/docs/LastClientRequest.md @@ -0,0 +1,118 @@ +# LastClientRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RelayAgent** | Pointer to **NullableString** | The relay agent that forwarded the DHCP traffic | [optional] +**Type** | Pointer to **string** | The type of DHCP packet requested by the client | [optional] +**UserAgent** | Pointer to **string** | The user agent of the client making the DHCP request | [optional] + +## Methods + +### NewLastClientRequest + +`func NewLastClientRequest() *LastClientRequest` + +NewLastClientRequest instantiates a new LastClientRequest object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewLastClientRequestWithDefaults + +`func NewLastClientRequestWithDefaults() *LastClientRequest` + +NewLastClientRequestWithDefaults instantiates a new LastClientRequest object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetRelayAgent + +`func (o *LastClientRequest) GetRelayAgent() string` + +GetRelayAgent returns the RelayAgent field if non-nil, zero value otherwise. + +### GetRelayAgentOk + +`func (o *LastClientRequest) GetRelayAgentOk() (*string, bool)` + +GetRelayAgentOk returns a tuple with the RelayAgent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRelayAgent + +`func (o *LastClientRequest) SetRelayAgent(v string)` + +SetRelayAgent sets RelayAgent field to given value. + +### HasRelayAgent + +`func (o *LastClientRequest) HasRelayAgent() bool` + +HasRelayAgent returns a boolean if a field has been set. + +### SetRelayAgentNil + +`func (o *LastClientRequest) SetRelayAgentNil(b bool)` + + SetRelayAgentNil sets the value for RelayAgent to be an explicit nil + +### UnsetRelayAgent +`func (o *LastClientRequest) UnsetRelayAgent()` + +UnsetRelayAgent ensures that no value is present for RelayAgent, not even an explicit nil +### GetType + +`func (o *LastClientRequest) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *LastClientRequest) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *LastClientRequest) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *LastClientRequest) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetUserAgent + +`func (o *LastClientRequest) GetUserAgent() string` + +GetUserAgent returns the UserAgent field if non-nil, zero value otherwise. + +### GetUserAgentOk + +`func (o *LastClientRequest) GetUserAgentOk() (*string, bool)` + +GetUserAgentOk returns a tuple with the UserAgent field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUserAgent + +`func (o *LastClientRequest) SetUserAgent(v string)` + +SetUserAgent sets UserAgent field to given value. + +### HasUserAgent + +`func (o *LastClientRequest) HasUserAgent() bool` + +HasUserAgent returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/Lease.md b/bmp/docs/Lease.md new file mode 100644 index 0000000..f3b8c57 --- /dev/null +++ b/bmp/docs/Lease.md @@ -0,0 +1,290 @@ +# Lease + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Bootfile** | Pointer to **string** | The PXE bootfile the server will network boot from | [optional] +**CreatedAt** | Pointer to **string** | The time when the DHCP reservation was created | [optional] +**Gateway** | Pointer to **string** | The gateway for this DHCP reservation | [optional] +**Hostname** | Pointer to **string** | The hostname for the server | [optional] +**Ip** | Pointer to **string** | The IP address this DHCP reservation is for | [optional] +**LastClientRequest** | Pointer to [**LastClientRequest**](LastClientRequest.md) | | [optional] +**Mac** | Pointer to **string** | The MAC address this DHCP reservation is for | [optional] +**Netmask** | Pointer to **string** | The netmask for this DHCP reservation | [optional] +**Site** | Pointer to **string** | The site serving this DHCP reservation | [optional] +**UpdatedAt** | Pointer to **string** | The time when the DHCP reservation was last updated or used by a client | [optional] + +## Methods + +### NewLease + +`func NewLease() *Lease` + +NewLease instantiates a new Lease object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewLeaseWithDefaults + +`func NewLeaseWithDefaults() *Lease` + +NewLeaseWithDefaults instantiates a new Lease object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetBootfile + +`func (o *Lease) GetBootfile() string` + +GetBootfile returns the Bootfile field if non-nil, zero value otherwise. + +### GetBootfileOk + +`func (o *Lease) GetBootfileOk() (*string, bool)` + +GetBootfileOk returns a tuple with the Bootfile field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBootfile + +`func (o *Lease) SetBootfile(v string)` + +SetBootfile sets Bootfile field to given value. + +### HasBootfile + +`func (o *Lease) HasBootfile() bool` + +HasBootfile returns a boolean if a field has been set. + +### GetCreatedAt + +`func (o *Lease) GetCreatedAt() string` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *Lease) GetCreatedAtOk() (*string, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *Lease) SetCreatedAt(v string)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *Lease) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### GetGateway + +`func (o *Lease) GetGateway() string` + +GetGateway returns the Gateway field if non-nil, zero value otherwise. + +### GetGatewayOk + +`func (o *Lease) GetGatewayOk() (*string, bool)` + +GetGatewayOk returns a tuple with the Gateway field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGateway + +`func (o *Lease) SetGateway(v string)` + +SetGateway sets Gateway field to given value. + +### HasGateway + +`func (o *Lease) HasGateway() bool` + +HasGateway returns a boolean if a field has been set. + +### GetHostname + +`func (o *Lease) GetHostname() string` + +GetHostname returns the Hostname field if non-nil, zero value otherwise. + +### GetHostnameOk + +`func (o *Lease) GetHostnameOk() (*string, bool)` + +GetHostnameOk returns a tuple with the Hostname field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHostname + +`func (o *Lease) SetHostname(v string)` + +SetHostname sets Hostname field to given value. + +### HasHostname + +`func (o *Lease) HasHostname() bool` + +HasHostname returns a boolean if a field has been set. + +### GetIp + +`func (o *Lease) GetIp() string` + +GetIp returns the Ip field if non-nil, zero value otherwise. + +### GetIpOk + +`func (o *Lease) GetIpOk() (*string, bool)` + +GetIpOk returns a tuple with the Ip field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIp + +`func (o *Lease) SetIp(v string)` + +SetIp sets Ip field to given value. + +### HasIp + +`func (o *Lease) HasIp() bool` + +HasIp returns a boolean if a field has been set. + +### GetLastClientRequest + +`func (o *Lease) GetLastClientRequest() LastClientRequest` + +GetLastClientRequest returns the LastClientRequest field if non-nil, zero value otherwise. + +### GetLastClientRequestOk + +`func (o *Lease) GetLastClientRequestOk() (*LastClientRequest, bool)` + +GetLastClientRequestOk returns a tuple with the LastClientRequest field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastClientRequest + +`func (o *Lease) SetLastClientRequest(v LastClientRequest)` + +SetLastClientRequest sets LastClientRequest field to given value. + +### HasLastClientRequest + +`func (o *Lease) HasLastClientRequest() bool` + +HasLastClientRequest returns a boolean if a field has been set. + +### GetMac + +`func (o *Lease) GetMac() string` + +GetMac returns the Mac field if non-nil, zero value otherwise. + +### GetMacOk + +`func (o *Lease) GetMacOk() (*string, bool)` + +GetMacOk returns a tuple with the Mac field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMac + +`func (o *Lease) SetMac(v string)` + +SetMac sets Mac field to given value. + +### HasMac + +`func (o *Lease) HasMac() bool` + +HasMac returns a boolean if a field has been set. + +### GetNetmask + +`func (o *Lease) GetNetmask() string` + +GetNetmask returns the Netmask field if non-nil, zero value otherwise. + +### GetNetmaskOk + +`func (o *Lease) GetNetmaskOk() (*string, bool)` + +GetNetmaskOk returns a tuple with the Netmask field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNetmask + +`func (o *Lease) SetNetmask(v string)` + +SetNetmask sets Netmask field to given value. + +### HasNetmask + +`func (o *Lease) HasNetmask() bool` + +HasNetmask returns a boolean if a field has been set. + +### GetSite + +`func (o *Lease) GetSite() string` + +GetSite returns the Site field if non-nil, zero value otherwise. + +### GetSiteOk + +`func (o *Lease) GetSiteOk() (*string, bool)` + +GetSiteOk returns a tuple with the Site field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSite + +`func (o *Lease) SetSite(v string)` + +SetSite sets Site field to given value. + +### HasSite + +`func (o *Lease) HasSite() bool` + +HasSite returns a boolean if a field has been set. + +### GetUpdatedAt + +`func (o *Lease) GetUpdatedAt() string` + +GetUpdatedAt returns the UpdatedAt field if non-nil, zero value otherwise. + +### GetUpdatedAtOk + +`func (o *Lease) GetUpdatedAtOk() (*string, bool)` + +GetUpdatedAtOk returns a tuple with the UpdatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdatedAt + +`func (o *Lease) SetUpdatedAt(v string)` + +SetUpdatedAt sets UpdatedAt field to given value. + +### HasUpdatedAt + +`func (o *Lease) HasUpdatedAt() bool` + +HasUpdatedAt returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/Metadata.md b/bmp/docs/Metadata.md new file mode 100644 index 0000000..e0117d3 --- /dev/null +++ b/bmp/docs/Metadata.md @@ -0,0 +1,56 @@ +# Metadata + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BATCH_ID** | Pointer to **string** | Batch ID for batch jobs | [optional] + +## Methods + +### NewMetadata + +`func NewMetadata() *Metadata` + +NewMetadata instantiates a new Metadata object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewMetadataWithDefaults + +`func NewMetadataWithDefaults() *Metadata` + +NewMetadataWithDefaults instantiates a new Metadata object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetBATCH_ID + +`func (o *Metadata) GetBATCH_ID() string` + +GetBATCH_ID returns the BATCH_ID field if non-nil, zero value otherwise. + +### GetBATCH_IDOk + +`func (o *Metadata) GetBATCH_IDOk() (*string, bool)` + +GetBATCH_IDOk returns a tuple with the BATCH_ID field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBATCH_ID + +`func (o *Metadata) SetBATCH_ID(v string)` + +SetBATCH_ID sets BATCH_ID field to given value. + +### HasBATCH_ID + +`func (o *Metadata) HasBATCH_ID() bool` + +HasBATCH_ID returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/OperatingSystem.md b/bmp/docs/OperatingSystem.md new file mode 100644 index 0000000..2497e10 --- /dev/null +++ b/bmp/docs/OperatingSystem.md @@ -0,0 +1,82 @@ +# OperatingSystem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of this operating system | [optional] +**Name** | Pointer to **string** | A human readable name describing the operating system | [optional] + +## Methods + +### NewOperatingSystem + +`func NewOperatingSystem() *OperatingSystem` + +NewOperatingSystem instantiates a new OperatingSystem object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewOperatingSystemWithDefaults + +`func NewOperatingSystemWithDefaults() *OperatingSystem` + +NewOperatingSystemWithDefaults instantiates a new OperatingSystem object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *OperatingSystem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *OperatingSystem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *OperatingSystem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *OperatingSystem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *OperatingSystem) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *OperatingSystem) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *OperatingSystem) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *OperatingSystem) HasName() bool` + +HasName returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/Partition.md b/bmp/docs/Partition.md new file mode 100644 index 0000000..efbb070 --- /dev/null +++ b/bmp/docs/Partition.md @@ -0,0 +1,108 @@ +# Partition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Filesystem** | Pointer to **string** | File system in which partition would be mounted | [optional] +**Mountpoint** | Pointer to **string** | The partition mount point (eg `/home`). Mandatory for the root partition (`/`) and not intended to be used in swap partition | [optional] +**Size** | Pointer to **string** | Size of the partition (Normally in MB, but this is OS-specific) | [optional] + +## Methods + +### NewPartition + +`func NewPartition() *Partition` + +NewPartition instantiates a new Partition object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPartitionWithDefaults + +`func NewPartitionWithDefaults() *Partition` + +NewPartitionWithDefaults instantiates a new Partition object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetFilesystem + +`func (o *Partition) GetFilesystem() string` + +GetFilesystem returns the Filesystem field if non-nil, zero value otherwise. + +### GetFilesystemOk + +`func (o *Partition) GetFilesystemOk() (*string, bool)` + +GetFilesystemOk returns a tuple with the Filesystem field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFilesystem + +`func (o *Partition) SetFilesystem(v string)` + +SetFilesystem sets Filesystem field to given value. + +### HasFilesystem + +`func (o *Partition) HasFilesystem() bool` + +HasFilesystem returns a boolean if a field has been set. + +### GetMountpoint + +`func (o *Partition) GetMountpoint() string` + +GetMountpoint returns the Mountpoint field if non-nil, zero value otherwise. + +### GetMountpointOk + +`func (o *Partition) GetMountpointOk() (*string, bool)` + +GetMountpointOk returns a tuple with the Mountpoint field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMountpoint + +`func (o *Partition) SetMountpoint(v string)` + +SetMountpoint sets Mountpoint field to given value. + +### HasMountpoint + +`func (o *Partition) HasMountpoint() bool` + +HasMountpoint returns a boolean if a field has been set. + +### GetSize + +`func (o *Partition) GetSize() string` + +GetSize returns the Size field if non-nil, zero value otherwise. + +### GetSizeOk + +`func (o *Partition) GetSizeOk() (*string, bool)` + +GetSizeOk returns a tuple with the Size field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSize + +`func (o *Partition) SetSize(v string)` + +SetSize sets Size field to given value. + +### HasSize + +`func (o *Partition) HasSize() bool` + +HasSize returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/Pdu.md b/bmp/docs/Pdu.md new file mode 100644 index 0000000..279a3a5 --- /dev/null +++ b/bmp/docs/Pdu.md @@ -0,0 +1,56 @@ +# Pdu + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Status** | Pointer to **string** | The current power status of the network equipment. | [optional] + +## Methods + +### NewPdu + +`func NewPdu() *Pdu` + +NewPdu instantiates a new Pdu object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPduWithDefaults + +`func NewPduWithDefaults() *Pdu` + +NewPduWithDefaults instantiates a new Pdu object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetStatus + +`func (o *Pdu) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *Pdu) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *Pdu) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *Pdu) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/Raid.md b/bmp/docs/Raid.md new file mode 100644 index 0000000..feed30a --- /dev/null +++ b/bmp/docs/Raid.md @@ -0,0 +1,108 @@ +# Raid + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Level** | Pointer to **int32** | RAID level to apply to your installation, this value is only required if you specify a type HW or SW | [optional] +**NumberOfDisks** | Pointer to **int32** | The number of disks you want to apply RAID on. If not specified all disks are used | [optional] +**Type** | Pointer to [**RaidType**](RaidType.md) | | [optional] + +## Methods + +### NewRaid + +`func NewRaid() *Raid` + +NewRaid instantiates a new Raid object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewRaidWithDefaults + +`func NewRaidWithDefaults() *Raid` + +NewRaidWithDefaults instantiates a new Raid object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLevel + +`func (o *Raid) GetLevel() int32` + +GetLevel returns the Level field if non-nil, zero value otherwise. + +### GetLevelOk + +`func (o *Raid) GetLevelOk() (*int32, bool)` + +GetLevelOk returns a tuple with the Level field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLevel + +`func (o *Raid) SetLevel(v int32)` + +SetLevel sets Level field to given value. + +### HasLevel + +`func (o *Raid) HasLevel() bool` + +HasLevel returns a boolean if a field has been set. + +### GetNumberOfDisks + +`func (o *Raid) GetNumberOfDisks() int32` + +GetNumberOfDisks returns the NumberOfDisks field if non-nil, zero value otherwise. + +### GetNumberOfDisksOk + +`func (o *Raid) GetNumberOfDisksOk() (*int32, bool)` + +GetNumberOfDisksOk returns a tuple with the NumberOfDisks field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNumberOfDisks + +`func (o *Raid) SetNumberOfDisks(v int32)` + +SetNumberOfDisks sets NumberOfDisks field to given value. + +### HasNumberOfDisks + +`func (o *Raid) HasNumberOfDisks() bool` + +HasNumberOfDisks returns a boolean if a field has been set. + +### GetType + +`func (o *Raid) GetType() RaidType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Raid) GetTypeOk() (*RaidType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Raid) SetType(v RaidType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Raid) HasType() bool` + +HasType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/RaidType.md b/bmp/docs/RaidType.md new file mode 100644 index 0000000..3027b12 --- /dev/null +++ b/bmp/docs/RaidType.md @@ -0,0 +1,15 @@ +# RaidType + +## Enum + + +* `HW` (value: `"HW"`) + +* `SW` (value: `"SW"`) + +* `NONE` (value: `"NONE"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/RescueImage.md b/bmp/docs/RescueImage.md new file mode 100644 index 0000000..aba19ac --- /dev/null +++ b/bmp/docs/RescueImage.md @@ -0,0 +1,82 @@ +# RescueImage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique ID of this rescue image | [optional] +**Name** | Pointer to **string** | A human readable name describing the rescue image | [optional] + +## Methods + +### NewRescueImage + +`func NewRescueImage() *RescueImage` + +NewRescueImage instantiates a new RescueImage object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewRescueImageWithDefaults + +`func NewRescueImageWithDefaults() *RescueImage` + +NewRescueImageWithDefaults instantiates a new RescueImage object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *RescueImage) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *RescueImage) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *RescueImage) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *RescueImage) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *RescueImage) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *RescueImage) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *RescueImage) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *RescueImage) HasName() bool` + +HasName returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/ScanHardwareOpts.md b/bmp/docs/ScanHardwareOpts.md new file mode 100644 index 0000000..32145e3 --- /dev/null +++ b/bmp/docs/ScanHardwareOpts.md @@ -0,0 +1,82 @@ +# ScanHardwareOpts + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CallbackUrl** | Pointer to **string** | Url which will receive callbacks | [optional] +**PowerCycle** | Pointer to **bool** | If set to `true`, server will be power cycled in order to complete the operation | [optional] [default to true] + +## Methods + +### NewScanHardwareOpts + +`func NewScanHardwareOpts() *ScanHardwareOpts` + +NewScanHardwareOpts instantiates a new ScanHardwareOpts object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewScanHardwareOptsWithDefaults + +`func NewScanHardwareOptsWithDefaults() *ScanHardwareOpts` + +NewScanHardwareOptsWithDefaults instantiates a new ScanHardwareOpts object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCallbackUrl + +`func (o *ScanHardwareOpts) GetCallbackUrl() string` + +GetCallbackUrl returns the CallbackUrl field if non-nil, zero value otherwise. + +### GetCallbackUrlOk + +`func (o *ScanHardwareOpts) GetCallbackUrlOk() (*string, bool)` + +GetCallbackUrlOk returns a tuple with the CallbackUrl field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCallbackUrl + +`func (o *ScanHardwareOpts) SetCallbackUrl(v string)` + +SetCallbackUrl sets CallbackUrl field to given value. + +### HasCallbackUrl + +`func (o *ScanHardwareOpts) HasCallbackUrl() bool` + +HasCallbackUrl returns a boolean if a field has been set. + +### GetPowerCycle + +`func (o *ScanHardwareOpts) GetPowerCycle() bool` + +GetPowerCycle returns the PowerCycle field if non-nil, zero value otherwise. + +### GetPowerCycleOk + +`func (o *ScanHardwareOpts) GetPowerCycleOk() (*bool, bool)` + +GetPowerCycleOk returns a tuple with the PowerCycle field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPowerCycle + +`func (o *ScanHardwareOpts) SetPowerCycle(v bool)` + +SetPowerCycle sets PowerCycle field to given value. + +### HasPowerCycle + +`func (o *ScanHardwareOpts) HasPowerCycle() bool` + +HasPowerCycle returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/ServerJob.md b/bmp/docs/ServerJob.md new file mode 100644 index 0000000..80a8e3b --- /dev/null +++ b/bmp/docs/ServerJob.md @@ -0,0 +1,394 @@ +# ServerJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BareMetalId** | Pointer to **string** | Id of the server (deprecated, use serverId instead) | [optional] +**CreatedAt** | Pointer to **time.Time** | Creation timestamp | [optional] +**Flow** | Pointer to **string** | Job flow | [optional] +**IsRunning** | Pointer to **bool** | Describes whether the job is running | [optional] +**Metadata** | Pointer to [**Metadata**](Metadata.md) | | [optional] [default to {}] +**Node** | Pointer to **string** | Node ID for this server | [optional] +**Payload** | Pointer to **map[string]interface{}** | Payload of the current job | [optional] +**Progress** | Pointer to **map[string]interface{}** | Describes progress of the jobs on the server | [optional] +**ServerId** | Pointer to **string** | Id of the server | [optional] +**Status** | Pointer to **string** | Status of the job | [optional] +**Tasks** | Pointer to [**[]Task**](Task.md) | List of tasks in the job | [optional] +**Type** | Pointer to **string** | Type of the job | [optional] +**UpdatedAt** | Pointer to **time.Time** | Update timestamp | [optional] +**Uuid** | Pointer to **string** | Unique identifier of the job | [optional] + +## Methods + +### NewServerJob + +`func NewServerJob() *ServerJob` + +NewServerJob instantiates a new ServerJob object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewServerJobWithDefaults + +`func NewServerJobWithDefaults() *ServerJob` + +NewServerJobWithDefaults instantiates a new ServerJob object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetBareMetalId + +`func (o *ServerJob) GetBareMetalId() string` + +GetBareMetalId returns the BareMetalId field if non-nil, zero value otherwise. + +### GetBareMetalIdOk + +`func (o *ServerJob) GetBareMetalIdOk() (*string, bool)` + +GetBareMetalIdOk returns a tuple with the BareMetalId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBareMetalId + +`func (o *ServerJob) SetBareMetalId(v string)` + +SetBareMetalId sets BareMetalId field to given value. + +### HasBareMetalId + +`func (o *ServerJob) HasBareMetalId() bool` + +HasBareMetalId returns a boolean if a field has been set. + +### GetCreatedAt + +`func (o *ServerJob) GetCreatedAt() time.Time` + +GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise. + +### GetCreatedAtOk + +`func (o *ServerJob) GetCreatedAtOk() (*time.Time, bool)` + +GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreatedAt + +`func (o *ServerJob) SetCreatedAt(v time.Time)` + +SetCreatedAt sets CreatedAt field to given value. + +### HasCreatedAt + +`func (o *ServerJob) HasCreatedAt() bool` + +HasCreatedAt returns a boolean if a field has been set. + +### GetFlow + +`func (o *ServerJob) GetFlow() string` + +GetFlow returns the Flow field if non-nil, zero value otherwise. + +### GetFlowOk + +`func (o *ServerJob) GetFlowOk() (*string, bool)` + +GetFlowOk returns a tuple with the Flow field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFlow + +`func (o *ServerJob) SetFlow(v string)` + +SetFlow sets Flow field to given value. + +### HasFlow + +`func (o *ServerJob) HasFlow() bool` + +HasFlow returns a boolean if a field has been set. + +### GetIsRunning + +`func (o *ServerJob) GetIsRunning() bool` + +GetIsRunning returns the IsRunning field if non-nil, zero value otherwise. + +### GetIsRunningOk + +`func (o *ServerJob) GetIsRunningOk() (*bool, bool)` + +GetIsRunningOk returns a tuple with the IsRunning field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsRunning + +`func (o *ServerJob) SetIsRunning(v bool)` + +SetIsRunning sets IsRunning field to given value. + +### HasIsRunning + +`func (o *ServerJob) HasIsRunning() bool` + +HasIsRunning returns a boolean if a field has been set. + +### GetMetadata + +`func (o *ServerJob) GetMetadata() Metadata` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *ServerJob) GetMetadataOk() (*Metadata, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *ServerJob) SetMetadata(v Metadata)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *ServerJob) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + +### GetNode + +`func (o *ServerJob) GetNode() string` + +GetNode returns the Node field if non-nil, zero value otherwise. + +### GetNodeOk + +`func (o *ServerJob) GetNodeOk() (*string, bool)` + +GetNodeOk returns a tuple with the Node field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNode + +`func (o *ServerJob) SetNode(v string)` + +SetNode sets Node field to given value. + +### HasNode + +`func (o *ServerJob) HasNode() bool` + +HasNode returns a boolean if a field has been set. + +### GetPayload + +`func (o *ServerJob) GetPayload() map[string]interface{}` + +GetPayload returns the Payload field if non-nil, zero value otherwise. + +### GetPayloadOk + +`func (o *ServerJob) GetPayloadOk() (*map[string]interface{}, bool)` + +GetPayloadOk returns a tuple with the Payload field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPayload + +`func (o *ServerJob) SetPayload(v map[string]interface{})` + +SetPayload sets Payload field to given value. + +### HasPayload + +`func (o *ServerJob) HasPayload() bool` + +HasPayload returns a boolean if a field has been set. + +### GetProgress + +`func (o *ServerJob) GetProgress() map[string]interface{}` + +GetProgress returns the Progress field if non-nil, zero value otherwise. + +### GetProgressOk + +`func (o *ServerJob) GetProgressOk() (*map[string]interface{}, bool)` + +GetProgressOk returns a tuple with the Progress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProgress + +`func (o *ServerJob) SetProgress(v map[string]interface{})` + +SetProgress sets Progress field to given value. + +### HasProgress + +`func (o *ServerJob) HasProgress() bool` + +HasProgress returns a boolean if a field has been set. + +### GetServerId + +`func (o *ServerJob) GetServerId() string` + +GetServerId returns the ServerId field if non-nil, zero value otherwise. + +### GetServerIdOk + +`func (o *ServerJob) GetServerIdOk() (*string, bool)` + +GetServerIdOk returns a tuple with the ServerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetServerId + +`func (o *ServerJob) SetServerId(v string)` + +SetServerId sets ServerId field to given value. + +### HasServerId + +`func (o *ServerJob) HasServerId() bool` + +HasServerId returns a boolean if a field has been set. + +### GetStatus + +`func (o *ServerJob) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *ServerJob) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *ServerJob) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *ServerJob) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetTasks + +`func (o *ServerJob) GetTasks() []Task` + +GetTasks returns the Tasks field if non-nil, zero value otherwise. + +### GetTasksOk + +`func (o *ServerJob) GetTasksOk() (*[]Task, bool)` + +GetTasksOk returns a tuple with the Tasks field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTasks + +`func (o *ServerJob) SetTasks(v []Task)` + +SetTasks sets Tasks field to given value. + +### HasTasks + +`func (o *ServerJob) HasTasks() bool` + +HasTasks returns a boolean if a field has been set. + +### GetType + +`func (o *ServerJob) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *ServerJob) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *ServerJob) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *ServerJob) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetUpdatedAt + +`func (o *ServerJob) GetUpdatedAt() time.Time` + +GetUpdatedAt returns the UpdatedAt field if non-nil, zero value otherwise. + +### GetUpdatedAtOk + +`func (o *ServerJob) GetUpdatedAtOk() (*time.Time, bool)` + +GetUpdatedAtOk returns a tuple with the UpdatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdatedAt + +`func (o *ServerJob) SetUpdatedAt(v time.Time)` + +SetUpdatedAt sets UpdatedAt field to given value. + +### HasUpdatedAt + +`func (o *ServerJob) HasUpdatedAt() bool` + +HasUpdatedAt returns a boolean if a field has been set. + +### GetUuid + +`func (o *ServerJob) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *ServerJob) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *ServerJob) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *ServerJob) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/ServerJobList.md b/bmp/docs/ServerJobList.md new file mode 100644 index 0000000..5d3a82a --- /dev/null +++ b/bmp/docs/ServerJobList.md @@ -0,0 +1,82 @@ +# ServerJobList + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Metadata** | Pointer to [**Metadata**](Metadata.md) | | [optional] +**Jobs** | Pointer to [**[]ServerJob**](ServerJob.md) | An array of jobs | [optional] + +## Methods + +### NewServerJobList + +`func NewServerJobList() *ServerJobList` + +NewServerJobList instantiates a new ServerJobList object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewServerJobListWithDefaults + +`func NewServerJobListWithDefaults() *ServerJobList` + +NewServerJobListWithDefaults instantiates a new ServerJobList object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMetadata + +`func (o *ServerJobList) GetMetadata() Metadata` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *ServerJobList) GetMetadataOk() (*Metadata, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *ServerJobList) SetMetadata(v Metadata)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *ServerJobList) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + +### GetJobs + +`func (o *ServerJobList) GetJobs() []ServerJob` + +GetJobs returns the Jobs field if non-nil, zero value otherwise. + +### GetJobsOk + +`func (o *ServerJobList) GetJobsOk() (*[]ServerJob, bool)` + +GetJobsOk returns a tuple with the Jobs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetJobs + +`func (o *ServerJobList) SetJobs(v []ServerJob)` + +SetJobs sets Jobs field to given value. + +### HasJobs + +`func (o *ServerJobList) HasJobs() bool` + +HasJobs returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/Task.md b/bmp/docs/Task.md new file mode 100644 index 0000000..fb594d1 --- /dev/null +++ b/bmp/docs/Task.md @@ -0,0 +1,222 @@ +# Task + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **string** | Description of the task | [optional] +**ErrorMessage** | Pointer to **NullableString** | An optional error message | [optional] +**Flow** | Pointer to **string** | The flow this task is part of | [optional] +**OnError** | Pointer to **string** | The behaviour if this task fails | [optional] +**Status** | Pointer to **string** | The status of the task | [optional] +**StatusTimestamps** | Pointer to **map[string]interface{}** | Timestamp for each state change | [optional] +**Uuid** | Pointer to **string** | Unique ID for this task | [optional] + +## Methods + +### NewTask + +`func NewTask() *Task` + +NewTask instantiates a new Task object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTaskWithDefaults + +`func NewTaskWithDefaults() *Task` + +NewTaskWithDefaults instantiates a new Task object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDescription + +`func (o *Task) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *Task) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *Task) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *Task) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + +### GetErrorMessage + +`func (o *Task) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *Task) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *Task) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *Task) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### SetErrorMessageNil + +`func (o *Task) SetErrorMessageNil(b bool)` + + SetErrorMessageNil sets the value for ErrorMessage to be an explicit nil + +### UnsetErrorMessage +`func (o *Task) UnsetErrorMessage()` + +UnsetErrorMessage ensures that no value is present for ErrorMessage, not even an explicit nil +### GetFlow + +`func (o *Task) GetFlow() string` + +GetFlow returns the Flow field if non-nil, zero value otherwise. + +### GetFlowOk + +`func (o *Task) GetFlowOk() (*string, bool)` + +GetFlowOk returns a tuple with the Flow field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFlow + +`func (o *Task) SetFlow(v string)` + +SetFlow sets Flow field to given value. + +### HasFlow + +`func (o *Task) HasFlow() bool` + +HasFlow returns a boolean if a field has been set. + +### GetOnError + +`func (o *Task) GetOnError() string` + +GetOnError returns the OnError field if non-nil, zero value otherwise. + +### GetOnErrorOk + +`func (o *Task) GetOnErrorOk() (*string, bool)` + +GetOnErrorOk returns a tuple with the OnError field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOnError + +`func (o *Task) SetOnError(v string)` + +SetOnError sets OnError field to given value. + +### HasOnError + +`func (o *Task) HasOnError() bool` + +HasOnError returns a boolean if a field has been set. + +### GetStatus + +`func (o *Task) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *Task) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *Task) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *Task) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetStatusTimestamps + +`func (o *Task) GetStatusTimestamps() map[string]interface{}` + +GetStatusTimestamps returns the StatusTimestamps field if non-nil, zero value otherwise. + +### GetStatusTimestampsOk + +`func (o *Task) GetStatusTimestampsOk() (*map[string]interface{}, bool)` + +GetStatusTimestampsOk returns a tuple with the StatusTimestamps field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatusTimestamps + +`func (o *Task) SetStatusTimestamps(v map[string]interface{})` + +SetStatusTimestamps sets StatusTimestamps field to given value. + +### HasStatusTimestamps + +`func (o *Task) HasStatusTimestamps() bool` + +HasStatusTimestamps returns a boolean if a field has been set. + +### GetUuid + +`func (o *Task) GetUuid() string` + +GetUuid returns the Uuid field if non-nil, zero value otherwise. + +### GetUuidOk + +`func (o *Task) GetUuidOk() (*string, bool)` + +GetUuidOk returns a tuple with the Uuid field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUuid + +`func (o *Task) SetUuid(v string)` + +SetUuid sets Uuid field to given value. + +### HasUuid + +`func (o *Task) HasUuid() bool` + +HasUuid returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/UpdateNetworkEquipmentCredentialOpts.md b/bmp/docs/UpdateNetworkEquipmentCredentialOpts.md new file mode 100644 index 0000000..bd73cba --- /dev/null +++ b/bmp/docs/UpdateNetworkEquipmentCredentialOpts.md @@ -0,0 +1,51 @@ +# UpdateNetworkEquipmentCredentialOpts + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Password** | **string** | The password for the credentials | + +## Methods + +### NewUpdateNetworkEquipmentCredentialOpts + +`func NewUpdateNetworkEquipmentCredentialOpts(password string, ) *UpdateNetworkEquipmentCredentialOpts` + +NewUpdateNetworkEquipmentCredentialOpts instantiates a new UpdateNetworkEquipmentCredentialOpts object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUpdateNetworkEquipmentCredentialOptsWithDefaults + +`func NewUpdateNetworkEquipmentCredentialOptsWithDefaults() *UpdateNetworkEquipmentCredentialOpts` + +NewUpdateNetworkEquipmentCredentialOptsWithDefaults instantiates a new UpdateNetworkEquipmentCredentialOpts object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetPassword + +`func (o *UpdateNetworkEquipmentCredentialOpts) GetPassword() string` + +GetPassword returns the Password field if non-nil, zero value otherwise. + +### GetPasswordOk + +`func (o *UpdateNetworkEquipmentCredentialOpts) GetPasswordOk() (*string, bool)` + +GetPasswordOk returns a tuple with the Password field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPassword + +`func (o *UpdateNetworkEquipmentCredentialOpts) SetPassword(v string)` + +SetPassword sets Password field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmp/docs/UpdateServerCredentialOpts.md b/bmp/docs/UpdateServerCredentialOpts.md new file mode 100644 index 0000000..c43ea38 --- /dev/null +++ b/bmp/docs/UpdateServerCredentialOpts.md @@ -0,0 +1,51 @@ +# UpdateServerCredentialOpts + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Password** | **string** | The password for the credentials | + +## Methods + +### NewUpdateServerCredentialOpts + +`func NewUpdateServerCredentialOpts(password string, ) *UpdateServerCredentialOpts` + +NewUpdateServerCredentialOpts instantiates a new UpdateServerCredentialOpts object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUpdateServerCredentialOptsWithDefaults + +`func NewUpdateServerCredentialOptsWithDefaults() *UpdateServerCredentialOpts` + +NewUpdateServerCredentialOptsWithDefaults instantiates a new UpdateServerCredentialOpts object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetPassword + +`func (o *UpdateServerCredentialOpts) GetPassword() string` + +GetPassword returns the Password field if non-nil, zero value otherwise. + +### GetPasswordOk + +`func (o *UpdateServerCredentialOpts) GetPasswordOk() (*string, bool)` + +GetPasswordOk returns a tuple with the Password field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPassword + +`func (o *UpdateServerCredentialOpts) SetPassword(v string)` + +SetPassword sets Password field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmsdb/docs/BmsdbAPI.md b/bmsdb/docs/BmsdbAPI.md new file mode 100644 index 0000000..52276e9 --- /dev/null +++ b/bmsdb/docs/BmsdbAPI.md @@ -0,0 +1,230 @@ +# \BmsdbAPI + +All URIs are relative to *https://api.leaseweb.com/internal/bmsdb/v2* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**GetServerHardware**](BmsdbAPI.md#GetServerHardware) | **Get** /servers/{serverId}/hardwareInfo | Show hardware information +[**GetServerHardwareScan**](BmsdbAPI.md#GetServerHardwareScan) | **Get** /servers/{serverId}/hardwareScans/{hardwareScanId} | Show a hardware scan +[**ServersHardwarescansList**](BmsdbAPI.md#ServersHardwarescansList) | **Get** /servers/{serverId}/hardwareScans | List hardware scans + + + +## GetServerHardware + +> GetServerHardwareResult GetServerHardware(ctx, serverId).Execute() + +Show hardware information + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmsdb" +) + +func main() { + serverId := "12345" // string | The ID of a server + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmsdbAPI.GetServerHardware(context.Background(), serverId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmsdbAPI.GetServerHardware``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServerHardware`: GetServerHardwareResult + fmt.Fprintf(os.Stdout, "Response from `BmsdbAPI.GetServerHardware`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServerHardwareRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**GetServerHardwareResult**](GetServerHardwareResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetServerHardwareScan + +> GetServerHardwareScanResult GetServerHardwareScan(ctx, serverId, hardwareScanId).Format(format).Execute() + +Show a hardware scan + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmsdb" +) + +func main() { + serverId := "12345" // string | The ID of a server + hardwareScanId := "hardwareScanId_example" // string | The ID that identifies a hardware scan + format := "json" // string | Defines the format of the response (optional) (default to "json") + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmsdbAPI.GetServerHardwareScan(context.Background(), serverId, hardwareScanId).Format(format).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmsdbAPI.GetServerHardwareScan``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServerHardwareScan`: GetServerHardwareScanResult + fmt.Fprintf(os.Stdout, "Response from `BmsdbAPI.GetServerHardwareScan`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | +**hardwareScanId** | **string** | The ID that identifies a hardware scan | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServerHardwareScanRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **format** | **string** | Defines the format of the response | [default to "json"] + +### Return type + +[**GetServerHardwareScanResult**](GetServerHardwareScanResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ServersHardwarescansList + +> GetServerHardwareScanListResult ServersHardwarescansList(ctx, serverId).Limit(limit).Offset(offset).Execute() + +List hardware scans + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmsdb" +) + +func main() { + serverId := "12345" // string | The ID of a server + limit := int32(20) // int32 | Limit the number of results returned. (optional) + offset := int32(10) // int32 | Return results starting from the given offset. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmsdbAPI.ServersHardwarescansList(context.Background(), serverId).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmsdbAPI.ServersHardwarescansList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ServersHardwarescansList`: GetServerHardwareScanListResult + fmt.Fprintf(os.Stdout, "Response from `BmsdbAPI.ServersHardwarescansList`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiServersHardwarescansListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **limit** | **int32** | Limit the number of results returned. | + **offset** | **int32** | Return results starting from the given offset. | + +### Return type + +[**GetServerHardwareScanListResult**](GetServerHardwareScanListResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/bmsdb/docs/ErrorResult.md b/bmsdb/docs/ErrorResult.md new file mode 100644 index 0000000..af3c285 --- /dev/null +++ b/bmsdb/docs/ErrorResult.md @@ -0,0 +1,134 @@ +# ErrorResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CorrelationId** | Pointer to **string** | The correlation ID of the current request. | [optional] +**ErrorCode** | Pointer to **string** | The error code. | [optional] +**ErrorMessage** | Pointer to **string** | A human friendly description of the error. | [optional] +**ErrorDetails** | Pointer to [**[]map[string][]string**](map[string][]string.md) | | [optional] + +## Methods + +### NewErrorResult + +`func NewErrorResult() *ErrorResult` + +NewErrorResult instantiates a new ErrorResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewErrorResultWithDefaults + +`func NewErrorResultWithDefaults() *ErrorResult` + +NewErrorResultWithDefaults instantiates a new ErrorResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCorrelationId + +`func (o *ErrorResult) GetCorrelationId() string` + +GetCorrelationId returns the CorrelationId field if non-nil, zero value otherwise. + +### GetCorrelationIdOk + +`func (o *ErrorResult) GetCorrelationIdOk() (*string, bool)` + +GetCorrelationIdOk returns a tuple with the CorrelationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelationId + +`func (o *ErrorResult) SetCorrelationId(v string)` + +SetCorrelationId sets CorrelationId field to given value. + +### HasCorrelationId + +`func (o *ErrorResult) HasCorrelationId() bool` + +HasCorrelationId returns a boolean if a field has been set. + +### GetErrorCode + +`func (o *ErrorResult) GetErrorCode() string` + +GetErrorCode returns the ErrorCode field if non-nil, zero value otherwise. + +### GetErrorCodeOk + +`func (o *ErrorResult) GetErrorCodeOk() (*string, bool)` + +GetErrorCodeOk returns a tuple with the ErrorCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorCode + +`func (o *ErrorResult) SetErrorCode(v string)` + +SetErrorCode sets ErrorCode field to given value. + +### HasErrorCode + +`func (o *ErrorResult) HasErrorCode() bool` + +HasErrorCode returns a boolean if a field has been set. + +### GetErrorMessage + +`func (o *ErrorResult) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *ErrorResult) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *ErrorResult) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *ErrorResult) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### GetErrorDetails + +`func (o *ErrorResult) GetErrorDetails() []map[string][]string` + +GetErrorDetails returns the ErrorDetails field if non-nil, zero value otherwise. + +### GetErrorDetailsOk + +`func (o *ErrorResult) GetErrorDetailsOk() (*[]map[string][]string, bool)` + +GetErrorDetailsOk returns a tuple with the ErrorDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorDetails + +`func (o *ErrorResult) SetErrorDetails(v []map[string][]string)` + +SetErrorDetails sets ErrorDetails field to given value. + +### HasErrorDetails + +`func (o *ErrorResult) HasErrorDetails() bool` + +HasErrorDetails returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmsdb/docs/GetServerHardwareResult.md b/bmsdb/docs/GetServerHardwareResult.md new file mode 100644 index 0000000..1928e47 --- /dev/null +++ b/bmsdb/docs/GetServerHardwareResult.md @@ -0,0 +1,160 @@ +# GetServerHardwareResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of this hardware scan result | [optional] +**ParserVersion** | Pointer to **string** | Version of the parser used for this hardware info | [optional] +**Result** | Pointer to **map[string]interface{}** | Hardware info e.g. chassis, cpu, memory and etc. | [optional] +**ScannedAt** | Pointer to **time.Time** | Timestamp of hardware scan | [optional] +**ServerId** | Pointer to **string** | The server id | [optional] + +## Methods + +### NewGetServerHardwareResult + +`func NewGetServerHardwareResult() *GetServerHardwareResult` + +NewGetServerHardwareResult instantiates a new GetServerHardwareResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetServerHardwareResultWithDefaults + +`func NewGetServerHardwareResultWithDefaults() *GetServerHardwareResult` + +NewGetServerHardwareResultWithDefaults instantiates a new GetServerHardwareResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *GetServerHardwareResult) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GetServerHardwareResult) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GetServerHardwareResult) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *GetServerHardwareResult) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetParserVersion + +`func (o *GetServerHardwareResult) GetParserVersion() string` + +GetParserVersion returns the ParserVersion field if non-nil, zero value otherwise. + +### GetParserVersionOk + +`func (o *GetServerHardwareResult) GetParserVersionOk() (*string, bool)` + +GetParserVersionOk returns a tuple with the ParserVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetParserVersion + +`func (o *GetServerHardwareResult) SetParserVersion(v string)` + +SetParserVersion sets ParserVersion field to given value. + +### HasParserVersion + +`func (o *GetServerHardwareResult) HasParserVersion() bool` + +HasParserVersion returns a boolean if a field has been set. + +### GetResult + +`func (o *GetServerHardwareResult) GetResult() map[string]interface{}` + +GetResult returns the Result field if non-nil, zero value otherwise. + +### GetResultOk + +`func (o *GetServerHardwareResult) GetResultOk() (*map[string]interface{}, bool)` + +GetResultOk returns a tuple with the Result field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResult + +`func (o *GetServerHardwareResult) SetResult(v map[string]interface{})` + +SetResult sets Result field to given value. + +### HasResult + +`func (o *GetServerHardwareResult) HasResult() bool` + +HasResult returns a boolean if a field has been set. + +### GetScannedAt + +`func (o *GetServerHardwareResult) GetScannedAt() time.Time` + +GetScannedAt returns the ScannedAt field if non-nil, zero value otherwise. + +### GetScannedAtOk + +`func (o *GetServerHardwareResult) GetScannedAtOk() (*time.Time, bool)` + +GetScannedAtOk returns a tuple with the ScannedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScannedAt + +`func (o *GetServerHardwareResult) SetScannedAt(v time.Time)` + +SetScannedAt sets ScannedAt field to given value. + +### HasScannedAt + +`func (o *GetServerHardwareResult) HasScannedAt() bool` + +HasScannedAt returns a boolean if a field has been set. + +### GetServerId + +`func (o *GetServerHardwareResult) GetServerId() string` + +GetServerId returns the ServerId field if non-nil, zero value otherwise. + +### GetServerIdOk + +`func (o *GetServerHardwareResult) GetServerIdOk() (*string, bool)` + +GetServerIdOk returns a tuple with the ServerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetServerId + +`func (o *GetServerHardwareResult) SetServerId(v string)` + +SetServerId sets ServerId field to given value. + +### HasServerId + +`func (o *GetServerHardwareResult) HasServerId() bool` + +HasServerId returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmsdb/docs/GetServerHardwareScanListResult.md b/bmsdb/docs/GetServerHardwareScanListResult.md new file mode 100644 index 0000000..7479ca3 --- /dev/null +++ b/bmsdb/docs/GetServerHardwareScanListResult.md @@ -0,0 +1,82 @@ +# GetServerHardwareScanListResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Metadata** | Pointer to [**Metadata**](Metadata.md) | | [optional] +**HardwareScans** | Pointer to [**[]HardwareScan**](HardwareScan.md) | Simple list of Hardware Scans | [optional] + +## Methods + +### NewGetServerHardwareScanListResult + +`func NewGetServerHardwareScanListResult() *GetServerHardwareScanListResult` + +NewGetServerHardwareScanListResult instantiates a new GetServerHardwareScanListResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetServerHardwareScanListResultWithDefaults + +`func NewGetServerHardwareScanListResultWithDefaults() *GetServerHardwareScanListResult` + +NewGetServerHardwareScanListResultWithDefaults instantiates a new GetServerHardwareScanListResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMetadata + +`func (o *GetServerHardwareScanListResult) GetMetadata() Metadata` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *GetServerHardwareScanListResult) GetMetadataOk() (*Metadata, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *GetServerHardwareScanListResult) SetMetadata(v Metadata)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *GetServerHardwareScanListResult) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + +### GetHardwareScans + +`func (o *GetServerHardwareScanListResult) GetHardwareScans() []HardwareScan` + +GetHardwareScans returns the HardwareScans field if non-nil, zero value otherwise. + +### GetHardwareScansOk + +`func (o *GetServerHardwareScanListResult) GetHardwareScansOk() (*[]HardwareScan, bool)` + +GetHardwareScansOk returns a tuple with the HardwareScans field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHardwareScans + +`func (o *GetServerHardwareScanListResult) SetHardwareScans(v []HardwareScan)` + +SetHardwareScans sets HardwareScans field to given value. + +### HasHardwareScans + +`func (o *GetServerHardwareScanListResult) HasHardwareScans() bool` + +HasHardwareScans returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmsdb/docs/GetServerHardwareScanResult.md b/bmsdb/docs/GetServerHardwareScanResult.md new file mode 100644 index 0000000..06f931b --- /dev/null +++ b/bmsdb/docs/GetServerHardwareScanResult.md @@ -0,0 +1,160 @@ +# GetServerHardwareScanResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Hardware Scan ID | [optional] +**ParserVersion** | Pointer to **string** | | [optional] +**Result** | Pointer to [**Results**](Results.md) | | [optional] +**ScannedAt** | Pointer to **string** | Date time using the ISO-8601 format | [optional] +**ServerId** | Pointer to **string** | | [optional] + +## Methods + +### NewGetServerHardwareScanResult + +`func NewGetServerHardwareScanResult() *GetServerHardwareScanResult` + +NewGetServerHardwareScanResult instantiates a new GetServerHardwareScanResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetServerHardwareScanResultWithDefaults + +`func NewGetServerHardwareScanResultWithDefaults() *GetServerHardwareScanResult` + +NewGetServerHardwareScanResultWithDefaults instantiates a new GetServerHardwareScanResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *GetServerHardwareScanResult) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GetServerHardwareScanResult) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GetServerHardwareScanResult) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *GetServerHardwareScanResult) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetParserVersion + +`func (o *GetServerHardwareScanResult) GetParserVersion() string` + +GetParserVersion returns the ParserVersion field if non-nil, zero value otherwise. + +### GetParserVersionOk + +`func (o *GetServerHardwareScanResult) GetParserVersionOk() (*string, bool)` + +GetParserVersionOk returns a tuple with the ParserVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetParserVersion + +`func (o *GetServerHardwareScanResult) SetParserVersion(v string)` + +SetParserVersion sets ParserVersion field to given value. + +### HasParserVersion + +`func (o *GetServerHardwareScanResult) HasParserVersion() bool` + +HasParserVersion returns a boolean if a field has been set. + +### GetResult + +`func (o *GetServerHardwareScanResult) GetResult() Results` + +GetResult returns the Result field if non-nil, zero value otherwise. + +### GetResultOk + +`func (o *GetServerHardwareScanResult) GetResultOk() (*Results, bool)` + +GetResultOk returns a tuple with the Result field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResult + +`func (o *GetServerHardwareScanResult) SetResult(v Results)` + +SetResult sets Result field to given value. + +### HasResult + +`func (o *GetServerHardwareScanResult) HasResult() bool` + +HasResult returns a boolean if a field has been set. + +### GetScannedAt + +`func (o *GetServerHardwareScanResult) GetScannedAt() string` + +GetScannedAt returns the ScannedAt field if non-nil, zero value otherwise. + +### GetScannedAtOk + +`func (o *GetServerHardwareScanResult) GetScannedAtOk() (*string, bool)` + +GetScannedAtOk returns a tuple with the ScannedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScannedAt + +`func (o *GetServerHardwareScanResult) SetScannedAt(v string)` + +SetScannedAt sets ScannedAt field to given value. + +### HasScannedAt + +`func (o *GetServerHardwareScanResult) HasScannedAt() bool` + +HasScannedAt returns a boolean if a field has been set. + +### GetServerId + +`func (o *GetServerHardwareScanResult) GetServerId() string` + +GetServerId returns the ServerId field if non-nil, zero value otherwise. + +### GetServerIdOk + +`func (o *GetServerHardwareScanResult) GetServerIdOk() (*string, bool)` + +GetServerIdOk returns a tuple with the ServerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetServerId + +`func (o *GetServerHardwareScanResult) SetServerId(v string)` + +SetServerId sets ServerId field to given value. + +### HasServerId + +`func (o *GetServerHardwareScanResult) HasServerId() bool` + +HasServerId returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmsdb/docs/HardwareScan.md b/bmsdb/docs/HardwareScan.md new file mode 100644 index 0000000..0944103 --- /dev/null +++ b/bmsdb/docs/HardwareScan.md @@ -0,0 +1,134 @@ +# HardwareScan + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Hardware Scan id | [optional] +**ParserVersion** | Pointer to **string** | | [optional] +**ScannedAt** | Pointer to **string** | Date time using the ISO-8601 format | [optional] +**ServerId** | Pointer to **string** | | [optional] + +## Methods + +### NewHardwareScan + +`func NewHardwareScan() *HardwareScan` + +NewHardwareScan instantiates a new HardwareScan object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewHardwareScanWithDefaults + +`func NewHardwareScanWithDefaults() *HardwareScan` + +NewHardwareScanWithDefaults instantiates a new HardwareScan object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *HardwareScan) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *HardwareScan) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *HardwareScan) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *HardwareScan) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetParserVersion + +`func (o *HardwareScan) GetParserVersion() string` + +GetParserVersion returns the ParserVersion field if non-nil, zero value otherwise. + +### GetParserVersionOk + +`func (o *HardwareScan) GetParserVersionOk() (*string, bool)` + +GetParserVersionOk returns a tuple with the ParserVersion field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetParserVersion + +`func (o *HardwareScan) SetParserVersion(v string)` + +SetParserVersion sets ParserVersion field to given value. + +### HasParserVersion + +`func (o *HardwareScan) HasParserVersion() bool` + +HasParserVersion returns a boolean if a field has been set. + +### GetScannedAt + +`func (o *HardwareScan) GetScannedAt() string` + +GetScannedAt returns the ScannedAt field if non-nil, zero value otherwise. + +### GetScannedAtOk + +`func (o *HardwareScan) GetScannedAtOk() (*string, bool)` + +GetScannedAtOk returns a tuple with the ScannedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScannedAt + +`func (o *HardwareScan) SetScannedAt(v string)` + +SetScannedAt sets ScannedAt field to given value. + +### HasScannedAt + +`func (o *HardwareScan) HasScannedAt() bool` + +HasScannedAt returns a boolean if a field has been set. + +### GetServerId + +`func (o *HardwareScan) GetServerId() string` + +GetServerId returns the ServerId field if non-nil, zero value otherwise. + +### GetServerIdOk + +`func (o *HardwareScan) GetServerIdOk() (*string, bool)` + +GetServerIdOk returns a tuple with the ServerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetServerId + +`func (o *HardwareScan) SetServerId(v string)` + +SetServerId sets ServerId field to given value. + +### HasServerId + +`func (o *HardwareScan) HasServerId() bool` + +HasServerId returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmsdb/docs/Metadata.md b/bmsdb/docs/Metadata.md new file mode 100644 index 0000000..194d6a7 --- /dev/null +++ b/bmsdb/docs/Metadata.md @@ -0,0 +1,108 @@ +# Metadata + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TotalCount** | Pointer to **float32** | Total amount of orders in this collection | [optional] +**Offset** | Pointer to **float32** | The offset used to generate this response | [optional] [default to 0] +**Limit** | Pointer to **float32** | The limit used to generate this response | [optional] [default to 5] + +## Methods + +### NewMetadata + +`func NewMetadata() *Metadata` + +NewMetadata instantiates a new Metadata object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewMetadataWithDefaults + +`func NewMetadataWithDefaults() *Metadata` + +NewMetadataWithDefaults instantiates a new Metadata object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetTotalCount + +`func (o *Metadata) GetTotalCount() float32` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *Metadata) GetTotalCountOk() (*float32, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *Metadata) SetTotalCount(v float32)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *Metadata) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + +### GetOffset + +`func (o *Metadata) GetOffset() float32` + +GetOffset returns the Offset field if non-nil, zero value otherwise. + +### GetOffsetOk + +`func (o *Metadata) GetOffsetOk() (*float32, bool)` + +GetOffsetOk returns a tuple with the Offset field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOffset + +`func (o *Metadata) SetOffset(v float32)` + +SetOffset sets Offset field to given value. + +### HasOffset + +`func (o *Metadata) HasOffset() bool` + +HasOffset returns a boolean if a field has been set. + +### GetLimit + +`func (o *Metadata) GetLimit() float32` + +GetLimit returns the Limit field if non-nil, zero value otherwise. + +### GetLimitOk + +`func (o *Metadata) GetLimitOk() (*float32, bool)` + +GetLimitOk returns a tuple with the Limit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLimit + +`func (o *Metadata) SetLimit(v float32)` + +SetLimit sets Limit field to given value. + +### HasLimit + +`func (o *Metadata) HasLimit() bool` + +HasLimit returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmsdb/docs/Results.md b/bmsdb/docs/Results.md new file mode 100644 index 0000000..f24deac --- /dev/null +++ b/bmsdb/docs/Results.md @@ -0,0 +1,186 @@ +# Results + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Chassis** | Pointer to **map[string]interface{}** | | [optional] +**Cpu** | Pointer to **[]map[string]interface{}** | | [optional] +**Disks** | Pointer to **[]map[string]interface{}** | | [optional] +**Ipmi** | Pointer to **map[string]interface{}** | | [optional] +**Memory** | Pointer to **[]map[string]interface{}** | | [optional] +**Network** | Pointer to **[]map[string]interface{}** | | [optional] + +## Methods + +### NewResults + +`func NewResults() *Results` + +NewResults instantiates a new Results object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewResultsWithDefaults + +`func NewResultsWithDefaults() *Results` + +NewResultsWithDefaults instantiates a new Results object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetChassis + +`func (o *Results) GetChassis() map[string]interface{}` + +GetChassis returns the Chassis field if non-nil, zero value otherwise. + +### GetChassisOk + +`func (o *Results) GetChassisOk() (*map[string]interface{}, bool)` + +GetChassisOk returns a tuple with the Chassis field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChassis + +`func (o *Results) SetChassis(v map[string]interface{})` + +SetChassis sets Chassis field to given value. + +### HasChassis + +`func (o *Results) HasChassis() bool` + +HasChassis returns a boolean if a field has been set. + +### GetCpu + +`func (o *Results) GetCpu() []map[string]interface{}` + +GetCpu returns the Cpu field if non-nil, zero value otherwise. + +### GetCpuOk + +`func (o *Results) GetCpuOk() (*[]map[string]interface{}, bool)` + +GetCpuOk returns a tuple with the Cpu field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCpu + +`func (o *Results) SetCpu(v []map[string]interface{})` + +SetCpu sets Cpu field to given value. + +### HasCpu + +`func (o *Results) HasCpu() bool` + +HasCpu returns a boolean if a field has been set. + +### GetDisks + +`func (o *Results) GetDisks() []map[string]interface{}` + +GetDisks returns the Disks field if non-nil, zero value otherwise. + +### GetDisksOk + +`func (o *Results) GetDisksOk() (*[]map[string]interface{}, bool)` + +GetDisksOk returns a tuple with the Disks field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDisks + +`func (o *Results) SetDisks(v []map[string]interface{})` + +SetDisks sets Disks field to given value. + +### HasDisks + +`func (o *Results) HasDisks() bool` + +HasDisks returns a boolean if a field has been set. + +### GetIpmi + +`func (o *Results) GetIpmi() map[string]interface{}` + +GetIpmi returns the Ipmi field if non-nil, zero value otherwise. + +### GetIpmiOk + +`func (o *Results) GetIpmiOk() (*map[string]interface{}, bool)` + +GetIpmiOk returns a tuple with the Ipmi field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIpmi + +`func (o *Results) SetIpmi(v map[string]interface{})` + +SetIpmi sets Ipmi field to given value. + +### HasIpmi + +`func (o *Results) HasIpmi() bool` + +HasIpmi returns a boolean if a field has been set. + +### GetMemory + +`func (o *Results) GetMemory() []map[string]interface{}` + +GetMemory returns the Memory field if non-nil, zero value otherwise. + +### GetMemoryOk + +`func (o *Results) GetMemoryOk() (*[]map[string]interface{}, bool)` + +GetMemoryOk returns a tuple with the Memory field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMemory + +`func (o *Results) SetMemory(v []map[string]interface{})` + +SetMemory sets Memory field to given value. + +### HasMemory + +`func (o *Results) HasMemory() bool` + +HasMemory returns a boolean if a field has been set. + +### GetNetwork + +`func (o *Results) GetNetwork() []map[string]interface{}` + +GetNetwork returns the Network field if non-nil, zero value otherwise. + +### GetNetworkOk + +`func (o *Results) GetNetworkOk() (*[]map[string]interface{}, bool)` + +GetNetworkOk returns a tuple with the Network field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNetwork + +`func (o *Results) SetNetwork(v []map[string]interface{})` + +SetNetwork sets Network field to given value. + +### HasNetwork + +`func (o *Results) HasNetwork() bool` + +HasNetwork returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmusage/docs/Actions.md b/bmusage/docs/Actions.md new file mode 100644 index 0000000..a8ad427 --- /dev/null +++ b/bmusage/docs/Actions.md @@ -0,0 +1,92 @@ +# Actions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LastTriggeredAt** | Pointer to **NullableString** | Date timestamp when the last notification email triggered | [optional] +**Type** | Pointer to **string** | Type of action | [optional] + +## Methods + +### NewActions + +`func NewActions() *Actions` + +NewActions instantiates a new Actions object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewActionsWithDefaults + +`func NewActionsWithDefaults() *Actions` + +NewActionsWithDefaults instantiates a new Actions object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLastTriggeredAt + +`func (o *Actions) GetLastTriggeredAt() string` + +GetLastTriggeredAt returns the LastTriggeredAt field if non-nil, zero value otherwise. + +### GetLastTriggeredAtOk + +`func (o *Actions) GetLastTriggeredAtOk() (*string, bool)` + +GetLastTriggeredAtOk returns a tuple with the LastTriggeredAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastTriggeredAt + +`func (o *Actions) SetLastTriggeredAt(v string)` + +SetLastTriggeredAt sets LastTriggeredAt field to given value. + +### HasLastTriggeredAt + +`func (o *Actions) HasLastTriggeredAt() bool` + +HasLastTriggeredAt returns a boolean if a field has been set. + +### SetLastTriggeredAtNil + +`func (o *Actions) SetLastTriggeredAtNil(b bool)` + + SetLastTriggeredAtNil sets the value for LastTriggeredAt to be an explicit nil + +### UnsetLastTriggeredAt +`func (o *Actions) UnsetLastTriggeredAt()` + +UnsetLastTriggeredAt ensures that no value is present for LastTriggeredAt, not even an explicit nil +### GetType + +`func (o *Actions) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Actions) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Actions) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Actions) HasType() bool` + +HasType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmusage/docs/BandwidthNotificationSetting.md b/bmusage/docs/BandwidthNotificationSetting.md new file mode 100644 index 0000000..6d5f907 --- /dev/null +++ b/bmusage/docs/BandwidthNotificationSetting.md @@ -0,0 +1,232 @@ +# BandwidthNotificationSetting + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Actions** | Pointer to [**[]Actions**](Actions.md) | An array of notification setting actions | [optional] +**Frequency** | Pointer to **string** | Frequency | [optional] +**Id** | Pointer to **string** | Identifier of the notification setting | [optional] +**LastCheckedAt** | Pointer to **NullableString** | Date timestamp when the system last checked the server for threshold limit | [optional] +**Threshold** | Pointer to **string** | Threshold Value | [optional] +**ThresholdExceededAt** | Pointer to **NullableString** | Date timestamp when the threshold exceeded the limit | [optional] +**Unit** | Pointer to **string** | Unit | [optional] + +## Methods + +### NewBandwidthNotificationSetting + +`func NewBandwidthNotificationSetting() *BandwidthNotificationSetting` + +NewBandwidthNotificationSetting instantiates a new BandwidthNotificationSetting object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewBandwidthNotificationSettingWithDefaults + +`func NewBandwidthNotificationSettingWithDefaults() *BandwidthNotificationSetting` + +NewBandwidthNotificationSettingWithDefaults instantiates a new BandwidthNotificationSetting object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetActions + +`func (o *BandwidthNotificationSetting) GetActions() []Actions` + +GetActions returns the Actions field if non-nil, zero value otherwise. + +### GetActionsOk + +`func (o *BandwidthNotificationSetting) GetActionsOk() (*[]Actions, bool)` + +GetActionsOk returns a tuple with the Actions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActions + +`func (o *BandwidthNotificationSetting) SetActions(v []Actions)` + +SetActions sets Actions field to given value. + +### HasActions + +`func (o *BandwidthNotificationSetting) HasActions() bool` + +HasActions returns a boolean if a field has been set. + +### GetFrequency + +`func (o *BandwidthNotificationSetting) GetFrequency() string` + +GetFrequency returns the Frequency field if non-nil, zero value otherwise. + +### GetFrequencyOk + +`func (o *BandwidthNotificationSetting) GetFrequencyOk() (*string, bool)` + +GetFrequencyOk returns a tuple with the Frequency field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFrequency + +`func (o *BandwidthNotificationSetting) SetFrequency(v string)` + +SetFrequency sets Frequency field to given value. + +### HasFrequency + +`func (o *BandwidthNotificationSetting) HasFrequency() bool` + +HasFrequency returns a boolean if a field has been set. + +### GetId + +`func (o *BandwidthNotificationSetting) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BandwidthNotificationSetting) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BandwidthNotificationSetting) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BandwidthNotificationSetting) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLastCheckedAt + +`func (o *BandwidthNotificationSetting) GetLastCheckedAt() string` + +GetLastCheckedAt returns the LastCheckedAt field if non-nil, zero value otherwise. + +### GetLastCheckedAtOk + +`func (o *BandwidthNotificationSetting) GetLastCheckedAtOk() (*string, bool)` + +GetLastCheckedAtOk returns a tuple with the LastCheckedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastCheckedAt + +`func (o *BandwidthNotificationSetting) SetLastCheckedAt(v string)` + +SetLastCheckedAt sets LastCheckedAt field to given value. + +### HasLastCheckedAt + +`func (o *BandwidthNotificationSetting) HasLastCheckedAt() bool` + +HasLastCheckedAt returns a boolean if a field has been set. + +### SetLastCheckedAtNil + +`func (o *BandwidthNotificationSetting) SetLastCheckedAtNil(b bool)` + + SetLastCheckedAtNil sets the value for LastCheckedAt to be an explicit nil + +### UnsetLastCheckedAt +`func (o *BandwidthNotificationSetting) UnsetLastCheckedAt()` + +UnsetLastCheckedAt ensures that no value is present for LastCheckedAt, not even an explicit nil +### GetThreshold + +`func (o *BandwidthNotificationSetting) GetThreshold() string` + +GetThreshold returns the Threshold field if non-nil, zero value otherwise. + +### GetThresholdOk + +`func (o *BandwidthNotificationSetting) GetThresholdOk() (*string, bool)` + +GetThresholdOk returns a tuple with the Threshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThreshold + +`func (o *BandwidthNotificationSetting) SetThreshold(v string)` + +SetThreshold sets Threshold field to given value. + +### HasThreshold + +`func (o *BandwidthNotificationSetting) HasThreshold() bool` + +HasThreshold returns a boolean if a field has been set. + +### GetThresholdExceededAt + +`func (o *BandwidthNotificationSetting) GetThresholdExceededAt() string` + +GetThresholdExceededAt returns the ThresholdExceededAt field if non-nil, zero value otherwise. + +### GetThresholdExceededAtOk + +`func (o *BandwidthNotificationSetting) GetThresholdExceededAtOk() (*string, bool)` + +GetThresholdExceededAtOk returns a tuple with the ThresholdExceededAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThresholdExceededAt + +`func (o *BandwidthNotificationSetting) SetThresholdExceededAt(v string)` + +SetThresholdExceededAt sets ThresholdExceededAt field to given value. + +### HasThresholdExceededAt + +`func (o *BandwidthNotificationSetting) HasThresholdExceededAt() bool` + +HasThresholdExceededAt returns a boolean if a field has been set. + +### SetThresholdExceededAtNil + +`func (o *BandwidthNotificationSetting) SetThresholdExceededAtNil(b bool)` + + SetThresholdExceededAtNil sets the value for ThresholdExceededAt to be an explicit nil + +### UnsetThresholdExceededAt +`func (o *BandwidthNotificationSetting) UnsetThresholdExceededAt()` + +UnsetThresholdExceededAt ensures that no value is present for ThresholdExceededAt, not even an explicit nil +### GetUnit + +`func (o *BandwidthNotificationSetting) GetUnit() string` + +GetUnit returns the Unit field if non-nil, zero value otherwise. + +### GetUnitOk + +`func (o *BandwidthNotificationSetting) GetUnitOk() (*string, bool)` + +GetUnitOk returns a tuple with the Unit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnit + +`func (o *BandwidthNotificationSetting) SetUnit(v string)` + +SetUnit sets Unit field to given value. + +### HasUnit + +`func (o *BandwidthNotificationSetting) HasUnit() bool` + +HasUnit returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmusage/docs/BandwidthNotificationSettingOpts.md b/bmusage/docs/BandwidthNotificationSettingOpts.md new file mode 100644 index 0000000..e896093 --- /dev/null +++ b/bmusage/docs/BandwidthNotificationSettingOpts.md @@ -0,0 +1,93 @@ +# BandwidthNotificationSettingOpts + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Frequency** | **string** | Frequency for the Bandwidth Notification | +**Threshold** | **string** | Threshold Value for the Bandwidth Notification | +**Unit** | **string** | Unit for the Bandwidth Notification | + +## Methods + +### NewBandwidthNotificationSettingOpts + +`func NewBandwidthNotificationSettingOpts(frequency string, threshold string, unit string, ) *BandwidthNotificationSettingOpts` + +NewBandwidthNotificationSettingOpts instantiates a new BandwidthNotificationSettingOpts object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewBandwidthNotificationSettingOptsWithDefaults + +`func NewBandwidthNotificationSettingOptsWithDefaults() *BandwidthNotificationSettingOpts` + +NewBandwidthNotificationSettingOptsWithDefaults instantiates a new BandwidthNotificationSettingOpts object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetFrequency + +`func (o *BandwidthNotificationSettingOpts) GetFrequency() string` + +GetFrequency returns the Frequency field if non-nil, zero value otherwise. + +### GetFrequencyOk + +`func (o *BandwidthNotificationSettingOpts) GetFrequencyOk() (*string, bool)` + +GetFrequencyOk returns a tuple with the Frequency field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFrequency + +`func (o *BandwidthNotificationSettingOpts) SetFrequency(v string)` + +SetFrequency sets Frequency field to given value. + + +### GetThreshold + +`func (o *BandwidthNotificationSettingOpts) GetThreshold() string` + +GetThreshold returns the Threshold field if non-nil, zero value otherwise. + +### GetThresholdOk + +`func (o *BandwidthNotificationSettingOpts) GetThresholdOk() (*string, bool)` + +GetThresholdOk returns a tuple with the Threshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThreshold + +`func (o *BandwidthNotificationSettingOpts) SetThreshold(v string)` + +SetThreshold sets Threshold field to given value. + + +### GetUnit + +`func (o *BandwidthNotificationSettingOpts) GetUnit() string` + +GetUnit returns the Unit field if non-nil, zero value otherwise. + +### GetUnitOk + +`func (o *BandwidthNotificationSettingOpts) GetUnitOk() (*string, bool)` + +GetUnitOk returns a tuple with the Unit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnit + +`func (o *BandwidthNotificationSettingOpts) SetUnit(v string)` + +SetUnit sets Unit field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmusage/docs/BmusageAPI.md b/bmusage/docs/BmusageAPI.md new file mode 100644 index 0000000..f5f788f --- /dev/null +++ b/bmusage/docs/BmusageAPI.md @@ -0,0 +1,908 @@ +# \BmusageAPI + +All URIs are relative to *https://api.leaseweb.com/internal/bmusageapi/v2* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CreateServerBandwidthNotificationSettingJson**](BmusageAPI.md#CreateServerBandwidthNotificationSettingJson) | **Post** /servers/{serverId}/notificationSettings/bandwidth | Create a bandwidth notification setting +[**CreateServerDataTrafficNotificationSetting**](BmusageAPI.md#CreateServerDataTrafficNotificationSetting) | **Post** /servers/{serverId}/notificationSettings/datatraffic | Create a data traffic notification setting +[**DeleteServerBandwidthNotificationSetting**](BmusageAPI.md#DeleteServerBandwidthNotificationSetting) | **Delete** /servers/{serverId}/notificationSettings/bandwidth/{notificationSettingId} | Delete a bandwidth notification setting +[**DeleteServerDataTrafficNotificationSetting**](BmusageAPI.md#DeleteServerDataTrafficNotificationSetting) | **Delete** /servers/{serverId}/notificationSettings/datatraffic/{notificationSettingId} | Delete a data traffic notification setting +[**GetServerBandwidthNotificationSetting**](BmusageAPI.md#GetServerBandwidthNotificationSetting) | **Get** /servers/{serverId}/notificationSettings/bandwidth/{notificationSettingId} | Show a bandwidth notification setting +[**GetServerBandwidthNotificationSettingList**](BmusageAPI.md#GetServerBandwidthNotificationSettingList) | **Get** /servers/{serverId}/notificationSettings/bandwidth | List bandwidth notification settings +[**GetServerDataTrafficMetrics**](BmusageAPI.md#GetServerDataTrafficMetrics) | **Get** /servers/{serverId}/metrics/datatraffic | Show datatraffic metrics +[**GetServerDataTrafficNotificationSetting**](BmusageAPI.md#GetServerDataTrafficNotificationSetting) | **Get** /servers/{serverId}/notificationSettings/datatraffic/{notificationSettingId} | Show a data traffic notification setting +[**GetServerDataTrafficNotificationSettingList**](BmusageAPI.md#GetServerDataTrafficNotificationSettingList) | **Get** /servers/{serverId}/notificationSettings/datatraffic | List data traffic notification settings +[**ServersMetricsBandwidth**](BmusageAPI.md#ServersMetricsBandwidth) | **Get** /servers/{serverId}/metrics/bandwidth | Show bandwidth metrics +[**UpdateServerBandwidthNotificationSetting**](BmusageAPI.md#UpdateServerBandwidthNotificationSetting) | **Put** /servers/{serverId}/notificationSettings/bandwidth/{notificationSettingId} | Update a bandwidth notification setting +[**UpdateServerDataTrafficNotificationSetting**](BmusageAPI.md#UpdateServerDataTrafficNotificationSetting) | **Put** /servers/{serverId}/notificationSettings/datatraffic/{notificationSettingId} | Update a data traffic notification setting + + + +## CreateServerBandwidthNotificationSettingJson + +> BandwidthNotificationSetting CreateServerBandwidthNotificationSettingJson(ctx, serverId).BandwidthNotificationSettingOpts(bandwidthNotificationSettingOpts).Execute() + +Create a bandwidth notification setting + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmusage" +) + +func main() { + serverId := "12345" // string | The ID of a server + bandwidthNotificationSettingOpts := *openapiclient.NewBandwidthNotificationSettingOpts("Frequency_example", "Threshold_example", "Unit_example") // BandwidthNotificationSettingOpts | (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmusageAPI.CreateServerBandwidthNotificationSettingJson(context.Background(), serverId).BandwidthNotificationSettingOpts(bandwidthNotificationSettingOpts).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmusageAPI.CreateServerBandwidthNotificationSettingJson``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateServerBandwidthNotificationSettingJson`: BandwidthNotificationSetting + fmt.Fprintf(os.Stdout, "Response from `BmusageAPI.CreateServerBandwidthNotificationSettingJson`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateServerBandwidthNotificationSettingJsonRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **bandwidthNotificationSettingOpts** | [**BandwidthNotificationSettingOpts**](BandwidthNotificationSettingOpts.md) | | + +### Return type + +[**BandwidthNotificationSetting**](BandwidthNotificationSetting.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## CreateServerDataTrafficNotificationSetting + +> DataTrafficNotificationSetting CreateServerDataTrafficNotificationSetting(ctx, serverId).DataTrafficNotificationSettingOpts(dataTrafficNotificationSettingOpts).Execute() + +Create a data traffic notification setting + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmusage" +) + +func main() { + serverId := "12345" // string | The ID of a server + dataTrafficNotificationSettingOpts := *openapiclient.NewDataTrafficNotificationSettingOpts("Frequency_example", "Threshold_example", "Unit_example") // DataTrafficNotificationSettingOpts | (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmusageAPI.CreateServerDataTrafficNotificationSetting(context.Background(), serverId).DataTrafficNotificationSettingOpts(dataTrafficNotificationSettingOpts).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmusageAPI.CreateServerDataTrafficNotificationSetting``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateServerDataTrafficNotificationSetting`: DataTrafficNotificationSetting + fmt.Fprintf(os.Stdout, "Response from `BmusageAPI.CreateServerDataTrafficNotificationSetting`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateServerDataTrafficNotificationSettingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **dataTrafficNotificationSettingOpts** | [**DataTrafficNotificationSettingOpts**](DataTrafficNotificationSettingOpts.md) | | + +### Return type + +[**DataTrafficNotificationSetting**](DataTrafficNotificationSetting.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteServerBandwidthNotificationSetting + +> DeleteServerBandwidthNotificationSetting(ctx, serverId, notificationSettingId).Execute() + +Delete a bandwidth notification setting + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmusage" +) + +func main() { + serverId := "12345" // string | The ID of a server + notificationSettingId := "839111" // string | The ID of a notification setting + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.BmusageAPI.DeleteServerBandwidthNotificationSetting(context.Background(), serverId, notificationSettingId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmusageAPI.DeleteServerBandwidthNotificationSetting``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | +**notificationSettingId** | **string** | The ID of a notification setting | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteServerBandwidthNotificationSettingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteServerDataTrafficNotificationSetting + +> DeleteServerDataTrafficNotificationSetting(ctx, serverId, notificationSettingId).Execute() + +Delete a data traffic notification setting + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmusage" +) + +func main() { + serverId := "12345" // string | The ID of a server + notificationSettingId := "839111" // string | The ID of a notification setting + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.BmusageAPI.DeleteServerDataTrafficNotificationSetting(context.Background(), serverId, notificationSettingId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmusageAPI.DeleteServerDataTrafficNotificationSetting``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | +**notificationSettingId** | **string** | The ID of a notification setting | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteServerDataTrafficNotificationSettingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetServerBandwidthNotificationSetting + +> BandwidthNotificationSetting GetServerBandwidthNotificationSetting(ctx, serverId, notificationSettingId).Execute() + +Show a bandwidth notification setting + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmusage" +) + +func main() { + serverId := "12345" // string | The ID of a server + notificationSettingId := "839111" // string | The ID of a notification setting + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmusageAPI.GetServerBandwidthNotificationSetting(context.Background(), serverId, notificationSettingId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmusageAPI.GetServerBandwidthNotificationSetting``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServerBandwidthNotificationSetting`: BandwidthNotificationSetting + fmt.Fprintf(os.Stdout, "Response from `BmusageAPI.GetServerBandwidthNotificationSetting`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | +**notificationSettingId** | **string** | The ID of a notification setting | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServerBandwidthNotificationSettingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**BandwidthNotificationSetting**](BandwidthNotificationSetting.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetServerBandwidthNotificationSettingList + +> GetServerBandwidthNotificationSettingListResult GetServerBandwidthNotificationSettingList(ctx, serverId).Limit(limit).Offset(offset).Execute() + +List bandwidth notification settings + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmusage" +) + +func main() { + serverId := "12345" // string | The ID of a server + limit := int32(20) // int32 | Limit the number of results returned. (optional) + offset := int32(10) // int32 | Return results starting from the given offset. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmusageAPI.GetServerBandwidthNotificationSettingList(context.Background(), serverId).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmusageAPI.GetServerBandwidthNotificationSettingList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServerBandwidthNotificationSettingList`: GetServerBandwidthNotificationSettingListResult + fmt.Fprintf(os.Stdout, "Response from `BmusageAPI.GetServerBandwidthNotificationSettingList`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServerBandwidthNotificationSettingListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **limit** | **int32** | Limit the number of results returned. | + **offset** | **int32** | Return results starting from the given offset. | + +### Return type + +[**GetServerBandwidthNotificationSettingListResult**](GetServerBandwidthNotificationSettingListResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetServerDataTrafficMetrics + +> Metrics GetServerDataTrafficMetrics(ctx, serverId).From(from).To(to).Aggregation(aggregation).Granularity(granularity).Execute() + +Show datatraffic metrics + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "time" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmusage" +) + +func main() { + serverId := "12345" // string | The ID of a server + from := time.Now() // time.Time | Start of date interval in ISO-8601 format. The returned data will include everything up from - and including - the specified date time. + to := time.Now() // time.Time | End of date interval in ISO-8601 format. The returned data will include everything up until - but not including - the specified date time. + aggregation := "aggregation_example" // string | Aggregate each metric using the given aggregation function. + granularity := "granularity_example" // string | Specify the preferred interval for each metric. If granularity is omitted from the request, only one metric is returned. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmusageAPI.GetServerDataTrafficMetrics(context.Background(), serverId).From(from).To(to).Aggregation(aggregation).Granularity(granularity).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmusageAPI.GetServerDataTrafficMetrics``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServerDataTrafficMetrics`: Metrics + fmt.Fprintf(os.Stdout, "Response from `BmusageAPI.GetServerDataTrafficMetrics`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServerDataTrafficMetricsRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **from** | **time.Time** | Start of date interval in ISO-8601 format. The returned data will include everything up from - and including - the specified date time. | + **to** | **time.Time** | End of date interval in ISO-8601 format. The returned data will include everything up until - but not including - the specified date time. | + **aggregation** | **string** | Aggregate each metric using the given aggregation function. | + **granularity** | **string** | Specify the preferred interval for each metric. If granularity is omitted from the request, only one metric is returned. | + +### Return type + +[**Metrics**](Metrics.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetServerDataTrafficNotificationSetting + +> DataTrafficNotificationSetting GetServerDataTrafficNotificationSetting(ctx, serverId, notificationSettingId).Execute() + +Show a data traffic notification setting + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmusage" +) + +func main() { + serverId := "12345" // string | The ID of a server + notificationSettingId := "839111" // string | The ID of a notification setting + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmusageAPI.GetServerDataTrafficNotificationSetting(context.Background(), serverId, notificationSettingId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmusageAPI.GetServerDataTrafficNotificationSetting``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServerDataTrafficNotificationSetting`: DataTrafficNotificationSetting + fmt.Fprintf(os.Stdout, "Response from `BmusageAPI.GetServerDataTrafficNotificationSetting`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | +**notificationSettingId** | **string** | The ID of a notification setting | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServerDataTrafficNotificationSettingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**DataTrafficNotificationSetting**](DataTrafficNotificationSetting.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetServerDataTrafficNotificationSettingList + +> GetServerDataTrafficNotificationSettingListResult GetServerDataTrafficNotificationSettingList(ctx, serverId).Limit(limit).Offset(offset).Execute() + +List data traffic notification settings + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmusage" +) + +func main() { + serverId := "12345" // string | The ID of a server + limit := int32(20) // int32 | Limit the number of results returned. (optional) + offset := int32(10) // int32 | Return results starting from the given offset. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmusageAPI.GetServerDataTrafficNotificationSettingList(context.Background(), serverId).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmusageAPI.GetServerDataTrafficNotificationSettingList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServerDataTrafficNotificationSettingList`: GetServerDataTrafficNotificationSettingListResult + fmt.Fprintf(os.Stdout, "Response from `BmusageAPI.GetServerDataTrafficNotificationSettingList`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServerDataTrafficNotificationSettingListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **limit** | **int32** | Limit the number of results returned. | + **offset** | **int32** | Return results starting from the given offset. | + +### Return type + +[**GetServerDataTrafficNotificationSettingListResult**](GetServerDataTrafficNotificationSettingListResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ServersMetricsBandwidth + +> Metrics ServersMetricsBandwidth(ctx, serverId).From(from).To(to).Aggregation(aggregation).Granularity(granularity).Execute() + +Show bandwidth metrics + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "time" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmusage" +) + +func main() { + serverId := "12345" // string | The ID of a server + from := time.Now() // time.Time | Start of date interval in ISO-8601 format. The returned data will include everything up from - and including - the specified date time. + to := time.Now() // time.Time | End of date interval in ISO-8601 format. The returned data will include everything up until - but not including - the specified date time. + aggregation := "aggregation_example" // string | Aggregate each metric using the given aggregation function. When the aggregation type `95TH` is specified the granularity parameter should be omitted from the request. + granularity := "granularity_example" // string | Specify the preferred interval for each metric. If granularity is omitted from the request, only one metric is returned. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmusageAPI.ServersMetricsBandwidth(context.Background(), serverId).From(from).To(to).Aggregation(aggregation).Granularity(granularity).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmusageAPI.ServersMetricsBandwidth``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `ServersMetricsBandwidth`: Metrics + fmt.Fprintf(os.Stdout, "Response from `BmusageAPI.ServersMetricsBandwidth`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiServersMetricsBandwidthRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **from** | **time.Time** | Start of date interval in ISO-8601 format. The returned data will include everything up from - and including - the specified date time. | + **to** | **time.Time** | End of date interval in ISO-8601 format. The returned data will include everything up until - but not including - the specified date time. | + **aggregation** | **string** | Aggregate each metric using the given aggregation function. When the aggregation type `95TH` is specified the granularity parameter should be omitted from the request. | + **granularity** | **string** | Specify the preferred interval for each metric. If granularity is omitted from the request, only one metric is returned. | + +### Return type + +[**Metrics**](Metrics.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateServerBandwidthNotificationSetting + +> BandwidthNotificationSetting UpdateServerBandwidthNotificationSetting(ctx, serverId, notificationSettingId).BandwidthNotificationSettingOpts(bandwidthNotificationSettingOpts).Execute() + +Update a bandwidth notification setting + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmusage" +) + +func main() { + serverId := "12345" // string | The ID of a server + notificationSettingId := "839111" // string | The ID of a notification setting + bandwidthNotificationSettingOpts := *openapiclient.NewBandwidthNotificationSettingOpts("Frequency_example", "Threshold_example", "Unit_example") // BandwidthNotificationSettingOpts | (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmusageAPI.UpdateServerBandwidthNotificationSetting(context.Background(), serverId, notificationSettingId).BandwidthNotificationSettingOpts(bandwidthNotificationSettingOpts).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmusageAPI.UpdateServerBandwidthNotificationSetting``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateServerBandwidthNotificationSetting`: BandwidthNotificationSetting + fmt.Fprintf(os.Stdout, "Response from `BmusageAPI.UpdateServerBandwidthNotificationSetting`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | +**notificationSettingId** | **string** | The ID of a notification setting | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateServerBandwidthNotificationSettingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **bandwidthNotificationSettingOpts** | [**BandwidthNotificationSettingOpts**](BandwidthNotificationSettingOpts.md) | | + +### Return type + +[**BandwidthNotificationSetting**](BandwidthNotificationSetting.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateServerDataTrafficNotificationSetting + +> DataTrafficNotificationSettingOpts UpdateServerDataTrafficNotificationSetting(ctx, serverId, notificationSettingId).DataTrafficNotificationSettingOpts(dataTrafficNotificationSettingOpts).Execute() + +Update a data traffic notification setting + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/bmusage" +) + +func main() { + serverId := "12345" // string | The ID of a server + notificationSettingId := "839111" // string | The ID of a notification setting + dataTrafficNotificationSettingOpts := *openapiclient.NewDataTrafficNotificationSettingOpts("Frequency_example", "Threshold_example", "Unit_example") // DataTrafficNotificationSettingOpts | (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.BmusageAPI.UpdateServerDataTrafficNotificationSetting(context.Background(), serverId, notificationSettingId).DataTrafficNotificationSettingOpts(dataTrafficNotificationSettingOpts).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `BmusageAPI.UpdateServerDataTrafficNotificationSetting``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateServerDataTrafficNotificationSetting`: DataTrafficNotificationSettingOpts + fmt.Fprintf(os.Stdout, "Response from `BmusageAPI.UpdateServerDataTrafficNotificationSetting`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | +**notificationSettingId** | **string** | The ID of a notification setting | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateServerDataTrafficNotificationSettingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **dataTrafficNotificationSettingOpts** | [**DataTrafficNotificationSettingOpts**](DataTrafficNotificationSettingOpts.md) | | + +### Return type + +[**DataTrafficNotificationSettingOpts**](DataTrafficNotificationSettingOpts.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/bmusage/docs/DataTrafficNotificationSetting.md b/bmusage/docs/DataTrafficNotificationSetting.md new file mode 100644 index 0000000..f1c9126 --- /dev/null +++ b/bmusage/docs/DataTrafficNotificationSetting.md @@ -0,0 +1,232 @@ +# DataTrafficNotificationSetting + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Actions** | Pointer to [**[]Actions**](Actions.md) | An array of notification setting actions | [optional] +**Frequency** | Pointer to **string** | Frequency | [optional] +**Id** | Pointer to **string** | Identifier of the notification setting | [optional] +**LastCheckedAt** | Pointer to **NullableString** | Date timestamp when the system last checked the server for threshold limit | [optional] +**Threshold** | Pointer to **string** | Threshold Value | [optional] +**ThresholdExceededAt** | Pointer to **NullableString** | Date timestamp when the threshold exceeded the limit | [optional] +**Unit** | Pointer to **string** | Unit | [optional] + +## Methods + +### NewDataTrafficNotificationSetting + +`func NewDataTrafficNotificationSetting() *DataTrafficNotificationSetting` + +NewDataTrafficNotificationSetting instantiates a new DataTrafficNotificationSetting object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDataTrafficNotificationSettingWithDefaults + +`func NewDataTrafficNotificationSettingWithDefaults() *DataTrafficNotificationSetting` + +NewDataTrafficNotificationSettingWithDefaults instantiates a new DataTrafficNotificationSetting object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetActions + +`func (o *DataTrafficNotificationSetting) GetActions() []Actions` + +GetActions returns the Actions field if non-nil, zero value otherwise. + +### GetActionsOk + +`func (o *DataTrafficNotificationSetting) GetActionsOk() (*[]Actions, bool)` + +GetActionsOk returns a tuple with the Actions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActions + +`func (o *DataTrafficNotificationSetting) SetActions(v []Actions)` + +SetActions sets Actions field to given value. + +### HasActions + +`func (o *DataTrafficNotificationSetting) HasActions() bool` + +HasActions returns a boolean if a field has been set. + +### GetFrequency + +`func (o *DataTrafficNotificationSetting) GetFrequency() string` + +GetFrequency returns the Frequency field if non-nil, zero value otherwise. + +### GetFrequencyOk + +`func (o *DataTrafficNotificationSetting) GetFrequencyOk() (*string, bool)` + +GetFrequencyOk returns a tuple with the Frequency field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFrequency + +`func (o *DataTrafficNotificationSetting) SetFrequency(v string)` + +SetFrequency sets Frequency field to given value. + +### HasFrequency + +`func (o *DataTrafficNotificationSetting) HasFrequency() bool` + +HasFrequency returns a boolean if a field has been set. + +### GetId + +`func (o *DataTrafficNotificationSetting) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DataTrafficNotificationSetting) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DataTrafficNotificationSetting) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *DataTrafficNotificationSetting) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLastCheckedAt + +`func (o *DataTrafficNotificationSetting) GetLastCheckedAt() string` + +GetLastCheckedAt returns the LastCheckedAt field if non-nil, zero value otherwise. + +### GetLastCheckedAtOk + +`func (o *DataTrafficNotificationSetting) GetLastCheckedAtOk() (*string, bool)` + +GetLastCheckedAtOk returns a tuple with the LastCheckedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastCheckedAt + +`func (o *DataTrafficNotificationSetting) SetLastCheckedAt(v string)` + +SetLastCheckedAt sets LastCheckedAt field to given value. + +### HasLastCheckedAt + +`func (o *DataTrafficNotificationSetting) HasLastCheckedAt() bool` + +HasLastCheckedAt returns a boolean if a field has been set. + +### SetLastCheckedAtNil + +`func (o *DataTrafficNotificationSetting) SetLastCheckedAtNil(b bool)` + + SetLastCheckedAtNil sets the value for LastCheckedAt to be an explicit nil + +### UnsetLastCheckedAt +`func (o *DataTrafficNotificationSetting) UnsetLastCheckedAt()` + +UnsetLastCheckedAt ensures that no value is present for LastCheckedAt, not even an explicit nil +### GetThreshold + +`func (o *DataTrafficNotificationSetting) GetThreshold() string` + +GetThreshold returns the Threshold field if non-nil, zero value otherwise. + +### GetThresholdOk + +`func (o *DataTrafficNotificationSetting) GetThresholdOk() (*string, bool)` + +GetThresholdOk returns a tuple with the Threshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThreshold + +`func (o *DataTrafficNotificationSetting) SetThreshold(v string)` + +SetThreshold sets Threshold field to given value. + +### HasThreshold + +`func (o *DataTrafficNotificationSetting) HasThreshold() bool` + +HasThreshold returns a boolean if a field has been set. + +### GetThresholdExceededAt + +`func (o *DataTrafficNotificationSetting) GetThresholdExceededAt() string` + +GetThresholdExceededAt returns the ThresholdExceededAt field if non-nil, zero value otherwise. + +### GetThresholdExceededAtOk + +`func (o *DataTrafficNotificationSetting) GetThresholdExceededAtOk() (*string, bool)` + +GetThresholdExceededAtOk returns a tuple with the ThresholdExceededAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThresholdExceededAt + +`func (o *DataTrafficNotificationSetting) SetThresholdExceededAt(v string)` + +SetThresholdExceededAt sets ThresholdExceededAt field to given value. + +### HasThresholdExceededAt + +`func (o *DataTrafficNotificationSetting) HasThresholdExceededAt() bool` + +HasThresholdExceededAt returns a boolean if a field has been set. + +### SetThresholdExceededAtNil + +`func (o *DataTrafficNotificationSetting) SetThresholdExceededAtNil(b bool)` + + SetThresholdExceededAtNil sets the value for ThresholdExceededAt to be an explicit nil + +### UnsetThresholdExceededAt +`func (o *DataTrafficNotificationSetting) UnsetThresholdExceededAt()` + +UnsetThresholdExceededAt ensures that no value is present for ThresholdExceededAt, not even an explicit nil +### GetUnit + +`func (o *DataTrafficNotificationSetting) GetUnit() string` + +GetUnit returns the Unit field if non-nil, zero value otherwise. + +### GetUnitOk + +`func (o *DataTrafficNotificationSetting) GetUnitOk() (*string, bool)` + +GetUnitOk returns a tuple with the Unit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnit + +`func (o *DataTrafficNotificationSetting) SetUnit(v string)` + +SetUnit sets Unit field to given value. + +### HasUnit + +`func (o *DataTrafficNotificationSetting) HasUnit() bool` + +HasUnit returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmusage/docs/DataTrafficNotificationSettingOpts.md b/bmusage/docs/DataTrafficNotificationSettingOpts.md new file mode 100644 index 0000000..579864a --- /dev/null +++ b/bmusage/docs/DataTrafficNotificationSettingOpts.md @@ -0,0 +1,93 @@ +# DataTrafficNotificationSettingOpts + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Frequency** | **string** | Frequency for the Data Traffic Notification | +**Threshold** | **string** | Threshold Value for the Data Traffic Notification | +**Unit** | **string** | Unit for the Data Traffic Notification | + +## Methods + +### NewDataTrafficNotificationSettingOpts + +`func NewDataTrafficNotificationSettingOpts(frequency string, threshold string, unit string, ) *DataTrafficNotificationSettingOpts` + +NewDataTrafficNotificationSettingOpts instantiates a new DataTrafficNotificationSettingOpts object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDataTrafficNotificationSettingOptsWithDefaults + +`func NewDataTrafficNotificationSettingOptsWithDefaults() *DataTrafficNotificationSettingOpts` + +NewDataTrafficNotificationSettingOptsWithDefaults instantiates a new DataTrafficNotificationSettingOpts object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetFrequency + +`func (o *DataTrafficNotificationSettingOpts) GetFrequency() string` + +GetFrequency returns the Frequency field if non-nil, zero value otherwise. + +### GetFrequencyOk + +`func (o *DataTrafficNotificationSettingOpts) GetFrequencyOk() (*string, bool)` + +GetFrequencyOk returns a tuple with the Frequency field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFrequency + +`func (o *DataTrafficNotificationSettingOpts) SetFrequency(v string)` + +SetFrequency sets Frequency field to given value. + + +### GetThreshold + +`func (o *DataTrafficNotificationSettingOpts) GetThreshold() string` + +GetThreshold returns the Threshold field if non-nil, zero value otherwise. + +### GetThresholdOk + +`func (o *DataTrafficNotificationSettingOpts) GetThresholdOk() (*string, bool)` + +GetThresholdOk returns a tuple with the Threshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThreshold + +`func (o *DataTrafficNotificationSettingOpts) SetThreshold(v string)` + +SetThreshold sets Threshold field to given value. + + +### GetUnit + +`func (o *DataTrafficNotificationSettingOpts) GetUnit() string` + +GetUnit returns the Unit field if non-nil, zero value otherwise. + +### GetUnitOk + +`func (o *DataTrafficNotificationSettingOpts) GetUnitOk() (*string, bool)` + +GetUnitOk returns a tuple with the Unit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnit + +`func (o *DataTrafficNotificationSettingOpts) SetUnit(v string)` + +SetUnit sets Unit field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmusage/docs/ErrorResult.md b/bmusage/docs/ErrorResult.md new file mode 100644 index 0000000..af3c285 --- /dev/null +++ b/bmusage/docs/ErrorResult.md @@ -0,0 +1,134 @@ +# ErrorResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CorrelationId** | Pointer to **string** | The correlation ID of the current request. | [optional] +**ErrorCode** | Pointer to **string** | The error code. | [optional] +**ErrorMessage** | Pointer to **string** | A human friendly description of the error. | [optional] +**ErrorDetails** | Pointer to [**[]map[string][]string**](map[string][]string.md) | | [optional] + +## Methods + +### NewErrorResult + +`func NewErrorResult() *ErrorResult` + +NewErrorResult instantiates a new ErrorResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewErrorResultWithDefaults + +`func NewErrorResultWithDefaults() *ErrorResult` + +NewErrorResultWithDefaults instantiates a new ErrorResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCorrelationId + +`func (o *ErrorResult) GetCorrelationId() string` + +GetCorrelationId returns the CorrelationId field if non-nil, zero value otherwise. + +### GetCorrelationIdOk + +`func (o *ErrorResult) GetCorrelationIdOk() (*string, bool)` + +GetCorrelationIdOk returns a tuple with the CorrelationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelationId + +`func (o *ErrorResult) SetCorrelationId(v string)` + +SetCorrelationId sets CorrelationId field to given value. + +### HasCorrelationId + +`func (o *ErrorResult) HasCorrelationId() bool` + +HasCorrelationId returns a boolean if a field has been set. + +### GetErrorCode + +`func (o *ErrorResult) GetErrorCode() string` + +GetErrorCode returns the ErrorCode field if non-nil, zero value otherwise. + +### GetErrorCodeOk + +`func (o *ErrorResult) GetErrorCodeOk() (*string, bool)` + +GetErrorCodeOk returns a tuple with the ErrorCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorCode + +`func (o *ErrorResult) SetErrorCode(v string)` + +SetErrorCode sets ErrorCode field to given value. + +### HasErrorCode + +`func (o *ErrorResult) HasErrorCode() bool` + +HasErrorCode returns a boolean if a field has been set. + +### GetErrorMessage + +`func (o *ErrorResult) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *ErrorResult) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *ErrorResult) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *ErrorResult) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### GetErrorDetails + +`func (o *ErrorResult) GetErrorDetails() []map[string][]string` + +GetErrorDetails returns the ErrorDetails field if non-nil, zero value otherwise. + +### GetErrorDetailsOk + +`func (o *ErrorResult) GetErrorDetailsOk() (*[]map[string][]string, bool)` + +GetErrorDetailsOk returns a tuple with the ErrorDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorDetails + +`func (o *ErrorResult) SetErrorDetails(v []map[string][]string)` + +SetErrorDetails sets ErrorDetails field to given value. + +### HasErrorDetails + +`func (o *ErrorResult) HasErrorDetails() bool` + +HasErrorDetails returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmusage/docs/GetServerBandwidthNotificationSettingListResult.md b/bmusage/docs/GetServerBandwidthNotificationSettingListResult.md new file mode 100644 index 0000000..4f63f13 --- /dev/null +++ b/bmusage/docs/GetServerBandwidthNotificationSettingListResult.md @@ -0,0 +1,82 @@ +# GetServerBandwidthNotificationSettingListResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Metadata** | Pointer to [**Metadata**](Metadata.md) | | [optional] +**BandwidthNotificationSettings** | Pointer to [**[]BandwidthNotificationSetting**](BandwidthNotificationSetting.md) | An array of Bandwidth Notification Settings | [optional] + +## Methods + +### NewGetServerBandwidthNotificationSettingListResult + +`func NewGetServerBandwidthNotificationSettingListResult() *GetServerBandwidthNotificationSettingListResult` + +NewGetServerBandwidthNotificationSettingListResult instantiates a new GetServerBandwidthNotificationSettingListResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetServerBandwidthNotificationSettingListResultWithDefaults + +`func NewGetServerBandwidthNotificationSettingListResultWithDefaults() *GetServerBandwidthNotificationSettingListResult` + +NewGetServerBandwidthNotificationSettingListResultWithDefaults instantiates a new GetServerBandwidthNotificationSettingListResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMetadata + +`func (o *GetServerBandwidthNotificationSettingListResult) GetMetadata() Metadata` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *GetServerBandwidthNotificationSettingListResult) GetMetadataOk() (*Metadata, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *GetServerBandwidthNotificationSettingListResult) SetMetadata(v Metadata)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *GetServerBandwidthNotificationSettingListResult) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + +### GetBandwidthNotificationSettings + +`func (o *GetServerBandwidthNotificationSettingListResult) GetBandwidthNotificationSettings() []BandwidthNotificationSetting` + +GetBandwidthNotificationSettings returns the BandwidthNotificationSettings field if non-nil, zero value otherwise. + +### GetBandwidthNotificationSettingsOk + +`func (o *GetServerBandwidthNotificationSettingListResult) GetBandwidthNotificationSettingsOk() (*[]BandwidthNotificationSetting, bool)` + +GetBandwidthNotificationSettingsOk returns a tuple with the BandwidthNotificationSettings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBandwidthNotificationSettings + +`func (o *GetServerBandwidthNotificationSettingListResult) SetBandwidthNotificationSettings(v []BandwidthNotificationSetting)` + +SetBandwidthNotificationSettings sets BandwidthNotificationSettings field to given value. + +### HasBandwidthNotificationSettings + +`func (o *GetServerBandwidthNotificationSettingListResult) HasBandwidthNotificationSettings() bool` + +HasBandwidthNotificationSettings returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmusage/docs/GetServerDataTrafficNotificationSettingListResult.md b/bmusage/docs/GetServerDataTrafficNotificationSettingListResult.md new file mode 100644 index 0000000..ec9e9ed --- /dev/null +++ b/bmusage/docs/GetServerDataTrafficNotificationSettingListResult.md @@ -0,0 +1,82 @@ +# GetServerDataTrafficNotificationSettingListResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Metadata** | Pointer to [**Metadata**](Metadata.md) | | [optional] +**DatatrafficNotificationSettings** | Pointer to [**[]DataTrafficNotificationSetting**](DataTrafficNotificationSetting.md) | An array of Data traffic Notification Settings | [optional] + +## Methods + +### NewGetServerDataTrafficNotificationSettingListResult + +`func NewGetServerDataTrafficNotificationSettingListResult() *GetServerDataTrafficNotificationSettingListResult` + +NewGetServerDataTrafficNotificationSettingListResult instantiates a new GetServerDataTrafficNotificationSettingListResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetServerDataTrafficNotificationSettingListResultWithDefaults + +`func NewGetServerDataTrafficNotificationSettingListResultWithDefaults() *GetServerDataTrafficNotificationSettingListResult` + +NewGetServerDataTrafficNotificationSettingListResultWithDefaults instantiates a new GetServerDataTrafficNotificationSettingListResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMetadata + +`func (o *GetServerDataTrafficNotificationSettingListResult) GetMetadata() Metadata` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *GetServerDataTrafficNotificationSettingListResult) GetMetadataOk() (*Metadata, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *GetServerDataTrafficNotificationSettingListResult) SetMetadata(v Metadata)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *GetServerDataTrafficNotificationSettingListResult) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + +### GetDatatrafficNotificationSettings + +`func (o *GetServerDataTrafficNotificationSettingListResult) GetDatatrafficNotificationSettings() []DataTrafficNotificationSetting` + +GetDatatrafficNotificationSettings returns the DatatrafficNotificationSettings field if non-nil, zero value otherwise. + +### GetDatatrafficNotificationSettingsOk + +`func (o *GetServerDataTrafficNotificationSettingListResult) GetDatatrafficNotificationSettingsOk() (*[]DataTrafficNotificationSetting, bool)` + +GetDatatrafficNotificationSettingsOk returns a tuple with the DatatrafficNotificationSettings field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDatatrafficNotificationSettings + +`func (o *GetServerDataTrafficNotificationSettingListResult) SetDatatrafficNotificationSettings(v []DataTrafficNotificationSetting)` + +SetDatatrafficNotificationSettings sets DatatrafficNotificationSettings field to given value. + +### HasDatatrafficNotificationSettings + +`func (o *GetServerDataTrafficNotificationSettingListResult) HasDatatrafficNotificationSettings() bool` + +HasDatatrafficNotificationSettings returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmusage/docs/Metadata.md b/bmusage/docs/Metadata.md new file mode 100644 index 0000000..194d6a7 --- /dev/null +++ b/bmusage/docs/Metadata.md @@ -0,0 +1,108 @@ +# Metadata + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TotalCount** | Pointer to **float32** | Total amount of orders in this collection | [optional] +**Offset** | Pointer to **float32** | The offset used to generate this response | [optional] [default to 0] +**Limit** | Pointer to **float32** | The limit used to generate this response | [optional] [default to 5] + +## Methods + +### NewMetadata + +`func NewMetadata() *Metadata` + +NewMetadata instantiates a new Metadata object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewMetadataWithDefaults + +`func NewMetadataWithDefaults() *Metadata` + +NewMetadataWithDefaults instantiates a new Metadata object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetTotalCount + +`func (o *Metadata) GetTotalCount() float32` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *Metadata) GetTotalCountOk() (*float32, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *Metadata) SetTotalCount(v float32)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *Metadata) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + +### GetOffset + +`func (o *Metadata) GetOffset() float32` + +GetOffset returns the Offset field if non-nil, zero value otherwise. + +### GetOffsetOk + +`func (o *Metadata) GetOffsetOk() (*float32, bool)` + +GetOffsetOk returns a tuple with the Offset field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOffset + +`func (o *Metadata) SetOffset(v float32)` + +SetOffset sets Offset field to given value. + +### HasOffset + +`func (o *Metadata) HasOffset() bool` + +HasOffset returns a boolean if a field has been set. + +### GetLimit + +`func (o *Metadata) GetLimit() float32` + +GetLimit returns the Limit field if non-nil, zero value otherwise. + +### GetLimitOk + +`func (o *Metadata) GetLimitOk() (*float32, bool)` + +GetLimitOk returns a tuple with the Limit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLimit + +`func (o *Metadata) SetLimit(v float32)` + +SetLimit sets Limit field to given value. + +### HasLimit + +`func (o *Metadata) HasLimit() bool` + +HasLimit returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmusage/docs/Metric.md b/bmusage/docs/Metric.md new file mode 100644 index 0000000..68ee97b --- /dev/null +++ b/bmusage/docs/Metric.md @@ -0,0 +1,82 @@ +# Metric + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Unit** | Pointer to **string** | The metric unit that's used | [optional] +**Values** | Pointer to [**[]MetricValue**](MetricValue.md) | | [optional] + +## Methods + +### NewMetric + +`func NewMetric() *Metric` + +NewMetric instantiates a new Metric object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewMetricWithDefaults + +`func NewMetricWithDefaults() *Metric` + +NewMetricWithDefaults instantiates a new Metric object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetUnit + +`func (o *Metric) GetUnit() string` + +GetUnit returns the Unit field if non-nil, zero value otherwise. + +### GetUnitOk + +`func (o *Metric) GetUnitOk() (*string, bool)` + +GetUnitOk returns a tuple with the Unit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnit + +`func (o *Metric) SetUnit(v string)` + +SetUnit sets Unit field to given value. + +### HasUnit + +`func (o *Metric) HasUnit() bool` + +HasUnit returns a boolean if a field has been set. + +### GetValues + +`func (o *Metric) GetValues() []MetricValue` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *Metric) GetValuesOk() (*[]MetricValue, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *Metric) SetValues(v []MetricValue)` + +SetValues sets Values field to given value. + +### HasValues + +`func (o *Metric) HasValues() bool` + +HasValues returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmusage/docs/MetricValue.md b/bmusage/docs/MetricValue.md new file mode 100644 index 0000000..d9f65d1 --- /dev/null +++ b/bmusage/docs/MetricValue.md @@ -0,0 +1,82 @@ +# MetricValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Timestamp** | Pointer to **time.Time** | The time of the current metric | [optional] +**Value** | Pointer to **int32** | The value of the current metric | [optional] + +## Methods + +### NewMetricValue + +`func NewMetricValue() *MetricValue` + +NewMetricValue instantiates a new MetricValue object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewMetricValueWithDefaults + +`func NewMetricValueWithDefaults() *MetricValue` + +NewMetricValueWithDefaults instantiates a new MetricValue object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetTimestamp + +`func (o *MetricValue) GetTimestamp() time.Time` + +GetTimestamp returns the Timestamp field if non-nil, zero value otherwise. + +### GetTimestampOk + +`func (o *MetricValue) GetTimestampOk() (*time.Time, bool)` + +GetTimestampOk returns a tuple with the Timestamp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTimestamp + +`func (o *MetricValue) SetTimestamp(v time.Time)` + +SetTimestamp sets Timestamp field to given value. + +### HasTimestamp + +`func (o *MetricValue) HasTimestamp() bool` + +HasTimestamp returns a boolean if a field has been set. + +### GetValue + +`func (o *MetricValue) GetValue() int32` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *MetricValue) GetValueOk() (*int32, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *MetricValue) SetValue(v int32)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *MetricValue) HasValue() bool` + +HasValue returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmusage/docs/MetricValues.md b/bmusage/docs/MetricValues.md new file mode 100644 index 0000000..2d89a41 --- /dev/null +++ b/bmusage/docs/MetricValues.md @@ -0,0 +1,82 @@ +# MetricValues + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UP_PUBLIC** | Pointer to [**Metric**](Metric.md) | | [optional] +**DOWN_PUBLIC** | Pointer to [**Metric**](Metric.md) | | [optional] + +## Methods + +### NewMetricValues + +`func NewMetricValues() *MetricValues` + +NewMetricValues instantiates a new MetricValues object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewMetricValuesWithDefaults + +`func NewMetricValuesWithDefaults() *MetricValues` + +NewMetricValuesWithDefaults instantiates a new MetricValues object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetUP_PUBLIC + +`func (o *MetricValues) GetUP_PUBLIC() Metric` + +GetUP_PUBLIC returns the UP_PUBLIC field if non-nil, zero value otherwise. + +### GetUP_PUBLICOk + +`func (o *MetricValues) GetUP_PUBLICOk() (*Metric, bool)` + +GetUP_PUBLICOk returns a tuple with the UP_PUBLIC field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUP_PUBLIC + +`func (o *MetricValues) SetUP_PUBLIC(v Metric)` + +SetUP_PUBLIC sets UP_PUBLIC field to given value. + +### HasUP_PUBLIC + +`func (o *MetricValues) HasUP_PUBLIC() bool` + +HasUP_PUBLIC returns a boolean if a field has been set. + +### GetDOWN_PUBLIC + +`func (o *MetricValues) GetDOWN_PUBLIC() Metric` + +GetDOWN_PUBLIC returns the DOWN_PUBLIC field if non-nil, zero value otherwise. + +### GetDOWN_PUBLICOk + +`func (o *MetricValues) GetDOWN_PUBLICOk() (*Metric, bool)` + +GetDOWN_PUBLICOk returns a tuple with the DOWN_PUBLIC field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDOWN_PUBLIC + +`func (o *MetricValues) SetDOWN_PUBLIC(v Metric)` + +SetDOWN_PUBLIC sets DOWN_PUBLIC field to given value. + +### HasDOWN_PUBLIC + +`func (o *MetricValues) HasDOWN_PUBLIC() bool` + +HasDOWN_PUBLIC returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmusage/docs/Metrics.md b/bmusage/docs/Metrics.md new file mode 100644 index 0000000..caf0758 --- /dev/null +++ b/bmusage/docs/Metrics.md @@ -0,0 +1,82 @@ +# Metrics + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Metadata** | Pointer to [**MetricsMetadata**](MetricsMetadata.md) | | [optional] +**Metrics** | Pointer to [**MetricValues**](MetricValues.md) | | [optional] + +## Methods + +### NewMetrics + +`func NewMetrics() *Metrics` + +NewMetrics instantiates a new Metrics object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewMetricsWithDefaults + +`func NewMetricsWithDefaults() *Metrics` + +NewMetricsWithDefaults instantiates a new Metrics object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMetadata + +`func (o *Metrics) GetMetadata() MetricsMetadata` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *Metrics) GetMetadataOk() (*MetricsMetadata, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *Metrics) SetMetadata(v MetricsMetadata)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *Metrics) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + +### GetMetrics + +`func (o *Metrics) GetMetrics() MetricValues` + +GetMetrics returns the Metrics field if non-nil, zero value otherwise. + +### GetMetricsOk + +`func (o *Metrics) GetMetricsOk() (*MetricValues, bool)` + +GetMetricsOk returns a tuple with the Metrics field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetrics + +`func (o *Metrics) SetMetrics(v MetricValues)` + +SetMetrics sets Metrics field to given value. + +### HasMetrics + +`func (o *Metrics) HasMetrics() bool` + +HasMetrics returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmusage/docs/MetricsMetadata.md b/bmusage/docs/MetricsMetadata.md new file mode 100644 index 0000000..ee92f72 --- /dev/null +++ b/bmusage/docs/MetricsMetadata.md @@ -0,0 +1,134 @@ +# MetricsMetadata + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Aggregation** | Pointer to **string** | The aggregation type for this request | [optional] +**From** | Pointer to **time.Time** | Start of date interval in ISO-8601 format | [optional] +**Granularity** | Pointer to **string** | The interval for each metric | [optional] +**To** | Pointer to **time.Time** | End of date interval in ISO-8601 format | [optional] + +## Methods + +### NewMetricsMetadata + +`func NewMetricsMetadata() *MetricsMetadata` + +NewMetricsMetadata instantiates a new MetricsMetadata object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewMetricsMetadataWithDefaults + +`func NewMetricsMetadataWithDefaults() *MetricsMetadata` + +NewMetricsMetadataWithDefaults instantiates a new MetricsMetadata object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAggregation + +`func (o *MetricsMetadata) GetAggregation() string` + +GetAggregation returns the Aggregation field if non-nil, zero value otherwise. + +### GetAggregationOk + +`func (o *MetricsMetadata) GetAggregationOk() (*string, bool)` + +GetAggregationOk returns a tuple with the Aggregation field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAggregation + +`func (o *MetricsMetadata) SetAggregation(v string)` + +SetAggregation sets Aggregation field to given value. + +### HasAggregation + +`func (o *MetricsMetadata) HasAggregation() bool` + +HasAggregation returns a boolean if a field has been set. + +### GetFrom + +`func (o *MetricsMetadata) GetFrom() time.Time` + +GetFrom returns the From field if non-nil, zero value otherwise. + +### GetFromOk + +`func (o *MetricsMetadata) GetFromOk() (*time.Time, bool)` + +GetFromOk returns a tuple with the From field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFrom + +`func (o *MetricsMetadata) SetFrom(v time.Time)` + +SetFrom sets From field to given value. + +### HasFrom + +`func (o *MetricsMetadata) HasFrom() bool` + +HasFrom returns a boolean if a field has been set. + +### GetGranularity + +`func (o *MetricsMetadata) GetGranularity() string` + +GetGranularity returns the Granularity field if non-nil, zero value otherwise. + +### GetGranularityOk + +`func (o *MetricsMetadata) GetGranularityOk() (*string, bool)` + +GetGranularityOk returns a tuple with the Granularity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGranularity + +`func (o *MetricsMetadata) SetGranularity(v string)` + +SetGranularity sets Granularity field to given value. + +### HasGranularity + +`func (o *MetricsMetadata) HasGranularity() bool` + +HasGranularity returns a boolean if a field has been set. + +### GetTo + +`func (o *MetricsMetadata) GetTo() time.Time` + +GetTo returns the To field if non-nil, zero value otherwise. + +### GetToOk + +`func (o *MetricsMetadata) GetToOk() (*time.Time, bool)` + +GetToOk returns a tuple with the To field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTo + +`func (o *MetricsMetadata) SetTo(v time.Time)` + +SetTo sets To field to given value. + +### HasTo + +`func (o *MetricsMetadata) HasTo() bool` + +HasTo returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/bmusage/docs/NotificationSetting.md b/bmusage/docs/NotificationSetting.md new file mode 100644 index 0000000..8b0a7aa --- /dev/null +++ b/bmusage/docs/NotificationSetting.md @@ -0,0 +1,206 @@ +# NotificationSetting + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Actions** | Pointer to [**[]Actions**](Actions.md) | An array of notification setting actions | [optional] +**Frequency** | Pointer to **string** | Frequency | [optional] +**Id** | Pointer to **string** | Identifier of the notification setting | [optional] +**LastCheckedAt** | Pointer to **NullableString** | Date timestamp when the system last checked the server for threshold limit | [optional] +**Threshold** | Pointer to **string** | Threshold Value | [optional] +**ThresholdExceededAt** | Pointer to **NullableString** | Date timestamp when the threshold exceeded the limit | [optional] + +## Methods + +### NewNotificationSetting + +`func NewNotificationSetting() *NotificationSetting` + +NewNotificationSetting instantiates a new NotificationSetting object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewNotificationSettingWithDefaults + +`func NewNotificationSettingWithDefaults() *NotificationSetting` + +NewNotificationSettingWithDefaults instantiates a new NotificationSetting object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetActions + +`func (o *NotificationSetting) GetActions() []Actions` + +GetActions returns the Actions field if non-nil, zero value otherwise. + +### GetActionsOk + +`func (o *NotificationSetting) GetActionsOk() (*[]Actions, bool)` + +GetActionsOk returns a tuple with the Actions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetActions + +`func (o *NotificationSetting) SetActions(v []Actions)` + +SetActions sets Actions field to given value. + +### HasActions + +`func (o *NotificationSetting) HasActions() bool` + +HasActions returns a boolean if a field has been set. + +### GetFrequency + +`func (o *NotificationSetting) GetFrequency() string` + +GetFrequency returns the Frequency field if non-nil, zero value otherwise. + +### GetFrequencyOk + +`func (o *NotificationSetting) GetFrequencyOk() (*string, bool)` + +GetFrequencyOk returns a tuple with the Frequency field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFrequency + +`func (o *NotificationSetting) SetFrequency(v string)` + +SetFrequency sets Frequency field to given value. + +### HasFrequency + +`func (o *NotificationSetting) HasFrequency() bool` + +HasFrequency returns a boolean if a field has been set. + +### GetId + +`func (o *NotificationSetting) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NotificationSetting) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NotificationSetting) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NotificationSetting) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLastCheckedAt + +`func (o *NotificationSetting) GetLastCheckedAt() string` + +GetLastCheckedAt returns the LastCheckedAt field if non-nil, zero value otherwise. + +### GetLastCheckedAtOk + +`func (o *NotificationSetting) GetLastCheckedAtOk() (*string, bool)` + +GetLastCheckedAtOk returns a tuple with the LastCheckedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLastCheckedAt + +`func (o *NotificationSetting) SetLastCheckedAt(v string)` + +SetLastCheckedAt sets LastCheckedAt field to given value. + +### HasLastCheckedAt + +`func (o *NotificationSetting) HasLastCheckedAt() bool` + +HasLastCheckedAt returns a boolean if a field has been set. + +### SetLastCheckedAtNil + +`func (o *NotificationSetting) SetLastCheckedAtNil(b bool)` + + SetLastCheckedAtNil sets the value for LastCheckedAt to be an explicit nil + +### UnsetLastCheckedAt +`func (o *NotificationSetting) UnsetLastCheckedAt()` + +UnsetLastCheckedAt ensures that no value is present for LastCheckedAt, not even an explicit nil +### GetThreshold + +`func (o *NotificationSetting) GetThreshold() string` + +GetThreshold returns the Threshold field if non-nil, zero value otherwise. + +### GetThresholdOk + +`func (o *NotificationSetting) GetThresholdOk() (*string, bool)` + +GetThresholdOk returns a tuple with the Threshold field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThreshold + +`func (o *NotificationSetting) SetThreshold(v string)` + +SetThreshold sets Threshold field to given value. + +### HasThreshold + +`func (o *NotificationSetting) HasThreshold() bool` + +HasThreshold returns a boolean if a field has been set. + +### GetThresholdExceededAt + +`func (o *NotificationSetting) GetThresholdExceededAt() string` + +GetThresholdExceededAt returns the ThresholdExceededAt field if non-nil, zero value otherwise. + +### GetThresholdExceededAtOk + +`func (o *NotificationSetting) GetThresholdExceededAtOk() (*string, bool)` + +GetThresholdExceededAtOk returns a tuple with the ThresholdExceededAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetThresholdExceededAt + +`func (o *NotificationSetting) SetThresholdExceededAt(v string)` + +SetThresholdExceededAt sets ThresholdExceededAt field to given value. + +### HasThresholdExceededAt + +`func (o *NotificationSetting) HasThresholdExceededAt() bool` + +HasThresholdExceededAt returns a boolean if a field has been set. + +### SetThresholdExceededAtNil + +`func (o *NotificationSetting) SetThresholdExceededAtNil(b bool)` + + SetThresholdExceededAtNil sets the value for ThresholdExceededAt to be an explicit nil + +### UnsetThresholdExceededAt +`func (o *NotificationSetting) UnsetThresholdExceededAt()` + +UnsetThresholdExceededAt ensures that no value is present for ThresholdExceededAt, not even an explicit nil + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/dedicatedserver/docs/AddServerToPrivateNetworkOpts.md b/dedicatedserver/docs/AddServerToPrivateNetworkOpts.md new file mode 100644 index 0000000..ffb5d08 --- /dev/null +++ b/dedicatedserver/docs/AddServerToPrivateNetworkOpts.md @@ -0,0 +1,51 @@ +# AddServerToPrivateNetworkOpts + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LinkSpeed** | [**LinkSpeed**](LinkSpeed.md) | | + +## Methods + +### NewAddServerToPrivateNetworkOpts + +`func NewAddServerToPrivateNetworkOpts(linkSpeed LinkSpeed, ) *AddServerToPrivateNetworkOpts` + +NewAddServerToPrivateNetworkOpts instantiates a new AddServerToPrivateNetworkOpts object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAddServerToPrivateNetworkOptsWithDefaults + +`func NewAddServerToPrivateNetworkOptsWithDefaults() *AddServerToPrivateNetworkOpts` + +NewAddServerToPrivateNetworkOptsWithDefaults instantiates a new AddServerToPrivateNetworkOpts object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinkSpeed + +`func (o *AddServerToPrivateNetworkOpts) GetLinkSpeed() LinkSpeed` + +GetLinkSpeed returns the LinkSpeed field if non-nil, zero value otherwise. + +### GetLinkSpeedOk + +`func (o *AddServerToPrivateNetworkOpts) GetLinkSpeedOk() (*LinkSpeed, bool)` + +GetLinkSpeedOk returns a tuple with the LinkSpeed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinkSpeed + +`func (o *AddServerToPrivateNetworkOpts) SetLinkSpeed(v LinkSpeed)` + +SetLinkSpeed sets LinkSpeed field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/dedicatedserver/docs/Cpu.md b/dedicatedserver/docs/Cpu.md new file mode 100644 index 0000000..fc03d2d --- /dev/null +++ b/dedicatedserver/docs/Cpu.md @@ -0,0 +1,82 @@ +# Cpu + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Quantity** | Pointer to **int32** | The quantity of CPUs in the server | [optional] +**Type** | Pointer to **string** | The type of CPUs in the server | [optional] + +## Methods + +### NewCpu + +`func NewCpu() *Cpu` + +NewCpu instantiates a new Cpu object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCpuWithDefaults + +`func NewCpuWithDefaults() *Cpu` + +NewCpuWithDefaults instantiates a new Cpu object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetQuantity + +`func (o *Cpu) GetQuantity() int32` + +GetQuantity returns the Quantity field if non-nil, zero value otherwise. + +### GetQuantityOk + +`func (o *Cpu) GetQuantityOk() (*int32, bool)` + +GetQuantityOk returns a tuple with the Quantity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetQuantity + +`func (o *Cpu) SetQuantity(v int32)` + +SetQuantity sets Quantity field to given value. + +### HasQuantity + +`func (o *Cpu) HasQuantity() bool` + +HasQuantity returns a boolean if a field has been set. + +### GetType + +`func (o *Cpu) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Cpu) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Cpu) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Cpu) HasType() bool` + +HasType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/dedicatedserver/docs/DDos.md b/dedicatedserver/docs/DDos.md new file mode 100644 index 0000000..809aa5d --- /dev/null +++ b/dedicatedserver/docs/DDos.md @@ -0,0 +1,82 @@ +# DDos + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DetectionProfile** | Pointer to **string** | The applied detection profile | [optional] +**ProtectionType** | Pointer to **string** | The type of DDoS protection | [optional] + +## Methods + +### NewDDos + +`func NewDDos() *DDos` + +NewDDos instantiates a new DDos object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDDosWithDefaults + +`func NewDDosWithDefaults() *DDos` + +NewDDosWithDefaults instantiates a new DDos object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDetectionProfile + +`func (o *DDos) GetDetectionProfile() string` + +GetDetectionProfile returns the DetectionProfile field if non-nil, zero value otherwise. + +### GetDetectionProfileOk + +`func (o *DDos) GetDetectionProfileOk() (*string, bool)` + +GetDetectionProfileOk returns a tuple with the DetectionProfile field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetectionProfile + +`func (o *DDos) SetDetectionProfile(v string)` + +SetDetectionProfile sets DetectionProfile field to given value. + +### HasDetectionProfile + +`func (o *DDos) HasDetectionProfile() bool` + +HasDetectionProfile returns a boolean if a field has been set. + +### GetProtectionType + +`func (o *DDos) GetProtectionType() string` + +GetProtectionType returns the ProtectionType field if non-nil, zero value otherwise. + +### GetProtectionTypeOk + +`func (o *DDos) GetProtectionTypeOk() (*string, bool)` + +GetProtectionTypeOk returns a tuple with the ProtectionType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProtectionType + +`func (o *DDos) SetProtectionType(v string)` + +SetProtectionType sets ProtectionType field to given value. + +### HasProtectionType + +`func (o *DDos) HasProtectionType() bool` + +HasProtectionType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/dedicatedserver/docs/DedicatedserverAPI.md b/dedicatedserver/docs/DedicatedserverAPI.md new file mode 100644 index 0000000..3b8b19c --- /dev/null +++ b/dedicatedserver/docs/DedicatedserverAPI.md @@ -0,0 +1,1516 @@ +# \DedicatedserverAPI + +All URIs are relative to *https://api.leaseweb.com/internal/dedicatedserverapi/v2* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**AddServerToPrivateNetwork**](DedicatedserverAPI.md#AddServerToPrivateNetwork) | **Put** /servers/{serverId}/privateNetworks/{privateNetworkId} | Add a server to private network +[**DeleteServerFromPrivateNetwork**](DedicatedserverAPI.md#DeleteServerFromPrivateNetwork) | **Delete** /servers/{serverId}/privateNetworks/{privateNetworkId} | Delete a server from a private network +[**GetNetworkEquipment**](DedicatedserverAPI.md#GetNetworkEquipment) | **Get** /networkEquipments/{networkEquipmentId} | Get network equipment +[**GetNetworkEquipmentIp**](DedicatedserverAPI.md#GetNetworkEquipmentIp) | **Get** /networkEquipments/{networkEquipmentId}/ips/{ip} | Show an IP +[**GetNetworkEquipmentIpList**](DedicatedserverAPI.md#GetNetworkEquipmentIpList) | **Get** /networkEquipments/{networkEquipmentId}/ips | List IPs +[**GetNetworkEquipmentList**](DedicatedserverAPI.md#GetNetworkEquipmentList) | **Get** /networkEquipments | List network equipment +[**GetNetworkEquipmentNullRouteHistory**](DedicatedserverAPI.md#GetNetworkEquipmentNullRouteHistory) | **Get** /networkEquipments/{networkEquipmentId}/nullRouteHistory | Show null route history +[**GetServer**](DedicatedserverAPI.md#GetServer) | **Get** /servers/{serverId} | Get server +[**GetServerIp**](DedicatedserverAPI.md#GetServerIp) | **Get** /servers/{serverId}/ips/{ip} | Show an IP +[**GetServerIpList**](DedicatedserverAPI.md#GetServerIpList) | **Get** /servers/{serverId}/ips | List IPs +[**GetServerList**](DedicatedserverAPI.md#GetServerList) | **Get** /servers | List servers +[**GetServerNullRouteHistory**](DedicatedserverAPI.md#GetServerNullRouteHistory) | **Get** /servers/{serverId}/nullRouteHistory | Show null route history +[**NetworkEquipmentsIpsNull**](DedicatedserverAPI.md#NetworkEquipmentsIpsNull) | **Post** /networkEquipments/{networkEquipmentId}/ips/{ip}/null | Null route an IP +[**NullIpRoute**](DedicatedserverAPI.md#NullIpRoute) | **Post** /servers/{serverId}/ips/{ip}/null | Null route an IP +[**PutServerIp**](DedicatedserverAPI.md#PutServerIp) | **Put** /servers/{serverId}/ips/{ip} | Update an IP +[**RemoveNullIpRoute**](DedicatedserverAPI.md#RemoveNullIpRoute) | **Post** /servers/{serverId}/ips/{ip}/unnull | Remove a null route +[**UnNullNetworkEquipmentIpRoute**](DedicatedserverAPI.md#UnNullNetworkEquipmentIpRoute) | **Post** /networkEquipments/{networkEquipmentId}/ips/{ip}/unnull | Remove a null route +[**UpdateNetworkEquipmentIp**](DedicatedserverAPI.md#UpdateNetworkEquipmentIp) | **Put** /networkEquipments/{networkEquipmentId}/ips/{ip} | Update an IP +[**UpdateNetworkEquipmentReference**](DedicatedserverAPI.md#UpdateNetworkEquipmentReference) | **Put** /networkEquipments/{networkEquipmentId} | Update network equipment +[**UpdateServerReference**](DedicatedserverAPI.md#UpdateServerReference) | **Put** /servers/{serverId} | Update server + + + +## AddServerToPrivateNetwork + +> AddServerToPrivateNetwork(ctx, serverId, privateNetworkId).AddServerToPrivateNetworkOpts(addServerToPrivateNetworkOpts).Execute() + +Add a server to private network + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/dedicatedserver" +) + +func main() { + serverId := "12345" // string | The ID of a server + privateNetworkId := "892" // string | The ID of a Private Network + addServerToPrivateNetworkOpts := *openapiclient.NewAddServerToPrivateNetworkOpts(openapiclient.linkSpeed(100)) // AddServerToPrivateNetworkOpts | (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.DedicatedserverAPI.AddServerToPrivateNetwork(context.Background(), serverId, privateNetworkId).AddServerToPrivateNetworkOpts(addServerToPrivateNetworkOpts).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DedicatedserverAPI.AddServerToPrivateNetwork``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | +**privateNetworkId** | **string** | The ID of a Private Network | + +### Other Parameters + +Other parameters are passed through a pointer to a apiAddServerToPrivateNetworkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **addServerToPrivateNetworkOpts** | [**AddServerToPrivateNetworkOpts**](AddServerToPrivateNetworkOpts.md) | | + +### Return type + + (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteServerFromPrivateNetwork + +> DeleteServerFromPrivateNetwork(ctx, serverId, privateNetworkId).Execute() + +Delete a server from a private network + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/dedicatedserver" +) + +func main() { + serverId := "12345" // string | The ID of a server + privateNetworkId := "892" // string | The ID of a Private Network + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.DedicatedserverAPI.DeleteServerFromPrivateNetwork(context.Background(), serverId, privateNetworkId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DedicatedserverAPI.DeleteServerFromPrivateNetwork``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | +**privateNetworkId** | **string** | The ID of a Private Network | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteServerFromPrivateNetworkRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetNetworkEquipment + +> NetworkEquipment GetNetworkEquipment(ctx, networkEquipmentId).Execute() + +Get network equipment + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/dedicatedserver" +) + +func main() { + networkEquipmentId := "12345" // string | The ID of a dedicated network equipment + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.DedicatedserverAPI.GetNetworkEquipment(context.Background(), networkEquipmentId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DedicatedserverAPI.GetNetworkEquipment``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNetworkEquipment`: NetworkEquipment + fmt.Fprintf(os.Stdout, "Response from `DedicatedserverAPI.GetNetworkEquipment`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**networkEquipmentId** | **string** | The ID of a dedicated network equipment | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNetworkEquipmentRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**NetworkEquipment**](NetworkEquipment.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetNetworkEquipmentIp + +> Ip GetNetworkEquipmentIp(ctx, networkEquipmentId, ip).Execute() + +Show an IP + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/dedicatedserver" +) + +func main() { + networkEquipmentId := "12345" // string | The ID of a dedicated network equipment + ip := "127.0.0.6" // string | The IP Address + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.DedicatedserverAPI.GetNetworkEquipmentIp(context.Background(), networkEquipmentId, ip).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DedicatedserverAPI.GetNetworkEquipmentIp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNetworkEquipmentIp`: Ip + fmt.Fprintf(os.Stdout, "Response from `DedicatedserverAPI.GetNetworkEquipmentIp`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**networkEquipmentId** | **string** | The ID of a dedicated network equipment | +**ip** | **string** | The IP Address | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNetworkEquipmentIpRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**Ip**](Ip.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetNetworkEquipmentIpList + +> GetNetworkEquipmentIpListResult GetNetworkEquipmentIpList(ctx, networkEquipmentId).NetworkType(networkType).Version(version).NullRouted(nullRouted).Ips(ips).Limit(limit).Offset(offset).Execute() + +List IPs + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/dedicatedserver" +) + +func main() { + networkEquipmentId := "12345" // string | The ID of a dedicated network equipment + networkType := "networkType_example" // string | Filter the collection of ip addresses by network type (optional) + version := "version_example" // string | Filter the collection by ip version (optional) + nullRouted := "nullRouted_example" // string | Filter Ips by Nulled-Status (optional) + ips := "ips_example" // string | Filter the collection of Ips for the comma separated list of Ips (optional) + limit := int32(20) // int32 | Limit the number of results returned. (optional) + offset := int32(10) // int32 | Return results starting from the given offset. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.DedicatedserverAPI.GetNetworkEquipmentIpList(context.Background(), networkEquipmentId).NetworkType(networkType).Version(version).NullRouted(nullRouted).Ips(ips).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DedicatedserverAPI.GetNetworkEquipmentIpList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNetworkEquipmentIpList`: GetNetworkEquipmentIpListResult + fmt.Fprintf(os.Stdout, "Response from `DedicatedserverAPI.GetNetworkEquipmentIpList`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**networkEquipmentId** | **string** | The ID of a dedicated network equipment | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNetworkEquipmentIpListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **networkType** | **string** | Filter the collection of ip addresses by network type | + **version** | **string** | Filter the collection by ip version | + **nullRouted** | **string** | Filter Ips by Nulled-Status | + **ips** | **string** | Filter the collection of Ips for the comma separated list of Ips | + **limit** | **int32** | Limit the number of results returned. | + **offset** | **int32** | Return results starting from the given offset. | + +### Return type + +[**GetNetworkEquipmentIpListResult**](GetNetworkEquipmentIpListResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetNetworkEquipmentList + +> GetNetworkEquipmentListResult GetNetworkEquipmentList(ctx).Limit(limit).Offset(offset).Reference(reference).Ip(ip).MacAddress(macAddress).Site(site).PrivateRackId(privateRackId).PrivateNetworkCapable(privateNetworkCapable).PrivateNetworkEnabled(privateNetworkEnabled).Execute() + +List network equipment + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/dedicatedserver" +) + +func main() { + limit := int32(20) // int32 | Limit the number of results returned. (optional) + offset := int32(10) // int32 | Return results starting from the given offset. (optional) + reference := "my-switch" // string | Filter the list of network equipment by reference. (optional) + ip := "127.0.0.4" // string | Filter the list of network equipment by ip address. (optional) + macAddress := "aa:bb:cc:dd:ee:ff" // string | Filter the list of network equipment by mac address. (optional) + site := "FRA-10" // string | Filter the list of network equipment by site (location). (optional) + privateRackId := "123" // string | Filter the list of network equipment by dedicated rack id. (optional) + privateNetworkCapable := "privateNetworkCapable_example" // string | Filter the list for private network capable network equipment (optional) + privateNetworkEnabled := "privateNetworkEnabled_example" // string | Filter the list for private network enabled network equipment (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.DedicatedserverAPI.GetNetworkEquipmentList(context.Background()).Limit(limit).Offset(offset).Reference(reference).Ip(ip).MacAddress(macAddress).Site(site).PrivateRackId(privateRackId).PrivateNetworkCapable(privateNetworkCapable).PrivateNetworkEnabled(privateNetworkEnabled).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DedicatedserverAPI.GetNetworkEquipmentList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNetworkEquipmentList`: GetNetworkEquipmentListResult + fmt.Fprintf(os.Stdout, "Response from `DedicatedserverAPI.GetNetworkEquipmentList`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNetworkEquipmentListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **limit** | **int32** | Limit the number of results returned. | + **offset** | **int32** | Return results starting from the given offset. | + **reference** | **string** | Filter the list of network equipment by reference. | + **ip** | **string** | Filter the list of network equipment by ip address. | + **macAddress** | **string** | Filter the list of network equipment by mac address. | + **site** | **string** | Filter the list of network equipment by site (location). | + **privateRackId** | **string** | Filter the list of network equipment by dedicated rack id. | + **privateNetworkCapable** | **string** | Filter the list for private network capable network equipment | + **privateNetworkEnabled** | **string** | Filter the list for private network enabled network equipment | + +### Return type + +[**GetNetworkEquipmentListResult**](GetNetworkEquipmentListResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetNetworkEquipmentNullRouteHistory + +> GetNetworkEquipmentNullRouteHistoryResult GetNetworkEquipmentNullRouteHistory(ctx, networkEquipmentId).Limit(limit).Offset(offset).Execute() + +Show null route history + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/dedicatedserver" +) + +func main() { + networkEquipmentId := "12345" // string | The ID of a dedicated network equipment + limit := int32(20) // int32 | Limit the number of results returned. (optional) + offset := int32(10) // int32 | Return results starting from the given offset. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.DedicatedserverAPI.GetNetworkEquipmentNullRouteHistory(context.Background(), networkEquipmentId).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DedicatedserverAPI.GetNetworkEquipmentNullRouteHistory``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNetworkEquipmentNullRouteHistory`: GetNetworkEquipmentNullRouteHistoryResult + fmt.Fprintf(os.Stdout, "Response from `DedicatedserverAPI.GetNetworkEquipmentNullRouteHistory`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**networkEquipmentId** | **string** | The ID of a dedicated network equipment | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNetworkEquipmentNullRouteHistoryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **limit** | **int32** | Limit the number of results returned. | + **offset** | **int32** | Return results starting from the given offset. | + +### Return type + +[**GetNetworkEquipmentNullRouteHistoryResult**](GetNetworkEquipmentNullRouteHistoryResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetServer + +> Server GetServer(ctx, serverId).Execute() + +Get server + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/dedicatedserver" +) + +func main() { + serverId := "12345" // string | The ID of a server + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.DedicatedserverAPI.GetServer(context.Background(), serverId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DedicatedserverAPI.GetServer``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServer`: Server + fmt.Fprintf(os.Stdout, "Response from `DedicatedserverAPI.GetServer`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServerRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**Server**](Server.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetServerIp + +> Ip GetServerIp(ctx, serverId, ip).Execute() + +Show an IP + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/dedicatedserver" +) + +func main() { + serverId := "12345" // string | The ID of a server + ip := "127.0.0.6" // string | The IP Address + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.DedicatedserverAPI.GetServerIp(context.Background(), serverId, ip).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DedicatedserverAPI.GetServerIp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServerIp`: Ip + fmt.Fprintf(os.Stdout, "Response from `DedicatedserverAPI.GetServerIp`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | +**ip** | **string** | The IP Address | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServerIpRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**Ip**](Ip.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetServerIpList + +> Ip GetServerIpList(ctx, serverId).NetworkType(networkType).Version(version).NullRouted(nullRouted).Ips(ips).Limit(limit).Offset(offset).Execute() + +List IPs + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/dedicatedserver" +) + +func main() { + serverId := "12345" // string | The ID of a server + networkType := "networkType_example" // string | Filter the collection of ip addresses by network type (optional) + version := "version_example" // string | Filter the collection by ip version (optional) + nullRouted := "nullRouted_example" // string | Filter Ips by Nulled-Status (optional) + ips := "ips_example" // string | Filter the collection of Ips for the comma separated list of Ips (optional) + limit := int32(20) // int32 | Limit the number of results returned. (optional) + offset := int32(10) // int32 | Return results starting from the given offset. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.DedicatedserverAPI.GetServerIpList(context.Background(), serverId).NetworkType(networkType).Version(version).NullRouted(nullRouted).Ips(ips).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DedicatedserverAPI.GetServerIpList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServerIpList`: Ip + fmt.Fprintf(os.Stdout, "Response from `DedicatedserverAPI.GetServerIpList`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServerIpListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **networkType** | **string** | Filter the collection of ip addresses by network type | + **version** | **string** | Filter the collection by ip version | + **nullRouted** | **string** | Filter Ips by Nulled-Status | + **ips** | **string** | Filter the collection of Ips for the comma separated list of Ips | + **limit** | **int32** | Limit the number of results returned. | + **offset** | **int32** | Return results starting from the given offset. | + +### Return type + +[**Ip**](Ip.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetServerList + +> GetServerListResult GetServerList(ctx).Limit(limit).Offset(offset).Reference(reference).Ip(ip).MacAddress(macAddress).Site(site).PrivateRackId(privateRackId).PrivateNetworkCapable(privateNetworkCapable).PrivateNetworkEnabled(privateNetworkEnabled).Execute() + +List servers + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/dedicatedserver" +) + +func main() { + limit := int32(20) // int32 | Limit the number of results returned. (optional) + offset := int32(10) // int32 | Return results starting from the given offset. (optional) + reference := "my-db" // string | Filter the list of servers by reference. (optional) + ip := "127.0.0.4" // string | Filter the list of servers by ip address. (optional) + macAddress := "aa:bb:cc:dd:ee:ff" // string | Filter the list of servers by mac address. (optional) + site := "FRA-10" // string | Filter the list of servers by site (location). (optional) + privateRackId := "123" // string | Filter the list of servers by dedicated rack id. (optional) + privateNetworkCapable := "privateNetworkCapable_example" // string | Filter the list for private network capable servers (optional) + privateNetworkEnabled := "privateNetworkEnabled_example" // string | Filter the list for private network enabled servers (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.DedicatedserverAPI.GetServerList(context.Background()).Limit(limit).Offset(offset).Reference(reference).Ip(ip).MacAddress(macAddress).Site(site).PrivateRackId(privateRackId).PrivateNetworkCapable(privateNetworkCapable).PrivateNetworkEnabled(privateNetworkEnabled).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DedicatedserverAPI.GetServerList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServerList`: GetServerListResult + fmt.Fprintf(os.Stdout, "Response from `DedicatedserverAPI.GetServerList`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServerListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **limit** | **int32** | Limit the number of results returned. | + **offset** | **int32** | Return results starting from the given offset. | + **reference** | **string** | Filter the list of servers by reference. | + **ip** | **string** | Filter the list of servers by ip address. | + **macAddress** | **string** | Filter the list of servers by mac address. | + **site** | **string** | Filter the list of servers by site (location). | + **privateRackId** | **string** | Filter the list of servers by dedicated rack id. | + **privateNetworkCapable** | **string** | Filter the list for private network capable servers | + **privateNetworkEnabled** | **string** | Filter the list for private network enabled servers | + +### Return type + +[**GetServerListResult**](GetServerListResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetServerNullRouteHistory + +> GetServerNullRouteHistoryResult GetServerNullRouteHistory(ctx, serverId).Limit(limit).Offset(offset).Execute() + +Show null route history + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/dedicatedserver" +) + +func main() { + serverId := "12345" // string | The ID of a server + limit := int32(20) // int32 | Limit the number of results returned. (optional) + offset := int32(10) // int32 | Return results starting from the given offset. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.DedicatedserverAPI.GetServerNullRouteHistory(context.Background(), serverId).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DedicatedserverAPI.GetServerNullRouteHistory``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetServerNullRouteHistory`: GetServerNullRouteHistoryResult + fmt.Fprintf(os.Stdout, "Response from `DedicatedserverAPI.GetServerNullRouteHistory`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetServerNullRouteHistoryRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **limit** | **int32** | Limit the number of results returned. | + **offset** | **int32** | Return results starting from the given offset. | + +### Return type + +[**GetServerNullRouteHistoryResult**](GetServerNullRouteHistoryResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## NetworkEquipmentsIpsNull + +> Ip NetworkEquipmentsIpsNull(ctx, networkEquipmentId, ip).Execute() + +Null route an IP + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/dedicatedserver" +) + +func main() { + networkEquipmentId := "12345" // string | The ID of a dedicated network equipment + ip := "127.0.0.6" // string | The IP Address + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.DedicatedserverAPI.NetworkEquipmentsIpsNull(context.Background(), networkEquipmentId, ip).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DedicatedserverAPI.NetworkEquipmentsIpsNull``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `NetworkEquipmentsIpsNull`: Ip + fmt.Fprintf(os.Stdout, "Response from `DedicatedserverAPI.NetworkEquipmentsIpsNull`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**networkEquipmentId** | **string** | The ID of a dedicated network equipment | +**ip** | **string** | The IP Address | + +### Other Parameters + +Other parameters are passed through a pointer to a apiNetworkEquipmentsIpsNullRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**Ip**](Ip.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## NullIpRoute + +> Ip NullIpRoute(ctx, serverId, ip).Execute() + +Null route an IP + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/dedicatedserver" +) + +func main() { + serverId := "12345" // string | The ID of a server + ip := "127.0.0.6" // string | The IP Address + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.DedicatedserverAPI.NullIpRoute(context.Background(), serverId, ip).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DedicatedserverAPI.NullIpRoute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `NullIpRoute`: Ip + fmt.Fprintf(os.Stdout, "Response from `DedicatedserverAPI.NullIpRoute`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | +**ip** | **string** | The IP Address | + +### Other Parameters + +Other parameters are passed through a pointer to a apiNullIpRouteRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**Ip**](Ip.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## PutServerIp + +> Ip PutServerIp(ctx, serverId, ip).UpdateIpProfileOpts(updateIpProfileOpts).Execute() + +Update an IP + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/dedicatedserver" +) + +func main() { + serverId := "12345" // string | The ID of a server + ip := "127.0.0.6" // string | The IP Address + updateIpProfileOpts := *openapiclient.NewUpdateIpProfileOpts() // UpdateIpProfileOpts | (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.DedicatedserverAPI.PutServerIp(context.Background(), serverId, ip).UpdateIpProfileOpts(updateIpProfileOpts).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DedicatedserverAPI.PutServerIp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `PutServerIp`: Ip + fmt.Fprintf(os.Stdout, "Response from `DedicatedserverAPI.PutServerIp`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | +**ip** | **string** | The IP Address | + +### Other Parameters + +Other parameters are passed through a pointer to a apiPutServerIpRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **updateIpProfileOpts** | [**UpdateIpProfileOpts**](UpdateIpProfileOpts.md) | | + +### Return type + +[**Ip**](Ip.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## RemoveNullIpRoute + +> Ip RemoveNullIpRoute(ctx, serverId, ip).Execute() + +Remove a null route + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/dedicatedserver" +) + +func main() { + serverId := "12345" // string | The ID of a server + ip := "127.0.0.6" // string | The IP Address + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.DedicatedserverAPI.RemoveNullIpRoute(context.Background(), serverId, ip).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DedicatedserverAPI.RemoveNullIpRoute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `RemoveNullIpRoute`: Ip + fmt.Fprintf(os.Stdout, "Response from `DedicatedserverAPI.RemoveNullIpRoute`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | +**ip** | **string** | The IP Address | + +### Other Parameters + +Other parameters are passed through a pointer to a apiRemoveNullIpRouteRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**Ip**](Ip.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UnNullNetworkEquipmentIpRoute + +> Ip UnNullNetworkEquipmentIpRoute(ctx, networkEquipmentId, ip).Execute() + +Remove a null route + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/dedicatedserver" +) + +func main() { + networkEquipmentId := "12345" // string | The ID of a dedicated network equipment + ip := "127.0.0.6" // string | The IP Address + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.DedicatedserverAPI.UnNullNetworkEquipmentIpRoute(context.Background(), networkEquipmentId, ip).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DedicatedserverAPI.UnNullNetworkEquipmentIpRoute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UnNullNetworkEquipmentIpRoute`: Ip + fmt.Fprintf(os.Stdout, "Response from `DedicatedserverAPI.UnNullNetworkEquipmentIpRoute`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**networkEquipmentId** | **string** | The ID of a dedicated network equipment | +**ip** | **string** | The IP Address | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUnNullNetworkEquipmentIpRouteRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**Ip**](Ip.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateNetworkEquipmentIp + +> Ip UpdateNetworkEquipmentIp(ctx, networkEquipmentId, ip).UpdateNetworkEquipmentIpOpts(updateNetworkEquipmentIpOpts).Execute() + +Update an IP + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/dedicatedserver" +) + +func main() { + networkEquipmentId := "12345" // string | The ID of a dedicated network equipment + ip := "127.0.0.6" // string | The IP Address + updateNetworkEquipmentIpOpts := *openapiclient.NewUpdateNetworkEquipmentIpOpts() // UpdateNetworkEquipmentIpOpts | (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.DedicatedserverAPI.UpdateNetworkEquipmentIp(context.Background(), networkEquipmentId, ip).UpdateNetworkEquipmentIpOpts(updateNetworkEquipmentIpOpts).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DedicatedserverAPI.UpdateNetworkEquipmentIp``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateNetworkEquipmentIp`: Ip + fmt.Fprintf(os.Stdout, "Response from `DedicatedserverAPI.UpdateNetworkEquipmentIp`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**networkEquipmentId** | **string** | The ID of a dedicated network equipment | +**ip** | **string** | The IP Address | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateNetworkEquipmentIpRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + **updateNetworkEquipmentIpOpts** | [**UpdateNetworkEquipmentIpOpts**](UpdateNetworkEquipmentIpOpts.md) | | + +### Return type + +[**Ip**](Ip.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateNetworkEquipmentReference + +> UpdateNetworkEquipmentReference(ctx, networkEquipmentId).UpdateNetworkEquipmentReferenceOpts(updateNetworkEquipmentReferenceOpts).Execute() + +Update network equipment + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/dedicatedserver" +) + +func main() { + networkEquipmentId := "12345" // string | The ID of a dedicated network equipment + updateNetworkEquipmentReferenceOpts := *openapiclient.NewUpdateNetworkEquipmentReferenceOpts("Reference_example") // UpdateNetworkEquipmentReferenceOpts | + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.DedicatedserverAPI.UpdateNetworkEquipmentReference(context.Background(), networkEquipmentId).UpdateNetworkEquipmentReferenceOpts(updateNetworkEquipmentReferenceOpts).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DedicatedserverAPI.UpdateNetworkEquipmentReference``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**networkEquipmentId** | **string** | The ID of a dedicated network equipment | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateNetworkEquipmentReferenceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **updateNetworkEquipmentReferenceOpts** | [**UpdateNetworkEquipmentReferenceOpts**](UpdateNetworkEquipmentReferenceOpts.md) | | + +### Return type + + (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateServerReference + +> UpdateServerReference(ctx, serverId).UpdateServerReferenceOpts(updateServerReferenceOpts).Execute() + +Update server + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/dedicatedserver" +) + +func main() { + serverId := "12345" // string | The ID of a server + updateServerReferenceOpts := *openapiclient.NewUpdateServerReferenceOpts("Reference_example") // UpdateServerReferenceOpts | + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.DedicatedserverAPI.UpdateServerReference(context.Background(), serverId).UpdateServerReferenceOpts(updateServerReferenceOpts).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `DedicatedserverAPI.UpdateServerReference``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateServerReferenceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **updateServerReferenceOpts** | [**UpdateServerReferenceOpts**](UpdateServerReferenceOpts.md) | | + +### Return type + + (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/dedicatedserver/docs/ErrorResult.md b/dedicatedserver/docs/ErrorResult.md new file mode 100644 index 0000000..af3c285 --- /dev/null +++ b/dedicatedserver/docs/ErrorResult.md @@ -0,0 +1,134 @@ +# ErrorResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CorrelationId** | Pointer to **string** | The correlation ID of the current request. | [optional] +**ErrorCode** | Pointer to **string** | The error code. | [optional] +**ErrorMessage** | Pointer to **string** | A human friendly description of the error. | [optional] +**ErrorDetails** | Pointer to [**[]map[string][]string**](map[string][]string.md) | | [optional] + +## Methods + +### NewErrorResult + +`func NewErrorResult() *ErrorResult` + +NewErrorResult instantiates a new ErrorResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewErrorResultWithDefaults + +`func NewErrorResultWithDefaults() *ErrorResult` + +NewErrorResultWithDefaults instantiates a new ErrorResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCorrelationId + +`func (o *ErrorResult) GetCorrelationId() string` + +GetCorrelationId returns the CorrelationId field if non-nil, zero value otherwise. + +### GetCorrelationIdOk + +`func (o *ErrorResult) GetCorrelationIdOk() (*string, bool)` + +GetCorrelationIdOk returns a tuple with the CorrelationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelationId + +`func (o *ErrorResult) SetCorrelationId(v string)` + +SetCorrelationId sets CorrelationId field to given value. + +### HasCorrelationId + +`func (o *ErrorResult) HasCorrelationId() bool` + +HasCorrelationId returns a boolean if a field has been set. + +### GetErrorCode + +`func (o *ErrorResult) GetErrorCode() string` + +GetErrorCode returns the ErrorCode field if non-nil, zero value otherwise. + +### GetErrorCodeOk + +`func (o *ErrorResult) GetErrorCodeOk() (*string, bool)` + +GetErrorCodeOk returns a tuple with the ErrorCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorCode + +`func (o *ErrorResult) SetErrorCode(v string)` + +SetErrorCode sets ErrorCode field to given value. + +### HasErrorCode + +`func (o *ErrorResult) HasErrorCode() bool` + +HasErrorCode returns a boolean if a field has been set. + +### GetErrorMessage + +`func (o *ErrorResult) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *ErrorResult) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *ErrorResult) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *ErrorResult) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### GetErrorDetails + +`func (o *ErrorResult) GetErrorDetails() []map[string][]string` + +GetErrorDetails returns the ErrorDetails field if non-nil, zero value otherwise. + +### GetErrorDetailsOk + +`func (o *ErrorResult) GetErrorDetailsOk() (*[]map[string][]string, bool)` + +GetErrorDetailsOk returns a tuple with the ErrorDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorDetails + +`func (o *ErrorResult) SetErrorDetails(v []map[string][]string)` + +SetErrorDetails sets ErrorDetails field to given value. + +### HasErrorDetails + +`func (o *ErrorResult) HasErrorDetails() bool` + +HasErrorDetails returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/dedicatedserver/docs/GetNetworkEquipmentIpListResult.md b/dedicatedserver/docs/GetNetworkEquipmentIpListResult.md new file mode 100644 index 0000000..8963d71 --- /dev/null +++ b/dedicatedserver/docs/GetNetworkEquipmentIpListResult.md @@ -0,0 +1,82 @@ +# GetNetworkEquipmentIpListResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Metadata** | Pointer to [**Metadata**](Metadata.md) | | [optional] +**Ips** | Pointer to [**[]Ip**](Ip.md) | An array of IP addresses | [optional] + +## Methods + +### NewGetNetworkEquipmentIpListResult + +`func NewGetNetworkEquipmentIpListResult() *GetNetworkEquipmentIpListResult` + +NewGetNetworkEquipmentIpListResult instantiates a new GetNetworkEquipmentIpListResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetNetworkEquipmentIpListResultWithDefaults + +`func NewGetNetworkEquipmentIpListResultWithDefaults() *GetNetworkEquipmentIpListResult` + +NewGetNetworkEquipmentIpListResultWithDefaults instantiates a new GetNetworkEquipmentIpListResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMetadata + +`func (o *GetNetworkEquipmentIpListResult) GetMetadata() Metadata` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *GetNetworkEquipmentIpListResult) GetMetadataOk() (*Metadata, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *GetNetworkEquipmentIpListResult) SetMetadata(v Metadata)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *GetNetworkEquipmentIpListResult) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + +### GetIps + +`func (o *GetNetworkEquipmentIpListResult) GetIps() []Ip` + +GetIps returns the Ips field if non-nil, zero value otherwise. + +### GetIpsOk + +`func (o *GetNetworkEquipmentIpListResult) GetIpsOk() (*[]Ip, bool)` + +GetIpsOk returns a tuple with the Ips field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIps + +`func (o *GetNetworkEquipmentIpListResult) SetIps(v []Ip)` + +SetIps sets Ips field to given value. + +### HasIps + +`func (o *GetNetworkEquipmentIpListResult) HasIps() bool` + +HasIps returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/dedicatedserver/docs/GetNetworkEquipmentListResult.md b/dedicatedserver/docs/GetNetworkEquipmentListResult.md new file mode 100644 index 0000000..90d1aaf --- /dev/null +++ b/dedicatedserver/docs/GetNetworkEquipmentListResult.md @@ -0,0 +1,82 @@ +# GetNetworkEquipmentListResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Metadata** | Pointer to [**Metadata**](Metadata.md) | | [optional] +**NetworkEquipments** | Pointer to [**[]NetworkEquipment**](NetworkEquipment.md) | An array of network equipment | [optional] + +## Methods + +### NewGetNetworkEquipmentListResult + +`func NewGetNetworkEquipmentListResult() *GetNetworkEquipmentListResult` + +NewGetNetworkEquipmentListResult instantiates a new GetNetworkEquipmentListResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetNetworkEquipmentListResultWithDefaults + +`func NewGetNetworkEquipmentListResultWithDefaults() *GetNetworkEquipmentListResult` + +NewGetNetworkEquipmentListResultWithDefaults instantiates a new GetNetworkEquipmentListResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMetadata + +`func (o *GetNetworkEquipmentListResult) GetMetadata() Metadata` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *GetNetworkEquipmentListResult) GetMetadataOk() (*Metadata, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *GetNetworkEquipmentListResult) SetMetadata(v Metadata)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *GetNetworkEquipmentListResult) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + +### GetNetworkEquipments + +`func (o *GetNetworkEquipmentListResult) GetNetworkEquipments() []NetworkEquipment` + +GetNetworkEquipments returns the NetworkEquipments field if non-nil, zero value otherwise. + +### GetNetworkEquipmentsOk + +`func (o *GetNetworkEquipmentListResult) GetNetworkEquipmentsOk() (*[]NetworkEquipment, bool)` + +GetNetworkEquipmentsOk returns a tuple with the NetworkEquipments field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNetworkEquipments + +`func (o *GetNetworkEquipmentListResult) SetNetworkEquipments(v []NetworkEquipment)` + +SetNetworkEquipments sets NetworkEquipments field to given value. + +### HasNetworkEquipments + +`func (o *GetNetworkEquipmentListResult) HasNetworkEquipments() bool` + +HasNetworkEquipments returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/dedicatedserver/docs/GetNetworkEquipmentNullRouteHistoryResult.md b/dedicatedserver/docs/GetNetworkEquipmentNullRouteHistoryResult.md new file mode 100644 index 0000000..c22cad7 --- /dev/null +++ b/dedicatedserver/docs/GetNetworkEquipmentNullRouteHistoryResult.md @@ -0,0 +1,82 @@ +# GetNetworkEquipmentNullRouteHistoryResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Metadata** | Pointer to [**Metadata**](Metadata.md) | | [optional] +**NullRoutes** | Pointer to [**[]NullRoute**](NullRoute.md) | An array of network equipment null route events | [optional] + +## Methods + +### NewGetNetworkEquipmentNullRouteHistoryResult + +`func NewGetNetworkEquipmentNullRouteHistoryResult() *GetNetworkEquipmentNullRouteHistoryResult` + +NewGetNetworkEquipmentNullRouteHistoryResult instantiates a new GetNetworkEquipmentNullRouteHistoryResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetNetworkEquipmentNullRouteHistoryResultWithDefaults + +`func NewGetNetworkEquipmentNullRouteHistoryResultWithDefaults() *GetNetworkEquipmentNullRouteHistoryResult` + +NewGetNetworkEquipmentNullRouteHistoryResultWithDefaults instantiates a new GetNetworkEquipmentNullRouteHistoryResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMetadata + +`func (o *GetNetworkEquipmentNullRouteHistoryResult) GetMetadata() Metadata` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *GetNetworkEquipmentNullRouteHistoryResult) GetMetadataOk() (*Metadata, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *GetNetworkEquipmentNullRouteHistoryResult) SetMetadata(v Metadata)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *GetNetworkEquipmentNullRouteHistoryResult) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + +### GetNullRoutes + +`func (o *GetNetworkEquipmentNullRouteHistoryResult) GetNullRoutes() []NullRoute` + +GetNullRoutes returns the NullRoutes field if non-nil, zero value otherwise. + +### GetNullRoutesOk + +`func (o *GetNetworkEquipmentNullRouteHistoryResult) GetNullRoutesOk() (*[]NullRoute, bool)` + +GetNullRoutesOk returns a tuple with the NullRoutes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNullRoutes + +`func (o *GetNetworkEquipmentNullRouteHistoryResult) SetNullRoutes(v []NullRoute)` + +SetNullRoutes sets NullRoutes field to given value. + +### HasNullRoutes + +`func (o *GetNetworkEquipmentNullRouteHistoryResult) HasNullRoutes() bool` + +HasNullRoutes returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/dedicatedserver/docs/GetServerListResult.md b/dedicatedserver/docs/GetServerListResult.md new file mode 100644 index 0000000..cf29c39 --- /dev/null +++ b/dedicatedserver/docs/GetServerListResult.md @@ -0,0 +1,82 @@ +# GetServerListResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Metadata** | Pointer to [**Metadata**](Metadata.md) | | [optional] +**Servers** | Pointer to [**[]Server**](Server.md) | An array of servers | [optional] + +## Methods + +### NewGetServerListResult + +`func NewGetServerListResult() *GetServerListResult` + +NewGetServerListResult instantiates a new GetServerListResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetServerListResultWithDefaults + +`func NewGetServerListResultWithDefaults() *GetServerListResult` + +NewGetServerListResultWithDefaults instantiates a new GetServerListResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMetadata + +`func (o *GetServerListResult) GetMetadata() Metadata` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *GetServerListResult) GetMetadataOk() (*Metadata, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *GetServerListResult) SetMetadata(v Metadata)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *GetServerListResult) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + +### GetServers + +`func (o *GetServerListResult) GetServers() []Server` + +GetServers returns the Servers field if non-nil, zero value otherwise. + +### GetServersOk + +`func (o *GetServerListResult) GetServersOk() (*[]Server, bool)` + +GetServersOk returns a tuple with the Servers field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetServers + +`func (o *GetServerListResult) SetServers(v []Server)` + +SetServers sets Servers field to given value. + +### HasServers + +`func (o *GetServerListResult) HasServers() bool` + +HasServers returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/dedicatedserver/docs/GetServerNullRouteHistoryResult.md b/dedicatedserver/docs/GetServerNullRouteHistoryResult.md new file mode 100644 index 0000000..7661874 --- /dev/null +++ b/dedicatedserver/docs/GetServerNullRouteHistoryResult.md @@ -0,0 +1,82 @@ +# GetServerNullRouteHistoryResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Metadata** | Pointer to [**Metadata**](Metadata.md) | | [optional] +**NullRoutes** | Pointer to [**[]NullRoute**](NullRoute.md) | An array of server null route events | [optional] + +## Methods + +### NewGetServerNullRouteHistoryResult + +`func NewGetServerNullRouteHistoryResult() *GetServerNullRouteHistoryResult` + +NewGetServerNullRouteHistoryResult instantiates a new GetServerNullRouteHistoryResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetServerNullRouteHistoryResultWithDefaults + +`func NewGetServerNullRouteHistoryResultWithDefaults() *GetServerNullRouteHistoryResult` + +NewGetServerNullRouteHistoryResultWithDefaults instantiates a new GetServerNullRouteHistoryResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMetadata + +`func (o *GetServerNullRouteHistoryResult) GetMetadata() Metadata` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *GetServerNullRouteHistoryResult) GetMetadataOk() (*Metadata, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *GetServerNullRouteHistoryResult) SetMetadata(v Metadata)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *GetServerNullRouteHistoryResult) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + +### GetNullRoutes + +`func (o *GetServerNullRouteHistoryResult) GetNullRoutes() []NullRoute` + +GetNullRoutes returns the NullRoutes field if non-nil, zero value otherwise. + +### GetNullRoutesOk + +`func (o *GetServerNullRouteHistoryResult) GetNullRoutesOk() (*[]NullRoute, bool)` + +GetNullRoutesOk returns a tuple with the NullRoutes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNullRoutes + +`func (o *GetServerNullRouteHistoryResult) SetNullRoutes(v []NullRoute)` + +SetNullRoutes sets NullRoutes field to given value. + +### HasNullRoutes + +`func (o *GetServerNullRouteHistoryResult) HasNullRoutes() bool` + +HasNullRoutes returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/dedicatedserver/docs/Hdd.md b/dedicatedserver/docs/Hdd.md new file mode 100644 index 0000000..82430a0 --- /dev/null +++ b/dedicatedserver/docs/Hdd.md @@ -0,0 +1,196 @@ +# Hdd + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Id of the hard disk drive | [optional] +**Amount** | Pointer to **int32** | The total amount of hard disk drives | [optional] +**Size** | Pointer to **int32** | The size number of the hard disk drive | [optional] +**Type** | Pointer to **string** | The type of the hard disk drive | [optional] +**Unit** | Pointer to **string** | The unit of the hard disk drive | [optional] +**PerformanceType** | Pointer to **NullableString** | Hard disk drive performance type | [optional] + +## Methods + +### NewHdd + +`func NewHdd() *Hdd` + +NewHdd instantiates a new Hdd object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewHddWithDefaults + +`func NewHddWithDefaults() *Hdd` + +NewHddWithDefaults instantiates a new Hdd object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *Hdd) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Hdd) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Hdd) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Hdd) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetAmount + +`func (o *Hdd) GetAmount() int32` + +GetAmount returns the Amount field if non-nil, zero value otherwise. + +### GetAmountOk + +`func (o *Hdd) GetAmountOk() (*int32, bool)` + +GetAmountOk returns a tuple with the Amount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAmount + +`func (o *Hdd) SetAmount(v int32)` + +SetAmount sets Amount field to given value. + +### HasAmount + +`func (o *Hdd) HasAmount() bool` + +HasAmount returns a boolean if a field has been set. + +### GetSize + +`func (o *Hdd) GetSize() int32` + +GetSize returns the Size field if non-nil, zero value otherwise. + +### GetSizeOk + +`func (o *Hdd) GetSizeOk() (*int32, bool)` + +GetSizeOk returns a tuple with the Size field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSize + +`func (o *Hdd) SetSize(v int32)` + +SetSize sets Size field to given value. + +### HasSize + +`func (o *Hdd) HasSize() bool` + +HasSize returns a boolean if a field has been set. + +### GetType + +`func (o *Hdd) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Hdd) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Hdd) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Hdd) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetUnit + +`func (o *Hdd) GetUnit() string` + +GetUnit returns the Unit field if non-nil, zero value otherwise. + +### GetUnitOk + +`func (o *Hdd) GetUnitOk() (*string, bool)` + +GetUnitOk returns a tuple with the Unit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnit + +`func (o *Hdd) SetUnit(v string)` + +SetUnit sets Unit field to given value. + +### HasUnit + +`func (o *Hdd) HasUnit() bool` + +HasUnit returns a boolean if a field has been set. + +### GetPerformanceType + +`func (o *Hdd) GetPerformanceType() string` + +GetPerformanceType returns the PerformanceType field if non-nil, zero value otherwise. + +### GetPerformanceTypeOk + +`func (o *Hdd) GetPerformanceTypeOk() (*string, bool)` + +GetPerformanceTypeOk returns a tuple with the PerformanceType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPerformanceType + +`func (o *Hdd) SetPerformanceType(v string)` + +SetPerformanceType sets PerformanceType field to given value. + +### HasPerformanceType + +`func (o *Hdd) HasPerformanceType() bool` + +HasPerformanceType returns a boolean if a field has been set. + +### SetPerformanceTypeNil + +`func (o *Hdd) SetPerformanceTypeNil(b bool)` + + SetPerformanceTypeNil sets the value for PerformanceType to be an explicit nil + +### UnsetPerformanceType +`func (o *Hdd) UnsetPerformanceType()` + +UnsetPerformanceType ensures that no value is present for PerformanceType, not even an explicit nil + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/dedicatedserver/docs/Ip.md b/dedicatedserver/docs/Ip.md new file mode 100644 index 0000000..2ae48b3 --- /dev/null +++ b/dedicatedserver/docs/Ip.md @@ -0,0 +1,264 @@ +# Ip + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ddos** | Pointer to [**DDos**](DDos.md) | | [optional] +**FloatingIp** | Pointer to **bool** | Indicates if the IP is a Floating IP | [optional] +**Gateway** | Pointer to **string** | Gateway | [optional] +**Ip** | Pointer to **string** | IP address in CIDR notation | [optional] +**MainIp** | Pointer to **bool** | IP address is main | [optional] +**NetworkType** | Pointer to **string** | Type of network | [optional] +**NullRouted** | Pointer to **bool** | IP address null routed | [optional] +**ReverseLookup** | Pointer to **string** | The reverse lookup value | [optional] +**Version** | Pointer to **int32** | IP version | [optional] + +## Methods + +### NewIp + +`func NewIp() *Ip` + +NewIp instantiates a new Ip object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewIpWithDefaults + +`func NewIpWithDefaults() *Ip` + +NewIpWithDefaults instantiates a new Ip object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDdos + +`func (o *Ip) GetDdos() DDos` + +GetDdos returns the Ddos field if non-nil, zero value otherwise. + +### GetDdosOk + +`func (o *Ip) GetDdosOk() (*DDos, bool)` + +GetDdosOk returns a tuple with the Ddos field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDdos + +`func (o *Ip) SetDdos(v DDos)` + +SetDdos sets Ddos field to given value. + +### HasDdos + +`func (o *Ip) HasDdos() bool` + +HasDdos returns a boolean if a field has been set. + +### GetFloatingIp + +`func (o *Ip) GetFloatingIp() bool` + +GetFloatingIp returns the FloatingIp field if non-nil, zero value otherwise. + +### GetFloatingIpOk + +`func (o *Ip) GetFloatingIpOk() (*bool, bool)` + +GetFloatingIpOk returns a tuple with the FloatingIp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFloatingIp + +`func (o *Ip) SetFloatingIp(v bool)` + +SetFloatingIp sets FloatingIp field to given value. + +### HasFloatingIp + +`func (o *Ip) HasFloatingIp() bool` + +HasFloatingIp returns a boolean if a field has been set. + +### GetGateway + +`func (o *Ip) GetGateway() string` + +GetGateway returns the Gateway field if non-nil, zero value otherwise. + +### GetGatewayOk + +`func (o *Ip) GetGatewayOk() (*string, bool)` + +GetGatewayOk returns a tuple with the Gateway field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetGateway + +`func (o *Ip) SetGateway(v string)` + +SetGateway sets Gateway field to given value. + +### HasGateway + +`func (o *Ip) HasGateway() bool` + +HasGateway returns a boolean if a field has been set. + +### GetIp + +`func (o *Ip) GetIp() string` + +GetIp returns the Ip field if non-nil, zero value otherwise. + +### GetIpOk + +`func (o *Ip) GetIpOk() (*string, bool)` + +GetIpOk returns a tuple with the Ip field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIp + +`func (o *Ip) SetIp(v string)` + +SetIp sets Ip field to given value. + +### HasIp + +`func (o *Ip) HasIp() bool` + +HasIp returns a boolean if a field has been set. + +### GetMainIp + +`func (o *Ip) GetMainIp() bool` + +GetMainIp returns the MainIp field if non-nil, zero value otherwise. + +### GetMainIpOk + +`func (o *Ip) GetMainIpOk() (*bool, bool)` + +GetMainIpOk returns a tuple with the MainIp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMainIp + +`func (o *Ip) SetMainIp(v bool)` + +SetMainIp sets MainIp field to given value. + +### HasMainIp + +`func (o *Ip) HasMainIp() bool` + +HasMainIp returns a boolean if a field has been set. + +### GetNetworkType + +`func (o *Ip) GetNetworkType() string` + +GetNetworkType returns the NetworkType field if non-nil, zero value otherwise. + +### GetNetworkTypeOk + +`func (o *Ip) GetNetworkTypeOk() (*string, bool)` + +GetNetworkTypeOk returns a tuple with the NetworkType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNetworkType + +`func (o *Ip) SetNetworkType(v string)` + +SetNetworkType sets NetworkType field to given value. + +### HasNetworkType + +`func (o *Ip) HasNetworkType() bool` + +HasNetworkType returns a boolean if a field has been set. + +### GetNullRouted + +`func (o *Ip) GetNullRouted() bool` + +GetNullRouted returns the NullRouted field if non-nil, zero value otherwise. + +### GetNullRoutedOk + +`func (o *Ip) GetNullRoutedOk() (*bool, bool)` + +GetNullRoutedOk returns a tuple with the NullRouted field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNullRouted + +`func (o *Ip) SetNullRouted(v bool)` + +SetNullRouted sets NullRouted field to given value. + +### HasNullRouted + +`func (o *Ip) HasNullRouted() bool` + +HasNullRouted returns a boolean if a field has been set. + +### GetReverseLookup + +`func (o *Ip) GetReverseLookup() string` + +GetReverseLookup returns the ReverseLookup field if non-nil, zero value otherwise. + +### GetReverseLookupOk + +`func (o *Ip) GetReverseLookupOk() (*string, bool)` + +GetReverseLookupOk returns a tuple with the ReverseLookup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReverseLookup + +`func (o *Ip) SetReverseLookup(v string)` + +SetReverseLookup sets ReverseLookup field to given value. + +### HasReverseLookup + +`func (o *Ip) HasReverseLookup() bool` + +HasReverseLookup returns a boolean if a field has been set. + +### GetVersion + +`func (o *Ip) GetVersion() int32` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *Ip) GetVersionOk() (*int32, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *Ip) SetVersion(v int32)` + +SetVersion sets Version field to given value. + +### HasVersion + +`func (o *Ip) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/dedicatedserver/docs/LinkSpeed.md b/dedicatedserver/docs/LinkSpeed.md new file mode 100644 index 0000000..b3ff9c3 --- /dev/null +++ b/dedicatedserver/docs/LinkSpeed.md @@ -0,0 +1,15 @@ +# LinkSpeed + +## Enum + + +* `_100` (value: `100`) + +* `_1000` (value: `1000`) + +* `_10000` (value: `10000`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/dedicatedserver/docs/Metadata.md b/dedicatedserver/docs/Metadata.md new file mode 100644 index 0000000..194d6a7 --- /dev/null +++ b/dedicatedserver/docs/Metadata.md @@ -0,0 +1,108 @@ +# Metadata + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TotalCount** | Pointer to **float32** | Total amount of orders in this collection | [optional] +**Offset** | Pointer to **float32** | The offset used to generate this response | [optional] [default to 0] +**Limit** | Pointer to **float32** | The limit used to generate this response | [optional] [default to 5] + +## Methods + +### NewMetadata + +`func NewMetadata() *Metadata` + +NewMetadata instantiates a new Metadata object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewMetadataWithDefaults + +`func NewMetadataWithDefaults() *Metadata` + +NewMetadataWithDefaults instantiates a new Metadata object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetTotalCount + +`func (o *Metadata) GetTotalCount() float32` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *Metadata) GetTotalCountOk() (*float32, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *Metadata) SetTotalCount(v float32)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *Metadata) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + +### GetOffset + +`func (o *Metadata) GetOffset() float32` + +GetOffset returns the Offset field if non-nil, zero value otherwise. + +### GetOffsetOk + +`func (o *Metadata) GetOffsetOk() (*float32, bool)` + +GetOffsetOk returns a tuple with the Offset field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOffset + +`func (o *Metadata) SetOffset(v float32)` + +SetOffset sets Offset field to given value. + +### HasOffset + +`func (o *Metadata) HasOffset() bool` + +HasOffset returns a boolean if a field has been set. + +### GetLimit + +`func (o *Metadata) GetLimit() float32` + +GetLimit returns the Limit field if non-nil, zero value otherwise. + +### GetLimitOk + +`func (o *Metadata) GetLimitOk() (*float32, bool)` + +GetLimitOk returns a tuple with the Limit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLimit + +`func (o *Metadata) SetLimit(v float32)` + +SetLimit sets Limit field to given value. + +### HasLimit + +`func (o *Metadata) HasLimit() bool` + +HasLimit returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/dedicatedserver/docs/NetworkEquipment.md b/dedicatedserver/docs/NetworkEquipment.md new file mode 100644 index 0000000..a0ae22d --- /dev/null +++ b/dedicatedserver/docs/NetworkEquipment.md @@ -0,0 +1,316 @@ +# NetworkEquipment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Contract** | Pointer to **map[string]interface{}** | Contract information | [optional] +**FeatureAvailability** | Pointer to **map[string]interface{}** | List of features that are available for this network equipment | [optional] +**Id** | Pointer to **string** | Id of the network equipment | [optional] +**Location** | Pointer to **map[string]interface{}** | Location of the network equipment | [optional] +**Name** | Pointer to **string** | The name of the network equipment | [optional] +**Type** | Pointer to **string** | The network equipment type | [optional] +**NetworkInterfaces** | Pointer to **map[string]interface{}** | Network interface information grouped by type | [optional] +**PowerPorts** | Pointer to [**[]Powerport**](Powerport.md) | List of ports that can be used to manage power of the network equipment | [optional] +**Rack** | Pointer to [**Rack**](Rack.md) | | [optional] +**SerialNumber** | Pointer to **string** | Serial number of network equipment | [optional] +**Specs** | Pointer to [**NetworkEquipmentSpecs**](NetworkEquipmentSpecs.md) | | [optional] + +## Methods + +### NewNetworkEquipment + +`func NewNetworkEquipment() *NetworkEquipment` + +NewNetworkEquipment instantiates a new NetworkEquipment object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewNetworkEquipmentWithDefaults + +`func NewNetworkEquipmentWithDefaults() *NetworkEquipment` + +NewNetworkEquipmentWithDefaults instantiates a new NetworkEquipment object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetContract + +`func (o *NetworkEquipment) GetContract() map[string]interface{}` + +GetContract returns the Contract field if non-nil, zero value otherwise. + +### GetContractOk + +`func (o *NetworkEquipment) GetContractOk() (*map[string]interface{}, bool)` + +GetContractOk returns a tuple with the Contract field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContract + +`func (o *NetworkEquipment) SetContract(v map[string]interface{})` + +SetContract sets Contract field to given value. + +### HasContract + +`func (o *NetworkEquipment) HasContract() bool` + +HasContract returns a boolean if a field has been set. + +### GetFeatureAvailability + +`func (o *NetworkEquipment) GetFeatureAvailability() map[string]interface{}` + +GetFeatureAvailability returns the FeatureAvailability field if non-nil, zero value otherwise. + +### GetFeatureAvailabilityOk + +`func (o *NetworkEquipment) GetFeatureAvailabilityOk() (*map[string]interface{}, bool)` + +GetFeatureAvailabilityOk returns a tuple with the FeatureAvailability field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatureAvailability + +`func (o *NetworkEquipment) SetFeatureAvailability(v map[string]interface{})` + +SetFeatureAvailability sets FeatureAvailability field to given value. + +### HasFeatureAvailability + +`func (o *NetworkEquipment) HasFeatureAvailability() bool` + +HasFeatureAvailability returns a boolean if a field has been set. + +### GetId + +`func (o *NetworkEquipment) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *NetworkEquipment) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *NetworkEquipment) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *NetworkEquipment) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLocation + +`func (o *NetworkEquipment) GetLocation() map[string]interface{}` + +GetLocation returns the Location field if non-nil, zero value otherwise. + +### GetLocationOk + +`func (o *NetworkEquipment) GetLocationOk() (*map[string]interface{}, bool)` + +GetLocationOk returns a tuple with the Location field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocation + +`func (o *NetworkEquipment) SetLocation(v map[string]interface{})` + +SetLocation sets Location field to given value. + +### HasLocation + +`func (o *NetworkEquipment) HasLocation() bool` + +HasLocation returns a boolean if a field has been set. + +### GetName + +`func (o *NetworkEquipment) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *NetworkEquipment) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *NetworkEquipment) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *NetworkEquipment) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetType + +`func (o *NetworkEquipment) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *NetworkEquipment) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *NetworkEquipment) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *NetworkEquipment) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetNetworkInterfaces + +`func (o *NetworkEquipment) GetNetworkInterfaces() map[string]interface{}` + +GetNetworkInterfaces returns the NetworkInterfaces field if non-nil, zero value otherwise. + +### GetNetworkInterfacesOk + +`func (o *NetworkEquipment) GetNetworkInterfacesOk() (*map[string]interface{}, bool)` + +GetNetworkInterfacesOk returns a tuple with the NetworkInterfaces field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNetworkInterfaces + +`func (o *NetworkEquipment) SetNetworkInterfaces(v map[string]interface{})` + +SetNetworkInterfaces sets NetworkInterfaces field to given value. + +### HasNetworkInterfaces + +`func (o *NetworkEquipment) HasNetworkInterfaces() bool` + +HasNetworkInterfaces returns a boolean if a field has been set. + +### GetPowerPorts + +`func (o *NetworkEquipment) GetPowerPorts() []Powerport` + +GetPowerPorts returns the PowerPorts field if non-nil, zero value otherwise. + +### GetPowerPortsOk + +`func (o *NetworkEquipment) GetPowerPortsOk() (*[]Powerport, bool)` + +GetPowerPortsOk returns a tuple with the PowerPorts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPowerPorts + +`func (o *NetworkEquipment) SetPowerPorts(v []Powerport)` + +SetPowerPorts sets PowerPorts field to given value. + +### HasPowerPorts + +`func (o *NetworkEquipment) HasPowerPorts() bool` + +HasPowerPorts returns a boolean if a field has been set. + +### GetRack + +`func (o *NetworkEquipment) GetRack() Rack` + +GetRack returns the Rack field if non-nil, zero value otherwise. + +### GetRackOk + +`func (o *NetworkEquipment) GetRackOk() (*Rack, bool)` + +GetRackOk returns a tuple with the Rack field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRack + +`func (o *NetworkEquipment) SetRack(v Rack)` + +SetRack sets Rack field to given value. + +### HasRack + +`func (o *NetworkEquipment) HasRack() bool` + +HasRack returns a boolean if a field has been set. + +### GetSerialNumber + +`func (o *NetworkEquipment) GetSerialNumber() string` + +GetSerialNumber returns the SerialNumber field if non-nil, zero value otherwise. + +### GetSerialNumberOk + +`func (o *NetworkEquipment) GetSerialNumberOk() (*string, bool)` + +GetSerialNumberOk returns a tuple with the SerialNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSerialNumber + +`func (o *NetworkEquipment) SetSerialNumber(v string)` + +SetSerialNumber sets SerialNumber field to given value. + +### HasSerialNumber + +`func (o *NetworkEquipment) HasSerialNumber() bool` + +HasSerialNumber returns a boolean if a field has been set. + +### GetSpecs + +`func (o *NetworkEquipment) GetSpecs() NetworkEquipmentSpecs` + +GetSpecs returns the Specs field if non-nil, zero value otherwise. + +### GetSpecsOk + +`func (o *NetworkEquipment) GetSpecsOk() (*NetworkEquipmentSpecs, bool)` + +GetSpecsOk returns a tuple with the Specs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSpecs + +`func (o *NetworkEquipment) SetSpecs(v NetworkEquipmentSpecs)` + +SetSpecs sets Specs field to given value. + +### HasSpecs + +`func (o *NetworkEquipment) HasSpecs() bool` + +HasSpecs returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/dedicatedserver/docs/NetworkEquipmentSpecs.md b/dedicatedserver/docs/NetworkEquipmentSpecs.md new file mode 100644 index 0000000..2fdbce3 --- /dev/null +++ b/dedicatedserver/docs/NetworkEquipmentSpecs.md @@ -0,0 +1,82 @@ +# NetworkEquipmentSpecs + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Brand** | Pointer to **string** | The brand of the network equipment | [optional] +**Model** | Pointer to **string** | The model of the network equipment | [optional] + +## Methods + +### NewNetworkEquipmentSpecs + +`func NewNetworkEquipmentSpecs() *NetworkEquipmentSpecs` + +NewNetworkEquipmentSpecs instantiates a new NetworkEquipmentSpecs object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewNetworkEquipmentSpecsWithDefaults + +`func NewNetworkEquipmentSpecsWithDefaults() *NetworkEquipmentSpecs` + +NewNetworkEquipmentSpecsWithDefaults instantiates a new NetworkEquipmentSpecs object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetBrand + +`func (o *NetworkEquipmentSpecs) GetBrand() string` + +GetBrand returns the Brand field if non-nil, zero value otherwise. + +### GetBrandOk + +`func (o *NetworkEquipmentSpecs) GetBrandOk() (*string, bool)` + +GetBrandOk returns a tuple with the Brand field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBrand + +`func (o *NetworkEquipmentSpecs) SetBrand(v string)` + +SetBrand sets Brand field to given value. + +### HasBrand + +`func (o *NetworkEquipmentSpecs) HasBrand() bool` + +HasBrand returns a boolean if a field has been set. + +### GetModel + +`func (o *NetworkEquipmentSpecs) GetModel() string` + +GetModel returns the Model field if non-nil, zero value otherwise. + +### GetModelOk + +`func (o *NetworkEquipmentSpecs) GetModelOk() (*string, bool)` + +GetModelOk returns a tuple with the Model field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetModel + +`func (o *NetworkEquipmentSpecs) SetModel(v string)` + +SetModel sets Model field to given value. + +### HasModel + +`func (o *NetworkEquipmentSpecs) HasModel() bool` + +HasModel returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/dedicatedserver/docs/NullRoute.md b/dedicatedserver/docs/NullRoute.md new file mode 100644 index 0000000..af5e74d --- /dev/null +++ b/dedicatedserver/docs/NullRoute.md @@ -0,0 +1,186 @@ +# NullRoute + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AutomatedUnnullingAt** | Pointer to **time.Time** | The time the null route was removed or will be removed. | [optional] +**Comment** | Pointer to **string** | An optional comment for the reason of the null route | [optional] +**Ip** | Pointer to **string** | The ip address that was null routed | [optional] +**NullLevel** | Pointer to **int32** | The level of the null route | [optional] +**NulledAt** | Pointer to **time.Time** | The time the null route was created | [optional] +**TicketId** | Pointer to **string** | A ticket number if available | [optional] + +## Methods + +### NewNullRoute + +`func NewNullRoute() *NullRoute` + +NewNullRoute instantiates a new NullRoute object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewNullRouteWithDefaults + +`func NewNullRouteWithDefaults() *NullRoute` + +NewNullRouteWithDefaults instantiates a new NullRoute object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAutomatedUnnullingAt + +`func (o *NullRoute) GetAutomatedUnnullingAt() time.Time` + +GetAutomatedUnnullingAt returns the AutomatedUnnullingAt field if non-nil, zero value otherwise. + +### GetAutomatedUnnullingAtOk + +`func (o *NullRoute) GetAutomatedUnnullingAtOk() (*time.Time, bool)` + +GetAutomatedUnnullingAtOk returns a tuple with the AutomatedUnnullingAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAutomatedUnnullingAt + +`func (o *NullRoute) SetAutomatedUnnullingAt(v time.Time)` + +SetAutomatedUnnullingAt sets AutomatedUnnullingAt field to given value. + +### HasAutomatedUnnullingAt + +`func (o *NullRoute) HasAutomatedUnnullingAt() bool` + +HasAutomatedUnnullingAt returns a boolean if a field has been set. + +### GetComment + +`func (o *NullRoute) GetComment() string` + +GetComment returns the Comment field if non-nil, zero value otherwise. + +### GetCommentOk + +`func (o *NullRoute) GetCommentOk() (*string, bool)` + +GetCommentOk returns a tuple with the Comment field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetComment + +`func (o *NullRoute) SetComment(v string)` + +SetComment sets Comment field to given value. + +### HasComment + +`func (o *NullRoute) HasComment() bool` + +HasComment returns a boolean if a field has been set. + +### GetIp + +`func (o *NullRoute) GetIp() string` + +GetIp returns the Ip field if non-nil, zero value otherwise. + +### GetIpOk + +`func (o *NullRoute) GetIpOk() (*string, bool)` + +GetIpOk returns a tuple with the Ip field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIp + +`func (o *NullRoute) SetIp(v string)` + +SetIp sets Ip field to given value. + +### HasIp + +`func (o *NullRoute) HasIp() bool` + +HasIp returns a boolean if a field has been set. + +### GetNullLevel + +`func (o *NullRoute) GetNullLevel() int32` + +GetNullLevel returns the NullLevel field if non-nil, zero value otherwise. + +### GetNullLevelOk + +`func (o *NullRoute) GetNullLevelOk() (*int32, bool)` + +GetNullLevelOk returns a tuple with the NullLevel field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNullLevel + +`func (o *NullRoute) SetNullLevel(v int32)` + +SetNullLevel sets NullLevel field to given value. + +### HasNullLevel + +`func (o *NullRoute) HasNullLevel() bool` + +HasNullLevel returns a boolean if a field has been set. + +### GetNulledAt + +`func (o *NullRoute) GetNulledAt() time.Time` + +GetNulledAt returns the NulledAt field if non-nil, zero value otherwise. + +### GetNulledAtOk + +`func (o *NullRoute) GetNulledAtOk() (*time.Time, bool)` + +GetNulledAtOk returns a tuple with the NulledAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNulledAt + +`func (o *NullRoute) SetNulledAt(v time.Time)` + +SetNulledAt sets NulledAt field to given value. + +### HasNulledAt + +`func (o *NullRoute) HasNulledAt() bool` + +HasNulledAt returns a boolean if a field has been set. + +### GetTicketId + +`func (o *NullRoute) GetTicketId() string` + +GetTicketId returns the TicketId field if non-nil, zero value otherwise. + +### GetTicketIdOk + +`func (o *NullRoute) GetTicketIdOk() (*string, bool)` + +GetTicketIdOk returns a tuple with the TicketId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTicketId + +`func (o *NullRoute) SetTicketId(v string)` + +SetTicketId sets TicketId field to given value. + +### HasTicketId + +`func (o *NullRoute) HasTicketId() bool` + +HasTicketId returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/dedicatedserver/docs/PciCard.md b/dedicatedserver/docs/PciCard.md new file mode 100644 index 0000000..965f729 --- /dev/null +++ b/dedicatedserver/docs/PciCard.md @@ -0,0 +1,56 @@ +# PciCard + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **string** | The description of the PCI card of the server | [optional] + +## Methods + +### NewPciCard + +`func NewPciCard() *PciCard` + +NewPciCard instantiates a new PciCard object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPciCardWithDefaults + +`func NewPciCardWithDefaults() *PciCard` + +NewPciCardWithDefaults instantiates a new PciCard object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDescription + +`func (o *PciCard) GetDescription() string` + +GetDescription returns the Description field if non-nil, zero value otherwise. + +### GetDescriptionOk + +`func (o *PciCard) GetDescriptionOk() (*string, bool)` + +GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDescription + +`func (o *PciCard) SetDescription(v string)` + +SetDescription sets Description field to given value. + +### HasDescription + +`func (o *PciCard) HasDescription() bool` + +HasDescription returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/dedicatedserver/docs/Powerport.md b/dedicatedserver/docs/Powerport.md new file mode 100644 index 0000000..24fbedd --- /dev/null +++ b/dedicatedserver/docs/Powerport.md @@ -0,0 +1,82 @@ +# Powerport + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | | [optional] +**Port** | Pointer to **string** | | [optional] + +## Methods + +### NewPowerport + +`func NewPowerport() *Powerport` + +NewPowerport instantiates a new Powerport object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPowerportWithDefaults + +`func NewPowerportWithDefaults() *Powerport` + +NewPowerportWithDefaults instantiates a new Powerport object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetName + +`func (o *Powerport) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Powerport) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Powerport) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Powerport) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetPort + +`func (o *Powerport) GetPort() string` + +GetPort returns the Port field if non-nil, zero value otherwise. + +### GetPortOk + +`func (o *Powerport) GetPortOk() (*string, bool)` + +GetPortOk returns a tuple with the Port field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPort + +`func (o *Powerport) SetPort(v string)` + +SetPort sets Port field to given value. + +### HasPort + +`func (o *Powerport) HasPort() bool` + +HasPort returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/dedicatedserver/docs/PrivateNetwork.md b/dedicatedserver/docs/PrivateNetwork.md new file mode 100644 index 0000000..721f76d --- /dev/null +++ b/dedicatedserver/docs/PrivateNetwork.md @@ -0,0 +1,160 @@ +# PrivateNetwork + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Private network id | [optional] +**LinkSpeed** | Pointer to [**LinkSpeed**](LinkSpeed.md) | | [optional] +**Status** | Pointer to **string** | Configuration status | [optional] +**Subnet** | Pointer to **string** | | [optional] +**VlanId** | Pointer to **string** | VLAN id | [optional] + +## Methods + +### NewPrivateNetwork + +`func NewPrivateNetwork() *PrivateNetwork` + +NewPrivateNetwork instantiates a new PrivateNetwork object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPrivateNetworkWithDefaults + +`func NewPrivateNetworkWithDefaults() *PrivateNetwork` + +NewPrivateNetworkWithDefaults instantiates a new PrivateNetwork object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *PrivateNetwork) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *PrivateNetwork) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *PrivateNetwork) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *PrivateNetwork) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLinkSpeed + +`func (o *PrivateNetwork) GetLinkSpeed() LinkSpeed` + +GetLinkSpeed returns the LinkSpeed field if non-nil, zero value otherwise. + +### GetLinkSpeedOk + +`func (o *PrivateNetwork) GetLinkSpeedOk() (*LinkSpeed, bool)` + +GetLinkSpeedOk returns a tuple with the LinkSpeed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinkSpeed + +`func (o *PrivateNetwork) SetLinkSpeed(v LinkSpeed)` + +SetLinkSpeed sets LinkSpeed field to given value. + +### HasLinkSpeed + +`func (o *PrivateNetwork) HasLinkSpeed() bool` + +HasLinkSpeed returns a boolean if a field has been set. + +### GetStatus + +`func (o *PrivateNetwork) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *PrivateNetwork) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *PrivateNetwork) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *PrivateNetwork) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetSubnet + +`func (o *PrivateNetwork) GetSubnet() string` + +GetSubnet returns the Subnet field if non-nil, zero value otherwise. + +### GetSubnetOk + +`func (o *PrivateNetwork) GetSubnetOk() (*string, bool)` + +GetSubnetOk returns a tuple with the Subnet field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubnet + +`func (o *PrivateNetwork) SetSubnet(v string)` + +SetSubnet sets Subnet field to given value. + +### HasSubnet + +`func (o *PrivateNetwork) HasSubnet() bool` + +HasSubnet returns a boolean if a field has been set. + +### GetVlanId + +`func (o *PrivateNetwork) GetVlanId() string` + +GetVlanId returns the VlanId field if non-nil, zero value otherwise. + +### GetVlanIdOk + +`func (o *PrivateNetwork) GetVlanIdOk() (*string, bool)` + +GetVlanIdOk returns a tuple with the VlanId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVlanId + +`func (o *PrivateNetwork) SetVlanId(v string)` + +SetVlanId sets VlanId field to given value. + +### HasVlanId + +`func (o *PrivateNetwork) HasVlanId() bool` + +HasVlanId returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/dedicatedserver/docs/Rack.md b/dedicatedserver/docs/Rack.md new file mode 100644 index 0000000..6a0a0c4 --- /dev/null +++ b/dedicatedserver/docs/Rack.md @@ -0,0 +1,108 @@ +# Rack + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | Rack id | [optional] +**Capacity** | Pointer to **string** | Rack capacity | [optional] +**Type** | Pointer to **string** | | [optional] + +## Methods + +### NewRack + +`func NewRack() *Rack` + +NewRack instantiates a new Rack object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewRackWithDefaults + +`func NewRackWithDefaults() *Rack` + +NewRackWithDefaults instantiates a new Rack object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *Rack) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Rack) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Rack) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Rack) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetCapacity + +`func (o *Rack) GetCapacity() string` + +GetCapacity returns the Capacity field if non-nil, zero value otherwise. + +### GetCapacityOk + +`func (o *Rack) GetCapacityOk() (*string, bool)` + +GetCapacityOk returns a tuple with the Capacity field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCapacity + +`func (o *Rack) SetCapacity(v string)` + +SetCapacity sets Capacity field to given value. + +### HasCapacity + +`func (o *Rack) HasCapacity() bool` + +HasCapacity returns a boolean if a field has been set. + +### GetType + +`func (o *Rack) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Rack) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Rack) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Rack) HasType() bool` + +HasType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/dedicatedserver/docs/Ram.md b/dedicatedserver/docs/Ram.md new file mode 100644 index 0000000..cbfc38e --- /dev/null +++ b/dedicatedserver/docs/Ram.md @@ -0,0 +1,82 @@ +# Ram + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Size** | Pointer to **int32** | The total RAM size of the server | [optional] +**Unit** | Pointer to **string** | RAM type of the server | [optional] + +## Methods + +### NewRam + +`func NewRam() *Ram` + +NewRam instantiates a new Ram object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewRamWithDefaults + +`func NewRamWithDefaults() *Ram` + +NewRamWithDefaults instantiates a new Ram object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetSize + +`func (o *Ram) GetSize() int32` + +GetSize returns the Size field if non-nil, zero value otherwise. + +### GetSizeOk + +`func (o *Ram) GetSizeOk() (*int32, bool)` + +GetSizeOk returns a tuple with the Size field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSize + +`func (o *Ram) SetSize(v int32)` + +SetSize sets Size field to given value. + +### HasSize + +`func (o *Ram) HasSize() bool` + +HasSize returns a boolean if a field has been set. + +### GetUnit + +`func (o *Ram) GetUnit() string` + +GetUnit returns the Unit field if non-nil, zero value otherwise. + +### GetUnitOk + +`func (o *Ram) GetUnitOk() (*string, bool)` + +GetUnitOk returns a tuple with the Unit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnit + +`func (o *Ram) SetUnit(v string)` + +SetUnit sets Unit field to given value. + +### HasUnit + +`func (o *Ram) HasUnit() bool` + +HasUnit returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/dedicatedserver/docs/Server.md b/dedicatedserver/docs/Server.md new file mode 100644 index 0000000..edcdfe4 --- /dev/null +++ b/dedicatedserver/docs/Server.md @@ -0,0 +1,316 @@ +# Server + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AssetId** | Pointer to **string** | The Asset Id of the server | [optional] +**Contract** | Pointer to **map[string]interface{}** | Contract information | [optional] +**FeatureAvailability** | Pointer to **map[string]interface{}** | List of features that are available for this server | [optional] +**Id** | Pointer to **string** | Id of the server | [optional] +**Location** | Pointer to **map[string]interface{}** | Location of the server | [optional] +**NetworkInterfaces** | Pointer to **map[string]interface{}** | Network interface information grouped by type | [optional] +**PowerPorts** | Pointer to [**[]Powerport**](Powerport.md) | List of ports that can be used to manage power of the server | [optional] +**PrivateNetworks** | Pointer to [**[]PrivateNetwork**](PrivateNetwork.md) | An array of private networks | [optional] +**Rack** | Pointer to [**Rack**](Rack.md) | | [optional] +**SerialNumber** | Pointer to **string** | Serial number of server | [optional] +**Specs** | Pointer to [**ServerSpecs**](ServerSpecs.md) | | [optional] + +## Methods + +### NewServer + +`func NewServer() *Server` + +NewServer instantiates a new Server object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewServerWithDefaults + +`func NewServerWithDefaults() *Server` + +NewServerWithDefaults instantiates a new Server object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAssetId + +`func (o *Server) GetAssetId() string` + +GetAssetId returns the AssetId field if non-nil, zero value otherwise. + +### GetAssetIdOk + +`func (o *Server) GetAssetIdOk() (*string, bool)` + +GetAssetIdOk returns a tuple with the AssetId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAssetId + +`func (o *Server) SetAssetId(v string)` + +SetAssetId sets AssetId field to given value. + +### HasAssetId + +`func (o *Server) HasAssetId() bool` + +HasAssetId returns a boolean if a field has been set. + +### GetContract + +`func (o *Server) GetContract() map[string]interface{}` + +GetContract returns the Contract field if non-nil, zero value otherwise. + +### GetContractOk + +`func (o *Server) GetContractOk() (*map[string]interface{}, bool)` + +GetContractOk returns a tuple with the Contract field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContract + +`func (o *Server) SetContract(v map[string]interface{})` + +SetContract sets Contract field to given value. + +### HasContract + +`func (o *Server) HasContract() bool` + +HasContract returns a boolean if a field has been set. + +### GetFeatureAvailability + +`func (o *Server) GetFeatureAvailability() map[string]interface{}` + +GetFeatureAvailability returns the FeatureAvailability field if non-nil, zero value otherwise. + +### GetFeatureAvailabilityOk + +`func (o *Server) GetFeatureAvailabilityOk() (*map[string]interface{}, bool)` + +GetFeatureAvailabilityOk returns a tuple with the FeatureAvailability field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFeatureAvailability + +`func (o *Server) SetFeatureAvailability(v map[string]interface{})` + +SetFeatureAvailability sets FeatureAvailability field to given value. + +### HasFeatureAvailability + +`func (o *Server) HasFeatureAvailability() bool` + +HasFeatureAvailability returns a boolean if a field has been set. + +### GetId + +`func (o *Server) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Server) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Server) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Server) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetLocation + +`func (o *Server) GetLocation() map[string]interface{}` + +GetLocation returns the Location field if non-nil, zero value otherwise. + +### GetLocationOk + +`func (o *Server) GetLocationOk() (*map[string]interface{}, bool)` + +GetLocationOk returns a tuple with the Location field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocation + +`func (o *Server) SetLocation(v map[string]interface{})` + +SetLocation sets Location field to given value. + +### HasLocation + +`func (o *Server) HasLocation() bool` + +HasLocation returns a boolean if a field has been set. + +### GetNetworkInterfaces + +`func (o *Server) GetNetworkInterfaces() map[string]interface{}` + +GetNetworkInterfaces returns the NetworkInterfaces field if non-nil, zero value otherwise. + +### GetNetworkInterfacesOk + +`func (o *Server) GetNetworkInterfacesOk() (*map[string]interface{}, bool)` + +GetNetworkInterfacesOk returns a tuple with the NetworkInterfaces field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNetworkInterfaces + +`func (o *Server) SetNetworkInterfaces(v map[string]interface{})` + +SetNetworkInterfaces sets NetworkInterfaces field to given value. + +### HasNetworkInterfaces + +`func (o *Server) HasNetworkInterfaces() bool` + +HasNetworkInterfaces returns a boolean if a field has been set. + +### GetPowerPorts + +`func (o *Server) GetPowerPorts() []Powerport` + +GetPowerPorts returns the PowerPorts field if non-nil, zero value otherwise. + +### GetPowerPortsOk + +`func (o *Server) GetPowerPortsOk() (*[]Powerport, bool)` + +GetPowerPortsOk returns a tuple with the PowerPorts field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPowerPorts + +`func (o *Server) SetPowerPorts(v []Powerport)` + +SetPowerPorts sets PowerPorts field to given value. + +### HasPowerPorts + +`func (o *Server) HasPowerPorts() bool` + +HasPowerPorts returns a boolean if a field has been set. + +### GetPrivateNetworks + +`func (o *Server) GetPrivateNetworks() []PrivateNetwork` + +GetPrivateNetworks returns the PrivateNetworks field if non-nil, zero value otherwise. + +### GetPrivateNetworksOk + +`func (o *Server) GetPrivateNetworksOk() (*[]PrivateNetwork, bool)` + +GetPrivateNetworksOk returns a tuple with the PrivateNetworks field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateNetworks + +`func (o *Server) SetPrivateNetworks(v []PrivateNetwork)` + +SetPrivateNetworks sets PrivateNetworks field to given value. + +### HasPrivateNetworks + +`func (o *Server) HasPrivateNetworks() bool` + +HasPrivateNetworks returns a boolean if a field has been set. + +### GetRack + +`func (o *Server) GetRack() Rack` + +GetRack returns the Rack field if non-nil, zero value otherwise. + +### GetRackOk + +`func (o *Server) GetRackOk() (*Rack, bool)` + +GetRackOk returns a tuple with the Rack field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRack + +`func (o *Server) SetRack(v Rack)` + +SetRack sets Rack field to given value. + +### HasRack + +`func (o *Server) HasRack() bool` + +HasRack returns a boolean if a field has been set. + +### GetSerialNumber + +`func (o *Server) GetSerialNumber() string` + +GetSerialNumber returns the SerialNumber field if non-nil, zero value otherwise. + +### GetSerialNumberOk + +`func (o *Server) GetSerialNumberOk() (*string, bool)` + +GetSerialNumberOk returns a tuple with the SerialNumber field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSerialNumber + +`func (o *Server) SetSerialNumber(v string)` + +SetSerialNumber sets SerialNumber field to given value. + +### HasSerialNumber + +`func (o *Server) HasSerialNumber() bool` + +HasSerialNumber returns a boolean if a field has been set. + +### GetSpecs + +`func (o *Server) GetSpecs() ServerSpecs` + +GetSpecs returns the Specs field if non-nil, zero value otherwise. + +### GetSpecsOk + +`func (o *Server) GetSpecsOk() (*ServerSpecs, bool)` + +GetSpecsOk returns a tuple with the Specs field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSpecs + +`func (o *Server) SetSpecs(v ServerSpecs)` + +SetSpecs sets Specs field to given value. + +### HasSpecs + +`func (o *Server) HasSpecs() bool` + +HasSpecs returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/dedicatedserver/docs/ServerSpecs.md b/dedicatedserver/docs/ServerSpecs.md new file mode 100644 index 0000000..8987f37 --- /dev/null +++ b/dedicatedserver/docs/ServerSpecs.md @@ -0,0 +1,186 @@ +# ServerSpecs + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Chassis** | Pointer to **string** | The chassis description of the server | [optional] +**Cpu** | Pointer to [**Cpu**](Cpu.md) | | [optional] +**HardwareRaidCapable** | Pointer to **bool** | Hardware RAID capability of the server | [optional] +**Hdd** | Pointer to [**[]Hdd**](Hdd.md) | List of hard disk drives of the server | [optional] +**PciCards** | Pointer to [**[]PciCard**](PciCard.md) | List of PCI cards of the server | [optional] +**Ram** | Pointer to [**Ram**](Ram.md) | | [optional] + +## Methods + +### NewServerSpecs + +`func NewServerSpecs() *ServerSpecs` + +NewServerSpecs instantiates a new ServerSpecs object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewServerSpecsWithDefaults + +`func NewServerSpecsWithDefaults() *ServerSpecs` + +NewServerSpecsWithDefaults instantiates a new ServerSpecs object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetChassis + +`func (o *ServerSpecs) GetChassis() string` + +GetChassis returns the Chassis field if non-nil, zero value otherwise. + +### GetChassisOk + +`func (o *ServerSpecs) GetChassisOk() (*string, bool)` + +GetChassisOk returns a tuple with the Chassis field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetChassis + +`func (o *ServerSpecs) SetChassis(v string)` + +SetChassis sets Chassis field to given value. + +### HasChassis + +`func (o *ServerSpecs) HasChassis() bool` + +HasChassis returns a boolean if a field has been set. + +### GetCpu + +`func (o *ServerSpecs) GetCpu() Cpu` + +GetCpu returns the Cpu field if non-nil, zero value otherwise. + +### GetCpuOk + +`func (o *ServerSpecs) GetCpuOk() (*Cpu, bool)` + +GetCpuOk returns a tuple with the Cpu field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCpu + +`func (o *ServerSpecs) SetCpu(v Cpu)` + +SetCpu sets Cpu field to given value. + +### HasCpu + +`func (o *ServerSpecs) HasCpu() bool` + +HasCpu returns a boolean if a field has been set. + +### GetHardwareRaidCapable + +`func (o *ServerSpecs) GetHardwareRaidCapable() bool` + +GetHardwareRaidCapable returns the HardwareRaidCapable field if non-nil, zero value otherwise. + +### GetHardwareRaidCapableOk + +`func (o *ServerSpecs) GetHardwareRaidCapableOk() (*bool, bool)` + +GetHardwareRaidCapableOk returns a tuple with the HardwareRaidCapable field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHardwareRaidCapable + +`func (o *ServerSpecs) SetHardwareRaidCapable(v bool)` + +SetHardwareRaidCapable sets HardwareRaidCapable field to given value. + +### HasHardwareRaidCapable + +`func (o *ServerSpecs) HasHardwareRaidCapable() bool` + +HasHardwareRaidCapable returns a boolean if a field has been set. + +### GetHdd + +`func (o *ServerSpecs) GetHdd() []Hdd` + +GetHdd returns the Hdd field if non-nil, zero value otherwise. + +### GetHddOk + +`func (o *ServerSpecs) GetHddOk() (*[]Hdd, bool)` + +GetHddOk returns a tuple with the Hdd field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHdd + +`func (o *ServerSpecs) SetHdd(v []Hdd)` + +SetHdd sets Hdd field to given value. + +### HasHdd + +`func (o *ServerSpecs) HasHdd() bool` + +HasHdd returns a boolean if a field has been set. + +### GetPciCards + +`func (o *ServerSpecs) GetPciCards() []PciCard` + +GetPciCards returns the PciCards field if non-nil, zero value otherwise. + +### GetPciCardsOk + +`func (o *ServerSpecs) GetPciCardsOk() (*[]PciCard, bool)` + +GetPciCardsOk returns a tuple with the PciCards field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPciCards + +`func (o *ServerSpecs) SetPciCards(v []PciCard)` + +SetPciCards sets PciCards field to given value. + +### HasPciCards + +`func (o *ServerSpecs) HasPciCards() bool` + +HasPciCards returns a boolean if a field has been set. + +### GetRam + +`func (o *ServerSpecs) GetRam() Ram` + +GetRam returns the Ram field if non-nil, zero value otherwise. + +### GetRamOk + +`func (o *ServerSpecs) GetRamOk() (*Ram, bool)` + +GetRamOk returns a tuple with the Ram field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRam + +`func (o *ServerSpecs) SetRam(v Ram)` + +SetRam sets Ram field to given value. + +### HasRam + +`func (o *ServerSpecs) HasRam() bool` + +HasRam returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/dedicatedserver/docs/UpdateIpProfileOpts.md b/dedicatedserver/docs/UpdateIpProfileOpts.md new file mode 100644 index 0000000..909e77b --- /dev/null +++ b/dedicatedserver/docs/UpdateIpProfileOpts.md @@ -0,0 +1,82 @@ +# UpdateIpProfileOpts + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DetectionProfile** | Pointer to **string** | The detection profile value | [optional] +**ReverseLookup** | Pointer to **string** | The reverse lookup value | [optional] + +## Methods + +### NewUpdateIpProfileOpts + +`func NewUpdateIpProfileOpts() *UpdateIpProfileOpts` + +NewUpdateIpProfileOpts instantiates a new UpdateIpProfileOpts object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUpdateIpProfileOptsWithDefaults + +`func NewUpdateIpProfileOptsWithDefaults() *UpdateIpProfileOpts` + +NewUpdateIpProfileOptsWithDefaults instantiates a new UpdateIpProfileOpts object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDetectionProfile + +`func (o *UpdateIpProfileOpts) GetDetectionProfile() string` + +GetDetectionProfile returns the DetectionProfile field if non-nil, zero value otherwise. + +### GetDetectionProfileOk + +`func (o *UpdateIpProfileOpts) GetDetectionProfileOk() (*string, bool)` + +GetDetectionProfileOk returns a tuple with the DetectionProfile field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetectionProfile + +`func (o *UpdateIpProfileOpts) SetDetectionProfile(v string)` + +SetDetectionProfile sets DetectionProfile field to given value. + +### HasDetectionProfile + +`func (o *UpdateIpProfileOpts) HasDetectionProfile() bool` + +HasDetectionProfile returns a boolean if a field has been set. + +### GetReverseLookup + +`func (o *UpdateIpProfileOpts) GetReverseLookup() string` + +GetReverseLookup returns the ReverseLookup field if non-nil, zero value otherwise. + +### GetReverseLookupOk + +`func (o *UpdateIpProfileOpts) GetReverseLookupOk() (*string, bool)` + +GetReverseLookupOk returns a tuple with the ReverseLookup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReverseLookup + +`func (o *UpdateIpProfileOpts) SetReverseLookup(v string)` + +SetReverseLookup sets ReverseLookup field to given value. + +### HasReverseLookup + +`func (o *UpdateIpProfileOpts) HasReverseLookup() bool` + +HasReverseLookup returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/dedicatedserver/docs/UpdateNetworkEquipmentIpOpts.md b/dedicatedserver/docs/UpdateNetworkEquipmentIpOpts.md new file mode 100644 index 0000000..0983d63 --- /dev/null +++ b/dedicatedserver/docs/UpdateNetworkEquipmentIpOpts.md @@ -0,0 +1,82 @@ +# UpdateNetworkEquipmentIpOpts + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DetectionProfile** | Pointer to **string** | The detection profile value | [optional] +**ReverseLookup** | Pointer to **string** | The reverse lookup value | [optional] + +## Methods + +### NewUpdateNetworkEquipmentIpOpts + +`func NewUpdateNetworkEquipmentIpOpts() *UpdateNetworkEquipmentIpOpts` + +NewUpdateNetworkEquipmentIpOpts instantiates a new UpdateNetworkEquipmentIpOpts object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUpdateNetworkEquipmentIpOptsWithDefaults + +`func NewUpdateNetworkEquipmentIpOptsWithDefaults() *UpdateNetworkEquipmentIpOpts` + +NewUpdateNetworkEquipmentIpOptsWithDefaults instantiates a new UpdateNetworkEquipmentIpOpts object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDetectionProfile + +`func (o *UpdateNetworkEquipmentIpOpts) GetDetectionProfile() string` + +GetDetectionProfile returns the DetectionProfile field if non-nil, zero value otherwise. + +### GetDetectionProfileOk + +`func (o *UpdateNetworkEquipmentIpOpts) GetDetectionProfileOk() (*string, bool)` + +GetDetectionProfileOk returns a tuple with the DetectionProfile field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetectionProfile + +`func (o *UpdateNetworkEquipmentIpOpts) SetDetectionProfile(v string)` + +SetDetectionProfile sets DetectionProfile field to given value. + +### HasDetectionProfile + +`func (o *UpdateNetworkEquipmentIpOpts) HasDetectionProfile() bool` + +HasDetectionProfile returns a boolean if a field has been set. + +### GetReverseLookup + +`func (o *UpdateNetworkEquipmentIpOpts) GetReverseLookup() string` + +GetReverseLookup returns the ReverseLookup field if non-nil, zero value otherwise. + +### GetReverseLookupOk + +`func (o *UpdateNetworkEquipmentIpOpts) GetReverseLookupOk() (*string, bool)` + +GetReverseLookupOk returns a tuple with the ReverseLookup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReverseLookup + +`func (o *UpdateNetworkEquipmentIpOpts) SetReverseLookup(v string)` + +SetReverseLookup sets ReverseLookup field to given value. + +### HasReverseLookup + +`func (o *UpdateNetworkEquipmentIpOpts) HasReverseLookup() bool` + +HasReverseLookup returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/dedicatedserver/docs/UpdateNetworkEquipmentReferenceOpts.md b/dedicatedserver/docs/UpdateNetworkEquipmentReferenceOpts.md new file mode 100644 index 0000000..60f9b8a --- /dev/null +++ b/dedicatedserver/docs/UpdateNetworkEquipmentReferenceOpts.md @@ -0,0 +1,51 @@ +# UpdateNetworkEquipmentReferenceOpts + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Reference** | **string** | The reference for this network equipment | + +## Methods + +### NewUpdateNetworkEquipmentReferenceOpts + +`func NewUpdateNetworkEquipmentReferenceOpts(reference string, ) *UpdateNetworkEquipmentReferenceOpts` + +NewUpdateNetworkEquipmentReferenceOpts instantiates a new UpdateNetworkEquipmentReferenceOpts object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUpdateNetworkEquipmentReferenceOptsWithDefaults + +`func NewUpdateNetworkEquipmentReferenceOptsWithDefaults() *UpdateNetworkEquipmentReferenceOpts` + +NewUpdateNetworkEquipmentReferenceOptsWithDefaults instantiates a new UpdateNetworkEquipmentReferenceOpts object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetReference + +`func (o *UpdateNetworkEquipmentReferenceOpts) GetReference() string` + +GetReference returns the Reference field if non-nil, zero value otherwise. + +### GetReferenceOk + +`func (o *UpdateNetworkEquipmentReferenceOpts) GetReferenceOk() (*string, bool)` + +GetReferenceOk returns a tuple with the Reference field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReference + +`func (o *UpdateNetworkEquipmentReferenceOpts) SetReference(v string)` + +SetReference sets Reference field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/dedicatedserver/docs/UpdateServerReferenceOpts.md b/dedicatedserver/docs/UpdateServerReferenceOpts.md new file mode 100644 index 0000000..f3f5bb1 --- /dev/null +++ b/dedicatedserver/docs/UpdateServerReferenceOpts.md @@ -0,0 +1,51 @@ +# UpdateServerReferenceOpts + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Reference** | **string** | The reference for this server | + +## Methods + +### NewUpdateServerReferenceOpts + +`func NewUpdateServerReferenceOpts(reference string, ) *UpdateServerReferenceOpts` + +NewUpdateServerReferenceOpts instantiates a new UpdateServerReferenceOpts object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUpdateServerReferenceOptsWithDefaults + +`func NewUpdateServerReferenceOptsWithDefaults() *UpdateServerReferenceOpts` + +NewUpdateServerReferenceOptsWithDefaults instantiates a new UpdateServerReferenceOpts object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetReference + +`func (o *UpdateServerReferenceOpts) GetReference() string` + +GetReference returns the Reference field if non-nil, zero value otherwise. + +### GetReferenceOk + +`func (o *UpdateServerReferenceOpts) GetReferenceOk() (*string, bool)` + +GetReferenceOk returns a tuple with the Reference field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReference + +`func (o *UpdateServerReferenceOpts) SetReference(v string)` + +SetReference sets Reference field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/nse/docs/ErrorResult.md b/nse/docs/ErrorResult.md new file mode 100644 index 0000000..af3c285 --- /dev/null +++ b/nse/docs/ErrorResult.md @@ -0,0 +1,134 @@ +# ErrorResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CorrelationId** | Pointer to **string** | The correlation ID of the current request. | [optional] +**ErrorCode** | Pointer to **string** | The error code. | [optional] +**ErrorMessage** | Pointer to **string** | A human friendly description of the error. | [optional] +**ErrorDetails** | Pointer to [**[]map[string][]string**](map[string][]string.md) | | [optional] + +## Methods + +### NewErrorResult + +`func NewErrorResult() *ErrorResult` + +NewErrorResult instantiates a new ErrorResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewErrorResultWithDefaults + +`func NewErrorResultWithDefaults() *ErrorResult` + +NewErrorResultWithDefaults instantiates a new ErrorResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCorrelationId + +`func (o *ErrorResult) GetCorrelationId() string` + +GetCorrelationId returns the CorrelationId field if non-nil, zero value otherwise. + +### GetCorrelationIdOk + +`func (o *ErrorResult) GetCorrelationIdOk() (*string, bool)` + +GetCorrelationIdOk returns a tuple with the CorrelationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelationId + +`func (o *ErrorResult) SetCorrelationId(v string)` + +SetCorrelationId sets CorrelationId field to given value. + +### HasCorrelationId + +`func (o *ErrorResult) HasCorrelationId() bool` + +HasCorrelationId returns a boolean if a field has been set. + +### GetErrorCode + +`func (o *ErrorResult) GetErrorCode() string` + +GetErrorCode returns the ErrorCode field if non-nil, zero value otherwise. + +### GetErrorCodeOk + +`func (o *ErrorResult) GetErrorCodeOk() (*string, bool)` + +GetErrorCodeOk returns a tuple with the ErrorCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorCode + +`func (o *ErrorResult) SetErrorCode(v string)` + +SetErrorCode sets ErrorCode field to given value. + +### HasErrorCode + +`func (o *ErrorResult) HasErrorCode() bool` + +HasErrorCode returns a boolean if a field has been set. + +### GetErrorMessage + +`func (o *ErrorResult) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *ErrorResult) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *ErrorResult) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *ErrorResult) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### GetErrorDetails + +`func (o *ErrorResult) GetErrorDetails() []map[string][]string` + +GetErrorDetails returns the ErrorDetails field if non-nil, zero value otherwise. + +### GetErrorDetailsOk + +`func (o *ErrorResult) GetErrorDetailsOk() (*[]map[string][]string, bool)` + +GetErrorDetailsOk returns a tuple with the ErrorDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorDetails + +`func (o *ErrorResult) SetErrorDetails(v []map[string][]string)` + +SetErrorDetails sets ErrorDetails field to given value. + +### HasErrorDetails + +`func (o *ErrorResult) HasErrorDetails() bool` + +HasErrorDetails returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/nse/docs/GetDdosNotificationSettingResult.md b/nse/docs/GetDdosNotificationSettingResult.md new file mode 100644 index 0000000..93a9179 --- /dev/null +++ b/nse/docs/GetDdosNotificationSettingResult.md @@ -0,0 +1,82 @@ +# GetDdosNotificationSettingResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Nulling** | Pointer to **string** | Email notifications for nulling events | [optional] +**Scrubbing** | Pointer to **string** | Email notifications for scrubbing events | [optional] + +## Methods + +### NewGetDdosNotificationSettingResult + +`func NewGetDdosNotificationSettingResult() *GetDdosNotificationSettingResult` + +NewGetDdosNotificationSettingResult instantiates a new GetDdosNotificationSettingResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetDdosNotificationSettingResultWithDefaults + +`func NewGetDdosNotificationSettingResultWithDefaults() *GetDdosNotificationSettingResult` + +NewGetDdosNotificationSettingResultWithDefaults instantiates a new GetDdosNotificationSettingResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetNulling + +`func (o *GetDdosNotificationSettingResult) GetNulling() string` + +GetNulling returns the Nulling field if non-nil, zero value otherwise. + +### GetNullingOk + +`func (o *GetDdosNotificationSettingResult) GetNullingOk() (*string, bool)` + +GetNullingOk returns a tuple with the Nulling field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNulling + +`func (o *GetDdosNotificationSettingResult) SetNulling(v string)` + +SetNulling sets Nulling field to given value. + +### HasNulling + +`func (o *GetDdosNotificationSettingResult) HasNulling() bool` + +HasNulling returns a boolean if a field has been set. + +### GetScrubbing + +`func (o *GetDdosNotificationSettingResult) GetScrubbing() string` + +GetScrubbing returns the Scrubbing field if non-nil, zero value otherwise. + +### GetScrubbingOk + +`func (o *GetDdosNotificationSettingResult) GetScrubbingOk() (*string, bool)` + +GetScrubbingOk returns a tuple with the Scrubbing field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScrubbing + +`func (o *GetDdosNotificationSettingResult) SetScrubbing(v string)` + +SetScrubbing sets Scrubbing field to given value. + +### HasScrubbing + +`func (o *GetDdosNotificationSettingResult) HasScrubbing() bool` + +HasScrubbing returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/nse/docs/GetNetworkInterfaceListResult.md b/nse/docs/GetNetworkInterfaceListResult.md new file mode 100644 index 0000000..e902ce1 --- /dev/null +++ b/nse/docs/GetNetworkInterfaceListResult.md @@ -0,0 +1,82 @@ +# GetNetworkInterfaceListResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Metadata** | Pointer to [**Metadata**](Metadata.md) | | [optional] +**NetworkInterfaces** | Pointer to [**[]NetworkInterface**](NetworkInterface.md) | An array of network interfaces | [optional] + +## Methods + +### NewGetNetworkInterfaceListResult + +`func NewGetNetworkInterfaceListResult() *GetNetworkInterfaceListResult` + +NewGetNetworkInterfaceListResult instantiates a new GetNetworkInterfaceListResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetNetworkInterfaceListResultWithDefaults + +`func NewGetNetworkInterfaceListResultWithDefaults() *GetNetworkInterfaceListResult` + +NewGetNetworkInterfaceListResultWithDefaults instantiates a new GetNetworkInterfaceListResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMetadata + +`func (o *GetNetworkInterfaceListResult) GetMetadata() Metadata` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *GetNetworkInterfaceListResult) GetMetadataOk() (*Metadata, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *GetNetworkInterfaceListResult) SetMetadata(v Metadata)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *GetNetworkInterfaceListResult) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + +### GetNetworkInterfaces + +`func (o *GetNetworkInterfaceListResult) GetNetworkInterfaces() []NetworkInterface` + +GetNetworkInterfaces returns the NetworkInterfaces field if non-nil, zero value otherwise. + +### GetNetworkInterfacesOk + +`func (o *GetNetworkInterfaceListResult) GetNetworkInterfacesOk() (*[]NetworkInterface, bool)` + +GetNetworkInterfacesOk returns a tuple with the NetworkInterfaces field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNetworkInterfaces + +`func (o *GetNetworkInterfaceListResult) SetNetworkInterfaces(v []NetworkInterface)` + +SetNetworkInterfaces sets NetworkInterfaces field to given value. + +### HasNetworkInterfaces + +`func (o *GetNetworkInterfaceListResult) HasNetworkInterfaces() bool` + +HasNetworkInterfaces returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/nse/docs/Metadata.md b/nse/docs/Metadata.md new file mode 100644 index 0000000..194d6a7 --- /dev/null +++ b/nse/docs/Metadata.md @@ -0,0 +1,108 @@ +# Metadata + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TotalCount** | Pointer to **float32** | Total amount of orders in this collection | [optional] +**Offset** | Pointer to **float32** | The offset used to generate this response | [optional] [default to 0] +**Limit** | Pointer to **float32** | The limit used to generate this response | [optional] [default to 5] + +## Methods + +### NewMetadata + +`func NewMetadata() *Metadata` + +NewMetadata instantiates a new Metadata object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewMetadataWithDefaults + +`func NewMetadataWithDefaults() *Metadata` + +NewMetadataWithDefaults instantiates a new Metadata object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetTotalCount + +`func (o *Metadata) GetTotalCount() float32` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *Metadata) GetTotalCountOk() (*float32, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *Metadata) SetTotalCount(v float32)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *Metadata) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + +### GetOffset + +`func (o *Metadata) GetOffset() float32` + +GetOffset returns the Offset field if non-nil, zero value otherwise. + +### GetOffsetOk + +`func (o *Metadata) GetOffsetOk() (*float32, bool)` + +GetOffsetOk returns a tuple with the Offset field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOffset + +`func (o *Metadata) SetOffset(v float32)` + +SetOffset sets Offset field to given value. + +### HasOffset + +`func (o *Metadata) HasOffset() bool` + +HasOffset returns a boolean if a field has been set. + +### GetLimit + +`func (o *Metadata) GetLimit() float32` + +GetLimit returns the Limit field if non-nil, zero value otherwise. + +### GetLimitOk + +`func (o *Metadata) GetLimitOk() (*float32, bool)` + +GetLimitOk returns a tuple with the Limit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLimit + +`func (o *Metadata) SetLimit(v float32)` + +SetLimit sets Limit field to given value. + +### HasLimit + +`func (o *Metadata) HasLimit() bool` + +HasLimit returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/nse/docs/NetworkInterface.md b/nse/docs/NetworkInterface.md new file mode 100644 index 0000000..88f0b12 --- /dev/null +++ b/nse/docs/NetworkInterface.md @@ -0,0 +1,186 @@ +# NetworkInterface + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LinkSpeed** | Pointer to **string** | The link speed | [optional] +**OperStatus** | Pointer to **string** | The operational status | [optional] +**Status** | Pointer to **string** | The administrative status | [optional] +**SwitchInterface** | Pointer to **string** | The switch port number | [optional] +**SwitchName** | Pointer to **string** | The switch name | [optional] +**Type** | Pointer to **string** | The network type | [optional] + +## Methods + +### NewNetworkInterface + +`func NewNetworkInterface() *NetworkInterface` + +NewNetworkInterface instantiates a new NetworkInterface object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewNetworkInterfaceWithDefaults + +`func NewNetworkInterfaceWithDefaults() *NetworkInterface` + +NewNetworkInterfaceWithDefaults instantiates a new NetworkInterface object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLinkSpeed + +`func (o *NetworkInterface) GetLinkSpeed() string` + +GetLinkSpeed returns the LinkSpeed field if non-nil, zero value otherwise. + +### GetLinkSpeedOk + +`func (o *NetworkInterface) GetLinkSpeedOk() (*string, bool)` + +GetLinkSpeedOk returns a tuple with the LinkSpeed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLinkSpeed + +`func (o *NetworkInterface) SetLinkSpeed(v string)` + +SetLinkSpeed sets LinkSpeed field to given value. + +### HasLinkSpeed + +`func (o *NetworkInterface) HasLinkSpeed() bool` + +HasLinkSpeed returns a boolean if a field has been set. + +### GetOperStatus + +`func (o *NetworkInterface) GetOperStatus() string` + +GetOperStatus returns the OperStatus field if non-nil, zero value otherwise. + +### GetOperStatusOk + +`func (o *NetworkInterface) GetOperStatusOk() (*string, bool)` + +GetOperStatusOk returns a tuple with the OperStatus field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperStatus + +`func (o *NetworkInterface) SetOperStatus(v string)` + +SetOperStatus sets OperStatus field to given value. + +### HasOperStatus + +`func (o *NetworkInterface) HasOperStatus() bool` + +HasOperStatus returns a boolean if a field has been set. + +### GetStatus + +`func (o *NetworkInterface) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *NetworkInterface) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *NetworkInterface) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *NetworkInterface) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetSwitchInterface + +`func (o *NetworkInterface) GetSwitchInterface() string` + +GetSwitchInterface returns the SwitchInterface field if non-nil, zero value otherwise. + +### GetSwitchInterfaceOk + +`func (o *NetworkInterface) GetSwitchInterfaceOk() (*string, bool)` + +GetSwitchInterfaceOk returns a tuple with the SwitchInterface field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSwitchInterface + +`func (o *NetworkInterface) SetSwitchInterface(v string)` + +SetSwitchInterface sets SwitchInterface field to given value. + +### HasSwitchInterface + +`func (o *NetworkInterface) HasSwitchInterface() bool` + +HasSwitchInterface returns a boolean if a field has been set. + +### GetSwitchName + +`func (o *NetworkInterface) GetSwitchName() string` + +GetSwitchName returns the SwitchName field if non-nil, zero value otherwise. + +### GetSwitchNameOk + +`func (o *NetworkInterface) GetSwitchNameOk() (*string, bool)` + +GetSwitchNameOk returns a tuple with the SwitchName field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSwitchName + +`func (o *NetworkInterface) SetSwitchName(v string)` + +SetSwitchName sets SwitchName field to given value. + +### HasSwitchName + +`func (o *NetworkInterface) HasSwitchName() bool` + +HasSwitchName returns a boolean if a field has been set. + +### GetType + +`func (o *NetworkInterface) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *NetworkInterface) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *NetworkInterface) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *NetworkInterface) HasType() bool` + +HasType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/nse/docs/NseAPI.md b/nse/docs/NseAPI.md new file mode 100644 index 0000000..a95825a --- /dev/null +++ b/nse/docs/NseAPI.md @@ -0,0 +1,644 @@ +# \NseAPI + +All URIs are relative to *https://api.leaseweb.com/internal/nseapi/v2* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CloseNetworkInterface**](NseAPI.md#CloseNetworkInterface) | **Post** /servers/{serverId}/networkInterfaces/{networkType}/close | Close network interface +[**CloseNetworkInterfaces**](NseAPI.md#CloseNetworkInterfaces) | **Post** /servers/{serverId}/networkInterfaces/close | Close all network interfaces +[**GetDdosNotificationSettingList**](NseAPI.md#GetDdosNotificationSettingList) | **Get** /servers/{serverId}/notificationSettings/ddos | Inspect DDoS notification settings +[**GetNetworkInterface**](NseAPI.md#GetNetworkInterface) | **Get** /servers/{serverId}/networkInterfaces/{networkType} | Show a network interface +[**GetNetworkInterfaceList**](NseAPI.md#GetNetworkInterfaceList) | **Get** /servers/{serverId}/networkInterfaces | List network interfaces +[**OpenNetworkInterface**](NseAPI.md#OpenNetworkInterface) | **Post** /servers/{serverId}/networkInterfaces/{networkType}/open | Open network interface +[**OpenNetworkInterfaces**](NseAPI.md#OpenNetworkInterfaces) | **Post** /servers/{serverId}/networkInterfaces/open | Open all network interfaces +[**UpdateNullRoute**](NseAPI.md#UpdateNullRoute) | **Post** /actions/nullRoute | Announce/Withdraw Null Routes +[**UpdateServerDdosNotificationSetting**](NseAPI.md#UpdateServerDdosNotificationSetting) | **Put** /servers/{serverId}/notificationSettings/ddos | Update DDoS notification settings + + + +## CloseNetworkInterface + +> CloseNetworkInterface(ctx, serverId, networkType).Execute() + +Close network interface + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/nse" +) + +func main() { + serverId := "12345" // string | The ID of a server + networkType := "public" // string | The network type + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.NseAPI.CloseNetworkInterface(context.Background(), serverId, networkType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NseAPI.CloseNetworkInterface``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | +**networkType** | **string** | The network type | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCloseNetworkInterfaceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## CloseNetworkInterfaces + +> CloseNetworkInterfaces(ctx, serverId).Execute() + +Close all network interfaces + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/nse" +) + +func main() { + serverId := "12345" // string | The ID of a server + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.NseAPI.CloseNetworkInterfaces(context.Background(), serverId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NseAPI.CloseNetworkInterfaces``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCloseNetworkInterfacesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetDdosNotificationSettingList + +> GetDdosNotificationSettingResult GetDdosNotificationSettingList(ctx, serverId).Execute() + +Inspect DDoS notification settings + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/nse" +) + +func main() { + serverId := "12345" // string | The ID of a server + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.NseAPI.GetDdosNotificationSettingList(context.Background(), serverId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NseAPI.GetDdosNotificationSettingList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetDdosNotificationSettingList`: GetDdosNotificationSettingResult + fmt.Fprintf(os.Stdout, "Response from `NseAPI.GetDdosNotificationSettingList`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetDdosNotificationSettingListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**GetDdosNotificationSettingResult**](GetDdosNotificationSettingResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetNetworkInterface + +> NetworkInterface GetNetworkInterface(ctx, serverId, networkType).Execute() + +Show a network interface + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/nse" +) + +func main() { + serverId := "12345" // string | The ID of a server + networkType := "public" // string | The network type + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.NseAPI.GetNetworkInterface(context.Background(), serverId, networkType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NseAPI.GetNetworkInterface``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNetworkInterface`: NetworkInterface + fmt.Fprintf(os.Stdout, "Response from `NseAPI.GetNetworkInterface`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | +**networkType** | **string** | The network type | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNetworkInterfaceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**NetworkInterface**](NetworkInterface.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetNetworkInterfaceList + +> GetNetworkInterfaceListResult GetNetworkInterfaceList(ctx, serverId).Execute() + +List network interfaces + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/nse" +) + +func main() { + serverId := "12345" // string | The ID of a server + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.NseAPI.GetNetworkInterfaceList(context.Background(), serverId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NseAPI.GetNetworkInterfaceList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetNetworkInterfaceList`: GetNetworkInterfaceListResult + fmt.Fprintf(os.Stdout, "Response from `NseAPI.GetNetworkInterfaceList`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetNetworkInterfaceListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**GetNetworkInterfaceListResult**](GetNetworkInterfaceListResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## OpenNetworkInterface + +> OpenNetworkInterface(ctx, serverId, networkType).Execute() + +Open network interface + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/nse" +) + +func main() { + serverId := "12345" // string | The ID of a server + networkType := "public" // string | The network type + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.NseAPI.OpenNetworkInterface(context.Background(), serverId, networkType).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NseAPI.OpenNetworkInterface``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | +**networkType** | **string** | The network type | + +### Other Parameters + +Other parameters are passed through a pointer to a apiOpenNetworkInterfaceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + + (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## OpenNetworkInterfaces + +> OpenNetworkInterfaces(ctx, serverId).Execute() + +Open all network interfaces + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/nse" +) + +func main() { + serverId := "12345" // string | The ID of a server + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.NseAPI.OpenNetworkInterfaces(context.Background(), serverId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NseAPI.OpenNetworkInterfaces``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiOpenNetworkInterfacesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateNullRoute + +> UpdateNullRouteAcceptedResult UpdateNullRoute(ctx).UpdateNullRouteOpts(updateNullRouteOpts).Execute() + +Announce/Withdraw Null Routes + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/nse" +) + +func main() { + updateNullRouteOpts := *openapiclient.NewUpdateNullRouteOpts("WITHDRAW", "IpAddress_example") // UpdateNullRouteOpts | (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.NseAPI.UpdateNullRoute(context.Background()).UpdateNullRouteOpts(updateNullRouteOpts).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NseAPI.UpdateNullRoute``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateNullRoute`: UpdateNullRouteAcceptedResult + fmt.Fprintf(os.Stdout, "Response from `NseAPI.UpdateNullRoute`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateNullRouteRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **updateNullRouteOpts** | [**UpdateNullRouteOpts**](UpdateNullRouteOpts.md) | | + +### Return type + +[**UpdateNullRouteAcceptedResult**](UpdateNullRouteAcceptedResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateServerDdosNotificationSetting + +> UpdateServerDdosNotificationSetting(ctx, serverId).UpdateDdosNotificationSettingOpts(updateDdosNotificationSettingOpts).Execute() + +Update DDoS notification settings + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/nse" +) + +func main() { + serverId := "12345" // string | The ID of a server + updateDdosNotificationSettingOpts := *openapiclient.NewUpdateDdosNotificationSettingOpts() // UpdateDdosNotificationSettingOpts | (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.NseAPI.UpdateServerDdosNotificationSetting(context.Background(), serverId).UpdateDdosNotificationSettingOpts(updateDdosNotificationSettingOpts).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `NseAPI.UpdateServerDdosNotificationSetting``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**serverId** | **string** | The ID of a server | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateServerDdosNotificationSettingRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **updateDdosNotificationSettingOpts** | [**UpdateDdosNotificationSettingOpts**](UpdateDdosNotificationSettingOpts.md) | | + +### Return type + + (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/nse/docs/UpdateDdosNotificationSettingOpts.md b/nse/docs/UpdateDdosNotificationSettingOpts.md new file mode 100644 index 0000000..a0241bb --- /dev/null +++ b/nse/docs/UpdateDdosNotificationSettingOpts.md @@ -0,0 +1,82 @@ +# UpdateDdosNotificationSettingOpts + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Nulling** | Pointer to **string** | Enable or disable email notifications for nulling events | [optional] +**Scrubbing** | Pointer to **string** | Enable or disable email notifications for nulling events | [optional] + +## Methods + +### NewUpdateDdosNotificationSettingOpts + +`func NewUpdateDdosNotificationSettingOpts() *UpdateDdosNotificationSettingOpts` + +NewUpdateDdosNotificationSettingOpts instantiates a new UpdateDdosNotificationSettingOpts object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUpdateDdosNotificationSettingOptsWithDefaults + +`func NewUpdateDdosNotificationSettingOptsWithDefaults() *UpdateDdosNotificationSettingOpts` + +NewUpdateDdosNotificationSettingOptsWithDefaults instantiates a new UpdateDdosNotificationSettingOpts object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetNulling + +`func (o *UpdateDdosNotificationSettingOpts) GetNulling() string` + +GetNulling returns the Nulling field if non-nil, zero value otherwise. + +### GetNullingOk + +`func (o *UpdateDdosNotificationSettingOpts) GetNullingOk() (*string, bool)` + +GetNullingOk returns a tuple with the Nulling field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNulling + +`func (o *UpdateDdosNotificationSettingOpts) SetNulling(v string)` + +SetNulling sets Nulling field to given value. + +### HasNulling + +`func (o *UpdateDdosNotificationSettingOpts) HasNulling() bool` + +HasNulling returns a boolean if a field has been set. + +### GetScrubbing + +`func (o *UpdateDdosNotificationSettingOpts) GetScrubbing() string` + +GetScrubbing returns the Scrubbing field if non-nil, zero value otherwise. + +### GetScrubbingOk + +`func (o *UpdateDdosNotificationSettingOpts) GetScrubbingOk() (*string, bool)` + +GetScrubbingOk returns a tuple with the Scrubbing field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetScrubbing + +`func (o *UpdateDdosNotificationSettingOpts) SetScrubbing(v string)` + +SetScrubbing sets Scrubbing field to given value. + +### HasScrubbing + +`func (o *UpdateDdosNotificationSettingOpts) HasScrubbing() bool` + +HasScrubbing returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/nse/docs/UpdateNullRouteAcceptedResult.md b/nse/docs/UpdateNullRouteAcceptedResult.md new file mode 100644 index 0000000..934d129 --- /dev/null +++ b/nse/docs/UpdateNullRouteAcceptedResult.md @@ -0,0 +1,56 @@ +# UpdateNullRouteAcceptedResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to **string** | A human friendly message describing the action that will be taken | [optional] + +## Methods + +### NewUpdateNullRouteAcceptedResult + +`func NewUpdateNullRouteAcceptedResult() *UpdateNullRouteAcceptedResult` + +NewUpdateNullRouteAcceptedResult instantiates a new UpdateNullRouteAcceptedResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUpdateNullRouteAcceptedResultWithDefaults + +`func NewUpdateNullRouteAcceptedResultWithDefaults() *UpdateNullRouteAcceptedResult` + +NewUpdateNullRouteAcceptedResultWithDefaults instantiates a new UpdateNullRouteAcceptedResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMessage + +`func (o *UpdateNullRouteAcceptedResult) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *UpdateNullRouteAcceptedResult) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *UpdateNullRouteAcceptedResult) SetMessage(v string)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *UpdateNullRouteAcceptedResult) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/nse/docs/UpdateNullRouteBadRequestResult.md b/nse/docs/UpdateNullRouteBadRequestResult.md new file mode 100644 index 0000000..403822d --- /dev/null +++ b/nse/docs/UpdateNullRouteBadRequestResult.md @@ -0,0 +1,134 @@ +# UpdateNullRouteBadRequestResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CorrelationId** | Pointer to **string** | The correlation ID of the current request. | [optional] +**ErrorCode** | Pointer to **string** | The error code. | [optional] +**ErrorDetails** | Pointer to **map[string]interface{}** | An object describing the errors for the current request. | [optional] +**ErrorMessage** | Pointer to **string** | A human friendly description of the error. | [optional] + +## Methods + +### NewUpdateNullRouteBadRequestResult + +`func NewUpdateNullRouteBadRequestResult() *UpdateNullRouteBadRequestResult` + +NewUpdateNullRouteBadRequestResult instantiates a new UpdateNullRouteBadRequestResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUpdateNullRouteBadRequestResultWithDefaults + +`func NewUpdateNullRouteBadRequestResultWithDefaults() *UpdateNullRouteBadRequestResult` + +NewUpdateNullRouteBadRequestResultWithDefaults instantiates a new UpdateNullRouteBadRequestResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCorrelationId + +`func (o *UpdateNullRouteBadRequestResult) GetCorrelationId() string` + +GetCorrelationId returns the CorrelationId field if non-nil, zero value otherwise. + +### GetCorrelationIdOk + +`func (o *UpdateNullRouteBadRequestResult) GetCorrelationIdOk() (*string, bool)` + +GetCorrelationIdOk returns a tuple with the CorrelationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelationId + +`func (o *UpdateNullRouteBadRequestResult) SetCorrelationId(v string)` + +SetCorrelationId sets CorrelationId field to given value. + +### HasCorrelationId + +`func (o *UpdateNullRouteBadRequestResult) HasCorrelationId() bool` + +HasCorrelationId returns a boolean if a field has been set. + +### GetErrorCode + +`func (o *UpdateNullRouteBadRequestResult) GetErrorCode() string` + +GetErrorCode returns the ErrorCode field if non-nil, zero value otherwise. + +### GetErrorCodeOk + +`func (o *UpdateNullRouteBadRequestResult) GetErrorCodeOk() (*string, bool)` + +GetErrorCodeOk returns a tuple with the ErrorCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorCode + +`func (o *UpdateNullRouteBadRequestResult) SetErrorCode(v string)` + +SetErrorCode sets ErrorCode field to given value. + +### HasErrorCode + +`func (o *UpdateNullRouteBadRequestResult) HasErrorCode() bool` + +HasErrorCode returns a boolean if a field has been set. + +### GetErrorDetails + +`func (o *UpdateNullRouteBadRequestResult) GetErrorDetails() map[string]interface{}` + +GetErrorDetails returns the ErrorDetails field if non-nil, zero value otherwise. + +### GetErrorDetailsOk + +`func (o *UpdateNullRouteBadRequestResult) GetErrorDetailsOk() (*map[string]interface{}, bool)` + +GetErrorDetailsOk returns a tuple with the ErrorDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorDetails + +`func (o *UpdateNullRouteBadRequestResult) SetErrorDetails(v map[string]interface{})` + +SetErrorDetails sets ErrorDetails field to given value. + +### HasErrorDetails + +`func (o *UpdateNullRouteBadRequestResult) HasErrorDetails() bool` + +HasErrorDetails returns a boolean if a field has been set. + +### GetErrorMessage + +`func (o *UpdateNullRouteBadRequestResult) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *UpdateNullRouteBadRequestResult) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *UpdateNullRouteBadRequestResult) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *UpdateNullRouteBadRequestResult) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/nse/docs/UpdateNullRouteOpts.md b/nse/docs/UpdateNullRouteOpts.md new file mode 100644 index 0000000..8727922 --- /dev/null +++ b/nse/docs/UpdateNullRouteOpts.md @@ -0,0 +1,72 @@ +# UpdateNullRouteOpts + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Action** | **string** | The action to take | +**IpAddress** | **string** | The IP address for which to announce or withdraw the null route | + +## Methods + +### NewUpdateNullRouteOpts + +`func NewUpdateNullRouteOpts(action string, ipAddress string, ) *UpdateNullRouteOpts` + +NewUpdateNullRouteOpts instantiates a new UpdateNullRouteOpts object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUpdateNullRouteOptsWithDefaults + +`func NewUpdateNullRouteOptsWithDefaults() *UpdateNullRouteOpts` + +NewUpdateNullRouteOptsWithDefaults instantiates a new UpdateNullRouteOpts object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetAction + +`func (o *UpdateNullRouteOpts) GetAction() string` + +GetAction returns the Action field if non-nil, zero value otherwise. + +### GetActionOk + +`func (o *UpdateNullRouteOpts) GetActionOk() (*string, bool)` + +GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetAction + +`func (o *UpdateNullRouteOpts) SetAction(v string)` + +SetAction sets Action field to given value. + + +### GetIpAddress + +`func (o *UpdateNullRouteOpts) GetIpAddress() string` + +GetIpAddress returns the IpAddress field if non-nil, zero value otherwise. + +### GetIpAddressOk + +`func (o *UpdateNullRouteOpts) GetIpAddressOk() (*string, bool)` + +GetIpAddressOk returns a tuple with the IpAddress field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIpAddress + +`func (o *UpdateNullRouteOpts) SetIpAddress(v string)` + +SetIpAddress sets IpAddress field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/AttachIsoOpts.md b/publicCloud/docs/AttachIsoOpts.md new file mode 100644 index 0000000..fd8c326 --- /dev/null +++ b/publicCloud/docs/AttachIsoOpts.md @@ -0,0 +1,51 @@ +# AttachIsoOpts + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IsoId** | **string** | The ISO ID, obtained using the ISO endpoints | + +## Methods + +### NewAttachIsoOpts + +`func NewAttachIsoOpts(isoId string, ) *AttachIsoOpts` + +NewAttachIsoOpts instantiates a new AttachIsoOpts object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewAttachIsoOptsWithDefaults + +`func NewAttachIsoOptsWithDefaults() *AttachIsoOpts` + +NewAttachIsoOptsWithDefaults instantiates a new AttachIsoOpts object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetIsoId + +`func (o *AttachIsoOpts) GetIsoId() string` + +GetIsoId returns the IsoId field if non-nil, zero value otherwise. + +### GetIsoIdOk + +`func (o *AttachIsoOpts) GetIsoIdOk() (*string, bool)` + +GetIsoIdOk returns a tuple with the IsoId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsoId + +`func (o *AttachIsoOpts) SetIsoId(v string)` + +SetIsoId sets IsoId field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/BaseFirewallRule.md b/publicCloud/docs/BaseFirewallRule.md new file mode 100644 index 0000000..cf3ad38 --- /dev/null +++ b/publicCloud/docs/BaseFirewallRule.md @@ -0,0 +1,118 @@ +# BaseFirewallRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | | [optional] +**Name** | Pointer to **NullableString** | | [optional] +**Cidr** | Pointer to **string** | | [optional] + +## Methods + +### NewBaseFirewallRule + +`func NewBaseFirewallRule() *BaseFirewallRule` + +NewBaseFirewallRule instantiates a new BaseFirewallRule object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewBaseFirewallRuleWithDefaults + +`func NewBaseFirewallRuleWithDefaults() *BaseFirewallRule` + +NewBaseFirewallRuleWithDefaults instantiates a new BaseFirewallRule object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *BaseFirewallRule) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *BaseFirewallRule) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *BaseFirewallRule) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *BaseFirewallRule) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *BaseFirewallRule) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *BaseFirewallRule) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *BaseFirewallRule) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *BaseFirewallRule) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *BaseFirewallRule) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *BaseFirewallRule) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCidr + +`func (o *BaseFirewallRule) GetCidr() string` + +GetCidr returns the Cidr field if non-nil, zero value otherwise. + +### GetCidrOk + +`func (o *BaseFirewallRule) GetCidrOk() (*string, bool)` + +GetCidrOk returns a tuple with the Cidr field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCidr + +`func (o *BaseFirewallRule) SetCidr(v string)` + +SetCidr sets Cidr field to given value. + +### HasCidr + +`func (o *BaseFirewallRule) HasCidr() bool` + +HasCidr returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/Billing.md b/publicCloud/docs/Billing.md new file mode 100644 index 0000000..29e6003 --- /dev/null +++ b/publicCloud/docs/Billing.md @@ -0,0 +1,82 @@ +# Billing + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Instances** | Pointer to [**[]ExpenseResultInstance**](ExpenseResultInstance.md) | List of instances to be billed in the period | [optional] +**Traffic** | Pointer to [**Traffic**](Traffic.md) | | [optional] + +## Methods + +### NewBilling + +`func NewBilling() *Billing` + +NewBilling instantiates a new Billing object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewBillingWithDefaults + +`func NewBillingWithDefaults() *Billing` + +NewBillingWithDefaults instantiates a new Billing object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetInstances + +`func (o *Billing) GetInstances() []ExpenseResultInstance` + +GetInstances returns the Instances field if non-nil, zero value otherwise. + +### GetInstancesOk + +`func (o *Billing) GetInstancesOk() (*[]ExpenseResultInstance, bool)` + +GetInstancesOk returns a tuple with the Instances field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInstances + +`func (o *Billing) SetInstances(v []ExpenseResultInstance)` + +SetInstances sets Instances field to given value. + +### HasInstances + +`func (o *Billing) HasInstances() bool` + +HasInstances returns a boolean if a field has been set. + +### GetTraffic + +`func (o *Billing) GetTraffic() Traffic` + +GetTraffic returns the Traffic field if non-nil, zero value otherwise. + +### GetTrafficOk + +`func (o *Billing) GetTrafficOk() (*Traffic, bool)` + +GetTrafficOk returns a tuple with the Traffic field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTraffic + +`func (o *Billing) SetTraffic(v Traffic)` + +SetTraffic sets Traffic field to given value. + +### HasTraffic + +`func (o *Billing) HasTraffic() bool` + +HasTraffic returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/Central.md b/publicCloud/docs/Central.md new file mode 100644 index 0000000..e158b10 --- /dev/null +++ b/publicCloud/docs/Central.md @@ -0,0 +1,82 @@ +# Central + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**HourlyPrice** | Pointer to **string** | | [optional] +**MonthlyPrice** | Pointer to **string** | | [optional] + +## Methods + +### NewCentral + +`func NewCentral() *Central` + +NewCentral instantiates a new Central object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCentralWithDefaults + +`func NewCentralWithDefaults() *Central` + +NewCentralWithDefaults instantiates a new Central object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetHourlyPrice + +`func (o *Central) GetHourlyPrice() string` + +GetHourlyPrice returns the HourlyPrice field if non-nil, zero value otherwise. + +### GetHourlyPriceOk + +`func (o *Central) GetHourlyPriceOk() (*string, bool)` + +GetHourlyPriceOk returns a tuple with the HourlyPrice field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHourlyPrice + +`func (o *Central) SetHourlyPrice(v string)` + +SetHourlyPrice sets HourlyPrice field to given value. + +### HasHourlyPrice + +`func (o *Central) HasHourlyPrice() bool` + +HasHourlyPrice returns a boolean if a field has been set. + +### GetMonthlyPrice + +`func (o *Central) GetMonthlyPrice() string` + +GetMonthlyPrice returns the MonthlyPrice field if non-nil, zero value otherwise. + +### GetMonthlyPriceOk + +`func (o *Central) GetMonthlyPriceOk() (*string, bool)` + +GetMonthlyPriceOk returns a tuple with the MonthlyPrice field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMonthlyPrice + +`func (o *Central) SetMonthlyPrice(v string)` + +SetMonthlyPrice sets MonthlyPrice field to given value. + +### HasMonthlyPrice + +`func (o *Central) HasMonthlyPrice() bool` + +HasMonthlyPrice returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/Compute.md b/publicCloud/docs/Compute.md new file mode 100644 index 0000000..9c53167 --- /dev/null +++ b/publicCloud/docs/Compute.md @@ -0,0 +1,82 @@ +# Compute + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**HourlyPrice** | Pointer to **string** | | [optional] +**MonthlyPrice** | Pointer to **string** | | [optional] + +## Methods + +### NewCompute + +`func NewCompute() *Compute` + +NewCompute instantiates a new Compute object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewComputeWithDefaults + +`func NewComputeWithDefaults() *Compute` + +NewComputeWithDefaults instantiates a new Compute object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetHourlyPrice + +`func (o *Compute) GetHourlyPrice() string` + +GetHourlyPrice returns the HourlyPrice field if non-nil, zero value otherwise. + +### GetHourlyPriceOk + +`func (o *Compute) GetHourlyPriceOk() (*string, bool)` + +GetHourlyPriceOk returns a tuple with the HourlyPrice field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHourlyPrice + +`func (o *Compute) SetHourlyPrice(v string)` + +SetHourlyPrice sets HourlyPrice field to given value. + +### HasHourlyPrice + +`func (o *Compute) HasHourlyPrice() bool` + +HasHourlyPrice returns a boolean if a field has been set. + +### GetMonthlyPrice + +`func (o *Compute) GetMonthlyPrice() string` + +GetMonthlyPrice returns the MonthlyPrice field if non-nil, zero value otherwise. + +### GetMonthlyPriceOk + +`func (o *Compute) GetMonthlyPriceOk() (*string, bool)` + +GetMonthlyPriceOk returns a tuple with the MonthlyPrice field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMonthlyPrice + +`func (o *Compute) SetMonthlyPrice(v string)` + +SetMonthlyPrice sets MonthlyPrice field to given value. + +### HasMonthlyPrice + +`func (o *Compute) HasMonthlyPrice() bool` + +HasMonthlyPrice returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/ContractType.md b/publicCloud/docs/ContractType.md new file mode 100644 index 0000000..34f6f15 --- /dev/null +++ b/publicCloud/docs/ContractType.md @@ -0,0 +1,13 @@ +# ContractType + +## Enum + + +* `HOURLY` (value: `"HOURLY"`) + +* `MONTHLY` (value: `"MONTHLY"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/Cpu.md b/publicCloud/docs/Cpu.md new file mode 100644 index 0000000..a5fe0f3 --- /dev/null +++ b/publicCloud/docs/Cpu.md @@ -0,0 +1,82 @@ +# Cpu + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **int32** | | [optional] +**Unit** | Pointer to **string** | | [optional] + +## Methods + +### NewCpu + +`func NewCpu() *Cpu` + +NewCpu instantiates a new Cpu object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCpuWithDefaults + +`func NewCpuWithDefaults() *Cpu` + +NewCpuWithDefaults instantiates a new Cpu object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetValue + +`func (o *Cpu) GetValue() int32` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *Cpu) GetValueOk() (*int32, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *Cpu) SetValue(v int32)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *Cpu) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetUnit + +`func (o *Cpu) GetUnit() string` + +GetUnit returns the Unit field if non-nil, zero value otherwise. + +### GetUnitOk + +`func (o *Cpu) GetUnitOk() (*string, bool)` + +GetUnitOk returns a tuple with the Unit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnit + +`func (o *Cpu) SetUnit(v string)` + +SetUnit sets Unit field to given value. + +### HasUnit + +`func (o *Cpu) HasUnit() bool` + +HasUnit returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/CreateFirewallRulesCreatedResult.md b/publicCloud/docs/CreateFirewallRulesCreatedResult.md new file mode 100644 index 0000000..05ce432 --- /dev/null +++ b/publicCloud/docs/CreateFirewallRulesCreatedResult.md @@ -0,0 +1,82 @@ +# CreateFirewallRulesCreatedResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to [**[]FirewallRule**](FirewallRule.md) | List of rules that have been successfully added | [optional] +**Failed** | Pointer to [**[]FirewallRule**](FirewallRule.md) | List of rules that have failed to be added | [optional] + +## Methods + +### NewCreateFirewallRulesCreatedResult + +`func NewCreateFirewallRulesCreatedResult() *CreateFirewallRulesCreatedResult` + +NewCreateFirewallRulesCreatedResult instantiates a new CreateFirewallRulesCreatedResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCreateFirewallRulesCreatedResultWithDefaults + +`func NewCreateFirewallRulesCreatedResultWithDefaults() *CreateFirewallRulesCreatedResult` + +NewCreateFirewallRulesCreatedResultWithDefaults instantiates a new CreateFirewallRulesCreatedResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCreated + +`func (o *CreateFirewallRulesCreatedResult) GetCreated() []FirewallRule` + +GetCreated returns the Created field if non-nil, zero value otherwise. + +### GetCreatedOk + +`func (o *CreateFirewallRulesCreatedResult) GetCreatedOk() (*[]FirewallRule, bool)` + +GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCreated + +`func (o *CreateFirewallRulesCreatedResult) SetCreated(v []FirewallRule)` + +SetCreated sets Created field to given value. + +### HasCreated + +`func (o *CreateFirewallRulesCreatedResult) HasCreated() bool` + +HasCreated returns a boolean if a field has been set. + +### GetFailed + +`func (o *CreateFirewallRulesCreatedResult) GetFailed() []FirewallRule` + +GetFailed returns the Failed field if non-nil, zero value otherwise. + +### GetFailedOk + +`func (o *CreateFirewallRulesCreatedResult) GetFailedOk() (*[]FirewallRule, bool)` + +GetFailedOk returns a tuple with the Failed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFailed + +`func (o *CreateFirewallRulesCreatedResult) SetFailed(v []FirewallRule)` + +SetFailed sets Failed field to given value. + +### HasFailed + +`func (o *CreateFirewallRulesCreatedResult) HasFailed() bool` + +HasFailed returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/CreateFirewallRulesOpts.md b/publicCloud/docs/CreateFirewallRulesOpts.md new file mode 100644 index 0000000..abce053 --- /dev/null +++ b/publicCloud/docs/CreateFirewallRulesOpts.md @@ -0,0 +1,51 @@ +# CreateFirewallRulesOpts + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Rules** | [**[]CreateRule**](CreateRule.md) | | + +## Methods + +### NewCreateFirewallRulesOpts + +`func NewCreateFirewallRulesOpts(rules []CreateRule, ) *CreateFirewallRulesOpts` + +NewCreateFirewallRulesOpts instantiates a new CreateFirewallRulesOpts object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCreateFirewallRulesOptsWithDefaults + +`func NewCreateFirewallRulesOptsWithDefaults() *CreateFirewallRulesOpts` + +NewCreateFirewallRulesOptsWithDefaults instantiates a new CreateFirewallRulesOpts object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetRules + +`func (o *CreateFirewallRulesOpts) GetRules() []CreateRule` + +GetRules returns the Rules field if non-nil, zero value otherwise. + +### GetRulesOk + +`func (o *CreateFirewallRulesOpts) GetRulesOk() (*[]CreateRule, bool)` + +GetRulesOk returns a tuple with the Rules field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRules + +`func (o *CreateFirewallRulesOpts) SetRules(v []CreateRule)` + +SetRules sets Rules field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/CreateRule.md b/publicCloud/docs/CreateRule.md new file mode 100644 index 0000000..2569a95 --- /dev/null +++ b/publicCloud/docs/CreateRule.md @@ -0,0 +1,233 @@ +# CreateRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Protocol** | **string** | | +**StartPort** | **NullableInt32** | | +**EndPort** | **NullableInt32** | | +**IcmpType** | **int32** | | +**IcmpCode** | **int32** | | +**Id** | Pointer to **string** | | [optional] +**Name** | **NullableString** | | +**Cidr** | **string** | | + +## Methods + +### NewCreateRule + +`func NewCreateRule(protocol string, startPort NullableInt32, endPort NullableInt32, icmpType int32, icmpCode int32, name NullableString, cidr string, ) *CreateRule` + +NewCreateRule instantiates a new CreateRule object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCreateRuleWithDefaults + +`func NewCreateRuleWithDefaults() *CreateRule` + +NewCreateRuleWithDefaults instantiates a new CreateRule object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetProtocol + +`func (o *CreateRule) GetProtocol() string` + +GetProtocol returns the Protocol field if non-nil, zero value otherwise. + +### GetProtocolOk + +`func (o *CreateRule) GetProtocolOk() (*string, bool)` + +GetProtocolOk returns a tuple with the Protocol field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProtocol + +`func (o *CreateRule) SetProtocol(v string)` + +SetProtocol sets Protocol field to given value. + + +### GetStartPort + +`func (o *CreateRule) GetStartPort() int32` + +GetStartPort returns the StartPort field if non-nil, zero value otherwise. + +### GetStartPortOk + +`func (o *CreateRule) GetStartPortOk() (*int32, bool)` + +GetStartPortOk returns a tuple with the StartPort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartPort + +`func (o *CreateRule) SetStartPort(v int32)` + +SetStartPort sets StartPort field to given value. + + +### SetStartPortNil + +`func (o *CreateRule) SetStartPortNil(b bool)` + + SetStartPortNil sets the value for StartPort to be an explicit nil + +### UnsetStartPort +`func (o *CreateRule) UnsetStartPort()` + +UnsetStartPort ensures that no value is present for StartPort, not even an explicit nil +### GetEndPort + +`func (o *CreateRule) GetEndPort() int32` + +GetEndPort returns the EndPort field if non-nil, zero value otherwise. + +### GetEndPortOk + +`func (o *CreateRule) GetEndPortOk() (*int32, bool)` + +GetEndPortOk returns a tuple with the EndPort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndPort + +`func (o *CreateRule) SetEndPort(v int32)` + +SetEndPort sets EndPort field to given value. + + +### SetEndPortNil + +`func (o *CreateRule) SetEndPortNil(b bool)` + + SetEndPortNil sets the value for EndPort to be an explicit nil + +### UnsetEndPort +`func (o *CreateRule) UnsetEndPort()` + +UnsetEndPort ensures that no value is present for EndPort, not even an explicit nil +### GetIcmpType + +`func (o *CreateRule) GetIcmpType() int32` + +GetIcmpType returns the IcmpType field if non-nil, zero value otherwise. + +### GetIcmpTypeOk + +`func (o *CreateRule) GetIcmpTypeOk() (*int32, bool)` + +GetIcmpTypeOk returns a tuple with the IcmpType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIcmpType + +`func (o *CreateRule) SetIcmpType(v int32)` + +SetIcmpType sets IcmpType field to given value. + + +### GetIcmpCode + +`func (o *CreateRule) GetIcmpCode() int32` + +GetIcmpCode returns the IcmpCode field if non-nil, zero value otherwise. + +### GetIcmpCodeOk + +`func (o *CreateRule) GetIcmpCodeOk() (*int32, bool)` + +GetIcmpCodeOk returns a tuple with the IcmpCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIcmpCode + +`func (o *CreateRule) SetIcmpCode(v int32)` + +SetIcmpCode sets IcmpCode field to given value. + + +### GetId + +`func (o *CreateRule) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *CreateRule) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *CreateRule) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *CreateRule) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *CreateRule) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *CreateRule) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *CreateRule) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *CreateRule) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *CreateRule) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCidr + +`func (o *CreateRule) GetCidr() string` + +GetCidr returns the Cidr field if non-nil, zero value otherwise. + +### GetCidrOk + +`func (o *CreateRule) GetCidrOk() (*string, bool)` + +GetCidrOk returns a tuple with the Cidr field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCidr + +`func (o *CreateRule) SetCidr(v string)` + +SetCidr sets Cidr field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/Credential.md b/publicCloud/docs/Credential.md new file mode 100644 index 0000000..58f1c2e --- /dev/null +++ b/publicCloud/docs/Credential.md @@ -0,0 +1,82 @@ +# Credential + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**CredentialType**](CredentialType.md) | | [optional] +**Username** | Pointer to **string** | | [optional] + +## Methods + +### NewCredential + +`func NewCredential() *Credential` + +NewCredential instantiates a new Credential object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewCredentialWithDefaults + +`func NewCredentialWithDefaults() *Credential` + +NewCredentialWithDefaults instantiates a new Credential object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetType + +`func (o *Credential) GetType() CredentialType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Credential) GetTypeOk() (*CredentialType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Credential) SetType(v CredentialType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Credential) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetUsername + +`func (o *Credential) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *Credential) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *Credential) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *Credential) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/CredentialType.md b/publicCloud/docs/CredentialType.md new file mode 100644 index 0000000..e6c8888 --- /dev/null +++ b/publicCloud/docs/CredentialType.md @@ -0,0 +1,13 @@ +# CredentialType + +## Enum + + +* `OPERATING_SYSTEM` (value: `"OPERATING_SYSTEM"`) + +* `CONTROL_PANEL` (value: `"CONTROL_PANEL"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/Ddos.md b/publicCloud/docs/Ddos.md new file mode 100644 index 0000000..4246d39 --- /dev/null +++ b/publicCloud/docs/Ddos.md @@ -0,0 +1,82 @@ +# Ddos + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DetectionProfile** | Pointer to **string** | | [optional] +**ProtectionType** | Pointer to **string** | | [optional] + +## Methods + +### NewDdos + +`func NewDdos() *Ddos` + +NewDdos instantiates a new Ddos object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDdosWithDefaults + +`func NewDdosWithDefaults() *Ddos` + +NewDdosWithDefaults instantiates a new Ddos object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDetectionProfile + +`func (o *Ddos) GetDetectionProfile() string` + +GetDetectionProfile returns the DetectionProfile field if non-nil, zero value otherwise. + +### GetDetectionProfileOk + +`func (o *Ddos) GetDetectionProfileOk() (*string, bool)` + +GetDetectionProfileOk returns a tuple with the DetectionProfile field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDetectionProfile + +`func (o *Ddos) SetDetectionProfile(v string)` + +SetDetectionProfile sets DetectionProfile field to given value. + +### HasDetectionProfile + +`func (o *Ddos) HasDetectionProfile() bool` + +HasDetectionProfile returns a boolean if a field has been set. + +### GetProtectionType + +`func (o *Ddos) GetProtectionType() string` + +GetProtectionType returns the ProtectionType field if non-nil, zero value otherwise. + +### GetProtectionTypeOk + +`func (o *Ddos) GetProtectionTypeOk() (*string, bool)` + +GetProtectionTypeOk returns a tuple with the ProtectionType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProtectionType + +`func (o *Ddos) SetProtectionType(v string)` + +SetProtectionType sets ProtectionType field to given value. + +### HasProtectionType + +`func (o *Ddos) HasProtectionType() bool` + +HasProtectionType returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/DeleteFirewallRulesOpts.md b/publicCloud/docs/DeleteFirewallRulesOpts.md new file mode 100644 index 0000000..30c68d1 --- /dev/null +++ b/publicCloud/docs/DeleteFirewallRulesOpts.md @@ -0,0 +1,51 @@ +# DeleteFirewallRulesOpts + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Rules** | [**[]DeletionRule**](DeletionRule.md) | | + +## Methods + +### NewDeleteFirewallRulesOpts + +`func NewDeleteFirewallRulesOpts(rules []DeletionRule, ) *DeleteFirewallRulesOpts` + +NewDeleteFirewallRulesOpts instantiates a new DeleteFirewallRulesOpts object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDeleteFirewallRulesOptsWithDefaults + +`func NewDeleteFirewallRulesOptsWithDefaults() *DeleteFirewallRulesOpts` + +NewDeleteFirewallRulesOptsWithDefaults instantiates a new DeleteFirewallRulesOpts object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetRules + +`func (o *DeleteFirewallRulesOpts) GetRules() []DeletionRule` + +GetRules returns the Rules field if non-nil, zero value otherwise. + +### GetRulesOk + +`func (o *DeleteFirewallRulesOpts) GetRulesOk() (*[]DeletionRule, bool)` + +GetRulesOk returns a tuple with the Rules field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRules + +`func (o *DeleteFirewallRulesOpts) SetRules(v []DeletionRule)` + +SetRules sets Rules field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/DeleteFirewallRulesResult.md b/publicCloud/docs/DeleteFirewallRulesResult.md new file mode 100644 index 0000000..8e8c44f --- /dev/null +++ b/publicCloud/docs/DeleteFirewallRulesResult.md @@ -0,0 +1,82 @@ +# DeleteFirewallRulesResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Deleted** | Pointer to [**[]FirewallRule**](FirewallRule.md) | List of rules that have been successfully deleted | [optional] +**Failed** | Pointer to [**[]FirewallRule**](FirewallRule.md) | List of rules that have failed to be deleted | [optional] + +## Methods + +### NewDeleteFirewallRulesResult + +`func NewDeleteFirewallRulesResult() *DeleteFirewallRulesResult` + +NewDeleteFirewallRulesResult instantiates a new DeleteFirewallRulesResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDeleteFirewallRulesResultWithDefaults + +`func NewDeleteFirewallRulesResultWithDefaults() *DeleteFirewallRulesResult` + +NewDeleteFirewallRulesResultWithDefaults instantiates a new DeleteFirewallRulesResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetDeleted + +`func (o *DeleteFirewallRulesResult) GetDeleted() []FirewallRule` + +GetDeleted returns the Deleted field if non-nil, zero value otherwise. + +### GetDeletedOk + +`func (o *DeleteFirewallRulesResult) GetDeletedOk() (*[]FirewallRule, bool)` + +GetDeletedOk returns a tuple with the Deleted field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDeleted + +`func (o *DeleteFirewallRulesResult) SetDeleted(v []FirewallRule)` + +SetDeleted sets Deleted field to given value. + +### HasDeleted + +`func (o *DeleteFirewallRulesResult) HasDeleted() bool` + +HasDeleted returns a boolean if a field has been set. + +### GetFailed + +`func (o *DeleteFirewallRulesResult) GetFailed() []FirewallRule` + +GetFailed returns the Failed field if non-nil, zero value otherwise. + +### GetFailedOk + +`func (o *DeleteFirewallRulesResult) GetFailedOk() (*[]FirewallRule, bool)` + +GetFailedOk returns a tuple with the Failed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFailed + +`func (o *DeleteFirewallRulesResult) SetFailed(v []FirewallRule)` + +SetFailed sets Failed field to given value. + +### HasFailed + +`func (o *DeleteFirewallRulesResult) HasFailed() bool` + +HasFailed returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/DeletionRule.md b/publicCloud/docs/DeletionRule.md new file mode 100644 index 0000000..eb1b871 --- /dev/null +++ b/publicCloud/docs/DeletionRule.md @@ -0,0 +1,51 @@ +# DeletionRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | | + +## Methods + +### NewDeletionRule + +`func NewDeletionRule(id string, ) *DeletionRule` + +NewDeletionRule instantiates a new DeletionRule object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewDeletionRuleWithDefaults + +`func NewDeletionRuleWithDefaults() *DeletionRule` + +NewDeletionRuleWithDefaults instantiates a new DeletionRule object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *DeletionRule) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *DeletionRule) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *DeletionRule) SetId(v string)` + +SetId sets Id field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/EditFirewallRulesOpts.md b/publicCloud/docs/EditFirewallRulesOpts.md new file mode 100644 index 0000000..314d739 --- /dev/null +++ b/publicCloud/docs/EditFirewallRulesOpts.md @@ -0,0 +1,51 @@ +# EditFirewallRulesOpts + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Rules** | [**[]EditRule**](EditRule.md) | | + +## Methods + +### NewEditFirewallRulesOpts + +`func NewEditFirewallRulesOpts(rules []EditRule, ) *EditFirewallRulesOpts` + +NewEditFirewallRulesOpts instantiates a new EditFirewallRulesOpts object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewEditFirewallRulesOptsWithDefaults + +`func NewEditFirewallRulesOptsWithDefaults() *EditFirewallRulesOpts` + +NewEditFirewallRulesOptsWithDefaults instantiates a new EditFirewallRulesOpts object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetRules + +`func (o *EditFirewallRulesOpts) GetRules() []EditRule` + +GetRules returns the Rules field if non-nil, zero value otherwise. + +### GetRulesOk + +`func (o *EditFirewallRulesOpts) GetRulesOk() (*[]EditRule, bool)` + +GetRulesOk returns a tuple with the Rules field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRules + +`func (o *EditFirewallRulesOpts) SetRules(v []EditRule)` + +SetRules sets Rules field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/EditFirewallRulesResult.md b/publicCloud/docs/EditFirewallRulesResult.md new file mode 100644 index 0000000..095dd12 --- /dev/null +++ b/publicCloud/docs/EditFirewallRulesResult.md @@ -0,0 +1,82 @@ +# EditFirewallRulesResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Updated** | Pointer to [**[]FirewallRule**](FirewallRule.md) | List of rules that have been successfully edited | [optional] +**Failed** | Pointer to [**[]FailedRule**](FailedRule.md) | List of rules that have failed to be edited along with their error messages | [optional] + +## Methods + +### NewEditFirewallRulesResult + +`func NewEditFirewallRulesResult() *EditFirewallRulesResult` + +NewEditFirewallRulesResult instantiates a new EditFirewallRulesResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewEditFirewallRulesResultWithDefaults + +`func NewEditFirewallRulesResultWithDefaults() *EditFirewallRulesResult` + +NewEditFirewallRulesResultWithDefaults instantiates a new EditFirewallRulesResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetUpdated + +`func (o *EditFirewallRulesResult) GetUpdated() []FirewallRule` + +GetUpdated returns the Updated field if non-nil, zero value otherwise. + +### GetUpdatedOk + +`func (o *EditFirewallRulesResult) GetUpdatedOk() (*[]FirewallRule, bool)` + +GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUpdated + +`func (o *EditFirewallRulesResult) SetUpdated(v []FirewallRule)` + +SetUpdated sets Updated field to given value. + +### HasUpdated + +`func (o *EditFirewallRulesResult) HasUpdated() bool` + +HasUpdated returns a boolean if a field has been set. + +### GetFailed + +`func (o *EditFirewallRulesResult) GetFailed() []FailedRule` + +GetFailed returns the Failed field if non-nil, zero value otherwise. + +### GetFailedOk + +`func (o *EditFirewallRulesResult) GetFailedOk() (*[]FailedRule, bool)` + +GetFailedOk returns a tuple with the Failed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFailed + +`func (o *EditFirewallRulesResult) SetFailed(v []FailedRule)` + +SetFailed sets Failed field to given value. + +### HasFailed + +`func (o *EditFirewallRulesResult) HasFailed() bool` + +HasFailed returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/EditRule.md b/publicCloud/docs/EditRule.md new file mode 100644 index 0000000..4721bb9 --- /dev/null +++ b/publicCloud/docs/EditRule.md @@ -0,0 +1,228 @@ +# EditRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Protocol** | **string** | | +**StartPort** | **NullableInt32** | | +**EndPort** | **NullableInt32** | | +**IcmpType** | **int32** | | +**IcmpCode** | **int32** | | +**Id** | **string** | | +**Name** | **NullableString** | | +**Cidr** | **string** | | + +## Methods + +### NewEditRule + +`func NewEditRule(protocol string, startPort NullableInt32, endPort NullableInt32, icmpType int32, icmpCode int32, id string, name NullableString, cidr string, ) *EditRule` + +NewEditRule instantiates a new EditRule object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewEditRuleWithDefaults + +`func NewEditRuleWithDefaults() *EditRule` + +NewEditRuleWithDefaults instantiates a new EditRule object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetProtocol + +`func (o *EditRule) GetProtocol() string` + +GetProtocol returns the Protocol field if non-nil, zero value otherwise. + +### GetProtocolOk + +`func (o *EditRule) GetProtocolOk() (*string, bool)` + +GetProtocolOk returns a tuple with the Protocol field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProtocol + +`func (o *EditRule) SetProtocol(v string)` + +SetProtocol sets Protocol field to given value. + + +### GetStartPort + +`func (o *EditRule) GetStartPort() int32` + +GetStartPort returns the StartPort field if non-nil, zero value otherwise. + +### GetStartPortOk + +`func (o *EditRule) GetStartPortOk() (*int32, bool)` + +GetStartPortOk returns a tuple with the StartPort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartPort + +`func (o *EditRule) SetStartPort(v int32)` + +SetStartPort sets StartPort field to given value. + + +### SetStartPortNil + +`func (o *EditRule) SetStartPortNil(b bool)` + + SetStartPortNil sets the value for StartPort to be an explicit nil + +### UnsetStartPort +`func (o *EditRule) UnsetStartPort()` + +UnsetStartPort ensures that no value is present for StartPort, not even an explicit nil +### GetEndPort + +`func (o *EditRule) GetEndPort() int32` + +GetEndPort returns the EndPort field if non-nil, zero value otherwise. + +### GetEndPortOk + +`func (o *EditRule) GetEndPortOk() (*int32, bool)` + +GetEndPortOk returns a tuple with the EndPort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndPort + +`func (o *EditRule) SetEndPort(v int32)` + +SetEndPort sets EndPort field to given value. + + +### SetEndPortNil + +`func (o *EditRule) SetEndPortNil(b bool)` + + SetEndPortNil sets the value for EndPort to be an explicit nil + +### UnsetEndPort +`func (o *EditRule) UnsetEndPort()` + +UnsetEndPort ensures that no value is present for EndPort, not even an explicit nil +### GetIcmpType + +`func (o *EditRule) GetIcmpType() int32` + +GetIcmpType returns the IcmpType field if non-nil, zero value otherwise. + +### GetIcmpTypeOk + +`func (o *EditRule) GetIcmpTypeOk() (*int32, bool)` + +GetIcmpTypeOk returns a tuple with the IcmpType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIcmpType + +`func (o *EditRule) SetIcmpType(v int32)` + +SetIcmpType sets IcmpType field to given value. + + +### GetIcmpCode + +`func (o *EditRule) GetIcmpCode() int32` + +GetIcmpCode returns the IcmpCode field if non-nil, zero value otherwise. + +### GetIcmpCodeOk + +`func (o *EditRule) GetIcmpCodeOk() (*int32, bool)` + +GetIcmpCodeOk returns a tuple with the IcmpCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIcmpCode + +`func (o *EditRule) SetIcmpCode(v int32)` + +SetIcmpCode sets IcmpCode field to given value. + + +### GetId + +`func (o *EditRule) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *EditRule) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *EditRule) SetId(v string)` + +SetId sets Id field to given value. + + +### GetName + +`func (o *EditRule) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *EditRule) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *EditRule) SetName(v string)` + +SetName sets Name field to given value. + + +### SetNameNil + +`func (o *EditRule) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *EditRule) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCidr + +`func (o *EditRule) GetCidr() string` + +GetCidr returns the Cidr field if non-nil, zero value otherwise. + +### GetCidrOk + +`func (o *EditRule) GetCidrOk() (*string, bool)` + +GetCidrOk returns a tuple with the Cidr field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCidr + +`func (o *EditRule) SetCidr(v string)` + +SetCidr sets Cidr field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/ErrorResult.md b/publicCloud/docs/ErrorResult.md new file mode 100644 index 0000000..af3c285 --- /dev/null +++ b/publicCloud/docs/ErrorResult.md @@ -0,0 +1,134 @@ +# ErrorResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CorrelationId** | Pointer to **string** | The correlation ID of the current request. | [optional] +**ErrorCode** | Pointer to **string** | The error code. | [optional] +**ErrorMessage** | Pointer to **string** | A human friendly description of the error. | [optional] +**ErrorDetails** | Pointer to [**[]map[string][]string**](map[string][]string.md) | | [optional] + +## Methods + +### NewErrorResult + +`func NewErrorResult() *ErrorResult` + +NewErrorResult instantiates a new ErrorResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewErrorResultWithDefaults + +`func NewErrorResultWithDefaults() *ErrorResult` + +NewErrorResultWithDefaults instantiates a new ErrorResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCorrelationId + +`func (o *ErrorResult) GetCorrelationId() string` + +GetCorrelationId returns the CorrelationId field if non-nil, zero value otherwise. + +### GetCorrelationIdOk + +`func (o *ErrorResult) GetCorrelationIdOk() (*string, bool)` + +GetCorrelationIdOk returns a tuple with the CorrelationId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCorrelationId + +`func (o *ErrorResult) SetCorrelationId(v string)` + +SetCorrelationId sets CorrelationId field to given value. + +### HasCorrelationId + +`func (o *ErrorResult) HasCorrelationId() bool` + +HasCorrelationId returns a boolean if a field has been set. + +### GetErrorCode + +`func (o *ErrorResult) GetErrorCode() string` + +GetErrorCode returns the ErrorCode field if non-nil, zero value otherwise. + +### GetErrorCodeOk + +`func (o *ErrorResult) GetErrorCodeOk() (*string, bool)` + +GetErrorCodeOk returns a tuple with the ErrorCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorCode + +`func (o *ErrorResult) SetErrorCode(v string)` + +SetErrorCode sets ErrorCode field to given value. + +### HasErrorCode + +`func (o *ErrorResult) HasErrorCode() bool` + +HasErrorCode returns a boolean if a field has been set. + +### GetErrorMessage + +`func (o *ErrorResult) GetErrorMessage() string` + +GetErrorMessage returns the ErrorMessage field if non-nil, zero value otherwise. + +### GetErrorMessageOk + +`func (o *ErrorResult) GetErrorMessageOk() (*string, bool)` + +GetErrorMessageOk returns a tuple with the ErrorMessage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorMessage + +`func (o *ErrorResult) SetErrorMessage(v string)` + +SetErrorMessage sets ErrorMessage field to given value. + +### HasErrorMessage + +`func (o *ErrorResult) HasErrorMessage() bool` + +HasErrorMessage returns a boolean if a field has been set. + +### GetErrorDetails + +`func (o *ErrorResult) GetErrorDetails() []map[string][]string` + +GetErrorDetails returns the ErrorDetails field if non-nil, zero value otherwise. + +### GetErrorDetailsOk + +`func (o *ErrorResult) GetErrorDetailsOk() (*[]map[string][]string, bool)` + +GetErrorDetailsOk returns a tuple with the ErrorDetails field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetErrorDetails + +`func (o *ErrorResult) SetErrorDetails(v []map[string][]string)` + +SetErrorDetails sets ErrorDetails field to given value. + +### HasErrorDetails + +`func (o *ErrorResult) HasErrorDetails() bool` + +HasErrorDetails returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/ExpenseResultInstance.md b/publicCloud/docs/ExpenseResultInstance.md new file mode 100644 index 0000000..a6291e1 --- /dev/null +++ b/publicCloud/docs/ExpenseResultInstance.md @@ -0,0 +1,420 @@ +# ExpenseResultInstance + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | The unique identifier for the instance. | [optional] +**Reference** | Pointer to **string** | The reference of the instance. | [optional] +**Resources** | Pointer to [**InstanceResources**](InstanceResources.md) | | [optional] +**ContractType** | Pointer to **string** | The contract type of the instance. | [optional] +**ContractCreatedAt** | Pointer to **time.Time** | Date when the contract was created | [optional] +**StartedAt** | Pointer to **time.Time** | Date when the instance was started | [optional] +**ContractTerm** | Pointer to **int32** | The contract term (in months) of the instance. | [optional] +**BillingFrequency** | Pointer to **int32** | The billing frequency (in months) of the instance. | [optional] +**RootDiskSize** | Pointer to **int32** | The root disk size as specified during its launch or update, in GB | [optional] +**RootDiskType** | Pointer to **string** | The root disk type as specified during its launch or update. | [optional] +**BillingType** | Pointer to **string** | The billing type of the instance. PREPAID is used for monthly commited instances, POSTPAID for hourly instances. | [optional] +**Hours** | Pointer to **int32** | The number of hours the instance has been running. | [optional] +**From** | Pointer to **time.Time** | The start date of the billing period. | [optional] +**To** | Pointer to **time.Time** | The end date of the billing period. | [optional] +**Price** | Pointer to **string** | The price of the instance for the billing period. | [optional] + +## Methods + +### NewExpenseResultInstance + +`func NewExpenseResultInstance() *ExpenseResultInstance` + +NewExpenseResultInstance instantiates a new ExpenseResultInstance object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewExpenseResultInstanceWithDefaults + +`func NewExpenseResultInstanceWithDefaults() *ExpenseResultInstance` + +NewExpenseResultInstanceWithDefaults instantiates a new ExpenseResultInstance object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *ExpenseResultInstance) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *ExpenseResultInstance) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *ExpenseResultInstance) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *ExpenseResultInstance) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetReference + +`func (o *ExpenseResultInstance) GetReference() string` + +GetReference returns the Reference field if non-nil, zero value otherwise. + +### GetReferenceOk + +`func (o *ExpenseResultInstance) GetReferenceOk() (*string, bool)` + +GetReferenceOk returns a tuple with the Reference field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReference + +`func (o *ExpenseResultInstance) SetReference(v string)` + +SetReference sets Reference field to given value. + +### HasReference + +`func (o *ExpenseResultInstance) HasReference() bool` + +HasReference returns a boolean if a field has been set. + +### GetResources + +`func (o *ExpenseResultInstance) GetResources() InstanceResources` + +GetResources returns the Resources field if non-nil, zero value otherwise. + +### GetResourcesOk + +`func (o *ExpenseResultInstance) GetResourcesOk() (*InstanceResources, bool)` + +GetResourcesOk returns a tuple with the Resources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResources + +`func (o *ExpenseResultInstance) SetResources(v InstanceResources)` + +SetResources sets Resources field to given value. + +### HasResources + +`func (o *ExpenseResultInstance) HasResources() bool` + +HasResources returns a boolean if a field has been set. + +### GetContractType + +`func (o *ExpenseResultInstance) GetContractType() string` + +GetContractType returns the ContractType field if non-nil, zero value otherwise. + +### GetContractTypeOk + +`func (o *ExpenseResultInstance) GetContractTypeOk() (*string, bool)` + +GetContractTypeOk returns a tuple with the ContractType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContractType + +`func (o *ExpenseResultInstance) SetContractType(v string)` + +SetContractType sets ContractType field to given value. + +### HasContractType + +`func (o *ExpenseResultInstance) HasContractType() bool` + +HasContractType returns a boolean if a field has been set. + +### GetContractCreatedAt + +`func (o *ExpenseResultInstance) GetContractCreatedAt() time.Time` + +GetContractCreatedAt returns the ContractCreatedAt field if non-nil, zero value otherwise. + +### GetContractCreatedAtOk + +`func (o *ExpenseResultInstance) GetContractCreatedAtOk() (*time.Time, bool)` + +GetContractCreatedAtOk returns a tuple with the ContractCreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContractCreatedAt + +`func (o *ExpenseResultInstance) SetContractCreatedAt(v time.Time)` + +SetContractCreatedAt sets ContractCreatedAt field to given value. + +### HasContractCreatedAt + +`func (o *ExpenseResultInstance) HasContractCreatedAt() bool` + +HasContractCreatedAt returns a boolean if a field has been set. + +### GetStartedAt + +`func (o *ExpenseResultInstance) GetStartedAt() time.Time` + +GetStartedAt returns the StartedAt field if non-nil, zero value otherwise. + +### GetStartedAtOk + +`func (o *ExpenseResultInstance) GetStartedAtOk() (*time.Time, bool)` + +GetStartedAtOk returns a tuple with the StartedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartedAt + +`func (o *ExpenseResultInstance) SetStartedAt(v time.Time)` + +SetStartedAt sets StartedAt field to given value. + +### HasStartedAt + +`func (o *ExpenseResultInstance) HasStartedAt() bool` + +HasStartedAt returns a boolean if a field has been set. + +### GetContractTerm + +`func (o *ExpenseResultInstance) GetContractTerm() int32` + +GetContractTerm returns the ContractTerm field if non-nil, zero value otherwise. + +### GetContractTermOk + +`func (o *ExpenseResultInstance) GetContractTermOk() (*int32, bool)` + +GetContractTermOk returns a tuple with the ContractTerm field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContractTerm + +`func (o *ExpenseResultInstance) SetContractTerm(v int32)` + +SetContractTerm sets ContractTerm field to given value. + +### HasContractTerm + +`func (o *ExpenseResultInstance) HasContractTerm() bool` + +HasContractTerm returns a boolean if a field has been set. + +### GetBillingFrequency + +`func (o *ExpenseResultInstance) GetBillingFrequency() int32` + +GetBillingFrequency returns the BillingFrequency field if non-nil, zero value otherwise. + +### GetBillingFrequencyOk + +`func (o *ExpenseResultInstance) GetBillingFrequencyOk() (*int32, bool)` + +GetBillingFrequencyOk returns a tuple with the BillingFrequency field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBillingFrequency + +`func (o *ExpenseResultInstance) SetBillingFrequency(v int32)` + +SetBillingFrequency sets BillingFrequency field to given value. + +### HasBillingFrequency + +`func (o *ExpenseResultInstance) HasBillingFrequency() bool` + +HasBillingFrequency returns a boolean if a field has been set. + +### GetRootDiskSize + +`func (o *ExpenseResultInstance) GetRootDiskSize() int32` + +GetRootDiskSize returns the RootDiskSize field if non-nil, zero value otherwise. + +### GetRootDiskSizeOk + +`func (o *ExpenseResultInstance) GetRootDiskSizeOk() (*int32, bool)` + +GetRootDiskSizeOk returns a tuple with the RootDiskSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRootDiskSize + +`func (o *ExpenseResultInstance) SetRootDiskSize(v int32)` + +SetRootDiskSize sets RootDiskSize field to given value. + +### HasRootDiskSize + +`func (o *ExpenseResultInstance) HasRootDiskSize() bool` + +HasRootDiskSize returns a boolean if a field has been set. + +### GetRootDiskType + +`func (o *ExpenseResultInstance) GetRootDiskType() string` + +GetRootDiskType returns the RootDiskType field if non-nil, zero value otherwise. + +### GetRootDiskTypeOk + +`func (o *ExpenseResultInstance) GetRootDiskTypeOk() (*string, bool)` + +GetRootDiskTypeOk returns a tuple with the RootDiskType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRootDiskType + +`func (o *ExpenseResultInstance) SetRootDiskType(v string)` + +SetRootDiskType sets RootDiskType field to given value. + +### HasRootDiskType + +`func (o *ExpenseResultInstance) HasRootDiskType() bool` + +HasRootDiskType returns a boolean if a field has been set. + +### GetBillingType + +`func (o *ExpenseResultInstance) GetBillingType() string` + +GetBillingType returns the BillingType field if non-nil, zero value otherwise. + +### GetBillingTypeOk + +`func (o *ExpenseResultInstance) GetBillingTypeOk() (*string, bool)` + +GetBillingTypeOk returns a tuple with the BillingType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBillingType + +`func (o *ExpenseResultInstance) SetBillingType(v string)` + +SetBillingType sets BillingType field to given value. + +### HasBillingType + +`func (o *ExpenseResultInstance) HasBillingType() bool` + +HasBillingType returns a boolean if a field has been set. + +### GetHours + +`func (o *ExpenseResultInstance) GetHours() int32` + +GetHours returns the Hours field if non-nil, zero value otherwise. + +### GetHoursOk + +`func (o *ExpenseResultInstance) GetHoursOk() (*int32, bool)` + +GetHoursOk returns a tuple with the Hours field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHours + +`func (o *ExpenseResultInstance) SetHours(v int32)` + +SetHours sets Hours field to given value. + +### HasHours + +`func (o *ExpenseResultInstance) HasHours() bool` + +HasHours returns a boolean if a field has been set. + +### GetFrom + +`func (o *ExpenseResultInstance) GetFrom() time.Time` + +GetFrom returns the From field if non-nil, zero value otherwise. + +### GetFromOk + +`func (o *ExpenseResultInstance) GetFromOk() (*time.Time, bool)` + +GetFromOk returns a tuple with the From field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFrom + +`func (o *ExpenseResultInstance) SetFrom(v time.Time)` + +SetFrom sets From field to given value. + +### HasFrom + +`func (o *ExpenseResultInstance) HasFrom() bool` + +HasFrom returns a boolean if a field has been set. + +### GetTo + +`func (o *ExpenseResultInstance) GetTo() time.Time` + +GetTo returns the To field if non-nil, zero value otherwise. + +### GetToOk + +`func (o *ExpenseResultInstance) GetToOk() (*time.Time, bool)` + +GetToOk returns a tuple with the To field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTo + +`func (o *ExpenseResultInstance) SetTo(v time.Time)` + +SetTo sets To field to given value. + +### HasTo + +`func (o *ExpenseResultInstance) HasTo() bool` + +HasTo returns a boolean if a field has been set. + +### GetPrice + +`func (o *ExpenseResultInstance) GetPrice() string` + +GetPrice returns the Price field if non-nil, zero value otherwise. + +### GetPriceOk + +`func (o *ExpenseResultInstance) GetPriceOk() (*string, bool)` + +GetPriceOk returns a tuple with the Price field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrice + +`func (o *ExpenseResultInstance) SetPrice(v string)` + +SetPrice sets Price field to given value. + +### HasPrice + +`func (o *ExpenseResultInstance) HasPrice() bool` + +HasPrice returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/FailedRule.md b/publicCloud/docs/FailedRule.md new file mode 100644 index 0000000..30a8b7d --- /dev/null +++ b/publicCloud/docs/FailedRule.md @@ -0,0 +1,82 @@ +# FailedRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | | [optional] +**Message** | Pointer to **string** | The reason which the edition has failed | [optional] + +## Methods + +### NewFailedRule + +`func NewFailedRule() *FailedRule` + +NewFailedRule instantiates a new FailedRule object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewFailedRuleWithDefaults + +`func NewFailedRuleWithDefaults() *FailedRule` + +NewFailedRuleWithDefaults instantiates a new FailedRule object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *FailedRule) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FailedRule) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FailedRule) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FailedRule) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetMessage + +`func (o *FailedRule) GetMessage() string` + +GetMessage returns the Message field if non-nil, zero value otherwise. + +### GetMessageOk + +`func (o *FailedRule) GetMessageOk() (*string, bool)` + +GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMessage + +`func (o *FailedRule) SetMessage(v string)` + +SetMessage sets Message field to given value. + +### HasMessage + +`func (o *FailedRule) HasMessage() bool` + +HasMessage returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/FirewallRule.md b/publicCloud/docs/FirewallRule.md new file mode 100644 index 0000000..d1a0ee6 --- /dev/null +++ b/publicCloud/docs/FirewallRule.md @@ -0,0 +1,248 @@ +# FirewallRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Protocol** | Pointer to **string** | | [optional] +**StartPort** | **NullableInt32** | | +**EndPort** | **NullableInt32** | | +**IcmpType** | **int32** | | +**IcmpCode** | **int32** | | +**Id** | Pointer to **string** | | [optional] +**Name** | Pointer to **NullableString** | | [optional] +**Cidr** | Pointer to **string** | | [optional] + +## Methods + +### NewFirewallRule + +`func NewFirewallRule(startPort NullableInt32, endPort NullableInt32, icmpType int32, icmpCode int32, ) *FirewallRule` + +NewFirewallRule instantiates a new FirewallRule object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewFirewallRuleWithDefaults + +`func NewFirewallRuleWithDefaults() *FirewallRule` + +NewFirewallRuleWithDefaults instantiates a new FirewallRule object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetProtocol + +`func (o *FirewallRule) GetProtocol() string` + +GetProtocol returns the Protocol field if non-nil, zero value otherwise. + +### GetProtocolOk + +`func (o *FirewallRule) GetProtocolOk() (*string, bool)` + +GetProtocolOk returns a tuple with the Protocol field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProtocol + +`func (o *FirewallRule) SetProtocol(v string)` + +SetProtocol sets Protocol field to given value. + +### HasProtocol + +`func (o *FirewallRule) HasProtocol() bool` + +HasProtocol returns a boolean if a field has been set. + +### GetStartPort + +`func (o *FirewallRule) GetStartPort() int32` + +GetStartPort returns the StartPort field if non-nil, zero value otherwise. + +### GetStartPortOk + +`func (o *FirewallRule) GetStartPortOk() (*int32, bool)` + +GetStartPortOk returns a tuple with the StartPort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartPort + +`func (o *FirewallRule) SetStartPort(v int32)` + +SetStartPort sets StartPort field to given value. + + +### SetStartPortNil + +`func (o *FirewallRule) SetStartPortNil(b bool)` + + SetStartPortNil sets the value for StartPort to be an explicit nil + +### UnsetStartPort +`func (o *FirewallRule) UnsetStartPort()` + +UnsetStartPort ensures that no value is present for StartPort, not even an explicit nil +### GetEndPort + +`func (o *FirewallRule) GetEndPort() int32` + +GetEndPort returns the EndPort field if non-nil, zero value otherwise. + +### GetEndPortOk + +`func (o *FirewallRule) GetEndPortOk() (*int32, bool)` + +GetEndPortOk returns a tuple with the EndPort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndPort + +`func (o *FirewallRule) SetEndPort(v int32)` + +SetEndPort sets EndPort field to given value. + + +### SetEndPortNil + +`func (o *FirewallRule) SetEndPortNil(b bool)` + + SetEndPortNil sets the value for EndPort to be an explicit nil + +### UnsetEndPort +`func (o *FirewallRule) UnsetEndPort()` + +UnsetEndPort ensures that no value is present for EndPort, not even an explicit nil +### GetIcmpType + +`func (o *FirewallRule) GetIcmpType() int32` + +GetIcmpType returns the IcmpType field if non-nil, zero value otherwise. + +### GetIcmpTypeOk + +`func (o *FirewallRule) GetIcmpTypeOk() (*int32, bool)` + +GetIcmpTypeOk returns a tuple with the IcmpType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIcmpType + +`func (o *FirewallRule) SetIcmpType(v int32)` + +SetIcmpType sets IcmpType field to given value. + + +### GetIcmpCode + +`func (o *FirewallRule) GetIcmpCode() int32` + +GetIcmpCode returns the IcmpCode field if non-nil, zero value otherwise. + +### GetIcmpCodeOk + +`func (o *FirewallRule) GetIcmpCodeOk() (*int32, bool)` + +GetIcmpCodeOk returns a tuple with the IcmpCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIcmpCode + +`func (o *FirewallRule) SetIcmpCode(v int32)` + +SetIcmpCode sets IcmpCode field to given value. + + +### GetId + +`func (o *FirewallRule) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *FirewallRule) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *FirewallRule) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *FirewallRule) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *FirewallRule) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *FirewallRule) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *FirewallRule) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *FirewallRule) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *FirewallRule) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *FirewallRule) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCidr + +`func (o *FirewallRule) GetCidr() string` + +GetCidr returns the Cidr field if non-nil, zero value otherwise. + +### GetCidrOk + +`func (o *FirewallRule) GetCidrOk() (*string, bool)` + +GetCidrOk returns a tuple with the Cidr field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCidr + +`func (o *FirewallRule) SetCidr(v string)` + +SetCidr sets Cidr field to given value. + +### HasCidr + +`func (o *FirewallRule) HasCidr() bool` + +HasCidr returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/GetConsoleAccessToInstanceResult.md b/publicCloud/docs/GetConsoleAccessToInstanceResult.md new file mode 100644 index 0000000..c588ee1 --- /dev/null +++ b/publicCloud/docs/GetConsoleAccessToInstanceResult.md @@ -0,0 +1,56 @@ +# GetConsoleAccessToInstanceResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Url** | Pointer to **string** | The URL to the console | [optional] + +## Methods + +### NewGetConsoleAccessToInstanceResult + +`func NewGetConsoleAccessToInstanceResult() *GetConsoleAccessToInstanceResult` + +NewGetConsoleAccessToInstanceResult instantiates a new GetConsoleAccessToInstanceResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetConsoleAccessToInstanceResultWithDefaults + +`func NewGetConsoleAccessToInstanceResultWithDefaults() *GetConsoleAccessToInstanceResult` + +NewGetConsoleAccessToInstanceResultWithDefaults instantiates a new GetConsoleAccessToInstanceResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetUrl + +`func (o *GetConsoleAccessToInstanceResult) GetUrl() string` + +GetUrl returns the Url field if non-nil, zero value otherwise. + +### GetUrlOk + +`func (o *GetConsoleAccessToInstanceResult) GetUrlOk() (*string, bool)` + +GetUrlOk returns a tuple with the Url field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUrl + +`func (o *GetConsoleAccessToInstanceResult) SetUrl(v string)` + +SetUrl sets Url field to given value. + +### HasUrl + +`func (o *GetConsoleAccessToInstanceResult) HasUrl() bool` + +HasUrl returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/GetCredentialListByTypeResult.md b/publicCloud/docs/GetCredentialListByTypeResult.md new file mode 100644 index 0000000..ce0874c --- /dev/null +++ b/publicCloud/docs/GetCredentialListByTypeResult.md @@ -0,0 +1,82 @@ +# GetCredentialListByTypeResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Credentials** | Pointer to [**[]Credential**](Credential.md) | | [optional] +**Metadata** | Pointer to [**Metadata**](Metadata.md) | | [optional] + +## Methods + +### NewGetCredentialListByTypeResult + +`func NewGetCredentialListByTypeResult() *GetCredentialListByTypeResult` + +NewGetCredentialListByTypeResult instantiates a new GetCredentialListByTypeResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetCredentialListByTypeResultWithDefaults + +`func NewGetCredentialListByTypeResultWithDefaults() *GetCredentialListByTypeResult` + +NewGetCredentialListByTypeResultWithDefaults instantiates a new GetCredentialListByTypeResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCredentials + +`func (o *GetCredentialListByTypeResult) GetCredentials() []Credential` + +GetCredentials returns the Credentials field if non-nil, zero value otherwise. + +### GetCredentialsOk + +`func (o *GetCredentialListByTypeResult) GetCredentialsOk() (*[]Credential, bool)` + +GetCredentialsOk returns a tuple with the Credentials field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentials + +`func (o *GetCredentialListByTypeResult) SetCredentials(v []Credential)` + +SetCredentials sets Credentials field to given value. + +### HasCredentials + +`func (o *GetCredentialListByTypeResult) HasCredentials() bool` + +HasCredentials returns a boolean if a field has been set. + +### GetMetadata + +`func (o *GetCredentialListByTypeResult) GetMetadata() Metadata` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *GetCredentialListByTypeResult) GetMetadataOk() (*Metadata, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *GetCredentialListByTypeResult) SetMetadata(v Metadata)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *GetCredentialListByTypeResult) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/GetCredentialListResult.md b/publicCloud/docs/GetCredentialListResult.md new file mode 100644 index 0000000..d766e1b --- /dev/null +++ b/publicCloud/docs/GetCredentialListResult.md @@ -0,0 +1,82 @@ +# GetCredentialListResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Credentials** | Pointer to [**[]Credential**](Credential.md) | | [optional] +**Metadata** | Pointer to [**Metadata**](Metadata.md) | | [optional] + +## Methods + +### NewGetCredentialListResult + +`func NewGetCredentialListResult() *GetCredentialListResult` + +NewGetCredentialListResult instantiates a new GetCredentialListResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetCredentialListResultWithDefaults + +`func NewGetCredentialListResultWithDefaults() *GetCredentialListResult` + +NewGetCredentialListResultWithDefaults instantiates a new GetCredentialListResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCredentials + +`func (o *GetCredentialListResult) GetCredentials() []Credential` + +GetCredentials returns the Credentials field if non-nil, zero value otherwise. + +### GetCredentialsOk + +`func (o *GetCredentialListResult) GetCredentialsOk() (*[]Credential, bool)` + +GetCredentialsOk returns a tuple with the Credentials field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCredentials + +`func (o *GetCredentialListResult) SetCredentials(v []Credential)` + +SetCredentials sets Credentials field to given value. + +### HasCredentials + +`func (o *GetCredentialListResult) HasCredentials() bool` + +HasCredentials returns a boolean if a field has been set. + +### GetMetadata + +`func (o *GetCredentialListResult) GetMetadata() Metadata` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *GetCredentialListResult) GetMetadataOk() (*Metadata, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *GetCredentialListResult) SetMetadata(v Metadata)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *GetCredentialListResult) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/GetCredentialResult.md b/publicCloud/docs/GetCredentialResult.md new file mode 100644 index 0000000..15c50e7 --- /dev/null +++ b/publicCloud/docs/GetCredentialResult.md @@ -0,0 +1,108 @@ +# GetCredentialResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**CredentialType**](CredentialType.md) | | [optional] +**Username** | Pointer to **string** | | [optional] +**Password** | Pointer to **string** | | [optional] + +## Methods + +### NewGetCredentialResult + +`func NewGetCredentialResult() *GetCredentialResult` + +NewGetCredentialResult instantiates a new GetCredentialResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetCredentialResultWithDefaults + +`func NewGetCredentialResultWithDefaults() *GetCredentialResult` + +NewGetCredentialResultWithDefaults instantiates a new GetCredentialResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetType + +`func (o *GetCredentialResult) GetType() CredentialType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *GetCredentialResult) GetTypeOk() (*CredentialType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *GetCredentialResult) SetType(v CredentialType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *GetCredentialResult) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetUsername + +`func (o *GetCredentialResult) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *GetCredentialResult) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *GetCredentialResult) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *GetCredentialResult) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + +### GetPassword + +`func (o *GetCredentialResult) GetPassword() string` + +GetPassword returns the Password field if non-nil, zero value otherwise. + +### GetPasswordOk + +`func (o *GetCredentialResult) GetPasswordOk() (*string, bool)` + +GetPasswordOk returns a tuple with the Password field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPassword + +`func (o *GetCredentialResult) SetPassword(v string)` + +SetPassword sets Password field to given value. + +### HasPassword + +`func (o *GetCredentialResult) HasPassword() bool` + +HasPassword returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/GetExpensesResult.md b/publicCloud/docs/GetExpensesResult.md new file mode 100644 index 0000000..b3bde59 --- /dev/null +++ b/publicCloud/docs/GetExpensesResult.md @@ -0,0 +1,56 @@ +# GetExpensesResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Billing** | Pointer to [**Billing**](Billing.md) | | [optional] + +## Methods + +### NewGetExpensesResult + +`func NewGetExpensesResult() *GetExpensesResult` + +NewGetExpensesResult instantiates a new GetExpensesResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetExpensesResultWithDefaults + +`func NewGetExpensesResultWithDefaults() *GetExpensesResult` + +NewGetExpensesResultWithDefaults instantiates a new GetExpensesResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetBilling + +`func (o *GetExpensesResult) GetBilling() Billing` + +GetBilling returns the Billing field if non-nil, zero value otherwise. + +### GetBillingOk + +`func (o *GetExpensesResult) GetBillingOk() (*Billing, bool)` + +GetBillingOk returns a tuple with the Billing field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBilling + +`func (o *GetExpensesResult) SetBilling(v Billing)` + +SetBilling sets Billing field to given value. + +### HasBilling + +`func (o *GetExpensesResult) HasBilling() bool` + +HasBilling returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/GetFirewallRuleListResult.md b/publicCloud/docs/GetFirewallRuleListResult.md new file mode 100644 index 0000000..32fab15 --- /dev/null +++ b/publicCloud/docs/GetFirewallRuleListResult.md @@ -0,0 +1,82 @@ +# GetFirewallRuleListResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FirewallRules** | Pointer to [**[]FirewallRule**](FirewallRule.md) | | [optional] +**Metadata** | Pointer to [**Metadata**](Metadata.md) | | [optional] + +## Methods + +### NewGetFirewallRuleListResult + +`func NewGetFirewallRuleListResult() *GetFirewallRuleListResult` + +NewGetFirewallRuleListResult instantiates a new GetFirewallRuleListResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetFirewallRuleListResultWithDefaults + +`func NewGetFirewallRuleListResultWithDefaults() *GetFirewallRuleListResult` + +NewGetFirewallRuleListResultWithDefaults instantiates a new GetFirewallRuleListResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetFirewallRules + +`func (o *GetFirewallRuleListResult) GetFirewallRules() []FirewallRule` + +GetFirewallRules returns the FirewallRules field if non-nil, zero value otherwise. + +### GetFirewallRulesOk + +`func (o *GetFirewallRuleListResult) GetFirewallRulesOk() (*[]FirewallRule, bool)` + +GetFirewallRulesOk returns a tuple with the FirewallRules field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFirewallRules + +`func (o *GetFirewallRuleListResult) SetFirewallRules(v []FirewallRule)` + +SetFirewallRules sets FirewallRules field to given value. + +### HasFirewallRules + +`func (o *GetFirewallRuleListResult) HasFirewallRules() bool` + +HasFirewallRules returns a boolean if a field has been set. + +### GetMetadata + +`func (o *GetFirewallRuleListResult) GetMetadata() Metadata` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *GetFirewallRuleListResult) GetMetadataOk() (*Metadata, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *GetFirewallRuleListResult) SetMetadata(v Metadata)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *GetFirewallRuleListResult) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/GetInstanceListResult.md b/publicCloud/docs/GetInstanceListResult.md new file mode 100644 index 0000000..705e8a9 --- /dev/null +++ b/publicCloud/docs/GetInstanceListResult.md @@ -0,0 +1,82 @@ +# GetInstanceListResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Instances** | Pointer to [**[]Instance**](Instance.md) | | [optional] +**Metadata** | Pointer to [**Metadata**](Metadata.md) | | [optional] + +## Methods + +### NewGetInstanceListResult + +`func NewGetInstanceListResult() *GetInstanceListResult` + +NewGetInstanceListResult instantiates a new GetInstanceListResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetInstanceListResultWithDefaults + +`func NewGetInstanceListResultWithDefaults() *GetInstanceListResult` + +NewGetInstanceListResultWithDefaults instantiates a new GetInstanceListResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetInstances + +`func (o *GetInstanceListResult) GetInstances() []Instance` + +GetInstances returns the Instances field if non-nil, zero value otherwise. + +### GetInstancesOk + +`func (o *GetInstanceListResult) GetInstancesOk() (*[]Instance, bool)` + +GetInstancesOk returns a tuple with the Instances field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInstances + +`func (o *GetInstanceListResult) SetInstances(v []Instance)` + +SetInstances sets Instances field to given value. + +### HasInstances + +`func (o *GetInstanceListResult) HasInstances() bool` + +HasInstances returns a boolean if a field has been set. + +### GetMetadata + +`func (o *GetInstanceListResult) GetMetadata() Metadata` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *GetInstanceListResult) GetMetadataOk() (*Metadata, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *GetInstanceListResult) SetMetadata(v Metadata)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *GetInstanceListResult) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/GetInstanceResult.md b/publicCloud/docs/GetInstanceResult.md new file mode 100644 index 0000000..faaf586 --- /dev/null +++ b/publicCloud/docs/GetInstanceResult.md @@ -0,0 +1,586 @@ +# GetInstanceResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CustomerId** | Pointer to **string** | The customer ID who owns the instance | [optional] +**Id** | Pointer to **string** | The instance unique identifier | [optional] +**Resources** | Pointer to [**InstanceResources**](InstanceResources.md) | | [optional] +**Type** | Pointer to **string** | Instance type | [optional] +**Region** | Pointer to **string** | The region where the instance was launched into | [optional] +**Reference** | Pointer to **string** | The identifying name set to the instance | [optional] +**OperatingSystem** | Pointer to [**OperatingSystem**](OperatingSystem.md) | | [optional] +**State** | Pointer to [**InstanceState**](InstanceState.md) | | [optional] +**HasPublicIpV4** | Pointer to **bool** | | [optional] +**HasPrivateNetwork** | Pointer to **bool** | | [optional] +**RootDiskSize** | Pointer to **int32** | The root disk size as specified during its launch or update, in GB | [optional] +**Ips** | Pointer to [**[]Ip**](Ip.md) | | [optional] +**BillingFrequency** | Pointer to **int32** | | [optional] +**ContractTerm** | Pointer to **int32** | The contract commitment (in months) | [optional] +**ContractType** | Pointer to [**ContractType**](ContractType.md) | | [optional] +**ContractEndsAt** | Pointer to **time.Time** | | [optional] +**StartedAt** | Pointer to **time.Time** | Date and time when the instance was started for the first time, right after launching it | [optional] +**ContractRenewalsAt** | Pointer to **time.Time** | Date when the contract will be automatically renewed | [optional] +**ContractCreatedAt** | Pointer to **time.Time** | Date when the contract was created | [optional] +**Iso** | Pointer to [**NullableIso**](Iso.md) | | [optional] +**PrivateNetwork** | Pointer to [**PrivateNetwork**](PrivateNetwork.md) | | [optional] + +## Methods + +### NewGetInstanceResult + +`func NewGetInstanceResult() *GetInstanceResult` + +NewGetInstanceResult instantiates a new GetInstanceResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetInstanceResultWithDefaults + +`func NewGetInstanceResultWithDefaults() *GetInstanceResult` + +NewGetInstanceResultWithDefaults instantiates a new GetInstanceResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCustomerId + +`func (o *GetInstanceResult) GetCustomerId() string` + +GetCustomerId returns the CustomerId field if non-nil, zero value otherwise. + +### GetCustomerIdOk + +`func (o *GetInstanceResult) GetCustomerIdOk() (*string, bool)` + +GetCustomerIdOk returns a tuple with the CustomerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCustomerId + +`func (o *GetInstanceResult) SetCustomerId(v string)` + +SetCustomerId sets CustomerId field to given value. + +### HasCustomerId + +`func (o *GetInstanceResult) HasCustomerId() bool` + +HasCustomerId returns a boolean if a field has been set. + +### GetId + +`func (o *GetInstanceResult) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *GetInstanceResult) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *GetInstanceResult) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *GetInstanceResult) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetResources + +`func (o *GetInstanceResult) GetResources() InstanceResources` + +GetResources returns the Resources field if non-nil, zero value otherwise. + +### GetResourcesOk + +`func (o *GetInstanceResult) GetResourcesOk() (*InstanceResources, bool)` + +GetResourcesOk returns a tuple with the Resources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResources + +`func (o *GetInstanceResult) SetResources(v InstanceResources)` + +SetResources sets Resources field to given value. + +### HasResources + +`func (o *GetInstanceResult) HasResources() bool` + +HasResources returns a boolean if a field has been set. + +### GetType + +`func (o *GetInstanceResult) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *GetInstanceResult) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *GetInstanceResult) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *GetInstanceResult) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetRegion + +`func (o *GetInstanceResult) GetRegion() string` + +GetRegion returns the Region field if non-nil, zero value otherwise. + +### GetRegionOk + +`func (o *GetInstanceResult) GetRegionOk() (*string, bool)` + +GetRegionOk returns a tuple with the Region field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegion + +`func (o *GetInstanceResult) SetRegion(v string)` + +SetRegion sets Region field to given value. + +### HasRegion + +`func (o *GetInstanceResult) HasRegion() bool` + +HasRegion returns a boolean if a field has been set. + +### GetReference + +`func (o *GetInstanceResult) GetReference() string` + +GetReference returns the Reference field if non-nil, zero value otherwise. + +### GetReferenceOk + +`func (o *GetInstanceResult) GetReferenceOk() (*string, bool)` + +GetReferenceOk returns a tuple with the Reference field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReference + +`func (o *GetInstanceResult) SetReference(v string)` + +SetReference sets Reference field to given value. + +### HasReference + +`func (o *GetInstanceResult) HasReference() bool` + +HasReference returns a boolean if a field has been set. + +### GetOperatingSystem + +`func (o *GetInstanceResult) GetOperatingSystem() OperatingSystem` + +GetOperatingSystem returns the OperatingSystem field if non-nil, zero value otherwise. + +### GetOperatingSystemOk + +`func (o *GetInstanceResult) GetOperatingSystemOk() (*OperatingSystem, bool)` + +GetOperatingSystemOk returns a tuple with the OperatingSystem field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperatingSystem + +`func (o *GetInstanceResult) SetOperatingSystem(v OperatingSystem)` + +SetOperatingSystem sets OperatingSystem field to given value. + +### HasOperatingSystem + +`func (o *GetInstanceResult) HasOperatingSystem() bool` + +HasOperatingSystem returns a boolean if a field has been set. + +### GetState + +`func (o *GetInstanceResult) GetState() InstanceState` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *GetInstanceResult) GetStateOk() (*InstanceState, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *GetInstanceResult) SetState(v InstanceState)` + +SetState sets State field to given value. + +### HasState + +`func (o *GetInstanceResult) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetHasPublicIpV4 + +`func (o *GetInstanceResult) GetHasPublicIpV4() bool` + +GetHasPublicIpV4 returns the HasPublicIpV4 field if non-nil, zero value otherwise. + +### GetHasPublicIpV4Ok + +`func (o *GetInstanceResult) GetHasPublicIpV4Ok() (*bool, bool)` + +GetHasPublicIpV4Ok returns a tuple with the HasPublicIpV4 field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasPublicIpV4 + +`func (o *GetInstanceResult) SetHasPublicIpV4(v bool)` + +SetHasPublicIpV4 sets HasPublicIpV4 field to given value. + +### HasHasPublicIpV4 + +`func (o *GetInstanceResult) HasHasPublicIpV4() bool` + +HasHasPublicIpV4 returns a boolean if a field has been set. + +### GetHasPrivateNetwork + +`func (o *GetInstanceResult) GetHasPrivateNetwork() bool` + +GetHasPrivateNetwork returns the HasPrivateNetwork field if non-nil, zero value otherwise. + +### GetHasPrivateNetworkOk + +`func (o *GetInstanceResult) GetHasPrivateNetworkOk() (*bool, bool)` + +GetHasPrivateNetworkOk returns a tuple with the HasPrivateNetwork field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasPrivateNetwork + +`func (o *GetInstanceResult) SetHasPrivateNetwork(v bool)` + +SetHasPrivateNetwork sets HasPrivateNetwork field to given value. + +### HasHasPrivateNetwork + +`func (o *GetInstanceResult) HasHasPrivateNetwork() bool` + +HasHasPrivateNetwork returns a boolean if a field has been set. + +### GetRootDiskSize + +`func (o *GetInstanceResult) GetRootDiskSize() int32` + +GetRootDiskSize returns the RootDiskSize field if non-nil, zero value otherwise. + +### GetRootDiskSizeOk + +`func (o *GetInstanceResult) GetRootDiskSizeOk() (*int32, bool)` + +GetRootDiskSizeOk returns a tuple with the RootDiskSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRootDiskSize + +`func (o *GetInstanceResult) SetRootDiskSize(v int32)` + +SetRootDiskSize sets RootDiskSize field to given value. + +### HasRootDiskSize + +`func (o *GetInstanceResult) HasRootDiskSize() bool` + +HasRootDiskSize returns a boolean if a field has been set. + +### GetIps + +`func (o *GetInstanceResult) GetIps() []Ip` + +GetIps returns the Ips field if non-nil, zero value otherwise. + +### GetIpsOk + +`func (o *GetInstanceResult) GetIpsOk() (*[]Ip, bool)` + +GetIpsOk returns a tuple with the Ips field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIps + +`func (o *GetInstanceResult) SetIps(v []Ip)` + +SetIps sets Ips field to given value. + +### HasIps + +`func (o *GetInstanceResult) HasIps() bool` + +HasIps returns a boolean if a field has been set. + +### GetBillingFrequency + +`func (o *GetInstanceResult) GetBillingFrequency() int32` + +GetBillingFrequency returns the BillingFrequency field if non-nil, zero value otherwise. + +### GetBillingFrequencyOk + +`func (o *GetInstanceResult) GetBillingFrequencyOk() (*int32, bool)` + +GetBillingFrequencyOk returns a tuple with the BillingFrequency field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBillingFrequency + +`func (o *GetInstanceResult) SetBillingFrequency(v int32)` + +SetBillingFrequency sets BillingFrequency field to given value. + +### HasBillingFrequency + +`func (o *GetInstanceResult) HasBillingFrequency() bool` + +HasBillingFrequency returns a boolean if a field has been set. + +### GetContractTerm + +`func (o *GetInstanceResult) GetContractTerm() int32` + +GetContractTerm returns the ContractTerm field if non-nil, zero value otherwise. + +### GetContractTermOk + +`func (o *GetInstanceResult) GetContractTermOk() (*int32, bool)` + +GetContractTermOk returns a tuple with the ContractTerm field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContractTerm + +`func (o *GetInstanceResult) SetContractTerm(v int32)` + +SetContractTerm sets ContractTerm field to given value. + +### HasContractTerm + +`func (o *GetInstanceResult) HasContractTerm() bool` + +HasContractTerm returns a boolean if a field has been set. + +### GetContractType + +`func (o *GetInstanceResult) GetContractType() ContractType` + +GetContractType returns the ContractType field if non-nil, zero value otherwise. + +### GetContractTypeOk + +`func (o *GetInstanceResult) GetContractTypeOk() (*ContractType, bool)` + +GetContractTypeOk returns a tuple with the ContractType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContractType + +`func (o *GetInstanceResult) SetContractType(v ContractType)` + +SetContractType sets ContractType field to given value. + +### HasContractType + +`func (o *GetInstanceResult) HasContractType() bool` + +HasContractType returns a boolean if a field has been set. + +### GetContractEndsAt + +`func (o *GetInstanceResult) GetContractEndsAt() time.Time` + +GetContractEndsAt returns the ContractEndsAt field if non-nil, zero value otherwise. + +### GetContractEndsAtOk + +`func (o *GetInstanceResult) GetContractEndsAtOk() (*time.Time, bool)` + +GetContractEndsAtOk returns a tuple with the ContractEndsAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContractEndsAt + +`func (o *GetInstanceResult) SetContractEndsAt(v time.Time)` + +SetContractEndsAt sets ContractEndsAt field to given value. + +### HasContractEndsAt + +`func (o *GetInstanceResult) HasContractEndsAt() bool` + +HasContractEndsAt returns a boolean if a field has been set. + +### GetStartedAt + +`func (o *GetInstanceResult) GetStartedAt() time.Time` + +GetStartedAt returns the StartedAt field if non-nil, zero value otherwise. + +### GetStartedAtOk + +`func (o *GetInstanceResult) GetStartedAtOk() (*time.Time, bool)` + +GetStartedAtOk returns a tuple with the StartedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartedAt + +`func (o *GetInstanceResult) SetStartedAt(v time.Time)` + +SetStartedAt sets StartedAt field to given value. + +### HasStartedAt + +`func (o *GetInstanceResult) HasStartedAt() bool` + +HasStartedAt returns a boolean if a field has been set. + +### GetContractRenewalsAt + +`func (o *GetInstanceResult) GetContractRenewalsAt() time.Time` + +GetContractRenewalsAt returns the ContractRenewalsAt field if non-nil, zero value otherwise. + +### GetContractRenewalsAtOk + +`func (o *GetInstanceResult) GetContractRenewalsAtOk() (*time.Time, bool)` + +GetContractRenewalsAtOk returns a tuple with the ContractRenewalsAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContractRenewalsAt + +`func (o *GetInstanceResult) SetContractRenewalsAt(v time.Time)` + +SetContractRenewalsAt sets ContractRenewalsAt field to given value. + +### HasContractRenewalsAt + +`func (o *GetInstanceResult) HasContractRenewalsAt() bool` + +HasContractRenewalsAt returns a boolean if a field has been set. + +### GetContractCreatedAt + +`func (o *GetInstanceResult) GetContractCreatedAt() time.Time` + +GetContractCreatedAt returns the ContractCreatedAt field if non-nil, zero value otherwise. + +### GetContractCreatedAtOk + +`func (o *GetInstanceResult) GetContractCreatedAtOk() (*time.Time, bool)` + +GetContractCreatedAtOk returns a tuple with the ContractCreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContractCreatedAt + +`func (o *GetInstanceResult) SetContractCreatedAt(v time.Time)` + +SetContractCreatedAt sets ContractCreatedAt field to given value. + +### HasContractCreatedAt + +`func (o *GetInstanceResult) HasContractCreatedAt() bool` + +HasContractCreatedAt returns a boolean if a field has been set. + +### GetIso + +`func (o *GetInstanceResult) GetIso() Iso` + +GetIso returns the Iso field if non-nil, zero value otherwise. + +### GetIsoOk + +`func (o *GetInstanceResult) GetIsoOk() (*Iso, bool)` + +GetIsoOk returns a tuple with the Iso field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIso + +`func (o *GetInstanceResult) SetIso(v Iso)` + +SetIso sets Iso field to given value. + +### HasIso + +`func (o *GetInstanceResult) HasIso() bool` + +HasIso returns a boolean if a field has been set. + +### SetIsoNil + +`func (o *GetInstanceResult) SetIsoNil(b bool)` + + SetIsoNil sets the value for Iso to be an explicit nil + +### UnsetIso +`func (o *GetInstanceResult) UnsetIso()` + +UnsetIso ensures that no value is present for Iso, not even an explicit nil +### GetPrivateNetwork + +`func (o *GetInstanceResult) GetPrivateNetwork() PrivateNetwork` + +GetPrivateNetwork returns the PrivateNetwork field if non-nil, zero value otherwise. + +### GetPrivateNetworkOk + +`func (o *GetInstanceResult) GetPrivateNetworkOk() (*PrivateNetwork, bool)` + +GetPrivateNetworkOk returns a tuple with the PrivateNetwork field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateNetwork + +`func (o *GetInstanceResult) SetPrivateNetwork(v PrivateNetwork)` + +SetPrivateNetwork sets PrivateNetwork field to given value. + +### HasPrivateNetwork + +`func (o *GetInstanceResult) HasPrivateNetwork() bool` + +HasPrivateNetwork returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/GetInstanceTypeListResult.md b/publicCloud/docs/GetInstanceTypeListResult.md new file mode 100644 index 0000000..28c8683 --- /dev/null +++ b/publicCloud/docs/GetInstanceTypeListResult.md @@ -0,0 +1,82 @@ +# GetInstanceTypeListResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Metadata** | Pointer to [**Metadata**](Metadata.md) | | [optional] +**InstanceTypes** | Pointer to [**[]InstanceTypeDetails**](InstanceTypeDetails.md) | | [optional] + +## Methods + +### NewGetInstanceTypeListResult + +`func NewGetInstanceTypeListResult() *GetInstanceTypeListResult` + +NewGetInstanceTypeListResult instantiates a new GetInstanceTypeListResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetInstanceTypeListResultWithDefaults + +`func NewGetInstanceTypeListResultWithDefaults() *GetInstanceTypeListResult` + +NewGetInstanceTypeListResultWithDefaults instantiates a new GetInstanceTypeListResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMetadata + +`func (o *GetInstanceTypeListResult) GetMetadata() Metadata` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *GetInstanceTypeListResult) GetMetadataOk() (*Metadata, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *GetInstanceTypeListResult) SetMetadata(v Metadata)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *GetInstanceTypeListResult) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + +### GetInstanceTypes + +`func (o *GetInstanceTypeListResult) GetInstanceTypes() []InstanceTypeDetails` + +GetInstanceTypes returns the InstanceTypes field if non-nil, zero value otherwise. + +### GetInstanceTypesOk + +`func (o *GetInstanceTypeListResult) GetInstanceTypesOk() (*[]InstanceTypeDetails, bool)` + +GetInstanceTypesOk returns a tuple with the InstanceTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInstanceTypes + +`func (o *GetInstanceTypeListResult) SetInstanceTypes(v []InstanceTypeDetails)` + +SetInstanceTypes sets InstanceTypes field to given value. + +### HasInstanceTypes + +`func (o *GetInstanceTypeListResult) HasInstanceTypes() bool` + +HasInstanceTypes returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/GetIsoListResult.md b/publicCloud/docs/GetIsoListResult.md new file mode 100644 index 0000000..fcc2a6c --- /dev/null +++ b/publicCloud/docs/GetIsoListResult.md @@ -0,0 +1,82 @@ +# GetIsoListResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Isos** | Pointer to [**[]Iso**](Iso.md) | | [optional] +**Metadata** | Pointer to [**Metadata**](Metadata.md) | | [optional] + +## Methods + +### NewGetIsoListResult + +`func NewGetIsoListResult() *GetIsoListResult` + +NewGetIsoListResult instantiates a new GetIsoListResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetIsoListResultWithDefaults + +`func NewGetIsoListResultWithDefaults() *GetIsoListResult` + +NewGetIsoListResultWithDefaults instantiates a new GetIsoListResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetIsos + +`func (o *GetIsoListResult) GetIsos() []Iso` + +GetIsos returns the Isos field if non-nil, zero value otherwise. + +### GetIsosOk + +`func (o *GetIsoListResult) GetIsosOk() (*[]Iso, bool)` + +GetIsosOk returns a tuple with the Isos field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIsos + +`func (o *GetIsoListResult) SetIsos(v []Iso)` + +SetIsos sets Isos field to given value. + +### HasIsos + +`func (o *GetIsoListResult) HasIsos() bool` + +HasIsos returns a boolean if a field has been set. + +### GetMetadata + +`func (o *GetIsoListResult) GetMetadata() Metadata` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *GetIsoListResult) GetMetadataOk() (*Metadata, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *GetIsoListResult) SetMetadata(v Metadata)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *GetIsoListResult) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/GetMarketAppListResult.md b/publicCloud/docs/GetMarketAppListResult.md new file mode 100644 index 0000000..4567c2b --- /dev/null +++ b/publicCloud/docs/GetMarketAppListResult.md @@ -0,0 +1,82 @@ +# GetMarketAppListResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MarketApps** | Pointer to [**[]MarketApp**](MarketApp.md) | | [optional] +**Metadata** | Pointer to [**Metadata**](Metadata.md) | | [optional] + +## Methods + +### NewGetMarketAppListResult + +`func NewGetMarketAppListResult() *GetMarketAppListResult` + +NewGetMarketAppListResult instantiates a new GetMarketAppListResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetMarketAppListResultWithDefaults + +`func NewGetMarketAppListResultWithDefaults() *GetMarketAppListResult` + +NewGetMarketAppListResultWithDefaults instantiates a new GetMarketAppListResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMarketApps + +`func (o *GetMarketAppListResult) GetMarketApps() []MarketApp` + +GetMarketApps returns the MarketApps field if non-nil, zero value otherwise. + +### GetMarketAppsOk + +`func (o *GetMarketAppListResult) GetMarketAppsOk() (*[]MarketApp, bool)` + +GetMarketAppsOk returns a tuple with the MarketApps field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMarketApps + +`func (o *GetMarketAppListResult) SetMarketApps(v []MarketApp)` + +SetMarketApps sets MarketApps field to given value. + +### HasMarketApps + +`func (o *GetMarketAppListResult) HasMarketApps() bool` + +HasMarketApps returns a boolean if a field has been set. + +### GetMetadata + +`func (o *GetMarketAppListResult) GetMetadata() Metadata` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *GetMarketAppListResult) GetMetadataOk() (*Metadata, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *GetMarketAppListResult) SetMetadata(v Metadata)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *GetMarketAppListResult) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/GetOperatingSystemListResult.md b/publicCloud/docs/GetOperatingSystemListResult.md new file mode 100644 index 0000000..c2c329a --- /dev/null +++ b/publicCloud/docs/GetOperatingSystemListResult.md @@ -0,0 +1,82 @@ +# GetOperatingSystemListResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OperatingSystems** | Pointer to [**[]OperatingSystemDetail**](OperatingSystemDetail.md) | | [optional] +**Metadata** | Pointer to [**Metadata**](Metadata.md) | | [optional] + +## Methods + +### NewGetOperatingSystemListResult + +`func NewGetOperatingSystemListResult() *GetOperatingSystemListResult` + +NewGetOperatingSystemListResult instantiates a new GetOperatingSystemListResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetOperatingSystemListResultWithDefaults + +`func NewGetOperatingSystemListResultWithDefaults() *GetOperatingSystemListResult` + +NewGetOperatingSystemListResultWithDefaults instantiates a new GetOperatingSystemListResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetOperatingSystems + +`func (o *GetOperatingSystemListResult) GetOperatingSystems() []OperatingSystemDetail` + +GetOperatingSystems returns the OperatingSystems field if non-nil, zero value otherwise. + +### GetOperatingSystemsOk + +`func (o *GetOperatingSystemListResult) GetOperatingSystemsOk() (*[]OperatingSystemDetail, bool)` + +GetOperatingSystemsOk returns a tuple with the OperatingSystems field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperatingSystems + +`func (o *GetOperatingSystemListResult) SetOperatingSystems(v []OperatingSystemDetail)` + +SetOperatingSystems sets OperatingSystems field to given value. + +### HasOperatingSystems + +`func (o *GetOperatingSystemListResult) HasOperatingSystems() bool` + +HasOperatingSystems returns a boolean if a field has been set. + +### GetMetadata + +`func (o *GetOperatingSystemListResult) GetMetadata() Metadata` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *GetOperatingSystemListResult) GetMetadataOk() (*Metadata, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *GetOperatingSystemListResult) SetMetadata(v Metadata)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *GetOperatingSystemListResult) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/GetRegionListResult.md b/publicCloud/docs/GetRegionListResult.md new file mode 100644 index 0000000..60cc40b --- /dev/null +++ b/publicCloud/docs/GetRegionListResult.md @@ -0,0 +1,82 @@ +# GetRegionListResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Regions** | Pointer to [**[]Region**](Region.md) | | [optional] +**Metadata** | Pointer to [**Metadata**](Metadata.md) | | [optional] + +## Methods + +### NewGetRegionListResult + +`func NewGetRegionListResult() *GetRegionListResult` + +NewGetRegionListResult instantiates a new GetRegionListResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetRegionListResultWithDefaults + +`func NewGetRegionListResultWithDefaults() *GetRegionListResult` + +NewGetRegionListResultWithDefaults instantiates a new GetRegionListResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetRegions + +`func (o *GetRegionListResult) GetRegions() []Region` + +GetRegions returns the Regions field if non-nil, zero value otherwise. + +### GetRegionsOk + +`func (o *GetRegionListResult) GetRegionsOk() (*[]Region, bool)` + +GetRegionsOk returns a tuple with the Regions field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegions + +`func (o *GetRegionListResult) SetRegions(v []Region)` + +SetRegions sets Regions field to given value. + +### HasRegions + +`func (o *GetRegionListResult) HasRegions() bool` + +HasRegions returns a boolean if a field has been set. + +### GetMetadata + +`func (o *GetRegionListResult) GetMetadata() Metadata` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *GetRegionListResult) GetMetadataOk() (*Metadata, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *GetRegionListResult) SetMetadata(v Metadata)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *GetRegionListResult) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/GetUpdateInstanceTypeListResult.md b/publicCloud/docs/GetUpdateInstanceTypeListResult.md new file mode 100644 index 0000000..d5c67aa --- /dev/null +++ b/publicCloud/docs/GetUpdateInstanceTypeListResult.md @@ -0,0 +1,82 @@ +# GetUpdateInstanceTypeListResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Metadata** | Pointer to [**Metadata**](Metadata.md) | | [optional] +**InstanceTypes** | Pointer to [**[]UpdateInstanceType**](UpdateInstanceType.md) | | [optional] + +## Methods + +### NewGetUpdateInstanceTypeListResult + +`func NewGetUpdateInstanceTypeListResult() *GetUpdateInstanceTypeListResult` + +NewGetUpdateInstanceTypeListResult instantiates a new GetUpdateInstanceTypeListResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewGetUpdateInstanceTypeListResultWithDefaults + +`func NewGetUpdateInstanceTypeListResultWithDefaults() *GetUpdateInstanceTypeListResult` + +NewGetUpdateInstanceTypeListResultWithDefaults instantiates a new GetUpdateInstanceTypeListResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetMetadata + +`func (o *GetUpdateInstanceTypeListResult) GetMetadata() Metadata` + +GetMetadata returns the Metadata field if non-nil, zero value otherwise. + +### GetMetadataOk + +`func (o *GetUpdateInstanceTypeListResult) GetMetadataOk() (*Metadata, bool)` + +GetMetadataOk returns a tuple with the Metadata field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMetadata + +`func (o *GetUpdateInstanceTypeListResult) SetMetadata(v Metadata)` + +SetMetadata sets Metadata field to given value. + +### HasMetadata + +`func (o *GetUpdateInstanceTypeListResult) HasMetadata() bool` + +HasMetadata returns a boolean if a field has been set. + +### GetInstanceTypes + +`func (o *GetUpdateInstanceTypeListResult) GetInstanceTypes() []UpdateInstanceType` + +GetInstanceTypes returns the InstanceTypes field if non-nil, zero value otherwise. + +### GetInstanceTypesOk + +`func (o *GetUpdateInstanceTypeListResult) GetInstanceTypesOk() (*[]UpdateInstanceType, bool)` + +GetInstanceTypesOk returns a tuple with the InstanceTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetInstanceTypes + +`func (o *GetUpdateInstanceTypeListResult) SetInstanceTypes(v []UpdateInstanceType)` + +SetInstanceTypes sets InstanceTypes field to given value. + +### HasInstanceTypes + +`func (o *GetUpdateInstanceTypeListResult) HasInstanceTypes() bool` + +HasInstanceTypes returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/IcmpFirewallRule.md b/publicCloud/docs/IcmpFirewallRule.md new file mode 100644 index 0000000..8c6e269 --- /dev/null +++ b/publicCloud/docs/IcmpFirewallRule.md @@ -0,0 +1,258 @@ +# IcmpFirewallRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | | [optional] +**Name** | Pointer to **NullableString** | | [optional] +**Cidr** | Pointer to **string** | | [optional] +**Protocol** | Pointer to **string** | | [optional] +**StartPort** | Pointer to **NullableInt32** | | [optional] +**EndPort** | Pointer to **NullableInt32** | | [optional] +**IcmpType** | **int32** | | +**IcmpCode** | **int32** | | + +## Methods + +### NewIcmpFirewallRule + +`func NewIcmpFirewallRule(icmpType int32, icmpCode int32, ) *IcmpFirewallRule` + +NewIcmpFirewallRule instantiates a new IcmpFirewallRule object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewIcmpFirewallRuleWithDefaults + +`func NewIcmpFirewallRuleWithDefaults() *IcmpFirewallRule` + +NewIcmpFirewallRuleWithDefaults instantiates a new IcmpFirewallRule object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *IcmpFirewallRule) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *IcmpFirewallRule) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *IcmpFirewallRule) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *IcmpFirewallRule) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *IcmpFirewallRule) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *IcmpFirewallRule) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *IcmpFirewallRule) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *IcmpFirewallRule) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *IcmpFirewallRule) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *IcmpFirewallRule) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCidr + +`func (o *IcmpFirewallRule) GetCidr() string` + +GetCidr returns the Cidr field if non-nil, zero value otherwise. + +### GetCidrOk + +`func (o *IcmpFirewallRule) GetCidrOk() (*string, bool)` + +GetCidrOk returns a tuple with the Cidr field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCidr + +`func (o *IcmpFirewallRule) SetCidr(v string)` + +SetCidr sets Cidr field to given value. + +### HasCidr + +`func (o *IcmpFirewallRule) HasCidr() bool` + +HasCidr returns a boolean if a field has been set. + +### GetProtocol + +`func (o *IcmpFirewallRule) GetProtocol() string` + +GetProtocol returns the Protocol field if non-nil, zero value otherwise. + +### GetProtocolOk + +`func (o *IcmpFirewallRule) GetProtocolOk() (*string, bool)` + +GetProtocolOk returns a tuple with the Protocol field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProtocol + +`func (o *IcmpFirewallRule) SetProtocol(v string)` + +SetProtocol sets Protocol field to given value. + +### HasProtocol + +`func (o *IcmpFirewallRule) HasProtocol() bool` + +HasProtocol returns a boolean if a field has been set. + +### GetStartPort + +`func (o *IcmpFirewallRule) GetStartPort() int32` + +GetStartPort returns the StartPort field if non-nil, zero value otherwise. + +### GetStartPortOk + +`func (o *IcmpFirewallRule) GetStartPortOk() (*int32, bool)` + +GetStartPortOk returns a tuple with the StartPort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartPort + +`func (o *IcmpFirewallRule) SetStartPort(v int32)` + +SetStartPort sets StartPort field to given value. + +### HasStartPort + +`func (o *IcmpFirewallRule) HasStartPort() bool` + +HasStartPort returns a boolean if a field has been set. + +### SetStartPortNil + +`func (o *IcmpFirewallRule) SetStartPortNil(b bool)` + + SetStartPortNil sets the value for StartPort to be an explicit nil + +### UnsetStartPort +`func (o *IcmpFirewallRule) UnsetStartPort()` + +UnsetStartPort ensures that no value is present for StartPort, not even an explicit nil +### GetEndPort + +`func (o *IcmpFirewallRule) GetEndPort() int32` + +GetEndPort returns the EndPort field if non-nil, zero value otherwise. + +### GetEndPortOk + +`func (o *IcmpFirewallRule) GetEndPortOk() (*int32, bool)` + +GetEndPortOk returns a tuple with the EndPort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndPort + +`func (o *IcmpFirewallRule) SetEndPort(v int32)` + +SetEndPort sets EndPort field to given value. + +### HasEndPort + +`func (o *IcmpFirewallRule) HasEndPort() bool` + +HasEndPort returns a boolean if a field has been set. + +### SetEndPortNil + +`func (o *IcmpFirewallRule) SetEndPortNil(b bool)` + + SetEndPortNil sets the value for EndPort to be an explicit nil + +### UnsetEndPort +`func (o *IcmpFirewallRule) UnsetEndPort()` + +UnsetEndPort ensures that no value is present for EndPort, not even an explicit nil +### GetIcmpType + +`func (o *IcmpFirewallRule) GetIcmpType() int32` + +GetIcmpType returns the IcmpType field if non-nil, zero value otherwise. + +### GetIcmpTypeOk + +`func (o *IcmpFirewallRule) GetIcmpTypeOk() (*int32, bool)` + +GetIcmpTypeOk returns a tuple with the IcmpType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIcmpType + +`func (o *IcmpFirewallRule) SetIcmpType(v int32)` + +SetIcmpType sets IcmpType field to given value. + + +### GetIcmpCode + +`func (o *IcmpFirewallRule) GetIcmpCode() int32` + +GetIcmpCode returns the IcmpCode field if non-nil, zero value otherwise. + +### GetIcmpCodeOk + +`func (o *IcmpFirewallRule) GetIcmpCodeOk() (*int32, bool)` + +GetIcmpCodeOk returns a tuple with the IcmpCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIcmpCode + +`func (o *IcmpFirewallRule) SetIcmpCode(v int32)` + +SetIcmpCode sets IcmpCode field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/Instance.md b/publicCloud/docs/Instance.md new file mode 100644 index 0000000..efffaf5 --- /dev/null +++ b/publicCloud/docs/Instance.md @@ -0,0 +1,524 @@ +# Instance + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CustomerId** | Pointer to **string** | The customer ID who owns the instance | [optional] +**Id** | Pointer to **string** | The instance unique identifier | [optional] +**Resources** | Pointer to [**InstanceResources**](InstanceResources.md) | | [optional] +**Region** | Pointer to **string** | The region where the instance was launched into | [optional] +**Reference** | Pointer to **string** | The identifying name set to the instance | [optional] +**OperatingSystem** | Pointer to [**OperatingSystem**](OperatingSystem.md) | | [optional] +**State** | Pointer to [**InstanceState**](InstanceState.md) | | [optional] +**HasPublicIpV4** | Pointer to **bool** | | [optional] +**HasPrivateNetwork** | Pointer to **bool** | | [optional] +**Type** | Pointer to **string** | Instance type | [optional] +**RootDiskSize** | Pointer to **int32** | The root disk size as specified during its launch or update, in GB | [optional] +**Ips** | Pointer to [**[]Ip**](Ip.md) | | [optional] +**BillingFrequency** | Pointer to **int32** | | [optional] +**ContractTerm** | Pointer to **int32** | The contract commitment (in months) | [optional] +**ContractType** | Pointer to [**ContractType**](ContractType.md) | | [optional] +**ContractEndsAt** | Pointer to **time.Time** | | [optional] +**StartedAt** | Pointer to **time.Time** | Date and time when the instance was started for the first time, right after launching it | [optional] +**ContractRenewalsAt** | Pointer to **time.Time** | Date when the contract will be automatically renewed | [optional] +**ContractCreatedAt** | Pointer to **time.Time** | Date when the contract was created | [optional] + +## Methods + +### NewInstance + +`func NewInstance() *Instance` + +NewInstance instantiates a new Instance object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewInstanceWithDefaults + +`func NewInstanceWithDefaults() *Instance` + +NewInstanceWithDefaults instantiates a new Instance object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCustomerId + +`func (o *Instance) GetCustomerId() string` + +GetCustomerId returns the CustomerId field if non-nil, zero value otherwise. + +### GetCustomerIdOk + +`func (o *Instance) GetCustomerIdOk() (*string, bool)` + +GetCustomerIdOk returns a tuple with the CustomerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCustomerId + +`func (o *Instance) SetCustomerId(v string)` + +SetCustomerId sets CustomerId field to given value. + +### HasCustomerId + +`func (o *Instance) HasCustomerId() bool` + +HasCustomerId returns a boolean if a field has been set. + +### GetId + +`func (o *Instance) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Instance) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Instance) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Instance) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetResources + +`func (o *Instance) GetResources() InstanceResources` + +GetResources returns the Resources field if non-nil, zero value otherwise. + +### GetResourcesOk + +`func (o *Instance) GetResourcesOk() (*InstanceResources, bool)` + +GetResourcesOk returns a tuple with the Resources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResources + +`func (o *Instance) SetResources(v InstanceResources)` + +SetResources sets Resources field to given value. + +### HasResources + +`func (o *Instance) HasResources() bool` + +HasResources returns a boolean if a field has been set. + +### GetRegion + +`func (o *Instance) GetRegion() string` + +GetRegion returns the Region field if non-nil, zero value otherwise. + +### GetRegionOk + +`func (o *Instance) GetRegionOk() (*string, bool)` + +GetRegionOk returns a tuple with the Region field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegion + +`func (o *Instance) SetRegion(v string)` + +SetRegion sets Region field to given value. + +### HasRegion + +`func (o *Instance) HasRegion() bool` + +HasRegion returns a boolean if a field has been set. + +### GetReference + +`func (o *Instance) GetReference() string` + +GetReference returns the Reference field if non-nil, zero value otherwise. + +### GetReferenceOk + +`func (o *Instance) GetReferenceOk() (*string, bool)` + +GetReferenceOk returns a tuple with the Reference field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReference + +`func (o *Instance) SetReference(v string)` + +SetReference sets Reference field to given value. + +### HasReference + +`func (o *Instance) HasReference() bool` + +HasReference returns a boolean if a field has been set. + +### GetOperatingSystem + +`func (o *Instance) GetOperatingSystem() OperatingSystem` + +GetOperatingSystem returns the OperatingSystem field if non-nil, zero value otherwise. + +### GetOperatingSystemOk + +`func (o *Instance) GetOperatingSystemOk() (*OperatingSystem, bool)` + +GetOperatingSystemOk returns a tuple with the OperatingSystem field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperatingSystem + +`func (o *Instance) SetOperatingSystem(v OperatingSystem)` + +SetOperatingSystem sets OperatingSystem field to given value. + +### HasOperatingSystem + +`func (o *Instance) HasOperatingSystem() bool` + +HasOperatingSystem returns a boolean if a field has been set. + +### GetState + +`func (o *Instance) GetState() InstanceState` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *Instance) GetStateOk() (*InstanceState, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *Instance) SetState(v InstanceState)` + +SetState sets State field to given value. + +### HasState + +`func (o *Instance) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetHasPublicIpV4 + +`func (o *Instance) GetHasPublicIpV4() bool` + +GetHasPublicIpV4 returns the HasPublicIpV4 field if non-nil, zero value otherwise. + +### GetHasPublicIpV4Ok + +`func (o *Instance) GetHasPublicIpV4Ok() (*bool, bool)` + +GetHasPublicIpV4Ok returns a tuple with the HasPublicIpV4 field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasPublicIpV4 + +`func (o *Instance) SetHasPublicIpV4(v bool)` + +SetHasPublicIpV4 sets HasPublicIpV4 field to given value. + +### HasHasPublicIpV4 + +`func (o *Instance) HasHasPublicIpV4() bool` + +HasHasPublicIpV4 returns a boolean if a field has been set. + +### GetHasPrivateNetwork + +`func (o *Instance) GetHasPrivateNetwork() bool` + +GetHasPrivateNetwork returns the HasPrivateNetwork field if non-nil, zero value otherwise. + +### GetHasPrivateNetworkOk + +`func (o *Instance) GetHasPrivateNetworkOk() (*bool, bool)` + +GetHasPrivateNetworkOk returns a tuple with the HasPrivateNetwork field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHasPrivateNetwork + +`func (o *Instance) SetHasPrivateNetwork(v bool)` + +SetHasPrivateNetwork sets HasPrivateNetwork field to given value. + +### HasHasPrivateNetwork + +`func (o *Instance) HasHasPrivateNetwork() bool` + +HasHasPrivateNetwork returns a boolean if a field has been set. + +### GetType + +`func (o *Instance) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *Instance) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *Instance) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *Instance) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetRootDiskSize + +`func (o *Instance) GetRootDiskSize() int32` + +GetRootDiskSize returns the RootDiskSize field if non-nil, zero value otherwise. + +### GetRootDiskSizeOk + +`func (o *Instance) GetRootDiskSizeOk() (*int32, bool)` + +GetRootDiskSizeOk returns a tuple with the RootDiskSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRootDiskSize + +`func (o *Instance) SetRootDiskSize(v int32)` + +SetRootDiskSize sets RootDiskSize field to given value. + +### HasRootDiskSize + +`func (o *Instance) HasRootDiskSize() bool` + +HasRootDiskSize returns a boolean if a field has been set. + +### GetIps + +`func (o *Instance) GetIps() []Ip` + +GetIps returns the Ips field if non-nil, zero value otherwise. + +### GetIpsOk + +`func (o *Instance) GetIpsOk() (*[]Ip, bool)` + +GetIpsOk returns a tuple with the Ips field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIps + +`func (o *Instance) SetIps(v []Ip)` + +SetIps sets Ips field to given value. + +### HasIps + +`func (o *Instance) HasIps() bool` + +HasIps returns a boolean if a field has been set. + +### GetBillingFrequency + +`func (o *Instance) GetBillingFrequency() int32` + +GetBillingFrequency returns the BillingFrequency field if non-nil, zero value otherwise. + +### GetBillingFrequencyOk + +`func (o *Instance) GetBillingFrequencyOk() (*int32, bool)` + +GetBillingFrequencyOk returns a tuple with the BillingFrequency field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBillingFrequency + +`func (o *Instance) SetBillingFrequency(v int32)` + +SetBillingFrequency sets BillingFrequency field to given value. + +### HasBillingFrequency + +`func (o *Instance) HasBillingFrequency() bool` + +HasBillingFrequency returns a boolean if a field has been set. + +### GetContractTerm + +`func (o *Instance) GetContractTerm() int32` + +GetContractTerm returns the ContractTerm field if non-nil, zero value otherwise. + +### GetContractTermOk + +`func (o *Instance) GetContractTermOk() (*int32, bool)` + +GetContractTermOk returns a tuple with the ContractTerm field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContractTerm + +`func (o *Instance) SetContractTerm(v int32)` + +SetContractTerm sets ContractTerm field to given value. + +### HasContractTerm + +`func (o *Instance) HasContractTerm() bool` + +HasContractTerm returns a boolean if a field has been set. + +### GetContractType + +`func (o *Instance) GetContractType() ContractType` + +GetContractType returns the ContractType field if non-nil, zero value otherwise. + +### GetContractTypeOk + +`func (o *Instance) GetContractTypeOk() (*ContractType, bool)` + +GetContractTypeOk returns a tuple with the ContractType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContractType + +`func (o *Instance) SetContractType(v ContractType)` + +SetContractType sets ContractType field to given value. + +### HasContractType + +`func (o *Instance) HasContractType() bool` + +HasContractType returns a boolean if a field has been set. + +### GetContractEndsAt + +`func (o *Instance) GetContractEndsAt() time.Time` + +GetContractEndsAt returns the ContractEndsAt field if non-nil, zero value otherwise. + +### GetContractEndsAtOk + +`func (o *Instance) GetContractEndsAtOk() (*time.Time, bool)` + +GetContractEndsAtOk returns a tuple with the ContractEndsAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContractEndsAt + +`func (o *Instance) SetContractEndsAt(v time.Time)` + +SetContractEndsAt sets ContractEndsAt field to given value. + +### HasContractEndsAt + +`func (o *Instance) HasContractEndsAt() bool` + +HasContractEndsAt returns a boolean if a field has been set. + +### GetStartedAt + +`func (o *Instance) GetStartedAt() time.Time` + +GetStartedAt returns the StartedAt field if non-nil, zero value otherwise. + +### GetStartedAtOk + +`func (o *Instance) GetStartedAtOk() (*time.Time, bool)` + +GetStartedAtOk returns a tuple with the StartedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartedAt + +`func (o *Instance) SetStartedAt(v time.Time)` + +SetStartedAt sets StartedAt field to given value. + +### HasStartedAt + +`func (o *Instance) HasStartedAt() bool` + +HasStartedAt returns a boolean if a field has been set. + +### GetContractRenewalsAt + +`func (o *Instance) GetContractRenewalsAt() time.Time` + +GetContractRenewalsAt returns the ContractRenewalsAt field if non-nil, zero value otherwise. + +### GetContractRenewalsAtOk + +`func (o *Instance) GetContractRenewalsAtOk() (*time.Time, bool)` + +GetContractRenewalsAtOk returns a tuple with the ContractRenewalsAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContractRenewalsAt + +`func (o *Instance) SetContractRenewalsAt(v time.Time)` + +SetContractRenewalsAt sets ContractRenewalsAt field to given value. + +### HasContractRenewalsAt + +`func (o *Instance) HasContractRenewalsAt() bool` + +HasContractRenewalsAt returns a boolean if a field has been set. + +### GetContractCreatedAt + +`func (o *Instance) GetContractCreatedAt() time.Time` + +GetContractCreatedAt returns the ContractCreatedAt field if non-nil, zero value otherwise. + +### GetContractCreatedAtOk + +`func (o *Instance) GetContractCreatedAtOk() (*time.Time, bool)` + +GetContractCreatedAtOk returns a tuple with the ContractCreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContractCreatedAt + +`func (o *Instance) SetContractCreatedAt(v time.Time)` + +SetContractCreatedAt sets ContractCreatedAt field to given value. + +### HasContractCreatedAt + +`func (o *Instance) HasContractCreatedAt() bool` + +HasContractCreatedAt returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/InstanceResources.md b/publicCloud/docs/InstanceResources.md new file mode 100644 index 0000000..805c19e --- /dev/null +++ b/publicCloud/docs/InstanceResources.md @@ -0,0 +1,134 @@ +# InstanceResources + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Cpu** | Pointer to [**Cpu**](Cpu.md) | | [optional] +**Memory** | Pointer to [**Memory**](Memory.md) | | [optional] +**PublicNetworkSpeed** | Pointer to [**PublicNetworkSpeed**](PublicNetworkSpeed.md) | | [optional] +**PrivateNetworkSpeed** | Pointer to [**PrivateNetworkSpeed**](PrivateNetworkSpeed.md) | | [optional] + +## Methods + +### NewInstanceResources + +`func NewInstanceResources() *InstanceResources` + +NewInstanceResources instantiates a new InstanceResources object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewInstanceResourcesWithDefaults + +`func NewInstanceResourcesWithDefaults() *InstanceResources` + +NewInstanceResourcesWithDefaults instantiates a new InstanceResources object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCpu + +`func (o *InstanceResources) GetCpu() Cpu` + +GetCpu returns the Cpu field if non-nil, zero value otherwise. + +### GetCpuOk + +`func (o *InstanceResources) GetCpuOk() (*Cpu, bool)` + +GetCpuOk returns a tuple with the Cpu field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCpu + +`func (o *InstanceResources) SetCpu(v Cpu)` + +SetCpu sets Cpu field to given value. + +### HasCpu + +`func (o *InstanceResources) HasCpu() bool` + +HasCpu returns a boolean if a field has been set. + +### GetMemory + +`func (o *InstanceResources) GetMemory() Memory` + +GetMemory returns the Memory field if non-nil, zero value otherwise. + +### GetMemoryOk + +`func (o *InstanceResources) GetMemoryOk() (*Memory, bool)` + +GetMemoryOk returns a tuple with the Memory field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMemory + +`func (o *InstanceResources) SetMemory(v Memory)` + +SetMemory sets Memory field to given value. + +### HasMemory + +`func (o *InstanceResources) HasMemory() bool` + +HasMemory returns a boolean if a field has been set. + +### GetPublicNetworkSpeed + +`func (o *InstanceResources) GetPublicNetworkSpeed() PublicNetworkSpeed` + +GetPublicNetworkSpeed returns the PublicNetworkSpeed field if non-nil, zero value otherwise. + +### GetPublicNetworkSpeedOk + +`func (o *InstanceResources) GetPublicNetworkSpeedOk() (*PublicNetworkSpeed, bool)` + +GetPublicNetworkSpeedOk returns a tuple with the PublicNetworkSpeed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicNetworkSpeed + +`func (o *InstanceResources) SetPublicNetworkSpeed(v PublicNetworkSpeed)` + +SetPublicNetworkSpeed sets PublicNetworkSpeed field to given value. + +### HasPublicNetworkSpeed + +`func (o *InstanceResources) HasPublicNetworkSpeed() bool` + +HasPublicNetworkSpeed returns a boolean if a field has been set. + +### GetPrivateNetworkSpeed + +`func (o *InstanceResources) GetPrivateNetworkSpeed() PrivateNetworkSpeed` + +GetPrivateNetworkSpeed returns the PrivateNetworkSpeed field if non-nil, zero value otherwise. + +### GetPrivateNetworkSpeedOk + +`func (o *InstanceResources) GetPrivateNetworkSpeedOk() (*PrivateNetworkSpeed, bool)` + +GetPrivateNetworkSpeedOk returns a tuple with the PrivateNetworkSpeed field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateNetworkSpeed + +`func (o *InstanceResources) SetPrivateNetworkSpeed(v PrivateNetworkSpeed)` + +SetPrivateNetworkSpeed sets PrivateNetworkSpeed field to given value. + +### HasPrivateNetworkSpeed + +`func (o *InstanceResources) HasPrivateNetworkSpeed() bool` + +HasPrivateNetworkSpeed returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/InstanceState.md b/publicCloud/docs/InstanceState.md new file mode 100644 index 0000000..3449e23 --- /dev/null +++ b/publicCloud/docs/InstanceState.md @@ -0,0 +1,19 @@ +# InstanceState + +## Enum + + +* `RUNNING` (value: `"RUNNING"`) + +* `STOPPED` (value: `"STOPPED"`) + +* `CREATING` (value: `"CREATING"`) + +* `DESTROYING` (value: `"DESTROYING"`) + +* `DESTROYED` (value: `"DESTROYED"`) + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/InstanceTypeDetails.md b/publicCloud/docs/InstanceTypeDetails.md new file mode 100644 index 0000000..c71953b --- /dev/null +++ b/publicCloud/docs/InstanceTypeDetails.md @@ -0,0 +1,144 @@ +# InstanceTypeDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Instance type's name | [optional] +**Resources** | Pointer to [**InstanceResources**](InstanceResources.md) | | [optional] +**StorageTypes** | Pointer to **[]string** | The supported storage types for the instance type | [optional] +**Prices** | Pointer to [**Price**](Price.md) | | [optional] + +## Methods + +### NewInstanceTypeDetails + +`func NewInstanceTypeDetails() *InstanceTypeDetails` + +NewInstanceTypeDetails instantiates a new InstanceTypeDetails object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewInstanceTypeDetailsWithDefaults + +`func NewInstanceTypeDetailsWithDefaults() *InstanceTypeDetails` + +NewInstanceTypeDetailsWithDefaults instantiates a new InstanceTypeDetails object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetName + +`func (o *InstanceTypeDetails) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *InstanceTypeDetails) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *InstanceTypeDetails) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *InstanceTypeDetails) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetResources + +`func (o *InstanceTypeDetails) GetResources() InstanceResources` + +GetResources returns the Resources field if non-nil, zero value otherwise. + +### GetResourcesOk + +`func (o *InstanceTypeDetails) GetResourcesOk() (*InstanceResources, bool)` + +GetResourcesOk returns a tuple with the Resources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResources + +`func (o *InstanceTypeDetails) SetResources(v InstanceResources)` + +SetResources sets Resources field to given value. + +### HasResources + +`func (o *InstanceTypeDetails) HasResources() bool` + +HasResources returns a boolean if a field has been set. + +### GetStorageTypes + +`func (o *InstanceTypeDetails) GetStorageTypes() []string` + +GetStorageTypes returns the StorageTypes field if non-nil, zero value otherwise. + +### GetStorageTypesOk + +`func (o *InstanceTypeDetails) GetStorageTypesOk() (*[]string, bool)` + +GetStorageTypesOk returns a tuple with the StorageTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStorageTypes + +`func (o *InstanceTypeDetails) SetStorageTypes(v []string)` + +SetStorageTypes sets StorageTypes field to given value. + +### HasStorageTypes + +`func (o *InstanceTypeDetails) HasStorageTypes() bool` + +HasStorageTypes returns a boolean if a field has been set. + +### SetStorageTypesNil + +`func (o *InstanceTypeDetails) SetStorageTypesNil(b bool)` + + SetStorageTypesNil sets the value for StorageTypes to be an explicit nil + +### UnsetStorageTypes +`func (o *InstanceTypeDetails) UnsetStorageTypes()` + +UnsetStorageTypes ensures that no value is present for StorageTypes, not even an explicit nil +### GetPrices + +`func (o *InstanceTypeDetails) GetPrices() Price` + +GetPrices returns the Prices field if non-nil, zero value otherwise. + +### GetPricesOk + +`func (o *InstanceTypeDetails) GetPricesOk() (*Price, bool)` + +GetPricesOk returns a tuple with the Prices field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrices + +`func (o *InstanceTypeDetails) SetPrices(v Price)` + +SetPrices sets Prices field to given value. + +### HasPrices + +`func (o *InstanceTypeDetails) HasPrices() bool` + +HasPrices returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/Ip.md b/publicCloud/docs/Ip.md new file mode 100644 index 0000000..682d5c4 --- /dev/null +++ b/publicCloud/docs/Ip.md @@ -0,0 +1,222 @@ +# Ip + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ip** | Pointer to **string** | Ip Address | [optional] +**PrefixLength** | Pointer to **string** | The number of leading bits in the IP address | [optional] +**Version** | Pointer to **int32** | Ip version | [optional] +**NullRouted** | Pointer to **bool** | Whether or not the IP has been nulled | [optional] +**MainIp** | Pointer to **bool** | | [optional] +**ReverseLookup** | Pointer to **NullableString** | | [optional] +**Ddos** | Pointer to [**Ddos**](Ddos.md) | | [optional] + +## Methods + +### NewIp + +`func NewIp() *Ip` + +NewIp instantiates a new Ip object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewIpWithDefaults + +`func NewIpWithDefaults() *Ip` + +NewIpWithDefaults instantiates a new Ip object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetIp + +`func (o *Ip) GetIp() string` + +GetIp returns the Ip field if non-nil, zero value otherwise. + +### GetIpOk + +`func (o *Ip) GetIpOk() (*string, bool)` + +GetIpOk returns a tuple with the Ip field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIp + +`func (o *Ip) SetIp(v string)` + +SetIp sets Ip field to given value. + +### HasIp + +`func (o *Ip) HasIp() bool` + +HasIp returns a boolean if a field has been set. + +### GetPrefixLength + +`func (o *Ip) GetPrefixLength() string` + +GetPrefixLength returns the PrefixLength field if non-nil, zero value otherwise. + +### GetPrefixLengthOk + +`func (o *Ip) GetPrefixLengthOk() (*string, bool)` + +GetPrefixLengthOk returns a tuple with the PrefixLength field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrefixLength + +`func (o *Ip) SetPrefixLength(v string)` + +SetPrefixLength sets PrefixLength field to given value. + +### HasPrefixLength + +`func (o *Ip) HasPrefixLength() bool` + +HasPrefixLength returns a boolean if a field has been set. + +### GetVersion + +`func (o *Ip) GetVersion() int32` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *Ip) GetVersionOk() (*int32, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *Ip) SetVersion(v int32)` + +SetVersion sets Version field to given value. + +### HasVersion + +`func (o *Ip) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + +### GetNullRouted + +`func (o *Ip) GetNullRouted() bool` + +GetNullRouted returns the NullRouted field if non-nil, zero value otherwise. + +### GetNullRoutedOk + +`func (o *Ip) GetNullRoutedOk() (*bool, bool)` + +GetNullRoutedOk returns a tuple with the NullRouted field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetNullRouted + +`func (o *Ip) SetNullRouted(v bool)` + +SetNullRouted sets NullRouted field to given value. + +### HasNullRouted + +`func (o *Ip) HasNullRouted() bool` + +HasNullRouted returns a boolean if a field has been set. + +### GetMainIp + +`func (o *Ip) GetMainIp() bool` + +GetMainIp returns the MainIp field if non-nil, zero value otherwise. + +### GetMainIpOk + +`func (o *Ip) GetMainIpOk() (*bool, bool)` + +GetMainIpOk returns a tuple with the MainIp field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMainIp + +`func (o *Ip) SetMainIp(v bool)` + +SetMainIp sets MainIp field to given value. + +### HasMainIp + +`func (o *Ip) HasMainIp() bool` + +HasMainIp returns a boolean if a field has been set. + +### GetReverseLookup + +`func (o *Ip) GetReverseLookup() string` + +GetReverseLookup returns the ReverseLookup field if non-nil, zero value otherwise. + +### GetReverseLookupOk + +`func (o *Ip) GetReverseLookupOk() (*string, bool)` + +GetReverseLookupOk returns a tuple with the ReverseLookup field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReverseLookup + +`func (o *Ip) SetReverseLookup(v string)` + +SetReverseLookup sets ReverseLookup field to given value. + +### HasReverseLookup + +`func (o *Ip) HasReverseLookup() bool` + +HasReverseLookup returns a boolean if a field has been set. + +### SetReverseLookupNil + +`func (o *Ip) SetReverseLookupNil(b bool)` + + SetReverseLookupNil sets the value for ReverseLookup to be an explicit nil + +### UnsetReverseLookup +`func (o *Ip) UnsetReverseLookup()` + +UnsetReverseLookup ensures that no value is present for ReverseLookup, not even an explicit nil +### GetDdos + +`func (o *Ip) GetDdos() Ddos` + +GetDdos returns the Ddos field if non-nil, zero value otherwise. + +### GetDdosOk + +`func (o *Ip) GetDdosOk() (*Ddos, bool)` + +GetDdosOk returns a tuple with the Ddos field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetDdos + +`func (o *Ip) SetDdos(v Ddos)` + +SetDdos sets Ddos field to given value. + +### HasDdos + +`func (o *Ip) HasDdos() bool` + +HasDdos returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/Iso.md b/publicCloud/docs/Iso.md new file mode 100644 index 0000000..4923c12 --- /dev/null +++ b/publicCloud/docs/Iso.md @@ -0,0 +1,82 @@ +# Iso + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | | [optional] +**Name** | Pointer to **string** | | [optional] + +## Methods + +### NewIso + +`func NewIso() *Iso` + +NewIso instantiates a new Iso object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewIsoWithDefaults + +`func NewIsoWithDefaults() *Iso` + +NewIsoWithDefaults instantiates a new Iso object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *Iso) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *Iso) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *Iso) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *Iso) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *Iso) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Iso) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Iso) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Iso) HasName() bool` + +HasName returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/LaunchInstanceCreatedResult.md b/publicCloud/docs/LaunchInstanceCreatedResult.md new file mode 100644 index 0000000..30c9532 --- /dev/null +++ b/publicCloud/docs/LaunchInstanceCreatedResult.md @@ -0,0 +1,642 @@ +# LaunchInstanceCreatedResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CustomerId** | Pointer to **string** | The customer ID who owns the instance | [optional] +**Id** | Pointer to **string** | The instance unique identifier | [optional] +**Resources** | Pointer to [**InstanceResources**](InstanceResources.md) | | [optional] +**Region** | Pointer to **string** | The region where the instance was launched into | [optional] +**Reference** | Pointer to **string** | The identifying name set to the instance | [optional] +**OperatingSystem** | Pointer to [**OperatingSystem**](OperatingSystem.md) | | [optional] +**State** | Pointer to [**InstanceState**](InstanceState.md) | | [optional] +**PublicIpV4** | Pointer to **bool** | | [optional] +**Type** | Pointer to **string** | Instance type | [optional] +**PrivateNetwork** | Pointer to **bool** | | [optional] +**RootDiskSize** | Pointer to **int32** | The root disk size as specified during its launch or update, in GB | [optional] +**RootDiskStorageType** | Pointer to **string** | The root disk's storage type | [optional] +**Ips** | Pointer to [**[]Ip**](Ip.md) | | [optional] +**BillingFrequency** | Pointer to **int32** | | [optional] +**ContractTerm** | Pointer to **int32** | The contract commitment (in months) | [optional] +**ContractType** | Pointer to [**ContractType**](ContractType.md) | | [optional] +**ContractEndsAt** | Pointer to **NullableTime** | | [optional] +**StartedAt** | Pointer to **NullableTime** | Date and time when the instance was started for the first time, right after launching it | [optional] +**ContractRenewalsAt** | Pointer to **time.Time** | Date when the contract will be automatically renewed | [optional] +**ContractCreatedAt** | Pointer to **time.Time** | Date when the contract was created | [optional] +**Iso** | Pointer to [**NullableIso**](Iso.md) | | [optional] +**MarketAppId** | Pointer to **NullableString** | The market app ID which was deployed in the instance, if any | [optional] + +## Methods + +### NewLaunchInstanceCreatedResult + +`func NewLaunchInstanceCreatedResult() *LaunchInstanceCreatedResult` + +NewLaunchInstanceCreatedResult instantiates a new LaunchInstanceCreatedResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewLaunchInstanceCreatedResultWithDefaults + +`func NewLaunchInstanceCreatedResultWithDefaults() *LaunchInstanceCreatedResult` + +NewLaunchInstanceCreatedResultWithDefaults instantiates a new LaunchInstanceCreatedResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCustomerId + +`func (o *LaunchInstanceCreatedResult) GetCustomerId() string` + +GetCustomerId returns the CustomerId field if non-nil, zero value otherwise. + +### GetCustomerIdOk + +`func (o *LaunchInstanceCreatedResult) GetCustomerIdOk() (*string, bool)` + +GetCustomerIdOk returns a tuple with the CustomerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCustomerId + +`func (o *LaunchInstanceCreatedResult) SetCustomerId(v string)` + +SetCustomerId sets CustomerId field to given value. + +### HasCustomerId + +`func (o *LaunchInstanceCreatedResult) HasCustomerId() bool` + +HasCustomerId returns a boolean if a field has been set. + +### GetId + +`func (o *LaunchInstanceCreatedResult) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *LaunchInstanceCreatedResult) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *LaunchInstanceCreatedResult) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *LaunchInstanceCreatedResult) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetResources + +`func (o *LaunchInstanceCreatedResult) GetResources() InstanceResources` + +GetResources returns the Resources field if non-nil, zero value otherwise. + +### GetResourcesOk + +`func (o *LaunchInstanceCreatedResult) GetResourcesOk() (*InstanceResources, bool)` + +GetResourcesOk returns a tuple with the Resources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResources + +`func (o *LaunchInstanceCreatedResult) SetResources(v InstanceResources)` + +SetResources sets Resources field to given value. + +### HasResources + +`func (o *LaunchInstanceCreatedResult) HasResources() bool` + +HasResources returns a boolean if a field has been set. + +### GetRegion + +`func (o *LaunchInstanceCreatedResult) GetRegion() string` + +GetRegion returns the Region field if non-nil, zero value otherwise. + +### GetRegionOk + +`func (o *LaunchInstanceCreatedResult) GetRegionOk() (*string, bool)` + +GetRegionOk returns a tuple with the Region field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegion + +`func (o *LaunchInstanceCreatedResult) SetRegion(v string)` + +SetRegion sets Region field to given value. + +### HasRegion + +`func (o *LaunchInstanceCreatedResult) HasRegion() bool` + +HasRegion returns a boolean if a field has been set. + +### GetReference + +`func (o *LaunchInstanceCreatedResult) GetReference() string` + +GetReference returns the Reference field if non-nil, zero value otherwise. + +### GetReferenceOk + +`func (o *LaunchInstanceCreatedResult) GetReferenceOk() (*string, bool)` + +GetReferenceOk returns a tuple with the Reference field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReference + +`func (o *LaunchInstanceCreatedResult) SetReference(v string)` + +SetReference sets Reference field to given value. + +### HasReference + +`func (o *LaunchInstanceCreatedResult) HasReference() bool` + +HasReference returns a boolean if a field has been set. + +### GetOperatingSystem + +`func (o *LaunchInstanceCreatedResult) GetOperatingSystem() OperatingSystem` + +GetOperatingSystem returns the OperatingSystem field if non-nil, zero value otherwise. + +### GetOperatingSystemOk + +`func (o *LaunchInstanceCreatedResult) GetOperatingSystemOk() (*OperatingSystem, bool)` + +GetOperatingSystemOk returns a tuple with the OperatingSystem field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperatingSystem + +`func (o *LaunchInstanceCreatedResult) SetOperatingSystem(v OperatingSystem)` + +SetOperatingSystem sets OperatingSystem field to given value. + +### HasOperatingSystem + +`func (o *LaunchInstanceCreatedResult) HasOperatingSystem() bool` + +HasOperatingSystem returns a boolean if a field has been set. + +### GetState + +`func (o *LaunchInstanceCreatedResult) GetState() InstanceState` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *LaunchInstanceCreatedResult) GetStateOk() (*InstanceState, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *LaunchInstanceCreatedResult) SetState(v InstanceState)` + +SetState sets State field to given value. + +### HasState + +`func (o *LaunchInstanceCreatedResult) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetPublicIpV4 + +`func (o *LaunchInstanceCreatedResult) GetPublicIpV4() bool` + +GetPublicIpV4 returns the PublicIpV4 field if non-nil, zero value otherwise. + +### GetPublicIpV4Ok + +`func (o *LaunchInstanceCreatedResult) GetPublicIpV4Ok() (*bool, bool)` + +GetPublicIpV4Ok returns a tuple with the PublicIpV4 field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicIpV4 + +`func (o *LaunchInstanceCreatedResult) SetPublicIpV4(v bool)` + +SetPublicIpV4 sets PublicIpV4 field to given value. + +### HasPublicIpV4 + +`func (o *LaunchInstanceCreatedResult) HasPublicIpV4() bool` + +HasPublicIpV4 returns a boolean if a field has been set. + +### GetType + +`func (o *LaunchInstanceCreatedResult) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *LaunchInstanceCreatedResult) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *LaunchInstanceCreatedResult) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *LaunchInstanceCreatedResult) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetPrivateNetwork + +`func (o *LaunchInstanceCreatedResult) GetPrivateNetwork() bool` + +GetPrivateNetwork returns the PrivateNetwork field if non-nil, zero value otherwise. + +### GetPrivateNetworkOk + +`func (o *LaunchInstanceCreatedResult) GetPrivateNetworkOk() (*bool, bool)` + +GetPrivateNetworkOk returns a tuple with the PrivateNetwork field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateNetwork + +`func (o *LaunchInstanceCreatedResult) SetPrivateNetwork(v bool)` + +SetPrivateNetwork sets PrivateNetwork field to given value. + +### HasPrivateNetwork + +`func (o *LaunchInstanceCreatedResult) HasPrivateNetwork() bool` + +HasPrivateNetwork returns a boolean if a field has been set. + +### GetRootDiskSize + +`func (o *LaunchInstanceCreatedResult) GetRootDiskSize() int32` + +GetRootDiskSize returns the RootDiskSize field if non-nil, zero value otherwise. + +### GetRootDiskSizeOk + +`func (o *LaunchInstanceCreatedResult) GetRootDiskSizeOk() (*int32, bool)` + +GetRootDiskSizeOk returns a tuple with the RootDiskSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRootDiskSize + +`func (o *LaunchInstanceCreatedResult) SetRootDiskSize(v int32)` + +SetRootDiskSize sets RootDiskSize field to given value. + +### HasRootDiskSize + +`func (o *LaunchInstanceCreatedResult) HasRootDiskSize() bool` + +HasRootDiskSize returns a boolean if a field has been set. + +### GetRootDiskStorageType + +`func (o *LaunchInstanceCreatedResult) GetRootDiskStorageType() string` + +GetRootDiskStorageType returns the RootDiskStorageType field if non-nil, zero value otherwise. + +### GetRootDiskStorageTypeOk + +`func (o *LaunchInstanceCreatedResult) GetRootDiskStorageTypeOk() (*string, bool)` + +GetRootDiskStorageTypeOk returns a tuple with the RootDiskStorageType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRootDiskStorageType + +`func (o *LaunchInstanceCreatedResult) SetRootDiskStorageType(v string)` + +SetRootDiskStorageType sets RootDiskStorageType field to given value. + +### HasRootDiskStorageType + +`func (o *LaunchInstanceCreatedResult) HasRootDiskStorageType() bool` + +HasRootDiskStorageType returns a boolean if a field has been set. + +### GetIps + +`func (o *LaunchInstanceCreatedResult) GetIps() []Ip` + +GetIps returns the Ips field if non-nil, zero value otherwise. + +### GetIpsOk + +`func (o *LaunchInstanceCreatedResult) GetIpsOk() (*[]Ip, bool)` + +GetIpsOk returns a tuple with the Ips field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIps + +`func (o *LaunchInstanceCreatedResult) SetIps(v []Ip)` + +SetIps sets Ips field to given value. + +### HasIps + +`func (o *LaunchInstanceCreatedResult) HasIps() bool` + +HasIps returns a boolean if a field has been set. + +### GetBillingFrequency + +`func (o *LaunchInstanceCreatedResult) GetBillingFrequency() int32` + +GetBillingFrequency returns the BillingFrequency field if non-nil, zero value otherwise. + +### GetBillingFrequencyOk + +`func (o *LaunchInstanceCreatedResult) GetBillingFrequencyOk() (*int32, bool)` + +GetBillingFrequencyOk returns a tuple with the BillingFrequency field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBillingFrequency + +`func (o *LaunchInstanceCreatedResult) SetBillingFrequency(v int32)` + +SetBillingFrequency sets BillingFrequency field to given value. + +### HasBillingFrequency + +`func (o *LaunchInstanceCreatedResult) HasBillingFrequency() bool` + +HasBillingFrequency returns a boolean if a field has been set. + +### GetContractTerm + +`func (o *LaunchInstanceCreatedResult) GetContractTerm() int32` + +GetContractTerm returns the ContractTerm field if non-nil, zero value otherwise. + +### GetContractTermOk + +`func (o *LaunchInstanceCreatedResult) GetContractTermOk() (*int32, bool)` + +GetContractTermOk returns a tuple with the ContractTerm field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContractTerm + +`func (o *LaunchInstanceCreatedResult) SetContractTerm(v int32)` + +SetContractTerm sets ContractTerm field to given value. + +### HasContractTerm + +`func (o *LaunchInstanceCreatedResult) HasContractTerm() bool` + +HasContractTerm returns a boolean if a field has been set. + +### GetContractType + +`func (o *LaunchInstanceCreatedResult) GetContractType() ContractType` + +GetContractType returns the ContractType field if non-nil, zero value otherwise. + +### GetContractTypeOk + +`func (o *LaunchInstanceCreatedResult) GetContractTypeOk() (*ContractType, bool)` + +GetContractTypeOk returns a tuple with the ContractType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContractType + +`func (o *LaunchInstanceCreatedResult) SetContractType(v ContractType)` + +SetContractType sets ContractType field to given value. + +### HasContractType + +`func (o *LaunchInstanceCreatedResult) HasContractType() bool` + +HasContractType returns a boolean if a field has been set. + +### GetContractEndsAt + +`func (o *LaunchInstanceCreatedResult) GetContractEndsAt() time.Time` + +GetContractEndsAt returns the ContractEndsAt field if non-nil, zero value otherwise. + +### GetContractEndsAtOk + +`func (o *LaunchInstanceCreatedResult) GetContractEndsAtOk() (*time.Time, bool)` + +GetContractEndsAtOk returns a tuple with the ContractEndsAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContractEndsAt + +`func (o *LaunchInstanceCreatedResult) SetContractEndsAt(v time.Time)` + +SetContractEndsAt sets ContractEndsAt field to given value. + +### HasContractEndsAt + +`func (o *LaunchInstanceCreatedResult) HasContractEndsAt() bool` + +HasContractEndsAt returns a boolean if a field has been set. + +### SetContractEndsAtNil + +`func (o *LaunchInstanceCreatedResult) SetContractEndsAtNil(b bool)` + + SetContractEndsAtNil sets the value for ContractEndsAt to be an explicit nil + +### UnsetContractEndsAt +`func (o *LaunchInstanceCreatedResult) UnsetContractEndsAt()` + +UnsetContractEndsAt ensures that no value is present for ContractEndsAt, not even an explicit nil +### GetStartedAt + +`func (o *LaunchInstanceCreatedResult) GetStartedAt() time.Time` + +GetStartedAt returns the StartedAt field if non-nil, zero value otherwise. + +### GetStartedAtOk + +`func (o *LaunchInstanceCreatedResult) GetStartedAtOk() (*time.Time, bool)` + +GetStartedAtOk returns a tuple with the StartedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartedAt + +`func (o *LaunchInstanceCreatedResult) SetStartedAt(v time.Time)` + +SetStartedAt sets StartedAt field to given value. + +### HasStartedAt + +`func (o *LaunchInstanceCreatedResult) HasStartedAt() bool` + +HasStartedAt returns a boolean if a field has been set. + +### SetStartedAtNil + +`func (o *LaunchInstanceCreatedResult) SetStartedAtNil(b bool)` + + SetStartedAtNil sets the value for StartedAt to be an explicit nil + +### UnsetStartedAt +`func (o *LaunchInstanceCreatedResult) UnsetStartedAt()` + +UnsetStartedAt ensures that no value is present for StartedAt, not even an explicit nil +### GetContractRenewalsAt + +`func (o *LaunchInstanceCreatedResult) GetContractRenewalsAt() time.Time` + +GetContractRenewalsAt returns the ContractRenewalsAt field if non-nil, zero value otherwise. + +### GetContractRenewalsAtOk + +`func (o *LaunchInstanceCreatedResult) GetContractRenewalsAtOk() (*time.Time, bool)` + +GetContractRenewalsAtOk returns a tuple with the ContractRenewalsAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContractRenewalsAt + +`func (o *LaunchInstanceCreatedResult) SetContractRenewalsAt(v time.Time)` + +SetContractRenewalsAt sets ContractRenewalsAt field to given value. + +### HasContractRenewalsAt + +`func (o *LaunchInstanceCreatedResult) HasContractRenewalsAt() bool` + +HasContractRenewalsAt returns a boolean if a field has been set. + +### GetContractCreatedAt + +`func (o *LaunchInstanceCreatedResult) GetContractCreatedAt() time.Time` + +GetContractCreatedAt returns the ContractCreatedAt field if non-nil, zero value otherwise. + +### GetContractCreatedAtOk + +`func (o *LaunchInstanceCreatedResult) GetContractCreatedAtOk() (*time.Time, bool)` + +GetContractCreatedAtOk returns a tuple with the ContractCreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContractCreatedAt + +`func (o *LaunchInstanceCreatedResult) SetContractCreatedAt(v time.Time)` + +SetContractCreatedAt sets ContractCreatedAt field to given value. + +### HasContractCreatedAt + +`func (o *LaunchInstanceCreatedResult) HasContractCreatedAt() bool` + +HasContractCreatedAt returns a boolean if a field has been set. + +### GetIso + +`func (o *LaunchInstanceCreatedResult) GetIso() Iso` + +GetIso returns the Iso field if non-nil, zero value otherwise. + +### GetIsoOk + +`func (o *LaunchInstanceCreatedResult) GetIsoOk() (*Iso, bool)` + +GetIsoOk returns a tuple with the Iso field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIso + +`func (o *LaunchInstanceCreatedResult) SetIso(v Iso)` + +SetIso sets Iso field to given value. + +### HasIso + +`func (o *LaunchInstanceCreatedResult) HasIso() bool` + +HasIso returns a boolean if a field has been set. + +### SetIsoNil + +`func (o *LaunchInstanceCreatedResult) SetIsoNil(b bool)` + + SetIsoNil sets the value for Iso to be an explicit nil + +### UnsetIso +`func (o *LaunchInstanceCreatedResult) UnsetIso()` + +UnsetIso ensures that no value is present for Iso, not even an explicit nil +### GetMarketAppId + +`func (o *LaunchInstanceCreatedResult) GetMarketAppId() string` + +GetMarketAppId returns the MarketAppId field if non-nil, zero value otherwise. + +### GetMarketAppIdOk + +`func (o *LaunchInstanceCreatedResult) GetMarketAppIdOk() (*string, bool)` + +GetMarketAppIdOk returns a tuple with the MarketAppId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMarketAppId + +`func (o *LaunchInstanceCreatedResult) SetMarketAppId(v string)` + +SetMarketAppId sets MarketAppId field to given value. + +### HasMarketAppId + +`func (o *LaunchInstanceCreatedResult) HasMarketAppId() bool` + +HasMarketAppId returns a boolean if a field has been set. + +### SetMarketAppIdNil + +`func (o *LaunchInstanceCreatedResult) SetMarketAppIdNil(b bool)` + + SetMarketAppIdNil sets the value for MarketAppId to be an explicit nil + +### UnsetMarketAppId +`func (o *LaunchInstanceCreatedResult) UnsetMarketAppId()` + +UnsetMarketAppId ensures that no value is present for MarketAppId, not even an explicit nil + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/LaunchInstanceOpts.md b/publicCloud/docs/LaunchInstanceOpts.md new file mode 100644 index 0000000..140ef50 --- /dev/null +++ b/publicCloud/docs/LaunchInstanceOpts.md @@ -0,0 +1,286 @@ +# LaunchInstanceOpts + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Region** | **string** | Region to launch the instance into | +**Type** | Pointer to **string** | Instance type | [optional] +**OperatingSystemId** | **string** | Operating System ID | +**MarketAppId** | Pointer to **string** | Market App ID that must be installed into the instance | [optional] +**Reference** | Pointer to **string** | An identifying name you can refer to the instance | [optional] +**ContractType** | **string** | | +**ContractTerm** | **int32** | Contract commitment. Used only when contract type is MONTHLY | +**BillingFrequency** | **int32** | How often you wish to be charged. Used only when contract type is MONTHLY. '1' means every month, '3' every three months and so on. | +**RootDiskSize** | Pointer to **int32** | The root disk's size in GB. Must be at least 5 GB for Linux and FreeBSD instances and 50 GB for Windows instances | [optional] +**RootDiskStorageType** | **string** | The root disk's storage type | +**SshKey** | Pointer to **string** | Public SSH key to be installed into the instance. Must be used only on Linux/FreeBSD instances | [optional] + +## Methods + +### NewLaunchInstanceOpts + +`func NewLaunchInstanceOpts(region string, operatingSystemId string, contractType string, contractTerm int32, billingFrequency int32, rootDiskStorageType string, ) *LaunchInstanceOpts` + +NewLaunchInstanceOpts instantiates a new LaunchInstanceOpts object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewLaunchInstanceOptsWithDefaults + +`func NewLaunchInstanceOptsWithDefaults() *LaunchInstanceOpts` + +NewLaunchInstanceOptsWithDefaults instantiates a new LaunchInstanceOpts object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetRegion + +`func (o *LaunchInstanceOpts) GetRegion() string` + +GetRegion returns the Region field if non-nil, zero value otherwise. + +### GetRegionOk + +`func (o *LaunchInstanceOpts) GetRegionOk() (*string, bool)` + +GetRegionOk returns a tuple with the Region field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegion + +`func (o *LaunchInstanceOpts) SetRegion(v string)` + +SetRegion sets Region field to given value. + + +### GetType + +`func (o *LaunchInstanceOpts) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *LaunchInstanceOpts) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *LaunchInstanceOpts) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *LaunchInstanceOpts) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetOperatingSystemId + +`func (o *LaunchInstanceOpts) GetOperatingSystemId() string` + +GetOperatingSystemId returns the OperatingSystemId field if non-nil, zero value otherwise. + +### GetOperatingSystemIdOk + +`func (o *LaunchInstanceOpts) GetOperatingSystemIdOk() (*string, bool)` + +GetOperatingSystemIdOk returns a tuple with the OperatingSystemId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperatingSystemId + +`func (o *LaunchInstanceOpts) SetOperatingSystemId(v string)` + +SetOperatingSystemId sets OperatingSystemId field to given value. + + +### GetMarketAppId + +`func (o *LaunchInstanceOpts) GetMarketAppId() string` + +GetMarketAppId returns the MarketAppId field if non-nil, zero value otherwise. + +### GetMarketAppIdOk + +`func (o *LaunchInstanceOpts) GetMarketAppIdOk() (*string, bool)` + +GetMarketAppIdOk returns a tuple with the MarketAppId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMarketAppId + +`func (o *LaunchInstanceOpts) SetMarketAppId(v string)` + +SetMarketAppId sets MarketAppId field to given value. + +### HasMarketAppId + +`func (o *LaunchInstanceOpts) HasMarketAppId() bool` + +HasMarketAppId returns a boolean if a field has been set. + +### GetReference + +`func (o *LaunchInstanceOpts) GetReference() string` + +GetReference returns the Reference field if non-nil, zero value otherwise. + +### GetReferenceOk + +`func (o *LaunchInstanceOpts) GetReferenceOk() (*string, bool)` + +GetReferenceOk returns a tuple with the Reference field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReference + +`func (o *LaunchInstanceOpts) SetReference(v string)` + +SetReference sets Reference field to given value. + +### HasReference + +`func (o *LaunchInstanceOpts) HasReference() bool` + +HasReference returns a boolean if a field has been set. + +### GetContractType + +`func (o *LaunchInstanceOpts) GetContractType() string` + +GetContractType returns the ContractType field if non-nil, zero value otherwise. + +### GetContractTypeOk + +`func (o *LaunchInstanceOpts) GetContractTypeOk() (*string, bool)` + +GetContractTypeOk returns a tuple with the ContractType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContractType + +`func (o *LaunchInstanceOpts) SetContractType(v string)` + +SetContractType sets ContractType field to given value. + + +### GetContractTerm + +`func (o *LaunchInstanceOpts) GetContractTerm() int32` + +GetContractTerm returns the ContractTerm field if non-nil, zero value otherwise. + +### GetContractTermOk + +`func (o *LaunchInstanceOpts) GetContractTermOk() (*int32, bool)` + +GetContractTermOk returns a tuple with the ContractTerm field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContractTerm + +`func (o *LaunchInstanceOpts) SetContractTerm(v int32)` + +SetContractTerm sets ContractTerm field to given value. + + +### GetBillingFrequency + +`func (o *LaunchInstanceOpts) GetBillingFrequency() int32` + +GetBillingFrequency returns the BillingFrequency field if non-nil, zero value otherwise. + +### GetBillingFrequencyOk + +`func (o *LaunchInstanceOpts) GetBillingFrequencyOk() (*int32, bool)` + +GetBillingFrequencyOk returns a tuple with the BillingFrequency field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBillingFrequency + +`func (o *LaunchInstanceOpts) SetBillingFrequency(v int32)` + +SetBillingFrequency sets BillingFrequency field to given value. + + +### GetRootDiskSize + +`func (o *LaunchInstanceOpts) GetRootDiskSize() int32` + +GetRootDiskSize returns the RootDiskSize field if non-nil, zero value otherwise. + +### GetRootDiskSizeOk + +`func (o *LaunchInstanceOpts) GetRootDiskSizeOk() (*int32, bool)` + +GetRootDiskSizeOk returns a tuple with the RootDiskSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRootDiskSize + +`func (o *LaunchInstanceOpts) SetRootDiskSize(v int32)` + +SetRootDiskSize sets RootDiskSize field to given value. + +### HasRootDiskSize + +`func (o *LaunchInstanceOpts) HasRootDiskSize() bool` + +HasRootDiskSize returns a boolean if a field has been set. + +### GetRootDiskStorageType + +`func (o *LaunchInstanceOpts) GetRootDiskStorageType() string` + +GetRootDiskStorageType returns the RootDiskStorageType field if non-nil, zero value otherwise. + +### GetRootDiskStorageTypeOk + +`func (o *LaunchInstanceOpts) GetRootDiskStorageTypeOk() (*string, bool)` + +GetRootDiskStorageTypeOk returns a tuple with the RootDiskStorageType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRootDiskStorageType + +`func (o *LaunchInstanceOpts) SetRootDiskStorageType(v string)` + +SetRootDiskStorageType sets RootDiskStorageType field to given value. + + +### GetSshKey + +`func (o *LaunchInstanceOpts) GetSshKey() string` + +GetSshKey returns the SshKey field if non-nil, zero value otherwise. + +### GetSshKeyOk + +`func (o *LaunchInstanceOpts) GetSshKeyOk() (*string, bool)` + +GetSshKeyOk returns a tuple with the SshKey field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSshKey + +`func (o *LaunchInstanceOpts) SetSshKey(v string)` + +SetSshKey sets SshKey field to given value. + +### HasSshKey + +`func (o *LaunchInstanceOpts) HasSshKey() bool` + +HasSshKey returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/Local.md b/publicCloud/docs/Local.md new file mode 100644 index 0000000..4b51b9a --- /dev/null +++ b/publicCloud/docs/Local.md @@ -0,0 +1,82 @@ +# Local + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**HourlyPrice** | Pointer to **string** | | [optional] +**MonthlyPrice** | Pointer to **string** | | [optional] + +## Methods + +### NewLocal + +`func NewLocal() *Local` + +NewLocal instantiates a new Local object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewLocalWithDefaults + +`func NewLocalWithDefaults() *Local` + +NewLocalWithDefaults instantiates a new Local object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetHourlyPrice + +`func (o *Local) GetHourlyPrice() string` + +GetHourlyPrice returns the HourlyPrice field if non-nil, zero value otherwise. + +### GetHourlyPriceOk + +`func (o *Local) GetHourlyPriceOk() (*string, bool)` + +GetHourlyPriceOk returns a tuple with the HourlyPrice field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetHourlyPrice + +`func (o *Local) SetHourlyPrice(v string)` + +SetHourlyPrice sets HourlyPrice field to given value. + +### HasHourlyPrice + +`func (o *Local) HasHourlyPrice() bool` + +HasHourlyPrice returns a boolean if a field has been set. + +### GetMonthlyPrice + +`func (o *Local) GetMonthlyPrice() string` + +GetMonthlyPrice returns the MonthlyPrice field if non-nil, zero value otherwise. + +### GetMonthlyPriceOk + +`func (o *Local) GetMonthlyPriceOk() (*string, bool)` + +GetMonthlyPriceOk returns a tuple with the MonthlyPrice field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMonthlyPrice + +`func (o *Local) SetMonthlyPrice(v string)` + +SetMonthlyPrice sets MonthlyPrice field to given value. + +### HasMonthlyPrice + +`func (o *Local) HasMonthlyPrice() bool` + +HasMonthlyPrice returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/MarketApp.md b/publicCloud/docs/MarketApp.md new file mode 100644 index 0000000..510914e --- /dev/null +++ b/publicCloud/docs/MarketApp.md @@ -0,0 +1,196 @@ +# MarketApp + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | | [optional] +**Name** | Pointer to **string** | | [optional] +**Category** | Pointer to **string** | | [optional] +**Version** | Pointer to **NullableString** | | [optional] +**Family** | Pointer to **string** | | [optional] +**OperatingSystem** | Pointer to [**OperatingSystem**](OperatingSystem.md) | | [optional] + +## Methods + +### NewMarketApp + +`func NewMarketApp() *MarketApp` + +NewMarketApp instantiates a new MarketApp object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewMarketAppWithDefaults + +`func NewMarketAppWithDefaults() *MarketApp` + +NewMarketAppWithDefaults instantiates a new MarketApp object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *MarketApp) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *MarketApp) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *MarketApp) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *MarketApp) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *MarketApp) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *MarketApp) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *MarketApp) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *MarketApp) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetCategory + +`func (o *MarketApp) GetCategory() string` + +GetCategory returns the Category field if non-nil, zero value otherwise. + +### GetCategoryOk + +`func (o *MarketApp) GetCategoryOk() (*string, bool)` + +GetCategoryOk returns a tuple with the Category field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCategory + +`func (o *MarketApp) SetCategory(v string)` + +SetCategory sets Category field to given value. + +### HasCategory + +`func (o *MarketApp) HasCategory() bool` + +HasCategory returns a boolean if a field has been set. + +### GetVersion + +`func (o *MarketApp) GetVersion() string` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *MarketApp) GetVersionOk() (*string, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *MarketApp) SetVersion(v string)` + +SetVersion sets Version field to given value. + +### HasVersion + +`func (o *MarketApp) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + +### SetVersionNil + +`func (o *MarketApp) SetVersionNil(b bool)` + + SetVersionNil sets the value for Version to be an explicit nil + +### UnsetVersion +`func (o *MarketApp) UnsetVersion()` + +UnsetVersion ensures that no value is present for Version, not even an explicit nil +### GetFamily + +`func (o *MarketApp) GetFamily() string` + +GetFamily returns the Family field if non-nil, zero value otherwise. + +### GetFamilyOk + +`func (o *MarketApp) GetFamilyOk() (*string, bool)` + +GetFamilyOk returns a tuple with the Family field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFamily + +`func (o *MarketApp) SetFamily(v string)` + +SetFamily sets Family field to given value. + +### HasFamily + +`func (o *MarketApp) HasFamily() bool` + +HasFamily returns a boolean if a field has been set. + +### GetOperatingSystem + +`func (o *MarketApp) GetOperatingSystem() OperatingSystem` + +GetOperatingSystem returns the OperatingSystem field if non-nil, zero value otherwise. + +### GetOperatingSystemOk + +`func (o *MarketApp) GetOperatingSystemOk() (*OperatingSystem, bool)` + +GetOperatingSystemOk returns a tuple with the OperatingSystem field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperatingSystem + +`func (o *MarketApp) SetOperatingSystem(v OperatingSystem)` + +SetOperatingSystem sets OperatingSystem field to given value. + +### HasOperatingSystem + +`func (o *MarketApp) HasOperatingSystem() bool` + +HasOperatingSystem returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/Memory.md b/publicCloud/docs/Memory.md new file mode 100644 index 0000000..2fbccea --- /dev/null +++ b/publicCloud/docs/Memory.md @@ -0,0 +1,82 @@ +# Memory + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **float32** | | [optional] +**Unit** | Pointer to **string** | | [optional] + +## Methods + +### NewMemory + +`func NewMemory() *Memory` + +NewMemory instantiates a new Memory object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewMemoryWithDefaults + +`func NewMemoryWithDefaults() *Memory` + +NewMemoryWithDefaults instantiates a new Memory object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetValue + +`func (o *Memory) GetValue() float32` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *Memory) GetValueOk() (*float32, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *Memory) SetValue(v float32)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *Memory) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetUnit + +`func (o *Memory) GetUnit() string` + +GetUnit returns the Unit field if non-nil, zero value otherwise. + +### GetUnitOk + +`func (o *Memory) GetUnitOk() (*string, bool)` + +GetUnitOk returns a tuple with the Unit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnit + +`func (o *Memory) SetUnit(v string)` + +SetUnit sets Unit field to given value. + +### HasUnit + +`func (o *Memory) HasUnit() bool` + +HasUnit returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/Metadata.md b/publicCloud/docs/Metadata.md new file mode 100644 index 0000000..194d6a7 --- /dev/null +++ b/publicCloud/docs/Metadata.md @@ -0,0 +1,108 @@ +# Metadata + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TotalCount** | Pointer to **float32** | Total amount of orders in this collection | [optional] +**Offset** | Pointer to **float32** | The offset used to generate this response | [optional] [default to 0] +**Limit** | Pointer to **float32** | The limit used to generate this response | [optional] [default to 5] + +## Methods + +### NewMetadata + +`func NewMetadata() *Metadata` + +NewMetadata instantiates a new Metadata object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewMetadataWithDefaults + +`func NewMetadataWithDefaults() *Metadata` + +NewMetadataWithDefaults instantiates a new Metadata object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetTotalCount + +`func (o *Metadata) GetTotalCount() float32` + +GetTotalCount returns the TotalCount field if non-nil, zero value otherwise. + +### GetTotalCountOk + +`func (o *Metadata) GetTotalCountOk() (*float32, bool)` + +GetTotalCountOk returns a tuple with the TotalCount field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTotalCount + +`func (o *Metadata) SetTotalCount(v float32)` + +SetTotalCount sets TotalCount field to given value. + +### HasTotalCount + +`func (o *Metadata) HasTotalCount() bool` + +HasTotalCount returns a boolean if a field has been set. + +### GetOffset + +`func (o *Metadata) GetOffset() float32` + +GetOffset returns the Offset field if non-nil, zero value otherwise. + +### GetOffsetOk + +`func (o *Metadata) GetOffsetOk() (*float32, bool)` + +GetOffsetOk returns a tuple with the Offset field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOffset + +`func (o *Metadata) SetOffset(v float32)` + +SetOffset sets Offset field to given value. + +### HasOffset + +`func (o *Metadata) HasOffset() bool` + +HasOffset returns a boolean if a field has been set. + +### GetLimit + +`func (o *Metadata) GetLimit() float32` + +GetLimit returns the Limit field if non-nil, zero value otherwise. + +### GetLimitOk + +`func (o *Metadata) GetLimitOk() (*float32, bool)` + +GetLimitOk returns a tuple with the Limit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLimit + +`func (o *Metadata) SetLimit(v float32)` + +SetLimit sets Limit field to given value. + +### HasLimit + +`func (o *Metadata) HasLimit() bool` + +HasLimit returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/OperatingSystem.md b/publicCloud/docs/OperatingSystem.md new file mode 100644 index 0000000..badeb7a --- /dev/null +++ b/publicCloud/docs/OperatingSystem.md @@ -0,0 +1,238 @@ +# OperatingSystem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | | [optional] +**Name** | Pointer to **string** | | [optional] +**Version** | Pointer to **string** | | [optional] +**Family** | Pointer to **string** | | [optional] +**Flavour** | Pointer to **string** | | [optional] +**Architecture** | Pointer to **string** | | [optional] +**MarketApps** | Pointer to **[]string** | | [optional] +**StorageTypes** | Pointer to **[]string** | The supported storage types for the instance type | [optional] + +## Methods + +### NewOperatingSystem + +`func NewOperatingSystem() *OperatingSystem` + +NewOperatingSystem instantiates a new OperatingSystem object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewOperatingSystemWithDefaults + +`func NewOperatingSystemWithDefaults() *OperatingSystem` + +NewOperatingSystemWithDefaults instantiates a new OperatingSystem object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *OperatingSystem) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *OperatingSystem) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *OperatingSystem) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *OperatingSystem) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *OperatingSystem) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *OperatingSystem) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *OperatingSystem) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *OperatingSystem) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetVersion + +`func (o *OperatingSystem) GetVersion() string` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *OperatingSystem) GetVersionOk() (*string, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *OperatingSystem) SetVersion(v string)` + +SetVersion sets Version field to given value. + +### HasVersion + +`func (o *OperatingSystem) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + +### GetFamily + +`func (o *OperatingSystem) GetFamily() string` + +GetFamily returns the Family field if non-nil, zero value otherwise. + +### GetFamilyOk + +`func (o *OperatingSystem) GetFamilyOk() (*string, bool)` + +GetFamilyOk returns a tuple with the Family field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFamily + +`func (o *OperatingSystem) SetFamily(v string)` + +SetFamily sets Family field to given value. + +### HasFamily + +`func (o *OperatingSystem) HasFamily() bool` + +HasFamily returns a boolean if a field has been set. + +### GetFlavour + +`func (o *OperatingSystem) GetFlavour() string` + +GetFlavour returns the Flavour field if non-nil, zero value otherwise. + +### GetFlavourOk + +`func (o *OperatingSystem) GetFlavourOk() (*string, bool)` + +GetFlavourOk returns a tuple with the Flavour field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFlavour + +`func (o *OperatingSystem) SetFlavour(v string)` + +SetFlavour sets Flavour field to given value. + +### HasFlavour + +`func (o *OperatingSystem) HasFlavour() bool` + +HasFlavour returns a boolean if a field has been set. + +### GetArchitecture + +`func (o *OperatingSystem) GetArchitecture() string` + +GetArchitecture returns the Architecture field if non-nil, zero value otherwise. + +### GetArchitectureOk + +`func (o *OperatingSystem) GetArchitectureOk() (*string, bool)` + +GetArchitectureOk returns a tuple with the Architecture field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetArchitecture + +`func (o *OperatingSystem) SetArchitecture(v string)` + +SetArchitecture sets Architecture field to given value. + +### HasArchitecture + +`func (o *OperatingSystem) HasArchitecture() bool` + +HasArchitecture returns a boolean if a field has been set. + +### GetMarketApps + +`func (o *OperatingSystem) GetMarketApps() []string` + +GetMarketApps returns the MarketApps field if non-nil, zero value otherwise. + +### GetMarketAppsOk + +`func (o *OperatingSystem) GetMarketAppsOk() (*[]string, bool)` + +GetMarketAppsOk returns a tuple with the MarketApps field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMarketApps + +`func (o *OperatingSystem) SetMarketApps(v []string)` + +SetMarketApps sets MarketApps field to given value. + +### HasMarketApps + +`func (o *OperatingSystem) HasMarketApps() bool` + +HasMarketApps returns a boolean if a field has been set. + +### GetStorageTypes + +`func (o *OperatingSystem) GetStorageTypes() []string` + +GetStorageTypes returns the StorageTypes field if non-nil, zero value otherwise. + +### GetStorageTypesOk + +`func (o *OperatingSystem) GetStorageTypesOk() (*[]string, bool)` + +GetStorageTypesOk returns a tuple with the StorageTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStorageTypes + +`func (o *OperatingSystem) SetStorageTypes(v []string)` + +SetStorageTypes sets StorageTypes field to given value. + +### HasStorageTypes + +`func (o *OperatingSystem) HasStorageTypes() bool` + +HasStorageTypes returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/OperatingSystemDetail.md b/publicCloud/docs/OperatingSystemDetail.md new file mode 100644 index 0000000..8f23ef6 --- /dev/null +++ b/publicCloud/docs/OperatingSystemDetail.md @@ -0,0 +1,238 @@ +# OperatingSystemDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | | [optional] +**Name** | Pointer to **string** | | [optional] +**Version** | Pointer to **string** | | [optional] +**Family** | Pointer to **string** | | [optional] +**Flavour** | Pointer to **string** | | [optional] +**Architecture** | Pointer to **string** | | [optional] +**MarketApps** | Pointer to **[]string** | The marketplace app IDs used to reference to on other operations | [optional] +**StorageTypes** | Pointer to **[]string** | The storage types supported by the operating systems | [optional] + +## Methods + +### NewOperatingSystemDetail + +`func NewOperatingSystemDetail() *OperatingSystemDetail` + +NewOperatingSystemDetail instantiates a new OperatingSystemDetail object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewOperatingSystemDetailWithDefaults + +`func NewOperatingSystemDetailWithDefaults() *OperatingSystemDetail` + +NewOperatingSystemDetailWithDefaults instantiates a new OperatingSystemDetail object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *OperatingSystemDetail) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *OperatingSystemDetail) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *OperatingSystemDetail) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *OperatingSystemDetail) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *OperatingSystemDetail) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *OperatingSystemDetail) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *OperatingSystemDetail) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *OperatingSystemDetail) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetVersion + +`func (o *OperatingSystemDetail) GetVersion() string` + +GetVersion returns the Version field if non-nil, zero value otherwise. + +### GetVersionOk + +`func (o *OperatingSystemDetail) GetVersionOk() (*string, bool)` + +GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetVersion + +`func (o *OperatingSystemDetail) SetVersion(v string)` + +SetVersion sets Version field to given value. + +### HasVersion + +`func (o *OperatingSystemDetail) HasVersion() bool` + +HasVersion returns a boolean if a field has been set. + +### GetFamily + +`func (o *OperatingSystemDetail) GetFamily() string` + +GetFamily returns the Family field if non-nil, zero value otherwise. + +### GetFamilyOk + +`func (o *OperatingSystemDetail) GetFamilyOk() (*string, bool)` + +GetFamilyOk returns a tuple with the Family field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFamily + +`func (o *OperatingSystemDetail) SetFamily(v string)` + +SetFamily sets Family field to given value. + +### HasFamily + +`func (o *OperatingSystemDetail) HasFamily() bool` + +HasFamily returns a boolean if a field has been set. + +### GetFlavour + +`func (o *OperatingSystemDetail) GetFlavour() string` + +GetFlavour returns the Flavour field if non-nil, zero value otherwise. + +### GetFlavourOk + +`func (o *OperatingSystemDetail) GetFlavourOk() (*string, bool)` + +GetFlavourOk returns a tuple with the Flavour field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetFlavour + +`func (o *OperatingSystemDetail) SetFlavour(v string)` + +SetFlavour sets Flavour field to given value. + +### HasFlavour + +`func (o *OperatingSystemDetail) HasFlavour() bool` + +HasFlavour returns a boolean if a field has been set. + +### GetArchitecture + +`func (o *OperatingSystemDetail) GetArchitecture() string` + +GetArchitecture returns the Architecture field if non-nil, zero value otherwise. + +### GetArchitectureOk + +`func (o *OperatingSystemDetail) GetArchitectureOk() (*string, bool)` + +GetArchitectureOk returns a tuple with the Architecture field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetArchitecture + +`func (o *OperatingSystemDetail) SetArchitecture(v string)` + +SetArchitecture sets Architecture field to given value. + +### HasArchitecture + +`func (o *OperatingSystemDetail) HasArchitecture() bool` + +HasArchitecture returns a boolean if a field has been set. + +### GetMarketApps + +`func (o *OperatingSystemDetail) GetMarketApps() []string` + +GetMarketApps returns the MarketApps field if non-nil, zero value otherwise. + +### GetMarketAppsOk + +`func (o *OperatingSystemDetail) GetMarketAppsOk() (*[]string, bool)` + +GetMarketAppsOk returns a tuple with the MarketApps field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetMarketApps + +`func (o *OperatingSystemDetail) SetMarketApps(v []string)` + +SetMarketApps sets MarketApps field to given value. + +### HasMarketApps + +`func (o *OperatingSystemDetail) HasMarketApps() bool` + +HasMarketApps returns a boolean if a field has been set. + +### GetStorageTypes + +`func (o *OperatingSystemDetail) GetStorageTypes() []string` + +GetStorageTypes returns the StorageTypes field if non-nil, zero value otherwise. + +### GetStorageTypesOk + +`func (o *OperatingSystemDetail) GetStorageTypesOk() (*[]string, bool)` + +GetStorageTypesOk returns a tuple with the StorageTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStorageTypes + +`func (o *OperatingSystemDetail) SetStorageTypes(v []string)` + +SetStorageTypes sets StorageTypes field to given value. + +### HasStorageTypes + +`func (o *OperatingSystemDetail) HasStorageTypes() bool` + +HasStorageTypes returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/Price.md b/publicCloud/docs/Price.md new file mode 100644 index 0000000..13b11c2 --- /dev/null +++ b/publicCloud/docs/Price.md @@ -0,0 +1,134 @@ +# Price + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Currency** | Pointer to **string** | | [optional] +**CurrencySymbol** | Pointer to **string** | | [optional] +**Compute** | Pointer to [**Compute**](Compute.md) | | [optional] +**Storage** | Pointer to [**Storage**](Storage.md) | | [optional] + +## Methods + +### NewPrice + +`func NewPrice() *Price` + +NewPrice instantiates a new Price object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPriceWithDefaults + +`func NewPriceWithDefaults() *Price` + +NewPriceWithDefaults instantiates a new Price object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetCurrency + +`func (o *Price) GetCurrency() string` + +GetCurrency returns the Currency field if non-nil, zero value otherwise. + +### GetCurrencyOk + +`func (o *Price) GetCurrencyOk() (*string, bool)` + +GetCurrencyOk returns a tuple with the Currency field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrency + +`func (o *Price) SetCurrency(v string)` + +SetCurrency sets Currency field to given value. + +### HasCurrency + +`func (o *Price) HasCurrency() bool` + +HasCurrency returns a boolean if a field has been set. + +### GetCurrencySymbol + +`func (o *Price) GetCurrencySymbol() string` + +GetCurrencySymbol returns the CurrencySymbol field if non-nil, zero value otherwise. + +### GetCurrencySymbolOk + +`func (o *Price) GetCurrencySymbolOk() (*string, bool)` + +GetCurrencySymbolOk returns a tuple with the CurrencySymbol field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCurrencySymbol + +`func (o *Price) SetCurrencySymbol(v string)` + +SetCurrencySymbol sets CurrencySymbol field to given value. + +### HasCurrencySymbol + +`func (o *Price) HasCurrencySymbol() bool` + +HasCurrencySymbol returns a boolean if a field has been set. + +### GetCompute + +`func (o *Price) GetCompute() Compute` + +GetCompute returns the Compute field if non-nil, zero value otherwise. + +### GetComputeOk + +`func (o *Price) GetComputeOk() (*Compute, bool)` + +GetComputeOk returns a tuple with the Compute field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCompute + +`func (o *Price) SetCompute(v Compute)` + +SetCompute sets Compute field to given value. + +### HasCompute + +`func (o *Price) HasCompute() bool` + +HasCompute returns a boolean if a field has been set. + +### GetStorage + +`func (o *Price) GetStorage() Storage` + +GetStorage returns the Storage field if non-nil, zero value otherwise. + +### GetStorageOk + +`func (o *Price) GetStorageOk() (*Storage, bool)` + +GetStorageOk returns a tuple with the Storage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStorage + +`func (o *Price) SetStorage(v Storage)` + +SetStorage sets Storage field to given value. + +### HasStorage + +`func (o *Price) HasStorage() bool` + +HasStorage returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/PrivateNetwork.md b/publicCloud/docs/PrivateNetwork.md new file mode 100644 index 0000000..43993e0 --- /dev/null +++ b/publicCloud/docs/PrivateNetwork.md @@ -0,0 +1,108 @@ +# PrivateNetwork + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PrivateNetworkId** | Pointer to **string** | | [optional] +**Status** | Pointer to **string** | | [optional] +**Subnet** | Pointer to **string** | | [optional] + +## Methods + +### NewPrivateNetwork + +`func NewPrivateNetwork() *PrivateNetwork` + +NewPrivateNetwork instantiates a new PrivateNetwork object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPrivateNetworkWithDefaults + +`func NewPrivateNetworkWithDefaults() *PrivateNetwork` + +NewPrivateNetworkWithDefaults instantiates a new PrivateNetwork object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetPrivateNetworkId + +`func (o *PrivateNetwork) GetPrivateNetworkId() string` + +GetPrivateNetworkId returns the PrivateNetworkId field if non-nil, zero value otherwise. + +### GetPrivateNetworkIdOk + +`func (o *PrivateNetwork) GetPrivateNetworkIdOk() (*string, bool)` + +GetPrivateNetworkIdOk returns a tuple with the PrivateNetworkId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateNetworkId + +`func (o *PrivateNetwork) SetPrivateNetworkId(v string)` + +SetPrivateNetworkId sets PrivateNetworkId field to given value. + +### HasPrivateNetworkId + +`func (o *PrivateNetwork) HasPrivateNetworkId() bool` + +HasPrivateNetworkId returns a boolean if a field has been set. + +### GetStatus + +`func (o *PrivateNetwork) GetStatus() string` + +GetStatus returns the Status field if non-nil, zero value otherwise. + +### GetStatusOk + +`func (o *PrivateNetwork) GetStatusOk() (*string, bool)` + +GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStatus + +`func (o *PrivateNetwork) SetStatus(v string)` + +SetStatus sets Status field to given value. + +### HasStatus + +`func (o *PrivateNetwork) HasStatus() bool` + +HasStatus returns a boolean if a field has been set. + +### GetSubnet + +`func (o *PrivateNetwork) GetSubnet() string` + +GetSubnet returns the Subnet field if non-nil, zero value otherwise. + +### GetSubnetOk + +`func (o *PrivateNetwork) GetSubnetOk() (*string, bool)` + +GetSubnetOk returns a tuple with the Subnet field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSubnet + +`func (o *PrivateNetwork) SetSubnet(v string)` + +SetSubnet sets Subnet field to given value. + +### HasSubnet + +`func (o *PrivateNetwork) HasSubnet() bool` + +HasSubnet returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/PrivateNetworkSpeed.md b/publicCloud/docs/PrivateNetworkSpeed.md new file mode 100644 index 0000000..3cd4e72 --- /dev/null +++ b/publicCloud/docs/PrivateNetworkSpeed.md @@ -0,0 +1,82 @@ +# PrivateNetworkSpeed + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **int32** | | [optional] +**Unit** | Pointer to **string** | | [optional] + +## Methods + +### NewPrivateNetworkSpeed + +`func NewPrivateNetworkSpeed() *PrivateNetworkSpeed` + +NewPrivateNetworkSpeed instantiates a new PrivateNetworkSpeed object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPrivateNetworkSpeedWithDefaults + +`func NewPrivateNetworkSpeedWithDefaults() *PrivateNetworkSpeed` + +NewPrivateNetworkSpeedWithDefaults instantiates a new PrivateNetworkSpeed object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetValue + +`func (o *PrivateNetworkSpeed) GetValue() int32` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *PrivateNetworkSpeed) GetValueOk() (*int32, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *PrivateNetworkSpeed) SetValue(v int32)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *PrivateNetworkSpeed) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetUnit + +`func (o *PrivateNetworkSpeed) GetUnit() string` + +GetUnit returns the Unit field if non-nil, zero value otherwise. + +### GetUnitOk + +`func (o *PrivateNetworkSpeed) GetUnitOk() (*string, bool)` + +GetUnitOk returns a tuple with the Unit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnit + +`func (o *PrivateNetworkSpeed) SetUnit(v string)` + +SetUnit sets Unit field to given value. + +### HasUnit + +`func (o *PrivateNetworkSpeed) HasUnit() bool` + +HasUnit returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/PublicCloudAPI.md b/publicCloud/docs/PublicCloudAPI.md new file mode 100644 index 0000000..5f6131e --- /dev/null +++ b/publicCloud/docs/PublicCloudAPI.md @@ -0,0 +1,2297 @@ +# \PublicCloudAPI + +All URIs are relative to *https://api.leaseweb.com/publicCloud/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**AttachIso**](PublicCloudAPI.md#AttachIso) | **Post** /instances/{instanceId}/attachIso | Attach ISO to instance +[**CancelInstanceTermination**](PublicCloudAPI.md#CancelInstanceTermination) | **Post** /instances/{instanceId}/cancelTermination | Cancel instance termination +[**CreateFirewallRules**](PublicCloudAPI.md#CreateFirewallRules) | **Post** /instances/{instanceId}/firewall/batchCreate | Add firewall rules in batch +[**CredentialsDelete**](PublicCloudAPI.md#CredentialsDelete) | **Delete** /instances/{instanceId}/credentials | Delete all instance credentials +[**DeleteCredential**](PublicCloudAPI.md#DeleteCredential) | **Delete** /instances/{instanceId}/credentials/{type}/{username} | Delete credentials +[**DeleteFirewallRules**](PublicCloudAPI.md#DeleteFirewallRules) | **Post** /instances/{instanceId}/firewall/batchDelete | Delete firewall rules in batch +[**DetachIso**](PublicCloudAPI.md#DetachIso) | **Post** /instances/{instanceId}/detachIso | Detach ISO from instance +[**EditFirewallRules**](PublicCloudAPI.md#EditFirewallRules) | **Post** /instances/{instanceId}/firewall/batchUpdate | Edit firewall rules in batch +[**GetConsoleAccessToInstance**](PublicCloudAPI.md#GetConsoleAccessToInstance) | **Get** /instances/{instanceId}/console | Get console access +[**GetCredential**](PublicCloudAPI.md#GetCredential) | **Get** /instances/{instanceId}/credentials/{type}/{username} | Get credentials by type and username +[**GetCredentialList**](PublicCloudAPI.md#GetCredentialList) | **Get** /instances/{instanceId}/credentials | List credentials stored for instance +[**GetCredentialListByType**](PublicCloudAPI.md#GetCredentialListByType) | **Get** /instances/{instanceId}/credentials/{type} | Get credentials by type +[**GetExpenses**](PublicCloudAPI.md#GetExpenses) | **Get** /equipments/{equipmentId}/expenses | Get costs for a given month. +[**GetFirewallRuleList**](PublicCloudAPI.md#GetFirewallRuleList) | **Get** /instances/{instanceId}/firewall | List firewall rules +[**GetInstance**](PublicCloudAPI.md#GetInstance) | **Get** /instances/{instanceId} | Get instance details +[**GetInstanceTypeList**](PublicCloudAPI.md#GetInstanceTypeList) | **Get** /instanceTypes | List instance types +[**GetIsoList**](PublicCloudAPI.md#GetIsoList) | **Get** /isos | List available ISOs +[**GetMarketAppList**](PublicCloudAPI.md#GetMarketAppList) | **Get** /marketApps | Get marketplace apps +[**GetOperatingSystemList**](PublicCloudAPI.md#GetOperatingSystemList) | **Get** /operatingSystems | List all available Operating Systems +[**GetReinstallOsList**](PublicCloudAPI.md#GetReinstallOsList) | **Get** /instances/{instanceId}/reinstall/operatingSystems | List OSes available for reinstall +[**GetUpdateInstanceTypeList**](PublicCloudAPI.md#GetUpdateInstanceTypeList) | **Get** /instances/{instanceId}/instanceTypesUpdate | List available instance types for update +[**InstanceList**](PublicCloudAPI.md#InstanceList) | **Get** /instances | Get instance list +[**LaunchInstance**](PublicCloudAPI.md#LaunchInstance) | **Post** /instances | Launch instance +[**RebootInstance**](PublicCloudAPI.md#RebootInstance) | **Post** /instances/{instanceId}/reboot | Reboot instance +[**RegionsList**](PublicCloudAPI.md#RegionsList) | **Get** /regions | List regions +[**ResetPassword**](PublicCloudAPI.md#ResetPassword) | **Post** /instances/{instanceId}/resetPassword | Reset instance password +[**StartInstance**](PublicCloudAPI.md#StartInstance) | **Post** /instances/{instanceId}/start | Start instance +[**StopInstance**](PublicCloudAPI.md#StopInstance) | **Post** /instances/{instanceId}/stop | Stop instance +[**StoreCredential**](PublicCloudAPI.md#StoreCredential) | **Post** /instances/{instanceId}/credentials | Store credentials +[**TerminateInstance**](PublicCloudAPI.md#TerminateInstance) | **Delete** /instances/{instanceId} | Terminate instance +[**UpdateCredential**](PublicCloudAPI.md#UpdateCredential) | **Put** /instances/{instanceId}/credentials/{type}/{username} | Update credentials +[**UpdateInstance**](PublicCloudAPI.md#UpdateInstance) | **Put** /instances/{instanceId} | Update instance + + + +## AttachIso + +> AttachIso(ctx, instanceId).AttachIsoOpts(attachIsoOpts).Execute() + +Attach ISO to instance + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/publicCloud" +) + +func main() { + instanceId := "695ddd91-051f-4dd6-9120-938a927a47d0" // string | Instance's ID + attachIsoOpts := *openapiclient.NewAttachIsoOpts("IsoId_example") // AttachIsoOpts | + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.PublicCloudAPI.AttachIso(context.Background(), instanceId).AttachIsoOpts(attachIsoOpts).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicCloudAPI.AttachIso``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**instanceId** | **string** | Instance's ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiAttachIsoRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **attachIsoOpts** | [**AttachIsoOpts**](AttachIsoOpts.md) | | + +### Return type + + (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## CancelInstanceTermination + +> CancelInstanceTermination(ctx, instanceId).Execute() + +Cancel instance termination + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/publicCloud" +) + +func main() { + instanceId := "695ddd91-051f-4dd6-9120-938a927a47d0" // string | Instance's ID + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.PublicCloudAPI.CancelInstanceTermination(context.Background(), instanceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicCloudAPI.CancelInstanceTermination``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**instanceId** | **string** | Instance's ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCancelInstanceTerminationRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## CreateFirewallRules + +> CreateFirewallRulesCreatedResult CreateFirewallRules(ctx, instanceId).CreateFirewallRulesOpts(createFirewallRulesOpts).Execute() + +Add firewall rules in batch + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/publicCloud" +) + +func main() { + instanceId := "695ddd91-051f-4dd6-9120-938a927a47d0" // string | Instance's ID + createFirewallRulesOpts := *openapiclient.NewCreateFirewallRulesOpts([]openapiclient.CreateRule{*openapiclient.NewCreateRule("Protocol_example", NullableInt32(123), NullableInt32(123), int32(-1), int32(-1), "HTTP rule", "0.0.0.0/0")}) // CreateFirewallRulesOpts | + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.PublicCloudAPI.CreateFirewallRules(context.Background(), instanceId).CreateFirewallRulesOpts(createFirewallRulesOpts).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicCloudAPI.CreateFirewallRules``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `CreateFirewallRules`: CreateFirewallRulesCreatedResult + fmt.Fprintf(os.Stdout, "Response from `PublicCloudAPI.CreateFirewallRules`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**instanceId** | **string** | Instance's ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCreateFirewallRulesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **createFirewallRulesOpts** | [**CreateFirewallRulesOpts**](CreateFirewallRulesOpts.md) | | + +### Return type + +[**CreateFirewallRulesCreatedResult**](CreateFirewallRulesCreatedResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## CredentialsDelete + +> CredentialsDelete(ctx, instanceId).Execute() + +Delete all instance credentials + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/publicCloud" +) + +func main() { + instanceId := "695ddd91-051f-4dd6-9120-938a927a47d0" // string | Instance's ID + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.PublicCloudAPI.CredentialsDelete(context.Background(), instanceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicCloudAPI.CredentialsDelete``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**instanceId** | **string** | Instance's ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiCredentialsDeleteRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteCredential + +> DeleteCredential(ctx, instanceId, type_, username).Execute() + +Delete credentials + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/publicCloud" +) + +func main() { + instanceId := "695ddd91-051f-4dd6-9120-938a927a47d0" // string | Instance's ID + type_ := "OPERATING_SYSTEM" // string | Credential type + username := "root" // string | Username + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.PublicCloudAPI.DeleteCredential(context.Background(), instanceId, type_, username).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicCloudAPI.DeleteCredential``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**instanceId** | **string** | Instance's ID | +**type_** | **string** | Credential type | +**username** | **string** | Username | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteCredentialRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + + (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteFirewallRules + +> DeleteFirewallRulesResult DeleteFirewallRules(ctx, instanceId).DeleteFirewallRulesOpts(deleteFirewallRulesOpts).Execute() + +Delete firewall rules in batch + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/publicCloud" +) + +func main() { + instanceId := "695ddd91-051f-4dd6-9120-938a927a47d0" // string | Instance's ID + deleteFirewallRulesOpts := *openapiclient.NewDeleteFirewallRulesOpts([]openapiclient.DeletionRule{*openapiclient.NewDeletionRule("7e59b33d-05f3-4078-b251-c7831ae8fe14")}) // DeleteFirewallRulesOpts | + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.PublicCloudAPI.DeleteFirewallRules(context.Background(), instanceId).DeleteFirewallRulesOpts(deleteFirewallRulesOpts).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicCloudAPI.DeleteFirewallRules``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `DeleteFirewallRules`: DeleteFirewallRulesResult + fmt.Fprintf(os.Stdout, "Response from `PublicCloudAPI.DeleteFirewallRules`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**instanceId** | **string** | Instance's ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDeleteFirewallRulesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **deleteFirewallRulesOpts** | [**DeleteFirewallRulesOpts**](DeleteFirewallRulesOpts.md) | | + +### Return type + +[**DeleteFirewallRulesResult**](DeleteFirewallRulesResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DetachIso + +> DetachIso(ctx, instanceId).Execute() + +Detach ISO from instance + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/publicCloud" +) + +func main() { + instanceId := "695ddd91-051f-4dd6-9120-938a927a47d0" // string | Instance's ID + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.PublicCloudAPI.DetachIso(context.Background(), instanceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicCloudAPI.DetachIso``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**instanceId** | **string** | Instance's ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiDetachIsoRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## EditFirewallRules + +> EditFirewallRulesResult EditFirewallRules(ctx, instanceId).EditFirewallRulesOpts(editFirewallRulesOpts).Execute() + +Edit firewall rules in batch + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/publicCloud" +) + +func main() { + instanceId := "695ddd91-051f-4dd6-9120-938a927a47d0" // string | Instance's ID + editFirewallRulesOpts := *openapiclient.NewEditFirewallRulesOpts([]openapiclient.EditRule{*openapiclient.NewEditRule("Protocol_example", NullableInt32(123), NullableInt32(123), int32(-1), int32(-1), "7e59b33d-05f3-4078-b251-c7831ae8fe14", "HTTP rule", "0.0.0.0/0")}) // EditFirewallRulesOpts | + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.PublicCloudAPI.EditFirewallRules(context.Background(), instanceId).EditFirewallRulesOpts(editFirewallRulesOpts).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicCloudAPI.EditFirewallRules``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `EditFirewallRules`: EditFirewallRulesResult + fmt.Fprintf(os.Stdout, "Response from `PublicCloudAPI.EditFirewallRules`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**instanceId** | **string** | Instance's ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiEditFirewallRulesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **editFirewallRulesOpts** | [**EditFirewallRulesOpts**](EditFirewallRulesOpts.md) | | + +### Return type + +[**EditFirewallRulesResult**](EditFirewallRulesResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetConsoleAccessToInstance + +> GetConsoleAccessToInstanceResult GetConsoleAccessToInstance(ctx, instanceId).Execute() + +Get console access + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/publicCloud" +) + +func main() { + instanceId := "695ddd91-051f-4dd6-9120-938a927a47d0" // string | Instance's ID + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.PublicCloudAPI.GetConsoleAccessToInstance(context.Background(), instanceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicCloudAPI.GetConsoleAccessToInstance``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetConsoleAccessToInstance`: GetConsoleAccessToInstanceResult + fmt.Fprintf(os.Stdout, "Response from `PublicCloudAPI.GetConsoleAccessToInstance`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**instanceId** | **string** | Instance's ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetConsoleAccessToInstanceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**GetConsoleAccessToInstanceResult**](GetConsoleAccessToInstanceResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetCredential + +> GetCredentialResult GetCredential(ctx, instanceId, type_, username).Execute() + +Get credentials by type and username + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/publicCloud" +) + +func main() { + instanceId := "695ddd91-051f-4dd6-9120-938a927a47d0" // string | Instance's ID + type_ := "OPERATING_SYSTEM" // string | Credential type + username := "root" // string | Username + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.PublicCloudAPI.GetCredential(context.Background(), instanceId, type_, username).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicCloudAPI.GetCredential``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCredential`: GetCredentialResult + fmt.Fprintf(os.Stdout, "Response from `PublicCloudAPI.GetCredential`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**instanceId** | **string** | Instance's ID | +**type_** | **string** | Credential type | +**username** | **string** | Username | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCredentialRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + +### Return type + +[**GetCredentialResult**](GetCredentialResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetCredentialList + +> GetCredentialListResult GetCredentialList(ctx, instanceId).Execute() + +List credentials stored for instance + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/publicCloud" +) + +func main() { + instanceId := "695ddd91-051f-4dd6-9120-938a927a47d0" // string | Instance's ID + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.PublicCloudAPI.GetCredentialList(context.Background(), instanceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicCloudAPI.GetCredentialList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCredentialList`: GetCredentialListResult + fmt.Fprintf(os.Stdout, "Response from `PublicCloudAPI.GetCredentialList`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**instanceId** | **string** | Instance's ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCredentialListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**GetCredentialListResult**](GetCredentialListResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetCredentialListByType + +> GetCredentialListByTypeResult GetCredentialListByType(ctx, instanceId, type_).Execute() + +Get credentials by type + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/publicCloud" +) + +func main() { + instanceId := "695ddd91-051f-4dd6-9120-938a927a47d0" // string | Instance's ID + type_ := "OPERATING_SYSTEM" // string | + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.PublicCloudAPI.GetCredentialListByType(context.Background(), instanceId, type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicCloudAPI.GetCredentialListByType``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetCredentialListByType`: GetCredentialListByTypeResult + fmt.Fprintf(os.Stdout, "Response from `PublicCloudAPI.GetCredentialListByType`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**instanceId** | **string** | Instance's ID | +**type_** | **string** | | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetCredentialListByTypeRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + +### Return type + +[**GetCredentialListByTypeResult**](GetCredentialListByTypeResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetExpenses + +> GetExpensesResult GetExpenses(ctx, equipmentId).From(from).To(to).Execute() + +Get costs for a given month. + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + "time" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/publicCloud" +) + +func main() { + equipmentId := "695ddd91-051f-4dd6-9120-938a927a47d0" // string | Equipment's UUID + from := time.Now() // string | Start date of the period to get costs for. It must be the first day of the month + to := time.Now() // string | End date of the period to get costs for. This date needs to be exactly one month after the 'from' date. If this value is not passed, it will be calculated based on 'from' parameter (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.PublicCloudAPI.GetExpenses(context.Background(), equipmentId).From(from).To(to).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicCloudAPI.GetExpenses``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetExpenses`: GetExpensesResult + fmt.Fprintf(os.Stdout, "Response from `PublicCloudAPI.GetExpenses`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**equipmentId** | **string** | Equipment's UUID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetExpensesRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **from** | **string** | Start date of the period to get costs for. It must be the first day of the month | + **to** | **string** | End date of the period to get costs for. This date needs to be exactly one month after the 'from' date. If this value is not passed, it will be calculated based on 'from' parameter | + +### Return type + +[**GetExpensesResult**](GetExpensesResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetFirewallRuleList + +> GetFirewallRuleListResult GetFirewallRuleList(ctx, instanceId).Limit(limit).Offset(offset).Execute() + +List firewall rules + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/publicCloud" +) + +func main() { + instanceId := "695ddd91-051f-4dd6-9120-938a927a47d0" // string | Instance's ID + limit := int32(20) // int32 | Limit the number of results returned. (optional) + offset := int32(10) // int32 | Return results starting from the given offset. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.PublicCloudAPI.GetFirewallRuleList(context.Background(), instanceId).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicCloudAPI.GetFirewallRuleList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetFirewallRuleList`: GetFirewallRuleListResult + fmt.Fprintf(os.Stdout, "Response from `PublicCloudAPI.GetFirewallRuleList`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**instanceId** | **string** | Instance's ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetFirewallRuleListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **limit** | **int32** | Limit the number of results returned. | + **offset** | **int32** | Return results starting from the given offset. | + +### Return type + +[**GetFirewallRuleListResult**](GetFirewallRuleListResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetInstance + +> GetInstanceResult GetInstance(ctx, instanceId).Execute() + +Get instance details + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/publicCloud" +) + +func main() { + instanceId := "695ddd91-051f-4dd6-9120-938a927a47d0" // string | Instance's ID + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.PublicCloudAPI.GetInstance(context.Background(), instanceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicCloudAPI.GetInstance``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetInstance`: GetInstanceResult + fmt.Fprintf(os.Stdout, "Response from `PublicCloudAPI.GetInstance`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**instanceId** | **string** | Instance's ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetInstanceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**GetInstanceResult**](GetInstanceResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetInstanceTypeList + +> GetInstanceTypeListResult GetInstanceTypeList(ctx).Region(region).Limit(limit).Offset(offset).Execute() + +List instance types + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/publicCloud" +) + +func main() { + region := "region_example" // string | + limit := int32(56) // int32 | (optional) (default to 50) + offset := int32(56) // int32 | (optional) (default to 0) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.PublicCloudAPI.GetInstanceTypeList(context.Background()).Region(region).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicCloudAPI.GetInstanceTypeList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetInstanceTypeList`: GetInstanceTypeListResult + fmt.Fprintf(os.Stdout, "Response from `PublicCloudAPI.GetInstanceTypeList`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetInstanceTypeListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **region** | **string** | | + **limit** | **int32** | | [default to 50] + **offset** | **int32** | | [default to 0] + +### Return type + +[**GetInstanceTypeListResult**](GetInstanceTypeListResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetIsoList + +> GetIsoListResult GetIsoList(ctx).Limit(limit).Offset(offset).Execute() + +List available ISOs + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/publicCloud" +) + +func main() { + limit := int32(20) // int32 | Limit the number of results returned. (optional) + offset := int32(10) // int32 | Return results starting from the given offset. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.PublicCloudAPI.GetIsoList(context.Background()).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicCloudAPI.GetIsoList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetIsoList`: GetIsoListResult + fmt.Fprintf(os.Stdout, "Response from `PublicCloudAPI.GetIsoList`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetIsoListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **limit** | **int32** | Limit the number of results returned. | + **offset** | **int32** | Return results starting from the given offset. | + +### Return type + +[**GetIsoListResult**](GetIsoListResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetMarketAppList + +> GetMarketAppListResult GetMarketAppList(ctx).Execute() + +Get marketplace apps + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/publicCloud" +) + +func main() { + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.PublicCloudAPI.GetMarketAppList(context.Background()).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicCloudAPI.GetMarketAppList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetMarketAppList`: GetMarketAppListResult + fmt.Fprintf(os.Stdout, "Response from `PublicCloudAPI.GetMarketAppList`: %v\n", resp) +} +``` + +### Path Parameters + +This endpoint does not need any parameter. + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetMarketAppListRequest struct via the builder pattern + + +### Return type + +[**GetMarketAppListResult**](GetMarketAppListResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetOperatingSystemList + +> GetOperatingSystemListResult GetOperatingSystemList(ctx).Limit(limit).Offset(offset).Execute() + +List all available Operating Systems + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/publicCloud" +) + +func main() { + limit := int32(20) // int32 | Limit the number of results returned. (optional) + offset := int32(10) // int32 | Return results starting from the given offset. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.PublicCloudAPI.GetOperatingSystemList(context.Background()).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicCloudAPI.GetOperatingSystemList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetOperatingSystemList`: GetOperatingSystemListResult + fmt.Fprintf(os.Stdout, "Response from `PublicCloudAPI.GetOperatingSystemList`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetOperatingSystemListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **limit** | **int32** | Limit the number of results returned. | + **offset** | **int32** | Return results starting from the given offset. | + +### Return type + +[**GetOperatingSystemListResult**](GetOperatingSystemListResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetReinstallOsList + +> []OperatingSystem GetReinstallOsList(ctx, instanceId).Execute() + +List OSes available for reinstall + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/publicCloud" +) + +func main() { + instanceId := "695ddd91-051f-4dd6-9120-938a927a47d0" // string | Instance's ID + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.PublicCloudAPI.GetReinstallOsList(context.Background(), instanceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicCloudAPI.GetReinstallOsList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetReinstallOsList`: []OperatingSystem + fmt.Fprintf(os.Stdout, "Response from `PublicCloudAPI.GetReinstallOsList`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**instanceId** | **string** | Instance's ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetReinstallOsListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + +[**[]OperatingSystem**](OperatingSystem.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetUpdateInstanceTypeList + +> GetUpdateInstanceTypeListResult GetUpdateInstanceTypeList(ctx, instanceId).Limit(limit).Offset(offset).Execute() + +List available instance types for update + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/publicCloud" +) + +func main() { + instanceId := "695ddd91-051f-4dd6-9120-938a927a47d0" // string | Instance's ID + limit := int32(56) // int32 | (optional) (default to 50) + offset := int32(56) // int32 | (optional) (default to 0) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.PublicCloudAPI.GetUpdateInstanceTypeList(context.Background(), instanceId).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicCloudAPI.GetUpdateInstanceTypeList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `GetUpdateInstanceTypeList`: GetUpdateInstanceTypeListResult + fmt.Fprintf(os.Stdout, "Response from `PublicCloudAPI.GetUpdateInstanceTypeList`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**instanceId** | **string** | Instance's ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiGetUpdateInstanceTypeListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **limit** | **int32** | | [default to 50] + **offset** | **int32** | | [default to 0] + +### Return type + +[**GetUpdateInstanceTypeListResult**](GetUpdateInstanceTypeListResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## InstanceList + +> GetInstanceListResult InstanceList(ctx).Limit(limit).Offset(offset).Ip(ip).Reference(reference).Id(id).Filter(filter).ContractType(contractType).State(state).Region(region).Type_(type_).Execute() + +Get instance list + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/publicCloud" +) + +func main() { + limit := int32(20) // int32 | Limit the number of results returned. (optional) + offset := int32(10) // int32 | Return results starting from the given offset. (optional) + ip := "10.0.0.1" // string | (optional) + reference := "my-webserver" // string | (optional) + id := "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11" // string | (optional) + filter := "my-webserver" // string | Using this parameter, you can filter by id, reference or IP. (optional) + contractType := "HOURLY" // string | (optional) + state := "RUNNING" // string | (optional) + region := "eu-west-3" // string | Available regions can be found using the List Regions endpoint. (optional) + type_ := "lsw.c3.xlarge" // string | Available instance types can be found using the List Instance Types endpoint. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.PublicCloudAPI.InstanceList(context.Background()).Limit(limit).Offset(offset).Ip(ip).Reference(reference).Id(id).Filter(filter).ContractType(contractType).State(state).Region(region).Type_(type_).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicCloudAPI.InstanceList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `InstanceList`: GetInstanceListResult + fmt.Fprintf(os.Stdout, "Response from `PublicCloudAPI.InstanceList`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiInstanceListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **limit** | **int32** | Limit the number of results returned. | + **offset** | **int32** | Return results starting from the given offset. | + **ip** | **string** | | + **reference** | **string** | | + **id** | **string** | | + **filter** | **string** | Using this parameter, you can filter by id, reference or IP. | + **contractType** | **string** | | + **state** | **string** | | + **region** | **string** | Available regions can be found using the List Regions endpoint. | + **type_** | **string** | Available instance types can be found using the List Instance Types endpoint. | + +### Return type + +[**GetInstanceListResult**](GetInstanceListResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## LaunchInstance + +> LaunchInstanceCreatedResult LaunchInstance(ctx).LaunchInstanceOpts(launchInstanceOpts).Execute() + +Launch instance + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/publicCloud" +) + +func main() { + launchInstanceOpts := *openapiclient.NewLaunchInstanceOpts("Region_example", "UBUNTU_22_04_64BIT", "ContractType_example", int32(123), int32(123), "RootDiskStorageType_example") // LaunchInstanceOpts | + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.PublicCloudAPI.LaunchInstance(context.Background()).LaunchInstanceOpts(launchInstanceOpts).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicCloudAPI.LaunchInstance``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `LaunchInstance`: LaunchInstanceCreatedResult + fmt.Fprintf(os.Stdout, "Response from `PublicCloudAPI.LaunchInstance`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiLaunchInstanceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **launchInstanceOpts** | [**LaunchInstanceOpts**](LaunchInstanceOpts.md) | | + +### Return type + +[**LaunchInstanceCreatedResult**](LaunchInstanceCreatedResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## RebootInstance + +> RebootInstance(ctx, instanceId).Execute() + +Reboot instance + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/publicCloud" +) + +func main() { + instanceId := "695ddd91-051f-4dd6-9120-938a927a47d0" // string | Instance's ID + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.PublicCloudAPI.RebootInstance(context.Background(), instanceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicCloudAPI.RebootInstance``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**instanceId** | **string** | Instance's ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiRebootInstanceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## RegionsList + +> GetRegionListResult RegionsList(ctx).Limit(limit).Offset(offset).Execute() + +List regions + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/publicCloud" +) + +func main() { + limit := int32(20) // int32 | Limit the number of results returned. (optional) + offset := int32(10) // int32 | Return results starting from the given offset. (optional) + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.PublicCloudAPI.RegionsList(context.Background()).Limit(limit).Offset(offset).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicCloudAPI.RegionsList``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `RegionsList`: GetRegionListResult + fmt.Fprintf(os.Stdout, "Response from `PublicCloudAPI.RegionsList`: %v\n", resp) +} +``` + +### Path Parameters + + + +### Other Parameters + +Other parameters are passed through a pointer to a apiRegionsListRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **limit** | **int32** | Limit the number of results returned. | + **offset** | **int32** | Return results starting from the given offset. | + +### Return type + +[**GetRegionListResult**](GetRegionListResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ResetPassword + +> ResetPassword(ctx, instanceId).Execute() + +Reset instance password + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/publicCloud" +) + +func main() { + instanceId := "695ddd91-051f-4dd6-9120-938a927a47d0" // string | Instance's ID + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.PublicCloudAPI.ResetPassword(context.Background(), instanceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicCloudAPI.ResetPassword``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**instanceId** | **string** | Instance's ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiResetPasswordRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## StartInstance + +> StartInstance(ctx, instanceId).Execute() + +Start instance + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/publicCloud" +) + +func main() { + instanceId := "695ddd91-051f-4dd6-9120-938a927a47d0" // string | Instance's ID + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.PublicCloudAPI.StartInstance(context.Background(), instanceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicCloudAPI.StartInstance``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**instanceId** | **string** | Instance's ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiStartInstanceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## StopInstance + +> StopInstance(ctx, instanceId).Execute() + +Stop instance + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/publicCloud" +) + +func main() { + instanceId := "695ddd91-051f-4dd6-9120-938a927a47d0" // string | Instance's ID + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.PublicCloudAPI.StopInstance(context.Background(), instanceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicCloudAPI.StopInstance``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**instanceId** | **string** | Instance's ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiStopInstanceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## StoreCredential + +> StoreCredentialResult StoreCredential(ctx, instanceId).StoreCredentialOpts(storeCredentialOpts).Execute() + +Store credentials + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/publicCloud" +) + +func main() { + instanceId := "695ddd91-051f-4dd6-9120-938a927a47d0" // string | Instance's ID + storeCredentialOpts := *openapiclient.NewStoreCredentialOpts(openapiclient.credentialType("OPERATING_SYSTEM"), "Username_example", "Password_example") // StoreCredentialOpts | + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.PublicCloudAPI.StoreCredential(context.Background(), instanceId).StoreCredentialOpts(storeCredentialOpts).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicCloudAPI.StoreCredential``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `StoreCredential`: StoreCredentialResult + fmt.Fprintf(os.Stdout, "Response from `PublicCloudAPI.StoreCredential`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**instanceId** | **string** | Instance's ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiStoreCredentialRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **storeCredentialOpts** | [**StoreCredentialOpts**](StoreCredentialOpts.md) | | + +### Return type + +[**StoreCredentialResult**](StoreCredentialResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## TerminateInstance + +> TerminateInstance(ctx, instanceId).Execute() + +Terminate instance + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/publicCloud" +) + +func main() { + instanceId := "695ddd91-051f-4dd6-9120-938a927a47d0" // string | Instance's ID + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + r, err := apiClient.PublicCloudAPI.TerminateInstance(context.Background(), instanceId).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicCloudAPI.TerminateInstance``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**instanceId** | **string** | Instance's ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiTerminateInstanceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + +### Return type + + (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateCredential + +> UpdateCredentialResult UpdateCredential(ctx, instanceId, type_, username).UpdateCredentialOpts(updateCredentialOpts).Execute() + +Update credentials + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/publicCloud" +) + +func main() { + instanceId := "695ddd91-051f-4dd6-9120-938a927a47d0" // string | Instance's ID + type_ := "OPERATING_SYSTEM" // string | Credential type + username := "root" // string | Username + updateCredentialOpts := *openapiclient.NewUpdateCredentialOpts("Password_example") // UpdateCredentialOpts | + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.PublicCloudAPI.UpdateCredential(context.Background(), instanceId, type_, username).UpdateCredentialOpts(updateCredentialOpts).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicCloudAPI.UpdateCredential``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateCredential`: UpdateCredentialResult + fmt.Fprintf(os.Stdout, "Response from `PublicCloudAPI.UpdateCredential`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**instanceId** | **string** | Instance's ID | +**type_** | **string** | Credential type | +**username** | **string** | Username | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateCredentialRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + + + **updateCredentialOpts** | [**UpdateCredentialOpts**](UpdateCredentialOpts.md) | | + +### Return type + +[**UpdateCredentialResult**](UpdateCredentialResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateInstance + +> UpdateInstanceResult UpdateInstance(ctx, instanceId).UpdateInstanceOpts(updateInstanceOpts).Execute() + +Update instance + + + +### Example + +```go +package main + +import ( + "context" + "fmt" + "os" + openapiclient "github.com/leaseweb/leaseweb-go-sdk/publicCloud" +) + +func main() { + instanceId := "695ddd91-051f-4dd6-9120-938a927a47d0" // string | Instance's ID + updateInstanceOpts := *openapiclient.NewUpdateInstanceOpts() // UpdateInstanceOpts | + + configuration := openapiclient.NewConfiguration() + apiClient := openapiclient.NewAPIClient(configuration) + resp, r, err := apiClient.PublicCloudAPI.UpdateInstance(context.Background(), instanceId).UpdateInstanceOpts(updateInstanceOpts).Execute() + if err != nil { + fmt.Fprintf(os.Stderr, "Error when calling `PublicCloudAPI.UpdateInstance``: %v\n", err) + fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) + } + // response from `UpdateInstance`: UpdateInstanceResult + fmt.Fprintf(os.Stdout, "Response from `PublicCloudAPI.UpdateInstance`: %v\n", resp) +} +``` + +### Path Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**instanceId** | **string** | Instance's ID | + +### Other Parameters + +Other parameters are passed through a pointer to a apiUpdateInstanceRequest struct via the builder pattern + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + + **updateInstanceOpts** | [**UpdateInstanceOpts**](UpdateInstanceOpts.md) | | + +### Return type + +[**UpdateInstanceResult**](UpdateInstanceResult.md) + +### Authorization + +[OAuth2](../README.md#OAuth2), [ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/publicCloud/docs/PublicNetworkSpeed.md b/publicCloud/docs/PublicNetworkSpeed.md new file mode 100644 index 0000000..f7a4079 --- /dev/null +++ b/publicCloud/docs/PublicNetworkSpeed.md @@ -0,0 +1,82 @@ +# PublicNetworkSpeed + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **int32** | | [optional] +**Unit** | Pointer to **string** | | [optional] + +## Methods + +### NewPublicNetworkSpeed + +`func NewPublicNetworkSpeed() *PublicNetworkSpeed` + +NewPublicNetworkSpeed instantiates a new PublicNetworkSpeed object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewPublicNetworkSpeedWithDefaults + +`func NewPublicNetworkSpeedWithDefaults() *PublicNetworkSpeed` + +NewPublicNetworkSpeedWithDefaults instantiates a new PublicNetworkSpeed object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetValue + +`func (o *PublicNetworkSpeed) GetValue() int32` + +GetValue returns the Value field if non-nil, zero value otherwise. + +### GetValueOk + +`func (o *PublicNetworkSpeed) GetValueOk() (*int32, bool)` + +GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValue + +`func (o *PublicNetworkSpeed) SetValue(v int32)` + +SetValue sets Value field to given value. + +### HasValue + +`func (o *PublicNetworkSpeed) HasValue() bool` + +HasValue returns a boolean if a field has been set. + +### GetUnit + +`func (o *PublicNetworkSpeed) GetUnit() string` + +GetUnit returns the Unit field if non-nil, zero value otherwise. + +### GetUnitOk + +`func (o *PublicNetworkSpeed) GetUnitOk() (*string, bool)` + +GetUnitOk returns a tuple with the Unit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnit + +`func (o *PublicNetworkSpeed) SetUnit(v string)` + +SetUnit sets Unit field to given value. + +### HasUnit + +`func (o *PublicNetworkSpeed) HasUnit() bool` + +HasUnit returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/Region.md b/publicCloud/docs/Region.md new file mode 100644 index 0000000..55f164d --- /dev/null +++ b/publicCloud/docs/Region.md @@ -0,0 +1,82 @@ +# Region + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | The region's name. | [optional] +**Location** | Pointer to **string** | The city where the region is located. | [optional] + +## Methods + +### NewRegion + +`func NewRegion() *Region` + +NewRegion instantiates a new Region object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewRegionWithDefaults + +`func NewRegionWithDefaults() *Region` + +NewRegionWithDefaults instantiates a new Region object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetName + +`func (o *Region) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *Region) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *Region) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *Region) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetLocation + +`func (o *Region) GetLocation() string` + +GetLocation returns the Location field if non-nil, zero value otherwise. + +### GetLocationOk + +`func (o *Region) GetLocationOk() (*string, bool)` + +GetLocationOk returns a tuple with the Location field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocation + +`func (o *Region) SetLocation(v string)` + +SetLocation sets Location field to given value. + +### HasLocation + +`func (o *Region) HasLocation() bool` + +HasLocation returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/Storage.md b/publicCloud/docs/Storage.md new file mode 100644 index 0000000..9b15759 --- /dev/null +++ b/publicCloud/docs/Storage.md @@ -0,0 +1,82 @@ +# Storage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Local** | Pointer to [**Local**](Local.md) | | [optional] +**Central** | Pointer to [**Central**](Central.md) | | [optional] + +## Methods + +### NewStorage + +`func NewStorage() *Storage` + +NewStorage instantiates a new Storage object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewStorageWithDefaults + +`func NewStorageWithDefaults() *Storage` + +NewStorageWithDefaults instantiates a new Storage object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetLocal + +`func (o *Storage) GetLocal() Local` + +GetLocal returns the Local field if non-nil, zero value otherwise. + +### GetLocalOk + +`func (o *Storage) GetLocalOk() (*Local, bool)` + +GetLocalOk returns a tuple with the Local field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetLocal + +`func (o *Storage) SetLocal(v Local)` + +SetLocal sets Local field to given value. + +### HasLocal + +`func (o *Storage) HasLocal() bool` + +HasLocal returns a boolean if a field has been set. + +### GetCentral + +`func (o *Storage) GetCentral() Central` + +GetCentral returns the Central field if non-nil, zero value otherwise. + +### GetCentralOk + +`func (o *Storage) GetCentralOk() (*Central, bool)` + +GetCentralOk returns a tuple with the Central field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCentral + +`func (o *Storage) SetCentral(v Central)` + +SetCentral sets Central field to given value. + +### HasCentral + +`func (o *Storage) HasCentral() bool` + +HasCentral returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/StoreCredentialOpts.md b/publicCloud/docs/StoreCredentialOpts.md new file mode 100644 index 0000000..ba12849 --- /dev/null +++ b/publicCloud/docs/StoreCredentialOpts.md @@ -0,0 +1,93 @@ +# StoreCredentialOpts + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**CredentialType**](CredentialType.md) | | +**Username** | **string** | Can contain only alphanumeric values and characters `@`, `.`, `-` and `_` | +**Password** | **string** | The password you'd like to store | + +## Methods + +### NewStoreCredentialOpts + +`func NewStoreCredentialOpts(type_ CredentialType, username string, password string, ) *StoreCredentialOpts` + +NewStoreCredentialOpts instantiates a new StoreCredentialOpts object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewStoreCredentialOptsWithDefaults + +`func NewStoreCredentialOptsWithDefaults() *StoreCredentialOpts` + +NewStoreCredentialOptsWithDefaults instantiates a new StoreCredentialOpts object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetType + +`func (o *StoreCredentialOpts) GetType() CredentialType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *StoreCredentialOpts) GetTypeOk() (*CredentialType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *StoreCredentialOpts) SetType(v CredentialType)` + +SetType sets Type field to given value. + + +### GetUsername + +`func (o *StoreCredentialOpts) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *StoreCredentialOpts) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *StoreCredentialOpts) SetUsername(v string)` + +SetUsername sets Username field to given value. + + +### GetPassword + +`func (o *StoreCredentialOpts) GetPassword() string` + +GetPassword returns the Password field if non-nil, zero value otherwise. + +### GetPasswordOk + +`func (o *StoreCredentialOpts) GetPasswordOk() (*string, bool)` + +GetPasswordOk returns a tuple with the Password field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPassword + +`func (o *StoreCredentialOpts) SetPassword(v string)` + +SetPassword sets Password field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/StoreCredentialResult.md b/publicCloud/docs/StoreCredentialResult.md new file mode 100644 index 0000000..978594e --- /dev/null +++ b/publicCloud/docs/StoreCredentialResult.md @@ -0,0 +1,108 @@ +# StoreCredentialResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**CredentialType**](CredentialType.md) | | [optional] +**Username** | Pointer to **string** | The provided username | [optional] +**Password** | Pointer to **string** | The provided password | [optional] + +## Methods + +### NewStoreCredentialResult + +`func NewStoreCredentialResult() *StoreCredentialResult` + +NewStoreCredentialResult instantiates a new StoreCredentialResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewStoreCredentialResultWithDefaults + +`func NewStoreCredentialResultWithDefaults() *StoreCredentialResult` + +NewStoreCredentialResultWithDefaults instantiates a new StoreCredentialResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetType + +`func (o *StoreCredentialResult) GetType() CredentialType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *StoreCredentialResult) GetTypeOk() (*CredentialType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *StoreCredentialResult) SetType(v CredentialType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *StoreCredentialResult) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetUsername + +`func (o *StoreCredentialResult) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *StoreCredentialResult) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *StoreCredentialResult) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *StoreCredentialResult) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + +### GetPassword + +`func (o *StoreCredentialResult) GetPassword() string` + +GetPassword returns the Password field if non-nil, zero value otherwise. + +### GetPasswordOk + +`func (o *StoreCredentialResult) GetPasswordOk() (*string, bool)` + +GetPasswordOk returns a tuple with the Password field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPassword + +`func (o *StoreCredentialResult) SetPassword(v string)` + +SetPassword sets Password field to given value. + +### HasPassword + +`func (o *StoreCredentialResult) HasPassword() bool` + +HasPassword returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/TcpUdpFirewallRule.md b/publicCloud/docs/TcpUdpFirewallRule.md new file mode 100644 index 0000000..e176201 --- /dev/null +++ b/publicCloud/docs/TcpUdpFirewallRule.md @@ -0,0 +1,258 @@ +# TcpUdpFirewallRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **string** | | [optional] +**Name** | Pointer to **NullableString** | | [optional] +**Cidr** | Pointer to **string** | | [optional] +**Protocol** | Pointer to **string** | | [optional] +**StartPort** | **int32** | | +**EndPort** | **int32** | Value will be equals to the startPort when not provided | +**IcmpType** | Pointer to **NullableInt32** | | [optional] +**IcmpCode** | Pointer to **NullableInt32** | | [optional] + +## Methods + +### NewTcpUdpFirewallRule + +`func NewTcpUdpFirewallRule(startPort int32, endPort int32, ) *TcpUdpFirewallRule` + +NewTcpUdpFirewallRule instantiates a new TcpUdpFirewallRule object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTcpUdpFirewallRuleWithDefaults + +`func NewTcpUdpFirewallRuleWithDefaults() *TcpUdpFirewallRule` + +NewTcpUdpFirewallRuleWithDefaults instantiates a new TcpUdpFirewallRule object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetId + +`func (o *TcpUdpFirewallRule) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *TcpUdpFirewallRule) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *TcpUdpFirewallRule) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *TcpUdpFirewallRule) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetName + +`func (o *TcpUdpFirewallRule) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *TcpUdpFirewallRule) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *TcpUdpFirewallRule) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *TcpUdpFirewallRule) HasName() bool` + +HasName returns a boolean if a field has been set. + +### SetNameNil + +`func (o *TcpUdpFirewallRule) SetNameNil(b bool)` + + SetNameNil sets the value for Name to be an explicit nil + +### UnsetName +`func (o *TcpUdpFirewallRule) UnsetName()` + +UnsetName ensures that no value is present for Name, not even an explicit nil +### GetCidr + +`func (o *TcpUdpFirewallRule) GetCidr() string` + +GetCidr returns the Cidr field if non-nil, zero value otherwise. + +### GetCidrOk + +`func (o *TcpUdpFirewallRule) GetCidrOk() (*string, bool)` + +GetCidrOk returns a tuple with the Cidr field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCidr + +`func (o *TcpUdpFirewallRule) SetCidr(v string)` + +SetCidr sets Cidr field to given value. + +### HasCidr + +`func (o *TcpUdpFirewallRule) HasCidr() bool` + +HasCidr returns a boolean if a field has been set. + +### GetProtocol + +`func (o *TcpUdpFirewallRule) GetProtocol() string` + +GetProtocol returns the Protocol field if non-nil, zero value otherwise. + +### GetProtocolOk + +`func (o *TcpUdpFirewallRule) GetProtocolOk() (*string, bool)` + +GetProtocolOk returns a tuple with the Protocol field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetProtocol + +`func (o *TcpUdpFirewallRule) SetProtocol(v string)` + +SetProtocol sets Protocol field to given value. + +### HasProtocol + +`func (o *TcpUdpFirewallRule) HasProtocol() bool` + +HasProtocol returns a boolean if a field has been set. + +### GetStartPort + +`func (o *TcpUdpFirewallRule) GetStartPort() int32` + +GetStartPort returns the StartPort field if non-nil, zero value otherwise. + +### GetStartPortOk + +`func (o *TcpUdpFirewallRule) GetStartPortOk() (*int32, bool)` + +GetStartPortOk returns a tuple with the StartPort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartPort + +`func (o *TcpUdpFirewallRule) SetStartPort(v int32)` + +SetStartPort sets StartPort field to given value. + + +### GetEndPort + +`func (o *TcpUdpFirewallRule) GetEndPort() int32` + +GetEndPort returns the EndPort field if non-nil, zero value otherwise. + +### GetEndPortOk + +`func (o *TcpUdpFirewallRule) GetEndPortOk() (*int32, bool)` + +GetEndPortOk returns a tuple with the EndPort field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEndPort + +`func (o *TcpUdpFirewallRule) SetEndPort(v int32)` + +SetEndPort sets EndPort field to given value. + + +### GetIcmpType + +`func (o *TcpUdpFirewallRule) GetIcmpType() int32` + +GetIcmpType returns the IcmpType field if non-nil, zero value otherwise. + +### GetIcmpTypeOk + +`func (o *TcpUdpFirewallRule) GetIcmpTypeOk() (*int32, bool)` + +GetIcmpTypeOk returns a tuple with the IcmpType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIcmpType + +`func (o *TcpUdpFirewallRule) SetIcmpType(v int32)` + +SetIcmpType sets IcmpType field to given value. + +### HasIcmpType + +`func (o *TcpUdpFirewallRule) HasIcmpType() bool` + +HasIcmpType returns a boolean if a field has been set. + +### SetIcmpTypeNil + +`func (o *TcpUdpFirewallRule) SetIcmpTypeNil(b bool)` + + SetIcmpTypeNil sets the value for IcmpType to be an explicit nil + +### UnsetIcmpType +`func (o *TcpUdpFirewallRule) UnsetIcmpType()` + +UnsetIcmpType ensures that no value is present for IcmpType, not even an explicit nil +### GetIcmpCode + +`func (o *TcpUdpFirewallRule) GetIcmpCode() int32` + +GetIcmpCode returns the IcmpCode field if non-nil, zero value otherwise. + +### GetIcmpCodeOk + +`func (o *TcpUdpFirewallRule) GetIcmpCodeOk() (*int32, bool)` + +GetIcmpCodeOk returns a tuple with the IcmpCode field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIcmpCode + +`func (o *TcpUdpFirewallRule) SetIcmpCode(v int32)` + +SetIcmpCode sets IcmpCode field to given value. + +### HasIcmpCode + +`func (o *TcpUdpFirewallRule) HasIcmpCode() bool` + +HasIcmpCode returns a boolean if a field has been set. + +### SetIcmpCodeNil + +`func (o *TcpUdpFirewallRule) SetIcmpCodeNil(b bool)` + + SetIcmpCodeNil sets the value for IcmpCode to be an explicit nil + +### UnsetIcmpCode +`func (o *TcpUdpFirewallRule) UnsetIcmpCode()` + +UnsetIcmpCode ensures that no value is present for IcmpCode, not even an explicit nil + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/Tier.md b/publicCloud/docs/Tier.md new file mode 100644 index 0000000..ad3cf6d --- /dev/null +++ b/publicCloud/docs/Tier.md @@ -0,0 +1,82 @@ +# Tier + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Usage** | Pointer to **float32** | Traffic sent, in GB | [optional] +**Price** | Pointer to **float32** | Total price of the tier, based on the usage. The first tier is free, so this will be 0 for the first tier. From tier 1 onwards, the usage has costs. Each tier has it own price. | [optional] + +## Methods + +### NewTier + +`func NewTier() *Tier` + +NewTier instantiates a new Tier object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTierWithDefaults + +`func NewTierWithDefaults() *Tier` + +NewTierWithDefaults instantiates a new Tier object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetUsage + +`func (o *Tier) GetUsage() float32` + +GetUsage returns the Usage field if non-nil, zero value otherwise. + +### GetUsageOk + +`func (o *Tier) GetUsageOk() (*float32, bool)` + +GetUsageOk returns a tuple with the Usage field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsage + +`func (o *Tier) SetUsage(v float32)` + +SetUsage sets Usage field to given value. + +### HasUsage + +`func (o *Tier) HasUsage() bool` + +HasUsage returns a boolean if a field has been set. + +### GetPrice + +`func (o *Tier) GetPrice() float32` + +GetPrice returns the Price field if non-nil, zero value otherwise. + +### GetPriceOk + +`func (o *Tier) GetPriceOk() (*float32, bool)` + +GetPriceOk returns a tuple with the Price field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrice + +`func (o *Tier) SetPrice(v float32)` + +SetPrice sets Price field to given value. + +### HasPrice + +`func (o *Tier) HasPrice() bool` + +HasPrice returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/Traffic.md b/publicCloud/docs/Traffic.md new file mode 100644 index 0000000..55cc523 --- /dev/null +++ b/publicCloud/docs/Traffic.md @@ -0,0 +1,82 @@ +# Traffic + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Unit** | Pointer to **string** | | [optional] +**Values** | Pointer to [**Values**](Values.md) | | [optional] + +## Methods + +### NewTraffic + +`func NewTraffic() *Traffic` + +NewTraffic instantiates a new Traffic object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewTrafficWithDefaults + +`func NewTrafficWithDefaults() *Traffic` + +NewTrafficWithDefaults instantiates a new Traffic object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetUnit + +`func (o *Traffic) GetUnit() string` + +GetUnit returns the Unit field if non-nil, zero value otherwise. + +### GetUnitOk + +`func (o *Traffic) GetUnitOk() (*string, bool)` + +GetUnitOk returns a tuple with the Unit field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUnit + +`func (o *Traffic) SetUnit(v string)` + +SetUnit sets Unit field to given value. + +### HasUnit + +`func (o *Traffic) HasUnit() bool` + +HasUnit returns a boolean if a field has been set. + +### GetValues + +`func (o *Traffic) GetValues() Values` + +GetValues returns the Values field if non-nil, zero value otherwise. + +### GetValuesOk + +`func (o *Traffic) GetValuesOk() (*Values, bool)` + +GetValuesOk returns a tuple with the Values field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetValues + +`func (o *Traffic) SetValues(v Values)` + +SetValues sets Values field to given value. + +### HasValues + +`func (o *Traffic) HasValues() bool` + +HasValues returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/UpdateCredentialOpts.md b/publicCloud/docs/UpdateCredentialOpts.md new file mode 100644 index 0000000..c1617d2 --- /dev/null +++ b/publicCloud/docs/UpdateCredentialOpts.md @@ -0,0 +1,51 @@ +# UpdateCredentialOpts + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Password** | **string** | The new password | + +## Methods + +### NewUpdateCredentialOpts + +`func NewUpdateCredentialOpts(password string, ) *UpdateCredentialOpts` + +NewUpdateCredentialOpts instantiates a new UpdateCredentialOpts object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUpdateCredentialOptsWithDefaults + +`func NewUpdateCredentialOptsWithDefaults() *UpdateCredentialOpts` + +NewUpdateCredentialOptsWithDefaults instantiates a new UpdateCredentialOpts object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetPassword + +`func (o *UpdateCredentialOpts) GetPassword() string` + +GetPassword returns the Password field if non-nil, zero value otherwise. + +### GetPasswordOk + +`func (o *UpdateCredentialOpts) GetPasswordOk() (*string, bool)` + +GetPasswordOk returns a tuple with the Password field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPassword + +`func (o *UpdateCredentialOpts) SetPassword(v string)` + +SetPassword sets Password field to given value. + + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/UpdateCredentialResult.md b/publicCloud/docs/UpdateCredentialResult.md new file mode 100644 index 0000000..b6a0f41 --- /dev/null +++ b/publicCloud/docs/UpdateCredentialResult.md @@ -0,0 +1,108 @@ +# UpdateCredentialResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**CredentialType**](CredentialType.md) | | [optional] +**Username** | Pointer to **string** | The provided username | [optional] +**Password** | Pointer to **string** | The provided password | [optional] + +## Methods + +### NewUpdateCredentialResult + +`func NewUpdateCredentialResult() *UpdateCredentialResult` + +NewUpdateCredentialResult instantiates a new UpdateCredentialResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUpdateCredentialResultWithDefaults + +`func NewUpdateCredentialResultWithDefaults() *UpdateCredentialResult` + +NewUpdateCredentialResultWithDefaults instantiates a new UpdateCredentialResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetType + +`func (o *UpdateCredentialResult) GetType() CredentialType` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *UpdateCredentialResult) GetTypeOk() (*CredentialType, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *UpdateCredentialResult) SetType(v CredentialType)` + +SetType sets Type field to given value. + +### HasType + +`func (o *UpdateCredentialResult) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetUsername + +`func (o *UpdateCredentialResult) GetUsername() string` + +GetUsername returns the Username field if non-nil, zero value otherwise. + +### GetUsernameOk + +`func (o *UpdateCredentialResult) GetUsernameOk() (*string, bool)` + +GetUsernameOk returns a tuple with the Username field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetUsername + +`func (o *UpdateCredentialResult) SetUsername(v string)` + +SetUsername sets Username field to given value. + +### HasUsername + +`func (o *UpdateCredentialResult) HasUsername() bool` + +HasUsername returns a boolean if a field has been set. + +### GetPassword + +`func (o *UpdateCredentialResult) GetPassword() string` + +GetPassword returns the Password field if non-nil, zero value otherwise. + +### GetPasswordOk + +`func (o *UpdateCredentialResult) GetPasswordOk() (*string, bool)` + +GetPasswordOk returns a tuple with the Password field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPassword + +`func (o *UpdateCredentialResult) SetPassword(v string)` + +SetPassword sets Password field to given value. + +### HasPassword + +`func (o *UpdateCredentialResult) HasPassword() bool` + +HasPassword returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/UpdateInstanceOpts.md b/publicCloud/docs/UpdateInstanceOpts.md new file mode 100644 index 0000000..3a930d9 --- /dev/null +++ b/publicCloud/docs/UpdateInstanceOpts.md @@ -0,0 +1,186 @@ +# UpdateInstanceOpts + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **string** | Instance type | [optional] +**Reference** | Pointer to **string** | An identifying name you can refer to the instance | [optional] +**ContractType** | Pointer to **string** | | [optional] +**ContractTerm** | Pointer to **int32** | Contract commitment. Can only be used when updating the contract type from HOURLY and MONTHLY. | [optional] +**BillingFrequency** | Pointer to **int32** | How often you wish to be charged. Can only be used when updating the contract type from HOURLY to MONTHLY. '1' means every month, '3' every three months and so on. | [optional] +**RootDiskSize** | Pointer to **int32** | The root disk's size in GB. Must be at least 5 GB for Linux and FreeBSD instances and 50 GB for Windows instances | [optional] + +## Methods + +### NewUpdateInstanceOpts + +`func NewUpdateInstanceOpts() *UpdateInstanceOpts` + +NewUpdateInstanceOpts instantiates a new UpdateInstanceOpts object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUpdateInstanceOptsWithDefaults + +`func NewUpdateInstanceOptsWithDefaults() *UpdateInstanceOpts` + +NewUpdateInstanceOptsWithDefaults instantiates a new UpdateInstanceOpts object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetType + +`func (o *UpdateInstanceOpts) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *UpdateInstanceOpts) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *UpdateInstanceOpts) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *UpdateInstanceOpts) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetReference + +`func (o *UpdateInstanceOpts) GetReference() string` + +GetReference returns the Reference field if non-nil, zero value otherwise. + +### GetReferenceOk + +`func (o *UpdateInstanceOpts) GetReferenceOk() (*string, bool)` + +GetReferenceOk returns a tuple with the Reference field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReference + +`func (o *UpdateInstanceOpts) SetReference(v string)` + +SetReference sets Reference field to given value. + +### HasReference + +`func (o *UpdateInstanceOpts) HasReference() bool` + +HasReference returns a boolean if a field has been set. + +### GetContractType + +`func (o *UpdateInstanceOpts) GetContractType() string` + +GetContractType returns the ContractType field if non-nil, zero value otherwise. + +### GetContractTypeOk + +`func (o *UpdateInstanceOpts) GetContractTypeOk() (*string, bool)` + +GetContractTypeOk returns a tuple with the ContractType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContractType + +`func (o *UpdateInstanceOpts) SetContractType(v string)` + +SetContractType sets ContractType field to given value. + +### HasContractType + +`func (o *UpdateInstanceOpts) HasContractType() bool` + +HasContractType returns a boolean if a field has been set. + +### GetContractTerm + +`func (o *UpdateInstanceOpts) GetContractTerm() int32` + +GetContractTerm returns the ContractTerm field if non-nil, zero value otherwise. + +### GetContractTermOk + +`func (o *UpdateInstanceOpts) GetContractTermOk() (*int32, bool)` + +GetContractTermOk returns a tuple with the ContractTerm field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContractTerm + +`func (o *UpdateInstanceOpts) SetContractTerm(v int32)` + +SetContractTerm sets ContractTerm field to given value. + +### HasContractTerm + +`func (o *UpdateInstanceOpts) HasContractTerm() bool` + +HasContractTerm returns a boolean if a field has been set. + +### GetBillingFrequency + +`func (o *UpdateInstanceOpts) GetBillingFrequency() int32` + +GetBillingFrequency returns the BillingFrequency field if non-nil, zero value otherwise. + +### GetBillingFrequencyOk + +`func (o *UpdateInstanceOpts) GetBillingFrequencyOk() (*int32, bool)` + +GetBillingFrequencyOk returns a tuple with the BillingFrequency field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBillingFrequency + +`func (o *UpdateInstanceOpts) SetBillingFrequency(v int32)` + +SetBillingFrequency sets BillingFrequency field to given value. + +### HasBillingFrequency + +`func (o *UpdateInstanceOpts) HasBillingFrequency() bool` + +HasBillingFrequency returns a boolean if a field has been set. + +### GetRootDiskSize + +`func (o *UpdateInstanceOpts) GetRootDiskSize() int32` + +GetRootDiskSize returns the RootDiskSize field if non-nil, zero value otherwise. + +### GetRootDiskSizeOk + +`func (o *UpdateInstanceOpts) GetRootDiskSizeOk() (*int32, bool)` + +GetRootDiskSizeOk returns a tuple with the RootDiskSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRootDiskSize + +`func (o *UpdateInstanceOpts) SetRootDiskSize(v int32)` + +SetRootDiskSize sets RootDiskSize field to given value. + +### HasRootDiskSize + +`func (o *UpdateInstanceOpts) HasRootDiskSize() bool` + +HasRootDiskSize returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/UpdateInstanceResult.md b/publicCloud/docs/UpdateInstanceResult.md new file mode 100644 index 0000000..47c834c --- /dev/null +++ b/publicCloud/docs/UpdateInstanceResult.md @@ -0,0 +1,632 @@ +# UpdateInstanceResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EquipmentId** | Pointer to **string** | The customer's equipment ID | [optional] +**CustomerId** | Pointer to **string** | The customer's ID | [optional] +**SalesOrgId** | Pointer to **string** | | [optional] +**Id** | Pointer to **string** | The instance's identifier | [optional] +**Type** | Pointer to **string** | Instance type | [optional] +**Region** | Pointer to **string** | The region where the instance has been launched into | [optional] +**Reference** | Pointer to **string** | The identifying name set to the instance | [optional] +**OperatingSystem** | Pointer to [**OperatingSystem**](OperatingSystem.md) | | [optional] +**Resources** | Pointer to [**InstanceResources**](InstanceResources.md) | | [optional] +**State** | Pointer to **string** | | [optional] +**PublicIpV4** | Pointer to **bool** | | [optional] +**PrivateNetwork** | Pointer to **bool** | | [optional] +**StartedAt** | Pointer to **NullableTime** | | [optional] +**RootDiskSize** | Pointer to **int32** | | [optional] +**Ips** | Pointer to [**[]Ip**](Ip.md) | | [optional] +**BillingFrequency** | Pointer to **int32** | | [optional] +**ContractTerm** | Pointer to **int32** | | [optional] +**ContractType** | Pointer to [**ContractType**](ContractType.md) | | [optional] +**ContractEndsAt** | Pointer to **NullableTime** | | [optional] +**ContractRenewalsAt** | Pointer to **time.Time** | | [optional] +**ContractCreatedAt** | Pointer to **time.Time** | | [optional] +**Iso** | Pointer to **NullableString** | | [optional] + +## Methods + +### NewUpdateInstanceResult + +`func NewUpdateInstanceResult() *UpdateInstanceResult` + +NewUpdateInstanceResult instantiates a new UpdateInstanceResult object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUpdateInstanceResultWithDefaults + +`func NewUpdateInstanceResultWithDefaults() *UpdateInstanceResult` + +NewUpdateInstanceResultWithDefaults instantiates a new UpdateInstanceResult object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetEquipmentId + +`func (o *UpdateInstanceResult) GetEquipmentId() string` + +GetEquipmentId returns the EquipmentId field if non-nil, zero value otherwise. + +### GetEquipmentIdOk + +`func (o *UpdateInstanceResult) GetEquipmentIdOk() (*string, bool)` + +GetEquipmentIdOk returns a tuple with the EquipmentId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetEquipmentId + +`func (o *UpdateInstanceResult) SetEquipmentId(v string)` + +SetEquipmentId sets EquipmentId field to given value. + +### HasEquipmentId + +`func (o *UpdateInstanceResult) HasEquipmentId() bool` + +HasEquipmentId returns a boolean if a field has been set. + +### GetCustomerId + +`func (o *UpdateInstanceResult) GetCustomerId() string` + +GetCustomerId returns the CustomerId field if non-nil, zero value otherwise. + +### GetCustomerIdOk + +`func (o *UpdateInstanceResult) GetCustomerIdOk() (*string, bool)` + +GetCustomerIdOk returns a tuple with the CustomerId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetCustomerId + +`func (o *UpdateInstanceResult) SetCustomerId(v string)` + +SetCustomerId sets CustomerId field to given value. + +### HasCustomerId + +`func (o *UpdateInstanceResult) HasCustomerId() bool` + +HasCustomerId returns a boolean if a field has been set. + +### GetSalesOrgId + +`func (o *UpdateInstanceResult) GetSalesOrgId() string` + +GetSalesOrgId returns the SalesOrgId field if non-nil, zero value otherwise. + +### GetSalesOrgIdOk + +`func (o *UpdateInstanceResult) GetSalesOrgIdOk() (*string, bool)` + +GetSalesOrgIdOk returns a tuple with the SalesOrgId field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetSalesOrgId + +`func (o *UpdateInstanceResult) SetSalesOrgId(v string)` + +SetSalesOrgId sets SalesOrgId field to given value. + +### HasSalesOrgId + +`func (o *UpdateInstanceResult) HasSalesOrgId() bool` + +HasSalesOrgId returns a boolean if a field has been set. + +### GetId + +`func (o *UpdateInstanceResult) GetId() string` + +GetId returns the Id field if non-nil, zero value otherwise. + +### GetIdOk + +`func (o *UpdateInstanceResult) GetIdOk() (*string, bool)` + +GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetId + +`func (o *UpdateInstanceResult) SetId(v string)` + +SetId sets Id field to given value. + +### HasId + +`func (o *UpdateInstanceResult) HasId() bool` + +HasId returns a boolean if a field has been set. + +### GetType + +`func (o *UpdateInstanceResult) GetType() string` + +GetType returns the Type field if non-nil, zero value otherwise. + +### GetTypeOk + +`func (o *UpdateInstanceResult) GetTypeOk() (*string, bool)` + +GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetType + +`func (o *UpdateInstanceResult) SetType(v string)` + +SetType sets Type field to given value. + +### HasType + +`func (o *UpdateInstanceResult) HasType() bool` + +HasType returns a boolean if a field has been set. + +### GetRegion + +`func (o *UpdateInstanceResult) GetRegion() string` + +GetRegion returns the Region field if non-nil, zero value otherwise. + +### GetRegionOk + +`func (o *UpdateInstanceResult) GetRegionOk() (*string, bool)` + +GetRegionOk returns a tuple with the Region field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRegion + +`func (o *UpdateInstanceResult) SetRegion(v string)` + +SetRegion sets Region field to given value. + +### HasRegion + +`func (o *UpdateInstanceResult) HasRegion() bool` + +HasRegion returns a boolean if a field has been set. + +### GetReference + +`func (o *UpdateInstanceResult) GetReference() string` + +GetReference returns the Reference field if non-nil, zero value otherwise. + +### GetReferenceOk + +`func (o *UpdateInstanceResult) GetReferenceOk() (*string, bool)` + +GetReferenceOk returns a tuple with the Reference field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetReference + +`func (o *UpdateInstanceResult) SetReference(v string)` + +SetReference sets Reference field to given value. + +### HasReference + +`func (o *UpdateInstanceResult) HasReference() bool` + +HasReference returns a boolean if a field has been set. + +### GetOperatingSystem + +`func (o *UpdateInstanceResult) GetOperatingSystem() OperatingSystem` + +GetOperatingSystem returns the OperatingSystem field if non-nil, zero value otherwise. + +### GetOperatingSystemOk + +`func (o *UpdateInstanceResult) GetOperatingSystemOk() (*OperatingSystem, bool)` + +GetOperatingSystemOk returns a tuple with the OperatingSystem field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetOperatingSystem + +`func (o *UpdateInstanceResult) SetOperatingSystem(v OperatingSystem)` + +SetOperatingSystem sets OperatingSystem field to given value. + +### HasOperatingSystem + +`func (o *UpdateInstanceResult) HasOperatingSystem() bool` + +HasOperatingSystem returns a boolean if a field has been set. + +### GetResources + +`func (o *UpdateInstanceResult) GetResources() InstanceResources` + +GetResources returns the Resources field if non-nil, zero value otherwise. + +### GetResourcesOk + +`func (o *UpdateInstanceResult) GetResourcesOk() (*InstanceResources, bool)` + +GetResourcesOk returns a tuple with the Resources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResources + +`func (o *UpdateInstanceResult) SetResources(v InstanceResources)` + +SetResources sets Resources field to given value. + +### HasResources + +`func (o *UpdateInstanceResult) HasResources() bool` + +HasResources returns a boolean if a field has been set. + +### GetState + +`func (o *UpdateInstanceResult) GetState() string` + +GetState returns the State field if non-nil, zero value otherwise. + +### GetStateOk + +`func (o *UpdateInstanceResult) GetStateOk() (*string, bool)` + +GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetState + +`func (o *UpdateInstanceResult) SetState(v string)` + +SetState sets State field to given value. + +### HasState + +`func (o *UpdateInstanceResult) HasState() bool` + +HasState returns a boolean if a field has been set. + +### GetPublicIpV4 + +`func (o *UpdateInstanceResult) GetPublicIpV4() bool` + +GetPublicIpV4 returns the PublicIpV4 field if non-nil, zero value otherwise. + +### GetPublicIpV4Ok + +`func (o *UpdateInstanceResult) GetPublicIpV4Ok() (*bool, bool)` + +GetPublicIpV4Ok returns a tuple with the PublicIpV4 field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPublicIpV4 + +`func (o *UpdateInstanceResult) SetPublicIpV4(v bool)` + +SetPublicIpV4 sets PublicIpV4 field to given value. + +### HasPublicIpV4 + +`func (o *UpdateInstanceResult) HasPublicIpV4() bool` + +HasPublicIpV4 returns a boolean if a field has been set. + +### GetPrivateNetwork + +`func (o *UpdateInstanceResult) GetPrivateNetwork() bool` + +GetPrivateNetwork returns the PrivateNetwork field if non-nil, zero value otherwise. + +### GetPrivateNetworkOk + +`func (o *UpdateInstanceResult) GetPrivateNetworkOk() (*bool, bool)` + +GetPrivateNetworkOk returns a tuple with the PrivateNetwork field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrivateNetwork + +`func (o *UpdateInstanceResult) SetPrivateNetwork(v bool)` + +SetPrivateNetwork sets PrivateNetwork field to given value. + +### HasPrivateNetwork + +`func (o *UpdateInstanceResult) HasPrivateNetwork() bool` + +HasPrivateNetwork returns a boolean if a field has been set. + +### GetStartedAt + +`func (o *UpdateInstanceResult) GetStartedAt() time.Time` + +GetStartedAt returns the StartedAt field if non-nil, zero value otherwise. + +### GetStartedAtOk + +`func (o *UpdateInstanceResult) GetStartedAtOk() (*time.Time, bool)` + +GetStartedAtOk returns a tuple with the StartedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStartedAt + +`func (o *UpdateInstanceResult) SetStartedAt(v time.Time)` + +SetStartedAt sets StartedAt field to given value. + +### HasStartedAt + +`func (o *UpdateInstanceResult) HasStartedAt() bool` + +HasStartedAt returns a boolean if a field has been set. + +### SetStartedAtNil + +`func (o *UpdateInstanceResult) SetStartedAtNil(b bool)` + + SetStartedAtNil sets the value for StartedAt to be an explicit nil + +### UnsetStartedAt +`func (o *UpdateInstanceResult) UnsetStartedAt()` + +UnsetStartedAt ensures that no value is present for StartedAt, not even an explicit nil +### GetRootDiskSize + +`func (o *UpdateInstanceResult) GetRootDiskSize() int32` + +GetRootDiskSize returns the RootDiskSize field if non-nil, zero value otherwise. + +### GetRootDiskSizeOk + +`func (o *UpdateInstanceResult) GetRootDiskSizeOk() (*int32, bool)` + +GetRootDiskSizeOk returns a tuple with the RootDiskSize field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetRootDiskSize + +`func (o *UpdateInstanceResult) SetRootDiskSize(v int32)` + +SetRootDiskSize sets RootDiskSize field to given value. + +### HasRootDiskSize + +`func (o *UpdateInstanceResult) HasRootDiskSize() bool` + +HasRootDiskSize returns a boolean if a field has been set. + +### GetIps + +`func (o *UpdateInstanceResult) GetIps() []Ip` + +GetIps returns the Ips field if non-nil, zero value otherwise. + +### GetIpsOk + +`func (o *UpdateInstanceResult) GetIpsOk() (*[]Ip, bool)` + +GetIpsOk returns a tuple with the Ips field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIps + +`func (o *UpdateInstanceResult) SetIps(v []Ip)` + +SetIps sets Ips field to given value. + +### HasIps + +`func (o *UpdateInstanceResult) HasIps() bool` + +HasIps returns a boolean if a field has been set. + +### GetBillingFrequency + +`func (o *UpdateInstanceResult) GetBillingFrequency() int32` + +GetBillingFrequency returns the BillingFrequency field if non-nil, zero value otherwise. + +### GetBillingFrequencyOk + +`func (o *UpdateInstanceResult) GetBillingFrequencyOk() (*int32, bool)` + +GetBillingFrequencyOk returns a tuple with the BillingFrequency field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetBillingFrequency + +`func (o *UpdateInstanceResult) SetBillingFrequency(v int32)` + +SetBillingFrequency sets BillingFrequency field to given value. + +### HasBillingFrequency + +`func (o *UpdateInstanceResult) HasBillingFrequency() bool` + +HasBillingFrequency returns a boolean if a field has been set. + +### GetContractTerm + +`func (o *UpdateInstanceResult) GetContractTerm() int32` + +GetContractTerm returns the ContractTerm field if non-nil, zero value otherwise. + +### GetContractTermOk + +`func (o *UpdateInstanceResult) GetContractTermOk() (*int32, bool)` + +GetContractTermOk returns a tuple with the ContractTerm field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContractTerm + +`func (o *UpdateInstanceResult) SetContractTerm(v int32)` + +SetContractTerm sets ContractTerm field to given value. + +### HasContractTerm + +`func (o *UpdateInstanceResult) HasContractTerm() bool` + +HasContractTerm returns a boolean if a field has been set. + +### GetContractType + +`func (o *UpdateInstanceResult) GetContractType() ContractType` + +GetContractType returns the ContractType field if non-nil, zero value otherwise. + +### GetContractTypeOk + +`func (o *UpdateInstanceResult) GetContractTypeOk() (*ContractType, bool)` + +GetContractTypeOk returns a tuple with the ContractType field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContractType + +`func (o *UpdateInstanceResult) SetContractType(v ContractType)` + +SetContractType sets ContractType field to given value. + +### HasContractType + +`func (o *UpdateInstanceResult) HasContractType() bool` + +HasContractType returns a boolean if a field has been set. + +### GetContractEndsAt + +`func (o *UpdateInstanceResult) GetContractEndsAt() time.Time` + +GetContractEndsAt returns the ContractEndsAt field if non-nil, zero value otherwise. + +### GetContractEndsAtOk + +`func (o *UpdateInstanceResult) GetContractEndsAtOk() (*time.Time, bool)` + +GetContractEndsAtOk returns a tuple with the ContractEndsAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContractEndsAt + +`func (o *UpdateInstanceResult) SetContractEndsAt(v time.Time)` + +SetContractEndsAt sets ContractEndsAt field to given value. + +### HasContractEndsAt + +`func (o *UpdateInstanceResult) HasContractEndsAt() bool` + +HasContractEndsAt returns a boolean if a field has been set. + +### SetContractEndsAtNil + +`func (o *UpdateInstanceResult) SetContractEndsAtNil(b bool)` + + SetContractEndsAtNil sets the value for ContractEndsAt to be an explicit nil + +### UnsetContractEndsAt +`func (o *UpdateInstanceResult) UnsetContractEndsAt()` + +UnsetContractEndsAt ensures that no value is present for ContractEndsAt, not even an explicit nil +### GetContractRenewalsAt + +`func (o *UpdateInstanceResult) GetContractRenewalsAt() time.Time` + +GetContractRenewalsAt returns the ContractRenewalsAt field if non-nil, zero value otherwise. + +### GetContractRenewalsAtOk + +`func (o *UpdateInstanceResult) GetContractRenewalsAtOk() (*time.Time, bool)` + +GetContractRenewalsAtOk returns a tuple with the ContractRenewalsAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContractRenewalsAt + +`func (o *UpdateInstanceResult) SetContractRenewalsAt(v time.Time)` + +SetContractRenewalsAt sets ContractRenewalsAt field to given value. + +### HasContractRenewalsAt + +`func (o *UpdateInstanceResult) HasContractRenewalsAt() bool` + +HasContractRenewalsAt returns a boolean if a field has been set. + +### GetContractCreatedAt + +`func (o *UpdateInstanceResult) GetContractCreatedAt() time.Time` + +GetContractCreatedAt returns the ContractCreatedAt field if non-nil, zero value otherwise. + +### GetContractCreatedAtOk + +`func (o *UpdateInstanceResult) GetContractCreatedAtOk() (*time.Time, bool)` + +GetContractCreatedAtOk returns a tuple with the ContractCreatedAt field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetContractCreatedAt + +`func (o *UpdateInstanceResult) SetContractCreatedAt(v time.Time)` + +SetContractCreatedAt sets ContractCreatedAt field to given value. + +### HasContractCreatedAt + +`func (o *UpdateInstanceResult) HasContractCreatedAt() bool` + +HasContractCreatedAt returns a boolean if a field has been set. + +### GetIso + +`func (o *UpdateInstanceResult) GetIso() string` + +GetIso returns the Iso field if non-nil, zero value otherwise. + +### GetIsoOk + +`func (o *UpdateInstanceResult) GetIsoOk() (*string, bool)` + +GetIsoOk returns a tuple with the Iso field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetIso + +`func (o *UpdateInstanceResult) SetIso(v string)` + +SetIso sets Iso field to given value. + +### HasIso + +`func (o *UpdateInstanceResult) HasIso() bool` + +HasIso returns a boolean if a field has been set. + +### SetIsoNil + +`func (o *UpdateInstanceResult) SetIsoNil(b bool)` + + SetIsoNil sets the value for Iso to be an explicit nil + +### UnsetIso +`func (o *UpdateInstanceResult) UnsetIso()` + +UnsetIso ensures that no value is present for Iso, not even an explicit nil + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/UpdateInstanceType.md b/publicCloud/docs/UpdateInstanceType.md new file mode 100644 index 0000000..94c9ae3 --- /dev/null +++ b/publicCloud/docs/UpdateInstanceType.md @@ -0,0 +1,144 @@ +# UpdateInstanceType + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **string** | Instance type's name | [optional] +**Resources** | Pointer to [**InstanceResources**](InstanceResources.md) | | [optional] +**Prices** | Pointer to [**map[string]Price**](Price.md) | | [optional] +**StorageTypes** | Pointer to **[]string** | The supported storage types for the instance type | [optional] + +## Methods + +### NewUpdateInstanceType + +`func NewUpdateInstanceType() *UpdateInstanceType` + +NewUpdateInstanceType instantiates a new UpdateInstanceType object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewUpdateInstanceTypeWithDefaults + +`func NewUpdateInstanceTypeWithDefaults() *UpdateInstanceType` + +NewUpdateInstanceTypeWithDefaults instantiates a new UpdateInstanceType object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetName + +`func (o *UpdateInstanceType) GetName() string` + +GetName returns the Name field if non-nil, zero value otherwise. + +### GetNameOk + +`func (o *UpdateInstanceType) GetNameOk() (*string, bool)` + +GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetName + +`func (o *UpdateInstanceType) SetName(v string)` + +SetName sets Name field to given value. + +### HasName + +`func (o *UpdateInstanceType) HasName() bool` + +HasName returns a boolean if a field has been set. + +### GetResources + +`func (o *UpdateInstanceType) GetResources() InstanceResources` + +GetResources returns the Resources field if non-nil, zero value otherwise. + +### GetResourcesOk + +`func (o *UpdateInstanceType) GetResourcesOk() (*InstanceResources, bool)` + +GetResourcesOk returns a tuple with the Resources field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetResources + +`func (o *UpdateInstanceType) SetResources(v InstanceResources)` + +SetResources sets Resources field to given value. + +### HasResources + +`func (o *UpdateInstanceType) HasResources() bool` + +HasResources returns a boolean if a field has been set. + +### GetPrices + +`func (o *UpdateInstanceType) GetPrices() map[string]Price` + +GetPrices returns the Prices field if non-nil, zero value otherwise. + +### GetPricesOk + +`func (o *UpdateInstanceType) GetPricesOk() (*map[string]Price, bool)` + +GetPricesOk returns a tuple with the Prices field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetPrices + +`func (o *UpdateInstanceType) SetPrices(v map[string]Price)` + +SetPrices sets Prices field to given value. + +### HasPrices + +`func (o *UpdateInstanceType) HasPrices() bool` + +HasPrices returns a boolean if a field has been set. + +### GetStorageTypes + +`func (o *UpdateInstanceType) GetStorageTypes() []string` + +GetStorageTypes returns the StorageTypes field if non-nil, zero value otherwise. + +### GetStorageTypesOk + +`func (o *UpdateInstanceType) GetStorageTypesOk() (*[]string, bool)` + +GetStorageTypesOk returns a tuple with the StorageTypes field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetStorageTypes + +`func (o *UpdateInstanceType) SetStorageTypes(v []string)` + +SetStorageTypes sets StorageTypes field to given value. + +### HasStorageTypes + +`func (o *UpdateInstanceType) HasStorageTypes() bool` + +HasStorageTypes returns a boolean if a field has been set. + +### SetStorageTypesNil + +`func (o *UpdateInstanceType) SetStorageTypesNil(b bool)` + + SetStorageTypesNil sets the value for StorageTypes to be an explicit nil + +### UnsetStorageTypes +`func (o *UpdateInstanceType) UnsetStorageTypes()` + +UnsetStorageTypes ensures that no value is present for StorageTypes, not even an explicit nil + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/publicCloud/docs/Values.md b/publicCloud/docs/Values.md new file mode 100644 index 0000000..6d7fa0d --- /dev/null +++ b/publicCloud/docs/Values.md @@ -0,0 +1,134 @@ +# Values + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Tier0** | Pointer to [**Tier**](Tier.md) | | [optional] +**Tier1** | Pointer to [**Tier**](Tier.md) | | [optional] +**Tier2** | Pointer to [**Tier**](Tier.md) | | [optional] +**Tier3** | Pointer to [**Tier**](Tier.md) | | [optional] + +## Methods + +### NewValues + +`func NewValues() *Values` + +NewValues instantiates a new Values object +This constructor will assign default values to properties that have it defined, +and makes sure properties required by API are set, but the set of arguments +will change when the set of required properties is changed + +### NewValuesWithDefaults + +`func NewValuesWithDefaults() *Values` + +NewValuesWithDefaults instantiates a new Values object +This constructor will only assign default values to properties that have it defined, +but it doesn't guarantee that properties required by API are set + +### GetTier0 + +`func (o *Values) GetTier0() Tier` + +GetTier0 returns the Tier0 field if non-nil, zero value otherwise. + +### GetTier0Ok + +`func (o *Values) GetTier0Ok() (*Tier, bool)` + +GetTier0Ok returns a tuple with the Tier0 field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTier0 + +`func (o *Values) SetTier0(v Tier)` + +SetTier0 sets Tier0 field to given value. + +### HasTier0 + +`func (o *Values) HasTier0() bool` + +HasTier0 returns a boolean if a field has been set. + +### GetTier1 + +`func (o *Values) GetTier1() Tier` + +GetTier1 returns the Tier1 field if non-nil, zero value otherwise. + +### GetTier1Ok + +`func (o *Values) GetTier1Ok() (*Tier, bool)` + +GetTier1Ok returns a tuple with the Tier1 field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTier1 + +`func (o *Values) SetTier1(v Tier)` + +SetTier1 sets Tier1 field to given value. + +### HasTier1 + +`func (o *Values) HasTier1() bool` + +HasTier1 returns a boolean if a field has been set. + +### GetTier2 + +`func (o *Values) GetTier2() Tier` + +GetTier2 returns the Tier2 field if non-nil, zero value otherwise. + +### GetTier2Ok + +`func (o *Values) GetTier2Ok() (*Tier, bool)` + +GetTier2Ok returns a tuple with the Tier2 field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTier2 + +`func (o *Values) SetTier2(v Tier)` + +SetTier2 sets Tier2 field to given value. + +### HasTier2 + +`func (o *Values) HasTier2() bool` + +HasTier2 returns a boolean if a field has been set. + +### GetTier3 + +`func (o *Values) GetTier3() Tier` + +GetTier3 returns the Tier3 field if non-nil, zero value otherwise. + +### GetTier3Ok + +`func (o *Values) GetTier3Ok() (*Tier, bool)` + +GetTier3Ok returns a tuple with the Tier3 field if it's non-nil, zero value otherwise +and a boolean to check if the value has been set. + +### SetTier3 + +`func (o *Values) SetTier3(v Tier)` + +SetTier3 sets Tier3 field to given value. + +### HasTier3 + +`func (o *Values) HasTier3() bool` + +HasTier3 returns a boolean if a field has been set. + + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + +