Class: OCI::Ocvp::DatastoreClusterClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ocvp/datastore_cluster_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) ⇒ DatastoreClusterClient

Creates a new DatastoreClusterClient. 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/datastore_cluster_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 "DatastoreClusterClient 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/datastore_cluster_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/datastore_cluster_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/datastore_cluster_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/datastore_cluster_client.rb', line 26

def retry_config
  @retry_config
end

Instance Method Details

#add_datastore_to_datastore_cluster(datastore_cluster_id, add_datastore_to_datastore_cluster_details, opts = {}) ⇒ Response

Note:

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

Add the specified Datastore to the provided Datastore Cluster.

Parameters:

  • datastore_cluster_id (String) —

    The OCID of the Datastore Cluster.

  • add_datastore_to_datastore_cluster_details (OCI::Ocvp::Models::AddDatastoreToDatastoreClusterDetails) —

    The information about datastore addition to the Datastore Cluster.

  • 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_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



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
162
163
164
165
166
167
168
 
# File 'lib/oci/ocvp/datastore_cluster_client.rb', line 129

def add_datastore_to_datastore_cluster(datastore_cluster_id, add_datastore_to_datastore_cluster_details, opts = {})
  logger.debug 'Calling operation DatastoreClusterClient#add_datastore_to_datastore_cluster.' if logger

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

  path = '/datastoreClusters/{datastoreClusterId}/actions/addDatastore'.sub('{datastoreClusterId}', datastore_cluster_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_datastore_to_datastore_cluster_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatastoreClusterClient#add_datastore_to_datastore_cluster') 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

#attach_datastore_cluster_to_cluster(datastore_cluster_id, attach_datastore_cluster_to_cluster_details, opts = {}) ⇒ Response

Note:

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

Attach the specified Datastore Cluster to the provided Vmware Cluster.

Use the WorkRequest operations to track the attachment of the Datastore.

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_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



206
207
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
 
# File 'lib/oci/ocvp/datastore_cluster_client.rb', line 206

def attach_datastore_cluster_to_cluster(datastore_cluster_id, attach_datastore_cluster_to_cluster_details, opts = {})
  logger.debug 'Calling operation DatastoreClusterClient#attach_datastore_cluster_to_cluster.' if logger

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

  path = '/datastoreClusters/{datastoreClusterId}/actions/attachToCluster'.sub('{datastoreClusterId}', datastore_cluster_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(attach_datastore_cluster_to_cluster_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatastoreClusterClient#attach_datastore_cluster_to_cluster') 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

#attach_datastore_cluster_to_esxi_host(datastore_cluster_id, attach_datastore_cluster_to_esxi_host_details, opts = {}) ⇒ Response

Note:

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

Attach the specified Datastore Cluster to the provided ESXi Hosts.

Use the WorkRequest operations to track the attachment of the Datastore.

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_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



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
314
315
316
317
318
319
320
321
322
 
# File 'lib/oci/ocvp/datastore_cluster_client.rb', line 283

def attach_datastore_cluster_to_esxi_host(datastore_cluster_id, attach_datastore_cluster_to_esxi_host_details, opts = {})
  logger.debug 'Calling operation DatastoreClusterClient#attach_datastore_cluster_to_esxi_host.' if logger

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

  path = '/datastoreClusters/{datastoreClusterId}/actions/attachToEsxiHost'.sub('{datastoreClusterId}', datastore_cluster_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(attach_datastore_cluster_to_esxi_host_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatastoreClusterClient#attach_datastore_cluster_to_esxi_host') 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_cluster_compartment(datastore_cluster_id, change_datastore_cluster_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves an Datastore Cluster 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.

  • :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).

Returns:

  • (Response) —

    A Response object with data of type nil



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/oci/ocvp/datastore_cluster_client.rb', line 359

def change_datastore_cluster_compartment(datastore_cluster_id, change_datastore_cluster_compartment_details, opts = {})
  logger.debug 'Calling operation DatastoreClusterClient#change_datastore_cluster_compartment.' if logger

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

  path = '/datastoreClusters/{datastoreClusterId}/actions/changeCompartment'.sub('{datastoreClusterId}', datastore_cluster_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_cluster_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatastoreClusterClient#change_datastore_cluster_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_cluster(create_datastore_cluster_details, opts = {}) ⇒ Response

Note:

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

Creates a Oracle Cloud VMware Solution Datastore Cluster.

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



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
459
460
461
 
# File 'lib/oci/ocvp/datastore_cluster_client.rb', line 425

def create_datastore_cluster(create_datastore_cluster_details, opts = {})
  logger.debug 'Calling operation DatastoreClusterClient#create_datastore_cluster.' if logger

  raise "Missing the required parameter 'create_datastore_cluster_details' when calling create_datastore_cluster." if create_datastore_cluster_details.nil?

  path = '/datastoreClusters'
  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_cluster_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatastoreClusterClient#create_datastore_cluster') 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_cluster(datastore_cluster_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified Datastore Cluster.

Parameters:

  • datastore_cluster_id (String) —

    The OCID of the Datastore Cluster.

  • 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



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
 
# File 'lib/oci/ocvp/datastore_cluster_client.rb', line 489

def delete_datastore_cluster(datastore_cluster_id, opts = {})
  logger.debug 'Calling operation DatastoreClusterClient#delete_datastore_cluster.' if logger

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

  path = '/datastoreClusters/{datastoreClusterId}'.sub('{datastoreClusterId}', datastore_cluster_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: 'DatastoreClusterClient#delete_datastore_cluster') 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

#detach_datastore_cluster_from_cluster(datastore_cluster_id, opts = {}) ⇒ Response

Note:

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

Detach the specified Datastore Cluster from the provided Vmware Cluster.

Use the WorkRequest operations to track the detachment of the Datastore.

Parameters:

  • datastore_cluster_id (String) —

    The OCID of the Datastore Cluster.

  • 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_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



562
563
564
565
566
567
568
569
570
571
572
573
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
 
# File 'lib/oci/ocvp/datastore_cluster_client.rb', line 562

def detach_datastore_cluster_from_cluster(datastore_cluster_id, opts = {})
  logger.debug 'Calling operation DatastoreClusterClient#detach_datastore_cluster_from_cluster.' if logger

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

  path = '/datastoreClusters/{datastoreClusterId}/actions/detachFromCluster'.sub('{datastoreClusterId}', datastore_cluster_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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatastoreClusterClient#detach_datastore_cluster_from_cluster') 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

#detach_datastore_cluster_from_esxi_host(datastore_cluster_id, detach_datastore_cluster_from_esxi_host_details, opts = {}) ⇒ Response

Note:

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

Detach the specified Datastore Cluster from the provided ESXi Hosts.

Use the WorkRequest operations to track the detachment of the Datastore.

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_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



638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
 
# File 'lib/oci/ocvp/datastore_cluster_client.rb', line 638

def detach_datastore_cluster_from_esxi_host(datastore_cluster_id, detach_datastore_cluster_from_esxi_host_details, opts = {})
  logger.debug 'Calling operation DatastoreClusterClient#detach_datastore_cluster_from_esxi_host.' if logger

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

  path = '/datastoreClusters/{datastoreClusterId}/actions/detachFromEsxiHost'.sub('{datastoreClusterId}', datastore_cluster_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(detach_datastore_cluster_from_esxi_host_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatastoreClusterClient#detach_datastore_cluster_from_esxi_host') 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

#get_datastore_cluster(datastore_cluster_id, opts = {}) ⇒ Response

Note:

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

Get the specified Datastore Cluster information.

Parameters:

  • datastore_cluster_id (String) —

    The OCID of the Datastore Cluster.

  • 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:



698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
 
# File 'lib/oci/ocvp/datastore_cluster_client.rb', line 698

def get_datastore_cluster(datastore_cluster_id, opts = {})
  logger.debug 'Calling operation DatastoreClusterClient#get_datastore_cluster.' if logger

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

  path = '/datastoreClusters/{datastoreClusterId}'.sub('{datastoreClusterId}', datastore_cluster_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: 'DatastoreClusterClient#get_datastore_cluster') 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::DatastoreCluster'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

List the Datastore Clusters in the specified compartment. The list can be filtered by compartment, Datastore Cluster, Display name and Lifecycle state

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

  • :display_name (String) —

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

  • :datastore_cluster_id (String) —

    The OCID of the Datastore Cluster.

  • :cluster_id (String) —

    The OCID of the SDDC Cluster.

  • :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 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 timeCreated) Allowed values are: timeCreated, displayName

  • :opc_request_id (String) —

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

  • :lifecycle_state (String) —

    The lifecycle state of the resource.

Returns:



783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
 
# File 'lib/oci/ocvp/datastore_cluster_client.rb', line 783

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

  raise "Missing the required parameter 'compartment_id' when calling list_datastore_clusters." 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 = '/datastoreClusters'
  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[:datastoreClusterId] = opts[:datastore_cluster_id] if opts[:datastore_cluster_id]
  query_params[:clusterId] = opts[:cluster_id] if opts[:cluster_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.make_retrying_call(applicable_retry_config(opts), call_name: 'DatastoreClusterClient#list_datastore_clusters') 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::DatastoreClusterCollection'
    )
  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/datastore_cluster_client.rb', line 95

def logger
  @api_client.config.logger
end

#remove_datastore_from_datastore_cluster(datastore_cluster_id, remove_datastore_from_datastore_cluster_details, opts = {}) ⇒ Response

Note:

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

Remove the specified Datastore from the provided Datastore Cluster.

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_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



874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
 
# File 'lib/oci/ocvp/datastore_cluster_client.rb', line 874

def remove_datastore_from_datastore_cluster(datastore_cluster_id, remove_datastore_from_datastore_cluster_details, opts = {})
  logger.debug 'Calling operation DatastoreClusterClient#remove_datastore_from_datastore_cluster.' if logger

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

  path = '/datastoreClusters/{datastoreClusterId}/actions/removeDatastore'.sub('{datastoreClusterId}', datastore_cluster_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(remove_datastore_from_datastore_cluster_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatastoreClusterClient#remove_datastore_from_datastore_cluster') 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

#update_datastore_cluster(datastore_cluster_id, update_datastore_cluster_details, opts = {}) ⇒ Response

Note:

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

Updates the specified Datastore Cluster.

Important: Updating a Datastore Cluster affects only certain attributes in the Datastore Cluster object and does not affect the VMware environment currently running.

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



945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
 
# File 'lib/oci/ocvp/datastore_cluster_client.rb', line 945

def update_datastore_cluster(datastore_cluster_id, update_datastore_cluster_details, opts = {})
  logger.debug 'Calling operation DatastoreClusterClient#update_datastore_cluster.' if logger

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

  path = '/datastoreClusters/{datastoreClusterId}'.sub('{datastoreClusterId}', datastore_cluster_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_cluster_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DatastoreClusterClient#update_datastore_cluster') 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