Class: OCI::Ocvp::ByolAllocationClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ocvp/byol_allocation_client.rb

Overview

Use the Oracle Cloud VMware API to create SDDCs and manage ESXi hosts and software. For more information, see Oracle Cloud VMware Solution.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ByolAllocationClient

Creates a new ByolAllocationClient. Notes: If a config is not specified, then the global OCI.config will be used.

This client is not thread-safe

Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.

Parameters:

  • config (Config) (defaults to: nil) —

    A Config object.

  • region (String) (defaults to: nil) —

    A region used to determine the service endpoint. This will usually correspond to a value in Regions::REGION_ENUM, but may be an arbitrary string.

  • endpoint (String) (defaults to: nil) —

    The fully qualified endpoint URL

  • signer (OCI::BaseSigner) (defaults to: nil) —

    A signer implementation which can be used by this client. If this is not provided then a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication, so that the instance principals signer can be provided to the client

  • proxy_settings (OCI::ApiClientProxySettings) (defaults to: nil) —

    If your environment requires you to use a proxy server for outgoing HTTP requests the details for the proxy can be provided in this parameter

  • retry_config (OCI::Retry::RetryConfig) (defaults to: nil) —

    The retry configuration for this service client. This represents the default retry configuration to apply across all operations. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/oci/ocvp/byol_allocation_client.rb', line 56

def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil)
  # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers)
  # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals
  # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then
  # pass it to this constructor.
  #
  # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid
  # so try and load the config from the default file.
  config = OCI::Config.validate_and_build_config_with_signer(config, signer)

  signer = OCI::Signer.config_file_auth_builder(config) if signer.nil?

  @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings)
  @retry_config = retry_config

  if endpoint
    @endpoint = endpoint + '/20230701'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "ByolAllocationClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



16
17
18
 
# File 'lib/oci/ocvp/byol_allocation_client.rb', line 16

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/ocvp/byol_allocation_client.rb', line 20

def endpoint
  @endpoint
end

#region ⇒ String

The region, which will usually correspond to a value in Regions::REGION_ENUM.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/ocvp/byol_allocation_client.rb', line 30

def region
  @region
end

#retry_config ⇒ OCI::Retry::RetryConfig (readonly)

The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries

Returns:



26
27
28
 
# File 'lib/oci/ocvp/byol_allocation_client.rb', line 26

def retry_config
  @retry_config
end

Instance Method Details

#change_byol_allocation_compartment(byol_allocation_id, change_byol_allocation_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_byol_allocation_compartment API.

Moves an BYOL Allocation into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/oci/ocvp/byol_allocation_client.rb', line 124

def change_byol_allocation_compartment(byol_allocation_id, change_byol_allocation_compartment_details, opts = {})
  logger.debug 'Calling operation ByolAllocationClient#change_byol_allocation_compartment.' if logger

  raise "Missing the required parameter 'byol_allocation_id' when calling change_byol_allocation_compartment." if byol_allocation_id.nil?
  raise "Missing the required parameter 'change_byol_allocation_compartment_details' when calling change_byol_allocation_compartment." if change_byol_allocation_compartment_details.nil?
  raise "Parameter value for 'byol_allocation_id' must not be blank" if OCI::Internal::Util.blank_string?(byol_allocation_id)

  path = '/byolAllocations/{byolAllocationId}/actions/changeCompartment'.sub('{byolAllocationId}', byol_allocation_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(change_byol_allocation_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ByolAllocationClient#change_byol_allocation_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_byol_allocation(create_byol_allocation_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_byol_allocation API.

Creates an Allocation on an specific Bring-You-Own-License (BYOL).

Use the WorkRequest operations to track the creation of the BYOL.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/oci/ocvp/byol_allocation_client.rb', line 191

def create_byol_allocation(create_byol_allocation_details, opts = {})
  logger.debug 'Calling operation ByolAllocationClient#create_byol_allocation.' if logger

  raise "Missing the required parameter 'create_byol_allocation_details' when calling create_byol_allocation." if create_byol_allocation_details.nil?

  path = '/byolAllocations'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_byol_allocation_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ByolAllocationClient#create_byol_allocation') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_byol_allocation(byol_allocation_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_byol_allocation API.

Deletes the specified BYOL Allocation.

Parameters:

  • byol_allocation_id (String) —

    The OCID of the BYOL Allocation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/oci/ocvp/byol_allocation_client.rb', line 254

def delete_byol_allocation(byol_allocation_id, opts = {})
  logger.debug 'Calling operation ByolAllocationClient#delete_byol_allocation.' if logger

  raise "Missing the required parameter 'byol_allocation_id' when calling delete_byol_allocation." if byol_allocation_id.nil?
  raise "Parameter value for 'byol_allocation_id' must not be blank" if OCI::Internal::Util.blank_string?(byol_allocation_id)

  path = '/byolAllocations/{byolAllocationId}'.sub('{byolAllocationId}', byol_allocation_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ByolAllocationClient#delete_byol_allocation') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_byol_allocation(byol_allocation_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_byol_allocation API.

Gets the specified BYOL Allocation's information.

Parameters:

  • byol_allocation_id (String) —

    The OCID of the BYOL Allocation.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/oci/ocvp/byol_allocation_client.rb', line 310

def get_byol_allocation(byol_allocation_id, opts = {})
  logger.debug 'Calling operation ByolAllocationClient#get_byol_allocation.' if logger

  raise "Missing the required parameter 'byol_allocation_id' when calling get_byol_allocation." if byol_allocation_id.nil?
  raise "Parameter value for 'byol_allocation_id' must not be blank" if OCI::Internal::Util.blank_string?(byol_allocation_id)

  path = '/byolAllocations/{byolAllocationId}'.sub('{byolAllocationId}', byol_allocation_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ByolAllocationClient#get_byol_allocation') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Ocvp::Models::ByolAllocation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_byol_allocations(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_byol_allocations API.

Lists the BYOL Allocations in the specified compartment. The list can be filtered by display name or availability domain.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :byol_allocation_id (String) —

    The OCID of the BYOL Allocation.

  • :lifecycle_state (String) —

    A filter to return only resources whose lifecycle state matches the given value.

  • :software_type (String) —

    A filter to return only resources whose softwareType matches the given value.

  • :available_units_greater_than_or_equal_to (Float) —

    A filter to return only resources whose availableUnits greater than or equal to the given value.

  • :byol_id (String) —

    The OCID of the BYOL.

  • :display_name (String) —

    A filter to return only resources that match the given display name exactly.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive. (default to ASC)

  • :sort_by (String) —

    The field to sort by. You can provide one sort order (sortOrder). Default order for timeTermStart is descending. Default order for timeCreated is descending. Default order for displayName is ascending. The displayName sort order is case sensitive.

    Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. (default to timeTermStart) Allowed values are: displayName, timeCreated, timeTermStart

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:



396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/oci/ocvp/byol_allocation_client.rb', line 396

def list_byol_allocations(compartment_id, opts = {})
  logger.debug 'Calling operation ByolAllocationClient#list_byol_allocations.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_byol_allocations." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::Ocvp::Models::ByolAllocation::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Ocvp::Models::ByolAllocation::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:software_type] && !OCI::Ocvp::Models::ByolAllocation::SOFTWARE_TYPE_ENUM.include?(opts[:software_type])
    raise 'Invalid value for "software_type", must be one of the values in OCI::Ocvp::Models::ByolAllocation::SOFTWARE_TYPE_ENUM.'
  end

  if opts[:sort_order] && !OCI::Ocvp::Models::SORT_ORDERS_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Ocvp::Models::SORT_ORDERS_ENUM.'
  end

  if opts[:sort_by] && !%w[displayName timeCreated timeTermStart].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName, timeCreated, timeTermStart.'
  end

  path = '/byolAllocations'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:byolAllocationId] = opts[:byol_allocation_id] if opts[:byol_allocation_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:softwareType] = opts[:software_type] if opts[:software_type]
  query_params[:availableUnitsGreaterThanOrEqualTo] = opts[:available_units_greater_than_or_equal_to] if opts[:available_units_greater_than_or_equal_to]
  query_params[:byolId] = opts[:byol_id] if opts[:byol_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ByolAllocationClient#list_byol_allocations') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Ocvp::Models::ByolAllocationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



95
96
97
 
# File 'lib/oci/ocvp/byol_allocation_client.rb', line 95

def logger
  @api_client.config.logger
end

#update_byol_allocation(byol_allocation_id, update_byol_allocation_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_byol_allocation API.

Updates the specified BYOL Allocation.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

  • :opc_request_id (String) —

    Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
 
# File 'lib/oci/ocvp/byol_allocation_client.rb', line 486

def update_byol_allocation(byol_allocation_id, update_byol_allocation_details, opts = {})
  logger.debug 'Calling operation ByolAllocationClient#update_byol_allocation.' if logger

  raise "Missing the required parameter 'byol_allocation_id' when calling update_byol_allocation." if byol_allocation_id.nil?
  raise "Missing the required parameter 'update_byol_allocation_details' when calling update_byol_allocation." if update_byol_allocation_details.nil?
  raise "Parameter value for 'byol_allocation_id' must not be blank" if OCI::Internal::Util.blank_string?(byol_allocation_id)

  path = '/byolAllocations/{byolAllocationId}'.sub('{byolAllocationId}', byol_allocation_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_byol_allocation_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ByolAllocationClient#update_byol_allocation') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end