Class: OCI::Analytics::AnalyticsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/analytics/analytics_client.rb

Overview

Analytics API.

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) ⇒ AnalyticsClient

Creates a new AnalyticsClient. 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



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

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 + '/20190331'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "AnalyticsClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



15
16
17
 
# File 'lib/oci/analytics/analytics_client.rb', line 15

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/analytics/analytics_client.rb', line 19

def endpoint
  @endpoint
end

#region ⇒ String

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

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/analytics/analytics_client.rb', line 29

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:



25
26
27
 
# File 'lib/oci/analytics/analytics_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#change_analytics_instance_compartment(analytics_instance_id, change_compartment_details, opts = {}) ⇒ Response

Note:

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

Change the compartment of an Analytics instance. The operation is long-running and creates a new work request.

Parameters:

  • analytics_instance_id (String) —

    The OCID of the Analytics instance.

  • change_compartment_details (OCI::Analytics::Models::ChangeCompartmentDetails) —

    Input payload to move the resource to a different 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

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



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
162
163
164
165
166
167
 
# File 'lib/oci/analytics/analytics_client.rb', line 128

def change_analytics_instance_compartment(analytics_instance_id, change_compartment_details, opts = {})
  logger.debug 'Calling operation AnalyticsClient#change_analytics_instance_compartment.' if logger

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

  path = '/analyticsInstances/{analyticsInstanceId}/actions/changeCompartment'.sub('{analyticsInstanceId}', analytics_instance_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_compartment_details)

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

#change_analytics_instance_network_endpoint(analytics_instance_id, change_analytics_instance_network_endpoint_details, opts = {}) ⇒ Response

Note:

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

Change the network endpoint for an Analytics instance. The operation is long-running and creates a new work request.

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



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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/oci/analytics/analytics_client.rb', line 202

def change_analytics_instance_network_endpoint(analytics_instance_id, change_analytics_instance_network_endpoint_details, opts = {})
  logger.debug 'Calling operation AnalyticsClient#change_analytics_instance_network_endpoint.' if logger

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

  path = '/analyticsInstances/{analyticsInstanceId}/actions/changeNetworkEndpoint'.sub('{analyticsInstanceId}', analytics_instance_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_analytics_instance_network_endpoint_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'AnalyticsClient#change_analytics_instance_network_endpoint') 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_analytics_instance(create_analytics_instance_details, opts = {}) ⇒ Response

Note:

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

Create a new Analytics instance in the specified compartment. The operation is long-running and creates a new work request.

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.

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



270
271
272
273
274
275
276
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
 
# File 'lib/oci/analytics/analytics_client.rb', line 270

def create_analytics_instance(create_analytics_instance_details, opts = {})
  logger.debug 'Calling operation AnalyticsClient#create_analytics_instance.' if logger

  raise "Missing the required parameter 'create_analytics_instance_details' when calling create_analytics_instance." if create_analytics_instance_details.nil?

  path = '/analyticsInstances'
  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]
  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(create_analytics_instance_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'AnalyticsClient#create_analytics_instance') 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,
      return_type: 'OCI::Analytics::Models::AnalyticsInstance'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_private_access_channel(analytics_instance_id, create_private_access_channel_details, opts = {}) ⇒ Response

Note:

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

Create an private access channel for the Analytics instance. The operation is long-running and creates a new work request.

Parameters:

  • analytics_instance_id (String) —

    The OCID of the Analytics instance.

  • create_private_access_channel_details (OCI::Analytics::Models::CreatePrivateAccessChannelDetails) —

    Input payload for creating a private access channel for an Analytics instance.

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

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



338
339
340
341
342
343
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
 
# File 'lib/oci/analytics/analytics_client.rb', line 338

def create_private_access_channel(analytics_instance_id, create_private_access_channel_details, opts = {})
  logger.debug 'Calling operation AnalyticsClient#create_private_access_channel.' if logger

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

  path = '/analyticsInstances/{analyticsInstanceId}/privateAccessChannels'.sub('{analyticsInstanceId}', analytics_instance_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]
  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(create_private_access_channel_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'AnalyticsClient#create_private_access_channel') 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_resource_group(analytics_instance_id, create_resource_group_details, opts = {}) ⇒ Response

Note:

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

Create a new resource group for the instance

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.

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



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
 
# File 'lib/oci/analytics/analytics_client.rb', line 406

def create_resource_group(analytics_instance_id, create_resource_group_details, opts = {})
  logger.debug 'Calling operation AnalyticsClient#create_resource_group.' if logger

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

  path = '/analyticsInstances/{analyticsInstanceId}/resourceGroups'.sub('{analyticsInstanceId}', analytics_instance_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]
  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(create_resource_group_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'AnalyticsClient#create_resource_group') 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,
      return_type: 'OCI::Analytics::Models::InstanceResourceGroup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_vanity_url(analytics_instance_id, create_vanity_url_details, opts = {}) ⇒ Response

Note:

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

Allows you to specify a custom host name to be used to access the Analytics instance. You must set up a DNS entry and certificate for this host in advance.

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.

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



475
476
477
478
479
480
481
482
483
484
485
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
 
# File 'lib/oci/analytics/analytics_client.rb', line 475

def create_vanity_url(analytics_instance_id, create_vanity_url_details, opts = {})
  logger.debug 'Calling operation AnalyticsClient#create_vanity_url.' if logger

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

  path = '/analyticsInstances/{analyticsInstanceId}/vanityUrls'.sub('{analyticsInstanceId}', analytics_instance_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]
  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(create_vanity_url_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'AnalyticsClient#create_vanity_url') 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_analytics_instance(analytics_instance_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified Analytics instance. The operation is long-running and creates a new work request.

Parameters:

  • analytics_instance_id (String) —

    The OCID of the Analytics instance.

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

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



546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
 
# File 'lib/oci/analytics/analytics_client.rb', line 546

def delete_analytics_instance(analytics_instance_id, opts = {})
  logger.debug 'Calling operation AnalyticsClient#delete_analytics_instance.' if logger

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

  path = '/analyticsInstances/{analyticsInstanceId}'.sub('{analyticsInstanceId}', analytics_instance_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 = nil

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

#delete_private_access_channel(private_access_channel_key, analytics_instance_id, opts = {}) ⇒ Response

Note:

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

Delete a private access channel with a given unique identifier key, for an Analytics instance.

Parameters:

  • private_access_channel_key (String) —

    The unique identifier key of the private access channel.

  • analytics_instance_id (String) —

    The OCID of the Analytics instance.

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

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



618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
 
# File 'lib/oci/analytics/analytics_client.rb', line 618

def delete_private_access_channel(private_access_channel_key, analytics_instance_id, opts = {})
  logger.debug 'Calling operation AnalyticsClient#delete_private_access_channel.' if logger

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

  path = '/analyticsInstances/{analyticsInstanceId}/privateAccessChannels/{privateAccessChannelKey}'.sub('{privateAccessChannelKey}', private_access_channel_key.to_s).sub('{analyticsInstanceId}', analytics_instance_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 = nil

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

#delete_resource_group(analytics_instance_id, analytics_instance_resource_group_id, opts = {}) ⇒ Response

Note:

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

Allows deleting a previously created resource group.

Parameters:

  • analytics_instance_id (String) —

    The OCID of the Analytics instance.

  • analytics_instance_resource_group_id (String) —

    Specify unique id of a resource group within an Analytics instance.

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

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



692
693
694
695
696
697
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
 
# File 'lib/oci/analytics/analytics_client.rb', line 692

def delete_resource_group(analytics_instance_id, analytics_instance_resource_group_id, opts = {})
  logger.debug 'Calling operation AnalyticsClient#delete_resource_group.' if logger

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

  path = '/analyticsInstances/{analyticsInstanceId}/resourceGroups/{analyticsInstanceResourceGroupId}'.sub('{analyticsInstanceId}', analytics_instance_id.to_s).sub('{analyticsInstanceResourceGroupId}', analytics_instance_resource_group_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 = nil

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

#delete_vanity_url(analytics_instance_id, vanity_url_key, opts = {}) ⇒ Response

Note:

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

Deletes a previously created vanity URL.

Parameters:

  • analytics_instance_id (String) —

    The OCID of the Analytics instance.

  • vanity_url_key (String) —

    Specify unique identifier key of a vanity URL to update or delete.

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

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



766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
 
# File 'lib/oci/analytics/analytics_client.rb', line 766

def delete_vanity_url(analytics_instance_id, vanity_url_key, opts = {})
  logger.debug 'Calling operation AnalyticsClient#delete_vanity_url.' if logger

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

  path = '/analyticsInstances/{analyticsInstanceId}/vanityUrls/{vanityUrlKey}'.sub('{analyticsInstanceId}', analytics_instance_id.to_s).sub('{vanityUrlKey}', vanity_url_key.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 = nil

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

#delete_work_request(work_request_id, opts = {}) ⇒ Response

Note:

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

Cancel a work request that hasn't started yet.

Parameters:

  • work_request_id (String) —

    The OCID of the work request.

  • 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



832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
 
# File 'lib/oci/analytics/analytics_client.rb', line 832

def delete_work_request(work_request_id, opts = {})
  logger.debug 'Calling operation AnalyticsClient#delete_work_request.' if logger

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

  path = '/workRequests/{workRequestId}'.sub('{workRequestId}', work_request_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: 'AnalyticsClient#delete_work_request') 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_analytics_instance(analytics_instance_id, opts = {}) ⇒ Response

Note:

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

Information about a specific Analytics instance.

Parameters:

  • analytics_instance_id (String) —

    The OCID of the Analytics instance.

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



890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
 
# File 'lib/oci/analytics/analytics_client.rb', line 890

def get_analytics_instance(analytics_instance_id, opts = {})
  logger.debug 'Calling operation AnalyticsClient#get_analytics_instance.' if logger

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

  path = '/analyticsInstances/{analyticsInstanceId}'.sub('{analyticsInstanceId}', analytics_instance_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: 'AnalyticsClient#get_analytics_instance') 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::Analytics::Models::AnalyticsInstance'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_private_access_channel(private_access_channel_key, analytics_instance_id, opts = {}) ⇒ Response

Note:

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

Retrieve private access channel for the specified Analytics Instance.

Parameters:

  • private_access_channel_key (String) —

    The unique identifier key of the private access channel.

  • analytics_instance_id (String) —

    The OCID of the Analytics instance.

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



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
983
984
985
986
987
988
 
# File 'lib/oci/analytics/analytics_client.rb', line 950

def get_private_access_channel(private_access_channel_key, analytics_instance_id, opts = {})
  logger.debug 'Calling operation AnalyticsClient#get_private_access_channel.' if logger

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

  path = '/analyticsInstances/{analyticsInstanceId}/privateAccessChannels/{privateAccessChannelKey}'.sub('{privateAccessChannelKey}', private_access_channel_key.to_s).sub('{analyticsInstanceId}', analytics_instance_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: 'AnalyticsClient#get_private_access_channel') 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::Analytics::Models::PrivateAccessChannel'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_resource_group(analytics_instance_id, analytics_instance_resource_group_id, opts = {}) ⇒ Response

Note:

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

Get details of a resource group for an instance

Parameters:

  • analytics_instance_id (String) —

    The OCID of the Analytics instance.

  • analytics_instance_resource_group_id (String) —

    Specify unique id of a resource group within an Analytics instance.

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



1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
 
# File 'lib/oci/analytics/analytics_client.rb', line 1012

def get_resource_group(analytics_instance_id, analytics_instance_resource_group_id, opts = {})
  logger.debug 'Calling operation AnalyticsClient#get_resource_group.' if logger

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

  path = '/analyticsInstances/{analyticsInstanceId}/resourceGroups/{analyticsInstanceResourceGroupId}'.sub('{analyticsInstanceId}', analytics_instance_id.to_s).sub('{analyticsInstanceResourceGroupId}', analytics_instance_resource_group_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: 'AnalyticsClient#get_resource_group') 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::Analytics::Models::InstanceResourceGroup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_work_request(work_request_id, opts = {}) ⇒ Response

Note:

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

Get the details of a work request.

Parameters:

  • work_request_id (String) —

    The OCID of the work request.

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



1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
 
# File 'lib/oci/analytics/analytics_client.rb', line 1072

def get_work_request(work_request_id, opts = {})
  logger.debug 'Calling operation AnalyticsClient#get_work_request.' if logger

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

  path = '/workRequests/{workRequestId}'.sub('{workRequestId}', work_request_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: 'AnalyticsClient#get_work_request') 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::Analytics::Models::WorkRequest'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

List Analytics instances.

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

  • :opc_request_id (String) —

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

  • :name (String) —

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

  • :capacity_type (String) —

    A filter to only return resources matching the capacity type enum. Values are case-insensitive.

  • :feature_set (String) —

    A filter to only return resources matching the feature set. Values are case-insensitive.

  • :lifecycle_state (String) —

    A filter to only return resources matching the lifecycle state. The state value is case-insensitive.

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

    Example: 50

  • :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_by (String) —

    The field to sort by (one column only). Default sort order is ascending exception of timeCreated column (descending).

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC).

Returns:



1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
 
# File 'lib/oci/analytics/analytics_client.rb', line 1156

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

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

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

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

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

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

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

  path = '/analyticsInstances'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:capacityType] = opts[:capacity_type] if opts[:capacity_type]
  query_params[:featureSet] = opts[:feature_set] if opts[:feature_set]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # 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: 'AnalyticsClient#list_analytics_instances') 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: 'Array<OCI::Analytics::Models::AnalyticsInstanceSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_resource_groups(analytics_instance_id, opts = {}) ⇒ Response

Note:

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

List resource groups associated with an instance.

Parameters:

  • analytics_instance_id (String) —

    The OCID of the Analytics instance.

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

  • :name (String) —

    A filter to return only resources that match the given 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.

    Example: 50

  • :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_by (String) —

    The field to sort by (one column only). Default sort order is default group first, then sort by resource name, ascending.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC).

Returns:



1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
 
# File 'lib/oci/analytics/analytics_client.rb', line 1259

def list_resource_groups(analytics_instance_id, opts = {})
  logger.debug 'Calling operation AnalyticsClient#list_resource_groups.' if logger

  raise "Missing the required parameter 'analytics_instance_id' when calling list_resource_groups." if analytics_instance_id.nil?

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

  if opts[:sort_order] && !OCI::Analytics::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Analytics::Models::SORT_ORDER_ENUM.'
  end
  raise "Parameter value for 'analytics_instance_id' must not be blank" if OCI::Internal::Util.blank_string?(analytics_instance_id)

  path = '/analyticsInstances/{analyticsInstanceId}/resourceGroups'.sub('{analyticsInstanceId}', analytics_instance_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # 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: 'AnalyticsClient#list_resource_groups') 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: 'Array<OCI::Analytics::Models::InstanceResourceGroupSummary>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_request_errors(work_request_id, opts = {}) ⇒ Response

Note:

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

Get the errors of a work request.

Parameters:

  • work_request_id (String) —

    The OCID of the work request.

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

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

    Example: 50

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

Returns:



1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
 
# File 'lib/oci/analytics/analytics_client.rb', line 1340

def list_work_request_errors(work_request_id, opts = {})
  logger.debug 'Calling operation AnalyticsClient#list_work_request_errors.' if logger

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

  path = '/workRequests/{workRequestId}/errors'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # 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: 'AnalyticsClient#list_work_request_errors') 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: 'Array<OCI::Analytics::Models::WorkRequestError>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_request_logs(work_request_id, opts = {}) ⇒ Response

Note:

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

Get the logs of a work request.

Parameters:

  • work_request_id (String) —

    The OCID of the work request.

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

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

    Example: 50

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

Returns:



1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
 
# File 'lib/oci/analytics/analytics_client.rb', line 1410

def list_work_request_logs(work_request_id, opts = {})
  logger.debug 'Calling operation AnalyticsClient#list_work_request_logs.' if logger

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

  path = '/workRequests/{workRequestId}/logs'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # 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: 'AnalyticsClient#list_work_request_logs') 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: 'Array<OCI::Analytics::Models::WorkRequestLog>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

List all work requests in a compartment.

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

  • :resource_id (String) —

    The OCID of the resource associated with a work request.

  • :resource_type (String) —

    Type of the resource associated with a work request.

  • :status (Array<String>) —

    One or more work request status values to filter on.

    Allowed values are: ACCEPTED, IN_PROGRESS, FAILED, SUCCEEDED, CANCELING, CANCELED

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

    Example: 50

  • :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_by (String) —

    The field used for sorting work request results.

  • :sort_order (String) —

    The sort order to use, either ascending (ASC) or descending (DESC).

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



1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
 
# File 'lib/oci/analytics/analytics_client.rb', line 1491

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

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

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


  status_allowable_values = %w[ACCEPTED IN_PROGRESS FAILED SUCCEEDED CANCELING CANCELED]
  if opts[:status] && !opts[:status].empty?
    opts[:status].each do |val_to_check|
      unless status_allowable_values.include?(val_to_check)
        raise 'Invalid value for "status", must be one of ACCEPTED, IN_PROGRESS, FAILED, SUCCEEDED, CANCELING, CANCELED.'
      end
    end
  end

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

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

  path = '/workRequests'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:resourceId] = opts[:resource_id] if opts[:resource_id]
  query_params[:resourceType] = opts[:resource_type] if opts[:resource_type]
  query_params[:status] = OCI::ApiClient.build_collection_params(opts[:status], :multi) if opts[:status] && !opts[:status].empty?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # 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: 'AnalyticsClient#list_work_requests') 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: 'Array<OCI::Analytics::Models::WorkRequestSummary>'
    )
  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.



94
95
96
 
# File 'lib/oci/analytics/analytics_client.rb', line 94

def logger
  @api_client.config.logger
end

#scale_analytics_instance(analytics_instance_id, scale_analytics_instance_details, opts = {}) ⇒ Response

Note:

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

Scale an Analytics instance up or down. The operation is long-running and creates a new work request.

Parameters:

  • analytics_instance_id (String) —

    The OCID of the Analytics instance.

  • scale_analytics_instance_details (OCI::Analytics::Models::ScaleAnalyticsInstanceDetails) —

    Input payload for scaling an Analytics instance up or down.

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

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



1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
 
# File 'lib/oci/analytics/analytics_client.rb', line 1591

def scale_analytics_instance(analytics_instance_id, scale_analytics_instance_details, opts = {})
  logger.debug 'Calling operation AnalyticsClient#scale_analytics_instance.' if logger

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

  path = '/analyticsInstances/{analyticsInstanceId}/actions/scale'.sub('{analyticsInstanceId}', analytics_instance_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(scale_analytics_instance_details)

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

#set_feature_bundle(analytics_instance_id, set_feature_bundle_details, opts = {}) ⇒ Response

Note:

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

Set the external service properties of an Analytics instance.

Parameters:

  • analytics_instance_id (String) —

    The OCID of the Analytics instance.

  • set_feature_bundle_details (OCI::Analytics::Models::SetFeatureBundleDetails) —

    Input payload for the feature set of an Analytics instance.

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

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



1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
 
# File 'lib/oci/analytics/analytics_client.rb', line 1664

def set_feature_bundle(analytics_instance_id, set_feature_bundle_details, opts = {})
  logger.debug 'Calling operation AnalyticsClient#set_feature_bundle.' if logger

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

  path = '/analyticsInstances/{analyticsInstanceId}/actions/setFeatureBundle'.sub('{analyticsInstanceId}', analytics_instance_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(set_feature_bundle_details)

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

#set_kms_key(analytics_instance_id, set_kms_key_details, opts = {}) ⇒ Response

Note:

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

Encrypts the customer data of this Analytics instance using either a customer OCI vault key or default Oracle-managed key.

Parameters:

  • analytics_instance_id (String) —

    The OCID of the Analytics instance.

  • set_kms_key_details (OCI::Analytics::Models::SetKmsKeyDetails) —

    Input payload to reset the OCI vault encryption key.

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

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



1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
 
# File 'lib/oci/analytics/analytics_client.rb', line 1737

def set_kms_key(analytics_instance_id, set_kms_key_details, opts = {})
  logger.debug 'Calling operation AnalyticsClient#set_kms_key.' if logger

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

  path = '/analyticsInstances/{analyticsInstanceId}/actions/setKmsKey'.sub('{analyticsInstanceId}', analytics_instance_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(set_kms_key_details)

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

#start_analytics_instance(analytics_instance_id, opts = {}) ⇒ Response

Note:

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

Starts the specified Analytics instance. The operation is long-running and creates a new work request.

Parameters:

  • analytics_instance_id (String) —

    The OCID of the Analytics instance.

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

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



1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
 
# File 'lib/oci/analytics/analytics_client.rb', line 1809

def start_analytics_instance(analytics_instance_id, opts = {})
  logger.debug 'Calling operation AnalyticsClient#start_analytics_instance.' if logger

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

  path = '/analyticsInstances/{analyticsInstanceId}/actions/start'.sub('{analyticsInstanceId}', analytics_instance_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 = nil

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

#stop_analytics_instance(analytics_instance_id, opts = {}) ⇒ Response

Note:

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

Stop the specified Analytics instance. The operation is long-running and creates a new work request.

Parameters:

  • analytics_instance_id (String) —

    The OCID of the Analytics instance.

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

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



1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
 
# File 'lib/oci/analytics/analytics_client.rb', line 1880

def stop_analytics_instance(analytics_instance_id, opts = {})
  logger.debug 'Calling operation AnalyticsClient#stop_analytics_instance.' if logger

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

  path = '/analyticsInstances/{analyticsInstanceId}/actions/stop'.sub('{analyticsInstanceId}', analytics_instance_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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'AnalyticsClient#stop_analytics_instance') 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_analytics_instance(analytics_instance_id, update_analytics_instance_details, opts = {}) ⇒ Response

Note:

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

Updates certain fields of an Analytics instance. Fields that are not provided in the request will not be updated.

Parameters:

  • analytics_instance_id (String) —

    The OCID of the Analytics instance.

  • update_analytics_instance_details (OCI::Analytics::Models::UpdateAnalyticsInstanceDetails) —

    Update specified fields for an Analytics instance. Fields that aren't provided won't be updated.

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



1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
 
# File 'lib/oci/analytics/analytics_client.rb', line 1948

def update_analytics_instance(analytics_instance_id, update_analytics_instance_details, opts = {})
  logger.debug 'Calling operation AnalyticsClient#update_analytics_instance.' if logger

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

  path = '/analyticsInstances/{analyticsInstanceId}'.sub('{analyticsInstanceId}', analytics_instance_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_analytics_instance_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'AnalyticsClient#update_analytics_instance') 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,
      return_type: 'OCI::Analytics::Models::AnalyticsInstance'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_private_access_channel(private_access_channel_key, analytics_instance_id, update_private_access_channel_details, opts = {}) ⇒ Response

Note:

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

Update the private access channel with the given unique identifier key in the specified Analytics instance.

Parameters:

  • private_access_channel_key (String) —

    The unique identifier key of the private access channel.

  • analytics_instance_id (String) —

    The OCID of the Analytics instance.

  • update_private_access_channel_details (OCI::Analytics::Models::UpdatePrivateAccessChannelDetails) —

    Update the private access channel with the given unique identifier key in the specified Analytics instance.

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

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



2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
 
# File 'lib/oci/analytics/analytics_client.rb', line 2022

def update_private_access_channel(private_access_channel_key, analytics_instance_id, update_private_access_channel_details, opts = {})
  logger.debug 'Calling operation AnalyticsClient#update_private_access_channel.' if logger

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

  path = '/analyticsInstances/{analyticsInstanceId}/privateAccessChannels/{privateAccessChannelKey}'.sub('{privateAccessChannelKey}', private_access_channel_key.to_s).sub('{analyticsInstanceId}', analytics_instance_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(update_private_access_channel_details)

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

#update_resource_group(analytics_instance_id, analytics_instance_resource_group_id, update_resource_group_details, opts = {}) ⇒ Response

Note:

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

Update any fields in a resource group

Parameters:

  • analytics_instance_id (String) —

    The OCID of the Analytics instance.

  • analytics_instance_resource_group_id (String) —

    Specify unique id of a resource group within an Analytics instance.

  • update_resource_group_details (OCI::Analytics::Models::UpdateResourceGroupDetails) —

    Resource group details to update (certificate).

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

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



2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
 
# File 'lib/oci/analytics/analytics_client.rb', line 2099

def update_resource_group(analytics_instance_id, analytics_instance_resource_group_id, update_resource_group_details, opts = {})
  logger.debug 'Calling operation AnalyticsClient#update_resource_group.' if logger

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

  path = '/analyticsInstances/{analyticsInstanceId}/resourceGroups/{analyticsInstanceResourceGroupId}'.sub('{analyticsInstanceId}', analytics_instance_id.to_s).sub('{analyticsInstanceResourceGroupId}', analytics_instance_resource_group_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(update_resource_group_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'AnalyticsClient#update_resource_group') 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,
      return_type: 'OCI::Analytics::Models::InstanceResourceGroup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_vanity_url(analytics_instance_id, vanity_url_key, update_vanity_url_details, opts = {}) ⇒ Response

Note:

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

Uploads a new certificate for a vanity URL. Required before the current certificate expires.

Parameters:

  • analytics_instance_id (String) —

    The OCID of the Analytics instance.

  • vanity_url_key (String) —

    Specify unique identifier key of a vanity URL to update or delete.

  • update_vanity_url_details (OCI::Analytics::Models::UpdateVanityUrlDetails) —

    Vanity URL details to update (certificate).

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

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



2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
 
# File 'lib/oci/analytics/analytics_client.rb', line 2177

def update_vanity_url(analytics_instance_id, vanity_url_key, update_vanity_url_details, opts = {})
  logger.debug 'Calling operation AnalyticsClient#update_vanity_url.' if logger

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

  path = '/analyticsInstances/{analyticsInstanceId}/vanityUrls/{vanityUrlKey}'.sub('{analyticsInstanceId}', analytics_instance_id.to_s).sub('{vanityUrlKey}', vanity_url_key.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(update_vanity_url_details)

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