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 Service APIs to perform common extract, load, and transform (ETL) tasks.

Instance Attribute Summary

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

• #change_compartment(workspace_id, change_compartment_details, opts = {}) ⇒ Response

  Moves a workspace to a specified compartment.

• #create_application(workspace_id, create_application_details, opts = {}) ⇒ Response

  Creates 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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_connection(workspace_id, connection_key, update_connection_details, opts = {}) ⇒ Response

  Updates a connection under a data asset.

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

Parameters:

• config (Config) (defaults to: nil) —

  A Config object.

• region (String) (defaults to: nil) —

  A region used to determine the service endpoint. This will usually correspond to a value in Regions::REGION_ENUM, but may be an arbitrary string.

• endpoint (String) (defaults to: nil) —

  The fully qualified endpoint URL

• signer (OCI::BaseSigner) (defaults to: nil) —

  A signer implementation which can be used by this client. If this is not provided then a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication, so that the instance principals signer can be provided to the client

• proxy_settings (OCI::ApiClientProxySettings) (defaults to: nil) —

  If your environment requires you to use a proxy server for outgoing HTTP requests the details for the proxy can be provided in this parameter

• retry_config (OCI::Retry::RetryConfig) (defaults to: nil) —

  The retry configuration for this service client. This represents the default retry configuration to apply across all operations. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries

# File 'lib/oci/data_integration/data_integration_client.rb', line 53

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.

Returns:

• (OCI::ApiClient)

# File 'lib/oci/data_integration/data_integration_client.rb', line 13

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

• (String)

# File 'lib/oci/data_integration/data_integration_client.rb', line 17

def endpoint
  @endpoint
end

#region ⇒ String

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

Returns:

• (String)

# File 'lib/oci/data_integration/data_integration_client.rb', line 27

def region
  @region
end

#retry_config ⇒ OCI::Retry::RetryConfig (readonly)

The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries

Returns:

• (OCI::Retry::RetryConfig)

# File 'lib/oci/data_integration/data_integration_client.rb', line 23

def retry_config
  @retry_config
end

Instance Method Details

#change_compartment(workspace_id, change_compartment_details, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/change_compartment.rb.html) to see an example of how to use change_compartment API.

Moves a workspace to a specified compartment.

Parameters:

• workspace_id (String) —

  The workspace ID.

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

  The information needed to move a workspace to a specified compartment.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

• :opc_request_id (String) —

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

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_integration/data_integration_client.rb', line 120

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.make_retrying_call(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

#create_application(workspace_id, create_application_details, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/create_application.rb.html) to see an example of how to use create_application API.

Creates an application.

Parameters:

• workspace_id (String) —

  The workspace ID.

• create_application_details (OCI::DataIntegration::Models::CreateApplicationDetails) —

  The details needed to create an application.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.

Returns:

• (Response) —

  A Response object with data of type Application

# File 'lib/oci/data_integration/data_integration_client.rb', line 184

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.make_retrying_call(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_connection(workspace_id, create_connection_details, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/create_connection.rb.html) to see an example of how to use create_connection API.

Creates a connection under an existing data asset.

Parameters:

• workspace_id (String) —

  The workspace ID.

• create_connection_details (OCI::DataIntegration::Models::CreateConnectionDetails) —

  The information needed to create a connection.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.

Returns:

• (Response) —

  A Response object with data of type Connection

# File 'lib/oci/data_integration/data_integration_client.rb', line 247

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/create_connection_validation.rb.html) to see an example of how to use create_connection_validation API.

Creates a connection validation.

Parameters:

• workspace_id (String) —

  The workspace ID.

• create_connection_validation_details (OCI::DataIntegration::Models::CreateConnectionValidationDetails) —

  The information needed to validate a connection.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.

Returns:

• (Response) —

  A Response object with data of type ConnectionValidation

# File 'lib/oci/data_integration/data_integration_client.rb', line 310

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.make_retrying_call(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_data_asset(workspace_id, create_data_asset_details, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/create_data_asset.rb.html) to see an example of how to use create_data_asset API.

Creates a data asset with default connection.

Parameters:

• workspace_id (String) —

  The workspace ID.

• create_data_asset_details (OCI::DataIntegration::Models::CreateDataAssetDetails) —

  The information needed to create a data asset.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.

Returns:

• (Response) —

  A Response object with data of type DataAsset

# File 'lib/oci/data_integration/data_integration_client.rb', line 373

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/create_data_flow.rb.html) 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.

Parameters:

• workspace_id (String) —

  The workspace ID.

• create_data_flow_details (OCI::DataIntegration::Models::CreateDataFlowDetails) —

  The details needed to create a new data flow.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type DataFlow

# File 'lib/oci/data_integration/data_integration_client.rb', line 437

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/create_data_flow_validation.rb.html) 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.

Parameters:

• workspace_id (String) —

  The workspace ID.

• create_data_flow_validation_details (OCI::DataIntegration::Models::CreateDataFlowValidationDetails) —

  The information needed to create the data flow validation for the data flow object.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.

Returns:

• (Response) —

  A Response object with data of type DataFlowValidation

# File 'lib/oci/data_integration/data_integration_client.rb', line 501

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.make_retrying_call(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_entity_shape(workspace_id, connection_key, schema_resource_name, create_entity_shape_details, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/create_entity_shape.rb.html) to see an example of how to use create_entity_shape API.

Creates the data entity shape using the shape from the data asset.

Parameters:

• workspace_id (String) —

  The workspace ID.

• connection_key (String) —

  The connection key.

• schema_resource_name (String) —

  The schema resource name used for retrieving schemas.

• create_entity_shape_details (OCI::DataIntegration::Models::CreateEntityShapeDetails) —

  The details needed to create the data entity shape.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

Returns:

• (Response) —

  A Response object with data of type EntityShape

# File 'lib/oci/data_integration/data_integration_client.rb', line 570

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.make_retrying_call(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_external_publication(workspace_id, task_key, create_external_publication_details, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/create_external_publication.rb.html) to see an example of how to use create_external_publication API.

Publish a DataFlow in a OCI DataFlow application.

Parameters:

• workspace_id (String) —

  The workspace ID.

• task_key (String) —

  The task key.

• create_external_publication_details (OCI::DataIntegration::Models::CreateExternalPublicationDetails) —

  Details needed to publish a task to OCI DataFlow application.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.

Returns:

• (Response) —

  A Response object with data of type ExternalPublication

# File 'lib/oci/data_integration/data_integration_client.rb', line 639

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/create_external_publication_validation.rb.html) to see an example of how to use create_external_publication_validation API.

Validates a specific task.

Parameters:

• workspace_id (String) —

  The workspace ID.

• task_key (String) —

  The task key.

• create_external_publication_validation_details (OCI::DataIntegration::Models::CreateExternalPublicationValidationDetails) —

  The information needed to create a task validation.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.

Returns:

• (Response) —

  A Response object with data of type ExternalPublicationValidation

# File 'lib/oci/data_integration/data_integration_client.rb', line 705

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/create_folder.rb.html) 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.

Parameters:

• workspace_id (String) —

  The workspace ID.

• create_folder_details (OCI::DataIntegration::Models::CreateFolderDetails) —

  The details needed to create a folder.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type Folder

# File 'lib/oci/data_integration/data_integration_client.rb', line 772

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.make_retrying_call(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_patch(workspace_id, application_key, create_patch_details, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/create_patch.rb.html) to see an example of how to use create_patch API.

Creates a patch in an application.

Parameters:

• workspace_id (String) —

  The workspace ID.

• application_key (String) —

  The application key.

• create_patch_details (OCI::DataIntegration::Models::CreatePatchDetails) —

  Detailed needed to create a patch in an application.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.

Returns:

• (Response) —

  A Response object with data of type Patch

# File 'lib/oci/data_integration/data_integration_client.rb', line 836

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/create_pipeline.rb.html) 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.

Parameters:

• workspace_id (String) —

  The workspace ID.

• create_pipeline_details (OCI::DataIntegration::Models::CreatePipelineDetails) —

  The details needed to create a new pipeline.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type Pipeline

# File 'lib/oci/data_integration/data_integration_client.rb', line 902

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/create_pipeline_validation.rb.html) 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.

Parameters:

• workspace_id (String) —

  The workspace ID.

• create_pipeline_validation_details (OCI::DataIntegration::Models::CreatePipelineValidationDetails) —

  The information needed to create the data flow validation for the pipeline object.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.

Returns:

• (Response) —

  A Response object with data of type PipelineValidation

# File 'lib/oci/data_integration/data_integration_client.rb', line 966

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/create_project.rb.html) 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.

Parameters:

• workspace_id (String) —

  The workspace ID.

• create_project_details (OCI::DataIntegration::Models::CreateProjectDetails) —

  The details needed to create a project in a workspace.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type Project

# File 'lib/oci/data_integration/data_integration_client.rb', line 1030

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/create_schedule.rb.html) to see an example of how to use create_schedule API.

Endpoint to create a new schedule

Parameters:

• workspace_id (String) —

  The workspace ID.

• application_key (String) —

  The application key.

• create_schedule_details (OCI::DataIntegration::Models::CreateScheduleDetails) —

  Request body parameter for Schedule details

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.

Returns:

• (Response) —

  A Response object with data of type Schedule

# File 'lib/oci/data_integration/data_integration_client.rb', line 1094

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/create_task.rb.html) 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.

Parameters:

• workspace_id (String) —

  The workspace ID.

• create_task_details (OCI::DataIntegration::Models::CreateTaskDetails) —

  The details needed to create a new task.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type Task

# File 'lib/oci/data_integration/data_integration_client.rb', line 1160

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/create_task_run.rb.html) to see an example of how to use create_task_run API.

Creates a data integration task run for the specified task.

Parameters:

• workspace_id (String) —

  The workspace ID.

• application_key (String) —

  The application key.

• create_task_run_details (OCI::DataIntegration::Models::CreateTaskRunDetails) —

  The details needed to create a task run.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type TaskRun

# File 'lib/oci/data_integration/data_integration_client.rb', line 1224

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/create_task_schedule.rb.html) to see an example of how to use create_task_schedule API.

Endpoint to be used create TaskSchedule.

Parameters:

• workspace_id (String) —

  The workspace ID.

• application_key (String) —

  The application key.

• create_task_schedule_details (OCI::DataIntegration::Models::CreateTaskScheduleDetails) —

  Request body parameter for TaskSchedule details

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.

Returns:

• (Response) —

  A Response object with data of type TaskSchedule

# File 'lib/oci/data_integration/data_integration_client.rb', line 1290

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/create_task_validation.rb.html) to see an example of how to use create_task_validation API.

Validates a specific task.

Parameters:

• workspace_id (String) —

  The workspace ID.

• create_task_validation_details (OCI::DataIntegration::Models::CreateTaskValidationDetails) —

  The information needed to create a task validation.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.

Returns:

• (Response) —

  A Response object with data of type TaskValidation

# File 'lib/oci/data_integration/data_integration_client.rb', line 1355

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.make_retrying_call(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_workspace(create_workspace_details, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/create_workspace.rb.html) to see an example of how to use create_workspace API.

Creates a new Data Integration workspace ready for performing data integration tasks.

Parameters:

• create_workspace_details (OCI::DataIntegration::Models::CreateWorkspaceDetails) —

  The information needed to create a new Data Integration workspace.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_integration/data_integration_client.rb', line 1418

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/delete_application.rb.html) to see an example of how to use delete_application API.

Removes an application using the specified identifier.

Parameters:

• workspace_id (String) —

  The workspace ID.

• application_key (String) —

  The application key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_integration/data_integration_client.rb', line 1480

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.make_retrying_call(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_connection(workspace_id, connection_key, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/delete_connection.rb.html) to see an example of how to use delete_connection API.

Removes a connection using the specified identifier.

Parameters:

• workspace_id (String) —

  The workspace ID.

• connection_key (String) —

  The connection key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_integration/data_integration_client.rb', line 1544

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/delete_connection_validation.rb.html) to see an example of how to use delete_connection_validation API.

Deletes a connection validation.

Parameters:

• workspace_id (String) —

  The workspace ID.

• connection_validation_key (String) —

  The key of the connection validation.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_integration/data_integration_client.rb', line 1608

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.make_retrying_call(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_data_asset(workspace_id, data_asset_key, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/delete_data_asset.rb.html) to see an example of how to use delete_data_asset API.

Removes a data asset using the specified identifier.

Parameters:

• workspace_id (String) —

  The workspace ID.

• data_asset_key (String) —

  The data asset key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_integration/data_integration_client.rb', line 1672

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/delete_data_flow.rb.html) 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.

Parameters:

• workspace_id (String) —

  The workspace ID.

• data_flow_key (String) —

  The data flow key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_integration/data_integration_client.rb', line 1736

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/delete_data_flow_validation.rb.html) to see an example of how to use delete_data_flow_validation API.

Removes a data flow validation using the specified identifier.

Parameters:

• workspace_id (String) —

  The workspace ID.

• data_flow_validation_key (String) —

  The key of the dataflow validation.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_integration/data_integration_client.rb', line 1800

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.make_retrying_call(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_external_publication(workspace_id, task_key, external_publications_key, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/delete_external_publication.rb.html) to see an example of how to use delete_external_publication API.

Removes a published object using the specified identifier.

Parameters:

• workspace_id (String) —

  The workspace ID.

• task_key (String) —

  The task key.

• external_publications_key (String) —

  The external published object key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_integration/data_integration_client.rb', line 1865

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/delete_external_publication_validation.rb.html) to see an example of how to use delete_external_publication_validation API.

Removes a task validation using the specified identifier.

Parameters:

• workspace_id (String) —

  The workspace ID.

• task_key (String) —

  The task key.

• external_publication_validation_key (String) —

  The external published object key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_integration/data_integration_client.rb', line 1933

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/delete_folder.rb.html) to see an example of how to use delete_folder API.

Removes a folder from a project using the specified identifier.

Parameters:

• workspace_id (String) —

  The workspace ID.

• folder_key (String) —

  The folder key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_integration/data_integration_client.rb', line 1999

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.make_retrying_call(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_patch(workspace_id, application_key, patch_key, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/delete_patch.rb.html) to see an example of how to use delete_patch API.

Removes a patch using the specified identifier.

Parameters:

• workspace_id (String) —

  The workspace ID.

• application_key (String) —

  The application key.

• patch_key (String) —

  The patch key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_integration/data_integration_client.rb', line 2064

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/delete_pipeline.rb.html) to see an example of how to use delete_pipeline API.

Removes a pipeline from a project or folder using the specified identifier.

Parameters:

• workspace_id (String) —

  The workspace ID.

• pipeline_key (String) —

  The pipeline key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_integration/data_integration_client.rb', line 2130

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/delete_pipeline_validation.rb.html) to see an example of how to use delete_pipeline_validation API.

Removes a pipeline validation using the specified identifier.

Parameters:

• workspace_id (String) —

  The workspace ID.

• pipeline_validation_key (String) —

  The key of the pipeline validation.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_integration/data_integration_client.rb', line 2194

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/delete_project.rb.html) to see an example of how to use delete_project API.

Removes a project from the workspace using the specified identifier.

Parameters:

• workspace_id (String) —

  The workspace ID.

• project_key (String) —

  The project key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_integration/data_integration_client.rb', line 2258

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/delete_schedule.rb.html) to see an example of how to use delete_schedule API.

Endpoint to delete schedule.

Parameters:

• workspace_id (String) —

  The workspace ID.

• application_key (String) —

  The application key.

• schedule_key (String) —

  Schedule Key

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_integration/data_integration_client.rb', line 2323

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/delete_task.rb.html) to see an example of how to use delete_task API.

Removes a task using the specified identifier.

Parameters:

• workspace_id (String) —

  The workspace ID.

• task_key (String) —

  The task key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_integration/data_integration_client.rb', line 2389

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/delete_task_run.rb.html) to see an example of how to use delete_task_run API.

Deletes a task run using the specified identifier.

Parameters:

• workspace_id (String) —

  The workspace ID.

• application_key (String) —

  The application key.

• task_run_key (String) —

  The task run key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_integration/data_integration_client.rb', line 2454

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/delete_task_schedule.rb.html) to see an example of how to use delete_task_schedule API.

Endpoint to delete TaskSchedule.

Parameters:

• workspace_id (String) —

  The workspace ID.

• application_key (String) —

  The application key.

• task_schedule_key (String) —

  TaskSchedule Key

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_integration/data_integration_client.rb', line 2521

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/delete_task_validation.rb.html) to see an example of how to use delete_task_validation API.

Removes a task validation using the specified identifier.

Parameters:

• workspace_id (String) —

  The workspace ID.

• task_validation_key (String) —

  The task validation key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_integration/data_integration_client.rb', line 2588

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.make_retrying_call(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_workspace(workspace_id, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/delete_workspace.rb.html) to see an example of how to use delete_workspace API.

Deletes a Data Integration workspace resource using the specified identifier.

Parameters:

• workspace_id (String) —

  The workspace ID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :quiesce_timeout (Integer) —

  Used to set the timeout for Data Integration to gracefully close down any running jobs before stopping the workspace. (default to 0)

• :is_force_operation (BOOLEAN) —

  Used to force close down the workspace. (default to false)

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_integration/data_integration_client.rb', line 2653

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/get_application.rb.html) to see an example of how to use get_application API.

Retrieves an application using the specified identifier.

Parameters:

• workspace_id (String) —

  The workspace ID.

• application_key (String) —

  The application key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type Application

# File 'lib/oci/data_integration/data_integration_client.rb', line 2713

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.make_retrying_call(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_connection(workspace_id, connection_key, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/get_connection.rb.html) to see an example of how to use get_connection API.

Retrieves the connection details using the specified identifier.

Parameters:

• workspace_id (String) —

  The workspace ID.

• connection_key (String) —

  The connection key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type Connection

# File 'lib/oci/data_integration/data_integration_client.rb', line 2773

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/get_connection_validation.rb.html) to see an example of how to use get_connection_validation API.

Retrieves a connection validation using the specified identifier.

Parameters:

• workspace_id (String) —

  The workspace ID.

• connection_validation_key (String) —

  The key of the connection validation.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type ConnectionValidation

# File 'lib/oci/data_integration/data_integration_client.rb', line 2833

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.make_retrying_call(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_count_statistic(workspace_id, count_statistic_key, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/get_count_statistic.rb.html) 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.

Parameters:

• workspace_id (String) —

  The workspace ID.

• count_statistic_key (String) —

  A unique key of the container object, such as workspace, project, and so on, to count statistics for. The statistics is fetched for the given key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type CountStatistic

# File 'lib/oci/data_integration/data_integration_client.rb', line 2895

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/get_data_asset.rb.html) to see an example of how to use get_data_asset API.

Retrieves details of a data asset using the specified identifier.

Parameters:

• workspace_id (String) —

  The workspace ID.

• data_asset_key (String) —

  The data asset key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type DataAsset

# File 'lib/oci/data_integration/data_integration_client.rb', line 2955

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/get_data_entity.rb.html) to see an example of how to use get_data_entity API.

Retrieves the data entity details with the given name from live schema.

Parameters:

• workspace_id (String) —

  The workspace ID.

• connection_key (String) —

  The connection key.

• schema_resource_name (String) —

  The schema resource name used for retrieving schemas.

• data_entity_key (String) —

  The key of the data entity.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type DataEntity

# File 'lib/oci/data_integration/data_integration_client.rb', line 3017

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/get_data_flow.rb.html) to see an example of how to use get_data_flow API.

Retrieves a data flow using the specified identifier.

Parameters:

• workspace_id (String) —

  The workspace ID.

• data_flow_key (String) —

  The data flow key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :expand_references (String) —

  Used to expand references of the object. If value is true, then all referenced objects are expanded. If value is false, then shallow objects are returned in place of references. Default is false.
  Example:
  <ul> <li>?expandReferences=true returns all objects of type data loader task</li> </ul> (default to false)

Returns:

• (Response) —

  A Response object with data of type DataFlow

# File 'lib/oci/data_integration/data_integration_client.rb', line 3082

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/get_data_flow_validation.rb.html) to see an example of how to use get_data_flow_validation API.

Retrieves a data flow validation using the specified identifier.

Parameters:

• workspace_id (String) —

  The workspace ID.

• data_flow_validation_key (String) —

  The key of the dataflow validation.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type DataFlowValidation

# File 'lib/oci/data_integration/data_integration_client.rb', line 3143

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/get_dependent_object.rb.html) to see an example of how to use get_dependent_object API.

Retrieves the details of a dependent object from an application.

Parameters:

• workspace_id (String) —

  The workspace ID.

• application_key (String) —

  The application key.

• dependent_object_key (String) —

  The dependent object key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type DependentObject

# File 'lib/oci/data_integration/data_integration_client.rb', line 3204

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.make_retrying_call(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_external_publication(workspace_id, task_key, external_publications_key, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/get_external_publication.rb.html) to see an example of how to use get_external_publication API.

Retrieves a publshed object in an task using the specified identifier.

Parameters:

• workspace_id (String) —

  The workspace ID.

• task_key (String) —

  The task key.

• external_publications_key (String) —

  The external published object key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type ExternalPublication

# File 'lib/oci/data_integration/data_integration_client.rb', line 3267

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/get_external_publication_validation.rb.html) to see an example of how to use get_external_publication_validation API.

Retrieves an external publication validation using the specified identifier.

Parameters:

• workspace_id (String) —

  The workspace ID.

• task_key (String) —

  The task key.

• external_publication_validation_key (String) —

  The external published object key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type ExternalPublicationValidation

# File 'lib/oci/data_integration/data_integration_client.rb', line 3330

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/get_folder.rb.html) to see an example of how to use get_folder API.

Retrieves a folder using the specified identifier.

Parameters:

• workspace_id (String) —

  The workspace ID.

• folder_key (String) —

  The folder key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :projection (Array<String>) —

  This parameter allows users to specify which view of the object to return. CHILD_COUNT_STATISTICS - This option is used to get statistics on immediate children of the object by their type. (default to []) Allowed values are: CHILD_COUNT_STATISTICS

Returns:

• (Response) —

  A Response object with data of type Folder

# File 'lib/oci/data_integration/data_integration_client.rb', line 3394

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.make_retrying_call(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_patch(workspace_id, application_key, patch_key, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/get_patch.rb.html) to see an example of how to use get_patch API.

Retrieves a patch in an application using the specified identifier.

Parameters:

• workspace_id (String) —

  The workspace ID.

• application_key (String) —

  The application key.

• patch_key (String) —

  The patch key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type Patch

# File 'lib/oci/data_integration/data_integration_client.rb', line 3466

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/get_pipeline.rb.html) to see an example of how to use get_pipeline API.

Retrieves a pipeline using the specified identifier.

Parameters:

• workspace_id (String) —

  The workspace ID.

• pipeline_key (String) —

  The pipeline key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :expand_references (String) —

  Used to expand references of the object. If value is true, then all referenced objects are expanded. If value is false, then shallow objects are returned in place of references. Default is false.
  Example:
  <ul> <li>?expandReferences=true returns all objects of type data loader task</li> </ul> (default to false)

Returns:

• (Response) —

  A Response object with data of type Pipeline

# File 'lib/oci/data_integration/data_integration_client.rb', line 3529

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/get_pipeline_validation.rb.html) to see an example of how to use get_pipeline_validation API.

Retrieves a pipeline validation using the specified identifier.

Parameters:

• workspace_id (String) —

  The workspace ID.

• pipeline_validation_key (String) —

  The key of the pipeline validation.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type PipelineValidation

# File 'lib/oci/data_integration/data_integration_client.rb', line 3590

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/get_project.rb.html) to see an example of how to use get_project API.

Retrieves a project using the specified identifier.

Parameters:

• workspace_id (String) —

  The workspace ID.

• project_key (String) —

  The project key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :projection (Array<String>) —

  This parameter allows users to specify which view of the object to return. CHILD_COUNT_STATISTICS - This option is used to get statistics on immediate children of the object by their type. (default to []) Allowed values are: CHILD_COUNT_STATISTICS

Returns:

• (Response) —

  A Response object with data of type Project

# File 'lib/oci/data_integration/data_integration_client.rb', line 3652

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/get_published_object.rb.html) to see an example of how to use get_published_object API.

Retrieves the details of a published object from an application.

Parameters:

• workspace_id (String) —

  The workspace ID.

• application_key (String) —

  The application key.

• published_object_key (String) —

  The published object key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :expand_references (String) —

  Used to expand references of the object. If value is true, then all referenced objects are expanded. If value is false, then shallow objects are returned in place of references. Default is false.
  Example:
  <ul> <li>?expandReferences=true returns all objects of type data loader task</li> </ul> (default to false)

Returns:

• (Response) —

  A Response object with data of type PublishedObject

# File 'lib/oci/data_integration/data_integration_client.rb', line 3725

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/get_reference.rb.html) to see an example of how to use get_reference API.

Retrieves a reference in an application.

Parameters:

• workspace_id (String) —

  The workspace ID.

• application_key (String) —

  The application key.

• reference_key (String) —

  The reference key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type Reference

# File 'lib/oci/data_integration/data_integration_client.rb', line 3789

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.make_retrying_call(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_schedule(workspace_id, application_key, schedule_key, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/get_schedule.rb.html) to see an example of how to use get_schedule API.

Retrieves schedule by schedule key

Parameters:

• workspace_id (String) —

  The workspace ID.

• application_key (String) —

  The application key.

• schedule_key (String) —

  Schedule Key

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type Schedule

# File 'lib/oci/data_integration/data_integration_client.rb', line 3852

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/get_schema.rb.html) to see an example of how to use get_schema API.

Retrieves a schema that can be accessed using the specified connection.

Parameters:

• workspace_id (String) —

  The workspace ID.

• connection_key (String) —

  The connection key.

• schema_resource_name (String) —

  The schema resource name used for retrieving schemas.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type Schema

# File 'lib/oci/data_integration/data_integration_client.rb', line 3915

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/get_task.rb.html) to see an example of how to use get_task API.

Retrieves a task using the specified identifier.

Parameters:

• workspace_id (String) —

  The workspace ID.

• task_key (String) —

  The task key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :expand_references (String) —

  Used to expand references of the object. If value is true, then all referenced objects are expanded. If value is false, then shallow objects are returned in place of references. Default is false.
  Example:
  <ul> <li>?expandReferences=true returns all objects of type data loader task</li> </ul> (default to false)

Returns:

• (Response) —

  A Response object with data of type Task

# File 'lib/oci/data_integration/data_integration_client.rb', line 3978

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/get_task_run.rb.html) to see an example of how to use get_task_run API.

Retrieves a task run using the specified identifier.

Parameters:

• workspace_id (String) —

  The workspace ID.

• application_key (String) —

  The application key.

• task_run_key (String) —

  The task run key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type TaskRun

# File 'lib/oci/data_integration/data_integration_client.rb', line 4040

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/get_task_schedule.rb.html) to see an example of how to use get_task_schedule API.

Endpoint used to get taskSchedule by its key

Parameters:

• workspace_id (String) —

  The workspace ID.

• application_key (String) —

  The application key.

• task_schedule_key (String) —

  TaskSchedule Key

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type TaskSchedule

# File 'lib/oci/data_integration/data_integration_client.rb', line 4103

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/get_task_validation.rb.html) to see an example of how to use get_task_validation API.

Retrieves a task validation using the specified identifier.

Parameters:

• workspace_id (String) —

  The workspace ID.

• task_validation_key (String) —

  The task validation key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type TaskValidation

# File 'lib/oci/data_integration/data_integration_client.rb', line 4166

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.make_retrying_call(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_work_request(work_request_id, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/get_work_request.rb.html) to see an example of how to use get_work_request API.

Retrieves the status of the work request with the given ID.

Parameters:

• work_request_id (String) —

  The ID of the asynchronous work request to retrieve.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type WorkRequest

# File 'lib/oci/data_integration/data_integration_client.rb', line 4225

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/get_workspace.rb.html) to see an example of how to use get_workspace API.

Retrieves a Data Integration workspace using the specified identifier.

Parameters:

• workspace_id (String) —

  The workspace ID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type Workspace

# File 'lib/oci/data_integration/data_integration_client.rb', line 4282

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/list_applications.rb.html) to see an example of how to use list_applications API.

Retrieves a list of applications and provides options to filter the list.

Parameters:

• workspace_id (String) —

  The workspace ID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :name (String) —

  Used to filter by the name of the object.

• :identifier (Array<String>) —

  Used to filter by the identifier of the published object. (default to [])

• :fields (Array<String>) —

  Specifies the fields to get for an object. (default to [])

• :limit (Integer) —

  Sets the maximum number of results per page, or items to return in a paginated List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 20)

• :page (String) —

  For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 1)

• :sort_order (String) —

  Specifies sort order to use, either ASC (ascending) or DESC (descending). (default to DESC) Allowed values are: ASC, DESC

• :sort_by (String) —

  Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order). (default to TIME_CREATED) Allowed values are: TIME_CREATED, DISPLAY_NAME

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type ApplicationSummaryCollection

# File 'lib/oci/data_integration/data_integration_client.rb', line 4349

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].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  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[: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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/list_connection_validations.rb.html) to see an example of how to use list_connection_validations API.

Retrieves a list of connection validations within the specified workspace.

Parameters:

• workspace_id (String) —

  The workspace ID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :key (String) —

  Used to filter by the key of the object.

• :name (String) —

  Used to filter by the name of the object.

• :identifier (String) —

  Used to filter by the identifier of the object.

• :fields (Array<String>) —

  Specifies the fields to get for an object. (default to [])

• :page (String) —

  For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

• :limit (Integer) —

  Sets the maximum number of results per page, or items to return in a paginated List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 100)

• :sort_by (String) —

  Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order). (default to TIME_CREATED) Allowed values are: TIME_CREATED, DISPLAY_NAME

• :sort_order (String) —

  Specifies sort order to use, either ASC (ascending) or DESC (descending). (default to DESC) Allowed values are: ASC, DESC

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type ConnectionValidationSummaryCollection

# File 'lib/oci/data_integration/data_integration_client.rb', line 4431

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].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/list_connections.rb.html) to see an example of how to use list_connections API.

Retrieves a list of all connections.

Parameters:

• workspace_id (String) —

  The workspace ID.

• data_asset_key (String) —

  Used to filter by the data asset key of the object.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :name (String) —

  Used to filter by the name of the object.

• :page (String) —

  For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

• :limit (Integer) —

  Sets the maximum number of results per page, or items to return in a paginated List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 100)

• :fields (Array<String>) —

  Specifies the fields to get for an object. (default to [])

• :type (String) —

  Type of the object to filter the results with.

• :sort_by (String) —

  Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order). (default to TIME_CREATED) Allowed values are: TIME_CREATED, DISPLAY_NAME

• :sort_order (String) —

  Specifies sort order to use, either ASC (ascending) or DESC (descending). (default to DESC) Allowed values are: ASC, DESC

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type ConnectionSummaryCollection

# File 'lib/oci/data_integration/data_integration_client.rb', line 4514

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].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  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.make_retrying_call(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_data_assets(workspace_id, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/list_data_assets.rb.html) to see an example of how to use list_data_assets API.

Retrieves a list of all data asset summaries.

Parameters:

• workspace_id (String) —

  The workspace ID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :page (String) —

  For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

• :limit (Integer) —

  Sets the maximum number of results per page, or items to return in a paginated List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 100)

• :fields (Array<String>) —

  Specifies the fields to get for an object. (default to [])

• :type (String) —

  Type of the object to filter the results with.

• :sort_by (String) —

  Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order). (default to TIME_CREATED) Allowed values are: TIME_CREATED, DISPLAY_NAME

• :sort_order (String) —

  Specifies sort order to use, either ASC (ascending) or DESC (descending). (default to DESC) Allowed values are: ASC, DESC

• :name (String) —

  Used to filter by the name of the object.

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type DataAssetSummaryCollection

# File 'lib/oci/data_integration/data_integration_client.rb', line 4598

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].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/list_data_entities.rb.html) 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.

Parameters:

• workspace_id (String) —

  The workspace ID.

• connection_key (String) —

  The connection key.

• schema_resource_name (String) —

  The schema resource name used for retrieving schemas.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :name (String) —

  Used to filter by the name of the object.

• :page (String) —

  For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

• :type (String) —

  Type of the object to filter the results with.

• :limit (Integer) —

  Sets the maximum number of results per page, or items to return in a paginated List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 100)

• :fields (Array<String>) —

  Specifies the fields to get for an object. (default to [])

• :sort_by (String) —

  Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order). (default to TIME_CREATED) Allowed values are: TIME_CREATED, DISPLAY_NAME

• :sort_order (String) —

  Specifies sort order to use, either ASC (ascending) or DESC (descending). (default to DESC) Allowed values are: ASC, DESC

• :opc_request_id (String) —

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

• :name_list (Array<String>) —

  Used to filter by the name of the object. (default to [])

• :is_pattern (BOOLEAN) —

  This parameter can be used to specify whether entity search type is pattern search or not. (default to false)

Returns:

• (Response) —

  A Response object with data of type DataEntitySummaryCollection

# File 'lib/oci/data_integration/data_integration_client.rb', line 4684

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].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  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?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/list_data_flow_validations.rb.html) to see an example of how to use list_data_flow_validations API.

Retrieves a list of data flow validations within the specified workspace.

Parameters:

• workspace_id (String) —

  The workspace ID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :key (String) —

  Used to filter by the key of the object.

• :name (String) —

  Used to filter by the name of the object.

• :identifier (String) —

  Used to filter by the identifier of the object.

• :fields (Array<String>) —

  Specifies the fields to get for an object. (default to [])

• :page (String) —

  For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

• :limit (Integer) —

  Sets the maximum number of results per page, or items to return in a paginated List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 100)

• :sort_by (String) —

  Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order). (default to TIME_CREATED) Allowed values are: TIME_CREATED, DISPLAY_NAME

• :sort_order (String) —

  Specifies sort order to use, either ASC (ascending) or DESC (descending). (default to DESC) Allowed values are: ASC, DESC

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type DataFlowValidationSummaryCollection

# File 'lib/oci/data_integration/data_integration_client.rb', line 4772

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].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/list_data_flows.rb.html) to see an example of how to use list_data_flows API.

Retrieves a list of data flows in a project or folder.

Parameters:

• workspace_id (String) —

  The workspace ID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :folder_id (String) —

  Unique key of the folder.

• :fields (Array<String>) —

  Specifies the fields to get for an object. (default to [])

• :name (String) —

  Used to filter by the name of the object.

• :identifier (Array<String>) —

  Used to filter by the identifier of the object. (default to [])

• :limit (Integer) —

  Sets the maximum number of results per page, or items to return in a paginated List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 100)

• :page (String) —

  For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

• :sort_order (String) —

  Specifies sort order to use, either ASC (ascending) or DESC (descending). (default to DESC) Allowed values are: ASC, DESC

• :sort_by (String) —

  Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order). (default to TIME_CREATED) Allowed values are: TIME_CREATED, DISPLAY_NAME

Returns:

• (Response) —

  A Response object with data of type DataFlowSummaryCollection

# File 'lib/oci/data_integration/data_integration_client.rb', line 4856

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].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/list_dependent_objects.rb.html) to see an example of how to use list_dependent_objects API.

Retrieves a list of all dependent objects for a specific application.

Parameters:

• workspace_id (String) —

  The workspace ID.

• application_key (String) —

  The application key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :fields (Array<String>) —

  Specifies the fields to get for an object. (default to [])

• :name (String) —

  Used to filter by the name of the object.

• :identifier (Array<String>) —

  Used to filter by the identifier of the published object. (default to [])

• :type (Array<String>) —

  Used to filter by the object type of the object. It can be suffixed with an optional filter operator InSubtree. For Data Integration APIs, a filter based on type Task is used.

  (default to [])
  

• :type_in_subtree (String) —

  Used in association with type parameter. If value is true, then type all sub types of the given type parameter is considered. If value is false, then sub types are not considered. Default is false.

  (default to [])
  

• :limit (Integer) —

  Sets the maximum number of results per page, or items to return in a paginated List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 20)

• :page (String) —

  For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 1)

• :sort_order (String) —

  Specifies sort order to use, either ASC (ascending) or DESC (descending). (default to DESC) Allowed values are: ASC, DESC

• :sort_by (String) —

  Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order). (default to TIME_CREATED) Allowed values are: TIME_CREATED, DISPLAY_NAME

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type DependentObjectSummaryCollection

# File 'lib/oci/data_integration/data_integration_client.rb', line 4948

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].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  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[: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.make_retrying_call(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_external_publication_validations(workspace_id, task_key, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/list_external_publication_validations.rb.html) 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.

Parameters:

• workspace_id (String) —

  The workspace ID.

• task_key (String) —

  The task key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :fields (Array<String>) —

  Specifies the fields to get for an object. (default to [])

• :name (String) —

  Used to filter by the name of the object.

• :identifier (Array<String>) —

  Used to filter by the identifier of the object. (default to [])

• :page (String) —

  For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

• :limit (Integer) —

  Sets the maximum number of results per page, or items to return in a paginated List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 100)

• :sort_order (String) —

  Specifies sort order to use, either ASC (ascending) or DESC (descending). (default to DESC) Allowed values are: ASC, DESC

• :sort_by (String) —

  Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order). (default to TIME_CREATED) Allowed values are: TIME_CREATED, DISPLAY_NAME

Returns:

• (Response) —

  A Response object with data of type ExternalPublicationValidationSummaryCollection

# File 'lib/oci/data_integration/data_integration_client.rb', line 5035

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].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/list_external_publications.rb.html) 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.

Parameters:

• workspace_id (String) —

  The workspace ID.

• task_key (String) —

  The task key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :fields (Array<String>) —

  Specifies the fields to get for an object. (default to [])

• :name (String) —

  Used to filter by the name of the object.

• :limit (Integer) —

  Sets the maximum number of results per page, or items to return in a paginated List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 100)

• :page (String) —

  For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 1)

• :sort_order (String) —

  Specifies sort order to use, either ASC (ascending) or DESC (descending). (default to DESC) Allowed values are: ASC, DESC

• :sort_by (String) —

  Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order). (default to TIME_CREATED) Allowed values are: TIME_CREATED, DISPLAY_NAME

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type ExternalPublicationSummaryCollection

# File 'lib/oci/data_integration/data_integration_client.rb', line 5118

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].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/list_folders.rb.html) 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.

Parameters:

• workspace_id (String) —

  The workspace ID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :aggregator_key (String) —

  Used to filter by the project or the folder object.

• :fields (Array<String>) —

  Specifies the fields to get for an object. (default to [])

• :name (String) —

  Used to filter by the name of the object.

• :identifier (Array<String>) —

  Used to filter by the identifier of the object. (default to [])

• :page (String) —

  For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

• :limit (Integer) —

  Sets the maximum number of results per page, or items to return in a paginated List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 100)

• :sort_order (String) —

  Specifies sort order to use, either ASC (ascending) or DESC (descending). (default to DESC) Allowed values are: ASC, DESC

• :sort_by (String) —

  Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order). (default to TIME_CREATED) Allowed values are: TIME_CREATED, DISPLAY_NAME

Returns:

• (Response) —

  A Response object with data of type FolderSummaryCollection

# File 'lib/oci/data_integration/data_integration_client.rb', line 5203

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].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  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[: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.make_retrying_call(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_patch_changes(workspace_id, application_key, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/list_patch_changes.rb.html) 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.

Parameters:

• workspace_id (String) —

  The workspace ID.

• application_key (String) —

  The application key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :name (String) —

  Used to filter by the name of the object.

• :since_patch (String) —

  Specifies the patch key to query from.

• :to_patch (String) —

  Specifies the patch key to query to.

• :limit (Integer) —

  Sets the maximum number of results per page, or items to return in a paginated List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 100)

• :page (String) —

  For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 1)

• :sort_order (String) —

  Specifies sort order to use, either ASC (ascending) or DESC (descending). (default to DESC) Allowed values are: ASC, DESC

• :sort_by (String) —

  Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order). (default to TIME_CREATED) Allowed values are: TIME_CREATED, DISPLAY_NAME

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type PatchChangeSummaryCollection

# File 'lib/oci/data_integration/data_integration_client.rb', line 5286

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].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/list_patches.rb.html) 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.

Parameters:

• workspace_id (String) —

  The workspace ID.

• application_key (String) —

  The application key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :name (String) —

  Used to filter by the name of the object.

• :identifier (Array<String>) —

  Used to filter by the identifier of the published object. (default to [])

• :fields (Array<String>) —

  Specifies the fields to get for an object. (default to [])

• :limit (Integer) —

  Sets the maximum number of results per page, or items to return in a paginated List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 20)

• :page (String) —

  For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 1)

• :sort_order (String) —

  Specifies sort order to use, either ASC (ascending) or DESC (descending). (default to DESC) Allowed values are: ASC, DESC

• :sort_by (String) —

  Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order). (default to TIME_CREATED) Allowed values are: TIME_CREATED, DISPLAY_NAME

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type PatchSummaryCollection

# File 'lib/oci/data_integration/data_integration_client.rb', line 5371

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].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/list_pipeline_validations.rb.html) to see an example of how to use list_pipeline_validations API.

Retrieves a list of pipeline validations within the specified workspace.

Parameters:

• workspace_id (String) —

  The workspace ID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :key (String) —

  Used to filter by the key of the object.

• :name (String) —

  Used to filter by the name of the object.

• :identifier (String) —

  Used to filter by the identifier of the object.

• :fields (Array<String>) —

  Specifies the fields to get for an object. (default to [])

• :page (String) —

  For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

• :limit (Integer) —

  Sets the maximum number of results per page, or items to return in a paginated List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 100)

• :sort_by (String) —

  Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order). (default to TIME_CREATED) Allowed values are: TIME_CREATED, DISPLAY_NAME

• :sort_order (String) —

  Specifies sort order to use, either ASC (ascending) or DESC (descending). (default to DESC) Allowed values are: ASC, DESC

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type PipelineValidationSummaryCollection

# File 'lib/oci/data_integration/data_integration_client.rb', line 5455

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].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/list_pipelines.rb.html) 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.

Parameters:

• workspace_id (String) —

  The workspace ID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :aggregator_key (String) —

  Used to filter by the project or the folder object.

• :fields (Array<String>) —

  Specifies the fields to get for an object. (default to [])

• :name (String) —

  Used to filter by the name of the object.

• :identifier (Array<String>) —

  Used to filter by the identifier of the object. (default to [])

• :limit (Integer) —

  Sets the maximum number of results per page, or items to return in a paginated List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 100)

• :page (String) —

  For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

• :sort_order (String) —

  Specifies sort order to use, either ASC (ascending) or DESC (descending). (default to DESC) Allowed values are: ASC, DESC

• :sort_by (String) —

  Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order). (default to TIME_CREATED) Allowed values are: TIME_CREATED, DISPLAY_NAME

Returns:

• (Response) —

  A Response object with data of type PipelineSummaryCollection

# File 'lib/oci/data_integration/data_integration_client.rb', line 5540

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].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/list_projects.rb.html) 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.

Parameters:

• workspace_id (String) —

  The workspace ID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :fields (Array<String>) —

  Specifies the fields to get for an object. (default to [])

• :name (String) —

  Used to filter by the name of the object.

• :identifier (Array<String>) —

  Used to filter by the identifier of the object. (default to [])

• :page (String) —

  For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

• :limit (Integer) —

  Sets the maximum number of results per page, or items to return in a paginated List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 100)

• :sort_order (String) —

  Specifies sort order to use, either ASC (ascending) or DESC (descending). (default to DESC) Allowed values are: ASC, DESC

• :sort_by (String) —

  Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order). (default to TIME_CREATED) Allowed values are: TIME_CREATED, DISPLAY_NAME

Returns:

• (Response) —

  A Response object with data of type ProjectSummaryCollection

# File 'lib/oci/data_integration/data_integration_client.rb', line 5623

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].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  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[: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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/list_published_objects.rb.html) to see an example of how to use list_published_objects API.

Retrieves a list of all the published objects for a specified application.

Parameters:

• workspace_id (String) —

  The workspace ID.

• application_key (String) —

  The application key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :fields (Array<String>) —

  Specifies the fields to get for an object. (default to [])

• :name (String) —

  Used to filter by the name of the object.

• :identifier (Array<String>) —

  Used to filter by the identifier of the published object. (default to [])

• :type (Array<String>) —

  Used to filter by the object type of the object. It can be suffixed with an optional filter operator InSubtree. For Data Integration APIs, a filter based on type Task is used.

  (default to [])
  

• :type_in_subtree (String) —

  Used in association with type parameter. If value is true, then type all sub types of the given type parameter is considered. If value is false, then sub types are not considered. Default is false.

  (default to [])
  

• :limit (Integer) —

  Sets the maximum number of results per page, or items to return in a paginated List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 20)

• :page (String) —

  For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 1)

• :sort_order (String) —

  Specifies sort order to use, either ASC (ascending) or DESC (descending). (default to DESC) Allowed values are: ASC, DESC

• :sort_by (String) —

  Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order). (default to TIME_CREATED) Allowed values are: TIME_CREATED, DISPLAY_NAME

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type PublishedObjectSummaryCollection

# File 'lib/oci/data_integration/data_integration_client.rb', line 5714

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].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  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[: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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/list_references.rb.html) 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.

Parameters:

• workspace_id (String) —

  The workspace ID.

• application_key (String) —

  The application key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :limit (Integer) —

  Sets the maximum number of results per page, or items to return in a paginated List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 100)

• :page (String) —

  For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

• :name (String) —

  Used to filter by the name of the object.

• :sort_order (String) —

  Specifies sort order to use, either ASC (ascending) or DESC (descending). (default to DESC) Allowed values are: ASC, DESC

• :sort_by (String) —

  Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order). (default to TIME_CREATED) Allowed values are: TIME_CREATED, DISPLAY_NAME

Returns:

• (Response) —

  A Response object with data of type ReferenceSummaryCollection

# File 'lib/oci/data_integration/data_integration_client.rb', line 5798

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].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  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.make_retrying_call(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_schedules(workspace_id, application_key, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/list_schedules.rb.html) to see an example of how to use list_schedules API.

Use this endpoint to list schedules.

Parameters:

• workspace_id (String) —

  The workspace ID.

• application_key (String) —

  The application key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :key (Array<String>) —

  Used to filter by the key of the object. (default to [])

• :name (String) —

  Used to filter by the name of the object.

• :identifier (Array<String>) —

  Used to filter by the identifier of the object. (default to [])

• :type (Array<String>) —

  Used to filter by the object type of the object. It can be suffixed with an optional filter operator InSubtree. If this operator is not specified, then exact match is considered.
  Examples:
  <ul> <li>?type=DATA_LOADER_TASK&typeInSubtree=false returns all objects of type data loader task</li> <li>?type=DATA_LOADER_TASK returns all objects of type data loader task</li> <li>?type=DATA_LOADER_TASK&typeInSubtree=true returns all objects of type data loader task</li> </ul> (default to [])

• :page (String) —

  For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

• :limit (Integer) —

  Sets the maximum number of results per page, or items to return in a paginated List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 100)

• :sort_by (String) —

  Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order). (default to TIME_CREATED) Allowed values are: TIME_CREATED, DISPLAY_NAME

• :sort_order (String) —

  Specifies sort order to use, either ASC (ascending) or DESC (descending). (default to DESC) Allowed values are: ASC, DESC

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type ScheduleSummaryCollection

# File 'lib/oci/data_integration/data_integration_client.rb', line 5882

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].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/list_schemas.rb.html) 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.

Parameters:

• workspace_id (String) —

  The workspace ID.

• connection_key (String) —

  The connection key.

• schema_resource_name (String) —

  Schema resource name used for retrieving schemas.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :page (String) —

  For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

• :limit (Integer) —

  Sets the maximum number of results per page, or items to return in a paginated List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 100)

• :fields (Array<String>) —

  Specifies the fields to get for an object. (default to [])

• :sort_by (String) —

  Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order). (default to TIME_CREATED) Allowed values are: TIME_CREATED, DISPLAY_NAME

• :sort_order (String) —

  Specifies sort order to use, either ASC (ascending) or DESC (descending). (default to DESC) Allowed values are: ASC, DESC

• :name (String) —

  Used to filter by the name of the object.

• :opc_request_id (String) —

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

• :name_list (Array<String>) —

  Used to filter by the name of the object. (default to [])

Returns:

• (Response) —

  A Response object with data of type SchemaSummaryCollection

# File 'lib/oci/data_integration/data_integration_client.rb', line 5968

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].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  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?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: '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_logs(workspace_id, application_key, task_run_key, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/list_task_run_logs.rb.html) to see an example of how to use list_task_run_logs API.

Gets log entries for task runs using its key.

Parameters:

• workspace_id (String) —

  The workspace ID.

• application_key (String) —

  The application key.

• task_run_key (String) —

  The task run key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :page (String) —

  For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

• :limit (Integer) —

  Sets the maximum number of results per page, or items to return in a paginated List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 100)

• :sort_order (String) —

  Specifies sort order to use, either ASC (ascending) or DESC (descending). (default to DESC) Allowed values are: ASC, DESC

• :sort_by (String) —

  Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order). (default to TIME_CREATED) Allowed values are: TIME_CREATED, DISPLAY_NAME

Returns:

• (Response) —

  A Response object with data of type Array<TaskRunLogSummary>

# File 'lib/oci/data_integration/data_integration_client.rb', line 6052

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].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/list_task_runs.rb.html) 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.

Parameters:

• workspace_id (String) —

  The workspace ID.

• application_key (String) —

  The application key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :key (Array<String>) —

  Used to filter by the key of the object. (default to [])

• :aggregator_key (String) —

  Used to filter by the project or the folder object.

• :fields (Array<String>) —

  Specifies the fields to get for an object. (default to [])

• :name (String) —

  Used to filter by the name of the object.

• :identifier (Array<String>) —

  Used to filter by the identifier of the object. (default to [])

• :page (String) —

  For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

• :limit (Integer) —

  Sets the maximum number of results per page, or items to return in a paginated List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 100)

• :sort_order (String) —

  Specifies sort order to use, either ASC (ascending) or DESC (descending). (default to DESC) Allowed values are: ASC, DESC

• :sort_by (String) —

  Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order). (default to TIME_CREATED) Allowed values are: TIME_CREATED, DISPLAY_NAME

• :filter (Array<String>) —

  This filter parameter can be used to filter by model specific queryable fields of the object
  Examples:-
  <ul> <li>?filter=status eq Failed returns all objects that have a status field with value Failed</li> </ul> (default to [])

Returns:

• (Response) —

  A Response object with data of type TaskRunSummaryCollection

# File 'lib/oci/data_integration/data_integration_client.rb', line 6139

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].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  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?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/list_task_schedules.rb.html) 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.

Parameters:

• workspace_id (String) —

  The workspace ID.

• application_key (String) —

  The application key.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :key (Array<String>) —

  Used to filter by the key of the object. (default to [])

• :name (String) —

  Used to filter by the name of the object.

• :identifier (Array<String>) —

  Used to filter by the identifier of the object. (default to [])

• :type (Array<String>) —

  Used to filter by the object type of the object. It can be suffixed with an optional filter operator InSubtree. If this operator is not specified, then exact match is considered.
  Examples:
  <ul> <li>?type=DATA_LOADER_TASK&typeInSubtree=false returns all objects of type data loader task</li> <li>?type=DATA_LOADER_TASK returns all objects of type data loader task</li> <li>?type=DATA_LOADER_TASK&typeInSubtree=true returns all objects of type data loader task</li> </ul> (default to [])

• :page (String) —

  For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

• :limit (Integer) —

  Sets the maximum number of results per page, or items to return in a paginated List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 100)

• :sort_by (String) —

  Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order). (default to TIME_CREATED) Allowed values are: TIME_CREATED, DISPLAY_NAME

• :sort_order (String) —

  Specifies sort order to use, either ASC (ascending) or DESC (descending). (default to DESC) Allowed values are: ASC, DESC

• :opc_request_id (String) —

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

• :is_enabled (BOOLEAN) —

  This filter parameter can be used to filter task schedule by its state.

Returns:

• (Response) —

  A Response object with data of type TaskScheduleSummaryCollection

# File 'lib/oci/data_integration/data_integration_client.rb', line 6229

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].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/list_task_validations.rb.html) to see an example of how to use list_task_validations API.

Retrieves a list of task validations within the specified workspace.

Parameters:

• workspace_id (String) —

  The workspace ID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :key (String) —

  Used to filter by the key of the object.

• :name (String) —

  Used to filter by the name of the object.

• :identifier (String) —

  Used to filter by the identifier of the object.

• :fields (Array<String>) —

  Specifies the fields to get for an object. (default to [])

• :page (String) —

  For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

• :limit (Integer) —

  Sets the maximum number of results per page, or items to return in a paginated List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 100)

• :sort_by (String) —

  Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order). (default to TIME_CREATED) Allowed values are: TIME_CREATED, DISPLAY_NAME

• :sort_order (String) —

  Specifies sort order to use, either ASC (ascending) or DESC (descending). (default to DESC) Allowed values are: ASC, DESC

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type TaskValidationSummaryCollection

# File 'lib/oci/data_integration/data_integration_client.rb', line 6316

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].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/list_tasks.rb.html) to see an example of how to use list_tasks API.

Retrieves a list of all tasks in a specified project or folder.

Parameters:

• workspace_id (String) —

  The workspace ID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :folder_id (String) —

  Unique key of the folder.

• :fields (Array<String>) —

  Specifies the fields to get for an object. (default to [])

• :name (String) —

  Used to filter by the name of the object.

• :key (Array<String>) —

  Used to filter by the key of the object. (default to [])

• :identifier (Array<String>) —

  Used to filter by the identifier of the object. (default to [])

• :type (Array<String>) —

  Used to filter by the object type of the object. It can be suffixed with an optional filter operator InSubtree. If this operator is not specified, then exact match is considered.
  Examples:
  <ul> <li>?type=DATA_LOADER_TASK&typeInSubtree=false returns all objects of type data loader task</li> <li>?type=DATA_LOADER_TASK returns all objects of type data loader task</li> <li>?type=DATA_LOADER_TASK&typeInSubtree=true returns all objects of type data loader task</li> </ul> (default to [])

• :limit (Integer) —

  Sets the maximum number of results per page, or items to return in a paginated List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 100)

• :page (String) —

  For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

• :sort_order (String) —

  Specifies sort order to use, either ASC (ascending) or DESC (descending). (default to DESC) Allowed values are: ASC, DESC

• :sort_by (String) —

  Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order). (default to TIME_CREATED) Allowed values are: TIME_CREATED, DISPLAY_NAME

Returns:

• (Response) —

  A Response object with data of type TaskSummaryCollection

# File 'lib/oci/data_integration/data_integration_client.rb', line 6402

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].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  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.make_retrying_call(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_work_request_errors(work_request_id, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/list_work_request_errors.rb.html) to see an example of how to use list_work_request_errors API.

Retrieves a paginated list of errors for a given work request.

Parameters:

• work_request_id (String) —

  The ID of the asynchronous work request to retrieve.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :page (String) —

  For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

• :limit (Integer) —

  Sets the maximum number of results per page, or items to return in a paginated List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 100)

• :sort_order (String) —

  Specifies sort order to use, either ASC (ascending) or DESC (descending). (default to DESC) Allowed values are: ASC, DESC

• :sort_by (String) —

  Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order). (default to TIME_CREATED) Allowed values are: TIME_CREATED, DISPLAY_NAME

Returns:

• (Response) —

  A Response object with data of type Array<WorkRequestError>

# File 'lib/oci/data_integration/data_integration_client.rb', line 6484

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].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/list_work_request_logs.rb.html) to see an example of how to use list_work_request_logs API.

Retrieves a paginated list of logs for a given work request.

Parameters:

• work_request_id (String) —

  The ID of the asynchronous work request to retrieve.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :page (String) —

  For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

• :limit (Integer) —

  Sets the maximum number of results per page, or items to return in a paginated List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 100)

• :sort_order (String) —

  Specifies sort order to use, either ASC (ascending) or DESC (descending). (default to DESC) Allowed values are: ASC, DESC

• :sort_by (String) —

  Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order). (default to TIME_CREATED) Allowed values are: TIME_CREATED, DISPLAY_NAME

Returns:

• (Response) —

  A Response object with data of type Array<WorkRequestLogEntry>

# File 'lib/oci/data_integration/data_integration_client.rb', line 6560

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].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/list_work_requests.rb.html) to see an example of how to use list_work_requests API.

Lists the work requests in a compartment.

Parameters:

• compartment_id (String) —

  The OCID of the compartment containing the resources you want to list.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :workspace_id (String) —

  DIS workspace id (default to )

• :work_request_status (String) —

  The work request status. Allowed values are: ACCEPTED, IN_PROGRESS, FAILED, SUCCEEDED, CANCELING, CANCELED

• :page (String) —

  For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

• :limit (Integer) —

  Sets the maximum number of results per page, or items to return in a paginated List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 100)

• :sort_order (String) —

  Specifies sort order to use, either ASC (ascending) or DESC (descending). (default to DESC) Allowed values are: ASC, DESC

• :sort_by (String) —

  Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order). (default to TIME_CREATED) Allowed values are: TIME_CREATED, DISPLAY_NAME

Returns:

• (Response) —

  A Response object with data of type Array<WorkRequestSummary>

# File 'lib/oci/data_integration/data_integration_client.rb', line 6639

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].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/list_workspaces.rb.html) to see an example of how to use list_workspaces API.

Retrieves a list of Data Integration workspaces.

Parameters:

• compartment_id (String) —

  The OCID of the compartment containing the resources you want to list.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :name (String) —

  Used to filter by the name of the object.

• :limit (Integer) —

  Sets the maximum number of results per page, or items to return in a paginated List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). (default to 100)

• :page (String) —

  For list pagination. The value for this parameter is the opc-next-page or the opc-prev-page response header from the previous List call. See [List Pagination](docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

• :lifecycle_state (String) —

  The lifecycle state of a resource. When specified, the operation only returns resources that match the given lifecycle state. When not specified, all lifecycle states are processed as a match.

• :sort_order (String) —

  Specifies sort order to use, either ASC (ascending) or DESC (descending). (default to DESC) Allowed values are: ASC, DESC

• :sort_by (String) —

  Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter query is present (search operation and sorting order is by relevance score in descending order). (default to TIME_CREATED) Allowed values are: TIME_CREATED, DISPLAY_NAME

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type Array<WorkspaceSummary>

# File 'lib/oci/data_integration/data_integration_client.rb', line 6723

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].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  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.make_retrying_call(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.

Returns:

• (Logger) —

  The logger for this client. May be nil.

# File 'lib/oci/data_integration/data_integration_client.rb', line 92

def logger
  @api_client.config.logger
end

#start_workspace(workspace_id, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/start_workspace.rb.html) to see an example of how to use start_workspace API.

Starts a workspace.

Parameters:

• workspace_id (String) —

  The workspace ID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

• :opc_request_id (String) —

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

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_integration/data_integration_client.rb', line 6805

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/stop_workspace.rb.html) to see an example of how to use stop_workspace API.

Stops a workspace.

Parameters:

• workspace_id (String) —

  The workspace ID.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :quiesce_timeout (Integer) —

  Used to set the timeout for Data Integration to gracefully close down any running jobs before stopping the workspace. (default to 0)

• :is_force_operation (BOOLEAN) —

  Used to force close down the workspace. (default to false)

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

• :opc_request_id (String) —

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

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.

Returns:

• (Response) —

  A Response object with data of type nil

# File 'lib/oci/data_integration/data_integration_client.rb', line 6873

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/update_application.rb.html) to see an example of how to use update_application API.

Updates an application.

Parameters:

• workspace_id (String) —

  The workspace ID.

• application_key (String) —

  The application key.

• update_application_details (OCI::DataIntegration::Models::UpdateApplicationDetails) —

  The details needed to update an application.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type Application

# File 'lib/oci/data_integration/data_integration_client.rb', line 6940

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.make_retrying_call(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_connection(workspace_id, connection_key, update_connection_details, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/update_connection.rb.html) to see an example of how to use update_connection API.

Updates a connection under a data asset.

Parameters:

• workspace_id (String) —

  The workspace ID.

• connection_key (String) —

  The connection key.

• update_connection_details (OCI::DataIntegration::Models::UpdateConnectionDetails) —

  The information needed to update a connection.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

Returns:

• (Response) —

  A Response object with data of type Connection

# File 'lib/oci/data_integration/data_integration_client.rb', line 7007

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.make_retrying_call(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_data_asset(workspace_id, data_asset_key, update_data_asset_details, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/update_data_asset.rb.html) to see an example of how to use update_data_asset API.

Updates a specific data asset with default connection.

Parameters:

• workspace_id (String) —

  The workspace ID.

• data_asset_key (String) —

  The data asset key.

• update_data_asset_details (OCI::DataIntegration::Models::UpdateDataAssetDetails) —

  The information needed to update a data asset.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

Returns:

• (Response) —

  A Response object with data of type DataAsset

# File 'lib/oci/data_integration/data_integration_client.rb', line 7074

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/update_data_flow.rb.html) to see an example of how to use update_data_flow API.

Updates a specific data flow.

Parameters:

• workspace_id (String) —

  The workspace ID.

• data_flow_key (String) —

  The data flow key.

• update_data_flow_details (OCI::DataIntegration::Models::UpdateDataFlowDetails) —

  The details needed to updated a data flow.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

Returns:

• (Response) —

  A Response object with data of type DataFlow

# File 'lib/oci/data_integration/data_integration_client.rb', line 7141

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.make_retrying_call(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_external_publication(workspace_id, task_key, external_publications_key, update_external_publication_details, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/update_external_publication.rb.html) to see an example of how to use update_external_publication API.

Updates the external publication object.

Parameters:

• workspace_id (String) —

  The workspace ID.

• task_key (String) —

  The task key.

• external_publications_key (String) —

  The external published object key.

• update_external_publication_details (OCI::DataIntegration::Models::UpdateExternalPublicationDetails) —

  The information to be updated.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

Returns:

• (Response) —

  A Response object with data of type ExternalPublication

# File 'lib/oci/data_integration/data_integration_client.rb', line 7209

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/update_folder.rb.html) to see an example of how to use update_folder API.

Updates a specific folder.

Parameters:

• workspace_id (String) —

  The workspace ID.

• folder_key (String) —

  The folder key.

• update_folder_details (OCI::DataIntegration::Models::UpdateFolderDetails) —

  The details needed to update a folder.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

Returns:

• (Response) —

  A Response object with data of type Folder

# File 'lib/oci/data_integration/data_integration_client.rb', line 7278

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.make_retrying_call(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_pipeline(workspace_id, pipeline_key, update_pipeline_details, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/update_pipeline.rb.html) to see an example of how to use update_pipeline API.

Updates a specific pipeline.

Parameters:

• workspace_id (String) —

  The workspace ID.

• pipeline_key (String) —

  The pipeline key.

• update_pipeline_details (OCI::DataIntegration::Models::UpdatePipelineDetails) —

  The details needed to updated a pipeline.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

Returns:

• (Response) —

  A Response object with data of type Pipeline

# File 'lib/oci/data_integration/data_integration_client.rb', line 7345

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/update_project.rb.html) to see an example of how to use update_project API.

Updates a specific project.

Parameters:

• workspace_id (String) —

  The workspace ID.

• project_key (String) —

  The project key.

• update_project_details (OCI::DataIntegration::Models::UpdateProjectDetails) —

  The details needed to update a project.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

Returns:

• (Response) —

  A Response object with data of type Project

# File 'lib/oci/data_integration/data_integration_client.rb', line 7412

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/update_reference.rb.html) 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.

Parameters:

• workspace_id (String) —

  The workspace ID.

• application_key (String) —

  The application key.

• reference_key (String) —

  The reference key.

• update_reference_details (OCI::DataIntegration::Models::UpdateReferenceDetails) —

  The details needed to update the references.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

• :opc_retry_token (String) —

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again.

Returns:

• (Response) —

  A Response object with data of type Reference

# File 'lib/oci/data_integration/data_integration_client.rb', line 7482

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/update_schedule.rb.html) to see an example of how to use update_schedule API.

Endpoint used to update the schedule

Parameters:

• workspace_id (String) —

  The workspace ID.

• application_key (String) —

  The application key.

• schedule_key (String) —

  Schedule Key

• update_schedule_details (OCI::DataIntegration::Models::UpdateScheduleDetails) —

  Request body parameter for Schedule details

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type Schedule

# File 'lib/oci/data_integration/data_integration_client.rb', line 7554

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/update_task.rb.html) 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.

Parameters:

• workspace_id (String) —

  The workspace ID.

• task_key (String) —

  The task key.

• update_task_details (OCI::DataIntegration::Models::UpdateTaskDetails) —

  The details needed to update a task.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

Returns:

• (Response) —

  A Response object with data of type Task

# File 'lib/oci/data_integration/data_integration_client.rb', line 7623

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/update_task_run.rb.html) 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.

Parameters:

• workspace_id (String) —

  The workspace ID.

• application_key (String) —

  The application key.

• task_run_key (String) —

  The task run key.

• update_task_run_details (OCI::DataIntegration::Models::UpdateTaskRunDetails) —

  The details needed to update the status of a task run.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :opc_request_id (String) —

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

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

Returns:

• (Response) —

  A Response object with data of type TaskRunDetails

# File 'lib/oci/data_integration/data_integration_client.rb', line 7691

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.make_retrying_call(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

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/update_task_schedule.rb.html) to see an example of how to use update_task_schedule API.

Endpoint used to update the TaskSchedule

Parameters:

• workspace_id (String) —

  The workspace ID.

• application_key (String) —

  The application key.

• task_schedule_key (String) —

  TaskSchedule Key

• update_task_schedule_details (OCI::DataIntegration::Models::UpdateTaskScheduleDetails) —

  Request body parameter for TaskSchedule details

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type TaskSchedule

# File 'lib/oci/data_integration/data_integration_client.rb', line 7761

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.make_retrying_call(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_workspace(workspace_id, update_workspace_details, opts = {}) ⇒ Response

Note:

Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dataintegration/update_workspace.rb.html) to see an example of how to use update_workspace API.

Updates the specified Data Integration workspace.

Parameters:

• workspace_id (String) —

  The workspace ID.

• update_workspace_details (OCI::DataIntegration::Models::UpdateWorkspaceDetails) —

  The information needed to update the workspace.

• opts (Hash) (defaults to: {}) —

  the optional parameters

Options Hash (opts):

• :retry_config (OCI::Retry::RetryConfig) —

  The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

• :if_match (String) —

  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

• :opc_request_id (String) —

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

Returns:

• (Response) —

  A Response object with data of type Workspace

# File 'lib/oci/data_integration/data_integration_client.rb', line 7829

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.make_retrying_call(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