Class: OCI::FileStorage::FileStorageClient
- Inherits:
-
Object
- Object
- OCI::FileStorage::FileStorageClient
- Defined in:
- lib/oci/file_storage/file_storage_client.rb
Overview
Use the File Storage service API to manage file systems, mount targets, and snapshots. For more information, see Overview of File Storage.
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
-
#change_file_system_compartment(file_system_id, change_file_system_compartment_details, opts = {}) ⇒ Response
Moves a file system and its associated snapshots into a different compartment within the same tenancy.
-
#change_filesystem_snapshot_policy_compartment(filesystem_snapshot_policy_id, change_filesystem_snapshot_policy_compartment_details, opts = {}) ⇒ Response
Moves a file system snapshot policy into a different compartment within the same tenancy.
-
#change_mount_target_compartment(mount_target_id, change_mount_target_compartment_details, opts = {}) ⇒ Response
Moves a mount target and its associated export set or share set into a different compartment within the same tenancy.
-
#change_outbound_connector_compartment(outbound_connector_id, change_outbound_connector_compartment_details, opts = {}) ⇒ Response
Moves an outbound connector into a different compartment within the same tenancy.
-
#change_replication_compartment(replication_id, change_replication_compartment_details, opts = {}) ⇒ Response
Moves a replication and its replication target into a different compartment within the same tenancy.
-
#create_export(create_export_details, opts = {}) ⇒ Response
Creates a new export in the specified export set, path, and file system.
-
#create_file_system(create_file_system_details, opts = {}) ⇒ Response
Creates a new file system in the specified compartment and availability domain.
-
#create_filesystem_snapshot_policy(create_filesystem_snapshot_policy_details, opts = {}) ⇒ Response
Creates a new file system snapshot policy in the specified compartment and availability domain.
-
#create_mount_target(create_mount_target_details, opts = {}) ⇒ Response
Creates a new mount target in the specified compartment and subnet.
-
#create_outbound_connector(create_outbound_connector_details, opts = {}) ⇒ Response
Creates a new outbound connector in the specified compartment.
-
#create_replication(create_replication_details, opts = {}) ⇒ Response
Creates a new replication in the specified compartment.
-
#create_snapshot(create_snapshot_details, opts = {}) ⇒ Response
Creates a new snapshot of the specified file system.
-
#delete_export(export_id, opts = {}) ⇒ Response
Deletes the specified export.
-
#delete_file_system(file_system_id, opts = {}) ⇒ Response
Deletes the specified file system.
-
#delete_filesystem_snapshot_policy(filesystem_snapshot_policy_id, opts = {}) ⇒ Response
Deletes the specified file system snapshot policy.
-
#delete_mount_target(mount_target_id, opts = {}) ⇒ Response
Deletes the specified mount target.
-
#delete_outbound_connector(outbound_connector_id, opts = {}) ⇒ Response
Deletes the specified outbound connector.
-
#delete_replication(replication_id, opts = {}) ⇒ Response
Deletes the specified replication and the the associated replication target.
-
#delete_replication_target(replication_target_id, opts = {}) ⇒ Response
Deletes the specified replication target.
-
#delete_snapshot(snapshot_id, opts = {}) ⇒ Response
Deletes the specified snapshot.
-
#estimate_replication(file_system_id, opts = {}) ⇒ Response
Provides estimates for replication created using specific file system.
-
#get_export(export_id, opts = {}) ⇒ Response
Gets the specified export's information.
-
#get_export_set(export_set_id, opts = {}) ⇒ Response
Gets the specified export set's information.
-
#get_file_system(file_system_id, opts = {}) ⇒ Response
Gets the specified file system's information.
-
#get_filesystem_snapshot_policy(filesystem_snapshot_policy_id, opts = {}) ⇒ Response
Gets the specified file system snapshot policy's information.
-
#get_mount_target(mount_target_id, opts = {}) ⇒ Response
Gets the specified mount target's information.
-
#get_outbound_connector(outbound_connector_id, opts = {}) ⇒ Response
Gets the specified outbound connector's information.
-
#get_replication(replication_id, opts = {}) ⇒ Response
Gets the specified replication's information.
-
#get_replication_target(replication_target_id, opts = {}) ⇒ Response
Gets the specified replication target's information.
-
#get_snapshot(snapshot_id, opts = {}) ⇒ Response
Gets the specified snapshot's information.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ FileStorageClient
constructor
Creates a new FileStorageClient.
-
#list_export_sets(compartment_id, availability_domain, opts = {}) ⇒ Response
Lists the export set resources in the specified compartment.
-
#list_exports(opts = {}) ⇒ Response
Lists export resources by compartment, file system, or export set.
-
#list_file_systems(compartment_id, availability_domain, opts = {}) ⇒ Response
Lists the file system resources in the specified compartment, or by the specified compartment and file system snapshot policy.
-
#list_filesystem_snapshot_policies(compartment_id, availability_domain, opts = {}) ⇒ Response
Lists file system snapshot policies in the specified compartment.
-
#list_mount_targets(compartment_id, availability_domain, opts = {}) ⇒ Response
Lists the mount target resources in the specified compartment.
-
#list_outbound_connectors(compartment_id, availability_domain, opts = {}) ⇒ Response
Lists the outbound connector resources in the specified compartment.
-
#list_replication_targets(compartment_id, availability_domain, opts = {}) ⇒ Response
Lists the replication target resources in the specified compartment.
-
#list_replications(compartment_id, availability_domain, opts = {}) ⇒ Response
Lists the replication resources in the specified compartment.
-
#list_snapshots(opts = {}) ⇒ Response
Lists snapshots of the specified file system, or by file system snapshot policy and compartment, or by file system snapshot policy and file system.
-
#logger ⇒ Logger
The logger for this client.
-
#pause_filesystem_snapshot_policy(filesystem_snapshot_policy_id, opts = {}) ⇒ Response
This operation pauses the scheduled snapshot creation and snapshot deletion of the policy and updates the lifecycle state of the file system snapshot policy from ACTIVE to INACTIVE.
-
#unpause_filesystem_snapshot_policy(filesystem_snapshot_policy_id, opts = {}) ⇒ Response
This operation unpauses a paused file system snapshot policy and updates the lifecycle state of the file system snapshot policy from INACTIVE to ACTIVE.
-
#update_export(export_id, update_export_details, opts = {}) ⇒ Response
Updates the specified export's information.
-
#update_export_set(export_set_id, update_export_set_details, opts = {}) ⇒ Response
Updates the specified export set's information.
-
#update_file_system(file_system_id, update_file_system_details, opts = {}) ⇒ Response
Updates the specified file system's information.
-
#update_filesystem_snapshot_policy(filesystem_snapshot_policy_id, update_filesystem_snapshot_policy_details, opts = {}) ⇒ Response
Updates the specified file system snapshot policy's information.
-
#update_mount_target(mount_target_id, update_mount_target_details, opts = {}) ⇒ Response
Updates the specified mount target's information.
-
#update_outbound_connector(outbound_connector_id, update_outbound_connector_details, opts = {}) ⇒ Response
Updates the specified outbound connector's information.
-
#update_replication(replication_id, update_replication_details, opts = {}) ⇒ Response
Updates the information for the specified replication and its associated replication target.
-
#update_snapshot(snapshot_id, update_snapshot_details, opts = {}) ⇒ Response
Updates the specified snapshot's information.
-
#validate_key_tabs(validate_key_tabs_details, opts = {}) ⇒ Response
Validates keytab contents for the secret details passed on the request or validte keytab contents associated with the mount target passed in the request.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ FileStorageClient
Creates a new FileStorageClient. Notes: If a config is not specified, then the global OCI.config will be used.
This client is not thread-safe
Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 56 def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers) # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then # pass it to this constructor. # # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid # so try and load the config from the default file. config = OCI::Config.validate_and_build_config_with_signer(config, signer) signer = OCI::Signer.config_file_auth_builder(config) if signer.nil? @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings) @retry_config = retry_config if endpoint @endpoint = endpoint + '/20171215' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "FileStorageClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
16 17 18 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 16 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
20 21 22 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 20 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
30 31 32 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 30 def region @region end |
#retry_config ⇒ OCI::Retry::RetryConfig (readonly)
The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is nil
, which means that an operation will not perform any retries
26 27 28 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 26 def retry_config @retry_config end |
Instance Method Details
#change_file_system_compartment(file_system_id, change_file_system_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_file_system_compartment API.
Moves a file system and its associated snapshots into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment
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 154 155 156 157 158 159 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 122 def change_file_system_compartment(file_system_id, change_file_system_compartment_details, opts = {}) logger.debug 'Calling operation FileStorageClient#change_file_system_compartment.' if logger raise "Missing the required parameter 'file_system_id' when calling change_file_system_compartment." if file_system_id.nil? raise "Missing the required parameter 'change_file_system_compartment_details' when calling change_file_system_compartment." if change_file_system_compartment_details.nil? raise "Parameter value for 'file_system_id' must not be blank" if OCI::Internal::Util.blank_string?(file_system_id) path = '/fileSystems/{fileSystemId}/actions/changeCompartment'.sub('{fileSystemId}', file_system_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(change_file_system_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'FileStorageClient#change_file_system_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_filesystem_snapshot_policy_compartment(filesystem_snapshot_policy_id, change_filesystem_snapshot_policy_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_filesystem_snapshot_policy_compartment API.
Moves a file system snapshot policy into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 187 def change_filesystem_snapshot_policy_compartment(filesystem_snapshot_policy_id, change_filesystem_snapshot_policy_compartment_details, opts = {}) logger.debug 'Calling operation FileStorageClient#change_filesystem_snapshot_policy_compartment.' if logger raise "Missing the required parameter 'filesystem_snapshot_policy_id' when calling change_filesystem_snapshot_policy_compartment." if filesystem_snapshot_policy_id.nil? raise "Missing the required parameter 'change_filesystem_snapshot_policy_compartment_details' when calling change_filesystem_snapshot_policy_compartment." if change_filesystem_snapshot_policy_compartment_details.nil? raise "Parameter value for 'filesystem_snapshot_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(filesystem_snapshot_policy_id) path = '/filesystemSnapshotPolicies/{filesystemSnapshotPolicyId}/actions/changeCompartment'.sub('{filesystemSnapshotPolicyId}', filesystem_snapshot_policy_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(change_filesystem_snapshot_policy_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'FileStorageClient#change_filesystem_snapshot_policy_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_mount_target_compartment(mount_target_id, change_mount_target_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_mount_target_compartment API.
Moves a mount target and its associated export set or share set into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment
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 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 252 def change_mount_target_compartment(mount_target_id, change_mount_target_compartment_details, opts = {}) logger.debug 'Calling operation FileStorageClient#change_mount_target_compartment.' if logger raise "Missing the required parameter 'mount_target_id' when calling change_mount_target_compartment." if mount_target_id.nil? raise "Missing the required parameter 'change_mount_target_compartment_details' when calling change_mount_target_compartment." if change_mount_target_compartment_details.nil? raise "Parameter value for 'mount_target_id' must not be blank" if OCI::Internal::Util.blank_string?(mount_target_id) path = '/mountTargets/{mountTargetId}/actions/changeCompartment'.sub('{mountTargetId}', mount_target_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(change_mount_target_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'FileStorageClient#change_mount_target_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_outbound_connector_compartment(outbound_connector_id, change_outbound_connector_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_outbound_connector_compartment API.
Moves an outbound connector into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment
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 355 356 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 319 def change_outbound_connector_compartment(outbound_connector_id, change_outbound_connector_compartment_details, opts = {}) logger.debug 'Calling operation FileStorageClient#change_outbound_connector_compartment.' if logger raise "Missing the required parameter 'outbound_connector_id' when calling change_outbound_connector_compartment." if outbound_connector_id.nil? raise "Missing the required parameter 'change_outbound_connector_compartment_details' when calling change_outbound_connector_compartment." if change_outbound_connector_compartment_details.nil? raise "Parameter value for 'outbound_connector_id' must not be blank" if OCI::Internal::Util.blank_string?(outbound_connector_id) path = '/outboundConnectors/{outboundConnectorId}/actions/changeCompartment'.sub('{outboundConnectorId}', outbound_connector_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(change_outbound_connector_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'FileStorageClient#change_outbound_connector_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_replication_compartment(replication_id, change_replication_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_replication_compartment API.
Moves a replication and its replication target into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 385 def change_replication_compartment(replication_id, change_replication_compartment_details, opts = {}) logger.debug 'Calling operation FileStorageClient#change_replication_compartment.' if logger raise "Missing the required parameter 'replication_id' when calling change_replication_compartment." if replication_id.nil? raise "Missing the required parameter 'change_replication_compartment_details' when calling change_replication_compartment." if change_replication_compartment_details.nil? raise "Parameter value for 'replication_id' must not be blank" if OCI::Internal::Util.blank_string?(replication_id) path = '/replications/{replicationId}/actions/changeCompartment'.sub('{replicationId}', replication_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(change_replication_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'FileStorageClient#change_replication_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#create_export(create_export_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_export API.
Creates a new export in the specified export set, path, and file system.
450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 450 def create_export(create_export_details, opts = {}) logger.debug 'Calling operation FileStorageClient#create_export.' if logger raise "Missing the required parameter 'create_export_details' when calling create_export." if create_export_details.nil? path = '/exports' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_export_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'FileStorageClient#create_export') 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::FileStorage::Models::Export' ) end # rubocop:enable Metrics/BlockLength end |
#create_file_system(create_file_system_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_file_system API.
Creates a new file system in the specified compartment and availability domain. Instances can mount file systems in another availability domain, but doing so might increase latency when compared to mounting instances in the same availability domain.
After you create a file system, you can associate it with a mount target. Instances can then mount the file system by connecting to the mount target's IP address. You can associate a file system with more than one mount target at a time.
For information about access control and compartments, see Overview of the IAM Service.
For information about Network Security Groups access control, see Network Security Groups.
For information about availability domains, see Regions and Availability Domains. To get a list of availability domains, use the ListAvailabilityDomains
operation in the Identity and Access Management Service API.
All Oracle Cloud Infrastructure resources, including file systems, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type or by viewing the resource in the Console.
542 543 544 545 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 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 542 def create_file_system(create_file_system_details, opts = {}) logger.debug 'Calling operation FileStorageClient#create_file_system.' if logger raise "Missing the required parameter 'create_file_system_details' when calling create_file_system." if create_file_system_details.nil? path = '/fileSystems' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_file_system_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'FileStorageClient#create_file_system') 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::FileStorage::Models::FileSystem' ) end # rubocop:enable Metrics/BlockLength end |
#create_filesystem_snapshot_policy(create_filesystem_snapshot_policy_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_filesystem_snapshot_policy API.
Creates a new file system snapshot policy in the specified compartment and availability domain.
After you create a file system snapshot policy, you can associate it with file systems.
610 611 612 613 614 615 616 617 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 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 610 def create_filesystem_snapshot_policy(create_filesystem_snapshot_policy_details, opts = {}) logger.debug 'Calling operation FileStorageClient#create_filesystem_snapshot_policy.' if logger raise "Missing the required parameter 'create_filesystem_snapshot_policy_details' when calling create_filesystem_snapshot_policy." if create_filesystem_snapshot_policy_details.nil? path = '/filesystemSnapshotPolicies' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_filesystem_snapshot_policy_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'FileStorageClient#create_filesystem_snapshot_policy') 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::FileStorage::Models::FilesystemSnapshotPolicy' ) end # rubocop:enable Metrics/BlockLength end |
#create_mount_target(create_mount_target_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_mount_target API.
Creates a new mount target in the specified compartment and subnet. You can associate a file system with a mount target only when they exist in the same availability domain. Instances can connect to mount targets in another availablity domain, but you might see higher latency than with instances in the same availability domain as the mount target.
Mount targets have one or more private IP addresses that you can provide as the host portion of remote target parameters in client mount commands. These private IP addresses are listed in the privateIpIds property of the mount target and are highly available. Mount targets also consume additional IP addresses in their subnet. Do not use /30 or smaller subnets for mount target creation because they do not have sufficient available IP addresses. Allow at least three IP addresses for each mount target.
For information about access control and compartments, see Overview of the IAM Service.
For information about availability domains, see Regions and Availability Domains. To get a list of availability domains, use the ListAvailabilityDomains
operation in the Identity and Access Management Service API.
All Oracle Cloud Infrastructure Services resources, including mount targets, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console.
705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 705 def create_mount_target(create_mount_target_details, opts = {}) logger.debug 'Calling operation FileStorageClient#create_mount_target.' if logger raise "Missing the required parameter 'create_mount_target_details' when calling create_mount_target." if create_mount_target_details.nil? path = '/mountTargets' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_mount_target_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'FileStorageClient#create_mount_target') 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::FileStorage::Models::MountTarget' ) end # rubocop:enable Metrics/BlockLength end |
#create_outbound_connector(create_outbound_connector_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_outbound_connector API.
Creates a new outbound connector in the specified compartment. You can associate an outbound connector with a mount target only when they exist in the same availability domain.
For information about access control and compartments, see Overview of the IAM Service.
For information about availability domains, see Regions and Availability Domains. To get a list of availability domains, use the ListAvailabilityDomains
operation in the Identity and Access Management Service API.
All Oracle Cloud Infrastructure Services resources, including outbound connectors, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console.
788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 788 def create_outbound_connector(create_outbound_connector_details, opts = {}) logger.debug 'Calling operation FileStorageClient#create_outbound_connector.' if logger raise "Missing the required parameter 'create_outbound_connector_details' when calling create_outbound_connector." if create_outbound_connector_details.nil? path = '/outboundConnectors' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_outbound_connector_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'FileStorageClient#create_outbound_connector') 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::FileStorage::Models::OutboundConnector' ) end # rubocop:enable Metrics/BlockLength end |
#create_replication(create_replication_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_replication API.
Creates a new replication in the specified compartment. Replications are the primary resource that governs the policy of cross-region replication between source and target file systems. Replications are associated with a secondary resource called a ReplicationTarget} located in another availability domain. The associated replication target resource is automatically created along with the replication resource. The replication retrieves the delta of data between two snapshots of a source file system and sends it to the associated ReplicationTarget, which retrieves the delta and applies it to the target file system. Only unexported file systems can be used as target file systems. For more information, see {Using Replication.
For information about access control and compartments, see Overview of the IAM Service.
For information about availability domains, see Regions and Availability Domains. To get a list of availability domains, use the ListAvailabilityDomains
operation in the Identity and Access Management Service API.
All Oracle Cloud Infrastructure Services resources, including replications, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console.
878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 878 def create_replication(create_replication_details, opts = {}) logger.debug 'Calling operation FileStorageClient#create_replication.' if logger raise "Missing the required parameter 'create_replication_details' when calling create_replication." if create_replication_details.nil? path = '/replications' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_replication_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'FileStorageClient#create_replication') 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::FileStorage::Models::Replication' ) end # rubocop:enable Metrics/BlockLength end |
#create_snapshot(create_snapshot_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_snapshot API.
Creates a new snapshot of the specified file system. You can access the snapshot at .snapshot/<name>
.
943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 943 def create_snapshot(create_snapshot_details, opts = {}) logger.debug 'Calling operation FileStorageClient#create_snapshot.' if logger raise "Missing the required parameter 'create_snapshot_details' when calling create_snapshot." if create_snapshot_details.nil? path = '/snapshots' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_snapshot_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'FileStorageClient#create_snapshot') 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::FileStorage::Models::Snapshot' ) end # rubocop:enable Metrics/BlockLength end |
#delete_export(export_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_export API.
Deletes the specified export.
1007 1008 1009 1010 1011 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 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 1007 def delete_export(export_id, opts = {}) logger.debug 'Calling operation FileStorageClient#delete_export.' if logger raise "Missing the required parameter 'export_id' when calling delete_export." if export_id.nil? raise "Parameter value for 'export_id' must not be blank" if OCI::Internal::Util.blank_string?(export_id) path = '/exports/{exportId}'.sub('{exportId}', export_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: 'FileStorageClient#delete_export') 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_file_system(file_system_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_file_system API.
Deletes the specified file system. Before you delete the file system, verify that no remaining export resources still reference it. Deleting a file system also deletes all of its snapshots.
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/file_storage/file_storage_client.rb', line 1072 def delete_file_system(file_system_id, opts = {}) logger.debug 'Calling operation FileStorageClient#delete_file_system.' if logger raise "Missing the required parameter 'file_system_id' when calling delete_file_system." if file_system_id.nil? raise "Parameter value for 'file_system_id' must not be blank" if OCI::Internal::Util.blank_string?(file_system_id) path = '/fileSystems/{fileSystemId}'.sub('{fileSystemId}', file_system_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: 'FileStorageClient#delete_file_system') 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_filesystem_snapshot_policy(filesystem_snapshot_policy_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_filesystem_snapshot_policy API.
Deletes the specified file system snapshot policy.
1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 1135 def delete_filesystem_snapshot_policy(filesystem_snapshot_policy_id, opts = {}) logger.debug 'Calling operation FileStorageClient#delete_filesystem_snapshot_policy.' if logger raise "Missing the required parameter 'filesystem_snapshot_policy_id' when calling delete_filesystem_snapshot_policy." if filesystem_snapshot_policy_id.nil? raise "Parameter value for 'filesystem_snapshot_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(filesystem_snapshot_policy_id) path = '/filesystemSnapshotPolicies/{filesystemSnapshotPolicyId}'.sub('{filesystemSnapshotPolicyId}', filesystem_snapshot_policy_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: 'FileStorageClient#delete_filesystem_snapshot_policy') 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_mount_target(mount_target_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_mount_target API.
Deletes the specified mount target. This operation also deletes the mount target's VNICs.
1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 1199 def delete_mount_target(mount_target_id, opts = {}) logger.debug 'Calling operation FileStorageClient#delete_mount_target.' if logger raise "Missing the required parameter 'mount_target_id' when calling delete_mount_target." if mount_target_id.nil? raise "Parameter value for 'mount_target_id' must not be blank" if OCI::Internal::Util.blank_string?(mount_target_id) path = '/mountTargets/{mountTargetId}'.sub('{mountTargetId}', mount_target_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: 'FileStorageClient#delete_mount_target') 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_outbound_connector(outbound_connector_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_outbound_connector API.
Deletes the specified outbound connector.
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 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 1262 def delete_outbound_connector(outbound_connector_id, opts = {}) logger.debug 'Calling operation FileStorageClient#delete_outbound_connector.' if logger raise "Missing the required parameter 'outbound_connector_id' when calling delete_outbound_connector." if outbound_connector_id.nil? raise "Parameter value for 'outbound_connector_id' must not be blank" if OCI::Internal::Util.blank_string?(outbound_connector_id) path = '/outboundConnectors/{outboundConnectorId}'.sub('{outboundConnectorId}', outbound_connector_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: 'FileStorageClient#delete_outbound_connector') 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_replication(replication_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_replication API.
Deletes the specified replication and the the associated replication target.
1331 1332 1333 1334 1335 1336 1337 1338 1339 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 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 1331 def delete_replication(replication_id, opts = {}) logger.debug 'Calling operation FileStorageClient#delete_replication.' if logger raise "Missing the required parameter 'replication_id' when calling delete_replication." if replication_id.nil? if opts[:delete_mode] && !%w[FINISH_CYCLE_IF_CAPTURING_OR_APPLYING ONE_MORE_CYCLE FINISH_CYCLE_IF_APPLYING].include?(opts[:delete_mode]) raise 'Invalid value for "delete_mode", must be one of FINISH_CYCLE_IF_CAPTURING_OR_APPLYING, ONE_MORE_CYCLE, FINISH_CYCLE_IF_APPLYING.' end raise "Parameter value for 'replication_id' must not be blank" if OCI::Internal::Util.blank_string?(replication_id) path = '/replications/{replicationId}'.sub('{replicationId}', replication_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:deleteMode] = opts[:delete_mode] if opts[:delete_mode] # 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: 'FileStorageClient#delete_replication') 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_replication_target(replication_target_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_replication_target API.
Deletes the specified replication target. This operation causes the immediate release of the target file system if there are currently no delta application operations. If there is any current delta being applied the delete operation is blocked until the current delta has been completely applied.
1402 1403 1404 1405 1406 1407 1408 1409 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 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 1402 def delete_replication_target(replication_target_id, opts = {}) logger.debug 'Calling operation FileStorageClient#delete_replication_target.' if logger raise "Missing the required parameter 'replication_target_id' when calling delete_replication_target." if replication_target_id.nil? raise "Parameter value for 'replication_target_id' must not be blank" if OCI::Internal::Util.blank_string?(replication_target_id) path = '/replicationTargets/{replicationTargetId}'.sub('{replicationTargetId}', replication_target_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: 'FileStorageClient#delete_replication_target') 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_snapshot(snapshot_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_snapshot API.
Deletes the specified snapshot.
1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 1465 def delete_snapshot(snapshot_id, opts = {}) logger.debug 'Calling operation FileStorageClient#delete_snapshot.' if logger raise "Missing the required parameter 'snapshot_id' when calling delete_snapshot." if snapshot_id.nil? raise "Parameter value for 'snapshot_id' must not be blank" if OCI::Internal::Util.blank_string?(snapshot_id) path = '/snapshots/{snapshotId}'.sub('{snapshotId}', snapshot_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: 'FileStorageClient#delete_snapshot') 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 |
#estimate_replication(file_system_id, opts = {}) ⇒ Response
Click here to see an example of how to use estimate_replication API.
Provides estimates for replication created using specific file system.
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 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 1529 def estimate_replication(file_system_id, opts = {}) logger.debug 'Calling operation FileStorageClient#estimate_replication.' if logger raise "Missing the required parameter 'file_system_id' when calling estimate_replication." if file_system_id.nil? raise "Parameter value for 'file_system_id' must not be blank" if OCI::Internal::Util.blank_string?(file_system_id) path = '/fileSystems/{fileSystemId}/actions/estimateReplication'.sub('{fileSystemId}', file_system_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:changeRateInMBps] = opts[:change_rate_in_m_bps] if opts[:change_rate_in_m_bps] # 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: 'FileStorageClient#estimate_replication') 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::FileStorage::Models::ReplicationEstimate' ) end # rubocop:enable Metrics/BlockLength end |
#get_export(export_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_export API.
Gets the specified export's information.
1587 1588 1589 1590 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 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 1587 def get_export(export_id, opts = {}) logger.debug 'Calling operation FileStorageClient#get_export.' if logger raise "Missing the required parameter 'export_id' when calling get_export." if export_id.nil? raise "Parameter value for 'export_id' must not be blank" if OCI::Internal::Util.blank_string?(export_id) path = '/exports/{exportId}'.sub('{exportId}', export_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: 'FileStorageClient#get_export') 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::FileStorage::Models::Export' ) end # rubocop:enable Metrics/BlockLength end |
#get_export_set(export_set_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_export_set API.
Gets the specified export set's information.
1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 1643 def get_export_set(export_set_id, opts = {}) logger.debug 'Calling operation FileStorageClient#get_export_set.' if logger raise "Missing the required parameter 'export_set_id' when calling get_export_set." if export_set_id.nil? raise "Parameter value for 'export_set_id' must not be blank" if OCI::Internal::Util.blank_string?(export_set_id) path = '/exportSets/{exportSetId}'.sub('{exportSetId}', export_set_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: 'FileStorageClient#get_export_set') 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::FileStorage::Models::ExportSet' ) end # rubocop:enable Metrics/BlockLength end |
#get_file_system(file_system_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_file_system API.
Gets the specified file system's information.
1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 1699 def get_file_system(file_system_id, opts = {}) logger.debug 'Calling operation FileStorageClient#get_file_system.' if logger raise "Missing the required parameter 'file_system_id' when calling get_file_system." if file_system_id.nil? raise "Parameter value for 'file_system_id' must not be blank" if OCI::Internal::Util.blank_string?(file_system_id) path = '/fileSystems/{fileSystemId}'.sub('{fileSystemId}', file_system_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: 'FileStorageClient#get_file_system') 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::FileStorage::Models::FileSystem' ) end # rubocop:enable Metrics/BlockLength end |
#get_filesystem_snapshot_policy(filesystem_snapshot_policy_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_filesystem_snapshot_policy API.
Gets the specified file system snapshot policy's information.
1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 1755 def get_filesystem_snapshot_policy(filesystem_snapshot_policy_id, opts = {}) logger.debug 'Calling operation FileStorageClient#get_filesystem_snapshot_policy.' if logger raise "Missing the required parameter 'filesystem_snapshot_policy_id' when calling get_filesystem_snapshot_policy." if filesystem_snapshot_policy_id.nil? raise "Parameter value for 'filesystem_snapshot_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(filesystem_snapshot_policy_id) path = '/filesystemSnapshotPolicies/{filesystemSnapshotPolicyId}'.sub('{filesystemSnapshotPolicyId}', filesystem_snapshot_policy_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: 'FileStorageClient#get_filesystem_snapshot_policy') 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::FileStorage::Models::FilesystemSnapshotPolicy' ) end # rubocop:enable Metrics/BlockLength end |
#get_mount_target(mount_target_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_mount_target API.
Gets the specified mount target's information.
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/file_storage/file_storage_client.rb', line 1811 def get_mount_target(mount_target_id, opts = {}) logger.debug 'Calling operation FileStorageClient#get_mount_target.' if logger raise "Missing the required parameter 'mount_target_id' when calling get_mount_target." if mount_target_id.nil? raise "Parameter value for 'mount_target_id' must not be blank" if OCI::Internal::Util.blank_string?(mount_target_id) path = '/mountTargets/{mountTargetId}'.sub('{mountTargetId}', mount_target_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: 'FileStorageClient#get_mount_target') 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::FileStorage::Models::MountTarget' ) end # rubocop:enable Metrics/BlockLength end |
#get_outbound_connector(outbound_connector_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_outbound_connector API.
Gets the specified outbound connector's information.
1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 1867 def get_outbound_connector(outbound_connector_id, opts = {}) logger.debug 'Calling operation FileStorageClient#get_outbound_connector.' if logger raise "Missing the required parameter 'outbound_connector_id' when calling get_outbound_connector." if outbound_connector_id.nil? raise "Parameter value for 'outbound_connector_id' must not be blank" if OCI::Internal::Util.blank_string?(outbound_connector_id) path = '/outboundConnectors/{outboundConnectorId}'.sub('{outboundConnectorId}', outbound_connector_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: 'FileStorageClient#get_outbound_connector') 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::FileStorage::Models::OutboundConnector' ) end # rubocop:enable Metrics/BlockLength end |
#get_replication(replication_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_replication API.
Gets the specified replication's information.
1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 1923 def get_replication(replication_id, opts = {}) logger.debug 'Calling operation FileStorageClient#get_replication.' if logger raise "Missing the required parameter 'replication_id' when calling get_replication." if replication_id.nil? raise "Parameter value for 'replication_id' must not be blank" if OCI::Internal::Util.blank_string?(replication_id) path = '/replications/{replicationId}'.sub('{replicationId}', replication_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: 'FileStorageClient#get_replication') 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::FileStorage::Models::Replication' ) end # rubocop:enable Metrics/BlockLength end |
#get_replication_target(replication_target_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_replication_target API.
Gets the specified replication target's information.
1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 1979 def get_replication_target(replication_target_id, opts = {}) logger.debug 'Calling operation FileStorageClient#get_replication_target.' if logger raise "Missing the required parameter 'replication_target_id' when calling get_replication_target." if replication_target_id.nil? raise "Parameter value for 'replication_target_id' must not be blank" if OCI::Internal::Util.blank_string?(replication_target_id) path = '/replicationTargets/{replicationTargetId}'.sub('{replicationTargetId}', replication_target_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: 'FileStorageClient#get_replication_target') 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::FileStorage::Models::ReplicationTarget' ) end # rubocop:enable Metrics/BlockLength end |
#get_snapshot(snapshot_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_snapshot API.
Gets the specified snapshot's information.
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 2064 2065 2066 2067 2068 2069 2070 2071 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 2035 def get_snapshot(snapshot_id, opts = {}) logger.debug 'Calling operation FileStorageClient#get_snapshot.' if logger raise "Missing the required parameter 'snapshot_id' when calling get_snapshot." if snapshot_id.nil? raise "Parameter value for 'snapshot_id' must not be blank" if OCI::Internal::Util.blank_string?(snapshot_id) path = '/snapshots/{snapshotId}'.sub('{snapshotId}', snapshot_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: 'FileStorageClient#get_snapshot') 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::FileStorage::Models::Snapshot' ) end # rubocop:enable Metrics/BlockLength end |
#list_export_sets(compartment_id, availability_domain, opts = {}) ⇒ Response
Click here to see an example of how to use list_export_sets API.
Lists the export set resources in the specified compartment.
2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 2133 def list_export_sets(compartment_id, availability_domain, opts = {}) logger.debug 'Calling operation FileStorageClient#list_export_sets.' if logger raise "Missing the required parameter 'compartment_id' when calling list_export_sets." if compartment_id.nil? raise "Missing the required parameter 'availability_domain' when calling list_export_sets." if availability_domain.nil? if opts[:lifecycle_state] && !%w[CREATING ACTIVE DELETING DELETED FAILED].include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of CREATING, ACTIVE, DELETING, DELETED, FAILED.' end if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end path = '/exportSets' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:availabilityDomain] = availability_domain query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:id] = opts[:id] if opts[:id] 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.(applicable_retry_config(opts), call_name: 'FileStorageClient#list_export_sets') 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::FileStorage::Models::ExportSetSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_exports(opts = {}) ⇒ Response
Click here to see an example of how to use list_exports API.
Lists export resources by compartment, file system, or export set. You must specify an export set ID, a file system ID, and / or a compartment ID.
2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 2248 def list_exports(opts = {}) logger.debug 'Calling operation FileStorageClient#list_exports.' if logger if opts[:lifecycle_state] && !%w[CREATING ACTIVE DELETING DELETED FAILED].include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of CREATING, ACTIVE, DELETING, DELETED, FAILED.' end if opts[:sort_by] && !%w[TIMECREATED PATH].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, PATH.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end path = '/exports' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:exportSetId] = opts[:export_set_id] if opts[:export_set_id] query_params[:fileSystemId] = opts[:file_system_id] if opts[:file_system_id] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:id] = opts[:id] if opts[:id] 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.(applicable_retry_config(opts), call_name: 'FileStorageClient#list_exports') 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::FileStorage::Models::ExportSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_file_systems(compartment_id, availability_domain, opts = {}) ⇒ Response
Click here to see an example of how to use list_file_systems API.
Lists the file system resources in the specified compartment, or by the specified compartment and file system snapshot policy.
2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 2371 def list_file_systems(compartment_id, availability_domain, opts = {}) logger.debug 'Calling operation FileStorageClient#list_file_systems.' if logger raise "Missing the required parameter 'compartment_id' when calling list_file_systems." if compartment_id.nil? raise "Missing the required parameter 'availability_domain' when calling list_file_systems." if availability_domain.nil? if opts[:lifecycle_state] && !%w[CREATING ACTIVE DELETING DELETED FAILED].include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of CREATING, ACTIVE, DELETING, DELETED, FAILED.' end if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end path = '/fileSystems' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:availabilityDomain] = availability_domain query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:id] = opts[:id] if opts[:id] query_params[:sourceSnapshotId] = opts[:source_snapshot_id] if opts[:source_snapshot_id] query_params[:parentFileSystemId] = opts[:parent_file_system_id] if opts[:parent_file_system_id] query_params[:filesystemSnapshotPolicyId] = opts[:filesystem_snapshot_policy_id] if opts[:filesystem_snapshot_policy_id] 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.(applicable_retry_config(opts), call_name: 'FileStorageClient#list_file_systems') 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::FileStorage::Models::FileSystemSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_filesystem_snapshot_policies(compartment_id, availability_domain, opts = {}) ⇒ Response
Click here to see an example of how to use list_filesystem_snapshot_policies API.
Lists file system snapshot policies in the specified compartment.
2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 2493 def list_filesystem_snapshot_policies(compartment_id, availability_domain, opts = {}) logger.debug 'Calling operation FileStorageClient#list_filesystem_snapshot_policies.' if logger raise "Missing the required parameter 'compartment_id' when calling list_filesystem_snapshot_policies." if compartment_id.nil? raise "Missing the required parameter 'availability_domain' when calling list_filesystem_snapshot_policies." if availability_domain.nil? if opts[:lifecycle_state] && !%w[CREATING ACTIVE DELETING DELETED FAILED INACTIVE].include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of CREATING, ACTIVE, DELETING, DELETED, FAILED, INACTIVE.' end if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end path = '/filesystemSnapshotPolicies' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:availabilityDomain] = availability_domain query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:id] = opts[:id] if opts[:id] 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.(applicable_retry_config(opts), call_name: 'FileStorageClient#list_filesystem_snapshot_policies') 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::FileStorage::Models::FilesystemSnapshotPolicySummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_mount_targets(compartment_id, availability_domain, opts = {}) ⇒ Response
Click here to see an example of how to use list_mount_targets API.
Lists the mount target resources in the specified compartment.
2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 2613 def list_mount_targets(compartment_id, availability_domain, opts = {}) logger.debug 'Calling operation FileStorageClient#list_mount_targets.' if logger raise "Missing the required parameter 'compartment_id' when calling list_mount_targets." if compartment_id.nil? raise "Missing the required parameter 'availability_domain' when calling list_mount_targets." if availability_domain.nil? if opts[:lifecycle_state] && !%w[CREATING ACTIVE DELETING DELETED FAILED].include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of CREATING, ACTIVE, DELETING, DELETED, FAILED.' end if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end path = '/mountTargets' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:availabilityDomain] = availability_domain query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:exportSetId] = opts[:export_set_id] if opts[:export_set_id] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:id] = opts[:id] if opts[:id] 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.(applicable_retry_config(opts), call_name: 'FileStorageClient#list_mount_targets') 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::FileStorage::Models::MountTargetSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_outbound_connectors(compartment_id, availability_domain, opts = {}) ⇒ Response
Click here to see an example of how to use list_outbound_connectors API.
Lists the outbound connector resources in the specified compartment.
2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 2733 def list_outbound_connectors(compartment_id, availability_domain, opts = {}) logger.debug 'Calling operation FileStorageClient#list_outbound_connectors.' if logger raise "Missing the required parameter 'compartment_id' when calling list_outbound_connectors." if compartment_id.nil? raise "Missing the required parameter 'availability_domain' when calling list_outbound_connectors." if availability_domain.nil? if opts[:lifecycle_state] && !%w[CREATING ACTIVE DELETING DELETED FAILED].include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of CREATING, ACTIVE, DELETING, DELETED, FAILED.' end if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end path = '/outboundConnectors' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:availabilityDomain] = availability_domain query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:id] = opts[:id] if opts[:id] 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.(applicable_retry_config(opts), call_name: 'FileStorageClient#list_outbound_connectors') 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::FileStorage::Models::OutboundConnectorSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_replication_targets(compartment_id, availability_domain, opts = {}) ⇒ Response
Click here to see an example of how to use list_replication_targets API.
Lists the replication target resources in the specified compartment.
2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 2852 def list_replication_targets(compartment_id, availability_domain, opts = {}) logger.debug 'Calling operation FileStorageClient#list_replication_targets.' if logger raise "Missing the required parameter 'compartment_id' when calling list_replication_targets." if compartment_id.nil? raise "Missing the required parameter 'availability_domain' when calling list_replication_targets." if availability_domain.nil? if opts[:lifecycle_state] && !%w[CREATING ACTIVE DELETING DELETED FAILED].include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of CREATING, ACTIVE, DELETING, DELETED, FAILED.' end if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end path = '/replicationTargets' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:availabilityDomain] = availability_domain query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:id] = opts[:id] if opts[:id] 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.(applicable_retry_config(opts), call_name: 'FileStorageClient#list_replication_targets') 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::FileStorage::Models::ReplicationTargetSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_replications(compartment_id, availability_domain, opts = {}) ⇒ Response
Click here to see an example of how to use list_replications API.
Lists the replication resources in the specified compartment.
2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 2972 def list_replications(compartment_id, availability_domain, opts = {}) logger.debug 'Calling operation FileStorageClient#list_replications.' if logger raise "Missing the required parameter 'compartment_id' when calling list_replications." if compartment_id.nil? raise "Missing the required parameter 'availability_domain' when calling list_replications." if availability_domain.nil? if opts[:lifecycle_state] && !%w[CREATING ACTIVE DELETING DELETED FAILED].include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of CREATING, ACTIVE, DELETING, DELETED, FAILED.' end if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end path = '/replications' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:availabilityDomain] = availability_domain query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:id] = opts[:id] if opts[:id] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:fileSystemId] = opts[:file_system_id] if opts[:file_system_id] # 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: 'FileStorageClient#list_replications') 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::FileStorage::Models::ReplicationSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_snapshots(opts = {}) ⇒ Response
Click here to see an example of how to use list_snapshots API.
Lists snapshots of the specified file system, or by file system snapshot policy and compartment, or by file system snapshot policy and file system.
If file system ID is not specified, a file system snapshot policy ID and compartment ID must be specified.
Users can only sort by time created when listing snapshots by file system snapshot policy ID and compartment ID (sort by name is NOT supported for listing snapshots by policy and compartment).
3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 3088 def list_snapshots(opts = {}) logger.debug 'Calling operation FileStorageClient#list_snapshots.' if logger if opts[:lifecycle_state] && !%w[CREATING ACTIVE DELETING DELETED FAILED].include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of CREATING, ACTIVE, DELETING, DELETED, FAILED.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end path = '/snapshots' 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] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:id] = opts[:id] if opts[:id] query_params[:filesystemSnapshotPolicyId] = opts[:filesystem_snapshot_policy_id] if opts[:filesystem_snapshot_policy_id] query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id] query_params[:fileSystemId] = opts[:file_system_id] if opts[:file_system_id] 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.(applicable_retry_config(opts), call_name: 'FileStorageClient#list_snapshots') 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::FileStorage::Models::SnapshotSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
95 96 97 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 95 def logger @api_client.config.logger end |
#pause_filesystem_snapshot_policy(filesystem_snapshot_policy_id, opts = {}) ⇒ Response
Click here to see an example of how to use pause_filesystem_snapshot_policy API.
This operation pauses the scheduled snapshot creation and snapshot deletion of the policy and updates the lifecycle state of the file system snapshot policy from ACTIVE to INACTIVE. When a file system snapshot policy is paused, file systems that are associated with the policy will not have scheduled snapshots created or deleted.
If the policy is already paused, or in the INACTIVE state, you cannot pause it again. You can't pause a policy that is in a DELETING, DELETED, FAILED, CREATING or INACTIVE state; attempts to pause a policy in these states result in a 409 conflict error.
3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 3170 def pause_filesystem_snapshot_policy(filesystem_snapshot_policy_id, opts = {}) logger.debug 'Calling operation FileStorageClient#pause_filesystem_snapshot_policy.' if logger raise "Missing the required parameter 'filesystem_snapshot_policy_id' when calling pause_filesystem_snapshot_policy." if filesystem_snapshot_policy_id.nil? raise "Parameter value for 'filesystem_snapshot_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(filesystem_snapshot_policy_id) path = '/filesystemSnapshotPolicies/{filesystemSnapshotPolicyId}/actions/pause'.sub('{filesystemSnapshotPolicyId}', filesystem_snapshot_policy_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: 'FileStorageClient#pause_filesystem_snapshot_policy') 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::FileStorage::Models::FilesystemSnapshotPolicy' ) end # rubocop:enable Metrics/BlockLength end |
#unpause_filesystem_snapshot_policy(filesystem_snapshot_policy_id, opts = {}) ⇒ Response
Click here to see an example of how to use unpause_filesystem_snapshot_policy API.
This operation unpauses a paused file system snapshot policy and updates the lifecycle state of the file system snapshot policy from INACTIVE to ACTIVE. By default, file system snapshot policies are in the ACTIVE state. When a file system snapshot policy is not paused, or in the ACTIVE state, file systems that are associated with the policy will have snapshots created and deleted according to the schedules defined in the policy.
If the policy is already in the ACTIVE state, you cannot unpause it. You can't unpause a policy that is in a DELETING, DELETED, FAILED, CREATING, or ACTIVE state; attempts to unpause a policy in these states result in a 409 conflict error.
3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 3238 def unpause_filesystem_snapshot_policy(filesystem_snapshot_policy_id, opts = {}) logger.debug 'Calling operation FileStorageClient#unpause_filesystem_snapshot_policy.' if logger raise "Missing the required parameter 'filesystem_snapshot_policy_id' when calling unpause_filesystem_snapshot_policy." if filesystem_snapshot_policy_id.nil? raise "Parameter value for 'filesystem_snapshot_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(filesystem_snapshot_policy_id) path = '/filesystemSnapshotPolicies/{filesystemSnapshotPolicyId}/actions/unpause'.sub('{filesystemSnapshotPolicyId}', filesystem_snapshot_policy_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: 'FileStorageClient#unpause_filesystem_snapshot_policy') 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::FileStorage::Models::FilesystemSnapshotPolicy' ) end # rubocop:enable Metrics/BlockLength end |
#update_export(export_id, update_export_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_export API.
Updates the specified export's information.
3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 3302 def update_export(export_id, update_export_details, opts = {}) logger.debug 'Calling operation FileStorageClient#update_export.' if logger raise "Missing the required parameter 'export_id' when calling update_export." if export_id.nil? raise "Missing the required parameter 'update_export_details' when calling update_export." if update_export_details.nil? raise "Parameter value for 'export_id' must not be blank" if OCI::Internal::Util.blank_string?(export_id) path = '/exports/{exportId}'.sub('{exportId}', export_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_export_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'FileStorageClient#update_export') 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::FileStorage::Models::Export' ) end # rubocop:enable Metrics/BlockLength end |
#update_export_set(export_set_id, update_export_set_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_export_set API.
Updates the specified export set's information.
3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 3367 def update_export_set(export_set_id, update_export_set_details, opts = {}) logger.debug 'Calling operation FileStorageClient#update_export_set.' if logger raise "Missing the required parameter 'export_set_id' when calling update_export_set." if export_set_id.nil? raise "Missing the required parameter 'update_export_set_details' when calling update_export_set." if update_export_set_details.nil? raise "Parameter value for 'export_set_id' must not be blank" if OCI::Internal::Util.blank_string?(export_set_id) path = '/exportSets/{exportSetId}'.sub('{exportSetId}', export_set_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_export_set_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'FileStorageClient#update_export_set') 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::FileStorage::Models::ExportSet' ) end # rubocop:enable Metrics/BlockLength end |
#update_file_system(file_system_id, update_file_system_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_file_system API.
Updates the specified file system's information. You can use this operation to rename a file system.
3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 3434 def update_file_system(file_system_id, update_file_system_details, opts = {}) logger.debug 'Calling operation FileStorageClient#update_file_system.' if logger raise "Missing the required parameter 'file_system_id' when calling update_file_system." if file_system_id.nil? raise "Missing the required parameter 'update_file_system_details' when calling update_file_system." if update_file_system_details.nil? raise "Parameter value for 'file_system_id' must not be blank" if OCI::Internal::Util.blank_string?(file_system_id) path = '/fileSystems/{fileSystemId}'.sub('{fileSystemId}', file_system_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_file_system_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'FileStorageClient#update_file_system') 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::FileStorage::Models::FileSystem' ) end # rubocop:enable Metrics/BlockLength end |
#update_filesystem_snapshot_policy(filesystem_snapshot_policy_id, update_filesystem_snapshot_policy_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_filesystem_snapshot_policy API.
Updates the specified file system snapshot policy's information.
3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 3499 def update_filesystem_snapshot_policy(filesystem_snapshot_policy_id, update_filesystem_snapshot_policy_details, opts = {}) logger.debug 'Calling operation FileStorageClient#update_filesystem_snapshot_policy.' if logger raise "Missing the required parameter 'filesystem_snapshot_policy_id' when calling update_filesystem_snapshot_policy." if filesystem_snapshot_policy_id.nil? raise "Missing the required parameter 'update_filesystem_snapshot_policy_details' when calling update_filesystem_snapshot_policy." if update_filesystem_snapshot_policy_details.nil? raise "Parameter value for 'filesystem_snapshot_policy_id' must not be blank" if OCI::Internal::Util.blank_string?(filesystem_snapshot_policy_id) path = '/filesystemSnapshotPolicies/{filesystemSnapshotPolicyId}'.sub('{filesystemSnapshotPolicyId}', filesystem_snapshot_policy_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_filesystem_snapshot_policy_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'FileStorageClient#update_filesystem_snapshot_policy') 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::FileStorage::Models::FilesystemSnapshotPolicy' ) end # rubocop:enable Metrics/BlockLength end |
#update_mount_target(mount_target_id, update_mount_target_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_mount_target API.
Updates the specified mount target's information.
3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 3564 def update_mount_target(mount_target_id, update_mount_target_details, opts = {}) logger.debug 'Calling operation FileStorageClient#update_mount_target.' if logger raise "Missing the required parameter 'mount_target_id' when calling update_mount_target." if mount_target_id.nil? raise "Missing the required parameter 'update_mount_target_details' when calling update_mount_target." if update_mount_target_details.nil? raise "Parameter value for 'mount_target_id' must not be blank" if OCI::Internal::Util.blank_string?(mount_target_id) path = '/mountTargets/{mountTargetId}'.sub('{mountTargetId}', mount_target_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_mount_target_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'FileStorageClient#update_mount_target') 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::FileStorage::Models::MountTarget' ) end # rubocop:enable Metrics/BlockLength end |
#update_outbound_connector(outbound_connector_id, update_outbound_connector_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_outbound_connector API.
Updates the specified outbound connector's information.
3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 3629 def update_outbound_connector(outbound_connector_id, update_outbound_connector_details, opts = {}) logger.debug 'Calling operation FileStorageClient#update_outbound_connector.' if logger raise "Missing the required parameter 'outbound_connector_id' when calling update_outbound_connector." if outbound_connector_id.nil? raise "Missing the required parameter 'update_outbound_connector_details' when calling update_outbound_connector." if update_outbound_connector_details.nil? raise "Parameter value for 'outbound_connector_id' must not be blank" if OCI::Internal::Util.blank_string?(outbound_connector_id) path = '/outboundConnectors/{outboundConnectorId}'.sub('{outboundConnectorId}', outbound_connector_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_outbound_connector_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'FileStorageClient#update_outbound_connector') 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::FileStorage::Models::OutboundConnector' ) end # rubocop:enable Metrics/BlockLength end |
#update_replication(replication_id, update_replication_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_replication API.
Updates the information for the specified replication and its associated replication target.
3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 3695 def update_replication(replication_id, update_replication_details, opts = {}) logger.debug 'Calling operation FileStorageClient#update_replication.' if logger raise "Missing the required parameter 'replication_id' when calling update_replication." if replication_id.nil? raise "Missing the required parameter 'update_replication_details' when calling update_replication." if update_replication_details.nil? raise "Parameter value for 'replication_id' must not be blank" if OCI::Internal::Util.blank_string?(replication_id) path = '/replications/{replicationId}'.sub('{replicationId}', replication_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_replication_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'FileStorageClient#update_replication') 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::FileStorage::Models::Replication' ) end # rubocop:enable Metrics/BlockLength end |
#update_snapshot(snapshot_id, update_snapshot_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_snapshot API.
Updates the specified snapshot's information.
3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 3760 def update_snapshot(snapshot_id, update_snapshot_details, opts = {}) logger.debug 'Calling operation FileStorageClient#update_snapshot.' if logger raise "Missing the required parameter 'snapshot_id' when calling update_snapshot." if snapshot_id.nil? raise "Missing the required parameter 'update_snapshot_details' when calling update_snapshot." if update_snapshot_details.nil? raise "Parameter value for 'snapshot_id' must not be blank" if OCI::Internal::Util.blank_string?(snapshot_id) path = '/snapshots/{snapshotId}'.sub('{snapshotId}', snapshot_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_snapshot_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'FileStorageClient#update_snapshot') 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::FileStorage::Models::Snapshot' ) end # rubocop:enable Metrics/BlockLength end |
#validate_key_tabs(validate_key_tabs_details, opts = {}) ⇒ Response
Click here to see an example of how to use validate_key_tabs API.
Validates keytab contents for the secret details passed on the request or validte keytab contents associated with the mount target passed in the request. The keytabs are deserialized, the contents are validated for compatibility and the principal, key version number and encryption type of each entry is provided as part of the response.
3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 |
# File 'lib/oci/file_storage/file_storage_client.rb', line 3821 def validate_key_tabs(validate_key_tabs_details, opts = {}) logger.debug 'Calling operation FileStorageClient#validate_key_tabs.' if logger raise "Missing the required parameter 'validate_key_tabs_details' when calling validate_key_tabs." if validate_key_tabs_details.nil? path = '/mountTargets/actions/validateKeyTabs' 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 = @api_client.object_to_http_body(validate_key_tabs_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'FileStorageClient#validate_key_tabs') 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::FileStorage::Models::ValidateKeyTabsResponseDetails' ) end # rubocop:enable Metrics/BlockLength end |