gateways

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

Overview

Name	gateways
Type	Resource
Id	confluent.networking.gateways

Fields

The following fields are returned by SELECT queries:

get_networking_v1_gateway

Gateway.

Name	Datatype	Description
id	string	ID 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"). (example: dlz-f3a90de)
api_version	string	APIVersion defines the schema version of this representation of a resource. (networking/v1)
kind	string	Kind defines the object this REST resource represents. (Gateway)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
spec	object	The desired state of the Gateway
status	object	The status of the Gateway

list_networking_v1_gateways

Gateway.

Name	Datatype	Description
id	string	ID 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"). (example: dlz-f3a90de)
api_version	string	APIVersion defines the schema version of this representation of a resource. (networking/v1)
kind	string	Kind defines the object this REST resource represents. (Gateway)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
spec	object	The desired state of the Gateway
status	object	The status of the Gateway

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_networking_v1_gateway	select	environment, id		Make a request to read a gateway.
list_networking_v1_gateways	select	environment	gateway_type, id, spec.config.region, spec.display_name, status.phase, page_size, page_token	Retrieve a sorted, filtered, paginated list of all gateways.
create_networking_v1_gateway	insert	spec		Make a request to create a gateway.
update_networking_v1_gateway	update	id, spec		Make a request to update a gateway.
delete_networking_v1_gateway	delete	environment, id		Make a request to delete a gateway.

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
environment	string	Scope the operation to the given environment. (example: env-00000)
id	string	The unique identifier for the gateway.
gateway_type	array	Filter the results by exact match for gateway_type. Pass multiple times to see results matching any of the values. (example: [AwsEgressPrivateLink, AzureEgressPrivateLink])
id	array	Filter the results by exact match for id. Pass multiple times to see results matching any of the values. (example: [gw-1, gw-2])
page_size	integer	A pagination size for collection requests.
page_token	string	An opaque pagination token for collection requests.
spec.config.region	array	Filter the results by exact match for spec.config.region. Pass multiple times to see results matching any of the values. (example: [us-east-1, us-west-2])
spec.display_name	array	Filter the results by exact match for spec.display_name. Pass multiple times to see results matching any of the values. (example: [prod-gateway-ingress-use1, prod-gateway-ingress-use2])
status.phase	array	Filter the results by exact match for status.phase. Pass multiple times to see results matching any of the values. (example: [PROVISIONING, READY])

SELECT examples

get_networking_v1_gateway

Make a request to read a gateway.

SELECT
id,
api_version,
kind,
metadata,
spec,
status
FROM confluent.networking.gateways
WHERE environment = '{{ environment }}' -- required
AND id = '{{ id }}' -- required
;

list_networking_v1_gateways

Retrieve a sorted, filtered, paginated list of all gateways.

SELECT
id,
api_version,
kind,
metadata,
spec,
status
FROM confluent.networking.gateways
WHERE environment = '{{ environment }}' -- required
AND gateway_type = '{{ gateway_type }}'
AND id = '{{ id }}'
AND spec.config.region = '{{ spec.config.region }}'
AND spec.display_name = '{{ spec.display_name }}'
AND status.phase = '{{ status.phase }}'
AND page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create_networking_v1_gateway

Make a request to create a gateway.

INSERT INTO confluent.networking.gateways (
spec
)
SELECT 
'{{ spec }}' /* required */
RETURNING
id,
api_version,
kind,
metadata,
spec,
status
;

Manifest

# Description fields are for documentation purposes
- name: gateways
props:
  - name: spec
    description: |
      The desired state of the Gateway
    value:
      display_name: "{{ display_name }}"
      config:
        kind: "{{ kind }}"
        region: "{{ region }}"
        zones:
          - "{{ zones }}"
      environment:
        id: "{{ id }}"
        environment: "{{ environment }}"
        related: "{{ related }}"
        resource_name: "{{ resource_name }}"
        api_version: "{{ api_version }}"
        kind: "{{ kind }}"

UPDATE examples

update_networking_v1_gateway

Make a request to update a gateway.

UPDATE confluent.networking.gateways
SET 
spec = '{{ spec }}'
WHERE 
id = '{{ id }}' --required
AND spec = '{{ spec }}' --required
RETURNING
id,
api_version,
kind,
metadata,
spec,
status;

DELETE examples

delete_networking_v1_gateway

Make a request to delete a gateway.

DELETE FROM confluent.networking.gateways
WHERE environment = '{{ environment }}' --required
AND id = '{{ id }}' --required
;