Class: OCI::Ocvp::DatastoreClient
- Inherits:
-
Object
- Object
- OCI::Ocvp::DatastoreClient
- Defined in:
- lib/oci/ocvp/datastore_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
-
#api_client ⇒ OCI::ApiClient
readonly
Client used to make HTTP requests.
-
#endpoint ⇒ String
readonly
Fully qualified endpoint URL.
-
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
-
#retry_config ⇒ OCI::Retry::RetryConfig
readonly
The default retry configuration to apply to all operations in this service client.
Instance Method Summary collapse
-
#add_block_volume_to_datastore(datastore_id, add_block_volume_to_datastore_details, opts = {}) ⇒ Response
Add the specified Block Volume to the provided Datastore.
-
#change_datastore_compartment(datastore_id, change_datastore_compartment_details, opts = {}) ⇒ Response
Moves an Datastore into a different compartment within the same tenancy.
-
#create_datastore(create_datastore_details, opts = {}) ⇒ Response
Creates a Oracle Cloud VMware Solution Datastore.
-
#delete_datastore(datastore_id, opts = {}) ⇒ Response
Deletes the specified Datastore.
-
#get_datastore(datastore_id, opts = {}) ⇒ Response
Get the specified Datastore's information.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ DatastoreClient
constructor
Creates a new DatastoreClient.
-
#list_datastores(compartment_id, opts = {}) ⇒ Response
List the Datastores in the specified compartment.
-
#logger ⇒ Logger
The logger for this client.
-
#update_datastore(datastore_id, update_datastore_details, opts = {}) ⇒ Response
Updates the specified Datastore.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ DatastoreClient
Creates a new DatastoreClient. 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.
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/datastore_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 "DatastoreClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
16 17 18 |
# File 'lib/oci/ocvp/datastore_client.rb', line 16 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
20 21 22 |
# File 'lib/oci/ocvp/datastore_client.rb', line 20 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
30 31 32 |
# File 'lib/oci/ocvp/datastore_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
26 27 28 |
# File 'lib/oci/ocvp/datastore_client.rb', line 26 def retry_config @retry_config end |
Instance Method Details
#add_block_volume_to_datastore(datastore_id, add_block_volume_to_datastore_details, opts = {}) ⇒ Response
Click here to see an example of how to use add_block_volume_to_datastore API.
Add the specified Block Volume to the provided Datastore.
Use the WorkRequest operations to track the addition of the block volume to the Datastore.
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 162 163 164 165 166 167 168 169 170 171 |
# File 'lib/oci/ocvp/datastore_client.rb', line 132 def add_block_volume_to_datastore(datastore_id, add_block_volume_to_datastore_details, opts = {}) logger.debug 'Calling operation DatastoreClient#add_block_volume_to_datastore.' if logger raise "Missing the required parameter 'datastore_id' when calling add_block_volume_to_datastore." if datastore_id.nil? raise "Missing the required parameter 'add_block_volume_to_datastore_details' when calling add_block_volume_to_datastore." if add_block_volume_to_datastore_details.nil? raise "Parameter value for 'datastore_id' must not be blank" if OCI::Internal::Util.blank_string?(datastore_id) path = '/datastores/{datastoreId}/actions/addBlockVolume'.sub('{datastoreId}', datastore_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-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(add_block_volume_to_datastore_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DatastoreClient#add_block_volume_to_datastore') 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 |
#change_datastore_compartment(datastore_id, change_datastore_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_datastore_compartment API.
Moves an Datastore into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 |
# File 'lib/oci/ocvp/datastore_client.rb', line 208 def change_datastore_compartment(datastore_id, change_datastore_compartment_details, opts = {}) logger.debug 'Calling operation DatastoreClient#change_datastore_compartment.' if logger raise "Missing the required parameter 'datastore_id' when calling change_datastore_compartment." if datastore_id.nil? raise "Missing the required parameter 'change_datastore_compartment_details' when calling change_datastore_compartment." if change_datastore_compartment_details.nil? raise "Parameter value for 'datastore_id' must not be blank" if OCI::Internal::Util.blank_string?(datastore_id) path = '/datastores/{datastoreId}/actions/changeCompartment'.sub('{datastoreId}', datastore_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] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_datastore_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DatastoreClient#change_datastore_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_datastore(create_datastore_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_datastore API.
Creates a Oracle Cloud VMware Solution Datastore.
Use the WorkRequest operations to track the creation of the Datastore.
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 |
# File 'lib/oci/ocvp/datastore_client.rb', line 277 def create_datastore(create_datastore_details, opts = {}) logger.debug 'Calling operation DatastoreClient#create_datastore.' if logger raise "Missing the required parameter 'create_datastore_details' when calling create_datastore." if create_datastore_details.nil? path = '/datastores' 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_datastore_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DatastoreClient#create_datastore') 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_datastore(datastore_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_datastore API.
Deletes the specified Datastore.
Use the WorkRequest operations to track the deletion of the Datastore.
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 |
# File 'lib/oci/ocvp/datastore_client.rb', line 344 def delete_datastore(datastore_id, opts = {}) logger.debug 'Calling operation DatastoreClient#delete_datastore.' if logger raise "Missing the required parameter 'datastore_id' when calling delete_datastore." if datastore_id.nil? raise "Parameter value for 'datastore_id' must not be blank" if OCI::Internal::Util.blank_string?(datastore_id) path = '/datastores/{datastoreId}'.sub('{datastoreId}', datastore_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.(applicable_retry_config(opts), call_name: 'DatastoreClient#delete_datastore') 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_datastore(datastore_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_datastore API.
Get the specified Datastore's information.
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 |
# File 'lib/oci/ocvp/datastore_client.rb', line 401 def get_datastore(datastore_id, opts = {}) logger.debug 'Calling operation DatastoreClient#get_datastore.' if logger raise "Missing the required parameter 'datastore_id' when calling get_datastore." if datastore_id.nil? raise "Parameter value for 'datastore_id' must not be blank" if OCI::Internal::Util.blank_string?(datastore_id) path = '/datastores/{datastoreId}'.sub('{datastoreId}', datastore_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.(applicable_retry_config(opts), call_name: 'DatastoreClient#get_datastore') 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::Datastore' ) end # rubocop:enable Metrics/BlockLength end |
#list_datastores(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_datastores API.
List the Datastores in the specified compartment. The list can be filtered by compartment, datastore id, display name and lifecycle state.
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 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 |
# File 'lib/oci/ocvp/datastore_client.rb', line 486 def list_datastores(compartment_id, opts = {}) logger.debug 'Calling operation DatastoreClient#list_datastores.' if logger raise "Missing the required parameter 'compartment_id' when calling list_datastores." if compartment_id.nil? 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[timeCreated displayName].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.' end if opts[:lifecycle_state] && !OCI::Ocvp::Models::LIFECYCLE_STATES_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Ocvp::Models::LIFECYCLE_STATES_ENUM.' end path = '/datastores' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:clusterId] = opts[:cluster_id] if opts[:cluster_id] query_params[:datastoreId] = opts[:datastore_id] if opts[:datastore_id] 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] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] # 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.(applicable_retry_config(opts), call_name: 'DatastoreClient#list_datastores') 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::DatastoreCollection' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
95 96 97 |
# File 'lib/oci/ocvp/datastore_client.rb', line 95 def logger @api_client.config.logger end |
#update_datastore(datastore_id, update_datastore_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_datastore API.
Updates the specified Datastore.
Important: Updating a Datastore affects only certain attributes in the Datastore object and does not affect the VMware environment currently running.
574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 |
# File 'lib/oci/ocvp/datastore_client.rb', line 574 def update_datastore(datastore_id, update_datastore_details, opts = {}) logger.debug 'Calling operation DatastoreClient#update_datastore.' if logger raise "Missing the required parameter 'datastore_id' when calling update_datastore." if datastore_id.nil? raise "Missing the required parameter 'update_datastore_details' when calling update_datastore." if update_datastore_details.nil? raise "Parameter value for 'datastore_id' must not be blank" if OCI::Internal::Util.blank_string?(datastore_id) path = '/datastores/{datastoreId}'.sub('{datastoreId}', datastore_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_datastore_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DatastoreClient#update_datastore') 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 |