gitwebhooks#

async idem_vra.states.vra.pipeline.gitwebhooks.present(hub, ctx, name: str, **kwargs)[source]#
Parameters:
  • name (string) – (required in body) A human-friendly name used as an identifier in APIs that support this option

  • 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

  • branchName (string) – (optional in body) Branch name for which the webhook has been configured.

  • delayTimeInMins (integer) – (optional in body) Delay time after which the pipeline execution is triggered.

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

  • endpoint (string) – (optional in body) Git endpoint.

  • eventCategory (string) – (optional in body) Git event type.

  • exclusions (array) – (optional in body) Provide file exclusions as conditions for the trigger.

  • externalListenerLink (string) – (optional in body) Git webhook listener link.

  • inclusions (array) – (optional in body) Provide file inclusions as conditions for the trigger.

  • input (object) – (optional in body) Pipeline Execution input properties.

  • insecureSsl (boolean) – (optional in body) verify SSL certificates when delivering payloads

  • pipeline (string) – (optional in body) Pipeline name which is meant to be triggered when a git event occur.

  • prioritizeExclusion (boolean) – (optional in body) Prioritize Exclusion ensures that pipelines are not triggered even if any ” + “of the files in a commit match the specified files in the exclusion paths or regex.

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

  • refreshToken (string) – (optional in body) Codestream API token.

  • repoName (string) – (optional in body) Repo name for which the webhook has been configured.

  • secretToken (string) – (optional in body) Secret token to validate received payloads.

  • serverType (string) – (optional in body) Git Server Type.

  • serverWebhookId (string) – (optional in body) Git webhook id.

async idem_vra.states.vra.pipeline.gitwebhooks.absent(hub, ctx, name: str, **kwargs)[source]#
Parameters:
  • p_id (string) – (required in path) id

  • 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.gitwebhooks.describe(hub, ctx)[source]#
idem_vra.states.vra.pipeline.gitwebhooks.is_pending(hub, ret: dict, state: str = None, **pending_kwargs)[source]#
class idem_vra.states.vra.pipeline.gitwebhooks.GitwebhooksState(hub, ctx)[source]#

Bases: object

async present(hub, ctx, name: str, **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.gitwebhooks.GitwebhooksStateImpl(hub, ctx)[source]#

Bases: GitwebhooksState

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