Class: Softlayer::Network::Bandwidth::Version1::Allotment

Inherits:
Entity
  • Object
show all
Defined in:
lib/softlayer/network/bandwidth/version1/allotment.rb,
lib/softlayer/network/bandwidth/version1/allotment/detail.rb

Defined Under Namespace

Classes: Detail, Representer

Constant Summary collapse

SERVICE =
'SoftLayer_Network_Bandwidth_Version1_Allotment'

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Model

all, all_request_for, create, find, #init_headers, parse, process_message, #request, request, service_name, #service_name, #to_hash, #to_softlayer

Methods included from Model::Operations

extended, #filter, included, #limit, #mask, #request_headers

Instance Attribute Details

#accountObject

Returns the value of attribute account.



27
28
29
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 27

def 
  @account
end

#account_idObject

Returns the value of attribute account_id.



8
9
10
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 8

def 
  @account_id
end

#active_detail_countObject

Returns the value of attribute active_detail_count.



16
17
18
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 16

def active_detail_count
  @active_detail_count
end

#active_detailsObject

Returns the value of attribute active_details.



28
29
30
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 28

def active_details
  @active_details
end

#application_delivery_controller_countObject

Returns the value of attribute application_delivery_controller_count.



17
18
19
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 17

def application_delivery_controller_count
  @application_delivery_controller_count
end

#application_delivery_controllersObject

Returns the value of attribute application_delivery_controllers.



29
30
31
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 29

def application_delivery_controllers
  @application_delivery_controllers
end

#average_daily_public_bandwidth_usageObject

Returns the value of attribute average_daily_public_bandwidth_usage.



30
31
32
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 30

def average_daily_public_bandwidth_usage
  @average_daily_public_bandwidth_usage
end

#bandwidth_allotment_type_idObject

Returns the value of attribute bandwidth_allotment_type_id.



9
10
11
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 9

def bandwidth_allotment_type_id
  @bandwidth_allotment_type_id
end

#bare_metal_instance_countObject

Returns the value of attribute bare_metal_instance_count.



18
19
20
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 18

def bare_metal_instance_count
  @bare_metal_instance_count
end

#bare_metal_instancesObject

Returns the value of attribute bare_metal_instances.



31
32
33
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 31

def bare_metal_instances
  @bare_metal_instances
end

#billing_cycle_bandwidth_usageObject

Returns the value of attribute billing_cycle_bandwidth_usage.



32
33
34
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 32

def billing_cycle_bandwidth_usage
  @billing_cycle_bandwidth_usage
end

#billing_cycle_bandwidth_usage_countObject

Returns the value of attribute billing_cycle_bandwidth_usage_count.



19
20
21
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 19

def billing_cycle_bandwidth_usage_count
  @billing_cycle_bandwidth_usage_count
end

#billing_cycle_private_bandwidth_usageObject

Returns the value of attribute billing_cycle_private_bandwidth_usage.



33
34
35
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 33

def billing_cycle_private_bandwidth_usage
  @billing_cycle_private_bandwidth_usage
end

#billing_cycle_public_bandwidth_usageObject

Returns the value of attribute billing_cycle_public_bandwidth_usage.



34
35
36
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 34

def billing_cycle_public_bandwidth_usage
  @billing_cycle_public_bandwidth_usage
end

#billing_cycle_public_usage_totalObject

Returns the value of attribute billing_cycle_public_usage_total.



35
36
37
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 35

def billing_cycle_public_usage_total
  @billing_cycle_public_usage_total
end

#billing_itemObject

Returns the value of attribute billing_item.



36
37
38
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 36

def billing_item
  @billing_item
end

#create_dateObject

Returns the value of attribute create_date.



10
11
12
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 10

def create_date
  @create_date
end

#current_bandwidth_summaryObject

Returns the value of attribute current_bandwidth_summary.



37
38
39
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 37

def current_bandwidth_summary
  @current_bandwidth_summary
end

#detail_countObject

Returns the value of attribute detail_count.



20
21
22
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 20

def detail_count
  @detail_count
end

#detailsObject

Returns the value of attribute details.



38
39
40
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 38

def details
  @details
end

#end_dateObject

Returns the value of attribute end_date.



11
12
13
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 11

def end_date
  @end_date
end

#hardwareObject

Returns the value of attribute hardware.



39
40
41
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 39

def hardware
  @hardware
end

#hardware_countObject

Returns the value of attribute hardware_count.



21
22
23
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 21

def hardware_count
  @hardware_count
end

#idObject

Returns the value of attribute id.



12
13
14
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 12

def id
  @id
end

#inbound_public_bandwidth_usageObject

Returns the value of attribute inbound_public_bandwidth_usage.



40
41
42
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 40

def inbound_public_bandwidth_usage
  @inbound_public_bandwidth_usage
end

#location_groupObject

Returns the value of attribute location_group.



41
42
43
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 41

def location_group
  @location_group
end

#location_group_idObject

Returns the value of attribute location_group_id.



13
14
15
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 13

def location_group_id
  @location_group_id
end

#managed_bare_metal_instance_countObject

Returns the value of attribute managed_bare_metal_instance_count.



22
23
24
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 22

def managed_bare_metal_instance_count
  @managed_bare_metal_instance_count
end

#managed_bare_metal_instancesObject

Returns the value of attribute managed_bare_metal_instances.



42
43
44
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 42

def managed_bare_metal_instances
  @managed_bare_metal_instances
end

#managed_hardwareObject

Returns the value of attribute managed_hardware.



43
44
45
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 43

def managed_hardware
  @managed_hardware
end

#managed_hardware_countObject

Returns the value of attribute managed_hardware_count.



23
24
25
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 23

def managed_hardware_count
  @managed_hardware_count
end

#managed_virtual_guest_countObject

Returns the value of attribute managed_virtual_guest_count.



24
25
26
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 24

def managed_virtual_guest_count
  @managed_virtual_guest_count
end

#managed_virtual_guestsObject

Returns the value of attribute managed_virtual_guests.



44
45
46
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 44

def managed_virtual_guests
  @managed_virtual_guests
end

#metric_tracking_objectObject

Returns the value of attribute metric_tracking_object.



45
46
47
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 45

def metric_tracking_object
  @metric_tracking_object
end

#metric_tracking_object_idObject

Returns the value of attribute metric_tracking_object_id.



46
47
48
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 46

def metric_tracking_object_id
  @metric_tracking_object_id
end

#nameObject

Returns the value of attribute name.



14
15
16
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 14

def name
  @name
end

#outbound_public_bandwidth_usageObject

Returns the value of attribute outbound_public_bandwidth_usage.



47
48
49
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 47

def outbound_public_bandwidth_usage
  @outbound_public_bandwidth_usage
end

#over_bandwidth_allocation_flagObject

Returns the value of attribute over_bandwidth_allocation_flag.



48
49
50
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 48

def over_bandwidth_allocation_flag
  @over_bandwidth_allocation_flag
end

#private_network_only_hardwareObject

Returns the value of attribute private_network_only_hardware.



49
50
51
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 49

def private_network_only_hardware
  @private_network_only_hardware
end

#private_network_only_hardware_countObject

Returns the value of attribute private_network_only_hardware_count.



25
26
27
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 25

def private_network_only_hardware_count
  @private_network_only_hardware_count
end

#projected_over_bandwidth_allocation_flagObject

Returns the value of attribute projected_over_bandwidth_allocation_flag.



50
51
52
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 50

def projected_over_bandwidth_allocation_flag
  @projected_over_bandwidth_allocation_flag
end

#projected_public_bandwidth_usageObject

Returns the value of attribute projected_public_bandwidth_usage.



51
52
53
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 51

def projected_public_bandwidth_usage
  @projected_public_bandwidth_usage
end

#service_providerObject

Returns the value of attribute service_provider.



52
53
54
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 52

def service_provider
  @service_provider
end

#service_provider_idObject

Returns the value of attribute service_provider_id.



15
16
17
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 15

def service_provider_id
  @service_provider_id
end

#total_bandwidth_allocatedObject

Returns the value of attribute total_bandwidth_allocated.



53
54
55
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 53

def total_bandwidth_allocated
  @total_bandwidth_allocated
end

#virtual_guest_countObject

Returns the value of attribute virtual_guest_count.



26
27
28
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 26

def virtual_guest_count
  @virtual_guest_count
end

#virtual_guestsObject

Returns the value of attribute virtual_guests.



54
55
56
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 54

def virtual_guests
  @virtual_guests
end

Class Method Details

.create_object(message) ⇒ Object

template_object



57
58
59
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 57

def self.create_object(message)
  request(:create_object, Softlayer::Network::Bandwidth::Version1::Allotment, message)
end

.reassign_servers(message) ⇒ Object

template_objects new_allotment_id



233
234
235
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 233

def self.reassign_servers(message)
  request(:reassign_servers, Boolean, message)
end

.unassign_servers(message) ⇒ Object

template_objects



262
263
264
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 262

def self.unassign_servers(message)
  request(:unassign_servers, Boolean, message)
end

Instance Method Details

#edit_object(message) ⇒ Object

template_object



62
63
64
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 62

def edit_object(message)
  request(:edit_object, Boolean, message)
end

#get_accountObject



66
67
68
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 66

def 
  request(:get_account, Softlayer::)
end

#get_active_detailsObject



70
71
72
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 70

def get_active_details
  request(:get_active_details, Array[Softlayer::Network::Bandwidth::Version1::Allotment::Detail])
end

#get_application_delivery_controllersObject



74
75
76
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 74

def get_application_delivery_controllers
  request(:get_application_delivery_controllers, Array[Softlayer::Network::Application::Delivery::Controller])
end

#get_average_daily_public_bandwidth_usageObject



78
79
80
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 78

def get_average_daily_public_bandwidth_usage
  request(:get_average_daily_public_bandwidth_usage, Float)
end

#get_backend_bandwidth_by_hour(message) ⇒ Object

date



83
84
85
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 83

def get_backend_bandwidth_by_hour(message)
  request(:get_backend_bandwidth_by_hour, Array[Softlayer::Container::Network::Bandwidth::Version1::Usage], message)
end

#get_backend_bandwidth_use(message) ⇒ Object

start_date end_date



89
90
91
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 89

def get_backend_bandwidth_use(message)
  request(:get_backend_bandwidth_use, Array[Softlayer::Network::Bandwidth::Version1::Usage::Detail], message)
end

#get_bandwidth_for_date_range(message) ⇒ Object

start_date end_date



95
96
97
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 95

def get_bandwidth_for_date_range(message)
  request(:get_bandwidth_for_date_range, Array[Softlayer::Metric::Tracking::Object::Data], message)
end

#get_bandwidth_image(message) ⇒ Object

network_type snapshot_range draw date_specified



103
104
105
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 103

def get_bandwidth_image(message)
  request(:get_bandwidth_image, Softlayer::Container::Bandwidth::GraphOutputs, message)
end

#get_bare_metal_instancesObject



107
108
109
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 107

def get_bare_metal_instances
  request(:get_bare_metal_instances, Array[Softlayer::Hardware])
end

#get_billing_cycle_bandwidth_usageObject



111
112
113
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 111

def get_billing_cycle_bandwidth_usage
  request(:get_billing_cycle_bandwidth_usage, Array[Softlayer::Network::Bandwidth::Usage])
end

#get_billing_cycle_private_bandwidth_usageObject



115
116
117
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 115

def get_billing_cycle_private_bandwidth_usage
  request(:get_billing_cycle_private_bandwidth_usage, Softlayer::Network::Bandwidth::Usage)
end

#get_billing_cycle_public_bandwidth_usageObject



119
120
121
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 119

def get_billing_cycle_public_bandwidth_usage
  request(:get_billing_cycle_public_bandwidth_usage, Softlayer::Network::Bandwidth::Usage)
end

#get_billing_cycle_public_usage_totalObject



123
124
125
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 123

def get_billing_cycle_public_usage_total
  request(:get_billing_cycle_public_usage_total, Integer)
end

#get_billing_itemObject



127
128
129
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 127

def get_billing_item
  request(:get_billing_item, Softlayer::Billing::Item)
end

#get_current_bandwidth_summaryObject



131
132
133
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 131

def get_current_bandwidth_summary
  request(:get_current_bandwidth_summary, Softlayer::Metric::Tracking::Object::Bandwidth::Summary)
end

#get_custom_bandwidth_data_by_date(message) ⇒ Object

graph_data



136
137
138
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 136

def get_custom_bandwidth_data_by_date(message)
  request(:get_custom_bandwidth_data_by_date, Softlayer::Container::Graph, message)
end

#get_detailsObject



140
141
142
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 140

def get_details
  request(:get_details, Array[Softlayer::Network::Bandwidth::Version1::Allotment::Detail])
end

#get_frontend_bandwidth_by_hour(message) ⇒ Object

date



145
146
147
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 145

def get_frontend_bandwidth_by_hour(message)
  request(:get_frontend_bandwidth_by_hour, Array[Softlayer::Container::Network::Bandwidth::Version1::Usage], message)
end

#get_frontend_bandwidth_use(message) ⇒ Object

start_date end_date



151
152
153
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 151

def get_frontend_bandwidth_use(message)
  request(:get_frontend_bandwidth_use, Array[Softlayer::Network::Bandwidth::Version1::Usage::Detail], message)
end

#get_hardwareObject



155
156
157
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 155

def get_hardware
  request(:get_hardware, Array[Softlayer::Hardware])
end

#get_inbound_public_bandwidth_usageObject



159
160
161
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 159

def get_inbound_public_bandwidth_usage
  request(:get_inbound_public_bandwidth_usage, Float)
end

#get_location_groupObject



163
164
165
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 163

def get_location_group
  request(:get_location_group, Softlayer::Location::Group)
end

#get_managed_bare_metal_instancesObject



167
168
169
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 167

def get_managed_bare_metal_instances
  request(:get_managed_bare_metal_instances, Array[Softlayer::Hardware])
end

#get_managed_hardwareObject



171
172
173
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 171

def get_managed_hardware
  request(:get_managed_hardware, Array[Softlayer::Hardware])
end

#get_managed_virtual_guestsObject



175
176
177
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 175

def get_managed_virtual_guests
  request(:get_managed_virtual_guests, Array[Softlayer::Virtual::Guest])
end

#get_metric_tracking_objectObject



179
180
181
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 179

def get_metric_tracking_object
  request(:get_metric_tracking_object, Softlayer::Metric::Tracking::Object::VirtualDedicatedRack)
end

#get_metric_tracking_object_idObject



183
184
185
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 183

def get_metric_tracking_object_id
  request(:get_metric_tracking_object_id, Integer)
end

#get_objectObject



187
188
189
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 187

def get_object
  request(:get_object, Softlayer::Network::Bandwidth::Version1::Allotment)
end

#get_outbound_public_bandwidth_usageObject



191
192
193
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 191

def get_outbound_public_bandwidth_usage
  request(:get_outbound_public_bandwidth_usage, Float)
end

#get_over_bandwidth_allocation_flagObject



195
196
197
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 195

def get_over_bandwidth_allocation_flag
  request(:get_over_bandwidth_allocation_flag, Integer)
end

#get_private_network_only_hardwareObject



199
200
201
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 199

def get_private_network_only_hardware
  request(:get_private_network_only_hardware, Array[Softlayer::Hardware])
end

#get_projected_over_bandwidth_allocation_flagObject



203
204
205
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 203

def get_projected_over_bandwidth_allocation_flag
  request(:get_projected_over_bandwidth_allocation_flag, Integer)
end

#get_projected_public_bandwidth_usageObject



207
208
209
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 207

def get_projected_public_bandwidth_usage
  request(:get_projected_public_bandwidth_usage, Float)
end

#get_service_providerObject



211
212
213
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 211

def get_service_provider
  request(:get_service_provider, Softlayer::Service::Provider)
end

#get_total_bandwidth_allocatedObject



215
216
217
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 215

def get_total_bandwidth_allocated
  request(:get_total_bandwidth_allocated, BigDecimal)
end

#get_virtual_guestsObject



219
220
221
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 219

def get_virtual_guests
  request(:get_virtual_guests, Array[Softlayer::Virtual::Guest])
end

#new_get_bandwidth_image(message) ⇒ Object

network_type snapshot_range draw date_specified



227
228
229
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 227

def new_get_bandwidth_image(message)
  request(:new_get_bandwidth_image, Softlayer::Container::Bandwidth::GraphOutputs, message)
end

#request_vdr_cancellationObject



237
238
239
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 237

def request_vdr_cancellation
  request(:request_vdr_cancellation, Boolean)
end

#request_vdr_content_updates(message) ⇒ Object

hardware_to_add hardware_to_remove clouds_to_add clouds_to_remove optional_allotment_id adc_to_add adc_to_remove



248
249
250
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 248

def request_vdr_content_updates(message)
  request(:request_vdr_content_updates, Boolean, message)
end

#set_vdr_content(message) ⇒ Object

hardware bare_metal_servers virtual_server_instance adc optional_allotment_id



257
258
259
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 257

def set_vdr_content(message)
  request(:set_vdr_content, Boolean, message)
end

#void_pending_server_move(message) ⇒ Object

id type



268
269
270
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 268

def void_pending_server_move(message)
  request(:void_pending_server_move, Boolean, message)
end

#void_pending_vdr_cancellationObject



272
273
274
# File 'lib/softlayer/network/bandwidth/version1/allotment.rb', line 272

def void_pending_vdr_cancellation
  request(:void_pending_vdr_cancellation, Boolean)
end