gdp.oracle.com/v1beta1¶
APIVersion: gdp.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 gdp.oracle.com/v1beta1.
Resources¶
| Kind | Scope | Sample | Packages |
|---|---|---|---|
| GdpPipeline | Namespaced | Sample | - |
GdpPipeline¶
Manage OCI Guarded Data Pipeline resources.
Plural:gdppipelinesScope:NamespacedAPIVersion:gdp.oracle.com/v1beta1Sample: Sample (config/samples/gdp_v1beta1_gdppipeline.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
GdpPipelineSpec defines the desired state of GdpPipeline.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
approvalKeyVaultId |
The KMS vault OCID for the key to be used for file transfer approvals. | string |
No | - | - |
authorizationDetails |
Authorization information about the pipeline being configured. | string |
No | - | - |
bucketDetails |
Information about the bucket in the pipeline being configured. | list[object] |
Yes | - | - |
compartmentId |
The OCID of the compartment. | 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 |
Short field input by customer for a description of the data pipeline use-case. | string |
No | - | - |
displayName |
Pipeline short name. | string |
Yes | - | - |
fileTypes |
List of file types allowed to be transferred in the pipeline according to the authorization details (e.g. .pdf, .xml, .doc). | list[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 | - | - |
isApprovalNeeded |
Determines whether file transfers need to go through an approval workflow. | boolean |
No | - | - |
isChunkingEnabled |
Determines whether file must be chunked during the transfer. This is only a property of SENDER pipelines. | boolean |
No | - | - |
isFileOverrideInDestinationEnabled |
Enable file override feature in destination bucket | boolean |
No | - | - |
isScanningEnabled |
Determines whether GDP Scanning should be enabled for the pipeline. | boolean |
No | - | - |
peeringRegion |
Public region name where the peered pipeline exists. | string |
Yes | - | - |
pipelineType |
Type of pipeline. Can be SENDER or RECEIVER. | string |
Yes | - | - |
serviceLogGroupId |
the OCID of the service log group. | string |
No | - | - |
Spec.bucketDetails[]¶
GdpPipelineBucketDetail defines nested fields for GdpPipeline.BucketDetail.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
bucketType |
Type of bucket. SENDER pipelines can be SOURCE, TRANSFER, REJECT, or FAILED. RECEIVER pipelines have a DESTINATION bucket. | string |
Yes | - | - |
id |
OCID of the bucket. | string |
Yes | - | - |
name |
Name of the bucket. | string |
Yes | - | - |
namespace |
Namespace of the bucket. | string |
Yes | - | - |
Status¶
GdpPipelineStatus defines the observed state of GdpPipeline.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
approvalKeyVaultId |
The KMS vault OCID for the key to be used for file transfer approvals. | string |
No | - | - |
authorizationDetails |
Authorization information about the pipeline being configured. | string |
No | - | - |
bucketDetails |
Information about the bucket in the pipeline being configured. | list[object] |
No | - | - |
compartmentId |
The OCID of the compartment. | 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 |
Short field input by customer for a description of the data pipeline use-case. | string |
No | - | - |
displayName |
Pipeline short name. | string |
No | - | - |
fileTypes |
List of file types allowed to be transferred in the pipeline according to the authorization details (e.g. .pdf, .xml, .doc). | list[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 of the pipeline. | string |
No | - | - |
isApprovalNeeded |
Determines whether file transfers need to go through an approval workflow. | boolean |
No | - | - |
isChunkingEnabled |
Determines whether file must be chunked during the transfer. This is only a property of SENDER pipelines. | boolean |
No | - | - |
isFileOverrideInDestinationEnabled |
Enable file override feature in destination bucket | boolean |
No | - | - |
isScanningEnabled |
Determines whether GDP Scanning should be enabled for the pipeline. | boolean |
No | - | - |
lifecycleDetails |
Additional details about the current state of the pipeline. | string |
No | - | - |
lifecycleState |
The current state of the pipeline. | string |
No | - | - |
peeredGdpPipelineId |
OCID of the peered pipeline. | string |
No | - | - |
peeringRegion |
Public region name where the peered pipeline exists. | string |
No | - | - |
pipelineType |
Type of pipeline. Can be SENDER or RECEIVER. | string |
No | - | - |
serviceLogGroupId |
the OCID of the service log group. | string |
No | - | - |
status |
- | object |
Yes | - | - |
systemTags |
System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No | - | - |
timeCreated |
The time the the pipeline was created. An RFC3339 formatted datetime string. | string |
No | - | - |
timeUpdated |
The time the pipeline was updated. An RFC3339 formatted datetime string. | string |
No | - | - |
Status.bucketDetails[]¶
GdpPipelineBucketDetail defines nested fields for GdpPipeline.BucketDetail.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
bucketType |
Type of bucket. SENDER pipelines can be SOURCE, TRANSFER, REJECT, or FAILED. RECEIVER pipelines have a DESTINATION bucket. | string |
Yes | - | - |
id |
OCID of the bucket. | string |
Yes | - | - |
name |
Name of the bucket. | string |
Yes | - | - |
namespace |
Namespace of the bucket. | string |
Yes | - | - |
Status.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¶
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¶
| 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[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |