network_link_services

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

Overview

Name	network_link_services
Type	Resource
Id	confluent.networking.network_link_services

Fields

The following fields are returned by SELECT queries:

get_networking_v1_network_link_service

Network Link Service.

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. (NetworkLinkService)
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 Network Link Service
status	object	The status of the Network Link Service

list_networking_v1_network_link_services

Network Link Service.

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. (NetworkLinkService)
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 Network Link Service
status	object	The status of the Network Link Service

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_networking_v1_network_link_service	select	environment, id		Make a request to read a network link service.
list_networking_v1_network_link_services	select	environment	spec.display_name, status.phase, spec.network, page_size, page_token	Retrieve a sorted, filtered, paginated list of all network link services.
create_networking_v1_network_link_service	insert	spec		Make a request to create a network link service.
update_networking_v1_network_link_service	update	id, spec		Make a request to update a network link service.
delete_networking_v1_network_link_service	delete	environment, id		Make a request to delete a network link service.

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 network link service.
page_size	integer	A pagination size for collection requests.
page_token	string	An opaque pagination token for collection requests.
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-net-1-nls, dev-net-1-nls])
spec.network	array	Filter the results by exact match for spec.network. Pass multiple times to see results matching any of the values. (example: [n-00000, n-00001])
status.phase	array	Filter the results by exact match for status.phase. Pass multiple times to see results matching any of the values. (example: [READY])

SELECT examples

get_networking_v1_network_link_service

Make a request to read a network link service.

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

list_networking_v1_network_link_services

Retrieve a sorted, filtered, paginated list of all network link services.

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

INSERT examples

create_networking_v1_network_link_service

Make a request to create a network link service.

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

Manifest

# Description fields are for documentation purposes
- name: network_link_services
props:
  - name: spec
    description: |
      The desired state of the Network Link Service
    value:
      display_name: "{{ display_name }}"
      description: "{{ description }}"
      accept:
        environments:
          - "{{ environments }}"
        networks:
          - "{{ networks }}"
      environment:
        id: "{{ id }}"
        related: "{{ related }}"
        resource_name: "{{ resource_name }}"
      network:
        id: "{{ id }}"
        environment: "{{ environment }}"
        related: "{{ related }}"
        resource_name: "{{ resource_name }}"

UPDATE examples

update_networking_v1_network_link_service

Make a request to update a network link service.

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

DELETE examples

delete_networking_v1_network_link_service

Make a request to delete a network link service.

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