eligibility_search_building_details

Creates, updates, deletes, gets or lists an eligibility_search_building_details resource.

Overview

Name	eligibility_search_building_details
Type	Resource
Id	ovh.connectivity.eligibility_search_building_details

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create	insert	building		Returns, as an asynchronous task, the name, type, NRO and stairs of a building given by its identifier. Get the identifier with the search/buildings calls.

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
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})

INSERT examples

create

Returns, as an asynchronous task, the name, type, NRO and stairs of a building given by its identifier. Get the identifier with the search/buildings calls.

INSERT INTO ovh.connectivity.eligibility_search_building_details (
building,
force_provider
)
SELECT 
'{{ building }}' /* required */,
'{{ force_provider }}'
RETURNING
error,
result,
status
;

Manifest

# Description fields are for documentation purposes
- name: eligibility_search_building_details
props:
  - name: building
    value: "{{ building }}"
    description: |
      Building identifier, that can be found using /connectivity/eligibility/search/building* methods
  - name: force_provider
    value: "{{ force_provider }}"
    description: |
      If possible, force to use a particular provider repository