Skip to main content

peerings

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

Overview

Namepeerings
TypeResource
Idconfluent.networking.peerings

Fields

NameDatatypeDescription
idstringID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").
_specobject
api_versionstringAPIVersion defines the schema version of this representation of a resource.
kindstringKind defines the object this REST resource represents.
metadata``ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
specobjectThe desired state of the Peering
statusobjectThe status of the Peering

Methods

NameAccessible byRequired ParamsDescription
get_networking_v1peeringSELECTenvironment, idGeneral Availability Make a request to read a peering.
list_networking_v1peeringsSELECTenvironmentGeneral Availability Retrieve a sorted, filtered, paginated list of all peerings.
create_networking_v1peeringINSERTGeneral Availability Make a request to create a peering.
delete_networking_v1peeringDELETEenvironment, idGeneral Availability Make a request to delete a peering.
update_networking_v1peeringUPDATEidGeneral Availability Make a request to update a peering.

SELECT examples

General Availability Retrieve a sorted, filtered, paginated list of all peerings.

SELECT
id,
_spec,
api_version,
kind,
metadata,
spec,
status
FROM confluent.networking.peerings
WHERE environment = '{{ environment }}';

INSERT example

Use the following StackQL query and manifest file to create a new peerings resource.

/*+ create */
INSERT INTO confluent.networking.peerings (
data__spec
)
SELECT
'{{ spec }}'
;

UPDATE example

Updates a peerings resource.

/*+ update */
UPDATE confluent.networking.peerings
SET
spec = '{{ spec }}'
WHERE
id = '{{ id }}';

DELETE example

Deletes the specified peerings resource.

/*+ delete */
DELETE FROM confluent.networking.peerings
WHERE environment = '{{ environment }}'
AND id = '{{ id }}';