endpoints#

async idem_vra.states.vra.pipeline.endpoints.present(hub, ctx, name: str, properties: Any, type: Any, **kwargs)[source]#
Parameters:

  • name (string) – (required in body) A human-friendly name used as an identifier in APIs that support this option

  • properties (object) – (required in body) Endpoint specific properties

  • type (string) – (required in body) The type of this Endpoint instance.

  • apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

  • Authorization (string) – (optional in header) Bearer token

  • description (string) – (optional in body) A human-friendly description.

  • isRestricted (boolean) – (optional in body) This type of Endpoint can be created, updated or deleted by admin only. If a restricted Endpoint is consumed in a pipeline, and that pipeline is executed by a non-admin user, then the execution will fail at the task which is consuming this restricted Endpoint. Only admin can then resume this pipeline to make it progress.

  • project (string) – (optional in body) The project this entity belongs to.

async idem_vra.states.vra.pipeline.endpoints.absent(hub, ctx, name: str, **kwargs)[source]#
Parameters:

  • p_id (string) – (required in path) The ID of the Endpoint

  • apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

  • Authorization (string) – (optional in header) Bearer token

async idem_vra.states.vra.pipeline.endpoints.describe(hub, ctx)[source]#
idem_vra.states.vra.pipeline.endpoints.is_pending(hub, ret: dict, state: str = None, **pending_kwargs)[source]#
class idem_vra.states.vra.pipeline.endpoints.EndpointsState(hub, ctx)[source]#

Bases: object

async present(hub, ctx, name: str, properties: Any, type: Any, **kwargs)[source]#
async absent(hub, ctx, name: str, **kwargs)[source]#
async describe(hub, ctx)[source]#
async paginate_find(hub, ctx, **kwargs)[source]#

Paginate through all resources using their ‘find’ method.

is_pending(hub, ret: dict, state: str = None, **pending_kwargs)[source]#

State reconciliation

async remap_resource_structure(hub, ctx, obj: dict) → dict[source]#
class idem_vra.states.vra.pipeline.endpoints.EndpointsStateImpl(hub, ctx)[source]#

Bases: EndpointsState

async present(hub, ctx, name: str, properties: Any, type: Any, **kwargs)[source]#
async absent(hub, ctx, name: str, **kwargs)[source]#
async describe(hub, ctx)[source]#