Skip to content

sch.oracle.com/v1beta1

Back to API Reference

APIVersion: sch.oracle.com/v1beta1

This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.

Packages

No customer-visible package currently exposes sch.oracle.com/v1beta1.

Resources

Kind Scope Sample Packages
ServiceConnector Namespaced Sample -

ServiceConnector

Manage OCI Service Connector Hub service connectors.

  • Plural: serviceconnectors
  • Scope: Namespaced
  • APIVersion: sch.oracle.com/v1beta1
  • Sample: Sample (config/samples/sch_v1beta1_serviceconnector.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

ServiceConnectorSpec defines the desired state of ServiceConnector.

Field Description Type Required Default Enum
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the comparment to create the connector in. string Yes - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
description The description of the resource. Avoid entering confidential information. string No - -
displayName A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. string Yes - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} map[string, string] No - -
source ServiceConnectorSource defines nested fields for ServiceConnector.Source. object Yes - -
target ServiceConnectorTarget defines nested fields for ServiceConnector.Target. object Yes - -
tasks The list of tasks. list[object] No - -

Spec.source

Back to ServiceConnector spec

ServiceConnectorSource defines nested fields for ServiceConnector.Source.

Field Description Type Required Default Enum
configMap The configuration map for the connector plugin. This map includes parameters specific to the connector plugin type. For example, for QueueSource, the map lists the OCID of the selected queue. To find the parameters for a connector plugin, get the plugin using GetConnectorPlugin and review its schema value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
cursor ServiceConnectorSourceCursor defines nested fields for ServiceConnector.Source.Cursor. object No - -
jsonData - string No - -
kind - string No - -
logSources The logs for this Logging source. list[object] No - -
monitoringSources One or more compartment-specific lists of metric namespaces to retrieve data from. list[object] No - -
pluginName The name of the connector plugin. This name indicates the service to be called by the connector plugin. For example, QueueSource indicates the Queue service. To find names of connector plugins, list the plugin using ListConnectorPlugins. string No - -
streamId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream. string No - -

Spec.source.cursor

Back to ServiceConnector spec

ServiceConnectorSourceCursor defines nested fields for ServiceConnector.Source.Cursor.

Field Description Type Required Default Enum
jsonData - string No - -
kind - string No - -

Spec.source.logSources[]

Back to ServiceConnector spec

ServiceConnectorSourceLogSource defines nested fields for ServiceConnector.Source.LogSource.

Field Description Type Required Default Enum
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the log source. string Yes - -
logGroupId Identifier of the log group. Either _Audit or the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. Note: For the Notifications target, only _Audit is allowed. string No - -
logId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log. string No - -

Spec.source.monitoringSources[]

Back to ServiceConnector spec

ServiceConnectorSourceMonitoringSource defines nested fields for ServiceConnector.Source.MonitoringSource.

Field Description Type Required Default Enum
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a compartment containing metric namespaces you want to use for the Monitoring source. string Yes - -
namespaceDetails ServiceConnectorSourceMonitoringSourceNamespaceDetails defines nested fields for ServiceConnector.Source.MonitoringSource.NamespaceDetails. object Yes - -

Spec.source.monitoringSources[].namespaceDetails

Back to ServiceConnector spec

ServiceConnectorSourceMonitoringSourceNamespaceDetails defines nested fields for ServiceConnector.Source.MonitoringSource.NamespaceDetails.

Field Description Type Required Default Enum
jsonData - string No - -
kind - string No - -
namespaces The namespaces for the compartment-specific list. list[object] No - -

Spec.source.monitoringSources[].namespaceDetails.namespaces[]

Back to ServiceConnector spec

ServiceConnectorSourceMonitoringSourceNamespaceDetailsNamespace defines nested fields for ServiceConnector.Source.MonitoringSource.NamespaceDetails.Namespace.

Field Description Type Required Default Enum
metrics ServiceConnectorSourceMonitoringSourceNamespaceDetailsNamespaceMetrics defines nested fields for ServiceConnector.Source.MonitoringSource.NamespaceDetails.Namespace.Metrics. object Yes - -
namespace The source service or application to use when querying for metric data points. Must begin with oci_. Example: oci_computeagent string Yes - -

Spec.source.monitoringSources[].namespaceDetails.namespaces[].metrics

Back to ServiceConnector spec

ServiceConnectorSourceMonitoringSourceNamespaceDetailsNamespaceMetrics defines nested fields for ServiceConnector.Source.MonitoringSource.NamespaceDetails.Namespace.Metrics.

Field Description Type Required Default Enum
jsonData - string No - -
kind - string No - -

Spec.target

Back to ServiceConnector spec

ServiceConnectorTarget defines nested fields for ServiceConnector.Target.

Field Description Type Required Default Enum
batchRolloverSizeInMBs The batch rollover size in megabytes. integer No - -
batchRolloverTimeInMs The batch rollover time in milliseconds. integer No - -
batchSizeInKbs The batch rollover size in kilobytes. Only one size option can be specified: batchSizeInKbs or batchSizeInNum. integer No - -
batchSizeInNum The batch rollover size in number of messages. Only one size option can be specified: batchSizeInKbs or batchSizeInNum. integer No - -
batchTimeInSec The batch rollover time in seconds. integer No - -
bucketName The name of the bucket. Valid characters are letters (upper or lower case), numbers, hyphens (-), underscores(_), and periods (.). Bucket names must be unique within an Object Storage namespace. Avoid entering confidential information. Example: my-new-bucket1 string No - -
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric. string No - -
dimensions List of dimension names and values. list[object] No - -
enableFormattedMessaging Whether to apply a simplified, user-friendly format to the message. Applies only when friendly formatting is supported by the connector source and the subscription protocol. Example: true boolean No - -
functionId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the function. string No - -
jsonData - string No - -
kind - string No - -
logGroupId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Logging Analytics log group. string No - -
logSourceIdentifier Identifier of the log source that you want to use for processing data received from the connector source. Applies to StreamingSource only. Equivalent to name at LogAnalyticsSource. string No - -
metric The name of the metric. Example: CpuUtilization string No - -
metricNamespace The namespace of the metric. Example: oci_computeagent string No - -
namespace The namespace. string No - -
objectNamePrefix The prefix of the objects. Avoid entering confidential information. string No - -
streamId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream. string No - -
topicId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic. string No - -

Spec.target.dimensions[]

Back to ServiceConnector spec

ServiceConnectorTargetDimension defines nested fields for ServiceConnector.Target.Dimension.

Field Description Type Required Default Enum
dimensionValue ServiceConnectorTargetDimensionDimensionValue defines nested fields for ServiceConnector.Target.Dimension.DimensionValue. object Yes - -
name Dimension key. A valid dimension key includes only printable ASCII, excluding periods (.) and spaces. Custom dimension keys are acceptable. Avoid entering confidential information. Due to use by Connector Hub, the following dimension names are reserved: connectorId, connectorName, connectorSourceType. For information on valid dimension keys and values, see MetricDataDetails. Example: type string Yes - -

Spec.target.dimensions[].dimensionValue

Back to ServiceConnector spec

ServiceConnectorTargetDimensionDimensionValue defines nested fields for ServiceConnector.Target.Dimension.DimensionValue.

Field Description Type Required Default Enum
jsonData - string No - -
kind - string No - -
path The location to use for deriving the dimension value (evaluated). The path must start with logContent in an acceptable notation style with supported JMESPath selectors (https://jmespath.org/specification.html): expression with dot and index operator (. and MetricDataDetails. The returned value depends on the results of evaluation. If the evaluated value is valid, then the evaluated value is returned without double quotes. (Any front or trailing double quotes are trimmed before returning the value. For example, the evaluated value"compartmentId"is returned ascompartmentId.) If the evaluated value is invalid, then the returned value isSCH_EVAL_INVALID_VALUE. If the evaluated value is empty, then the returned value isSCH_EVAL_VALUE_EMPTY. |string` No - -
value The data extracted from the specified dimension value (passed as-is). Unicode characters only. For information on valid dimension keys and values, see MetricDataDetails. string No - -

Spec.tasks[]

Back to ServiceConnector spec

ServiceConnectorTask defines nested fields for ServiceConnector.Task.

Field Description Type Required Default Enum
batchSizeInKbs Size limit (kilobytes) for batch sent to invoke the function. integer No - -
batchTimeInSec Time limit (seconds) for batch sent to invoke the function. integer No - -
condition A filter or mask to limit the source used in the flow defined by the connector. string No - -
functionId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the function to be used as a task. string No - -
jsonData - string No - -
kind - string No - -

Status

ServiceConnectorStatus defines the observed state of ServiceConnector.

Field Description Type Required Default Enum
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the connector. string No - -
definedTags Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
description The description of the resource. Avoid entering confidential information. string No - -
displayName A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information. string No - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} map[string, string] No - -
id The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the connector. string No - -
lifecycleDetails A message describing the current state in more detail. For example, the message might provide actionable information for a resource in a FAILED state. string No - -
lifecycleState The current state of the connector. string No - -
lifecyleDetails Please note this property is deprecated and will be removed on January 27, 2026. Use lifecycleDetails instead. A message describing the current state in more detail. For example, the message might provide actionable information for a resource in a FAILED state. string No - -
source ServiceConnectorSource defines nested fields for ServiceConnector.Source. object No - -
status - object Yes - -
systemTags The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {orcl-cloud: {free-tier-retain: true}} map[string, map[string, string]] No - -
target ServiceConnectorTarget defines nested fields for ServiceConnector.Target. object No - -
tasks The list of tasks. list[object] No - -
timeCreated The date and time when the connector was created. Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: 2020-01-25T21:10:29.600Z string No - -
timeUpdated The date and time when the connector was updated. Format is defined by RFC3339 (https://tools.ietf.org/html/rfc3339). Example: 2020-01-25T21:10:29.600Z string No - -

Status.source

Back to ServiceConnector status

ServiceConnectorSource defines nested fields for ServiceConnector.Source.

Field Description Type Required Default Enum
configMap The configuration map for the connector plugin. This map includes parameters specific to the connector plugin type. For example, for QueueSource, the map lists the OCID of the selected queue. To find the parameters for a connector plugin, get the plugin using GetConnectorPlugin and review its schema value. Unknown nested fields are preserved. object (preserves unknown fields) No - -
cursor ServiceConnectorSourceCursor defines nested fields for ServiceConnector.Source.Cursor. object No - -
jsonData - string No - -
kind - string No - -
logSources The logs for this Logging source. list[object] No - -
monitoringSources One or more compartment-specific lists of metric namespaces to retrieve data from. list[object] No - -
pluginName The name of the connector plugin. This name indicates the service to be called by the connector plugin. For example, QueueSource indicates the Queue service. To find names of connector plugins, list the plugin using ListConnectorPlugins. string No - -
streamId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream. string No - -

Status.source.cursor

Back to ServiceConnector status

ServiceConnectorSourceCursor defines nested fields for ServiceConnector.Source.Cursor.

Field Description Type Required Default Enum
jsonData - string No - -
kind - string No - -

Status.source.logSources[]

Back to ServiceConnector status

ServiceConnectorSourceLogSource defines nested fields for ServiceConnector.Source.LogSource.

Field Description Type Required Default Enum
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the log source. string Yes - -
logGroupId Identifier of the log group. Either _Audit or the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group. Note: For the Notifications target, only _Audit is allowed. string No - -
logId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log. string No - -

Status.source.monitoringSources[]

Back to ServiceConnector status

ServiceConnectorSourceMonitoringSource defines nested fields for ServiceConnector.Source.MonitoringSource.

Field Description Type Required Default Enum
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a compartment containing metric namespaces you want to use for the Monitoring source. string Yes - -
namespaceDetails ServiceConnectorSourceMonitoringSourceNamespaceDetails defines nested fields for ServiceConnector.Source.MonitoringSource.NamespaceDetails. object Yes - -

Status.source.monitoringSources[].namespaceDetails

Back to ServiceConnector status

ServiceConnectorSourceMonitoringSourceNamespaceDetails defines nested fields for ServiceConnector.Source.MonitoringSource.NamespaceDetails.

Field Description Type Required Default Enum
jsonData - string No - -
kind - string No - -
namespaces The namespaces for the compartment-specific list. list[object] No - -

Status.source.monitoringSources[].namespaceDetails.namespaces[]

Back to ServiceConnector status

ServiceConnectorSourceMonitoringSourceNamespaceDetailsNamespace defines nested fields for ServiceConnector.Source.MonitoringSource.NamespaceDetails.Namespace.

Field Description Type Required Default Enum
metrics ServiceConnectorSourceMonitoringSourceNamespaceDetailsNamespaceMetrics defines nested fields for ServiceConnector.Source.MonitoringSource.NamespaceDetails.Namespace.Metrics. object Yes - -
namespace The source service or application to use when querying for metric data points. Must begin with oci_. Example: oci_computeagent string Yes - -

Status.source.monitoringSources[].namespaceDetails.namespaces[].metrics

Back to ServiceConnector status

ServiceConnectorSourceMonitoringSourceNamespaceDetailsNamespaceMetrics defines nested fields for ServiceConnector.Source.MonitoringSource.NamespaceDetails.Namespace.Metrics.

Field Description Type Required Default Enum
jsonData - string No - -
kind - string No - -

Status.status

Back to ServiceConnector status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to ServiceConnector status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to ServiceConnector status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to ServiceConnector status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -

Status.target

Back to ServiceConnector status

ServiceConnectorTarget defines nested fields for ServiceConnector.Target.

Field Description Type Required Default Enum
batchRolloverSizeInMBs The batch rollover size in megabytes. integer No - -
batchRolloverTimeInMs The batch rollover time in milliseconds. integer No - -
batchSizeInKbs The batch rollover size in kilobytes. Only one size option can be specified: batchSizeInKbs or batchSizeInNum. integer No - -
batchSizeInNum The batch rollover size in number of messages. Only one size option can be specified: batchSizeInKbs or batchSizeInNum. integer No - -
batchTimeInSec The batch rollover time in seconds. integer No - -
bucketName The name of the bucket. Valid characters are letters (upper or lower case), numbers, hyphens (-), underscores(_), and periods (.). Bucket names must be unique within an Object Storage namespace. Avoid entering confidential information. Example: my-new-bucket1 string No - -
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric. string No - -
dimensions List of dimension names and values. list[object] No - -
enableFormattedMessaging Whether to apply a simplified, user-friendly format to the message. Applies only when friendly formatting is supported by the connector source and the subscription protocol. Example: true boolean No - -
functionId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the function. string No - -
jsonData - string No - -
kind - string No - -
logGroupId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Logging Analytics log group. string No - -
logSourceIdentifier Identifier of the log source that you want to use for processing data received from the connector source. Applies to StreamingSource only. Equivalent to name at LogAnalyticsSource. string No - -
metric The name of the metric. Example: CpuUtilization string No - -
metricNamespace The namespace of the metric. Example: oci_computeagent string No - -
namespace The namespace. string No - -
objectNamePrefix The prefix of the objects. Avoid entering confidential information. string No - -
streamId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream. string No - -
topicId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic. string No - -

Status.target.dimensions[]

Back to ServiceConnector status

ServiceConnectorTargetDimension defines nested fields for ServiceConnector.Target.Dimension.

Field Description Type Required Default Enum
dimensionValue ServiceConnectorTargetDimensionDimensionValue defines nested fields for ServiceConnector.Target.Dimension.DimensionValue. object Yes - -
name Dimension key. A valid dimension key includes only printable ASCII, excluding periods (.) and spaces. Custom dimension keys are acceptable. Avoid entering confidential information. Due to use by Connector Hub, the following dimension names are reserved: connectorId, connectorName, connectorSourceType. For information on valid dimension keys and values, see MetricDataDetails. Example: type string Yes - -

Status.target.dimensions[].dimensionValue

Back to ServiceConnector status

ServiceConnectorTargetDimensionDimensionValue defines nested fields for ServiceConnector.Target.Dimension.DimensionValue.

Field Description Type Required Default Enum
jsonData - string No - -
kind - string No - -
path The location to use for deriving the dimension value (evaluated). The path must start with logContent in an acceptable notation style with supported JMESPath selectors (https://jmespath.org/specification.html): expression with dot and index operator (. and MetricDataDetails. The returned value depends on the results of evaluation. If the evaluated value is valid, then the evaluated value is returned without double quotes. (Any front or trailing double quotes are trimmed before returning the value. For example, the evaluated value"compartmentId"is returned ascompartmentId.) If the evaluated value is invalid, then the returned value isSCH_EVAL_INVALID_VALUE. If the evaluated value is empty, then the returned value isSCH_EVAL_VALUE_EMPTY. |string` No - -
value The data extracted from the specified dimension value (passed as-is). Unicode characters only. For information on valid dimension keys and values, see MetricDataDetails. string No - -

Status.tasks[]

Back to ServiceConnector status

ServiceConnectorTask defines nested fields for ServiceConnector.Task.

Field Description Type Required Default Enum
batchSizeInKbs Size limit (kilobytes) for batch sent to invoke the function. integer No - -
batchTimeInSec Time limit (seconds) for batch sent to invoke the function. integer No - -
condition A filter or mask to limit the source used in the flow defined by the connector. string No - -
functionId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the function to be used as a task. string No - -
jsonData - string No - -
kind - string No - -