Class: OCI::DataIntegration::DataIntegrationClient
- Inherits:
-
Object
- Object
- OCI::DataIntegration::DataIntegrationClient
- Defined in:
- lib/oci/data_integration/data_integration_client.rb
Overview
Use the Data Integration API to organize your data integration projects, create data flows, pipelines and tasks, and then publish, schedule, and run tasks that extract, transform, and load data. For more information, see Data Integration.
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_compartment(workspace_id, change_compartment_details, opts = {}) ⇒ Response
Moves a workspace to a specified compartment.
-
#change_dis_application_compartment(workspace_id, dis_application_id, change_dis_application_compartment_details, opts = {}) ⇒ Response
Moves a DIS Application to a specified compartment.
-
#create_application(workspace_id, create_application_details, opts = {}) ⇒ Response
Creates an application.
-
#create_application_detailed_description(workspace_id, application_key, create_application_detailed_description_details, opts = {}) ⇒ Response
Creates detailed description for an application.
-
#create_connection(workspace_id, create_connection_details, opts = {}) ⇒ Response
Creates a connection under an existing data asset.
-
#create_connection_validation(workspace_id, create_connection_validation_details, opts = {}) ⇒ Response
Creates a connection validation.
-
#create_copy_object_request(workspace_id, create_copy_object_request_details, opts = {}) ⇒ Response
Copy Metadata Object.
-
#create_data_asset(workspace_id, create_data_asset_details, opts = {}) ⇒ Response
Creates a data asset with default connection.
-
#create_data_flow(workspace_id, create_data_flow_details, opts = {}) ⇒ Response
Creates a new data flow in a project or folder ready for performing data integrations.
-
#create_data_flow_validation(workspace_id, create_data_flow_validation_details, opts = {}) ⇒ Response
Accepts the data flow definition in the request payload and creates a data flow validation.
-
#create_dis_application(workspace_id, create_dis_application_details, opts = {}) ⇒ Response
Creates a DIS Application.
-
#create_dis_application_detailed_description(workspace_id, application_key, create_dis_application_detailed_description_details, opts = {}) ⇒ Response
Creates detailed description for an application.
-
#create_entity_shape(workspace_id, connection_key, schema_resource_name, create_entity_shape_details, opts = {}) ⇒ Response
Creates the data entity shape using the shape from the data asset.
-
#create_export_request(workspace_id, create_export_request_details, opts = {}) ⇒ Response
Export Metadata Object.
-
#create_external_publication(workspace_id, task_key, create_external_publication_details, opts = {}) ⇒ Response
Publish a DataFlow in a OCI DataFlow application.
-
#create_external_publication_validation(workspace_id, task_key, create_external_publication_validation_details, opts = {}) ⇒ Response
Validates a specific task.
-
#create_folder(workspace_id, create_folder_details, opts = {}) ⇒ Response
Creates a folder in a project or in another folder, limited to two levels of folders.
-
#create_function_library(workspace_id, create_function_library_details, opts = {}) ⇒ Response
Creates a function library in a project or in another function library, limited to two levels of function libraries.
-
#create_import_request(workspace_id, create_import_request_details, opts = {}) ⇒ Response
Import Metadata Object.
-
#create_patch(workspace_id, application_key, create_patch_details, opts = {}) ⇒ Response
Creates a patch in an application.
-
#create_pipeline(workspace_id, create_pipeline_details, opts = {}) ⇒ Response
Creates a new pipeline in a project or folder ready for performing task orchestration.
-
#create_pipeline_validation(workspace_id, create_pipeline_validation_details, opts = {}) ⇒ Response
Accepts the data flow definition in the request payload and creates a pipeline validation.
-
#create_project(workspace_id, create_project_details, opts = {}) ⇒ Response
Creates a project.
-
#create_schedule(workspace_id, application_key, create_schedule_details, opts = {}) ⇒ Response
Endpoint to create a new schedule.
-
#create_task(workspace_id, create_task_details, opts = {}) ⇒ Response
Creates a new task ready for performing data integrations.
-
#create_task_run(workspace_id, application_key, create_task_run_details, opts = {}) ⇒ Response
Creates a data integration task run for the specified task.
-
#create_task_schedule(workspace_id, application_key, create_task_schedule_details, opts = {}) ⇒ Response
Endpoint to be used create TaskSchedule.
-
#create_task_validation(workspace_id, create_task_validation_details, opts = {}) ⇒ Response
Validates a specific task.
-
#create_user_defined_function(workspace_id, create_user_defined_function_details, opts = {}) ⇒ Response
Creates a new UserDefinedFunction in a function library ready for performing data integrations.
-
#create_user_defined_function_validation(workspace_id, create_user_defined_function_validation_details, opts = {}) ⇒ Response
Accepts the UserDefinedFunction definition in the request payload and creates a UserDefinedFunction validation.
-
#create_workspace(create_workspace_details, opts = {}) ⇒ Response
Creates a new Data Integration workspace ready for performing data integration tasks.
-
#delete_application(workspace_id, application_key, opts = {}) ⇒ Response
Removes an application using the specified identifier.
-
#delete_application_detailed_description(workspace_id, application_key, opts = {}) ⇒ Response
Deletes detailed description of an Application.
-
#delete_connection(workspace_id, connection_key, opts = {}) ⇒ Response
Removes a connection using the specified identifier.
-
#delete_connection_validation(workspace_id, connection_validation_key, opts = {}) ⇒ Response
Deletes a connection validation.
-
#delete_copy_object_request(workspace_id, copy_object_request_key, opts = {}) ⇒ Response
Delete copy object request using the specified identifier.
-
#delete_data_asset(workspace_id, data_asset_key, opts = {}) ⇒ Response
Removes a data asset using the specified identifier.
-
#delete_data_flow(workspace_id, data_flow_key, opts = {}) ⇒ Response
Removes a data flow from a project or folder using the specified identifier.
-
#delete_data_flow_validation(workspace_id, data_flow_validation_key, opts = {}) ⇒ Response
Removes a data flow validation using the specified identifier.
-
#delete_dis_application(workspace_id, dis_application_id, opts = {}) ⇒ Response
Removes a DIS application using the specified identifier.
-
#delete_dis_application_detailed_description(workspace_id, application_key, opts = {}) ⇒ Response
Deletes detailed description of an Application.
-
#delete_export_request(workspace_id, export_request_key, opts = {}) ⇒ Response
Delete export object request using the specified identifier.
-
#delete_external_publication(workspace_id, task_key, external_publications_key, opts = {}) ⇒ Response
Removes a published object using the specified identifier.
-
#delete_external_publication_validation(workspace_id, task_key, external_publication_validation_key, opts = {}) ⇒ Response
Removes a task validation using the specified identifier.
-
#delete_folder(workspace_id, folder_key, opts = {}) ⇒ Response
Removes a folder from a project using the specified identifier.
-
#delete_function_library(workspace_id, function_library_key, opts = {}) ⇒ Response
Removes a Function Library from a project using the specified identifier.
-
#delete_import_request(import_request_key, workspace_id, opts = {}) ⇒ Response
Delete import object request using the specified identifier.
-
#delete_patch(workspace_id, application_key, patch_key, opts = {}) ⇒ Response
Removes a patch using the specified identifier.
-
#delete_pipeline(workspace_id, pipeline_key, opts = {}) ⇒ Response
Removes a pipeline from a project or folder using the specified identifier.
-
#delete_pipeline_validation(workspace_id, pipeline_validation_key, opts = {}) ⇒ Response
Removes a pipeline validation using the specified identifier.
-
#delete_project(workspace_id, project_key, opts = {}) ⇒ Response
Removes a project from the workspace using the specified identifier.
-
#delete_schedule(workspace_id, application_key, schedule_key, opts = {}) ⇒ Response
Endpoint to delete schedule.
-
#delete_task(workspace_id, task_key, opts = {}) ⇒ Response
Removes a task using the specified identifier.
-
#delete_task_run(workspace_id, application_key, task_run_key, opts = {}) ⇒ Response
Deletes a task run using the specified identifier.
-
#delete_task_schedule(workspace_id, application_key, task_schedule_key, opts = {}) ⇒ Response
Endpoint to delete TaskSchedule.
-
#delete_task_validation(workspace_id, task_validation_key, opts = {}) ⇒ Response
Removes a task validation using the specified identifier.
-
#delete_user_defined_function(workspace_id, user_defined_function_key, opts = {}) ⇒ Response
Removes a UserDefinedFunction from a function library using the specified identifier.
-
#delete_user_defined_function_validation(workspace_id, user_defined_function_validation_key, opts = {}) ⇒ Response
Removes a UserDefinedFunction validation using the specified identifier.
-
#delete_workspace(workspace_id, opts = {}) ⇒ Response
Deletes a Data Integration workspace resource using the specified identifier.
-
#get_application(workspace_id, application_key, opts = {}) ⇒ Response
Retrieves an application using the specified identifier.
-
#get_application_detailed_description(workspace_id, application_key, opts = {}) ⇒ Response
Retrieves detailed description of an Application.
-
#get_composite_state(workspace_id, application_key, aggregator_key, opts = {}) ⇒ Response
This endpoint can be used to get composite state for a given aggregator.
-
#get_connection(workspace_id, connection_key, opts = {}) ⇒ Response
Retrieves the connection details using the specified identifier.
-
#get_connection_validation(workspace_id, connection_validation_key, opts = {}) ⇒ Response
Retrieves a connection validation using the specified identifier.
-
#get_copy_object_request(workspace_id, copy_object_request_key, opts = {}) ⇒ Response
This endpoint can be used to get the summary/details of object being copied.
-
#get_count_statistic(workspace_id, count_statistic_key, opts = {}) ⇒ Response
Retrieves statistics on a workspace.
-
#get_data_asset(workspace_id, data_asset_key, opts = {}) ⇒ Response
Retrieves details of a data asset using the specified identifier.
-
#get_data_entity(workspace_id, connection_key, schema_resource_name, data_entity_key, opts = {}) ⇒ Response
Retrieves the data entity details with the given name from live schema.
-
#get_data_flow(workspace_id, data_flow_key, opts = {}) ⇒ Response
Retrieves a data flow using the specified identifier.
-
#get_data_flow_validation(workspace_id, data_flow_validation_key, opts = {}) ⇒ Response
Retrieves a data flow validation using the specified identifier.
-
#get_dependent_object(workspace_id, application_key, dependent_object_key, opts = {}) ⇒ Response
Retrieves the details of a dependent object from an application.
-
#get_dis_application(workspace_id, dis_application_id, opts = {}) ⇒ Response
Retrieves an application using the specified OCID.
-
#get_dis_application_detailed_description(workspace_id, application_key, opts = {}) ⇒ Response
Retrieves detailed description of an Application.
-
#get_export_request(workspace_id, export_request_key, opts = {}) ⇒ Response
This endpoint can be used to get the summary/details of object being exported.
-
#get_external_publication(workspace_id, task_key, external_publications_key, opts = {}) ⇒ Response
Retrieves a publshed object in an task using the specified identifier.
-
#get_external_publication_validation(workspace_id, task_key, external_publication_validation_key, opts = {}) ⇒ Response
Retrieves an external publication validation using the specified identifier.
-
#get_folder(workspace_id, folder_key, opts = {}) ⇒ Response
Retrieves a folder using the specified identifier.
-
#get_function_library(workspace_id, function_library_key, opts = {}) ⇒ Response
Retrieves a Function Library using the specified identifier.
-
#get_import_request(workspace_id, import_request_key, opts = {}) ⇒ Response
This endpoint can be used to get the summary/details of object being imported.
-
#get_patch(workspace_id, application_key, patch_key, opts = {}) ⇒ Response
Retrieves a patch in an application using the specified identifier.
-
#get_pipeline(workspace_id, pipeline_key, opts = {}) ⇒ Response
Retrieves a pipeline using the specified identifier.
-
#get_pipeline_validation(workspace_id, pipeline_validation_key, opts = {}) ⇒ Response
Retrieves a pipeline validation using the specified identifier.
-
#get_project(workspace_id, project_key, opts = {}) ⇒ Response
Retrieves a project using the specified identifier.
-
#get_published_object(workspace_id, application_key, published_object_key, opts = {}) ⇒ Response
Retrieves the details of a published object from an application.
-
#get_reference(workspace_id, application_key, reference_key, opts = {}) ⇒ Response
Retrieves a reference in an application.
-
#get_runtime_operator(workspace_id, application_key, runtime_pipeline_key, runtime_operator_key, opts = {}) ⇒ Response
Retrieves a runtime operator using the specified identifier.
-
#get_runtime_pipeline(workspace_id, application_key, runtime_pipeline_key, opts = {}) ⇒ Response
Retrieves a runtime pipeline using the specified identifier.
-
#get_schedule(workspace_id, application_key, schedule_key, opts = {}) ⇒ Response
Retrieves schedule by schedule key.
-
#get_schema(workspace_id, connection_key, schema_resource_name, opts = {}) ⇒ Response
Retrieves a schema that can be accessed using the specified connection.
-
#get_task(workspace_id, task_key, opts = {}) ⇒ Response
Retrieves a task using the specified identifier.
-
#get_task_run(workspace_id, application_key, task_run_key, opts = {}) ⇒ Response
Retrieves a task run using the specified identifier.
-
#get_task_schedule(workspace_id, application_key, task_schedule_key, opts = {}) ⇒ Response
Endpoint used to get taskSchedule by its key.
-
#get_task_validation(workspace_id, task_validation_key, opts = {}) ⇒ Response
Retrieves a task validation using the specified identifier.
-
#get_template(workspace_id, template_id, opts = {}) ⇒ Response
This endpoint can be used to get an application template using a key.
-
#get_user_defined_function(workspace_id, user_defined_function_key, opts = {}) ⇒ Response
Retrieves a UserDefinedFunction using the specified identifier.
-
#get_user_defined_function_validation(workspace_id, user_defined_function_validation_key, opts = {}) ⇒ Response
Retrieves a UserDefinedFunction validation using the specified identifier.
-
#get_work_request(work_request_id, opts = {}) ⇒ Response
Retrieves the status of the work request with the given ID.
-
#get_workspace(workspace_id, opts = {}) ⇒ Response
Retrieves a Data Integration workspace using the specified identifier.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ DataIntegrationClient
constructor
Creates a new DataIntegrationClient.
-
#list_applications(workspace_id, opts = {}) ⇒ Response
Retrieves a list of applications and provides options to filter the list.
-
#list_connection_validations(workspace_id, opts = {}) ⇒ Response
Retrieves a list of connection validations within the specified workspace.
-
#list_connections(workspace_id, data_asset_key, opts = {}) ⇒ Response
Retrieves a list of all connections.
-
#list_copy_object_requests(workspace_id, opts = {}) ⇒ Response
This endpoint can be used to get the list of copy object requests.
-
#list_data_assets(workspace_id, opts = {}) ⇒ Response
Retrieves a list of all data asset summaries.
-
#list_data_entities(workspace_id, connection_key, schema_resource_name, opts = {}) ⇒ Response
Lists a summary of data entities from the data asset using the specified connection.
-
#list_data_flow_validations(workspace_id, opts = {}) ⇒ Response
Retrieves a list of data flow validations within the specified workspace.
-
#list_data_flows(workspace_id, opts = {}) ⇒ Response
Retrieves a list of data flows in a project or folder.
-
#list_dependent_objects(workspace_id, application_key, opts = {}) ⇒ Response
Retrieves a list of all dependent objects for a specific application.
-
#list_dis_application_task_run_lineages(workspace_id, dis_application_id, opts = {}) ⇒ Response
This endpoint can be used to list Task Run Lineages within a given time window.
-
#list_dis_applications(workspace_id, compartment_id, opts = {}) ⇒ Response
Retrieves a list of DIS Applications in a compartment and provides options to filter the list.
-
#list_export_requests(workspace_id, opts = {}) ⇒ Response
This endpoint can be used to get the list of export object requests.
-
#list_external_publication_validations(workspace_id, task_key, opts = {}) ⇒ Response
Retrieves a lists of external publication validations in a workspace and provides options to filter the list.
-
#list_external_publications(workspace_id, task_key, opts = {}) ⇒ Response
Retrieves a list of external publications in an application and provides options to filter the list.
-
#list_folders(workspace_id, opts = {}) ⇒ Response
Retrieves a list of folders in a project and provides options to filter the list.
-
#list_function_libraries(workspace_id, opts = {}) ⇒ Response
Retrieves a list of function libraries in a project and provides options to filter the list.
-
#list_import_requests(workspace_id, opts = {}) ⇒ Response
This endpoint can be used to get the list of import object requests.
-
#list_patch_changes(workspace_id, application_key, opts = {}) ⇒ Response
Retrieves a list of patches in an application and provides options to filter the list.
-
#list_patches(workspace_id, application_key, opts = {}) ⇒ Response
Retrieves a list of patches in an application and provides options to filter the list.
-
#list_pipeline_validations(workspace_id, opts = {}) ⇒ Response
Retrieves a list of pipeline validations within the specified workspace.
-
#list_pipelines(workspace_id, opts = {}) ⇒ Response
Retrieves a list of pipelines in a project or folder from within a workspace, the query parameter specifies the project or folder.
-
#list_projects(workspace_id, opts = {}) ⇒ Response
Retrieves a lists of projects in a workspace and provides options to filter the list.
-
#list_published_objects(workspace_id, application_key, opts = {}) ⇒ Response
Retrieves a list of all the published objects for a specified application.
-
#list_references(workspace_id, application_key, opts = {}) ⇒ Response
Retrieves a list of references in an application.
-
#list_runtime_operators(workspace_id, application_key, runtime_pipeline_key, opts = {}) ⇒ Response
This endpoint can be used to list runtime operators with filtering options.
-
#list_runtime_pipelines(workspace_id, application_key, opts = {}) ⇒ Response
This endpoint can be used to list runtime pipelines with filtering options.
-
#list_schedules(workspace_id, application_key, opts = {}) ⇒ Response
Use this endpoint to list schedules.
-
#list_schemas(workspace_id, connection_key, schema_resource_name, opts = {}) ⇒ Response
Retrieves a list of all the schemas that can be accessed using the specified connection.
-
#list_task_run_lineages(workspace_id, application_key, opts = {}) ⇒ Response
This endpoint can be used to list Task Run Lineages within a given time window.
-
#list_task_run_logs(workspace_id, application_key, task_run_key, opts = {}) ⇒ Response
Gets log entries for task runs using its key.
-
#list_task_runs(workspace_id, application_key, opts = {}) ⇒ Response
Retrieves a list of task runs and provides options to filter the list.
-
#list_task_schedules(workspace_id, application_key, opts = {}) ⇒ Response
This endpoint can be used to get the list of all the TaskSchedule objects.
-
#list_task_validations(workspace_id, opts = {}) ⇒ Response
Retrieves a list of task validations within the specified workspace.
-
#list_tasks(workspace_id, opts = {}) ⇒ Response
Retrieves a list of all tasks in a specified project or folder.
-
#list_templates(workspace_id, opts = {}) ⇒ Response
This endpoint can be used to list application templates with filtering options.
-
#list_user_defined_function_validations(workspace_id, opts = {}) ⇒ Response
Retrieves a list of UserDefinedFunctionvalidations within the specified workspace.
-
#list_user_defined_functions(workspace_id, opts = {}) ⇒ Response
Retrieves a list of UserDefinedFunctions in a function library.
-
#list_work_request_errors(work_request_id, opts = {}) ⇒ Response
Retrieves a paginated list of errors for a given work request.
-
#list_work_request_logs(work_request_id, opts = {}) ⇒ Response
Retrieves a paginated list of logs for a given work request.
-
#list_work_requests(compartment_id, opts = {}) ⇒ Response
Lists the work requests in a compartment.
-
#list_workspaces(compartment_id, opts = {}) ⇒ Response
Retrieves a list of Data Integration workspaces.
-
#logger ⇒ Logger
The logger for this client.
-
#start_workspace(workspace_id, opts = {}) ⇒ Response
Starts a workspace.
-
#stop_workspace(workspace_id, opts = {}) ⇒ Response
Stops a workspace.
-
#update_application(workspace_id, application_key, update_application_details, opts = {}) ⇒ Response
Updates an application.
-
#update_application_detailed_description(workspace_id, application_key, update_application_detailed_description_details, opts = {}) ⇒ Response
Updates the detailed description of an Application.
-
#update_connection(workspace_id, connection_key, update_connection_details, opts = {}) ⇒ Response
Updates a connection under a data asset.
-
#update_copy_object_request(workspace_id, copy_object_request_key, update_copy_object_request_details, opts = {}) ⇒ Response
Updates the status of a copy object request.
-
#update_data_asset(workspace_id, data_asset_key, update_data_asset_details, opts = {}) ⇒ Response
Updates a specific data asset with default connection.
-
#update_data_flow(workspace_id, data_flow_key, update_data_flow_details, opts = {}) ⇒ Response
Updates a specific data flow.
-
#update_dis_application(workspace_id, dis_application_id, update_dis_application_details, opts = {}) ⇒ Response
Updates a DIS Application.
-
#update_dis_application_detailed_description(workspace_id, application_key, update_dis_application_detailed_description_details, opts = {}) ⇒ Response
Updates the detailed description of an Application.
-
#update_export_request(workspace_id, export_request_key, update_export_request_details, opts = {}) ⇒ Response
Updates the status of a export object request.
-
#update_external_publication(workspace_id, task_key, external_publications_key, update_external_publication_details, opts = {}) ⇒ Response
Updates the external publication object.
-
#update_folder(workspace_id, folder_key, update_folder_details, opts = {}) ⇒ Response
Updates a specific folder.
-
#update_function_library(workspace_id, function_library_key, update_function_library_details, opts = {}) ⇒ Response
Updates a specific Function Library.
-
#update_import_request(workspace_id, import_request_key, update_import_request_details, opts = {}) ⇒ Response
Updates the status of a import object request.
-
#update_pipeline(workspace_id, pipeline_key, update_pipeline_details, opts = {}) ⇒ Response
Updates a specific pipeline.
-
#update_project(workspace_id, project_key, update_project_details, opts = {}) ⇒ Response
Updates a specific project.
-
#update_reference(workspace_id, application_key, reference_key, update_reference_details, opts = {}) ⇒ Response
Updates the application references.
-
#update_schedule(workspace_id, application_key, schedule_key, update_schedule_details, opts = {}) ⇒ Response
Endpoint used to update the schedule.
-
#update_task(workspace_id, task_key, update_task_details, opts = {}) ⇒ Response
Updates a specific task.
-
#update_task_run(workspace_id, application_key, task_run_key, update_task_run_details, opts = {}) ⇒ Response
Updates the status of the task run.
-
#update_task_schedule(workspace_id, application_key, task_schedule_key, update_task_schedule_details, opts = {}) ⇒ Response
Endpoint used to update the TaskSchedule.
-
#update_user_defined_function(workspace_id, user_defined_function_key, update_user_defined_function_details, opts = {}) ⇒ Response
Updates a specific UserDefinedFunction.
-
#update_workspace(workspace_id, update_workspace_details, opts = {}) ⇒ Response
Updates the specified Data Integration workspace.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ DataIntegrationClient
Creates a new DataIntegrationClient. Notes: If a config is not specified, then the global OCI.config will be used.
This client is not thread-safe
Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 55 def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers) # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then # pass it to this constructor. # # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid # so try and load the config from the default file. config = OCI::Config.validate_and_build_config_with_signer(config, signer) signer = OCI::Signer.config_file_auth_builder(config) if signer.nil? @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings) @retry_config = retry_config if endpoint @endpoint = endpoint + '/20200430' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "DataIntegrationClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
15 16 17 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 15 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
19 20 21 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 19 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
29 30 31 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 29 def region @region end |
#retry_config ⇒ OCI::Retry::RetryConfig (readonly)
The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is nil
, which means that an operation will not perform any retries
25 26 27 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 25 def retry_config @retry_config end |
Instance Method Details
#change_compartment(workspace_id, change_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_compartment API.
Moves a workspace to a specified 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 160 161 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 122 def change_compartment(workspace_id, change_compartment_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#change_compartment.' if logger raise "Missing the required parameter 'workspace_id' when calling change_compartment." if workspace_id.nil? raise "Missing the required parameter 'change_compartment_details' when calling change_compartment." if change_compartment_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/actions/changeCompartment'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#change_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_dis_application_compartment(workspace_id, dis_application_id, change_dis_application_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_dis_application_compartment API.
Moves a DIS Application to a specified compartment.
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 225 226 227 228 229 230 231 232 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 191 def change_dis_application_compartment(workspace_id, dis_application_id, change_dis_application_compartment_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#change_dis_application_compartment.' if logger raise "Missing the required parameter 'workspace_id' when calling change_dis_application_compartment." if workspace_id.nil? raise "Missing the required parameter 'dis_application_id' when calling change_dis_application_compartment." if dis_application_id.nil? raise "Missing the required parameter 'change_dis_application_compartment_details' when calling change_dis_application_compartment." if change_dis_application_compartment_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'dis_application_id' must not be blank" if OCI::Internal::Util.blank_string?(dis_application_id) path = '/workspaces/{workspaceId}/disApplications/{disApplicationId}/actions/changeCompartment'.sub('{workspaceId}', workspace_id.to_s).sub('{disApplicationId}', dis_application_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_dis_application_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#change_dis_application_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_application(workspace_id, create_application_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_application API.
Creates an application.
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 257 def create_application(workspace_id, create_application_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#create_application.' if logger raise "Missing the required parameter 'workspace_id' when calling create_application." if workspace_id.nil? raise "Missing the required parameter 'create_application_details' when calling create_application." if create_application_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/applications'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_application_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#create_application') 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::DataIntegration::Models::Application' ) end # rubocop:enable Metrics/BlockLength end |
#create_application_detailed_description(workspace_id, application_key, create_application_detailed_description_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_application_detailed_description API.
Creates detailed description for an application.
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 357 358 359 360 361 362 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 321 def create_application_detailed_description(workspace_id, application_key, create_application_detailed_description_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#create_application_detailed_description.' if logger raise "Missing the required parameter 'workspace_id' when calling create_application_detailed_description." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling create_application_detailed_description." if application_key.nil? raise "Missing the required parameter 'create_application_detailed_description_details' when calling create_application_detailed_description." if create_application_detailed_description_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/detailedDescription'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_application_detailed_description_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#create_application_detailed_description') 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::DataIntegration::Models::DetailedDescription' ) end # rubocop:enable Metrics/BlockLength end |
#create_connection(workspace_id, create_connection_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_connection API.
Creates a connection under an existing data asset.
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 423 424 425 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 386 def create_connection(workspace_id, create_connection_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#create_connection.' if logger raise "Missing the required parameter 'workspace_id' when calling create_connection." if workspace_id.nil? raise "Missing the required parameter 'create_connection_details' when calling create_connection." if create_connection_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/connections'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_connection_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#create_connection') 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::DataIntegration::Models::Connection' ) end # rubocop:enable Metrics/BlockLength end |
#create_connection_validation(workspace_id, create_connection_validation_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_connection_validation API.
Creates a connection validation.
449 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 488 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 449 def create_connection_validation(workspace_id, create_connection_validation_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#create_connection_validation.' if logger raise "Missing the required parameter 'workspace_id' when calling create_connection_validation." if workspace_id.nil? raise "Missing the required parameter 'create_connection_validation_details' when calling create_connection_validation." if create_connection_validation_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/connectionValidations'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_connection_validation_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#create_connection_validation') 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::DataIntegration::Models::ConnectionValidation' ) end # rubocop:enable Metrics/BlockLength end |
#create_copy_object_request(workspace_id, create_copy_object_request_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_copy_object_request API.
Copy Metadata Object.
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 513 def create_copy_object_request(workspace_id, create_copy_object_request_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#create_copy_object_request.' if logger raise "Missing the required parameter 'workspace_id' when calling create_copy_object_request." if workspace_id.nil? raise "Missing the required parameter 'create_copy_object_request_details' when calling create_copy_object_request." if create_copy_object_request_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/copyObjectRequests'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_copy_object_request_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#create_copy_object_request') 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::DataIntegration::Models::CopyObjectRequest' ) end # rubocop:enable Metrics/BlockLength end |
#create_data_asset(workspace_id, create_data_asset_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_data_asset API.
Creates a data asset with default connection.
576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 576 def create_data_asset(workspace_id, create_data_asset_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#create_data_asset.' if logger raise "Missing the required parameter 'workspace_id' when calling create_data_asset." if workspace_id.nil? raise "Missing the required parameter 'create_data_asset_details' when calling create_data_asset." if create_data_asset_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/dataAssets'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_data_asset_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#create_data_asset') 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::DataIntegration::Models::DataAsset' ) end # rubocop:enable Metrics/BlockLength end |
#create_data_flow(workspace_id, create_data_flow_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_data_flow API.
Creates a new data flow in a project or folder ready for performing data integrations.
640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 640 def create_data_flow(workspace_id, create_data_flow_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#create_data_flow.' if logger raise "Missing the required parameter 'workspace_id' when calling create_data_flow." if workspace_id.nil? raise "Missing the required parameter 'create_data_flow_details' when calling create_data_flow." if create_data_flow_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/dataFlows'.sub('{workspaceId}', workspace_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-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_data_flow_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#create_data_flow') 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::DataIntegration::Models::DataFlow' ) end # rubocop:enable Metrics/BlockLength end |
#create_data_flow_validation(workspace_id, create_data_flow_validation_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_data_flow_validation API.
Accepts the data flow definition in the request payload and creates a data flow validation.
704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 704 def create_data_flow_validation(workspace_id, create_data_flow_validation_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#create_data_flow_validation.' if logger raise "Missing the required parameter 'workspace_id' when calling create_data_flow_validation." if workspace_id.nil? raise "Missing the required parameter 'create_data_flow_validation_details' when calling create_data_flow_validation." if create_data_flow_validation_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/dataFlowValidations'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_data_flow_validation_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#create_data_flow_validation') 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::DataIntegration::Models::DataFlowValidation' ) end # rubocop:enable Metrics/BlockLength end |
#create_dis_application(workspace_id, create_dis_application_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_dis_application API.
Creates a DIS Application.
768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 768 def create_dis_application(workspace_id, create_dis_application_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#create_dis_application.' if logger raise "Missing the required parameter 'workspace_id' when calling create_dis_application." if workspace_id.nil? raise "Missing the required parameter 'create_dis_application_details' when calling create_dis_application." if create_dis_application_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/disApplications'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_dis_application_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#create_dis_application') 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::DataIntegration::Models::DisApplication' ) end # rubocop:enable Metrics/BlockLength end |
#create_dis_application_detailed_description(workspace_id, application_key, create_dis_application_detailed_description_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_dis_application_detailed_description API.
Creates detailed description for an application.
832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 832 def create_dis_application_detailed_description(workspace_id, application_key, create_dis_application_detailed_description_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#create_dis_application_detailed_description.' if logger raise "Missing the required parameter 'workspace_id' when calling create_dis_application_detailed_description." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling create_dis_application_detailed_description." if application_key.nil? raise "Missing the required parameter 'create_dis_application_detailed_description_details' when calling create_dis_application_detailed_description." if create_dis_application_detailed_description_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) path = '/workspaces/{workspaceId}/disApplications/{applicationKey}/detailedDescription'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_dis_application_detailed_description_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#create_dis_application_detailed_description') 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::DataIntegration::Models::DetailedDescription' ) end # rubocop:enable Metrics/BlockLength end |
#create_entity_shape(workspace_id, connection_key, schema_resource_name, create_entity_shape_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_entity_shape API.
Creates the data entity shape using the shape from the data asset.
903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 903 def create_entity_shape(workspace_id, connection_key, schema_resource_name, create_entity_shape_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#create_entity_shape.' if logger raise "Missing the required parameter 'workspace_id' when calling create_entity_shape." if workspace_id.nil? raise "Missing the required parameter 'connection_key' when calling create_entity_shape." if connection_key.nil? raise "Missing the required parameter 'schema_resource_name' when calling create_entity_shape." if schema_resource_name.nil? raise "Missing the required parameter 'create_entity_shape_details' when calling create_entity_shape." if create_entity_shape_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'connection_key' must not be blank" if OCI::Internal::Util.blank_string?(connection_key) raise "Parameter value for 'schema_resource_name' must not be blank" if OCI::Internal::Util.blank_string?(schema_resource_name) path = '/workspaces/{workspaceId}/connections/{connectionKey}/schemas/{schemaResourceName}/entityShapes'.sub('{workspaceId}', workspace_id.to_s).sub('{connectionKey}', connection_key.to_s).sub('{schemaResourceName}', schema_resource_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_entity_shape_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#create_entity_shape') 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::DataIntegration::Models::EntityShape' ) end # rubocop:enable Metrics/BlockLength end |
#create_export_request(workspace_id, create_export_request_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_export_request API.
Export Metadata Object
971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 971 def create_export_request(workspace_id, create_export_request_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#create_export_request.' if logger raise "Missing the required parameter 'workspace_id' when calling create_export_request." if workspace_id.nil? raise "Missing the required parameter 'create_export_request_details' when calling create_export_request." if create_export_request_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/exportRequests'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_export_request_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#create_export_request') 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::DataIntegration::Models::ExportRequest' ) end # rubocop:enable Metrics/BlockLength end |
#create_external_publication(workspace_id, task_key, create_external_publication_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_external_publication API.
Publish a DataFlow in a OCI DataFlow application.
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 1035 def create_external_publication(workspace_id, task_key, create_external_publication_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#create_external_publication.' if logger raise "Missing the required parameter 'workspace_id' when calling create_external_publication." if workspace_id.nil? raise "Missing the required parameter 'task_key' when calling create_external_publication." if task_key.nil? raise "Missing the required parameter 'create_external_publication_details' when calling create_external_publication." if create_external_publication_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'task_key' must not be blank" if OCI::Internal::Util.blank_string?(task_key) path = '/workspaces/{workspaceId}/tasks/{taskKey}/externalPublications'.sub('{workspaceId}', workspace_id.to_s).sub('{taskKey}', task_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_external_publication_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#create_external_publication') 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::DataIntegration::Models::ExternalPublication' ) end # rubocop:enable Metrics/BlockLength end |
#create_external_publication_validation(workspace_id, task_key, create_external_publication_validation_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_external_publication_validation API.
Validates a specific task.
1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 1101 def create_external_publication_validation(workspace_id, task_key, create_external_publication_validation_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#create_external_publication_validation.' if logger raise "Missing the required parameter 'workspace_id' when calling create_external_publication_validation." if workspace_id.nil? raise "Missing the required parameter 'task_key' when calling create_external_publication_validation." if task_key.nil? raise "Missing the required parameter 'create_external_publication_validation_details' when calling create_external_publication_validation." if create_external_publication_validation_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'task_key' must not be blank" if OCI::Internal::Util.blank_string?(task_key) path = '/workspaces/{workspaceId}/tasks/{taskKey}/externalPublicationValidations'.sub('{workspaceId}', workspace_id.to_s).sub('{taskKey}', task_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_external_publication_validation_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#create_external_publication_validation') 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::DataIntegration::Models::ExternalPublicationValidation' ) end # rubocop:enable Metrics/BlockLength end |
#create_folder(workspace_id, create_folder_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_folder API.
Creates a folder in a project or in another folder, limited to two levels of folders. | Folders are used to organize your design-time resources, such as tasks or data flows.
1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 1168 def create_folder(workspace_id, create_folder_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#create_folder.' if logger raise "Missing the required parameter 'workspace_id' when calling create_folder." if workspace_id.nil? raise "Missing the required parameter 'create_folder_details' when calling create_folder." if create_folder_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/folders'.sub('{workspaceId}', workspace_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-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_folder_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#create_folder') 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::DataIntegration::Models::Folder' ) end # rubocop:enable Metrics/BlockLength end |
#create_function_library(workspace_id, create_function_library_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_function_library API.
Creates a function library in a project or in another function library, limited to two levels of function libraries. | FunctionLibraries are used to organize your design-time resources, such as tasks or data flows.
1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 1233 def create_function_library(workspace_id, create_function_library_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#create_function_library.' if logger raise "Missing the required parameter 'workspace_id' when calling create_function_library." if workspace_id.nil? raise "Missing the required parameter 'create_function_library_details' when calling create_function_library." if create_function_library_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/functionLibraries'.sub('{workspaceId}', workspace_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-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_function_library_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#create_function_library') 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::DataIntegration::Models::FunctionLibrary' ) end # rubocop:enable Metrics/BlockLength end |
#create_import_request(workspace_id, create_import_request_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_import_request API.
Import Metadata Object
1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 1296 def create_import_request(workspace_id, create_import_request_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#create_import_request.' if logger raise "Missing the required parameter 'workspace_id' when calling create_import_request." if workspace_id.nil? raise "Missing the required parameter 'create_import_request_details' when calling create_import_request." if create_import_request_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/importRequests'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_import_request_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#create_import_request') 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::DataIntegration::Models::ImportRequest' ) end # rubocop:enable Metrics/BlockLength end |
#create_patch(workspace_id, application_key, create_patch_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_patch API.
Creates a patch in an application.
1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 1360 def create_patch(workspace_id, application_key, create_patch_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#create_patch.' if logger raise "Missing the required parameter 'workspace_id' when calling create_patch." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling create_patch." if application_key.nil? raise "Missing the required parameter 'create_patch_details' when calling create_patch." if create_patch_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/patches'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_patch_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#create_patch') 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::DataIntegration::Models::Patch' ) end # rubocop:enable Metrics/BlockLength end |
#create_pipeline(workspace_id, create_pipeline_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_pipeline API.
Creates a new pipeline in a project or folder ready for performing task orchestration.
1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 1426 def create_pipeline(workspace_id, create_pipeline_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#create_pipeline.' if logger raise "Missing the required parameter 'workspace_id' when calling create_pipeline." if workspace_id.nil? raise "Missing the required parameter 'create_pipeline_details' when calling create_pipeline." if create_pipeline_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/pipelines'.sub('{workspaceId}', workspace_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-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_pipeline_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#create_pipeline') 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::DataIntegration::Models::Pipeline' ) end # rubocop:enable Metrics/BlockLength end |
#create_pipeline_validation(workspace_id, create_pipeline_validation_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_pipeline_validation API.
Accepts the data flow definition in the request payload and creates a pipeline validation.
1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 1490 def create_pipeline_validation(workspace_id, create_pipeline_validation_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#create_pipeline_validation.' if logger raise "Missing the required parameter 'workspace_id' when calling create_pipeline_validation." if workspace_id.nil? raise "Missing the required parameter 'create_pipeline_validation_details' when calling create_pipeline_validation." if create_pipeline_validation_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/pipelineValidations'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_pipeline_validation_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#create_pipeline_validation') 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::DataIntegration::Models::PipelineValidation' ) end # rubocop:enable Metrics/BlockLength end |
#create_project(workspace_id, create_project_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_project API.
Creates a project. Projects are organizational constructs within a workspace that you use to organize your design-time resources, such as tasks or data flows. Projects can be organized into folders.
1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 1554 def create_project(workspace_id, create_project_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#create_project.' if logger raise "Missing the required parameter 'workspace_id' when calling create_project." if workspace_id.nil? raise "Missing the required parameter 'create_project_details' when calling create_project." if create_project_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/projects'.sub('{workspaceId}', workspace_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-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_project_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#create_project') 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::DataIntegration::Models::Project' ) end # rubocop:enable Metrics/BlockLength end |
#create_schedule(workspace_id, application_key, create_schedule_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_schedule API.
Endpoint to create a new schedule
1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 1618 def create_schedule(workspace_id, application_key, create_schedule_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#create_schedule.' if logger raise "Missing the required parameter 'workspace_id' when calling create_schedule." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling create_schedule." if application_key.nil? raise "Missing the required parameter 'create_schedule_details' when calling create_schedule." if create_schedule_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/schedules'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_schedule_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#create_schedule') 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::DataIntegration::Models::Schedule' ) end # rubocop:enable Metrics/BlockLength end |
#create_task(workspace_id, create_task_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_task API.
Creates a new task ready for performing data integrations. There are specialized types of tasks that include data loader and integration tasks.
1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 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 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 1684 def create_task(workspace_id, create_task_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#create_task.' if logger raise "Missing the required parameter 'workspace_id' when calling create_task." if workspace_id.nil? raise "Missing the required parameter 'create_task_details' when calling create_task." if create_task_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/tasks'.sub('{workspaceId}', workspace_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-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_task_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#create_task') 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::DataIntegration::Models::Task' ) end # rubocop:enable Metrics/BlockLength end |
#create_task_run(workspace_id, application_key, create_task_run_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_task_run API.
Creates a data integration task run for the specified task.
1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 1748 def create_task_run(workspace_id, application_key, create_task_run_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#create_task_run.' if logger raise "Missing the required parameter 'workspace_id' when calling create_task_run." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling create_task_run." if application_key.nil? raise "Missing the required parameter 'create_task_run_details' when calling create_task_run." if create_task_run_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/taskRuns'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'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_task_run_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#create_task_run') 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::DataIntegration::Models::TaskRun' ) end # rubocop:enable Metrics/BlockLength end |
#create_task_schedule(workspace_id, application_key, create_task_schedule_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_task_schedule API.
Endpoint to be used create TaskSchedule.
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 1848 1849 1850 1851 1852 1853 1854 1855 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 1814 def create_task_schedule(workspace_id, application_key, create_task_schedule_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#create_task_schedule.' if logger raise "Missing the required parameter 'workspace_id' when calling create_task_schedule." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling create_task_schedule." if application_key.nil? raise "Missing the required parameter 'create_task_schedule_details' when calling create_task_schedule." if create_task_schedule_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/taskSchedules'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_task_schedule_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#create_task_schedule') 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::DataIntegration::Models::TaskSchedule' ) end # rubocop:enable Metrics/BlockLength end |
#create_task_validation(workspace_id, create_task_validation_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_task_validation API.
Validates a specific task.
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 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 1879 def create_task_validation(workspace_id, create_task_validation_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#create_task_validation.' if logger raise "Missing the required parameter 'workspace_id' when calling create_task_validation." if workspace_id.nil? raise "Missing the required parameter 'create_task_validation_details' when calling create_task_validation." if create_task_validation_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/taskValidations'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_task_validation_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#create_task_validation') 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::DataIntegration::Models::TaskValidation' ) end # rubocop:enable Metrics/BlockLength end |
#create_user_defined_function(workspace_id, create_user_defined_function_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_user_defined_function API.
Creates a new UserDefinedFunction in a function library ready for performing data integrations.
1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 1943 def create_user_defined_function(workspace_id, create_user_defined_function_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#create_user_defined_function.' if logger raise "Missing the required parameter 'workspace_id' when calling create_user_defined_function." if workspace_id.nil? raise "Missing the required parameter 'create_user_defined_function_details' when calling create_user_defined_function." if create_user_defined_function_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/userDefinedFunctions'.sub('{workspaceId}', workspace_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-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_user_defined_function_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#create_user_defined_function') 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::DataIntegration::Models::UserDefinedFunction' ) end # rubocop:enable Metrics/BlockLength end |
#create_user_defined_function_validation(workspace_id, create_user_defined_function_validation_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_user_defined_function_validation API.
Accepts the UserDefinedFunction definition in the request payload and creates a UserDefinedFunction validation.
2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 2007 def create_user_defined_function_validation(workspace_id, create_user_defined_function_validation_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#create_user_defined_function_validation.' if logger raise "Missing the required parameter 'workspace_id' when calling create_user_defined_function_validation." if workspace_id.nil? raise "Missing the required parameter 'create_user_defined_function_validation_details' when calling create_user_defined_function_validation." if create_user_defined_function_validation_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/userDefinedFunctionValidations'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_user_defined_function_validation_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#create_user_defined_function_validation') 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::DataIntegration::Models::UserDefinedFunctionValidation' ) end # rubocop:enable Metrics/BlockLength end |
#create_workspace(create_workspace_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_workspace API.
Creates a new Data Integration workspace ready for performing data integration tasks. To retrieve the OCID for the new workspace, use the opc-work-request-id returned by this API and call the get_work_request API.
2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 2070 def create_workspace(create_workspace_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#create_workspace.' if logger raise "Missing the required parameter 'create_workspace_details' when calling create_workspace." if create_workspace_details.nil? path = '/workspaces' 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_workspace_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#create_workspace') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_application(workspace_id, application_key, opts = {}) ⇒ Response
Click here to see an example of how to use delete_application API.
Removes an application using the specified identifier.
2132 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 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 2132 def delete_application(workspace_id, application_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#delete_application.' if logger raise "Missing the required parameter 'workspace_id' when calling delete_application." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling delete_application." if application_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#delete_application') 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_application_detailed_description(workspace_id, application_key, opts = {}) ⇒ Response
Click here to see an example of how to use delete_application_detailed_description API.
Deletes detailed description of an Application.
2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 2196 def delete_application_detailed_description(workspace_id, application_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#delete_application_detailed_description.' if logger raise "Missing the required parameter 'workspace_id' when calling delete_application_detailed_description." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling delete_application_detailed_description." if application_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/detailedDescription'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#delete_application_detailed_description') 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_connection(workspace_id, connection_key, opts = {}) ⇒ Response
Click here to see an example of how to use delete_connection API.
Removes a connection using the specified identifier.
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 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 2260 def delete_connection(workspace_id, connection_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#delete_connection.' if logger raise "Missing the required parameter 'workspace_id' when calling delete_connection." if workspace_id.nil? raise "Missing the required parameter 'connection_key' when calling delete_connection." if connection_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'connection_key' must not be blank" if OCI::Internal::Util.blank_string?(connection_key) path = '/workspaces/{workspaceId}/connections/{connectionKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{connectionKey}', connection_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#delete_connection') 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_connection_validation(workspace_id, connection_validation_key, opts = {}) ⇒ Response
Click here to see an example of how to use delete_connection_validation API.
Deletes a connection validation.
2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 2324 def delete_connection_validation(workspace_id, connection_validation_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#delete_connection_validation.' if logger raise "Missing the required parameter 'workspace_id' when calling delete_connection_validation." if workspace_id.nil? raise "Missing the required parameter 'connection_validation_key' when calling delete_connection_validation." if connection_validation_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'connection_validation_key' must not be blank" if OCI::Internal::Util.blank_string?(connection_validation_key) path = '/workspaces/{workspaceId}/connectionValidations/{connectionValidationKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{connectionValidationKey}', connection_validation_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#delete_connection_validation') 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_copy_object_request(workspace_id, copy_object_request_key, opts = {}) ⇒ Response
Click here to see an example of how to use delete_copy_object_request API.
Delete copy object request using the specified identifier.
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 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 2388 def delete_copy_object_request(workspace_id, copy_object_request_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#delete_copy_object_request.' if logger raise "Missing the required parameter 'workspace_id' when calling delete_copy_object_request." if workspace_id.nil? raise "Missing the required parameter 'copy_object_request_key' when calling delete_copy_object_request." if copy_object_request_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'copy_object_request_key' must not be blank" if OCI::Internal::Util.blank_string?(copy_object_request_key) path = '/workspaces/{workspaceId}/copyObjectRequests/{copyObjectRequestKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{copyObjectRequestKey}', copy_object_request_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#delete_copy_object_request') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_data_asset(workspace_id, data_asset_key, opts = {}) ⇒ Response
Click here to see an example of how to use delete_data_asset API.
Removes a data asset using the specified identifier.
2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 2452 def delete_data_asset(workspace_id, data_asset_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#delete_data_asset.' if logger raise "Missing the required parameter 'workspace_id' when calling delete_data_asset." if workspace_id.nil? raise "Missing the required parameter 'data_asset_key' when calling delete_data_asset." if data_asset_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key) path = '/workspaces/{workspaceId}/dataAssets/{dataAssetKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#delete_data_asset') 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_data_flow(workspace_id, data_flow_key, opts = {}) ⇒ Response
Click here to see an example of how to use delete_data_flow API.
Removes a data flow from a project or folder using the specified identifier.
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 2551 2552 2553 2554 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 2516 def delete_data_flow(workspace_id, data_flow_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#delete_data_flow.' if logger raise "Missing the required parameter 'workspace_id' when calling delete_data_flow." if workspace_id.nil? raise "Missing the required parameter 'data_flow_key' when calling delete_data_flow." if data_flow_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'data_flow_key' must not be blank" if OCI::Internal::Util.blank_string?(data_flow_key) path = '/workspaces/{workspaceId}/dataFlows/{dataFlowKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{dataFlowKey}', data_flow_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#delete_data_flow') 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_data_flow_validation(workspace_id, data_flow_validation_key, opts = {}) ⇒ Response
Click here to see an example of how to use delete_data_flow_validation API.
Removes a data flow validation using the specified identifier.
2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 2580 def delete_data_flow_validation(workspace_id, data_flow_validation_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#delete_data_flow_validation.' if logger raise "Missing the required parameter 'workspace_id' when calling delete_data_flow_validation." if workspace_id.nil? raise "Missing the required parameter 'data_flow_validation_key' when calling delete_data_flow_validation." if data_flow_validation_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'data_flow_validation_key' must not be blank" if OCI::Internal::Util.blank_string?(data_flow_validation_key) path = '/workspaces/{workspaceId}/dataFlowValidations/{dataFlowValidationKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{dataFlowValidationKey}', data_flow_validation_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#delete_data_flow_validation') 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_dis_application(workspace_id, dis_application_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_dis_application API.
Removes a DIS application using the specified identifier.
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 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 2644 def delete_dis_application(workspace_id, dis_application_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#delete_dis_application.' if logger raise "Missing the required parameter 'workspace_id' when calling delete_dis_application." if workspace_id.nil? raise "Missing the required parameter 'dis_application_id' when calling delete_dis_application." if dis_application_id.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'dis_application_id' must not be blank" if OCI::Internal::Util.blank_string?(dis_application_id) path = '/workspaces/{workspaceId}/disApplications/{disApplicationId}'.sub('{workspaceId}', workspace_id.to_s).sub('{disApplicationId}', dis_application_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: 'DataIntegrationClient#delete_dis_application') 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_dis_application_detailed_description(workspace_id, application_key, opts = {}) ⇒ Response
Click here to see an example of how to use delete_dis_application_detailed_description API.
Deletes detailed description of an Application.
2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 2708 def delete_dis_application_detailed_description(workspace_id, application_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#delete_dis_application_detailed_description.' if logger raise "Missing the required parameter 'workspace_id' when calling delete_dis_application_detailed_description." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling delete_dis_application_detailed_description." if application_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) path = '/workspaces/{workspaceId}/disApplications/{applicationKey}/detailedDescription'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#delete_dis_application_detailed_description') 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_export_request(workspace_id, export_request_key, opts = {}) ⇒ Response
Click here to see an example of how to use delete_export_request API.
Delete export object request using the specified identifier.
2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 2773 def delete_export_request(workspace_id, export_request_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#delete_export_request.' if logger raise "Missing the required parameter 'workspace_id' when calling delete_export_request." if workspace_id.nil? raise "Missing the required parameter 'export_request_key' when calling delete_export_request." if export_request_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'export_request_key' must not be blank" if OCI::Internal::Util.blank_string?(export_request_key) path = '/workspaces/{workspaceId}/exportRequests/{exportRequestKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{exportRequestKey}', export_request_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#delete_export_request') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_external_publication(workspace_id, task_key, external_publications_key, opts = {}) ⇒ Response
Click here to see an example of how to use delete_external_publication API.
Removes a published object using the specified identifier.
2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 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 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 2838 def delete_external_publication(workspace_id, task_key, external_publications_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#delete_external_publication.' if logger raise "Missing the required parameter 'workspace_id' when calling delete_external_publication." if workspace_id.nil? raise "Missing the required parameter 'task_key' when calling delete_external_publication." if task_key.nil? raise "Missing the required parameter 'external_publications_key' when calling delete_external_publication." if external_publications_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'task_key' must not be blank" if OCI::Internal::Util.blank_string?(task_key) raise "Parameter value for 'external_publications_key' must not be blank" if OCI::Internal::Util.blank_string?(external_publications_key) path = '/workspaces/{workspaceId}/tasks/{taskKey}/externalPublications/{externalPublicationsKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{taskKey}', task_key.to_s).sub('{externalPublicationsKey}', external_publications_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#delete_external_publication') 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_external_publication_validation(workspace_id, task_key, external_publication_validation_key, opts = {}) ⇒ Response
Click here to see an example of how to use delete_external_publication_validation API.
Removes a task validation using the specified identifier.
2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 2906 def delete_external_publication_validation(workspace_id, task_key, external_publication_validation_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#delete_external_publication_validation.' if logger raise "Missing the required parameter 'workspace_id' when calling delete_external_publication_validation." if workspace_id.nil? raise "Missing the required parameter 'task_key' when calling delete_external_publication_validation." if task_key.nil? raise "Missing the required parameter 'external_publication_validation_key' when calling delete_external_publication_validation." if external_publication_validation_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'task_key' must not be blank" if OCI::Internal::Util.blank_string?(task_key) raise "Parameter value for 'external_publication_validation_key' must not be blank" if OCI::Internal::Util.blank_string?(external_publication_validation_key) path = '/workspaces/{workspaceId}/tasks/{taskKey}/externalPublicationValidations/{externalPublicationValidationKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{taskKey}', task_key.to_s).sub('{externalPublicationValidationKey}', external_publication_validation_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#delete_external_publication_validation') 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_folder(workspace_id, folder_key, opts = {}) ⇒ Response
Click here to see an example of how to use delete_folder API.
Removes a folder from a project using the specified identifier.
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 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 2972 def delete_folder(workspace_id, folder_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#delete_folder.' if logger raise "Missing the required parameter 'workspace_id' when calling delete_folder." if workspace_id.nil? raise "Missing the required parameter 'folder_key' when calling delete_folder." if folder_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'folder_key' must not be blank" if OCI::Internal::Util.blank_string?(folder_key) path = '/workspaces/{workspaceId}/folders/{folderKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{folderKey}', folder_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#delete_folder') 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_function_library(workspace_id, function_library_key, opts = {}) ⇒ Response
Click here to see an example of how to use delete_function_library API.
Removes a Function Library from a project using the specified identifier.
3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 3036 def delete_function_library(workspace_id, function_library_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#delete_function_library.' if logger raise "Missing the required parameter 'workspace_id' when calling delete_function_library." if workspace_id.nil? raise "Missing the required parameter 'function_library_key' when calling delete_function_library." if function_library_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'function_library_key' must not be blank" if OCI::Internal::Util.blank_string?(function_library_key) path = '/workspaces/{workspaceId}/functionLibraries/{functionLibraryKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{functionLibraryKey}', function_library_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#delete_function_library') 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_import_request(import_request_key, workspace_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_import_request API.
Delete import object request using the specified identifier.
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 3139 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 3101 def delete_import_request(import_request_key, workspace_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#delete_import_request.' if logger raise "Missing the required parameter 'import_request_key' when calling delete_import_request." if import_request_key.nil? raise "Missing the required parameter 'workspace_id' when calling delete_import_request." if workspace_id.nil? raise "Parameter value for 'import_request_key' must not be blank" if OCI::Internal::Util.blank_string?(import_request_key) raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/importRequests/{importRequestKey}'.sub('{importRequestKey}', import_request_key.to_s).sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#delete_import_request') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_patch(workspace_id, application_key, patch_key, opts = {}) ⇒ Response
Click here to see an example of how to use delete_patch API.
Removes a patch using the specified identifier.
3166 3167 3168 3169 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 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 3166 def delete_patch(workspace_id, application_key, patch_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#delete_patch.' if logger raise "Missing the required parameter 'workspace_id' when calling delete_patch." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling delete_patch." if application_key.nil? raise "Missing the required parameter 'patch_key' when calling delete_patch." if patch_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) raise "Parameter value for 'patch_key' must not be blank" if OCI::Internal::Util.blank_string?(patch_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/patches/{patchKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s).sub('{patchKey}', patch_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#delete_patch') 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_pipeline(workspace_id, pipeline_key, opts = {}) ⇒ Response
Click here to see an example of how to use delete_pipeline API.
Removes a pipeline from a project or folder using the specified identifier.
3232 3233 3234 3235 3236 3237 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 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 3232 def delete_pipeline(workspace_id, pipeline_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#delete_pipeline.' if logger raise "Missing the required parameter 'workspace_id' when calling delete_pipeline." if workspace_id.nil? raise "Missing the required parameter 'pipeline_key' when calling delete_pipeline." if pipeline_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'pipeline_key' must not be blank" if OCI::Internal::Util.blank_string?(pipeline_key) path = '/workspaces/{workspaceId}/pipelines/{pipelineKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{pipelineKey}', pipeline_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#delete_pipeline') 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_pipeline_validation(workspace_id, pipeline_validation_key, opts = {}) ⇒ Response
Click here to see an example of how to use delete_pipeline_validation API.
Removes a pipeline validation using the specified identifier.
3296 3297 3298 3299 3300 3301 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 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 3296 def delete_pipeline_validation(workspace_id, pipeline_validation_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#delete_pipeline_validation.' if logger raise "Missing the required parameter 'workspace_id' when calling delete_pipeline_validation." if workspace_id.nil? raise "Missing the required parameter 'pipeline_validation_key' when calling delete_pipeline_validation." if pipeline_validation_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'pipeline_validation_key' must not be blank" if OCI::Internal::Util.blank_string?(pipeline_validation_key) path = '/workspaces/{workspaceId}/pipelineValidations/{pipelineValidationKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{pipelineValidationKey}', pipeline_validation_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#delete_pipeline_validation') 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_project(workspace_id, project_key, opts = {}) ⇒ Response
Click here to see an example of how to use delete_project API.
Removes a project from the workspace using the specified identifier.
3360 3361 3362 3363 3364 3365 3366 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 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 3360 def delete_project(workspace_id, project_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#delete_project.' if logger raise "Missing the required parameter 'workspace_id' when calling delete_project." if workspace_id.nil? raise "Missing the required parameter 'project_key' when calling delete_project." if project_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'project_key' must not be blank" if OCI::Internal::Util.blank_string?(project_key) path = '/workspaces/{workspaceId}/projects/{projectKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{projectKey}', project_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#delete_project') 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_schedule(workspace_id, application_key, schedule_key, opts = {}) ⇒ Response
Click here to see an example of how to use delete_schedule API.
Endpoint to delete schedule.
3425 3426 3427 3428 3429 3430 3431 3432 3433 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 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 3425 def delete_schedule(workspace_id, application_key, schedule_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#delete_schedule.' if logger raise "Missing the required parameter 'workspace_id' when calling delete_schedule." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling delete_schedule." if application_key.nil? raise "Missing the required parameter 'schedule_key' when calling delete_schedule." if schedule_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) raise "Parameter value for 'schedule_key' must not be blank" if OCI::Internal::Util.blank_string?(schedule_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/schedules/{scheduleKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s).sub('{scheduleKey}', schedule_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#delete_schedule') 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_task(workspace_id, task_key, opts = {}) ⇒ Response
Click here to see an example of how to use delete_task API.
Removes a task using the specified identifier.
3491 3492 3493 3494 3495 3496 3497 3498 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 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 3491 def delete_task(workspace_id, task_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#delete_task.' if logger raise "Missing the required parameter 'workspace_id' when calling delete_task." if workspace_id.nil? raise "Missing the required parameter 'task_key' when calling delete_task." if task_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'task_key' must not be blank" if OCI::Internal::Util.blank_string?(task_key) path = '/workspaces/{workspaceId}/tasks/{taskKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{taskKey}', task_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#delete_task') 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_task_run(workspace_id, application_key, task_run_key, opts = {}) ⇒ Response
Click here to see an example of how to use delete_task_run API.
Deletes a task run using the specified identifier.
3556 3557 3558 3559 3560 3561 3562 3563 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 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 3556 def delete_task_run(workspace_id, application_key, task_run_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#delete_task_run.' if logger raise "Missing the required parameter 'workspace_id' when calling delete_task_run." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling delete_task_run." if application_key.nil? raise "Missing the required parameter 'task_run_key' when calling delete_task_run." if task_run_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) raise "Parameter value for 'task_run_key' must not be blank" if OCI::Internal::Util.blank_string?(task_run_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/taskRuns/{taskRunKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s).sub('{taskRunKey}', task_run_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#delete_task_run') 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_task_schedule(workspace_id, application_key, task_schedule_key, opts = {}) ⇒ Response
Click here to see an example of how to use delete_task_schedule API.
Endpoint to delete TaskSchedule.
3623 3624 3625 3626 3627 3628 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 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 3623 def delete_task_schedule(workspace_id, application_key, task_schedule_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#delete_task_schedule.' if logger raise "Missing the required parameter 'workspace_id' when calling delete_task_schedule." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling delete_task_schedule." if application_key.nil? raise "Missing the required parameter 'task_schedule_key' when calling delete_task_schedule." if task_schedule_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) raise "Parameter value for 'task_schedule_key' must not be blank" if OCI::Internal::Util.blank_string?(task_schedule_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/taskSchedules/{taskScheduleKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s).sub('{taskScheduleKey}', task_schedule_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#delete_task_schedule') 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_task_validation(workspace_id, task_validation_key, opts = {}) ⇒ Response
Click here to see an example of how to use delete_task_validation API.
Removes a task validation using the specified identifier.
3690 3691 3692 3693 3694 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 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 3690 def delete_task_validation(workspace_id, task_validation_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#delete_task_validation.' if logger raise "Missing the required parameter 'workspace_id' when calling delete_task_validation." if workspace_id.nil? raise "Missing the required parameter 'task_validation_key' when calling delete_task_validation." if task_validation_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'task_validation_key' must not be blank" if OCI::Internal::Util.blank_string?(task_validation_key) path = '/workspaces/{workspaceId}/taskValidations/{taskValidationKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{taskValidationKey}', task_validation_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#delete_task_validation') 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_user_defined_function(workspace_id, user_defined_function_key, opts = {}) ⇒ Response
Click here to see an example of how to use delete_user_defined_function API.
Removes a UserDefinedFunction from a function library using the specified identifier.
3754 3755 3756 3757 3758 3759 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 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 3754 def delete_user_defined_function(workspace_id, user_defined_function_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#delete_user_defined_function.' if logger raise "Missing the required parameter 'workspace_id' when calling delete_user_defined_function." if workspace_id.nil? raise "Missing the required parameter 'user_defined_function_key' when calling delete_user_defined_function." if user_defined_function_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'user_defined_function_key' must not be blank" if OCI::Internal::Util.blank_string?(user_defined_function_key) path = '/workspaces/{workspaceId}/userDefinedFunctions/{userDefinedFunctionKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{userDefinedFunctionKey}', user_defined_function_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#delete_user_defined_function') 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_user_defined_function_validation(workspace_id, user_defined_function_validation_key, opts = {}) ⇒ Response
Click here to see an example of how to use delete_user_defined_function_validation API.
Removes a UserDefinedFunction validation using the specified identifier.
3818 3819 3820 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/data_integration/data_integration_client.rb', line 3818 def delete_user_defined_function_validation(workspace_id, user_defined_function_validation_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#delete_user_defined_function_validation.' if logger raise "Missing the required parameter 'workspace_id' when calling delete_user_defined_function_validation." if workspace_id.nil? raise "Missing the required parameter 'user_defined_function_validation_key' when calling delete_user_defined_function_validation." if user_defined_function_validation_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'user_defined_function_validation_key' must not be blank" if OCI::Internal::Util.blank_string?(user_defined_function_validation_key) path = '/workspaces/{workspaceId}/userDefinedFunctionValidations/{userDefinedFunctionValidationKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{userDefinedFunctionValidationKey}', user_defined_function_validation_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#delete_user_defined_function_validation') 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_workspace(workspace_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_workspace API.
Deletes a Data Integration workspace resource using the specified identifier.
3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 3883 def delete_workspace(workspace_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#delete_workspace.' if logger raise "Missing the required parameter 'workspace_id' when calling delete_workspace." if workspace_id.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:quiesceTimeout] = opts[:quiesce_timeout] if opts[:quiesce_timeout] query_params[:isForceOperation] = opts[:is_force_operation] if !opts[:is_force_operation].nil? # 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: 'DataIntegrationClient#delete_workspace') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#get_application(workspace_id, application_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_application API.
Retrieves an application using the specified identifier.
3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 3943 def get_application(workspace_id, application_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_application.' if logger raise "Missing the required parameter 'workspace_id' when calling get_application." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling get_application." if application_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'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: 'DataIntegrationClient#get_application') 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::DataIntegration::Models::Application' ) end # rubocop:enable Metrics/BlockLength end |
#get_application_detailed_description(workspace_id, application_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_application_detailed_description API.
Retrieves detailed description of an Application
4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 4003 def get_application_detailed_description(workspace_id, application_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_application_detailed_description.' if logger raise "Missing the required parameter 'workspace_id' when calling get_application_detailed_description." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling get_application_detailed_description." if application_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/detailedDescription'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'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: 'DataIntegrationClient#get_application_detailed_description') 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::DataIntegration::Models::DetailedDescription' ) end # rubocop:enable Metrics/BlockLength end |
#get_composite_state(workspace_id, application_key, aggregator_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_composite_state API.
This endpoint can be used to get composite state for a given aggregator
4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 4065 def get_composite_state(workspace_id, application_key, aggregator_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_composite_state.' if logger raise "Missing the required parameter 'workspace_id' when calling get_composite_state." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling get_composite_state." if application_key.nil? raise "Missing the required parameter 'aggregator_key' when calling get_composite_state." if aggregator_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/compositeState'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:aggregatorKey] = aggregator_key # 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: 'DataIntegrationClient#get_composite_state') 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::DataIntegration::Models::CompositeState' ) end # rubocop:enable Metrics/BlockLength end |
#get_connection(workspace_id, connection_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_connection API.
Retrieves the connection details using the specified identifier.
4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 4127 def get_connection(workspace_id, connection_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_connection.' if logger raise "Missing the required parameter 'workspace_id' when calling get_connection." if workspace_id.nil? raise "Missing the required parameter 'connection_key' when calling get_connection." if connection_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'connection_key' must not be blank" if OCI::Internal::Util.blank_string?(connection_key) path = '/workspaces/{workspaceId}/connections/{connectionKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{connectionKey}', connection_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'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: 'DataIntegrationClient#get_connection') 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::DataIntegration::Models::Connection' ) end # rubocop:enable Metrics/BlockLength end |
#get_connection_validation(workspace_id, connection_validation_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_connection_validation API.
Retrieves a connection validation using the specified identifier.
4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 4187 def get_connection_validation(workspace_id, connection_validation_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_connection_validation.' if logger raise "Missing the required parameter 'workspace_id' when calling get_connection_validation." if workspace_id.nil? raise "Missing the required parameter 'connection_validation_key' when calling get_connection_validation." if connection_validation_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'connection_validation_key' must not be blank" if OCI::Internal::Util.blank_string?(connection_validation_key) path = '/workspaces/{workspaceId}/connectionValidations/{connectionValidationKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{connectionValidationKey}', connection_validation_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'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: 'DataIntegrationClient#get_connection_validation') 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::DataIntegration::Models::ConnectionValidation' ) end # rubocop:enable Metrics/BlockLength end |
#get_copy_object_request(workspace_id, copy_object_request_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_copy_object_request API.
This endpoint can be used to get the summary/details of object being copied.
4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 4248 def get_copy_object_request(workspace_id, copy_object_request_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_copy_object_request.' if logger raise "Missing the required parameter 'workspace_id' when calling get_copy_object_request." if workspace_id.nil? raise "Missing the required parameter 'copy_object_request_key' when calling get_copy_object_request." if copy_object_request_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'copy_object_request_key' must not be blank" if OCI::Internal::Util.blank_string?(copy_object_request_key) path = '/workspaces/{workspaceId}/copyObjectRequests/{copyObjectRequestKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{copyObjectRequestKey}', copy_object_request_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'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: 'DataIntegrationClient#get_copy_object_request') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::DataIntegration::Models::CopyObjectRequest' ) end # rubocop:enable Metrics/BlockLength end |
#get_count_statistic(workspace_id, count_statistic_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_count_statistic API.
Retrieves statistics on a workspace. It returns an object with an array of property values, such as the number of projects, | applications, data assets, and so on.
4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 4310 def get_count_statistic(workspace_id, count_statistic_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_count_statistic.' if logger raise "Missing the required parameter 'workspace_id' when calling get_count_statistic." if workspace_id.nil? raise "Missing the required parameter 'count_statistic_key' when calling get_count_statistic." if count_statistic_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'count_statistic_key' must not be blank" if OCI::Internal::Util.blank_string?(count_statistic_key) path = '/workspaces/{workspaceId}/countStatistics/{countStatisticKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{countStatisticKey}', count_statistic_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'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: 'DataIntegrationClient#get_count_statistic') 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::DataIntegration::Models::CountStatistic' ) end # rubocop:enable Metrics/BlockLength end |
#get_data_asset(workspace_id, data_asset_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_data_asset API.
Retrieves details of a data asset using the specified identifier.
4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 4370 def get_data_asset(workspace_id, data_asset_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_data_asset.' if logger raise "Missing the required parameter 'workspace_id' when calling get_data_asset." if workspace_id.nil? raise "Missing the required parameter 'data_asset_key' when calling get_data_asset." if data_asset_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key) path = '/workspaces/{workspaceId}/dataAssets/{dataAssetKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'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: 'DataIntegrationClient#get_data_asset') 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::DataIntegration::Models::DataAsset' ) end # rubocop:enable Metrics/BlockLength end |
#get_data_entity(workspace_id, connection_key, schema_resource_name, data_entity_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_data_entity API.
Retrieves the data entity details with the given name from live schema.
4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 4432 def get_data_entity(workspace_id, connection_key, schema_resource_name, data_entity_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_data_entity.' if logger raise "Missing the required parameter 'workspace_id' when calling get_data_entity." if workspace_id.nil? raise "Missing the required parameter 'connection_key' when calling get_data_entity." if connection_key.nil? raise "Missing the required parameter 'schema_resource_name' when calling get_data_entity." if schema_resource_name.nil? raise "Missing the required parameter 'data_entity_key' when calling get_data_entity." if data_entity_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'connection_key' must not be blank" if OCI::Internal::Util.blank_string?(connection_key) raise "Parameter value for 'schema_resource_name' must not be blank" if OCI::Internal::Util.blank_string?(schema_resource_name) raise "Parameter value for 'data_entity_key' must not be blank" if OCI::Internal::Util.blank_string?(data_entity_key) path = '/workspaces/{workspaceId}/connections/{connectionKey}/schemas/{schemaResourceName}/dataEntities/{dataEntityKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{connectionKey}', connection_key.to_s).sub('{schemaResourceName}', schema_resource_name.to_s).sub('{dataEntityKey}', data_entity_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'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: 'DataIntegrationClient#get_data_entity') 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::DataIntegration::Models::DataEntity' ) end # rubocop:enable Metrics/BlockLength end |
#get_data_flow(workspace_id, data_flow_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_data_flow API.
Retrieves a data flow using the specified identifier.
4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 4497 def get_data_flow(workspace_id, data_flow_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_data_flow.' if logger raise "Missing the required parameter 'workspace_id' when calling get_data_flow." if workspace_id.nil? raise "Missing the required parameter 'data_flow_key' when calling get_data_flow." if data_flow_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'data_flow_key' must not be blank" if OCI::Internal::Util.blank_string?(data_flow_key) path = '/workspaces/{workspaceId}/dataFlows/{dataFlowKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{dataFlowKey}', data_flow_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:expandReferences] = opts[:expand_references] if opts[:expand_references] # 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: 'DataIntegrationClient#get_data_flow') 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::DataIntegration::Models::DataFlow' ) end # rubocop:enable Metrics/BlockLength end |
#get_data_flow_validation(workspace_id, data_flow_validation_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_data_flow_validation API.
Retrieves a data flow validation using the specified identifier.
4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 4558 def get_data_flow_validation(workspace_id, data_flow_validation_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_data_flow_validation.' if logger raise "Missing the required parameter 'workspace_id' when calling get_data_flow_validation." if workspace_id.nil? raise "Missing the required parameter 'data_flow_validation_key' when calling get_data_flow_validation." if data_flow_validation_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'data_flow_validation_key' must not be blank" if OCI::Internal::Util.blank_string?(data_flow_validation_key) path = '/workspaces/{workspaceId}/dataFlowValidations/{dataFlowValidationKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{dataFlowValidationKey}', data_flow_validation_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'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: 'DataIntegrationClient#get_data_flow_validation') 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::DataIntegration::Models::DataFlowValidation' ) end # rubocop:enable Metrics/BlockLength end |
#get_dependent_object(workspace_id, application_key, dependent_object_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_dependent_object API.
Retrieves the details of a dependent object from an application.
4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 4619 def get_dependent_object(workspace_id, application_key, dependent_object_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_dependent_object.' if logger raise "Missing the required parameter 'workspace_id' when calling get_dependent_object." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling get_dependent_object." if application_key.nil? raise "Missing the required parameter 'dependent_object_key' when calling get_dependent_object." if dependent_object_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) raise "Parameter value for 'dependent_object_key' must not be blank" if OCI::Internal::Util.blank_string?(dependent_object_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/dependentObjects/{dependentObjectKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s).sub('{dependentObjectKey}', dependent_object_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'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: 'DataIntegrationClient#get_dependent_object') 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::DataIntegration::Models::DependentObject' ) end # rubocop:enable Metrics/BlockLength end |
#get_dis_application(workspace_id, dis_application_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_dis_application API.
Retrieves an application using the specified OCID.
4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 4681 def get_dis_application(workspace_id, dis_application_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_dis_application.' if logger raise "Missing the required parameter 'workspace_id' when calling get_dis_application." if workspace_id.nil? raise "Missing the required parameter 'dis_application_id' when calling get_dis_application." if dis_application_id.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'dis_application_id' must not be blank" if OCI::Internal::Util.blank_string?(dis_application_id) path = '/workspaces/{workspaceId}/disApplications/{disApplicationId}'.sub('{workspaceId}', workspace_id.to_s).sub('{disApplicationId}', dis_application_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: 'DataIntegrationClient#get_dis_application') 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::DataIntegration::Models::DisApplication' ) end # rubocop:enable Metrics/BlockLength end |
#get_dis_application_detailed_description(workspace_id, application_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_dis_application_detailed_description API.
Retrieves detailed description of an Application.
4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 4741 def get_dis_application_detailed_description(workspace_id, application_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_dis_application_detailed_description.' if logger raise "Missing the required parameter 'workspace_id' when calling get_dis_application_detailed_description." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling get_dis_application_detailed_description." if application_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) path = '/workspaces/{workspaceId}/disApplications/{applicationKey}/detailedDescription'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'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: 'DataIntegrationClient#get_dis_application_detailed_description') 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::DataIntegration::Models::DetailedDescription' ) end # rubocop:enable Metrics/BlockLength end |
#get_export_request(workspace_id, export_request_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_export_request API.
This endpoint can be used to get the summary/details of object being exported.
4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 4802 def get_export_request(workspace_id, export_request_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_export_request.' if logger raise "Missing the required parameter 'workspace_id' when calling get_export_request." if workspace_id.nil? raise "Missing the required parameter 'export_request_key' when calling get_export_request." if export_request_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'export_request_key' must not be blank" if OCI::Internal::Util.blank_string?(export_request_key) path = '/workspaces/{workspaceId}/exportRequests/{exportRequestKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{exportRequestKey}', export_request_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'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: 'DataIntegrationClient#get_export_request') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::DataIntegration::Models::ExportRequest' ) end # rubocop:enable Metrics/BlockLength end |
#get_external_publication(workspace_id, task_key, external_publications_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_external_publication API.
Retrieves a publshed object in an task using the specified identifier.
4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 4863 def get_external_publication(workspace_id, task_key, external_publications_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_external_publication.' if logger raise "Missing the required parameter 'workspace_id' when calling get_external_publication." if workspace_id.nil? raise "Missing the required parameter 'task_key' when calling get_external_publication." if task_key.nil? raise "Missing the required parameter 'external_publications_key' when calling get_external_publication." if external_publications_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'task_key' must not be blank" if OCI::Internal::Util.blank_string?(task_key) raise "Parameter value for 'external_publications_key' must not be blank" if OCI::Internal::Util.blank_string?(external_publications_key) path = '/workspaces/{workspaceId}/tasks/{taskKey}/externalPublications/{externalPublicationsKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{taskKey}', task_key.to_s).sub('{externalPublicationsKey}', external_publications_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'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: 'DataIntegrationClient#get_external_publication') 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::DataIntegration::Models::ExternalPublication' ) end # rubocop:enable Metrics/BlockLength end |
#get_external_publication_validation(workspace_id, task_key, external_publication_validation_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_external_publication_validation API.
Retrieves an external publication validation using the specified identifier.
4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 4926 def get_external_publication_validation(workspace_id, task_key, external_publication_validation_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_external_publication_validation.' if logger raise "Missing the required parameter 'workspace_id' when calling get_external_publication_validation." if workspace_id.nil? raise "Missing the required parameter 'task_key' when calling get_external_publication_validation." if task_key.nil? raise "Missing the required parameter 'external_publication_validation_key' when calling get_external_publication_validation." if external_publication_validation_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'task_key' must not be blank" if OCI::Internal::Util.blank_string?(task_key) raise "Parameter value for 'external_publication_validation_key' must not be blank" if OCI::Internal::Util.blank_string?(external_publication_validation_key) path = '/workspaces/{workspaceId}/tasks/{taskKey}/externalPublicationValidations/{externalPublicationValidationKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{taskKey}', task_key.to_s).sub('{externalPublicationValidationKey}', external_publication_validation_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'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: 'DataIntegrationClient#get_external_publication_validation') 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::DataIntegration::Models::ExternalPublicationValidation' ) end # rubocop:enable Metrics/BlockLength end |
#get_folder(workspace_id, folder_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_folder API.
Retrieves a folder using the specified identifier.
4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 4990 def get_folder(workspace_id, folder_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_folder.' if logger raise "Missing the required parameter 'workspace_id' when calling get_folder." if workspace_id.nil? raise "Missing the required parameter 'folder_key' when calling get_folder." if folder_key.nil? projection_allowable_values = %w[CHILD_COUNT_STATISTICS] if opts[:projection] && !opts[:projection].empty? opts[:projection].each do |val_to_check| unless projection_allowable_values.include?(val_to_check) raise 'Invalid value for "projection", must be one of CHILD_COUNT_STATISTICS.' end end end raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'folder_key' must not be blank" if OCI::Internal::Util.blank_string?(folder_key) path = '/workspaces/{workspaceId}/folders/{folderKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{folderKey}', folder_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:projection] = OCI::ApiClient.build_collection_params(opts[:projection], :multi) if opts[:projection] && !opts[:projection].empty? # 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: 'DataIntegrationClient#get_folder') 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::DataIntegration::Models::Folder' ) end # rubocop:enable Metrics/BlockLength end |
#get_function_library(workspace_id, function_library_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_function_library API.
Retrieves a Function Library using the specified identifier.
5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 5063 def get_function_library(workspace_id, function_library_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_function_library.' if logger raise "Missing the required parameter 'workspace_id' when calling get_function_library." if workspace_id.nil? raise "Missing the required parameter 'function_library_key' when calling get_function_library." if function_library_key.nil? projection_allowable_values = %w[CHILD_COUNT_STATISTICS] if opts[:projection] && !opts[:projection].empty? opts[:projection].each do |val_to_check| unless projection_allowable_values.include?(val_to_check) raise 'Invalid value for "projection", must be one of CHILD_COUNT_STATISTICS.' end end end raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'function_library_key' must not be blank" if OCI::Internal::Util.blank_string?(function_library_key) path = '/workspaces/{workspaceId}/functionLibraries/{functionLibraryKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{functionLibraryKey}', function_library_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:projection] = OCI::ApiClient.build_collection_params(opts[:projection], :multi) if opts[:projection] && !opts[:projection].empty? # 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: 'DataIntegrationClient#get_function_library') 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::DataIntegration::Models::FunctionLibrary' ) end # rubocop:enable Metrics/BlockLength end |
#get_import_request(workspace_id, import_request_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_import_request API.
This endpoint can be used to get the summary/details of object being imported.
5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 5137 def get_import_request(workspace_id, import_request_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_import_request.' if logger raise "Missing the required parameter 'workspace_id' when calling get_import_request." if workspace_id.nil? raise "Missing the required parameter 'import_request_key' when calling get_import_request." if import_request_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'import_request_key' must not be blank" if OCI::Internal::Util.blank_string?(import_request_key) path = '/workspaces/{workspaceId}/importRequests/{importRequestKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{importRequestKey}', import_request_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#get_import_request') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::DataIntegration::Models::ImportRequest' ) end # rubocop:enable Metrics/BlockLength end |
#get_patch(workspace_id, application_key, patch_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_patch API.
Retrieves a patch in an application using the specified identifier.
5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 5200 def get_patch(workspace_id, application_key, patch_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_patch.' if logger raise "Missing the required parameter 'workspace_id' when calling get_patch." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling get_patch." if application_key.nil? raise "Missing the required parameter 'patch_key' when calling get_patch." if patch_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) raise "Parameter value for 'patch_key' must not be blank" if OCI::Internal::Util.blank_string?(patch_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/patches/{patchKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s).sub('{patchKey}', patch_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'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: 'DataIntegrationClient#get_patch') 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::DataIntegration::Models::Patch' ) end # rubocop:enable Metrics/BlockLength end |
#get_pipeline(workspace_id, pipeline_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_pipeline API.
Retrieves a pipeline using the specified identifier.
5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 5263 def get_pipeline(workspace_id, pipeline_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_pipeline.' if logger raise "Missing the required parameter 'workspace_id' when calling get_pipeline." if workspace_id.nil? raise "Missing the required parameter 'pipeline_key' when calling get_pipeline." if pipeline_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'pipeline_key' must not be blank" if OCI::Internal::Util.blank_string?(pipeline_key) path = '/workspaces/{workspaceId}/pipelines/{pipelineKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{pipelineKey}', pipeline_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:expandReferences] = opts[:expand_references] if opts[:expand_references] # 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: 'DataIntegrationClient#get_pipeline') 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::DataIntegration::Models::Pipeline' ) end # rubocop:enable Metrics/BlockLength end |
#get_pipeline_validation(workspace_id, pipeline_validation_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_pipeline_validation API.
Retrieves a pipeline validation using the specified identifier.
5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 5324 def get_pipeline_validation(workspace_id, pipeline_validation_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_pipeline_validation.' if logger raise "Missing the required parameter 'workspace_id' when calling get_pipeline_validation." if workspace_id.nil? raise "Missing the required parameter 'pipeline_validation_key' when calling get_pipeline_validation." if pipeline_validation_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'pipeline_validation_key' must not be blank" if OCI::Internal::Util.blank_string?(pipeline_validation_key) path = '/workspaces/{workspaceId}/pipelineValidations/{pipelineValidationKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{pipelineValidationKey}', pipeline_validation_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'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: 'DataIntegrationClient#get_pipeline_validation') 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::DataIntegration::Models::PipelineValidation' ) end # rubocop:enable Metrics/BlockLength end |
#get_project(workspace_id, project_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_project API.
Retrieves a project using the specified identifier.
5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 5386 def get_project(workspace_id, project_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_project.' if logger raise "Missing the required parameter 'workspace_id' when calling get_project." if workspace_id.nil? raise "Missing the required parameter 'project_key' when calling get_project." if project_key.nil? projection_allowable_values = %w[CHILD_COUNT_STATISTICS] if opts[:projection] && !opts[:projection].empty? opts[:projection].each do |val_to_check| unless projection_allowable_values.include?(val_to_check) raise 'Invalid value for "projection", must be one of CHILD_COUNT_STATISTICS.' end end end raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'project_key' must not be blank" if OCI::Internal::Util.blank_string?(project_key) path = '/workspaces/{workspaceId}/projects/{projectKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{projectKey}', project_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:projection] = OCI::ApiClient.build_collection_params(opts[:projection], :multi) if opts[:projection] && !opts[:projection].empty? # 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: 'DataIntegrationClient#get_project') 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::DataIntegration::Models::Project' ) end # rubocop:enable Metrics/BlockLength end |
#get_published_object(workspace_id, application_key, published_object_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_published_object API.
Retrieves the details of a published object from an application.
5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 5459 def get_published_object(workspace_id, application_key, published_object_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_published_object.' if logger raise "Missing the required parameter 'workspace_id' when calling get_published_object." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling get_published_object." if application_key.nil? raise "Missing the required parameter 'published_object_key' when calling get_published_object." if published_object_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) raise "Parameter value for 'published_object_key' must not be blank" if OCI::Internal::Util.blank_string?(published_object_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/publishedObjects/{publishedObjectKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s).sub('{publishedObjectKey}', published_object_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:expandReferences] = opts[:expand_references] if opts[:expand_references] # 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: 'DataIntegrationClient#get_published_object') 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::DataIntegration::Models::PublishedObject' ) end # rubocop:enable Metrics/BlockLength end |
#get_reference(workspace_id, application_key, reference_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_reference API.
Retrieves a reference in an application.
5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 5523 def get_reference(workspace_id, application_key, reference_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_reference.' if logger raise "Missing the required parameter 'workspace_id' when calling get_reference." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling get_reference." if application_key.nil? raise "Missing the required parameter 'reference_key' when calling get_reference." if reference_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) raise "Parameter value for 'reference_key' must not be blank" if OCI::Internal::Util.blank_string?(reference_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/references/{referenceKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s).sub('{referenceKey}', reference_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'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: 'DataIntegrationClient#get_reference') 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::DataIntegration::Models::Reference' ) end # rubocop:enable Metrics/BlockLength end |
#get_runtime_operator(workspace_id, application_key, runtime_pipeline_key, runtime_operator_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_runtime_operator API.
Retrieves a runtime operator using the specified identifier.
5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 5587 def get_runtime_operator(workspace_id, application_key, runtime_pipeline_key, runtime_operator_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_runtime_operator.' if logger raise "Missing the required parameter 'workspace_id' when calling get_runtime_operator." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling get_runtime_operator." if application_key.nil? raise "Missing the required parameter 'runtime_pipeline_key' when calling get_runtime_operator." if runtime_pipeline_key.nil? raise "Missing the required parameter 'runtime_operator_key' when calling get_runtime_operator." if runtime_operator_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) raise "Parameter value for 'runtime_pipeline_key' must not be blank" if OCI::Internal::Util.blank_string?(runtime_pipeline_key) raise "Parameter value for 'runtime_operator_key' must not be blank" if OCI::Internal::Util.blank_string?(runtime_operator_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/runtimePipelines/{runtimePipelineKey}/runtimeOperators/{runtimeOperatorKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s).sub('{runtimePipelineKey}', runtime_pipeline_key.to_s).sub('{runtimeOperatorKey}', runtime_operator_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'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: 'DataIntegrationClient#get_runtime_operator') 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::DataIntegration::Models::RuntimeOperator' ) end # rubocop:enable Metrics/BlockLength end |
#get_runtime_pipeline(workspace_id, application_key, runtime_pipeline_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_runtime_pipeline API.
Retrieves a runtime pipeline using the specified identifier.
5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 5653 def get_runtime_pipeline(workspace_id, application_key, runtime_pipeline_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_runtime_pipeline.' if logger raise "Missing the required parameter 'workspace_id' when calling get_runtime_pipeline." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling get_runtime_pipeline." if application_key.nil? raise "Missing the required parameter 'runtime_pipeline_key' when calling get_runtime_pipeline." if runtime_pipeline_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) raise "Parameter value for 'runtime_pipeline_key' must not be blank" if OCI::Internal::Util.blank_string?(runtime_pipeline_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/runtimePipelines/{runtimePipelineKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s).sub('{runtimePipelineKey}', runtime_pipeline_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:expandReferences] = opts[:expand_references] if opts[:expand_references] # 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: 'DataIntegrationClient#get_runtime_pipeline') 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::DataIntegration::Models::RuntimePipeline' ) end # rubocop:enable Metrics/BlockLength end |
#get_schedule(workspace_id, application_key, schedule_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_schedule API.
Retrieves schedule by schedule key
5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 5717 def get_schedule(workspace_id, application_key, schedule_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_schedule.' if logger raise "Missing the required parameter 'workspace_id' when calling get_schedule." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling get_schedule." if application_key.nil? raise "Missing the required parameter 'schedule_key' when calling get_schedule." if schedule_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) raise "Parameter value for 'schedule_key' must not be blank" if OCI::Internal::Util.blank_string?(schedule_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/schedules/{scheduleKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s).sub('{scheduleKey}', schedule_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'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: 'DataIntegrationClient#get_schedule') 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::DataIntegration::Models::Schedule' ) end # rubocop:enable Metrics/BlockLength end |
#get_schema(workspace_id, connection_key, schema_resource_name, opts = {}) ⇒ Response
Click here to see an example of how to use get_schema API.
Retrieves a schema that can be accessed using the specified connection.
5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 5780 def get_schema(workspace_id, connection_key, schema_resource_name, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_schema.' if logger raise "Missing the required parameter 'workspace_id' when calling get_schema." if workspace_id.nil? raise "Missing the required parameter 'connection_key' when calling get_schema." if connection_key.nil? raise "Missing the required parameter 'schema_resource_name' when calling get_schema." if schema_resource_name.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'connection_key' must not be blank" if OCI::Internal::Util.blank_string?(connection_key) raise "Parameter value for 'schema_resource_name' must not be blank" if OCI::Internal::Util.blank_string?(schema_resource_name) path = '/workspaces/{workspaceId}/connections/{connectionKey}/schemas/{schemaResourceName}'.sub('{workspaceId}', workspace_id.to_s).sub('{connectionKey}', connection_key.to_s).sub('{schemaResourceName}', schema_resource_name.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: 'DataIntegrationClient#get_schema') 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::DataIntegration::Models::Schema' ) end # rubocop:enable Metrics/BlockLength end |
#get_task(workspace_id, task_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_task API.
Retrieves a task using the specified identifier.
5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 5843 def get_task(workspace_id, task_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_task.' if logger raise "Missing the required parameter 'workspace_id' when calling get_task." if workspace_id.nil? raise "Missing the required parameter 'task_key' when calling get_task." if task_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'task_key' must not be blank" if OCI::Internal::Util.blank_string?(task_key) path = '/workspaces/{workspaceId}/tasks/{taskKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{taskKey}', task_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:expandReferences] = opts[:expand_references] if opts[:expand_references] # 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: 'DataIntegrationClient#get_task') 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::DataIntegration::Models::Task' ) end # rubocop:enable Metrics/BlockLength end |
#get_task_run(workspace_id, application_key, task_run_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_task_run API.
Retrieves a task run using the specified identifier.
5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 5905 def get_task_run(workspace_id, application_key, task_run_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_task_run.' if logger raise "Missing the required parameter 'workspace_id' when calling get_task_run." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling get_task_run." if application_key.nil? raise "Missing the required parameter 'task_run_key' when calling get_task_run." if task_run_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) raise "Parameter value for 'task_run_key' must not be blank" if OCI::Internal::Util.blank_string?(task_run_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/taskRuns/{taskRunKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s).sub('{taskRunKey}', task_run_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'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: 'DataIntegrationClient#get_task_run') 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::DataIntegration::Models::TaskRun' ) end # rubocop:enable Metrics/BlockLength end |
#get_task_schedule(workspace_id, application_key, task_schedule_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_task_schedule API.
Endpoint used to get taskSchedule by its key
5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 5968 def get_task_schedule(workspace_id, application_key, task_schedule_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_task_schedule.' if logger raise "Missing the required parameter 'workspace_id' when calling get_task_schedule." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling get_task_schedule." if application_key.nil? raise "Missing the required parameter 'task_schedule_key' when calling get_task_schedule." if task_schedule_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) raise "Parameter value for 'task_schedule_key' must not be blank" if OCI::Internal::Util.blank_string?(task_schedule_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/taskSchedules/{taskScheduleKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s).sub('{taskScheduleKey}', task_schedule_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'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: 'DataIntegrationClient#get_task_schedule') 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::DataIntegration::Models::TaskSchedule' ) end # rubocop:enable Metrics/BlockLength end |
#get_task_validation(workspace_id, task_validation_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_task_validation API.
Retrieves a task validation using the specified identifier.
6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 6031 def get_task_validation(workspace_id, task_validation_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_task_validation.' if logger raise "Missing the required parameter 'workspace_id' when calling get_task_validation." if workspace_id.nil? raise "Missing the required parameter 'task_validation_key' when calling get_task_validation." if task_validation_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'task_validation_key' must not be blank" if OCI::Internal::Util.blank_string?(task_validation_key) path = '/workspaces/{workspaceId}/taskValidations/{taskValidationKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{taskValidationKey}', task_validation_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'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: 'DataIntegrationClient#get_task_validation') 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::DataIntegration::Models::TaskValidation' ) end # rubocop:enable Metrics/BlockLength end |
#get_template(workspace_id, template_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_template API.
This endpoint can be used to get an application template using a key.
6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 6091 def get_template(workspace_id, template_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_template.' if logger raise "Missing the required parameter 'workspace_id' when calling get_template." if workspace_id.nil? raise "Missing the required parameter 'template_id' when calling get_template." if template_id.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'template_id' must not be blank" if OCI::Internal::Util.blank_string?(template_id) path = '/workspaces/{workspaceId}/templates/{templateId}'.sub('{workspaceId}', workspace_id.to_s).sub('{templateId}', template_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: 'DataIntegrationClient#get_template') 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::DataIntegration::Models::Template' ) end # rubocop:enable Metrics/BlockLength end |
#get_user_defined_function(workspace_id, user_defined_function_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_user_defined_function API.
Retrieves a UserDefinedFunction using the specified identifier.
6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 6151 def get_user_defined_function(workspace_id, user_defined_function_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_user_defined_function.' if logger raise "Missing the required parameter 'workspace_id' when calling get_user_defined_function." if workspace_id.nil? raise "Missing the required parameter 'user_defined_function_key' when calling get_user_defined_function." if user_defined_function_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'user_defined_function_key' must not be blank" if OCI::Internal::Util.blank_string?(user_defined_function_key) path = '/workspaces/{workspaceId}/userDefinedFunctions/{userDefinedFunctionKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{userDefinedFunctionKey}', user_defined_function_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'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: 'DataIntegrationClient#get_user_defined_function') 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::DataIntegration::Models::UserDefinedFunction' ) end # rubocop:enable Metrics/BlockLength end |
#get_user_defined_function_validation(workspace_id, user_defined_function_validation_key, opts = {}) ⇒ Response
Click here to see an example of how to use get_user_defined_function_validation API.
Retrieves a UserDefinedFunction validation using the specified identifier.
6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 6211 def get_user_defined_function_validation(workspace_id, user_defined_function_validation_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_user_defined_function_validation.' if logger raise "Missing the required parameter 'workspace_id' when calling get_user_defined_function_validation." if workspace_id.nil? raise "Missing the required parameter 'user_defined_function_validation_key' when calling get_user_defined_function_validation." if user_defined_function_validation_key.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'user_defined_function_validation_key' must not be blank" if OCI::Internal::Util.blank_string?(user_defined_function_validation_key) path = '/workspaces/{workspaceId}/userDefinedFunctionValidations/{userDefinedFunctionValidationKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{userDefinedFunctionValidationKey}', user_defined_function_validation_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'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: 'DataIntegrationClient#get_user_defined_function_validation') 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::DataIntegration::Models::UserDefinedFunctionValidation' ) end # rubocop:enable Metrics/BlockLength end |
#get_work_request(work_request_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_work_request API.
Retrieves the status of the work request with the given ID.
6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 6270 def get_work_request(work_request_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_work_request.' if logger raise "Missing the required parameter 'work_request_id' when calling get_work_request." if work_request_id.nil? raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id) path = '/workRequests/{workRequestId}'.sub('{workRequestId}', work_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#get_work_request') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::DataIntegration::Models::WorkRequest' ) end # rubocop:enable Metrics/BlockLength end |
#get_workspace(workspace_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_workspace API.
Retrieves a Data Integration workspace using the specified identifier.
6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 6327 def get_workspace(workspace_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#get_workspace.' if logger raise "Missing the required parameter 'workspace_id' when calling get_workspace." if workspace_id.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}'.sub('{workspaceId}', workspace_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: 'DataIntegrationClient#get_workspace') 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::DataIntegration::Models::Workspace' ) end # rubocop:enable Metrics/BlockLength end |
#list_applications(workspace_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_applications API.
Retrieves a list of applications and provides options to filter the list.
6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 6395 def list_applications(workspace_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_applications.' if logger raise "Missing the required parameter 'workspace_id' when calling list_applications." if workspace_id.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' end raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/applications'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:name] = opts[:name] if opts[:name] query_params[:nameContains] = opts[:name_contains] if opts[:name_contains] query_params[:identifier] = OCI::ApiClient.build_collection_params(opts[:identifier], :multi) if opts[:identifier] && !opts[:identifier].empty? query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty? query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#list_applications') 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::DataIntegration::Models::ApplicationSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_connection_validations(workspace_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_connection_validations API.
Retrieves a list of connection validations within the specified workspace.
6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 6478 def list_connection_validations(workspace_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_connection_validations.' if logger raise "Missing the required parameter 'workspace_id' when calling list_connection_validations." if workspace_id.nil? if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' 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 raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/connectionValidations'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:key] = opts[:key] if opts[:key] query_params[:name] = opts[:name] if opts[:name] query_params[:identifier] = opts[:identifier] if opts[:identifier] query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty? query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] 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: 'DataIntegrationClient#list_connection_validations') 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::DataIntegration::Models::ConnectionValidationSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_connections(workspace_id, data_asset_key, opts = {}) ⇒ Response
Click here to see an example of how to use list_connections API.
Retrieves a list of all connections.
6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 6561 def list_connections(workspace_id, data_asset_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_connections.' if logger raise "Missing the required parameter 'workspace_id' when calling list_connections." if workspace_id.nil? raise "Missing the required parameter 'data_asset_key' when calling list_connections." if data_asset_key.nil? if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' 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 raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/connections'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:dataAssetKey] = data_asset_key query_params[:name] = opts[:name] if opts[:name] query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty? query_params[:type] = opts[:type] if opts[:type] 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: 'DataIntegrationClient#list_connections') 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::DataIntegration::Models::ConnectionSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_copy_object_requests(workspace_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_copy_object_requests API.
This endpoint can be used to get the list of copy object requests.
6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 6649 def list_copy_object_requests(workspace_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_copy_object_requests.' if logger raise "Missing the required parameter 'workspace_id' when calling list_copy_object_requests." if workspace_id.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' end if opts[:copy_status] && !%w[IN_PROGRESS SUCCESSFUL QUEUED TERMINATING TERMINATED FAILED ALL].include?(opts[:copy_status]) raise 'Invalid value for "copy_status", must be one of IN_PROGRESS, SUCCESSFUL, QUEUED, TERMINATING, TERMINATED, FAILED, ALL.' end if opts[:projection] && !%w[SUMMARY DETAILS].include?(opts[:projection]) raise 'Invalid value for "projection", must be one of SUMMARY, DETAILS.' end raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/copyObjectRequests'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:name] = opts[:name] if opts[:name] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:copyStatus] = opts[:copy_status] if opts[:copy_status] query_params[:projection] = opts[:projection] if opts[:projection] query_params[:timeStartedInMillis] = opts[:time_started_in_millis] if opts[:time_started_in_millis] query_params[:timeEndedInMillis] = opts[:time_ended_in_millis] if opts[:time_ended_in_millis] # 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: 'DataIntegrationClient#list_copy_object_requests') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::DataIntegration::Models::CopyObjectRequestSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_data_assets(workspace_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_data_assets API.
Retrieves a list of all data asset summaries.
6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 6741 def list_data_assets(workspace_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_data_assets.' if logger raise "Missing the required parameter 'workspace_id' when calling list_data_assets." if workspace_id.nil? if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' 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 raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/dataAssets'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty? query_params[:type] = opts[:type] if opts[:type] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:name] = opts[:name] if opts[:name] # 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: 'DataIntegrationClient#list_data_assets') 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::DataIntegration::Models::DataAssetSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_data_entities(workspace_id, connection_key, schema_resource_name, opts = {}) ⇒ Response
Click here to see an example of how to use list_data_entities API.
Lists a summary of data entities from the data asset using the specified connection.
6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 6828 def list_data_entities(workspace_id, connection_key, schema_resource_name, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_data_entities.' if logger raise "Missing the required parameter 'workspace_id' when calling list_data_entities." if workspace_id.nil? raise "Missing the required parameter 'connection_key' when calling list_data_entities." if connection_key.nil? raise "Missing the required parameter 'schema_resource_name' when calling list_data_entities." if schema_resource_name.nil? if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' 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 raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'connection_key' must not be blank" if OCI::Internal::Util.blank_string?(connection_key) raise "Parameter value for 'schema_resource_name' must not be blank" if OCI::Internal::Util.blank_string?(schema_resource_name) path = '/workspaces/{workspaceId}/connections/{connectionKey}/schemas/{schemaResourceName}/dataEntities'.sub('{workspaceId}', workspace_id.to_s).sub('{connectionKey}', connection_key.to_s).sub('{schemaResourceName}', schema_resource_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:name] = opts[:name] if opts[:name] query_params[:page] = opts[:page] if opts[:page] query_params[:type] = opts[:type] if opts[:type] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty? query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:nameList] = OCI::ApiClient.build_collection_params(opts[:name_list], :multi) if opts[:name_list] && !opts[:name_list].empty? query_params[:isPattern] = opts[:is_pattern] if !opts[:is_pattern].nil? query_params[:includeTypes] = OCI::ApiClient.build_collection_params(opts[:include_types], :multi) if opts[:include_types] && !opts[:include_types].empty? # 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: 'DataIntegrationClient#list_data_entities') 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::DataIntegration::Models::DataEntitySummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_data_flow_validations(workspace_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_data_flow_validations API.
Retrieves a list of data flow validations within the specified workspace.
6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 6917 def list_data_flow_validations(workspace_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_data_flow_validations.' if logger raise "Missing the required parameter 'workspace_id' when calling list_data_flow_validations." if workspace_id.nil? if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' 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 raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/dataFlowValidations'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:key] = opts[:key] if opts[:key] query_params[:name] = opts[:name] if opts[:name] query_params[:identifier] = opts[:identifier] if opts[:identifier] query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty? query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] 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: 'DataIntegrationClient#list_data_flow_validations') 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::DataIntegration::Models::DataFlowValidationSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_data_flows(workspace_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_data_flows API.
Retrieves a list of data flows in a project or folder.
7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 7001 def list_data_flows(workspace_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_data_flows.' if logger raise "Missing the required parameter 'workspace_id' when calling list_data_flows." if workspace_id.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' end raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/dataFlows'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:folderId] = opts[:folder_id] if opts[:folder_id] query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty? query_params[:name] = opts[:name] if opts[:name] query_params[:identifier] = OCI::ApiClient.build_collection_params(opts[:identifier], :multi) if opts[:identifier] && !opts[:identifier].empty? query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#list_data_flows') 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::DataIntegration::Models::DataFlowSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_dependent_objects(workspace_id, application_key, opts = {}) ⇒ Response
Click here to see an example of how to use list_dependent_objects API.
Retrieves a list of all dependent objects for a specific application.
7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 7094 def list_dependent_objects(workspace_id, application_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_dependent_objects.' if logger raise "Missing the required parameter 'workspace_id' when calling list_dependent_objects." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling list_dependent_objects." if application_key.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' end raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/dependentObjects'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty? query_params[:name] = opts[:name] if opts[:name] query_params[:nameContains] = opts[:name_contains] if opts[:name_contains] query_params[:identifier] = OCI::ApiClient.build_collection_params(opts[:identifier], :multi) if opts[:identifier] && !opts[:identifier].empty? query_params[:type] = OCI::ApiClient.build_collection_params(opts[:type], :multi) if opts[:type] && !opts[:type].empty? query_params[:typeInSubtree] = opts[:type_in_subtree] if opts[:type_in_subtree] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#list_dependent_objects') 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::DataIntegration::Models::DependentObjectSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_dis_application_task_run_lineages(workspace_id, dis_application_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_dis_application_task_run_lineages API.
This endpoint can be used to list Task Run Lineages within a given time window.
7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 7185 def list_dis_application_task_run_lineages(workspace_id, dis_application_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_dis_application_task_run_lineages.' if logger raise "Missing the required parameter 'workspace_id' when calling list_dis_application_task_run_lineages." if workspace_id.nil? raise "Missing the required parameter 'dis_application_id' when calling list_dis_application_task_run_lineages." if dis_application_id.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' end raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'dis_application_id' must not be blank" if OCI::Internal::Util.blank_string?(dis_application_id) path = '/workspaces/{workspaceId}/disApplications/{disApplicationId}/taskRunLineages'.sub('{workspaceId}', workspace_id.to_s).sub('{disApplicationId}', dis_application_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty? query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:filter] = OCI::ApiClient.build_collection_params(opts[:filter], :multi) if opts[:filter] && !opts[:filter].empty? query_params[:timeUpdatedGreaterThan] = opts[:time_updated_greater_than] if opts[:time_updated_greater_than] query_params[:timeUpdatedGreaterThanOrEqualTo] = opts[:time_updated_greater_than_or_equal_to] if opts[:time_updated_greater_than_or_equal_to] query_params[:timeUpatedLessThan] = opts[:time_upated_less_than] if opts[:time_upated_less_than] query_params[:timeUpatedLessThanOrEqualTo] = opts[:time_upated_less_than_or_equal_to] if opts[:time_upated_less_than_or_equal_to] # 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: 'DataIntegrationClient#list_dis_application_task_run_lineages') 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::DataIntegration::Models::TaskRunLineageSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_dis_applications(workspace_id, compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_dis_applications API.
Retrieves a list of DIS Applications in a compartment and provides options to filter the list.
7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 7274 def list_dis_applications(workspace_id, compartment_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_dis_applications.' if logger raise "Missing the required parameter 'workspace_id' when calling list_dis_applications." if workspace_id.nil? raise "Missing the required parameter 'compartment_id' when calling list_dis_applications." if compartment_id.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' end raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/disApplications'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:name] = opts[:name] if opts[:name] query_params[:nameContains] = opts[:name_contains] if opts[:name_contains] query_params[:identifier] = OCI::ApiClient.build_collection_params(opts[:identifier], :multi) if opts[:identifier] && !opts[:identifier].empty? query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty? query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#list_dis_applications') 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::DataIntegration::Models::DisApplicationSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_export_requests(workspace_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_export_requests API.
This endpoint can be used to get the list of export object requests.
7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 7363 def list_export_requests(workspace_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_export_requests.' if logger raise "Missing the required parameter 'workspace_id' when calling list_export_requests." if workspace_id.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' end if opts[:export_status] && !%w[IN_PROGRESS SUCCESSFUL QUEUED TERMINATING TERMINATED FAILED].include?(opts[:export_status]) raise 'Invalid value for "export_status", must be one of IN_PROGRESS, SUCCESSFUL, QUEUED, TERMINATING, TERMINATED, FAILED.' end if opts[:projection] && !%w[SUMMARY DETAILS].include?(opts[:projection]) raise 'Invalid value for "projection", must be one of SUMMARY, DETAILS.' end raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/exportRequests'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:name] = opts[:name] if opts[:name] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:exportStatus] = opts[:export_status] if opts[:export_status] query_params[:projection] = opts[:projection] if opts[:projection] query_params[:timeStartedInMillis] = opts[:time_started_in_millis] if opts[:time_started_in_millis] query_params[:timeEndedInMillis] = opts[:time_ended_in_millis] if opts[:time_ended_in_millis] # 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: 'DataIntegrationClient#list_export_requests') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::DataIntegration::Models::ExportRequestSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_external_publication_validations(workspace_id, task_key, opts = {}) ⇒ Response
Click here to see an example of how to use list_external_publication_validations API.
Retrieves a lists of external publication validations in a workspace and provides options to filter the list.
7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 7456 def list_external_publication_validations(workspace_id, task_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_external_publication_validations.' if logger raise "Missing the required parameter 'workspace_id' when calling list_external_publication_validations." if workspace_id.nil? raise "Missing the required parameter 'task_key' when calling list_external_publication_validations." if task_key.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' end raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'task_key' must not be blank" if OCI::Internal::Util.blank_string?(task_key) path = '/workspaces/{workspaceId}/tasks/{taskKey}/externalPublicationValidations'.sub('{workspaceId}', workspace_id.to_s).sub('{taskKey}', task_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty? query_params[:name] = opts[:name] if opts[:name] query_params[:identifier] = OCI::ApiClient.build_collection_params(opts[:identifier], :multi) if opts[:identifier] && !opts[:identifier].empty? query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#list_external_publication_validations') 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::DataIntegration::Models::ExternalPublicationValidationSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_external_publications(workspace_id, task_key, opts = {}) ⇒ Response
Click here to see an example of how to use list_external_publications API.
Retrieves a list of external publications in an application and provides options to filter the list.
7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 7539 def list_external_publications(workspace_id, task_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_external_publications.' if logger raise "Missing the required parameter 'workspace_id' when calling list_external_publications." if workspace_id.nil? raise "Missing the required parameter 'task_key' when calling list_external_publications." if task_key.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' end raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'task_key' must not be blank" if OCI::Internal::Util.blank_string?(task_key) path = '/workspaces/{workspaceId}/tasks/{taskKey}/externalPublications'.sub('{workspaceId}', workspace_id.to_s).sub('{taskKey}', task_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty? query_params[:name] = opts[:name] if opts[:name] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#list_external_publications') 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::DataIntegration::Models::ExternalPublicationSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_folders(workspace_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_folders API.
Retrieves a list of folders in a project and provides options to filter the list.
7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 7625 def list_folders(workspace_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_folders.' if logger raise "Missing the required parameter 'workspace_id' when calling list_folders." if workspace_id.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' end raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/folders'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:aggregatorKey] = opts[:aggregator_key] if opts[:aggregator_key] query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty? query_params[:name] = opts[:name] if opts[:name] query_params[:nameContains] = opts[:name_contains] if opts[:name_contains] query_params[:identifier] = OCI::ApiClient.build_collection_params(opts[:identifier], :multi) if opts[:identifier] && !opts[:identifier].empty? query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#list_folders') 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::DataIntegration::Models::FolderSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_function_libraries(workspace_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_function_libraries API.
Retrieves a list of function libraries in a project and provides options to filter the list.
7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 7711 def list_function_libraries(workspace_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_function_libraries.' if logger raise "Missing the required parameter 'workspace_id' when calling list_function_libraries." if workspace_id.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' end raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/functionLibraries'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:aggregatorKey] = opts[:aggregator_key] if opts[:aggregator_key] query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty? query_params[:name] = opts[:name] if opts[:name] query_params[:identifier] = OCI::ApiClient.build_collection_params(opts[:identifier], :multi) if opts[:identifier] && !opts[:identifier].empty? query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#list_function_libraries') 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::DataIntegration::Models::FunctionLibrarySummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_import_requests(workspace_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_import_requests API.
This endpoint can be used to get the list of import object requests.
7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 7798 def list_import_requests(workspace_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_import_requests.' if logger raise "Missing the required parameter 'workspace_id' when calling list_import_requests." if workspace_id.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' end if opts[:import_status] && !%w[IN_PROGRESS SUCCESSFUL QUEUED TERMINATING TERMINATED FAILED].include?(opts[:import_status]) raise 'Invalid value for "import_status", must be one of IN_PROGRESS, SUCCESSFUL, QUEUED, TERMINATING, TERMINATED, FAILED.' end if opts[:projection] && !%w[SUMMARY DETAILS].include?(opts[:projection]) raise 'Invalid value for "projection", must be one of SUMMARY, DETAILS.' end raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/importRequests'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:name] = opts[:name] if opts[:name] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:importStatus] = opts[:import_status] if opts[:import_status] query_params[:projection] = opts[:projection] if opts[:projection] query_params[:timeStartedInMillis] = opts[:time_started_in_millis] if opts[:time_started_in_millis] query_params[:timeEndedInMillis] = opts[:time_ended_in_millis] if opts[:time_ended_in_millis] # 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: 'DataIntegrationClient#list_import_requests') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::DataIntegration::Models::ImportRequestSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_patch_changes(workspace_id, application_key, opts = {}) ⇒ Response
Click here to see an example of how to use list_patch_changes API.
Retrieves a list of patches in an application and provides options to filter the list.
7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 7890 def list_patch_changes(workspace_id, application_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_patch_changes.' if logger raise "Missing the required parameter 'workspace_id' when calling list_patch_changes." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling list_patch_changes." if application_key.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' end raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/patchChanges'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:name] = opts[:name] if opts[:name] query_params[:sincePatch] = opts[:since_patch] if opts[:since_patch] query_params[:toPatch] = opts[:to_patch] if opts[:to_patch] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#list_patch_changes') 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::DataIntegration::Models::PatchChangeSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_patches(workspace_id, application_key, opts = {}) ⇒ Response
Click here to see an example of how to use list_patches API.
Retrieves a list of patches in an application and provides options to filter the list. For listing changes based on a period and logical objects changed, see ListPatchChanges API.
7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 7975 def list_patches(workspace_id, application_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_patches.' if logger raise "Missing the required parameter 'workspace_id' when calling list_patches." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling list_patches." if application_key.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' end raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/patches'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:name] = opts[:name] if opts[:name] query_params[:identifier] = OCI::ApiClient.build_collection_params(opts[:identifier], :multi) if opts[:identifier] && !opts[:identifier].empty? query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty? query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#list_patches') 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::DataIntegration::Models::PatchSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_pipeline_validations(workspace_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_pipeline_validations API.
Retrieves a list of pipeline validations within the specified workspace.
8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 8059 def list_pipeline_validations(workspace_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_pipeline_validations.' if logger raise "Missing the required parameter 'workspace_id' when calling list_pipeline_validations." if workspace_id.nil? if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' 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 raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/pipelineValidations'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:key] = opts[:key] if opts[:key] query_params[:name] = opts[:name] if opts[:name] query_params[:identifier] = opts[:identifier] if opts[:identifier] query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty? query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] 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: 'DataIntegrationClient#list_pipeline_validations') 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::DataIntegration::Models::PipelineValidationSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_pipelines(workspace_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_pipelines API.
Retrieves a list of pipelines in a project or folder from within a workspace, the query parameter specifies the project or folder.
8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 8144 def list_pipelines(workspace_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_pipelines.' if logger raise "Missing the required parameter 'workspace_id' when calling list_pipelines." if workspace_id.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' end raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/pipelines'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:aggregatorKey] = opts[:aggregator_key] if opts[:aggregator_key] query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty? query_params[:name] = opts[:name] if opts[:name] query_params[:identifier] = OCI::ApiClient.build_collection_params(opts[:identifier], :multi) if opts[:identifier] && !opts[:identifier].empty? query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#list_pipelines') 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::DataIntegration::Models::PipelineSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_projects(workspace_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_projects API.
Retrieves a lists of projects in a workspace and provides options to filter the list.
8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 8228 def list_projects(workspace_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_projects.' if logger raise "Missing the required parameter 'workspace_id' when calling list_projects." if workspace_id.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' end raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/projects'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty? query_params[:name] = opts[:name] if opts[:name] query_params[:nameContains] = opts[:name_contains] if opts[:name_contains] query_params[:identifier] = OCI::ApiClient.build_collection_params(opts[:identifier], :multi) if opts[:identifier] && !opts[:identifier].empty? query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#list_projects') 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::DataIntegration::Models::ProjectSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_published_objects(workspace_id, application_key, opts = {}) ⇒ Response
Click here to see an example of how to use list_published_objects API.
Retrieves a list of all the published objects for a specified application.
8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 8322 def list_published_objects(workspace_id, application_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_published_objects.' if logger raise "Missing the required parameter 'workspace_id' when calling list_published_objects." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling list_published_objects." if application_key.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' end raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/publishedObjects'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty? query_params[:name] = opts[:name] if opts[:name] query_params[:nameStartsWith] = opts[:name_starts_with] if opts[:name_starts_with] query_params[:nameContains] = opts[:name_contains] if opts[:name_contains] query_params[:identifier] = OCI::ApiClient.build_collection_params(opts[:identifier], :multi) if opts[:identifier] && !opts[:identifier].empty? query_params[:type] = OCI::ApiClient.build_collection_params(opts[:type], :multi) if opts[:type] && !opts[:type].empty? query_params[:typeInSubtree] = opts[:type_in_subtree] if opts[:type_in_subtree] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#list_published_objects') 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::DataIntegration::Models::PublishedObjectSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_references(workspace_id, application_key, opts = {}) ⇒ Response
Click here to see an example of how to use list_references API.
Retrieves a list of references in an application. Reference objects are created when dataflows and tasks use objects, such as data assets and connections.
8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 8408 def list_references(workspace_id, application_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_references.' if logger raise "Missing the required parameter 'workspace_id' when calling list_references." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling list_references." if application_key.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' end raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/references'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:name] = opts[:name] if opts[:name] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#list_references') 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::DataIntegration::Models::ReferenceSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_runtime_operators(workspace_id, application_key, runtime_pipeline_key, opts = {}) ⇒ Response
Click here to see an example of how to use list_runtime_operators API.
This endpoint can be used to list runtime operators with filtering options
8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 8494 def list_runtime_operators(workspace_id, application_key, runtime_pipeline_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_runtime_operators.' if logger raise "Missing the required parameter 'workspace_id' when calling list_runtime_operators." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling list_runtime_operators." if application_key.nil? raise "Missing the required parameter 'runtime_pipeline_key' when calling list_runtime_operators." if runtime_pipeline_key.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' end raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) raise "Parameter value for 'runtime_pipeline_key' must not be blank" if OCI::Internal::Util.blank_string?(runtime_pipeline_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/runtimePipelines/{runtimePipelineKey}/runtimeOperators'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s).sub('{runtimePipelineKey}', runtime_pipeline_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:key] = OCI::ApiClient.build_collection_params(opts[:key], :multi) if opts[:key] && !opts[:key].empty? query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty? query_params[:name] = opts[:name] if opts[:name] query_params[:identifier] = OCI::ApiClient.build_collection_params(opts[:identifier], :multi) if opts[:identifier] && !opts[:identifier].empty? query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:aggregatorType] = OCI::ApiClient.build_collection_params(opts[:aggregator_type], :multi) if opts[:aggregator_type] && !opts[:aggregator_type].empty? # 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: 'DataIntegrationClient#list_runtime_operators') 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::DataIntegration::Models::RuntimeOperatorSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_runtime_pipelines(workspace_id, application_key, opts = {}) ⇒ Response
Click here to see an example of how to use list_runtime_pipelines API.
This endpoint can be used to list runtime pipelines with filtering options
8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 8635 8636 8637 8638 8639 8640 8641 8642 8643 8644 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 8587 def list_runtime_pipelines(workspace_id, application_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_runtime_pipelines.' if logger raise "Missing the required parameter 'workspace_id' when calling list_runtime_pipelines." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling list_runtime_pipelines." if application_key.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' end raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/runtimePipelines'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:key] = OCI::ApiClient.build_collection_params(opts[:key], :multi) if opts[:key] && !opts[:key].empty? query_params[:aggregatorKey] = opts[:aggregator_key] if opts[:aggregator_key] query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty? query_params[:name] = opts[:name] if opts[:name] query_params[:identifier] = OCI::ApiClient.build_collection_params(opts[:identifier], :multi) if opts[:identifier] && !opts[:identifier].empty? query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:aggregatorType] = OCI::ApiClient.build_collection_params(opts[:aggregator_type], :multi) if opts[:aggregator_type] && !opts[:aggregator_type].empty? query_params[:filter] = OCI::ApiClient.build_collection_params(opts[:filter], :multi) if opts[:filter] && !opts[:filter].empty? # 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: 'DataIntegrationClient#list_runtime_pipelines') 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::DataIntegration::Models::RuntimePipelineSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_schedules(workspace_id, application_key, opts = {}) ⇒ Response
Click here to see an example of how to use list_schedules API.
Use this endpoint to list schedules.
8677 8678 8679 8680 8681 8682 8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721 8722 8723 8724 8725 8726 8727 8728 8729 8730 8731 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 8677 def list_schedules(workspace_id, application_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_schedules.' if logger raise "Missing the required parameter 'workspace_id' when calling list_schedules." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling list_schedules." if application_key.nil? if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' 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 raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/schedules'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:key] = OCI::ApiClient.build_collection_params(opts[:key], :multi) if opts[:key] && !opts[:key].empty? query_params[:name] = opts[:name] if opts[:name] query_params[:identifier] = OCI::ApiClient.build_collection_params(opts[:identifier], :multi) if opts[:identifier] && !opts[:identifier].empty? query_params[:type] = OCI::ApiClient.build_collection_params(opts[:type], :multi) if opts[:type] && !opts[:type].empty? query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] 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: 'DataIntegrationClient#list_schedules') 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::DataIntegration::Models::ScheduleSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_schemas(workspace_id, connection_key, schema_resource_name, opts = {}) ⇒ Response
Click here to see an example of how to use list_schemas API.
Retrieves a list of all the schemas that can be accessed using the specified connection.
8764 8765 8766 8767 8768 8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779 8780 8781 8782 8783 8784 8785 8786 8787 8788 8789 8790 8791 8792 8793 8794 8795 8796 8797 8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 8812 8813 8814 8815 8816 8817 8818 8819 8820 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 8764 def list_schemas(workspace_id, connection_key, schema_resource_name, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_schemas.' if logger raise "Missing the required parameter 'workspace_id' when calling list_schemas." if workspace_id.nil? raise "Missing the required parameter 'connection_key' when calling list_schemas." if connection_key.nil? raise "Missing the required parameter 'schema_resource_name' when calling list_schemas." if schema_resource_name.nil? if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' 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 raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'connection_key' must not be blank" if OCI::Internal::Util.blank_string?(connection_key) path = '/workspaces/{workspaceId}/connections/{connectionKey}/schemas'.sub('{workspaceId}', workspace_id.to_s).sub('{connectionKey}', connection_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:schemaResourceName] = schema_resource_name query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty? query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:name] = opts[:name] if opts[:name] query_params[:nameList] = OCI::ApiClient.build_collection_params(opts[:name_list], :multi) if opts[:name_list] && !opts[:name_list].empty? query_params[:includeTypes] = OCI::ApiClient.build_collection_params(opts[:include_types], :multi) if opts[:include_types] && !opts[:include_types].empty? # 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: 'DataIntegrationClient#list_schemas') 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::DataIntegration::Models::SchemaSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_task_run_lineages(workspace_id, application_key, opts = {}) ⇒ Response
Click here to see an example of how to use list_task_run_lineages API.
This endpoint can be used to list Task Run Lineages within a given time window.
8855 8856 8857 8858 8859 8860 8861 8862 8863 8864 8865 8866 8867 8868 8869 8870 8871 8872 8873 8874 8875 8876 8877 8878 8879 8880 8881 8882 8883 8884 8885 8886 8887 8888 8889 8890 8891 8892 8893 8894 8895 8896 8897 8898 8899 8900 8901 8902 8903 8904 8905 8906 8907 8908 8909 8910 8911 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 8855 def list_task_run_lineages(workspace_id, application_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_task_run_lineages.' if logger raise "Missing the required parameter 'workspace_id' when calling list_task_run_lineages." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling list_task_run_lineages." if application_key.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' end raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/taskRunLineages'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty? query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:filter] = OCI::ApiClient.build_collection_params(opts[:filter], :multi) if opts[:filter] && !opts[:filter].empty? query_params[:timeUpdatedGreaterThan] = opts[:time_updated_greater_than] if opts[:time_updated_greater_than] query_params[:timeUpdatedGreaterThanOrEqualTo] = opts[:time_updated_greater_than_or_equal_to] if opts[:time_updated_greater_than_or_equal_to] query_params[:timeUpatedLessThan] = opts[:time_upated_less_than] if opts[:time_upated_less_than] query_params[:timeUpatedLessThanOrEqualTo] = opts[:time_upated_less_than_or_equal_to] if opts[:time_upated_less_than_or_equal_to] # 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: 'DataIntegrationClient#list_task_run_lineages') 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::DataIntegration::Models::TaskRunLineageSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_task_run_logs(workspace_id, application_key, task_run_key, opts = {}) ⇒ Response
Click here to see an example of how to use list_task_run_logs API.
Gets log entries for task runs using its key.
8940 8941 8942 8943 8944 8945 8946 8947 8948 8949 8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962 8963 8964 8965 8966 8967 8968 8969 8970 8971 8972 8973 8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 8986 8987 8988 8989 8990 8991 8992 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 8940 def list_task_run_logs(workspace_id, application_key, task_run_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_task_run_logs.' if logger raise "Missing the required parameter 'workspace_id' when calling list_task_run_logs." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling list_task_run_logs." if application_key.nil? raise "Missing the required parameter 'task_run_key' when calling list_task_run_logs." if task_run_key.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' end raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) raise "Parameter value for 'task_run_key' must not be blank" if OCI::Internal::Util.blank_string?(task_run_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/taskRuns/{taskRunKey}/logs'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s).sub('{taskRunKey}', task_run_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#list_task_run_logs') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::DataIntegration::Models::TaskRunLogSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_task_runs(workspace_id, application_key, opts = {}) ⇒ Response
Click here to see an example of how to use list_task_runs API.
Retrieves a list of task runs and provides options to filter the list.
9029 9030 9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041 9042 9043 9044 9045 9046 9047 9048 9049 9050 9051 9052 9053 9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065 9066 9067 9068 9069 9070 9071 9072 9073 9074 9075 9076 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086 9087 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 9029 def list_task_runs(workspace_id, application_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_task_runs.' if logger raise "Missing the required parameter 'workspace_id' when calling list_task_runs." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling list_task_runs." if application_key.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' end raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/taskRuns'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:key] = OCI::ApiClient.build_collection_params(opts[:key], :multi) if opts[:key] && !opts[:key].empty? query_params[:aggregatorKey] = opts[:aggregator_key] if opts[:aggregator_key] query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty? query_params[:name] = opts[:name] if opts[:name] query_params[:identifier] = OCI::ApiClient.build_collection_params(opts[:identifier], :multi) if opts[:identifier] && !opts[:identifier].empty? query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:filter] = OCI::ApiClient.build_collection_params(opts[:filter], :multi) if opts[:filter] && !opts[:filter].empty? query_params[:nameStartsWith] = opts[:name_starts_with] if opts[:name_starts_with] query_params[:nameContains] = opts[:name_contains] if opts[:name_contains] # 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: 'DataIntegrationClient#list_task_runs') 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::DataIntegration::Models::TaskRunSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_task_schedules(workspace_id, application_key, opts = {}) ⇒ Response
Click here to see an example of how to use list_task_schedules API.
This endpoint can be used to get the list of all the TaskSchedule objects.
9121 9122 9123 9124 9125 9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 9121 def list_task_schedules(workspace_id, application_key, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_task_schedules.' if logger raise "Missing the required parameter 'workspace_id' when calling list_task_schedules." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling list_task_schedules." if application_key.nil? if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' 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 raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/taskSchedules'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:key] = OCI::ApiClient.build_collection_params(opts[:key], :multi) if opts[:key] && !opts[:key].empty? query_params[:name] = opts[:name] if opts[:name] query_params[:identifier] = OCI::ApiClient.build_collection_params(opts[:identifier], :multi) if opts[:identifier] && !opts[:identifier].empty? query_params[:type] = OCI::ApiClient.build_collection_params(opts[:type], :multi) if opts[:type] && !opts[:type].empty? query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:isEnabled] = opts[:is_enabled] if !opts[:is_enabled].nil? # 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: 'DataIntegrationClient#list_task_schedules') 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::DataIntegration::Models::TaskScheduleSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_task_validations(workspace_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_task_validations API.
Retrieves a list of task validations within the specified workspace.
9208 9209 9210 9211 9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232 9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 9208 def list_task_validations(workspace_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_task_validations.' if logger raise "Missing the required parameter 'workspace_id' when calling list_task_validations." if workspace_id.nil? if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' 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 raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/taskValidations'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:key] = opts[:key] if opts[:key] query_params[:name] = opts[:name] if opts[:name] query_params[:identifier] = opts[:identifier] if opts[:identifier] query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty? query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] 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: 'DataIntegrationClient#list_task_validations') 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::DataIntegration::Models::TaskValidationSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_tasks(workspace_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_tasks API.
Retrieves a list of all tasks in a specified project or folder.
9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 9315 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325 9326 9327 9328 9329 9330 9331 9332 9333 9334 9335 9336 9337 9338 9339 9340 9341 9342 9343 9344 9345 9346 9347 9348 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 9294 def list_tasks(workspace_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_tasks.' if logger raise "Missing the required parameter 'workspace_id' when calling list_tasks." if workspace_id.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' end raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/tasks'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:folderId] = opts[:folder_id] if opts[:folder_id] query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty? query_params[:name] = opts[:name] if opts[:name] query_params[:key] = OCI::ApiClient.build_collection_params(opts[:key], :multi) if opts[:key] && !opts[:key].empty? query_params[:identifier] = OCI::ApiClient.build_collection_params(opts[:identifier], :multi) if opts[:identifier] && !opts[:identifier].empty? query_params[:type] = OCI::ApiClient.build_collection_params(opts[:type], :multi) if opts[:type] && !opts[:type].empty? query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#list_tasks') 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::DataIntegration::Models::TaskSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_templates(workspace_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_templates API.
This endpoint can be used to list application templates with filtering options.
9379 9380 9381 9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 9430 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 9379 def list_templates(workspace_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_templates.' if logger raise "Missing the required parameter 'workspace_id' when calling list_templates." if workspace_id.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' end raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/templates'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:name] = opts[:name] if opts[:name] query_params[:identifier] = OCI::ApiClient.build_collection_params(opts[:identifier], :multi) if opts[:identifier] && !opts[:identifier].empty? query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty? query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#list_templates') 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::DataIntegration::Models::TemplateSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_user_defined_function_validations(workspace_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_user_defined_function_validations API.
Retrieves a list of UserDefinedFunctionvalidations within the specified workspace.
9461 9462 9463 9464 9465 9466 9467 9468 9469 9470 9471 9472 9473 9474 9475 9476 9477 9478 9479 9480 9481 9482 9483 9484 9485 9486 9487 9488 9489 9490 9491 9492 9493 9494 9495 9496 9497 9498 9499 9500 9501 9502 9503 9504 9505 9506 9507 9508 9509 9510 9511 9512 9513 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 9461 def list_user_defined_function_validations(workspace_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_user_defined_function_validations.' if logger raise "Missing the required parameter 'workspace_id' when calling list_user_defined_function_validations." if workspace_id.nil? if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' 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 raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/userDefinedFunctionValidations'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:key] = opts[:key] if opts[:key] query_params[:name] = opts[:name] if opts[:name] query_params[:identifier] = opts[:identifier] if opts[:identifier] query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty? query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] 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: 'DataIntegrationClient#list_user_defined_function_validations') 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::DataIntegration::Models::UserDefinedFunctionValidationSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_user_defined_functions(workspace_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_user_defined_functions API.
Retrieves a list of UserDefinedFunctions in a function library.
9545 9546 9547 9548 9549 9550 9551 9552 9553 9554 9555 9556 9557 9558 9559 9560 9561 9562 9563 9564 9565 9566 9567 9568 9569 9570 9571 9572 9573 9574 9575 9576 9577 9578 9579 9580 9581 9582 9583 9584 9585 9586 9587 9588 9589 9590 9591 9592 9593 9594 9595 9596 9597 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 9545 def list_user_defined_functions(workspace_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_user_defined_functions.' if logger raise "Missing the required parameter 'workspace_id' when calling list_user_defined_functions." if workspace_id.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' end raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/userDefinedFunctions'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:functionLibraryKey] = opts[:function_library_key] if opts[:function_library_key] query_params[:fields] = OCI::ApiClient.build_collection_params(opts[:fields], :multi) if opts[:fields] && !opts[:fields].empty? query_params[:name] = opts[:name] if opts[:name] query_params[:identifier] = OCI::ApiClient.build_collection_params(opts[:identifier], :multi) if opts[:identifier] && !opts[:identifier].empty? query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#list_user_defined_functions') 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::DataIntegration::Models::UserDefinedFunctionSummaryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_work_request_errors(work_request_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_work_request_errors API.
Retrieves a paginated list of errors for a given work request.
9625 9626 9627 9628 9629 9630 9631 9632 9633 9634 9635 9636 9637 9638 9639 9640 9641 9642 9643 9644 9645 9646 9647 9648 9649 9650 9651 9652 9653 9654 9655 9656 9657 9658 9659 9660 9661 9662 9663 9664 9665 9666 9667 9668 9669 9670 9671 9672 9673 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 9625 def list_work_request_errors(work_request_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_work_request_errors.' if logger raise "Missing the required parameter 'work_request_id' when calling list_work_request_errors." if work_request_id.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' end raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id) path = '/workRequests/{workRequestId}/workRequestErrors'.sub('{workRequestId}', work_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#list_work_request_errors') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::DataIntegration::Models::WorkRequestError>' ) end # rubocop:enable Metrics/BlockLength end |
#list_work_request_logs(work_request_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_work_request_logs API.
Retrieves a paginated list of logs for a given work request.
9701 9702 9703 9704 9705 9706 9707 9708 9709 9710 9711 9712 9713 9714 9715 9716 9717 9718 9719 9720 9721 9722 9723 9724 9725 9726 9727 9728 9729 9730 9731 9732 9733 9734 9735 9736 9737 9738 9739 9740 9741 9742 9743 9744 9745 9746 9747 9748 9749 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 9701 def list_work_request_logs(work_request_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_work_request_logs.' if logger raise "Missing the required parameter 'work_request_id' when calling list_work_request_logs." if work_request_id.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' end raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id) path = '/workRequests/{workRequestId}/logs'.sub('{workRequestId}', work_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#list_work_request_logs') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::DataIntegration::Models::WorkRequestLogEntry>' ) end # rubocop:enable Metrics/BlockLength end |
#list_work_requests(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_work_requests API.
Lists the work requests in a compartment.
9780 9781 9782 9783 9784 9785 9786 9787 9788 9789 9790 9791 9792 9793 9794 9795 9796 9797 9798 9799 9800 9801 9802 9803 9804 9805 9806 9807 9808 9809 9810 9811 9812 9813 9814 9815 9816 9817 9818 9819 9820 9821 9822 9823 9824 9825 9826 9827 9828 9829 9830 9831 9832 9833 9834 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 9780 def list_work_requests(compartment_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_work_requests.' if logger raise "Missing the required parameter 'compartment_id' when calling list_work_requests." if compartment_id.nil? if opts[:work_request_status] && !%w[ACCEPTED IN_PROGRESS FAILED SUCCEEDED CANCELING CANCELED].include?(opts[:work_request_status]) raise 'Invalid value for "work_request_status", must be one of ACCEPTED, IN_PROGRESS, FAILED, SUCCEEDED, CANCELING, CANCELED.' 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 if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' end path = '/workRequests' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:workspaceId] = opts[:workspace_id] if opts[:workspace_id] query_params[:workRequestStatus] = opts[:work_request_status] if opts[:work_request_status] query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#list_work_requests') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::DataIntegration::Models::WorkRequestSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_workspaces(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_workspaces API.
Retrieves a list of Data Integration workspaces.
9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 9879 9880 9881 9882 9883 9884 9885 9886 9887 9888 9889 9890 9891 9892 9893 9894 9895 9896 9897 9898 9899 9900 9901 9902 9903 9904 9905 9906 9907 9908 9909 9910 9911 9912 9913 9914 9915 9916 9917 9918 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 9864 def list_workspaces(compartment_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#list_workspaces.' if logger raise "Missing the required parameter 'compartment_id' when calling list_workspaces." if compartment_id.nil? if opts[:lifecycle_state] && !OCI::DataIntegration::Models::Workspace::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::DataIntegration::Models::Workspace::LIFECYCLE_STATE_ENUM.' 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 if opts[:sort_by] && !%w[TIME_CREATED DISPLAY_NAME TIME_UPDATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME, TIME_UPDATED.' end path = '/workspaces' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:name] = opts[:name] if opts[:name] query_params[: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[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#list_workspaces') 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::DataIntegration::Models::WorkspaceSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
94 95 96 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 94 def logger @api_client.config.logger end |
#start_workspace(workspace_id, opts = {}) ⇒ Response
Click here to see an example of how to use start_workspace API.
Starts a workspace.
9946 9947 9948 9949 9950 9951 9952 9953 9954 9955 9956 9957 9958 9959 9960 9961 9962 9963 9964 9965 9966 9967 9968 9969 9970 9971 9972 9973 9974 9975 9976 9977 9978 9979 9980 9981 9982 9983 9984 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 9946 def start_workspace(workspace_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#start_workspace.' if logger raise "Missing the required parameter 'workspace_id' when calling start_workspace." if workspace_id.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/actions/start'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#start_workspace') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#stop_workspace(workspace_id, opts = {}) ⇒ Response
Click here to see an example of how to use stop_workspace API.
Stops a workspace.
10014 10015 10016 10017 10018 10019 10020 10021 10022 10023 10024 10025 10026 10027 10028 10029 10030 10031 10032 10033 10034 10035 10036 10037 10038 10039 10040 10041 10042 10043 10044 10045 10046 10047 10048 10049 10050 10051 10052 10053 10054 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 10014 def stop_workspace(workspace_id, opts = {}) logger.debug 'Calling operation DataIntegrationClient#stop_workspace.' if logger raise "Missing the required parameter 'workspace_id' when calling stop_workspace." if workspace_id.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}/actions/stop'.sub('{workspaceId}', workspace_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:quiesceTimeout] = opts[:quiesce_timeout] if opts[:quiesce_timeout] query_params[:isForceOperation] = opts[:is_force_operation] if !opts[:is_force_operation].nil? # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#stop_workspace') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#update_application(workspace_id, application_key, update_application_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_application API.
Updates an application.
10081 10082 10083 10084 10085 10086 10087 10088 10089 10090 10091 10092 10093 10094 10095 10096 10097 10098 10099 10100 10101 10102 10103 10104 10105 10106 10107 10108 10109 10110 10111 10112 10113 10114 10115 10116 10117 10118 10119 10120 10121 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 10081 def update_application(workspace_id, application_key, update_application_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#update_application.' if logger raise "Missing the required parameter 'workspace_id' when calling update_application." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling update_application." if application_key.nil? raise "Missing the required parameter 'update_application_details' when calling update_application." if update_application_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_application_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#update_application') 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::DataIntegration::Models::Application' ) end # rubocop:enable Metrics/BlockLength end |
#update_application_detailed_description(workspace_id, application_key, update_application_detailed_description_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_application_detailed_description API.
Updates the detailed description of an Application.
10148 10149 10150 10151 10152 10153 10154 10155 10156 10157 10158 10159 10160 10161 10162 10163 10164 10165 10166 10167 10168 10169 10170 10171 10172 10173 10174 10175 10176 10177 10178 10179 10180 10181 10182 10183 10184 10185 10186 10187 10188 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 10148 def update_application_detailed_description(workspace_id, application_key, update_application_detailed_description_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#update_application_detailed_description.' if logger raise "Missing the required parameter 'workspace_id' when calling update_application_detailed_description." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling update_application_detailed_description." if application_key.nil? raise "Missing the required parameter 'update_application_detailed_description_details' when calling update_application_detailed_description." if update_application_detailed_description_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/detailedDescription'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_application_detailed_description_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#update_application_detailed_description') 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::DataIntegration::Models::DetailedDescription' ) end # rubocop:enable Metrics/BlockLength end |
#update_connection(workspace_id, connection_key, update_connection_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_connection API.
Updates a connection under a data asset.
10215 10216 10217 10218 10219 10220 10221 10222 10223 10224 10225 10226 10227 10228 10229 10230 10231 10232 10233 10234 10235 10236 10237 10238 10239 10240 10241 10242 10243 10244 10245 10246 10247 10248 10249 10250 10251 10252 10253 10254 10255 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 10215 def update_connection(workspace_id, connection_key, update_connection_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#update_connection.' if logger raise "Missing the required parameter 'workspace_id' when calling update_connection." if workspace_id.nil? raise "Missing the required parameter 'connection_key' when calling update_connection." if connection_key.nil? raise "Missing the required parameter 'update_connection_details' when calling update_connection." if update_connection_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'connection_key' must not be blank" if OCI::Internal::Util.blank_string?(connection_key) path = '/workspaces/{workspaceId}/connections/{connectionKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{connectionKey}', connection_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_connection_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#update_connection') 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::DataIntegration::Models::Connection' ) end # rubocop:enable Metrics/BlockLength end |
#update_copy_object_request(workspace_id, copy_object_request_key, update_copy_object_request_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_copy_object_request API.
Updates the status of a copy object request.
10282 10283 10284 10285 10286 10287 10288 10289 10290 10291 10292 10293 10294 10295 10296 10297 10298 10299 10300 10301 10302 10303 10304 10305 10306 10307 10308 10309 10310 10311 10312 10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 10282 def update_copy_object_request(workspace_id, copy_object_request_key, update_copy_object_request_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#update_copy_object_request.' if logger raise "Missing the required parameter 'workspace_id' when calling update_copy_object_request." if workspace_id.nil? raise "Missing the required parameter 'copy_object_request_key' when calling update_copy_object_request." if copy_object_request_key.nil? raise "Missing the required parameter 'update_copy_object_request_details' when calling update_copy_object_request." if update_copy_object_request_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'copy_object_request_key' must not be blank" if OCI::Internal::Util.blank_string?(copy_object_request_key) path = '/workspaces/{workspaceId}/copyObjectRequests/{copyObjectRequestKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{copyObjectRequestKey}', copy_object_request_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_copy_object_request_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#update_copy_object_request') 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::DataIntegration::Models::CopyObjectRequest' ) end # rubocop:enable Metrics/BlockLength end |
#update_data_asset(workspace_id, data_asset_key, update_data_asset_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_data_asset API.
Updates a specific data asset with default connection.
10349 10350 10351 10352 10353 10354 10355 10356 10357 10358 10359 10360 10361 10362 10363 10364 10365 10366 10367 10368 10369 10370 10371 10372 10373 10374 10375 10376 10377 10378 10379 10380 10381 10382 10383 10384 10385 10386 10387 10388 10389 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 10349 def update_data_asset(workspace_id, data_asset_key, update_data_asset_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#update_data_asset.' if logger raise "Missing the required parameter 'workspace_id' when calling update_data_asset." if workspace_id.nil? raise "Missing the required parameter 'data_asset_key' when calling update_data_asset." if data_asset_key.nil? raise "Missing the required parameter 'update_data_asset_details' when calling update_data_asset." if update_data_asset_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'data_asset_key' must not be blank" if OCI::Internal::Util.blank_string?(data_asset_key) path = '/workspaces/{workspaceId}/dataAssets/{dataAssetKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{dataAssetKey}', data_asset_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_data_asset_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#update_data_asset') 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::DataIntegration::Models::DataAsset' ) end # rubocop:enable Metrics/BlockLength end |
#update_data_flow(workspace_id, data_flow_key, update_data_flow_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_data_flow API.
Updates a specific data flow.
10416 10417 10418 10419 10420 10421 10422 10423 10424 10425 10426 10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447 10448 10449 10450 10451 10452 10453 10454 10455 10456 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 10416 def update_data_flow(workspace_id, data_flow_key, update_data_flow_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#update_data_flow.' if logger raise "Missing the required parameter 'workspace_id' when calling update_data_flow." if workspace_id.nil? raise "Missing the required parameter 'data_flow_key' when calling update_data_flow." if data_flow_key.nil? raise "Missing the required parameter 'update_data_flow_details' when calling update_data_flow." if update_data_flow_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'data_flow_key' must not be blank" if OCI::Internal::Util.blank_string?(data_flow_key) path = '/workspaces/{workspaceId}/dataFlows/{dataFlowKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{dataFlowKey}', data_flow_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_data_flow_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#update_data_flow') 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::DataIntegration::Models::DataFlow' ) end # rubocop:enable Metrics/BlockLength end |
#update_dis_application(workspace_id, dis_application_id, update_dis_application_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_dis_application API.
Updates a DIS Application.
10483 10484 10485 10486 10487 10488 10489 10490 10491 10492 10493 10494 10495 10496 10497 10498 10499 10500 10501 10502 10503 10504 10505 10506 10507 10508 10509 10510 10511 10512 10513 10514 10515 10516 10517 10518 10519 10520 10521 10522 10523 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 10483 def update_dis_application(workspace_id, dis_application_id, update_dis_application_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#update_dis_application.' if logger raise "Missing the required parameter 'workspace_id' when calling update_dis_application." if workspace_id.nil? raise "Missing the required parameter 'dis_application_id' when calling update_dis_application." if dis_application_id.nil? raise "Missing the required parameter 'update_dis_application_details' when calling update_dis_application." if update_dis_application_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'dis_application_id' must not be blank" if OCI::Internal::Util.blank_string?(dis_application_id) path = '/workspaces/{workspaceId}/disApplications/{disApplicationId}'.sub('{workspaceId}', workspace_id.to_s).sub('{disApplicationId}', dis_application_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_dis_application_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#update_dis_application') 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::DataIntegration::Models::DisApplication' ) end # rubocop:enable Metrics/BlockLength end |
#update_dis_application_detailed_description(workspace_id, application_key, update_dis_application_detailed_description_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_dis_application_detailed_description API.
Updates the detailed description of an Application.
10550 10551 10552 10553 10554 10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 10570 10571 10572 10573 10574 10575 10576 10577 10578 10579 10580 10581 10582 10583 10584 10585 10586 10587 10588 10589 10590 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 10550 def update_dis_application_detailed_description(workspace_id, application_key, update_dis_application_detailed_description_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#update_dis_application_detailed_description.' if logger raise "Missing the required parameter 'workspace_id' when calling update_dis_application_detailed_description." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling update_dis_application_detailed_description." if application_key.nil? raise "Missing the required parameter 'update_dis_application_detailed_description_details' when calling update_dis_application_detailed_description." if update_dis_application_detailed_description_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) path = '/workspaces/{workspaceId}/disApplications/{applicationKey}/detailedDescription'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_dis_application_detailed_description_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#update_dis_application_detailed_description') 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::DataIntegration::Models::DetailedDescription' ) end # rubocop:enable Metrics/BlockLength end |
#update_export_request(workspace_id, export_request_key, update_export_request_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_export_request API.
Updates the status of a export object request.
10617 10618 10619 10620 10621 10622 10623 10624 10625 10626 10627 10628 10629 10630 10631 10632 10633 10634 10635 10636 10637 10638 10639 10640 10641 10642 10643 10644 10645 10646 10647 10648 10649 10650 10651 10652 10653 10654 10655 10656 10657 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 10617 def update_export_request(workspace_id, export_request_key, update_export_request_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#update_export_request.' if logger raise "Missing the required parameter 'workspace_id' when calling update_export_request." if workspace_id.nil? raise "Missing the required parameter 'export_request_key' when calling update_export_request." if export_request_key.nil? raise "Missing the required parameter 'update_export_request_details' when calling update_export_request." if update_export_request_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'export_request_key' must not be blank" if OCI::Internal::Util.blank_string?(export_request_key) path = '/workspaces/{workspaceId}/exportRequests/{exportRequestKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{exportRequestKey}', export_request_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_export_request_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#update_export_request') 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::DataIntegration::Models::ExportRequest' ) end # rubocop:enable Metrics/BlockLength end |
#update_external_publication(workspace_id, task_key, external_publications_key, update_external_publication_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_external_publication API.
Updates the external publication object.
10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 10702 10703 10704 10705 10706 10707 10708 10709 10710 10711 10712 10713 10714 10715 10716 10717 10718 10719 10720 10721 10722 10723 10724 10725 10726 10727 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 10685 def update_external_publication(workspace_id, task_key, external_publications_key, update_external_publication_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#update_external_publication.' if logger raise "Missing the required parameter 'workspace_id' when calling update_external_publication." if workspace_id.nil? raise "Missing the required parameter 'task_key' when calling update_external_publication." if task_key.nil? raise "Missing the required parameter 'external_publications_key' when calling update_external_publication." if external_publications_key.nil? raise "Missing the required parameter 'update_external_publication_details' when calling update_external_publication." if update_external_publication_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'task_key' must not be blank" if OCI::Internal::Util.blank_string?(task_key) raise "Parameter value for 'external_publications_key' must not be blank" if OCI::Internal::Util.blank_string?(external_publications_key) path = '/workspaces/{workspaceId}/tasks/{taskKey}/externalPublications/{externalPublicationsKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{taskKey}', task_key.to_s).sub('{externalPublicationsKey}', external_publications_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_external_publication_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#update_external_publication') 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::DataIntegration::Models::ExternalPublication' ) end # rubocop:enable Metrics/BlockLength end |
#update_folder(workspace_id, folder_key, update_folder_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_folder API.
Updates a specific folder.
10754 10755 10756 10757 10758 10759 10760 10761 10762 10763 10764 10765 10766 10767 10768 10769 10770 10771 10772 10773 10774 10775 10776 10777 10778 10779 10780 10781 10782 10783 10784 10785 10786 10787 10788 10789 10790 10791 10792 10793 10794 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 10754 def update_folder(workspace_id, folder_key, update_folder_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#update_folder.' if logger raise "Missing the required parameter 'workspace_id' when calling update_folder." if workspace_id.nil? raise "Missing the required parameter 'folder_key' when calling update_folder." if folder_key.nil? raise "Missing the required parameter 'update_folder_details' when calling update_folder." if update_folder_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'folder_key' must not be blank" if OCI::Internal::Util.blank_string?(folder_key) path = '/workspaces/{workspaceId}/folders/{folderKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{folderKey}', folder_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_folder_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#update_folder') 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::DataIntegration::Models::Folder' ) end # rubocop:enable Metrics/BlockLength end |
#update_function_library(workspace_id, function_library_key, update_function_library_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_function_library API.
Updates a specific Function Library.
10821 10822 10823 10824 10825 10826 10827 10828 10829 10830 10831 10832 10833 10834 10835 10836 10837 10838 10839 10840 10841 10842 10843 10844 10845 10846 10847 10848 10849 10850 10851 10852 10853 10854 10855 10856 10857 10858 10859 10860 10861 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 10821 def update_function_library(workspace_id, function_library_key, update_function_library_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#update_function_library.' if logger raise "Missing the required parameter 'workspace_id' when calling update_function_library." if workspace_id.nil? raise "Missing the required parameter 'function_library_key' when calling update_function_library." if function_library_key.nil? raise "Missing the required parameter 'update_function_library_details' when calling update_function_library." if update_function_library_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'function_library_key' must not be blank" if OCI::Internal::Util.blank_string?(function_library_key) path = '/workspaces/{workspaceId}/functionLibraries/{functionLibraryKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{functionLibraryKey}', function_library_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_function_library_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#update_function_library') 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::DataIntegration::Models::FunctionLibrary' ) end # rubocop:enable Metrics/BlockLength end |
#update_import_request(workspace_id, import_request_key, update_import_request_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_import_request API.
Updates the status of a import object request.
10888 10889 10890 10891 10892 10893 10894 10895 10896 10897 10898 10899 10900 10901 10902 10903 10904 10905 10906 10907 10908 10909 10910 10911 10912 10913 10914 10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 10926 10927 10928 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 10888 def update_import_request(workspace_id, import_request_key, update_import_request_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#update_import_request.' if logger raise "Missing the required parameter 'workspace_id' when calling update_import_request." if workspace_id.nil? raise "Missing the required parameter 'import_request_key' when calling update_import_request." if import_request_key.nil? raise "Missing the required parameter 'update_import_request_details' when calling update_import_request." if update_import_request_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'import_request_key' must not be blank" if OCI::Internal::Util.blank_string?(import_request_key) path = '/workspaces/{workspaceId}/importRequests/{importRequestKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{importRequestKey}', import_request_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_import_request_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#update_import_request') 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::DataIntegration::Models::ImportRequest' ) end # rubocop:enable Metrics/BlockLength end |
#update_pipeline(workspace_id, pipeline_key, update_pipeline_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_pipeline API.
Updates a specific pipeline.
10955 10956 10957 10958 10959 10960 10961 10962 10963 10964 10965 10966 10967 10968 10969 10970 10971 10972 10973 10974 10975 10976 10977 10978 10979 10980 10981 10982 10983 10984 10985 10986 10987 10988 10989 10990 10991 10992 10993 10994 10995 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 10955 def update_pipeline(workspace_id, pipeline_key, update_pipeline_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#update_pipeline.' if logger raise "Missing the required parameter 'workspace_id' when calling update_pipeline." if workspace_id.nil? raise "Missing the required parameter 'pipeline_key' when calling update_pipeline." if pipeline_key.nil? raise "Missing the required parameter 'update_pipeline_details' when calling update_pipeline." if update_pipeline_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'pipeline_key' must not be blank" if OCI::Internal::Util.blank_string?(pipeline_key) path = '/workspaces/{workspaceId}/pipelines/{pipelineKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{pipelineKey}', pipeline_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_pipeline_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#update_pipeline') 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::DataIntegration::Models::Pipeline' ) end # rubocop:enable Metrics/BlockLength end |
#update_project(workspace_id, project_key, update_project_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_project API.
Updates a specific project.
11022 11023 11024 11025 11026 11027 11028 11029 11030 11031 11032 11033 11034 11035 11036 11037 11038 11039 11040 11041 11042 11043 11044 11045 11046 11047 11048 11049 11050 11051 11052 11053 11054 11055 11056 11057 11058 11059 11060 11061 11062 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 11022 def update_project(workspace_id, project_key, update_project_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#update_project.' if logger raise "Missing the required parameter 'workspace_id' when calling update_project." if workspace_id.nil? raise "Missing the required parameter 'project_key' when calling update_project." if project_key.nil? raise "Missing the required parameter 'update_project_details' when calling update_project." if update_project_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'project_key' must not be blank" if OCI::Internal::Util.blank_string?(project_key) path = '/workspaces/{workspaceId}/projects/{projectKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{projectKey}', project_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_project_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#update_project') 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::DataIntegration::Models::Project' ) end # rubocop:enable Metrics/BlockLength end |
#update_reference(workspace_id, application_key, reference_key, update_reference_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_reference API.
Updates the application references. For example, to map a data asset to a different target object.
11092 11093 11094 11095 11096 11097 11098 11099 11100 11101 11102 11103 11104 11105 11106 11107 11108 11109 11110 11111 11112 11113 11114 11115 11116 11117 11118 11119 11120 11121 11122 11123 11124 11125 11126 11127 11128 11129 11130 11131 11132 11133 11134 11135 11136 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 11092 def update_reference(workspace_id, application_key, reference_key, update_reference_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#update_reference.' if logger raise "Missing the required parameter 'workspace_id' when calling update_reference." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling update_reference." if application_key.nil? raise "Missing the required parameter 'reference_key' when calling update_reference." if reference_key.nil? raise "Missing the required parameter 'update_reference_details' when calling update_reference." if update_reference_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) raise "Parameter value for 'reference_key' must not be blank" if OCI::Internal::Util.blank_string?(reference_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/references/{referenceKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s).sub('{referenceKey}', reference_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(update_reference_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#update_reference') 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::DataIntegration::Models::Reference' ) end # rubocop:enable Metrics/BlockLength end |
#update_schedule(workspace_id, application_key, schedule_key, update_schedule_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_schedule API.
Endpoint used to update the schedule
11164 11165 11166 11167 11168 11169 11170 11171 11172 11173 11174 11175 11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 11191 11192 11193 11194 11195 11196 11197 11198 11199 11200 11201 11202 11203 11204 11205 11206 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 11164 def update_schedule(workspace_id, application_key, schedule_key, update_schedule_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#update_schedule.' if logger raise "Missing the required parameter 'workspace_id' when calling update_schedule." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling update_schedule." if application_key.nil? raise "Missing the required parameter 'schedule_key' when calling update_schedule." if schedule_key.nil? raise "Missing the required parameter 'update_schedule_details' when calling update_schedule." if update_schedule_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) raise "Parameter value for 'schedule_key' must not be blank" if OCI::Internal::Util.blank_string?(schedule_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/schedules/{scheduleKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s).sub('{scheduleKey}', schedule_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_schedule_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#update_schedule') 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::DataIntegration::Models::Schedule' ) end # rubocop:enable Metrics/BlockLength end |
#update_task(workspace_id, task_key, update_task_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_task API.
Updates a specific task. For example, you can update the task description or move the task to a different folder by changing the aggregatorKey
to a different folder in the registry.
11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 11247 11248 11249 11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 11262 11263 11264 11265 11266 11267 11268 11269 11270 11271 11272 11273 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 11233 def update_task(workspace_id, task_key, update_task_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#update_task.' if logger raise "Missing the required parameter 'workspace_id' when calling update_task." if workspace_id.nil? raise "Missing the required parameter 'task_key' when calling update_task." if task_key.nil? raise "Missing the required parameter 'update_task_details' when calling update_task." if update_task_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'task_key' must not be blank" if OCI::Internal::Util.blank_string?(task_key) path = '/workspaces/{workspaceId}/tasks/{taskKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{taskKey}', task_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_task_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#update_task') 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::DataIntegration::Models::Task' ) end # rubocop:enable Metrics/BlockLength end |
#update_task_run(workspace_id, application_key, task_run_key, update_task_run_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_task_run API.
Updates the status of the task run. For example, aborts a task run.
11301 11302 11303 11304 11305 11306 11307 11308 11309 11310 11311 11312 11313 11314 11315 11316 11317 11318 11319 11320 11321 11322 11323 11324 11325 11326 11327 11328 11329 11330 11331 11332 11333 11334 11335 11336 11337 11338 11339 11340 11341 11342 11343 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 11301 def update_task_run(workspace_id, application_key, task_run_key, update_task_run_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#update_task_run.' if logger raise "Missing the required parameter 'workspace_id' when calling update_task_run." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling update_task_run." if application_key.nil? raise "Missing the required parameter 'task_run_key' when calling update_task_run." if task_run_key.nil? raise "Missing the required parameter 'update_task_run_details' when calling update_task_run." if update_task_run_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) raise "Parameter value for 'task_run_key' must not be blank" if OCI::Internal::Util.blank_string?(task_run_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/taskRuns/{taskRunKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s).sub('{taskRunKey}', task_run_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_task_run_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#update_task_run') 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::DataIntegration::Models::TaskRunDetails' ) end # rubocop:enable Metrics/BlockLength end |
#update_task_schedule(workspace_id, application_key, task_schedule_key, update_task_schedule_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_task_schedule API.
Endpoint used to update the TaskSchedule
11371 11372 11373 11374 11375 11376 11377 11378 11379 11380 11381 11382 11383 11384 11385 11386 11387 11388 11389 11390 11391 11392 11393 11394 11395 11396 11397 11398 11399 11400 11401 11402 11403 11404 11405 11406 11407 11408 11409 11410 11411 11412 11413 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 11371 def update_task_schedule(workspace_id, application_key, task_schedule_key, update_task_schedule_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#update_task_schedule.' if logger raise "Missing the required parameter 'workspace_id' when calling update_task_schedule." if workspace_id.nil? raise "Missing the required parameter 'application_key' when calling update_task_schedule." if application_key.nil? raise "Missing the required parameter 'task_schedule_key' when calling update_task_schedule." if task_schedule_key.nil? raise "Missing the required parameter 'update_task_schedule_details' when calling update_task_schedule." if update_task_schedule_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'application_key' must not be blank" if OCI::Internal::Util.blank_string?(application_key) raise "Parameter value for 'task_schedule_key' must not be blank" if OCI::Internal::Util.blank_string?(task_schedule_key) path = '/workspaces/{workspaceId}/applications/{applicationKey}/taskSchedules/{taskScheduleKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{applicationKey}', application_key.to_s).sub('{taskScheduleKey}', task_schedule_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_task_schedule_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#update_task_schedule') 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::DataIntegration::Models::TaskSchedule' ) end # rubocop:enable Metrics/BlockLength end |
#update_user_defined_function(workspace_id, user_defined_function_key, update_user_defined_function_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_user_defined_function API.
Updates a specific UserDefinedFunction.
11440 11441 11442 11443 11444 11445 11446 11447 11448 11449 11450 11451 11452 11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 11469 11470 11471 11472 11473 11474 11475 11476 11477 11478 11479 11480 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 11440 def update_user_defined_function(workspace_id, user_defined_function_key, update_user_defined_function_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#update_user_defined_function.' if logger raise "Missing the required parameter 'workspace_id' when calling update_user_defined_function." if workspace_id.nil? raise "Missing the required parameter 'user_defined_function_key' when calling update_user_defined_function." if user_defined_function_key.nil? raise "Missing the required parameter 'update_user_defined_function_details' when calling update_user_defined_function." if update_user_defined_function_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) raise "Parameter value for 'user_defined_function_key' must not be blank" if OCI::Internal::Util.blank_string?(user_defined_function_key) path = '/workspaces/{workspaceId}/userDefinedFunctions/{userDefinedFunctionKey}'.sub('{workspaceId}', workspace_id.to_s).sub('{userDefinedFunctionKey}', user_defined_function_key.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_user_defined_function_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#update_user_defined_function') 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::DataIntegration::Models::UserDefinedFunction' ) end # rubocop:enable Metrics/BlockLength end |
#update_workspace(workspace_id, update_workspace_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_workspace API.
Updates the specified Data Integration workspace.
11506 11507 11508 11509 11510 11511 11512 11513 11514 11515 11516 11517 11518 11519 11520 11521 11522 11523 11524 11525 11526 11527 11528 11529 11530 11531 11532 11533 11534 11535 11536 11537 11538 11539 11540 11541 11542 11543 11544 |
# File 'lib/oci/data_integration/data_integration_client.rb', line 11506 def update_workspace(workspace_id, update_workspace_details, opts = {}) logger.debug 'Calling operation DataIntegrationClient#update_workspace.' if logger raise "Missing the required parameter 'workspace_id' when calling update_workspace." if workspace_id.nil? raise "Missing the required parameter 'update_workspace_details' when calling update_workspace." if update_workspace_details.nil? raise "Parameter value for 'workspace_id' must not be blank" if OCI::Internal::Util.blank_string?(workspace_id) path = '/workspaces/{workspaceId}'.sub('{workspaceId}', workspace_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_workspace_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'DataIntegrationClient#update_workspace') 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::DataIntegration::Models::Workspace' ) end # rubocop:enable Metrics/BlockLength end |