connect_harnesses

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

Overview

Name	connect_harnesses
Type	Resource
Id	oci.streaming.connect_harnesses

Fields

The following fields are returned by SELECT queries:

list

Summary representation of a ConnectHarness.

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. Example: TelemetryEvents (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 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"}
lifecycleState	string	The current state of the connect harness. (CREATING, ACTIVE, DELETING, DELETED, FAILED, UPDATING)
timeCreated	string (date-time)	The date and time the connect harness was created, expressed 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
list	select	compartmentId, region	id, name, limit, page, sortBy, sortOrder, lifecycleState, opc-request-id	Lists the connectharness.

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
compartmentId	string	The OCID of the compartment.
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)
id	string	A filter to return only resources that match the given ID exactly.
lifecycleState	string	A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
limit	integer	The maximum number of items to return. The value must be between 1 and 50. The default is 10.
name	string	A filter to return only resources that match the given name exactly.
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.
page	string	The page at which to start retrieving results.
sortBy	string	The field to sort by. You can provide no more than one sort order. By default, TIMECREATED sorts results in descending order and NAME sorts results in ascending order.
sortOrder	string	The sort order to use, either 'asc' or 'desc'.

SELECT examples

list

Lists the connectharness.

SELECT
id,
name,
compartmentId,
definedTags,
freeformTags,
lifecycleState,
timeCreated
FROM oci.streaming.connect_harnesses
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND id = '{{ id }}'
AND name = '{{ name }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND lifecycleState = '{{ lifecycleState }}'
AND opc-request-id = '{{ opc-request-id }}'
;