Class: OCI::Opensearch::OpensearchClusterBackupClient
- Inherits:
-
Object
- Object
- OCI::Opensearch::OpensearchClusterBackupClient
- Defined in:
- lib/oci/opensearch/opensearch_cluster_backup_client.rb
Overview
The OpenSearch service API provides access to OCI Search Service with OpenSearch.
Instance Attribute Summary collapse
-
#api_client ⇒ OCI::ApiClient
readonly
Client used to make HTTP requests.
-
#endpoint ⇒ String
readonly
Fully qualified endpoint URL.
-
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
-
#retry_config ⇒ OCI::Retry::RetryConfig
readonly
The default retry configuration to apply to all operations in this service client.
Instance Method Summary collapse
-
#delete_opensearch_cluster_backup(opensearch_cluster_backup_id, opts = {}) ⇒ Response
Deletes a OpensearchClusterBackup resource by identifier.
-
#get_opensearch_cluster_backup(opensearch_cluster_backup_id, opts = {}) ⇒ Response
Gets a OpensearchClusterBackup by identifier.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ OpensearchClusterBackupClient
constructor
Creates a new OpensearchClusterBackupClient.
-
#list_opensearch_cluster_backups(compartment_id, opts = {}) ⇒ Response
Returns a list of OpensearchClusterBackups.
-
#logger ⇒ Logger
The logger for this client.
-
#update_opensearch_cluster_backup(opensearch_cluster_backup_id, update_opensearch_cluster_backup_details, opts = {}) ⇒ Response
Updates the OpensearchClusterBackup.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ OpensearchClusterBackupClient
Creates a new OpensearchClusterBackupClient. 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.
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/opensearch/opensearch_cluster_backup_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 + '/20180828' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "OpensearchClusterBackupClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
15 16 17 |
# File 'lib/oci/opensearch/opensearch_cluster_backup_client.rb', line 15 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
19 20 21 |
# File 'lib/oci/opensearch/opensearch_cluster_backup_client.rb', line 19 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
29 30 31 |
# File 'lib/oci/opensearch/opensearch_cluster_backup_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
25 26 27 |
# File 'lib/oci/opensearch/opensearch_cluster_backup_client.rb', line 25 def retry_config @retry_config end |
Instance Method Details
#delete_opensearch_cluster_backup(opensearch_cluster_backup_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_opensearch_cluster_backup API.
Deletes a OpensearchClusterBackup resource by identifier
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 |
# File 'lib/oci/opensearch/opensearch_cluster_backup_client.rb', line 117 def delete_opensearch_cluster_backup(opensearch_cluster_backup_id, opts = {}) logger.debug 'Calling operation OpensearchClusterBackupClient#delete_opensearch_cluster_backup.' if logger raise "Missing the required parameter 'opensearch_cluster_backup_id' when calling delete_opensearch_cluster_backup." if opensearch_cluster_backup_id.nil? raise "Parameter value for 'opensearch_cluster_backup_id' must not be blank" if OCI::Internal::Util.blank_string?(opensearch_cluster_backup_id) path = '/opensearchClusterBackups/{opensearchClusterBackupId}'.sub('{opensearchClusterBackupId}', opensearch_cluster_backup_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'OpensearchClusterBackupClient#delete_opensearch_cluster_backup') 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_opensearch_cluster_backup(opensearch_cluster_backup_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_opensearch_cluster_backup API.
Gets a OpensearchClusterBackup by identifier
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 |
# File 'lib/oci/opensearch/opensearch_cluster_backup_client.rb', line 171 def get_opensearch_cluster_backup(opensearch_cluster_backup_id, opts = {}) logger.debug 'Calling operation OpensearchClusterBackupClient#get_opensearch_cluster_backup.' if logger raise "Missing the required parameter 'opensearch_cluster_backup_id' when calling get_opensearch_cluster_backup." if opensearch_cluster_backup_id.nil? raise "Parameter value for 'opensearch_cluster_backup_id' must not be blank" if OCI::Internal::Util.blank_string?(opensearch_cluster_backup_id) path = '/opensearchClusterBackups/{opensearchClusterBackupId}'.sub('{opensearchClusterBackupId}', opensearch_cluster_backup_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'OpensearchClusterBackupClient#get_opensearch_cluster_backup') 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::Opensearch::Models::OpensearchClusterBackup' ) end # rubocop:enable Metrics/BlockLength end |
#list_opensearch_cluster_backups(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_opensearch_cluster_backups API.
Returns a list of OpensearchClusterBackups.
Allowed values are: timeCreated, displayName
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 |
# File 'lib/oci/opensearch/opensearch_cluster_backup_client.rb', line 236 def list_opensearch_cluster_backups(compartment_id, opts = {}) logger.debug 'Calling operation OpensearchClusterBackupClient#list_opensearch_cluster_backups.' if logger raise "Missing the required parameter 'compartment_id' when calling list_opensearch_cluster_backups." if compartment_id.nil? if opts[:lifecycle_state] && !OCI::Opensearch::Models::OpensearchClusterBackup::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Opensearch::Models::OpensearchClusterBackup::LIFECYCLE_STATE_ENUM.' end if opts[:sort_order] && !OCI::Opensearch::Models::SORT_ORDER_ENUM.include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of the values in OCI::Opensearch::Models::SORT_ORDER_ENUM.' end if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.' end path = '/opensearchClusterBackups' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:sourceOpensearchClusterId] = opts[:source_opensearch_cluster_id] if opts[:source_opensearch_cluster_id] query_params[:id] = opts[:id] if opts[:id] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'OpensearchClusterBackupClient#list_opensearch_cluster_backups') 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::Opensearch::Models::OpensearchClusterBackupCollection' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
94 95 96 |
# File 'lib/oci/opensearch/opensearch_cluster_backup_client.rb', line 94 def logger @api_client.config.logger end |
#update_opensearch_cluster_backup(opensearch_cluster_backup_id, update_opensearch_cluster_backup_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_opensearch_cluster_backup API.
Updates the OpensearchClusterBackup
317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 |
# File 'lib/oci/opensearch/opensearch_cluster_backup_client.rb', line 317 def update_opensearch_cluster_backup(opensearch_cluster_backup_id, update_opensearch_cluster_backup_details, opts = {}) logger.debug 'Calling operation OpensearchClusterBackupClient#update_opensearch_cluster_backup.' if logger raise "Missing the required parameter 'opensearch_cluster_backup_id' when calling update_opensearch_cluster_backup." if opensearch_cluster_backup_id.nil? raise "Missing the required parameter 'update_opensearch_cluster_backup_details' when calling update_opensearch_cluster_backup." if update_opensearch_cluster_backup_details.nil? raise "Parameter value for 'opensearch_cluster_backup_id' must not be blank" if OCI::Internal::Util.blank_string?(opensearch_cluster_backup_id) path = '/opensearchClusterBackups/{opensearchClusterBackupId}'.sub('{opensearchClusterBackupId}', opensearch_cluster_backup_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_opensearch_cluster_backup_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'OpensearchClusterBackupClient#update_opensearch_cluster_backup') 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 |