connect_harness

Creates, updates, deletes, gets or lists a connect_harness resource.

Overview

Name	`connect_harness`
Type	Resource
Id	`oci.streaming.connect_harness`

Fields

The following fields are returned by SELECT queries:

Name	Datatype	Description
`id`	`string`	The OCID of the connect harness. (example: ocid1.connectharness.realm.region.mnopqr789)
`name`	`string`	The name of the connect harness. Avoid entering confidential information. Example: `JDBCConnector` (example: TelemetryEvents)
`compartmentId`	`string`	The OCID of the compartment that contains the connect harness. (example: ocid1.compartment.realm.region.zxcvbn432765)
`definedTags`	`object`	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}'
`freeformTags`	`object`	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
`lifecycleState`	`string`	The current state of the connect harness. (CREATING, ACTIVE, DELETING, DELETED, FAILED, UPDATING)
`lifecycleStateDetails`	`string`	Any additional details about the current state of the connect harness.
`timeCreated`	`string (date-time)`	The date and time the connect harness was created, expressed in in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2018-04-20T00:00:07.405Z`

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`connectHarnessId`, `region`	`opc-request-id`	Gets detailed information about a connect harness.
`create`	`insert`	`region`, `name`, `compartmentId`	`opc-request-id`, `opc-retry-token`	Starts the provisioning of a new connect harness.<br />To track the progress of the provisioning, you can periodically call [GetConnectHarness].<br />In the response, the `lifecycleState` parameter of the [ConnectHarness](#/en/streaming/20180418/ConnectHarness/) object tells you its current state.<br />
`update`	`update`	`connectHarnessId`, `region`	`opc-request-id`, `if-match`	Updates the tags applied to the connect harness.<br />
`delete`	`delete`	`connectHarnessId`, `region`	`opc-request-id`, `if-match`	Deletes a connect harness and its content. Connect harness contents are deleted immediately. The service retains records of the connect harness itself for 90 days after deletion.<br />The `lifecycleState` parameter of the `ConnectHarness` object changes to `DELETING` and the connect harness becomes inaccessible for read or write operations.<br />To verify that a connect harness has been deleted, make a [GetConnectHarness](#/en/streaming/20180418/ConnectHarness/GetConnectHarness) request. If the call returns the connect harness's<br />lifecycle state as `DELETED`, then the connect harness has been deleted. If the call returns a "404 Not Found" error, that means all records of the<br />connect harness have been deleted.<br />
`change_compartment`	`exec`	`connectHarnessId`, `region`, `compartmentId`	`if-match`, `opc-request-id`	Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`connectHarnessId`	`string`	The OCID of the connect harness.
`region`	`string`	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
`if-match`	`string`	For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc-request-id`	`string`	The 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. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

`SELECT` examples

Gets detailed information about a connect harness.

SELECT
id,
name,
compartmentId,
definedTags,
freeformTags,
lifecycleState,
lifecycleStateDetails,
timeCreated
FROM oci.streaming.connect_harness
WHERE connectHarnessId = '{{ connectHarnessId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

`INSERT` examples

create
Manifest

Starts the provisioning of a new connect harness. To track the progress of the provisioning, you can periodically call [GetConnectHarness]. In the response, the lifecycleState parameter of the [ConnectHarness](#/en/streaming/20180418/ConnectHarness/) object tells you its current state.

INSERT INTO oci.streaming.connect_harness (
compartmentId,
definedTags,
freeformTags,
name,
region,
opc-request-id,
opc-retry-token
)
SELECT 
'{{ compartmentId }}' /* required */,
'{{ definedTags }}',
'{{ freeformTags }}',
'{{ name }}' /* required */,
'{{ region }}',
'{{ opc-request-id }}',
'{{ opc-retry-token }}'
RETURNING
id,
name,
compartmentId,
definedTags,
freeformTags,
lifecycleState,
lifecycleStateDetails,
timeCreated
;

# Description fields are for documentation purposes
- name: connect_harness
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the connect_harness resource.
  - name: compartmentId
    value: "{{ compartmentId }}"
    description: |
      The OCID of the compartment that contains the connect harness.
  - name: definedTags
    value: "{{ definedTags }}"
    description: |
      Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
      Example: `{"Operations": {"CostCenter": "42"}}`
  - name: freeformTags
    value: "{{ freeformTags }}"
    description: |
      Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only.
      For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
      Example: `{"Department": "Finance"}`
  - name: name
    value: "{{ name }}"
    description: |
      The name of the connect harness. Avoid entering confidential information.
      Example: `JDBCConnector`
  - name: opc-request-id
    value: "{{ opc-request-id }}"
    description: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 
    description: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 
  - name: opc-retry-token
    value: "{{ opc-retry-token }}"
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

`UPDATE` examples

update

Updates the tags applied to the connect harness.

UPDATE oci.streaming.connect_harness
SET 
definedTags = '{{ definedTags }}',
freeformTags = '{{ freeformTags }}'
WHERE 
connectHarnessId = '{{ connectHarnessId }}' --required
AND region = '{{ region }}' --required
AND opc-request-id = '{{ opc-request-id}}'
AND if-match = '{{ if-match}}'
RETURNING
id,
name,
compartmentId,
definedTags,
freeformTags,
lifecycleState,
lifecycleStateDetails,
timeCreated;

`DELETE` examples

delete

Deletes a connect harness and its content. Connect harness contents are deleted immediately. The service retains records of the connect harness itself for 90 days after deletion. The lifecycleState parameter of the ConnectHarness object changes to DELETING and the connect harness becomes inaccessible for read or write operations. To verify that a connect harness has been deleted, make a [GetConnectHarness](#/en/streaming/20180418/ConnectHarness/GetConnectHarness) request. If the call returns the connect harness's lifecycle state as DELETED, then the connect harness has been deleted. If the call returns a "404 Not Found" error, that means all records of the connect harness have been deleted.

DELETE FROM oci.streaming.connect_harness
WHERE connectHarnessId = '{{ connectHarnessId }}' --required
AND region = '{{ region }}' --required
AND opc-request-id = '{{ opc-request-id }}'
AND if-match = '{{ if-match }}'
;

Lifecycle Methods

change_compartment

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

EXEC oci.streaming.connect_harness.change_compartment 
@connectHarnessId='{{ connectHarnessId }}' --required, 
@region='{{ region }}' --required, 
@if-match='{{ if-match }}', 
@opc-request-id='{{ opc-request-id }}' 
@@json=
'{
"compartmentId": "{{ compartmentId }}"
}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​