ionoscloud 5.1.2 → 6.0.0.beta.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/docs/{models/AttachedVolumes.md → AttachedVolumes.md} +1 -1
- data/docs/{models/BackupUnit.md → BackupUnit.md} +0 -0
- data/docs/{models/BackupUnitProperties.md → BackupUnitProperties.md} +0 -0
- data/docs/{models/BackupUnitSSO.md → BackupUnitSSO.md} +0 -0
- data/docs/{models/BackupUnits.md → BackupUnits.md} +0 -0
- data/docs/{api/BackupUnitApi.md → BackupUnitsApi.md} +42 -42
- data/docs/{models/BalancedNics.md → BalancedNics.md} +0 -0
- data/docs/CHANGELOG.md +1 -0
- data/docs/{models/Cdroms.md → Cdroms.md} +1 -1
- data/docs/{models/ConnectableDatacenter.md → ConnectableDatacenter.md} +0 -0
- data/docs/{models/Contract.md → Contract.md} +0 -0
- data/docs/{models/ContractProperties.md → ContractProperties.md} +0 -0
- data/docs/{api/ContractApi.md → ContractResourcesApi.md} +11 -11
- data/docs/Contracts.md +24 -0
- data/docs/CpuArchitectureProperties.md +24 -0
- data/docs/{models/DataCenterEntities.md → DataCenterEntities.md} +5 -1
- data/docs/{api/DataCenterApi.md → DataCentersApi.md} +31 -31
- data/docs/{models/Datacenter.md → Datacenter.md} +0 -0
- data/docs/{models/DatacenterElementMetadata.md → DatacenterElementMetadata.md} +0 -0
- data/docs/{models/DatacenterProperties.md → DatacenterProperties.md} +3 -1
- data/docs/{models/Datacenters.md → Datacenters.md} +0 -0
- data/docs/{api/DefaultApi.md → DefaultApi.md} +2 -13
- data/docs/{models/Error.md → Error.md} +0 -0
- data/docs/{models/ErrorMessage.md → ErrorMessage.md} +0 -0
- data/docs/{models/FirewallRule.md → FirewallRule.md} +0 -0
- data/docs/{models/FirewallRules.md → FirewallRules.md} +0 -0
- data/docs/FirewallRulesApi.md +553 -0
- data/docs/{models/FirewallruleProperties.md → FirewallruleProperties.md} +3 -1
- data/docs/FlowLog.md +26 -0
- data/docs/FlowLogProperties.md +24 -0
- data/docs/FlowLogPut.md +24 -0
- data/docs/FlowLogs.md +30 -0
- data/docs/FlowLogsApi.md +541 -0
- data/docs/{models/Group.md → Group.md} +1 -1
- data/docs/{models/GroupEntities.md → GroupEntities.md} +0 -0
- data/docs/{models/GroupMembers.md → GroupMembers.md} +1 -1
- data/docs/{models/GroupProperties.md → GroupProperties.md} +5 -1
- data/docs/{models/GroupShare.md → GroupShare.md} +1 -1
- data/docs/{models/GroupShareProperties.md → GroupShareProperties.md} +0 -0
- data/docs/{models/GroupShares.md → GroupShares.md} +1 -1
- data/docs/{models/GroupUsers.md → GroupUsers.md} +1 -1
- data/docs/{models/Groups.md → Groups.md} +1 -1
- data/docs/{api/IPBlocksApi.md → IPBlocksApi.md} +7 -11
- data/docs/{models/IPFailover.md → IPFailover.md} +0 -0
- data/docs/{models/Image.md → Image.md} +0 -0
- data/docs/{models/ImageProperties.md → ImageProperties.md} +1 -5
- data/docs/{models/Images.md → Images.md} +0 -0
- data/docs/{api/ImageApi.md → ImagesApi.md} +25 -25
- data/docs/{models/Info.md → Info.md} +0 -0
- data/docs/{models/IpBlock.md → IpBlock.md} +0 -0
- data/docs/{models/IpBlockProperties.md → IpBlockProperties.md} +1 -1
- data/docs/IpBlocks.md +24 -0
- data/docs/{models/IpConsumer.md → IpConsumer.md} +1 -5
- data/docs/{api/KubernetesApi.md → KubernetesApi.md} +17 -93
- data/docs/{models/KubernetesAutoScaling.md → KubernetesAutoScaling.md} +2 -2
- data/docs/{models/KubernetesCluster.md → KubernetesCluster.md} +0 -0
- data/docs/{models/KubernetesClusterEntities.md → KubernetesClusterEntities.md} +0 -0
- data/docs/{models/KubernetesClusterForPost.md → KubernetesClusterForPost.md} +0 -0
- data/docs/{models/KubernetesClusterForPut.md → KubernetesClusterForPut.md} +0 -0
- data/docs/{models/KubernetesClusterProperties.md → KubernetesClusterProperties.md} +4 -4
- data/docs/{models/KubernetesClusterPropertiesForPost.md → KubernetesClusterPropertiesForPost.md} +4 -4
- data/docs/{models/KubernetesClusterPropertiesForPut.md → KubernetesClusterPropertiesForPut.md} +1 -5
- data/docs/{models/KubernetesClusters.md → KubernetesClusters.md} +1 -1
- data/docs/{models/KubernetesMaintenanceWindow.md → KubernetesMaintenanceWindow.md} +2 -2
- data/docs/{models/KubernetesNode.md → KubernetesNode.md} +0 -0
- data/docs/{models/KubernetesNodeMetadata.md → KubernetesNodeMetadata.md} +0 -0
- data/docs/{models/KubernetesNodePool.md → KubernetesNodePool.md} +0 -0
- data/docs/{models/KubernetesNodePoolForPost.md → KubernetesNodePoolForPost.md} +0 -0
- data/docs/{models/KubernetesNodePoolForPut.md → KubernetesNodePoolForPut.md} +0 -0
- data/docs/KubernetesNodePoolLan.md +22 -0
- data/docs/KubernetesNodePoolLanRoutes.md +20 -0
- data/docs/{models/KubernetesNodePoolProperties.md → KubernetesNodePoolProperties.md} +2 -1
- data/docs/{models/KubernetesNodePoolPropertiesForPost.md → KubernetesNodePoolPropertiesForPost.md} +2 -1
- data/docs/{models/KubernetesNodePoolPropertiesForPut.md → KubernetesNodePoolPropertiesForPut.md} +0 -0
- data/docs/{models/KubernetesNodePools.md → KubernetesNodePools.md} +1 -1
- data/docs/{models/KubernetesNodeProperties.md → KubernetesNodeProperties.md} +0 -0
- data/docs/{models/KubernetesNodes.md → KubernetesNodes.md} +0 -0
- data/docs/{models/Label.md → Label.md} +0 -0
- data/docs/{models/LabelProperties.md → LabelProperties.md} +0 -0
- data/docs/{models/LabelResource.md → LabelResource.md} +0 -0
- data/docs/{models/LabelResourceProperties.md → LabelResourceProperties.md} +0 -0
- data/docs/{models/LabelResources.md → LabelResources.md} +0 -0
- data/docs/{models/Labels.md → Labels.md} +0 -0
- data/docs/{api/LabelApi.md → LabelsApi.md} +128 -132
- data/docs/{models/Lan.md → Lan.md} +0 -0
- data/docs/{models/LanEntities.md → LanEntities.md} +0 -0
- data/docs/{models/LanNics.md → LanNics.md} +0 -0
- data/docs/{models/LanPost.md → LanPost.md} +0 -0
- data/docs/{models/LanProperties.md → LanProperties.md} +0 -0
- data/docs/{models/LanPropertiesPost.md → LanPropertiesPost.md} +0 -0
- data/docs/{models/Lans.md → Lans.md} +1 -1
- data/docs/{api/LanApi.md → LansApi.md} +55 -55
- data/docs/{api/LoadBalancerApi.md → LoadBalancersApi.md} +73 -69
- data/docs/{models/Loadbalancer.md → Loadbalancer.md} +0 -0
- data/docs/{models/LoadbalancerEntities.md → LoadbalancerEntities.md} +0 -0
- data/docs/{models/LoadbalancerProperties.md → LoadbalancerProperties.md} +0 -0
- data/docs/{models/Loadbalancers.md → Loadbalancers.md} +0 -0
- data/docs/{models/Location.md → Location.md} +0 -0
- data/docs/{models/LocationProperties.md → LocationProperties.md} +3 -1
- data/docs/{models/Locations.md → Locations.md} +0 -0
- data/docs/{api/LocationApi.md → LocationsApi.md} +14 -14
- data/docs/NATGatewaysApi.md +1581 -0
- data/docs/NatGateway.md +28 -0
- data/docs/NatGatewayEntities.md +20 -0
- data/docs/NatGatewayLanProperties.md +20 -0
- data/docs/NatGatewayProperties.md +22 -0
- data/docs/NatGatewayPut.md +24 -0
- data/docs/NatGatewayRule.md +26 -0
- data/docs/NatGatewayRuleProperties.md +30 -0
- data/docs/{models/S3Bucket.md → NatGatewayRuleProtocol.md} +2 -5
- data/docs/NatGatewayRulePut.md +24 -0
- data/docs/NatGatewayRuleType.md +15 -0
- data/docs/NatGatewayRules.md +24 -0
- data/docs/NatGateways.md +30 -0
- data/docs/NetworkInterfacesApi.md +541 -0
- data/docs/NetworkLoadBalancer.md +28 -0
- data/docs/NetworkLoadBalancerEntities.md +20 -0
- data/docs/NetworkLoadBalancerForwardingRule.md +26 -0
- data/docs/NetworkLoadBalancerForwardingRuleHealthCheck.md +26 -0
- data/docs/NetworkLoadBalancerForwardingRuleProperties.md +30 -0
- data/docs/NetworkLoadBalancerForwardingRulePut.md +24 -0
- data/docs/NetworkLoadBalancerForwardingRuleTarget.md +24 -0
- data/docs/NetworkLoadBalancerForwardingRuleTargetHealthCheck.md +22 -0
- data/docs/NetworkLoadBalancerForwardingRules.md +30 -0
- data/docs/NetworkLoadBalancerProperties.md +26 -0
- data/docs/NetworkLoadBalancerPut.md +24 -0
- data/docs/NetworkLoadBalancers.md +30 -0
- data/docs/NetworkLoadBalancersApi.md +1593 -0
- data/docs/{models/Nic.md → Nic.md} +0 -0
- data/docs/{models/NicEntities.md → NicEntities.md} +2 -0
- data/docs/{models/NicProperties.md → NicProperties.md} +6 -2
- data/docs/NicPut.md +24 -0
- data/docs/{models/Nics.md → Nics.md} +1 -1
- data/docs/{models/NoStateMetaData.md → NoStateMetaData.md} +0 -0
- data/docs/{models/PaginationLinks.md → PaginationLinks.md} +0 -0
- data/docs/{models/Peer.md → Peer.md} +0 -0
- data/docs/{models/PrivateCrossConnect.md → PrivateCrossConnect.md} +0 -0
- data/docs/{models/PrivateCrossConnectProperties.md → PrivateCrossConnectProperties.md} +0 -0
- data/docs/{models/PrivateCrossConnects.md → PrivateCrossConnects.md} +0 -0
- data/docs/{api/PrivateCrossConnectApi.md → PrivateCrossConnectsApi.md} +34 -30
- data/docs/README.md +4 -4
- data/docs/RemoteConsoleUrl.md +18 -0
- data/docs/{models/Request.md → Request.md} +0 -0
- data/docs/{models/RequestMetadata.md → RequestMetadata.md} +0 -0
- data/docs/{models/RequestProperties.md → RequestProperties.md} +0 -0
- data/docs/{models/RequestStatus.md → RequestStatus.md} +0 -0
- data/docs/{models/RequestStatusMetadata.md → RequestStatusMetadata.md} +0 -0
- data/docs/{models/RequestTarget.md → RequestTarget.md} +0 -0
- data/docs/{models/Requests.md → Requests.md} +1 -1
- data/docs/{api/RequestApi.md → RequestsApi.md} +24 -40
- data/docs/{models/Resource.md → Resource.md} +1 -1
- data/docs/{models/ResourceEntities.md → ResourceEntities.md} +0 -0
- data/docs/{models/ResourceGroups.md → ResourceGroups.md} +1 -1
- data/docs/{models/ResourceLimits.md → ResourceLimits.md} +11 -1
- data/docs/{models/ResourceProperties.md → ResourceProperties.md} +0 -0
- data/docs/{models/ResourceReference.md → ResourceReference.md} +0 -0
- data/docs/{models/Resources.md → Resources.md} +1 -1
- data/docs/{models/ResourcesUsers.md → ResourcesUsers.md} +1 -1
- data/docs/{models/S3Key.md → S3Key.md} +1 -1
- data/docs/{models/S3KeyMetadata.md → S3KeyMetadata.md} +0 -0
- data/docs/{models/S3KeyProperties.md → S3KeyProperties.md} +0 -0
- data/docs/{models/S3Keys.md → S3Keys.md} +1 -1
- data/docs/{models/S3ObjectStorageSSO.md → S3ObjectStorageSSO.md} +0 -0
- data/docs/{models/Server.md → Server.md} +0 -0
- data/docs/{models/ServerEntities.md → ServerEntities.md} +0 -0
- data/docs/{models/ServerProperties.md → ServerProperties.md} +6 -2
- data/docs/{models/Servers.md → Servers.md} +0 -0
- data/docs/{api/ServerApi.md → ServersApi.md} +430 -86
- data/docs/{models/Snapshot.md → Snapshot.md} +0 -0
- data/docs/{models/SnapshotProperties.md → SnapshotProperties.md} +0 -0
- data/docs/{models/Snapshots.md → Snapshots.md} +0 -0
- data/docs/{api/SnapshotApi.md → SnapshotsApi.md} +28 -28
- data/docs/TargetPortRange.md +20 -0
- data/docs/Template.md +26 -0
- data/docs/TemplateProperties.md +24 -0
- data/docs/Templates.md +24 -0
- data/docs/TemplatesApi.md +165 -0
- data/docs/Token.md +18 -0
- data/docs/{models/Type.md → Type.md} +0 -0
- data/docs/{models/User.md → User.md} +0 -0
- data/docs/{api/UserManagementApi.md → UserManagementApi.md} +12 -526
- data/docs/{models/UserMetadata.md → UserMetadata.md} +0 -0
- data/docs/{models/UserPost.md → UserPost.md} +0 -0
- data/docs/{models/UserProperties.md → UserProperties.md} +0 -0
- data/docs/{models/UserPropertiesPost.md → UserPropertiesPost.md} +0 -0
- data/docs/{models/UserPropertiesPut.md → UserPropertiesPut.md} +0 -0
- data/docs/{models/UserPut.md → UserPut.md} +0 -0
- data/docs/UserS3KeysApi.md +517 -0
- data/docs/Users.md +24 -0
- data/docs/{models/UsersEntities.md → UsersEntities.md} +0 -0
- data/docs/{models/Volume.md → Volume.md} +0 -0
- data/docs/{models/VolumeProperties.md → VolumeProperties.md} +5 -5
- data/docs/{models/Volumes.md → Volumes.md} +0 -0
- data/docs/{api/VolumeApi.md → VolumesApi.md} +42 -42
- data/docs/summary.md +386 -159
- data/ionoscloud.gemspec +2 -2
- data/lib/ionoscloud/api/_api.rb +3 -3
- data/lib/ionoscloud/api/{backup_unit_api.rb → backup_units_api.rb} +56 -56
- data/lib/ionoscloud/api/{contract_api.rb → contract_resources_api.rb} +13 -13
- data/lib/ionoscloud/api/{data_center_api.rb → data_centers_api.rb} +49 -49
- data/lib/ionoscloud/api/firewall_rules_api.rb +640 -0
- data/lib/ionoscloud/api/flow_logs_api.rb +622 -0
- data/lib/ionoscloud/api/{image_api.rb → images_api.rb} +36 -36
- data/lib/ionoscloud/api/ip_blocks_api.rb +12 -30
- data/lib/ionoscloud/api/kubernetes_api.rb +17 -80
- data/lib/ionoscloud/api/{label_api.rb → labels_api.rb} +245 -263
- data/lib/ionoscloud/api/{lan_api.rb → lans_api.rb} +101 -101
- data/lib/ionoscloud/api/{load_balancer_api.rb → load_balancers_api.rb} +144 -126
- data/lib/ionoscloud/api/{location_api.rb → locations_api.rb} +21 -21
- data/lib/ionoscloud/api/nat_gateways_api.rb +1690 -0
- data/lib/ionoscloud/api/network_interfaces_api.rb +604 -0
- data/lib/ionoscloud/api/network_load_balancers_api.rb +1708 -0
- data/lib/ionoscloud/api/{private_cross_connect_api.rb → private_cross_connects_api.rb} +57 -39
- data/lib/ionoscloud/api/{request_api.rb → requests_api.rb} +33 -57
- data/lib/ionoscloud/api/{server_api.rb → servers_api.rb} +501 -157
- data/lib/ionoscloud/api/{snapshot_api.rb → snapshots_api.rb} +42 -42
- data/lib/ionoscloud/api/templates_api.rb +164 -0
- data/lib/ionoscloud/api/user_management_api.rb +12 -525
- data/lib/ionoscloud/api/user_s3_keys_api.rb +517 -0
- data/lib/ionoscloud/api/{volume_api.rb → volumes_api.rb} +71 -71
- data/lib/ionoscloud/api_client.rb +21 -21
- data/lib/ionoscloud/api_error.rb +2 -2
- data/lib/ionoscloud/configuration.rb +6 -6
- data/lib/ionoscloud/models/attached_volumes.rb +13 -69
- data/lib/ionoscloud/models/backup_unit.rb +7 -49
- data/lib/ionoscloud/models/backup_unit_properties.rb +5 -31
- data/lib/ionoscloud/models/backup_unit_sso.rb +3 -13
- data/lib/ionoscloud/models/backup_units.rb +12 -44
- data/lib/ionoscloud/models/balanced_nics.rb +13 -69
- data/lib/ionoscloud/models/cdroms.rb +13 -69
- data/lib/ionoscloud/models/connectable_datacenter.rb +5 -31
- data/lib/ionoscloud/models/contract.rb +4 -22
- data/lib/ionoscloud/models/contract_properties.rb +7 -49
- data/lib/ionoscloud/models/contracts.rb +249 -0
- data/lib/ionoscloud/models/cpu_architecture_properties.rb +247 -0
- data/lib/ionoscloud/models/data_center_entities.rb +27 -43
- data/lib/ionoscloud/models/datacenter.rb +8 -58
- data/lib/ionoscloud/models/datacenter_element_metadata.rb +12 -78
- data/lib/ionoscloud/models/datacenter_properties.rb +49 -63
- data/lib/ionoscloud/models/datacenters.rb +13 -69
- data/lib/ionoscloud/models/error.rb +8 -24
- data/lib/ionoscloud/models/error_message.rb +4 -22
- data/lib/ionoscloud/models/firewall_rule.rb +7 -49
- data/lib/ionoscloud/models/firewall_rules.rb +13 -69
- data/lib/ionoscloud/models/firewallrule_properties.rb +57 -124
- data/lib/ionoscloud/models/flow_log.rb +260 -0
- data/lib/ionoscloud/models/flow_log_properties.rb +313 -0
- data/lib/ionoscloud/models/{kubernetes_config.rb → flow_log_put.rb} +13 -81
- data/lib/ionoscloud/models/flow_logs.rb +278 -0
- data/lib/ionoscloud/models/group.rb +7 -49
- data/lib/ionoscloud/models/group_entities.rb +4 -22
- data/lib/ionoscloud/models/group_members.rb +10 -42
- data/lib/ionoscloud/models/group_properties.rb +35 -97
- data/lib/ionoscloud/models/group_share.rb +6 -40
- data/lib/ionoscloud/models/group_share_properties.rb +4 -22
- data/lib/ionoscloud/models/group_shares.rb +10 -42
- data/lib/ionoscloud/models/group_users.rb +10 -42
- data/lib/ionoscloud/models/groups.rb +10 -42
- data/lib/ionoscloud/models/image.rb +7 -49
- data/lib/ionoscloud/models/image_properties.rb +24 -210
- data/lib/ionoscloud/models/images.rb +10 -42
- data/lib/ionoscloud/models/info.rb +5 -31
- data/lib/ionoscloud/models/ip_block.rb +7 -49
- data/lib/ionoscloud/models/ip_block_properties.rb +15 -53
- data/lib/ionoscloud/models/ip_blocks.rb +13 -98
- data/lib/ionoscloud/models/ip_consumer.rb +12 -104
- data/lib/ionoscloud/models/ip_failover.rb +4 -22
- data/lib/ionoscloud/models/kubernetes_auto_scaling.rb +13 -21
- data/lib/ionoscloud/models/kubernetes_cluster.rb +8 -58
- data/lib/ionoscloud/models/kubernetes_cluster_entities.rb +3 -13
- data/lib/ionoscloud/models/kubernetes_cluster_for_post.rb +8 -58
- data/lib/ionoscloud/models/kubernetes_cluster_for_put.rb +8 -58
- data/lib/ionoscloud/models/kubernetes_cluster_properties.rb +32 -84
- data/lib/ionoscloud/models/kubernetes_cluster_properties_for_post.rb +22 -62
- data/lib/ionoscloud/models/kubernetes_cluster_properties_for_put.rb +8 -70
- data/lib/ionoscloud/models/kubernetes_clusters.rb +11 -43
- data/lib/ionoscloud/models/kubernetes_maintenance_window.rb +13 -21
- data/lib/ionoscloud/models/kubernetes_node.rb +7 -49
- data/lib/ionoscloud/models/kubernetes_node_metadata.rb +9 -51
- data/lib/ionoscloud/models/kubernetes_node_pool.rb +7 -49
- data/lib/ionoscloud/models/kubernetes_node_pool_for_post.rb +7 -49
- data/lib/ionoscloud/models/kubernetes_node_pool_for_put.rb +7 -49
- data/lib/ionoscloud/models/kubernetes_node_pool_lan.rb +28 -21
- data/lib/ionoscloud/models/kubernetes_node_pool_lan_routes.rb +227 -0
- data/lib/ionoscloud/models/kubernetes_node_pool_properties.rb +42 -170
- data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_post.rb +37 -159
- data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_put.rb +27 -93
- data/lib/ionoscloud/models/kubernetes_node_pools.rb +11 -43
- data/lib/ionoscloud/models/kubernetes_node_properties.rb +6 -40
- data/lib/ionoscloud/models/kubernetes_nodes.rb +10 -42
- data/lib/ionoscloud/models/label.rb +7 -49
- data/lib/ionoscloud/models/label_properties.rb +7 -49
- data/lib/ionoscloud/models/label_resource.rb +7 -49
- data/lib/ionoscloud/models/label_resource_properties.rb +4 -22
- data/lib/ionoscloud/models/label_resources.rb +15 -71
- data/lib/ionoscloud/models/labels.rb +12 -44
- data/lib/ionoscloud/models/lan.rb +8 -58
- data/lib/ionoscloud/models/lan_entities.rb +3 -13
- data/lib/ionoscloud/models/lan_nics.rb +13 -69
- data/lib/ionoscloud/models/lan_post.rb +8 -58
- data/lib/ionoscloud/models/lan_properties.rb +10 -42
- data/lib/ionoscloud/models/lan_properties_post.rb +10 -42
- data/lib/ionoscloud/models/lans.rb +14 -70
- data/lib/ionoscloud/models/loadbalancer.rb +8 -58
- data/lib/ionoscloud/models/loadbalancer_entities.rb +3 -13
- data/lib/ionoscloud/models/loadbalancer_properties.rb +34 -43
- data/lib/ionoscloud/models/loadbalancers.rb +13 -69
- data/lib/ionoscloud/models/location.rb +7 -49
- data/lib/ionoscloud/models/location_properties.rb +49 -37
- data/lib/ionoscloud/models/locations.rb +10 -42
- data/lib/ionoscloud/models/nat_gateway.rb +269 -0
- data/lib/ionoscloud/models/nat_gateway_entities.rb +225 -0
- data/lib/ionoscloud/models/nat_gateway_lan_properties.rb +234 -0
- data/lib/ionoscloud/models/nat_gateway_properties.rb +251 -0
- data/lib/ionoscloud/models/nat_gateway_put.rb +251 -0
- data/lib/ionoscloud/models/nat_gateway_rule.rb +260 -0
- data/lib/ionoscloud/models/nat_gateway_rule_properties.rb +291 -0
- data/lib/ionoscloud/models/nat_gateway_rule_protocol.rb +39 -0
- data/lib/ionoscloud/models/nat_gateway_rule_put.rb +251 -0
- data/lib/ionoscloud/models/nat_gateway_rule_type.rb +36 -0
- data/lib/ionoscloud/models/nat_gateway_rules.rb +249 -0
- data/lib/ionoscloud/models/nat_gateways.rb +278 -0
- data/lib/ionoscloud/models/network_load_balancer.rb +269 -0
- data/lib/ionoscloud/models/network_load_balancer_entities.rb +225 -0
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule.rb +260 -0
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_health_check.rb +257 -0
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_properties.rb +354 -0
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_put.rb +251 -0
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_target.rb +261 -0
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_target_health_check.rb +237 -0
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rules.rb +278 -0
- data/lib/ionoscloud/models/network_load_balancer_properties.rb +276 -0
- data/lib/ionoscloud/models/network_load_balancer_put.rb +251 -0
- data/lib/ionoscloud/models/network_load_balancers.rb +278 -0
- data/lib/ionoscloud/models/nic.rb +8 -58
- data/lib/ionoscloud/models/nic_entities.rb +13 -14
- data/lib/ionoscloud/models/nic_properties.rb +71 -73
- data/lib/ionoscloud/models/nic_put.rb +251 -0
- data/lib/ionoscloud/models/nics.rb +13 -69
- data/lib/ionoscloud/models/no_state_meta_data.rb +9 -67
- data/lib/ionoscloud/models/pagination_links.rb +5 -31
- data/lib/ionoscloud/models/peer.rb +7 -49
- data/lib/ionoscloud/models/private_cross_connect.rb +7 -49
- data/lib/ionoscloud/models/private_cross_connect_properties.rb +14 -44
- data/lib/ionoscloud/models/private_cross_connects.rb +10 -42
- data/lib/ionoscloud/models/{kubernetes_config_properties.rb → remote_console_url.rb} +13 -23
- data/lib/ionoscloud/models/request.rb +7 -49
- data/lib/ionoscloud/models/request_metadata.rb +6 -40
- data/lib/ionoscloud/models/request_properties.rb +10 -42
- data/lib/ionoscloud/models/request_status.rb +6 -40
- data/lib/ionoscloud/models/request_status_metadata.rb +10 -42
- data/lib/ionoscloud/models/request_target.rb +4 -22
- data/lib/ionoscloud/models/requests.rb +14 -70
- data/lib/ionoscloud/models/resource.rb +8 -58
- data/lib/ionoscloud/models/resource_entities.rb +3 -13
- data/lib/ionoscloud/models/resource_groups.rb +10 -42
- data/lib/ionoscloud/models/resource_limits.rb +94 -157
- data/lib/ionoscloud/models/resource_properties.rb +4 -22
- data/lib/ionoscloud/models/resource_reference.rb +5 -31
- data/lib/ionoscloud/models/resources.rb +10 -42
- data/lib/ionoscloud/models/resources_users.rb +10 -42
- data/lib/ionoscloud/models/s3_key.rb +7 -49
- data/lib/ionoscloud/models/s3_key_metadata.rb +4 -22
- data/lib/ionoscloud/models/s3_key_properties.rb +4 -22
- data/lib/ionoscloud/models/s3_keys.rb +10 -42
- data/lib/ionoscloud/models/s3_object_storage_sso.rb +3 -13
- data/lib/ionoscloud/models/server.rb +8 -58
- data/lib/ionoscloud/models/server_entities.rb +5 -31
- data/lib/ionoscloud/models/server_properties.rb +36 -82
- data/lib/ionoscloud/models/servers.rb +13 -69
- data/lib/ionoscloud/models/snapshot.rb +7 -49
- data/lib/ionoscloud/models/snapshot_properties.rb +18 -148
- data/lib/ionoscloud/models/snapshots.rb +10 -42
- data/lib/ionoscloud/models/target_port_range.rb +227 -0
- data/lib/ionoscloud/models/template.rb +260 -0
- data/lib/ionoscloud/models/template_properties.rb +267 -0
- data/lib/ionoscloud/models/templates.rb +249 -0
- data/lib/ionoscloud/models/{s3_bucket.rb → token.rb} +13 -28
- data/lib/ionoscloud/models/type.rb +10 -2
- data/lib/ionoscloud/models/user.rb +8 -58
- data/lib/ionoscloud/models/user_metadata.rb +5 -31
- data/lib/ionoscloud/models/user_post.rb +3 -13
- data/lib/ionoscloud/models/user_properties.rb +10 -76
- data/lib/ionoscloud/models/user_properties_post.rb +10 -76
- data/lib/ionoscloud/models/user_properties_put.rb +9 -67
- data/lib/ionoscloud/models/user_put.rb +4 -22
- data/lib/ionoscloud/models/users.rb +13 -98
- data/lib/ionoscloud/models/users_entities.rb +4 -22
- data/lib/ionoscloud/models/volume.rb +7 -49
- data/lib/ionoscloud/models/volume_properties.rb +40 -191
- data/lib/ionoscloud/models/volumes.rb +13 -69
- data/lib/ionoscloud/version.rb +3 -3
- data/lib/ionoscloud.rb +60 -19
- data/spec/api/_api_spec.rb +49 -0
- data/spec/api/backup_units_api_spec.rb +140 -0
- data/spec/api/contract_resources_api_spec.rb +49 -0
- data/spec/api/data_centers_api_spec.rb +128 -0
- data/spec/api/firewall_rules_api_spec.rb +146 -0
- data/spec/api/flow_logs_api_spec.rb +140 -0
- data/spec/api/images_api_spec.rb +111 -0
- data/spec/api/ip_blocks_api_spec.rb +126 -0
- data/spec/api/kubernetes_api_spec.rb +294 -0
- data/spec/api/labels_api_spec.rb +478 -0
- data/spec/api/lans_api_spec.rb +186 -0
- data/spec/api/load_balancers_api_spec.rb +205 -0
- data/spec/api/locations_api_spec.rb +80 -0
- data/spec/api/nat_gateways_api_spec.rb +336 -0
- data/spec/api/network_interfaces_api_spec.rb +140 -0
- data/spec/api/network_load_balancers_api_spec.rb +342 -0
- data/spec/api/private_cross_connects_api_spec.rb +112 -0
- data/spec/api/requests_api_spec.rb +84 -0
- data/spec/api/servers_api_spec.rb +401 -0
- data/spec/api/snapshots_api_spec.rb +111 -0
- data/spec/api/templates_api_spec.rb +60 -0
- data/spec/api/user_management_api_spec.rb +402 -0
- data/spec/api/user_s3_keys_api_spec.rb +128 -0
- data/spec/api/volumes_api_spec.rb +171 -0
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +5 -5
- data/spec/models/attached_volumes_spec.rb +70 -0
- data/spec/models/backup_unit_properties_spec.rb +46 -0
- data/spec/models/backup_unit_spec.rb +62 -0
- data/spec/models/backup_unit_sso_spec.rb +34 -0
- data/spec/models/backup_units_spec.rb +56 -0
- data/spec/models/balanced_nics_spec.rb +70 -0
- data/spec/models/cdroms_spec.rb +70 -0
- data/spec/models/connectable_datacenter_spec.rb +46 -0
- data/spec/models/contract_properties_spec.rb +58 -0
- data/spec/models/contract_spec.rb +40 -0
- data/spec/models/contracts_spec.rb +52 -0
- data/spec/models/cpu_architecture_properties_spec.rb +52 -0
- data/spec/models/data_center_entities_spec.rb +64 -0
- data/spec/models/datacenter_element_metadata_spec.rb +80 -0
- data/spec/models/datacenter_properties_spec.rb +74 -0
- data/spec/models/datacenter_spec.rb +64 -0
- data/spec/models/datacenters_spec.rb +70 -0
- data/spec/models/error_message_spec.rb +40 -0
- data/spec/models/error_spec.rb +40 -0
- data/spec/models/firewall_rule_spec.rb +58 -0
- data/spec/models/firewall_rules_spec.rb +70 -0
- data/spec/models/firewallrule_properties_spec.rb +108 -0
- data/spec/models/flow_log_properties_spec.rb +60 -0
- data/spec/models/flow_log_put_spec.rb +52 -0
- data/spec/models/flow_log_spec.rb +58 -0
- data/spec/models/flow_logs_spec.rb +70 -0
- data/spec/models/group_entities_spec.rb +40 -0
- data/spec/models/group_members_spec.rb +52 -0
- data/spec/models/group_properties_spec.rb +100 -0
- data/spec/models/group_share_properties_spec.rb +40 -0
- data/spec/models/group_share_spec.rb +52 -0
- data/spec/models/group_shares_spec.rb +52 -0
- data/spec/models/group_spec.rb +58 -0
- data/spec/models/group_users_spec.rb +52 -0
- data/spec/models/groups_spec.rb +52 -0
- data/spec/models/image_properties_spec.rb +138 -0
- data/spec/models/image_spec.rb +58 -0
- data/spec/models/images_spec.rb +52 -0
- data/spec/models/info_spec.rb +46 -0
- data/spec/models/ip_block_properties_spec.rb +58 -0
- data/spec/models/ip_block_spec.rb +58 -0
- data/spec/models/ip_blocks_spec.rb +52 -0
- data/spec/models/ip_consumer_spec.rb +70 -0
- data/spec/models/ip_failover_spec.rb +40 -0
- data/spec/models/kubernetes_auto_scaling_spec.rb +40 -0
- data/spec/models/kubernetes_cluster_entities_spec.rb +34 -0
- data/spec/models/kubernetes_cluster_for_post_spec.rb +68 -0
- data/spec/models/kubernetes_cluster_for_put_spec.rb +68 -0
- data/spec/models/kubernetes_cluster_properties_for_post_spec.rb +58 -0
- data/spec/models/kubernetes_cluster_properties_for_put_spec.rb +46 -0
- data/spec/models/kubernetes_cluster_properties_spec.rb +70 -0
- data/spec/models/kubernetes_cluster_spec.rb +68 -0
- data/spec/models/kubernetes_clusters_spec.rb +56 -0
- data/spec/models/kubernetes_maintenance_window_spec.rb +44 -0
- data/spec/models/kubernetes_node_metadata_spec.rb +62 -0
- data/spec/models/kubernetes_node_pool_for_post_spec.rb +62 -0
- data/spec/models/kubernetes_node_pool_for_put_spec.rb +62 -0
- data/spec/models/kubernetes_node_pool_lan_routes_spec.rb +40 -0
- data/spec/models/kubernetes_node_pool_lan_spec.rb +46 -0
- data/spec/models/kubernetes_node_pool_properties_for_post_spec.rb +132 -0
- data/spec/models/kubernetes_node_pool_properties_for_put_spec.rb +82 -0
- data/spec/models/kubernetes_node_pool_properties_spec.rb +138 -0
- data/spec/models/kubernetes_node_pool_spec.rb +62 -0
- data/spec/models/kubernetes_node_pools_spec.rb +56 -0
- data/spec/models/kubernetes_node_properties_spec.rb +52 -0
- data/spec/models/kubernetes_node_spec.rb +62 -0
- data/spec/models/kubernetes_nodes_spec.rb +56 -0
- data/spec/models/label_properties_spec.rb +58 -0
- data/spec/models/label_resource_properties_spec.rb +40 -0
- data/spec/models/label_resource_spec.rb +62 -0
- data/spec/models/label_resources_spec.rb +74 -0
- data/spec/models/label_spec.rb +62 -0
- data/spec/models/labels_spec.rb +56 -0
- data/spec/models/lan_entities_spec.rb +34 -0
- data/spec/models/lan_nics_spec.rb +70 -0
- data/spec/models/lan_post_spec.rb +64 -0
- data/spec/models/lan_properties_post_spec.rb +52 -0
- data/spec/models/lan_properties_spec.rb +52 -0
- data/spec/models/lan_spec.rb +64 -0
- data/spec/models/lans_spec.rb +70 -0
- data/spec/models/loadbalancer_entities_spec.rb +34 -0
- data/spec/models/loadbalancer_properties_spec.rb +50 -0
- data/spec/models/loadbalancer_spec.rb +64 -0
- data/spec/models/loadbalancers_spec.rb +70 -0
- data/spec/models/location_properties_spec.rb +56 -0
- data/spec/models/location_spec.rb +58 -0
- data/spec/models/locations_spec.rb +52 -0
- data/spec/models/nat_gateway_entities_spec.rb +40 -0
- data/spec/models/nat_gateway_lan_properties_spec.rb +40 -0
- data/spec/models/nat_gateway_properties_spec.rb +46 -0
- data/spec/models/nat_gateway_put_spec.rb +52 -0
- data/spec/models/nat_gateway_rule_properties_spec.rb +70 -0
- data/spec/models/nat_gateway_rule_protocol_spec.rb +28 -0
- data/spec/models/nat_gateway_rule_put_spec.rb +52 -0
- data/spec/models/nat_gateway_rule_spec.rb +58 -0
- data/spec/models/nat_gateway_rule_type_spec.rb +28 -0
- data/spec/models/nat_gateway_rules_spec.rb +52 -0
- data/spec/models/nat_gateway_spec.rb +64 -0
- data/spec/models/nat_gateways_spec.rb +70 -0
- data/spec/models/network_load_balancer_entities_spec.rb +40 -0
- data/spec/models/network_load_balancer_forwarding_rule_health_check_spec.rb +58 -0
- data/spec/models/network_load_balancer_forwarding_rule_properties_spec.rb +78 -0
- data/spec/models/network_load_balancer_forwarding_rule_put_spec.rb +52 -0
- data/spec/models/network_load_balancer_forwarding_rule_spec.rb +58 -0
- data/spec/models/network_load_balancer_forwarding_rule_target_health_check_spec.rb +46 -0
- data/spec/models/network_load_balancer_forwarding_rule_target_spec.rb +52 -0
- data/spec/models/network_load_balancer_forwarding_rules_spec.rb +70 -0
- data/spec/models/network_load_balancer_properties_spec.rb +58 -0
- data/spec/models/network_load_balancer_put_spec.rb +52 -0
- data/spec/models/network_load_balancer_spec.rb +64 -0
- data/spec/models/network_load_balancers_spec.rb +70 -0
- data/spec/models/nic_entities_spec.rb +40 -0
- data/spec/models/nic_properties_spec.rb +86 -0
- data/spec/models/nic_put_spec.rb +52 -0
- data/spec/models/nic_spec.rb +64 -0
- data/spec/models/nics_spec.rb +70 -0
- data/spec/models/no_state_meta_data_spec.rb +70 -0
- data/spec/models/pagination_links_spec.rb +46 -0
- data/spec/models/peer_spec.rb +58 -0
- data/spec/models/private_cross_connect_properties_spec.rb +52 -0
- data/spec/models/private_cross_connect_spec.rb +58 -0
- data/spec/models/private_cross_connects_spec.rb +52 -0
- data/spec/models/remote_console_url_spec.rb +34 -0
- data/spec/models/request_metadata_spec.rb +52 -0
- data/spec/models/request_properties_spec.rb +52 -0
- data/spec/models/request_spec.rb +58 -0
- data/spec/models/request_status_metadata_spec.rb +56 -0
- data/spec/models/request_status_spec.rb +52 -0
- data/spec/models/request_target_spec.rb +44 -0
- data/spec/models/requests_spec.rb +70 -0
- data/spec/models/resource_entities_spec.rb +34 -0
- data/spec/models/resource_groups_spec.rb +52 -0
- data/spec/models/resource_limits_spec.rb +160 -0
- data/spec/models/resource_properties_spec.rb +40 -0
- data/spec/models/resource_reference_spec.rb +46 -0
- data/spec/models/resource_spec.rb +64 -0
- data/spec/models/resources_spec.rb +52 -0
- data/spec/models/resources_users_spec.rb +52 -0
- data/spec/models/s3_key_metadata_spec.rb +40 -0
- data/spec/models/s3_key_properties_spec.rb +40 -0
- data/spec/models/s3_key_spec.rb +58 -0
- data/spec/models/s3_keys_spec.rb +52 -0
- data/spec/models/s3_object_storage_sso_spec.rb +34 -0
- data/spec/models/server_entities_spec.rb +46 -0
- data/spec/models/server_properties_spec.rb +96 -0
- data/spec/models/server_spec.rb +64 -0
- data/spec/models/servers_spec.rb +70 -0
- data/spec/models/snapshot_properties_spec.rb +128 -0
- data/spec/models/snapshot_spec.rb +58 -0
- data/spec/models/snapshots_spec.rb +52 -0
- data/spec/models/target_port_range_spec.rb +40 -0
- data/spec/models/template_properties_spec.rb +52 -0
- data/spec/models/template_spec.rb +58 -0
- data/spec/models/templates_spec.rb +52 -0
- data/spec/models/token_spec.rb +34 -0
- data/spec/models/type_spec.rb +28 -0
- data/spec/models/user_metadata_spec.rb +46 -0
- data/spec/models/user_post_spec.rb +34 -0
- data/spec/models/user_properties_post_spec.rb +76 -0
- data/spec/models/user_properties_put_spec.rb +70 -0
- data/spec/models/user_properties_spec.rb +76 -0
- data/spec/models/user_put_spec.rb +40 -0
- data/spec/models/user_spec.rb +64 -0
- data/spec/models/users_entities_spec.rb +40 -0
- data/spec/models/users_spec.rb +52 -0
- data/spec/models/volume_properties_spec.rb +158 -0
- data/spec/models/volume_spec.rb +58 -0
- data/spec/models/volumes_spec.rb +70 -0
- data/spec/spec_helper.rb +2 -2
- metadata +642 -179
- data/Gemfile.lock +0 -68
- data/LICENSE +0 -190
- data/README.md +0 -65
- data/docs/api/NicApi.md +0 -1087
- data/docs/models/IpBlocks.md +0 -30
- data/docs/models/KubernetesConfig.md +0 -24
- data/docs/models/KubernetesConfigProperties.md +0 -18
- data/docs/models/KubernetesNodePoolLan.md +0 -18
- data/docs/models/Users.md +0 -30
- data/lib/ionoscloud/api/nic_api.rb +0 -1222
- data/lib/test_driver.rb +0 -104
@@ -0,0 +1,517 @@
|
|
1
|
+
# UserS3KeysApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.ionos.com/cloudapi/v6*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**um_users_s3keys_delete**](UserS3KeysApi.md#um_users_s3keys_delete) | **DELETE** /um/users/{userId}/s3keys/{keyId} | Delete an S3 Key |
|
8
|
+
| [**um_users_s3keys_find_by_key_id**](UserS3KeysApi.md#um_users_s3keys_find_by_key_id) | **GET** /um/users/{userId}/s3keys/{keyId} | Retrieve given S3 Key belonging to the given User |
|
9
|
+
| [**um_users_s3keys_get**](UserS3KeysApi.md#um_users_s3keys_get) | **GET** /um/users/{userId}/s3keys | Retrieve a User's S3 keys |
|
10
|
+
| [**um_users_s3keys_post**](UserS3KeysApi.md#um_users_s3keys_post) | **POST** /um/users/{userId}/s3keys | Create a S3 Key for the given User |
|
11
|
+
| [**um_users_s3keys_put**](UserS3KeysApi.md#um_users_s3keys_put) | **PUT** /um/users/{userId}/s3keys/{keyId} | Modify a S3 key having the given key id |
|
12
|
+
| [**um_users_s3ssourl_get**](UserS3KeysApi.md#um_users_s3ssourl_get) | **GET** /um/users/{userId}/s3ssourl | Retrieve S3 object storage single signon URL for the given user |
|
13
|
+
|
14
|
+
|
15
|
+
## um_users_s3keys_delete
|
16
|
+
|
17
|
+
> Object um_users_s3keys_delete(user_id, key_id, opts)
|
18
|
+
|
19
|
+
Delete an S3 Key
|
20
|
+
|
21
|
+
Delete an S3 key.
|
22
|
+
|
23
|
+
### Examples
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
require 'time'
|
27
|
+
require 'ionoscloud'
|
28
|
+
# setup authorization
|
29
|
+
Ionoscloud.configure do |config|
|
30
|
+
# Configure HTTP basic authorization: Basic Authentication
|
31
|
+
config.username = 'YOUR USERNAME'
|
32
|
+
config.password = 'YOUR PASSWORD'
|
33
|
+
|
34
|
+
# Configure API key authorization: Token Authentication
|
35
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
36
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
37
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
38
|
+
end
|
39
|
+
|
40
|
+
api_instance = Ionoscloud::UserS3KeysApi.new
|
41
|
+
user_id = 'user_id_example' # String | The unique ID of the user
|
42
|
+
key_id = 'key_id_example' # String | The unique access key ID of the S3 key
|
43
|
+
opts = {
|
44
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
45
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
46
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
47
|
+
}
|
48
|
+
|
49
|
+
begin
|
50
|
+
# Delete an S3 Key
|
51
|
+
result = api_instance.um_users_s3keys_delete(user_id, key_id, opts)
|
52
|
+
p result
|
53
|
+
rescue Ionoscloud::ApiError => e
|
54
|
+
puts "Error when calling UserS3KeysApi->um_users_s3keys_delete: #{e}"
|
55
|
+
end
|
56
|
+
```
|
57
|
+
|
58
|
+
#### Using the um_users_s3keys_delete_with_http_info variant
|
59
|
+
|
60
|
+
This returns an Array which contains the response data, status code and headers.
|
61
|
+
|
62
|
+
> <Array(Object, Integer, Hash)> um_users_s3keys_delete_with_http_info(user_id, key_id, opts)
|
63
|
+
|
64
|
+
```ruby
|
65
|
+
begin
|
66
|
+
# Delete an S3 Key
|
67
|
+
data, status_code, headers = api_instance.um_users_s3keys_delete_with_http_info(user_id, key_id, opts)
|
68
|
+
p status_code # => 2xx
|
69
|
+
p headers # => { ... }
|
70
|
+
p data # => Object
|
71
|
+
rescue Ionoscloud::ApiError => e
|
72
|
+
puts "Error when calling UserS3KeysApi->um_users_s3keys_delete_with_http_info: #{e}"
|
73
|
+
end
|
74
|
+
```
|
75
|
+
|
76
|
+
### Parameters
|
77
|
+
|
78
|
+
| Name | Type | Description | Notes |
|
79
|
+
| ---- | ---- | ----------- | ----- |
|
80
|
+
| **user_id** | **String** | The unique ID of the user | |
|
81
|
+
| **key_id** | **String** | The unique access key ID of the S3 key | |
|
82
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
83
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
84
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
85
|
+
|
86
|
+
### Return type
|
87
|
+
|
88
|
+
**Object**
|
89
|
+
|
90
|
+
### Authorization
|
91
|
+
|
92
|
+
Basic Authentication, Token Authentication
|
93
|
+
|
94
|
+
### HTTP request headers
|
95
|
+
|
96
|
+
- **Content-Type**: Not defined
|
97
|
+
- **Accept**: application/json
|
98
|
+
|
99
|
+
|
100
|
+
## um_users_s3keys_find_by_key_id
|
101
|
+
|
102
|
+
> <S3Key> um_users_s3keys_find_by_key_id(user_id, key_id, opts)
|
103
|
+
|
104
|
+
Retrieve given S3 Key belonging to the given User
|
105
|
+
|
106
|
+
You can retrieve S3 key belonging to the given User. This user Id can be found in the response body when a user is created or when you GET a list of users. The key Id can be found in the response body when a S3 key is created or when you GET a list of all S3 keys of a user
|
107
|
+
|
108
|
+
### Examples
|
109
|
+
|
110
|
+
```ruby
|
111
|
+
require 'time'
|
112
|
+
require 'ionoscloud'
|
113
|
+
# setup authorization
|
114
|
+
Ionoscloud.configure do |config|
|
115
|
+
# Configure HTTP basic authorization: Basic Authentication
|
116
|
+
config.username = 'YOUR USERNAME'
|
117
|
+
config.password = 'YOUR PASSWORD'
|
118
|
+
|
119
|
+
# Configure API key authorization: Token Authentication
|
120
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
121
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
122
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
123
|
+
end
|
124
|
+
|
125
|
+
api_instance = Ionoscloud::UserS3KeysApi.new
|
126
|
+
user_id = 'user_id_example' # String | The unique ID of the user
|
127
|
+
key_id = 'key_id_example' # String | The unique access key ID of the S3 key
|
128
|
+
opts = {
|
129
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
130
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
131
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
132
|
+
}
|
133
|
+
|
134
|
+
begin
|
135
|
+
# Retrieve given S3 Key belonging to the given User
|
136
|
+
result = api_instance.um_users_s3keys_find_by_key_id(user_id, key_id, opts)
|
137
|
+
p result
|
138
|
+
rescue Ionoscloud::ApiError => e
|
139
|
+
puts "Error when calling UserS3KeysApi->um_users_s3keys_find_by_key_id: #{e}"
|
140
|
+
end
|
141
|
+
```
|
142
|
+
|
143
|
+
#### Using the um_users_s3keys_find_by_key_id_with_http_info variant
|
144
|
+
|
145
|
+
This returns an Array which contains the response data, status code and headers.
|
146
|
+
|
147
|
+
> <Array(<S3Key>, Integer, Hash)> um_users_s3keys_find_by_key_id_with_http_info(user_id, key_id, opts)
|
148
|
+
|
149
|
+
```ruby
|
150
|
+
begin
|
151
|
+
# Retrieve given S3 Key belonging to the given User
|
152
|
+
data, status_code, headers = api_instance.um_users_s3keys_find_by_key_id_with_http_info(user_id, key_id, opts)
|
153
|
+
p status_code # => 2xx
|
154
|
+
p headers # => { ... }
|
155
|
+
p data # => <S3Key>
|
156
|
+
rescue Ionoscloud::ApiError => e
|
157
|
+
puts "Error when calling UserS3KeysApi->um_users_s3keys_find_by_key_id_with_http_info: #{e}"
|
158
|
+
end
|
159
|
+
```
|
160
|
+
|
161
|
+
### Parameters
|
162
|
+
|
163
|
+
| Name | Type | Description | Notes |
|
164
|
+
| ---- | ---- | ----------- | ----- |
|
165
|
+
| **user_id** | **String** | The unique ID of the user | |
|
166
|
+
| **key_id** | **String** | The unique access key ID of the S3 key | |
|
167
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
168
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
169
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
170
|
+
|
171
|
+
### Return type
|
172
|
+
|
173
|
+
[**S3Key**](S3Key.md)
|
174
|
+
|
175
|
+
### Authorization
|
176
|
+
|
177
|
+
Basic Authentication, Token Authentication
|
178
|
+
|
179
|
+
### HTTP request headers
|
180
|
+
|
181
|
+
- **Content-Type**: Not defined
|
182
|
+
- **Accept**: application/json
|
183
|
+
|
184
|
+
|
185
|
+
## um_users_s3keys_get
|
186
|
+
|
187
|
+
> <S3Keys> um_users_s3keys_get(user_id, opts)
|
188
|
+
|
189
|
+
Retrieve a User's S3 keys
|
190
|
+
|
191
|
+
You can retrieve S3 keys owned by a user by using the users ID. This user Id can be found in the response body when a user is created or when you GET a list of users.
|
192
|
+
|
193
|
+
### Examples
|
194
|
+
|
195
|
+
```ruby
|
196
|
+
require 'time'
|
197
|
+
require 'ionoscloud'
|
198
|
+
# setup authorization
|
199
|
+
Ionoscloud.configure do |config|
|
200
|
+
# Configure HTTP basic authorization: Basic Authentication
|
201
|
+
config.username = 'YOUR USERNAME'
|
202
|
+
config.password = 'YOUR PASSWORD'
|
203
|
+
|
204
|
+
# Configure API key authorization: Token Authentication
|
205
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
206
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
207
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
208
|
+
end
|
209
|
+
|
210
|
+
api_instance = Ionoscloud::UserS3KeysApi.new
|
211
|
+
user_id = 'user_id_example' # String | The unique ID of the user
|
212
|
+
opts = {
|
213
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
214
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
215
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
216
|
+
}
|
217
|
+
|
218
|
+
begin
|
219
|
+
# Retrieve a User's S3 keys
|
220
|
+
result = api_instance.um_users_s3keys_get(user_id, opts)
|
221
|
+
p result
|
222
|
+
rescue Ionoscloud::ApiError => e
|
223
|
+
puts "Error when calling UserS3KeysApi->um_users_s3keys_get: #{e}"
|
224
|
+
end
|
225
|
+
```
|
226
|
+
|
227
|
+
#### Using the um_users_s3keys_get_with_http_info variant
|
228
|
+
|
229
|
+
This returns an Array which contains the response data, status code and headers.
|
230
|
+
|
231
|
+
> <Array(<S3Keys>, Integer, Hash)> um_users_s3keys_get_with_http_info(user_id, opts)
|
232
|
+
|
233
|
+
```ruby
|
234
|
+
begin
|
235
|
+
# Retrieve a User's S3 keys
|
236
|
+
data, status_code, headers = api_instance.um_users_s3keys_get_with_http_info(user_id, opts)
|
237
|
+
p status_code # => 2xx
|
238
|
+
p headers # => { ... }
|
239
|
+
p data # => <S3Keys>
|
240
|
+
rescue Ionoscloud::ApiError => e
|
241
|
+
puts "Error when calling UserS3KeysApi->um_users_s3keys_get_with_http_info: #{e}"
|
242
|
+
end
|
243
|
+
```
|
244
|
+
|
245
|
+
### Parameters
|
246
|
+
|
247
|
+
| Name | Type | Description | Notes |
|
248
|
+
| ---- | ---- | ----------- | ----- |
|
249
|
+
| **user_id** | **String** | The unique ID of the user | |
|
250
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
251
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
252
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
253
|
+
|
254
|
+
### Return type
|
255
|
+
|
256
|
+
[**S3Keys**](S3Keys.md)
|
257
|
+
|
258
|
+
### Authorization
|
259
|
+
|
260
|
+
Basic Authentication, Token Authentication
|
261
|
+
|
262
|
+
### HTTP request headers
|
263
|
+
|
264
|
+
- **Content-Type**: Not defined
|
265
|
+
- **Accept**: application/json
|
266
|
+
|
267
|
+
|
268
|
+
## um_users_s3keys_post
|
269
|
+
|
270
|
+
> <S3Key> um_users_s3keys_post(user_id, opts)
|
271
|
+
|
272
|
+
Create a S3 Key for the given User
|
273
|
+
|
274
|
+
Creates a S3 key for the given user. This user Id can be found in the response body when a user is created or when you GET a list of users. Maximum of 5 keys can be generated for a given user
|
275
|
+
|
276
|
+
### Examples
|
277
|
+
|
278
|
+
```ruby
|
279
|
+
require 'time'
|
280
|
+
require 'ionoscloud'
|
281
|
+
# setup authorization
|
282
|
+
Ionoscloud.configure do |config|
|
283
|
+
# Configure HTTP basic authorization: Basic Authentication
|
284
|
+
config.username = 'YOUR USERNAME'
|
285
|
+
config.password = 'YOUR PASSWORD'
|
286
|
+
|
287
|
+
# Configure API key authorization: Token Authentication
|
288
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
289
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
290
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
291
|
+
end
|
292
|
+
|
293
|
+
api_instance = Ionoscloud::UserS3KeysApi.new
|
294
|
+
user_id = 'user_id_example' # String | The unique ID of the user
|
295
|
+
opts = {
|
296
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
297
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
298
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
299
|
+
}
|
300
|
+
|
301
|
+
begin
|
302
|
+
# Create a S3 Key for the given User
|
303
|
+
result = api_instance.um_users_s3keys_post(user_id, opts)
|
304
|
+
p result
|
305
|
+
rescue Ionoscloud::ApiError => e
|
306
|
+
puts "Error when calling UserS3KeysApi->um_users_s3keys_post: #{e}"
|
307
|
+
end
|
308
|
+
```
|
309
|
+
|
310
|
+
#### Using the um_users_s3keys_post_with_http_info variant
|
311
|
+
|
312
|
+
This returns an Array which contains the response data, status code and headers.
|
313
|
+
|
314
|
+
> <Array(<S3Key>, Integer, Hash)> um_users_s3keys_post_with_http_info(user_id, opts)
|
315
|
+
|
316
|
+
```ruby
|
317
|
+
begin
|
318
|
+
# Create a S3 Key for the given User
|
319
|
+
data, status_code, headers = api_instance.um_users_s3keys_post_with_http_info(user_id, opts)
|
320
|
+
p status_code # => 2xx
|
321
|
+
p headers # => { ... }
|
322
|
+
p data # => <S3Key>
|
323
|
+
rescue Ionoscloud::ApiError => e
|
324
|
+
puts "Error when calling UserS3KeysApi->um_users_s3keys_post_with_http_info: #{e}"
|
325
|
+
end
|
326
|
+
```
|
327
|
+
|
328
|
+
### Parameters
|
329
|
+
|
330
|
+
| Name | Type | Description | Notes |
|
331
|
+
| ---- | ---- | ----------- | ----- |
|
332
|
+
| **user_id** | **String** | The unique ID of the user | |
|
333
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
334
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
335
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
336
|
+
|
337
|
+
### Return type
|
338
|
+
|
339
|
+
[**S3Key**](S3Key.md)
|
340
|
+
|
341
|
+
### Authorization
|
342
|
+
|
343
|
+
Basic Authentication, Token Authentication
|
344
|
+
|
345
|
+
### HTTP request headers
|
346
|
+
|
347
|
+
- **Content-Type**: Not defined
|
348
|
+
- **Accept**: application/json
|
349
|
+
|
350
|
+
|
351
|
+
## um_users_s3keys_put
|
352
|
+
|
353
|
+
> <S3Key> um_users_s3keys_put(user_id, key_id, s3_key, opts)
|
354
|
+
|
355
|
+
Modify a S3 key having the given key id
|
356
|
+
|
357
|
+
You can enable or disable a given S3 key.
|
358
|
+
|
359
|
+
### Examples
|
360
|
+
|
361
|
+
```ruby
|
362
|
+
require 'time'
|
363
|
+
require 'ionoscloud'
|
364
|
+
# setup authorization
|
365
|
+
Ionoscloud.configure do |config|
|
366
|
+
# Configure HTTP basic authorization: Basic Authentication
|
367
|
+
config.username = 'YOUR USERNAME'
|
368
|
+
config.password = 'YOUR PASSWORD'
|
369
|
+
|
370
|
+
# Configure API key authorization: Token Authentication
|
371
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
372
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
373
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
374
|
+
end
|
375
|
+
|
376
|
+
api_instance = Ionoscloud::UserS3KeysApi.new
|
377
|
+
user_id = 'user_id_example' # String |
|
378
|
+
key_id = 'key_id_example' # String | The unique access key ID of the S3 key
|
379
|
+
s3_key = Ionoscloud::S3Key.new({properties: Ionoscloud::S3KeyProperties.new}) # S3Key | Modified S3 key
|
380
|
+
opts = {
|
381
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
382
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
383
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
384
|
+
}
|
385
|
+
|
386
|
+
begin
|
387
|
+
# Modify a S3 key having the given key id
|
388
|
+
result = api_instance.um_users_s3keys_put(user_id, key_id, s3_key, opts)
|
389
|
+
p result
|
390
|
+
rescue Ionoscloud::ApiError => e
|
391
|
+
puts "Error when calling UserS3KeysApi->um_users_s3keys_put: #{e}"
|
392
|
+
end
|
393
|
+
```
|
394
|
+
|
395
|
+
#### Using the um_users_s3keys_put_with_http_info variant
|
396
|
+
|
397
|
+
This returns an Array which contains the response data, status code and headers.
|
398
|
+
|
399
|
+
> <Array(<S3Key>, Integer, Hash)> um_users_s3keys_put_with_http_info(user_id, key_id, s3_key, opts)
|
400
|
+
|
401
|
+
```ruby
|
402
|
+
begin
|
403
|
+
# Modify a S3 key having the given key id
|
404
|
+
data, status_code, headers = api_instance.um_users_s3keys_put_with_http_info(user_id, key_id, s3_key, opts)
|
405
|
+
p status_code # => 2xx
|
406
|
+
p headers # => { ... }
|
407
|
+
p data # => <S3Key>
|
408
|
+
rescue Ionoscloud::ApiError => e
|
409
|
+
puts "Error when calling UserS3KeysApi->um_users_s3keys_put_with_http_info: #{e}"
|
410
|
+
end
|
411
|
+
```
|
412
|
+
|
413
|
+
### Parameters
|
414
|
+
|
415
|
+
| Name | Type | Description | Notes |
|
416
|
+
| ---- | ---- | ----------- | ----- |
|
417
|
+
| **user_id** | **String** | | |
|
418
|
+
| **key_id** | **String** | The unique access key ID of the S3 key | |
|
419
|
+
| **s3_key** | [**S3Key**](S3Key.md) | Modified S3 key | |
|
420
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
421
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
422
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
423
|
+
|
424
|
+
### Return type
|
425
|
+
|
426
|
+
[**S3Key**](S3Key.md)
|
427
|
+
|
428
|
+
### Authorization
|
429
|
+
|
430
|
+
Basic Authentication, Token Authentication
|
431
|
+
|
432
|
+
### HTTP request headers
|
433
|
+
|
434
|
+
- **Content-Type**: application/json
|
435
|
+
- **Accept**: application/json
|
436
|
+
|
437
|
+
|
438
|
+
## um_users_s3ssourl_get
|
439
|
+
|
440
|
+
> <S3ObjectStorageSSO> um_users_s3ssourl_get(user_id, opts)
|
441
|
+
|
442
|
+
Retrieve S3 object storage single signon URL for the given user
|
443
|
+
|
444
|
+
You can retrieve S3 object storage single signon URL for the given user. This user Id can be found in the response body when a user is created or when you GET a list of users.
|
445
|
+
|
446
|
+
### Examples
|
447
|
+
|
448
|
+
```ruby
|
449
|
+
require 'time'
|
450
|
+
require 'ionoscloud'
|
451
|
+
# setup authorization
|
452
|
+
Ionoscloud.configure do |config|
|
453
|
+
# Configure HTTP basic authorization: Basic Authentication
|
454
|
+
config.username = 'YOUR USERNAME'
|
455
|
+
config.password = 'YOUR PASSWORD'
|
456
|
+
|
457
|
+
# Configure API key authorization: Token Authentication
|
458
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
459
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
460
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
461
|
+
end
|
462
|
+
|
463
|
+
api_instance = Ionoscloud::UserS3KeysApi.new
|
464
|
+
user_id = 'user_id_example' # String | The unique ID of the user
|
465
|
+
opts = {
|
466
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
467
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
468
|
+
}
|
469
|
+
|
470
|
+
begin
|
471
|
+
# Retrieve S3 object storage single signon URL for the given user
|
472
|
+
result = api_instance.um_users_s3ssourl_get(user_id, opts)
|
473
|
+
p result
|
474
|
+
rescue Ionoscloud::ApiError => e
|
475
|
+
puts "Error when calling UserS3KeysApi->um_users_s3ssourl_get: #{e}"
|
476
|
+
end
|
477
|
+
```
|
478
|
+
|
479
|
+
#### Using the um_users_s3ssourl_get_with_http_info variant
|
480
|
+
|
481
|
+
This returns an Array which contains the response data, status code and headers.
|
482
|
+
|
483
|
+
> <Array(<S3ObjectStorageSSO>, Integer, Hash)> um_users_s3ssourl_get_with_http_info(user_id, opts)
|
484
|
+
|
485
|
+
```ruby
|
486
|
+
begin
|
487
|
+
# Retrieve S3 object storage single signon URL for the given user
|
488
|
+
data, status_code, headers = api_instance.um_users_s3ssourl_get_with_http_info(user_id, opts)
|
489
|
+
p status_code # => 2xx
|
490
|
+
p headers # => { ... }
|
491
|
+
p data # => <S3ObjectStorageSSO>
|
492
|
+
rescue Ionoscloud::ApiError => e
|
493
|
+
puts "Error when calling UserS3KeysApi->um_users_s3ssourl_get_with_http_info: #{e}"
|
494
|
+
end
|
495
|
+
```
|
496
|
+
|
497
|
+
### Parameters
|
498
|
+
|
499
|
+
| Name | Type | Description | Notes |
|
500
|
+
| ---- | ---- | ----------- | ----- |
|
501
|
+
| **user_id** | **String** | The unique ID of the user | |
|
502
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
503
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
504
|
+
|
505
|
+
### Return type
|
506
|
+
|
507
|
+
[**S3ObjectStorageSSO**](S3ObjectStorageSSO.md)
|
508
|
+
|
509
|
+
### Authorization
|
510
|
+
|
511
|
+
Basic Authentication, Token Authentication
|
512
|
+
|
513
|
+
### HTTP request headers
|
514
|
+
|
515
|
+
- **Content-Type**: Not defined
|
516
|
+
- **Accept**: application/json
|
517
|
+
|
data/docs/Users.md
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
# Users
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | The resource's unique identifier | [optional][readonly] |
|
8
|
+
| **type** | [**Type**](Type.md) | The type of object that has been created | [optional] |
|
9
|
+
| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
|
10
|
+
| **items** | [**Array<User>**](User.md) | Array of items in that collection | [optional][readonly] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'ionoscloud'
|
16
|
+
|
17
|
+
instance = Ionoscloud::Users.new(
|
18
|
+
id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
|
19
|
+
type: "collection",
|
20
|
+
href: <RESOURCE-URI>,
|
21
|
+
items: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
File without changes
|
File without changes
|
@@ -5,12 +5,11 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **name** | **String** | A name of that resource | [optional] |
|
8
|
-
| **type** | **String** | Hardware type of the volume. | [optional] |
|
8
|
+
| **type** | **String** | Hardware type of the volume. DAS (Direct Attached Storage) could be used only in a composite call with a Cube server | [optional] |
|
9
9
|
| **size** | **Float** | The size of the volume in GB | |
|
10
|
-
| **availability_zone** | **String** | The availability zone in which the volume should exist. The storage volume will be provisioned on as less physical storages as possible but cannot guarantee upfront | [optional] |
|
10
|
+
| **availability_zone** | **String** | The availability zone in which the volume should exist. The storage volume will be provisioned on as less physical storages as possible but cannot guarantee upfront. It is not available for DAS (Direct Attached Storage) and subject of availability for SSD. | [optional] |
|
11
11
|
| **image** | **String** | Image or snapshot ID to be used as template for this volume | [optional] |
|
12
12
|
| **image_password** | **String** | Initial password to be set for installed OS. Works with public images only. Not modifiable, forbidden in update requests. Password rules allows all characters from a-z, A-Z, 0-9 | [optional] |
|
13
|
-
| **image_alias** | **String** | | [optional] |
|
14
13
|
| **ssh_keys** | **Array<String>** | Public SSH keys are set on the image as authorized keys for appropriate SSH login to the instance using the corresponding private key. This field may only be set in creation requests. When reading, it always returns null. SSH keys are only supported if a public Linux image is used for the volume creation. | [optional] |
|
15
14
|
| **bus** | **String** | The bus type of the volume. Default is VIRTIO | [optional] |
|
16
15
|
| **licence_type** | **String** | OS type of this volume | [optional][readonly] |
|
@@ -20,7 +19,8 @@
|
|
20
19
|
| **nic_hot_unplug** | **Boolean** | Is capable of nic hot unplug (no reboot required) | [optional] |
|
21
20
|
| **disc_virtio_hot_plug** | **Boolean** | Is capable of Virt-IO drive hot plug (no reboot required) | [optional] |
|
22
21
|
| **disc_virtio_hot_unplug** | **Boolean** | Is capable of Virt-IO drive hot unplug (no reboot required). This works only for non-Windows virtual Machines. | [optional] |
|
23
|
-
| **device_number** | **Integer** | The
|
22
|
+
| **device_number** | **Integer** | The Logical Unit Number of the storage volume. Null for volumes not mounted to any VM | [optional][readonly] |
|
23
|
+
| **pci_slot** | **Integer** | The PCI slot number of the storage volume. Null for volumes not mounted to any VM | [optional][readonly] |
|
24
24
|
| **backupunit_id** | **String** | The uuid of the Backup Unit that user has access to. The property is immutable and is only allowed to be set on a new volume creation. It is mandatory to provide either 'public image' or 'imageAlias' in conjunction with this property. | [optional] |
|
25
25
|
| **user_data** | **String** | The cloud-init configuration for the volume as base64 encoded string. The property is immutable and is only allowed to be set on a new volume creation. It is mandatory to provide either 'public image' or 'imageAlias' that has cloud-init compatibility in conjunction with this property. | [optional] |
|
26
26
|
|
@@ -36,7 +36,6 @@ instance = Ionoscloud::VolumeProperties.new(
|
|
36
36
|
availability_zone: AUTO,
|
37
37
|
image: d6ad1576-fde9-4696-aa41-1ebd75bdaf49,
|
38
38
|
image_password: mypass123,
|
39
|
-
image_alias: null,
|
40
39
|
ssh_keys: [ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCyWh6LZ7f2wxnupVgtK2096bc69Vv9uT2A58lwN3ol0A6mxqlT0f4M1NbarVUxa+MVdxBLud5PvlkbYc9mY91OyzLGZMfVWvhAYz/tJSsDtsgRUl0GFVv332zDWk0i+mAVy0N408OORm5XqV6zvIDaiB/jopyjemUp2rnP7pXU4+98ilZw6ef9DF9y4YZ64mchL5//rcrGm1Lff3pC75X/polGONHeG6m4Vs8eIu+0epJ4PJBxO+rwRYp1zMnn90UCk21KvTcYops2cte7ouXQwkGUq3vmXxnSdvuivK/4JNoFQBsaGV974hDmloS5LOvSJjKpXs8Ed437ln712345, ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCyWh6LZ7f2wxnupVgtK2096bc69Vv9uT2A58lwN3ol0A6mxqlT0f4M1NbarVUxa+MVdxBLud5PvlkbYc9mY91OyzLGZMfVWvhAYz/tJSsDtsgRUl0GFVv332zDWk0i+mAVy0N408OORm5XqV6zvIDaiB/jopyjemUp2rnP7pXU4+98ilZw6ef9DF9y4YZ64mchL5//rcrGm1Lff3pC75X/polGONHeG6m4Vs8eIu+0epJ4PJBxO+rwRYp1zMnn90UCk21KvTcYops2cte7ouXQwkGUq3vmXxnSdvuivK/asdfghjkjhyutry545tgvbn76e4rf43],
|
41
40
|
bus: VIRTIO,
|
42
41
|
licence_type: LINUX,
|
@@ -47,6 +46,7 @@ instance = Ionoscloud::VolumeProperties.new(
|
|
47
46
|
disc_virtio_hot_plug: true,
|
48
47
|
disc_virtio_hot_unplug: true,
|
49
48
|
device_number: 3,
|
49
|
+
pci_slot: 7,
|
50
50
|
backupunit_id: 25f67991-0f51-4efc-a8ad-ef1fb31a481c,
|
51
51
|
user_data: null
|
52
52
|
)
|
File without changes
|