triggers#

async idem_vra.exec.vra.pipeline.triggers.clone_gerrit_listener_by_name_using_post(hub, ctx, p_name, p_project, **kwargs)[source]#

Clone a Gerrit Listener by project and name Clone a Gerrit Listener with the given project and name Performs POST /codestream/api/gerrit-listeners/{project}/{name}

Parameters:
  • p_name (string) – (required in path) The name of the Gerrit Listener

  • p_project (string) – (required in path) The project the Gerrit Listener belongs to

  • 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) Description for the cloned entity.

  • name (string) – (optional in body) Name field for the cloned entity.

  • requestType (string) – (optional in body) Action to be performed on the service.

async idem_vra.exec.vra.pipeline.triggers.clone_gerrit_listener_using_post(hub, ctx, p_id, **kwargs)[source]#

Clone a Gerrit Listener Clone a Gerrit Listener Performs POST /codestream/api/gerrit-listeners/{id}

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

  • description (string) – (optional in body) Description for the cloned entity.

  • name (string) – (optional in body) Name field for the cloned entity.

  • requestType (string) – (optional in body) Action to be performed on the service.

async idem_vra.exec.vra.pipeline.triggers.clone_gerrit_trigger_by_name_using_post(hub, ctx, p_name, p_project, **kwargs)[source]#

Clone a Gerrit Trigger by project and name Clone a Gerrit Trigger with the given project and name Performs POST /codestream/api/gerrit-triggers/{project}/{name}

Parameters:
  • p_name (string) – (required in path) The name of the Gerrit Trigger

  • p_project (string) – (required in path) The project the Gerrit Trigger belongs to

  • 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) Description for the cloned entity.

  • name (string) – (optional in body) Name field for the cloned entity.

  • requestType (string) – (optional in body) Action to be performed on the service.

async idem_vra.exec.vra.pipeline.triggers.clone_gerrit_trigger_using_post(hub, ctx, p_id, **kwargs)[source]#

Clone a Gerrit Trigger Clone a Gerrit Trigger Performs POST /codestream/api/gerrit-triggers/{id}

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

  • description (string) – (optional in body) Description for the cloned entity.

  • name (string) – (optional in body) Name field for the cloned entity.

  • requestType (string) – (optional in body) Action to be performed on the service.

async idem_vra.exec.vra.pipeline.triggers.create_docker_registry_webhook_using_post(hub, ctx, name, **kwargs)[source]#

Create a Docker Registry Webhook Create a Docker Registry Webhook Performs POST /codestream/api/registry-webhooks

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

  • description (string) – (optional in body) Docker webhook description.

  • enabled (boolean) – (optional in body) Indicates whether Docker webhook is enabled or not.

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

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

  • imageNameRegExPattern (string) – (optional in body) If provided then the pipeline execution is triggered only when the given image name regex matches the image name in the received payload.

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

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

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

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

  • repoName (string) – (optional in body) Docker Repo Name.

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

  • serverType (string) – (optional in body) Docker server type.

  • slug (string) – (optional in body) Docker webhook name.

  • tagNamePattern (string) – (optional in body) If provided then the pipeline execution is triggered only when the given tag name regex matches the tag name(s) in the received payload.

async idem_vra.exec.vra.pipeline.triggers.create_gerrit_listener_using_post(hub, ctx, apiToken, description, endpoint, name, **kwargs)[source]#

Create a Gerrit Listener Create a Gerrit Listener Performs POST /codestream/api/gerrit-listeners

Parameters:
  • apiToken (string) – (required in body) This token is used to authenticate when calling VMware Cloud Services APIs. These tokens are scoped within the organization.

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

  • endpoint (string) – (required in body) The name of the Gerrit Endpoint.

  • 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

  • connected (boolean) – (optional in body) Indicates whether the connection with the Gerrit Server to start receiving events is created or not.

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

async idem_vra.exec.vra.pipeline.triggers.create_gerrit_trigger_using_post(hub, ctx, branch, description, gerritProject, listener, name, **kwargs)[source]#

Create a Gerrit Trigger Create a Gerrit Trigger Performs POST /codestream/api/gerrit-triggers

Parameters:
  • branch (string) – (required in body) Gerrit Project Branch on which the change has to be monitored.

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

  • gerritProject (string) – (required in body) Gerrit Project which is to be monitored for the change.

  • listener (string) – (required in body) Gerrit Listener which will receive the events for this trigger.

  • 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

  • configurations (array) – (optional in body) The configuration of an Gerrit Event.

  • enabled (boolean) – (optional in body) Indicates that this trigger will be addressed on receiving respective events.

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

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

  • 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.

async idem_vra.exec.vra.pipeline.triggers.create_git_webhook_using_post(hub, ctx, name, **kwargs)[source]#

Create a Git Webhook Create a Git Webhook Performs POST /codestream/api/git-webhooks

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.exec.vra.pipeline.triggers.delete_docker_registry_event_by_id_using_delete(hub, ctx, p_id, **kwargs)[source]#

Delete a Docker Registry Event Delete a Docker Registry Event Performs DELETE /codestream/api/registry-events/{id}

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.exec.vra.pipeline.triggers.delete_docker_registry_webhook_by_id_using_delete(hub, ctx, p_id, **kwargs)[source]#

Delete a Docker Registry Webhook Delete a Docker Registry Webhook Performs DELETE /codestream/api/registry-webhooks/{id}

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.exec.vra.pipeline.triggers.delete_docker_registry_webhook_by_name_using_delete(hub, ctx, p_name, p_project, **kwargs)[source]#

Delete a Docker Registry Webhook using name Delete a Docker Registry Webhook using name Performs DELETE /codestream/api/registry-webhooks/{project}/{name}

Parameters:
  • p_name (string) – (required in path) name

  • p_project (string) – (required in path) project

  • 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.exec.vra.pipeline.triggers.delete_gerrit_event_by_id_using_delete(hub, ctx, p_id, **kwargs)[source]#

Delete a Gerrit Event Delete a Gerrit Event Performs DELETE /codestream/api/gerrit-events/{id}

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.exec.vra.pipeline.triggers.delete_gerrit_listener_by_id_using_delete(hub, ctx, p_id, **kwargs)[source]#

Delete a Gerrit Listener with id Delete a Gerrit Listener with id Performs DELETE /codestream/api/gerrit-listeners/{id}

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.exec.vra.pipeline.triggers.delete_gerrit_listener_by_name_using_delete(hub, ctx, p_name, p_project, **kwargs)[source]#

Delete a Gerrit Listener with project and name Delete a Gerrit Listener with project and name Performs DELETE /codestream/api/gerrit-listeners/{project}/{name}

Parameters:
  • p_name (string) – (required in path) name

  • p_project (string) – (required in path) project

  • 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.exec.vra.pipeline.triggers.delete_gerrit_trigger_by_id_using_delete(hub, ctx, p_id, **kwargs)[source]#

Delete a Gerrit Trigger with id Delete a Gerrit Trigger with id Performs DELETE /codestream/api/gerrit-triggers/{id}

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.exec.vra.pipeline.triggers.delete_gerrit_trigger_by_name_using_delete(hub, ctx, p_name, p_project, **kwargs)[source]#

Delete a Gerrit Trigger with project and name Delete a Gerrit Trigger with project and name Performs DELETE /codestream/api/gerrit-triggers/{project}/{name}

Parameters:
  • p_name (string) – (required in path) name

  • p_project (string) – (required in path) project

  • 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.exec.vra.pipeline.triggers.delete_git_events_by_id_using_delete(hub, ctx, p_id, **kwargs)[source]#

Delete a Git Event Delete a Git Event Performs DELETE /codestream/api/git-events/{id}

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.exec.vra.pipeline.triggers.delete_git_webhook_by_id_using_delete(hub, ctx, p_id, **kwargs)[source]#

Delete a Git Webhook Delete a Git Webhook Performs DELETE /codestream/api/git-webhooks/{id}

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.exec.vra.pipeline.triggers.delete_git_webhook_by_name_using_delete(hub, ctx, p_name, p_project, **kwargs)[source]#

Delete a Git Webhook by name Delete a Git Webhook by name Performs DELETE /codestream/api/git-webhooks/{project}/{name}

Parameters:
  • p_name (string) – (required in path) name

  • p_project (string) – (required in path) project

  • 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.exec.vra.pipeline.triggers.get_all_docker_registry_events_using_get(hub, ctx, **kwargs)[source]#

Get all Docker Registry Events Get all Docker Registry Events Performs GET /codestream/api/registry-events

Parameters:
  • filter (string) – (optional in query) To list Docker Registry Events with OData like filter

  • orderby (string) – (optional in query) Order by attribute

  • skip (string) – (optional in query) To skip ‘n’ Docker Registry Events for listing

  • top (string) – (optional in query) To list top ‘n’ Docker Registry Events for listing

  • page (string) – (optional in query) To select ‘n’th page for listing

  • 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.exec.vra.pipeline.triggers.get_all_docker_registry_webhooks_using_get(hub, ctx, **kwargs)[source]#

Get all Docker Registry Webhooks Get all Docker Registry Webhooks Performs GET /codestream/api/registry-webhooks

Parameters:
  • filter (string) – (optional in query) To list Docker Registry Webhooks with OData like filter

  • orderby (string) – (optional in query) Order by attribute

  • skip (string) – (optional in query) To skip ‘n’ Docker Registry Webhooks for listing

  • top (string) – (optional in query) To list top ‘n’ Docker Registry Webhooks for listing

  • page (string) – (optional in query) To select ‘n’th page for listing

  • 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.exec.vra.pipeline.triggers.get_all_gerrit_events_using_get(hub, ctx, **kwargs)[source]#

Get all Gerrit Events Get all Gerrit Events Performs GET /codestream/api/gerrit-events

Parameters:
  • filter (string) – (optional in query) To list gerrit events with OData like filter

  • orderby (string) – (optional in query) Order by attribute

  • skip (string) – (optional in query) To skip ‘n’ gerrit events for listing

  • top (string) – (optional in query) To list top ‘n’ gerrit events for listing

  • page (string) – (optional in query) To select ‘n’th page for listing

  • 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.exec.vra.pipeline.triggers.get_all_gerrit_listeners_using_get(hub, ctx, **kwargs)[source]#

Get all gerrit listeners Get all gerrit listeners Performs GET /codestream/api/gerrit-listeners

Parameters:
  • filter (string) – (optional in query) To list gerrit listeners with OData like filter

  • orderby (string) – (optional in query) Order by attribute

  • skip (string) – (optional in query) To skip ‘n’ gerrit listeners for listing

  • top (string) – (optional in query) To list top ‘n’ gerrit listeners for listing

  • page (string) – (optional in query) To select ‘n’th page for listing

  • 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.exec.vra.pipeline.triggers.get_all_gerrit_triggers_using_get(hub, ctx, **kwargs)[source]#

Get all gerrit triggers Get all gerrit triggers Performs GET /codestream/api/gerrit-triggers

Parameters:
  • filter (string) – (optional in query) To list gerrit triggers with OData like filter

  • orderby (string) – (optional in query) Order by attribute

  • skip (string) – (optional in query) To skip ‘n’ gerrit triggers for listing

  • top (string) – (optional in query) To list top ‘n’ gerrit triggers for listing

  • page (string) – (optional in query) To select ‘n’th page for listing

  • 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.exec.vra.pipeline.triggers.get_all_git_events_using_get(hub, ctx, **kwargs)[source]#

Get all Git Events Get all Git Events Performs GET /codestream/api/git-events

Parameters:
  • filter (string) – (optional in query) To list Git Events with OData like filter

  • orderby (string) – (optional in query) Order by attribute

  • skip (string) – (optional in query) To skip ‘n’ Git Events for listing

  • top (string) – (optional in query) To list top ‘n’ Git Events for listing

  • page (string) – (optional in query) To select ‘n’th page for listing

  • 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.exec.vra.pipeline.triggers.get_all_git_webhooks_using_get(hub, ctx, **kwargs)[source]#

Get all Git Webhooks Get all Git Webhooks Performs GET /codestream/api/git-webhooks

Parameters:
  • filter (string) – (optional in query) To list Git Webhooks with OData like filter

  • orderby (string) – (optional in query) Order by attribute

  • skip (string) – (optional in query) To skip ‘n’ Git Webhooks for listing

  • top (string) – (optional in query) To list top ‘n’ Git Webhooks for listing

  • page (string) – (optional in query) To select ‘n’th page for listing

  • 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.exec.vra.pipeline.triggers.get_docker_registry_event_by_id_using_get(hub, ctx, p_id, **kwargs)[source]#

Get a Docker Registry Event Get a Docker Registry Event based on id Performs GET /codestream/api/registry-events/{id}

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.exec.vra.pipeline.triggers.get_docker_registry_webhook_by_id_using_get(hub, ctx, p_id, **kwargs)[source]#

Get a Docker Registry Webhook Get a Docker Registry Webhook based on id Performs GET /codestream/api/registry-webhooks/{id}

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.exec.vra.pipeline.triggers.get_docker_registry_webhook_name_using_get(hub, ctx, p_name, p_project, **kwargs)[source]#

Get a Docker Registry Webhook by name Get a Docker Registry Webhook by Name Performs GET /codestream/api/registry-webhooks/{project}/{name}

Parameters:
  • p_name (string) – (required in path) name

  • p_project (string) – (required in path) project

  • 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.exec.vra.pipeline.triggers.get_gerrit_event_by_id_using_get(hub, ctx, p_id, **kwargs)[source]#

Get a gerrit Event Get a gerrit Event based on id Performs GET /codestream/api/gerrit-events/{id}

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.exec.vra.pipeline.triggers.get_gerrit_listener_by_id_using_get(hub, ctx, p_id, **kwargs)[source]#

Get a gerrit listener Get a gerrit listeners based on id Performs GET /codestream/api/gerrit-listeners/{id}

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.exec.vra.pipeline.triggers.get_gerrit_listener_by_name_using_get(hub, ctx, p_name, p_project, **kwargs)[source]#

Get a gerrit listener by project and name Get a gerrit listener based on project and name Performs GET /codestream/api/gerrit-listeners/{project}/{name}

Parameters:
  • p_name (string) – (required in path) name

  • p_project (string) – (required in path) project

  • 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.exec.vra.pipeline.triggers.get_gerrit_projects_by_id_using_get(hub, ctx, p_id, **kwargs)[source]#

Get Gerrit Projects from the Gerrit Listener using id Get Gerrit Projects from the Gerrit Listener using id Performs GET /codestream/api/gerrit-listeners/{id}/projects

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.exec.vra.pipeline.triggers.get_gerrit_projects_by_name_using_get(hub, ctx, p_name, p_project, **kwargs)[source]#

Get Gerrit Projects from the Gerrit Listener using project and name Get Gerrit Projects from the Gerrit Listener using project and name Performs GET /codestream/api/gerrit-listeners/{project}/{name}/projects

Parameters:
  • p_name (string) – (required in path) name

  • p_project (string) – (required in path) project

  • 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.exec.vra.pipeline.triggers.get_gerrit_trigger_by_id_using_get(hub, ctx, p_id, **kwargs)[source]#

Get a gerrit trigger Get a gerrit trigger based on id Performs GET /codestream/api/gerrit-triggers/{id}

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.exec.vra.pipeline.triggers.get_gerrit_trigger_by_name_using_get(hub, ctx, p_name, p_project, **kwargs)[source]#

Get a gerrit trigger by project and name Get a gerrit trigger based on project and name Performs GET /codestream/api/gerrit-triggers/{project}/{name}

Parameters:
  • p_name (string) – (required in path) name

  • p_project (string) – (required in path) project

  • 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.exec.vra.pipeline.triggers.get_git_event_by_id_using_get(hub, ctx, p_id, **kwargs)[source]#

Get a Git Event Get a Git Event based on id Performs GET /codestream/api/git-events/{id}

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.exec.vra.pipeline.triggers.get_git_webhook_by_id_using_get(hub, ctx, p_id, **kwargs)[source]#

Get a Git Webhook Get a Git Webhook based on id Performs GET /codestream/api/git-webhooks/{id}

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.exec.vra.pipeline.triggers.get_git_webhook_by_name_using_get(hub, ctx, p_name, p_project, **kwargs)[source]#

Get a Git Webhook by name Get a Git Webhook by Name Performs GET /codestream/api/git-webhooks/{project}/{name}

Parameters:
  • p_name (string) – (required in path) name

  • p_project (string) – (required in path) project

  • 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.exec.vra.pipeline.triggers.manual_gerrit_event_trigger_using_post(hub, ctx, changeId, project, trigger, **kwargs)[source]#

Manual trigger Gerrit event Manual trigger Gerrit event Performs POST /codestream/api/gerrit-events

Parameters:
  • changeId (string) – (required in body) The ChangeSet Id corresponding to which the manual trigger has to be performed.

  • project (string) – (required in body) The tango project to which Gerrit Trigger belongs to.

  • trigger (string) – (required in body) Name of the Gerrit Trigger for which event has to be analysed.

  • 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.exec.vra.pipeline.triggers.patch_docker_registry_webhook_by_id_using_patch(hub, ctx, p_id, **kwargs)[source]#

Patch a Docker Registry Webhook with id Patch a Docker Registry Webhook with id Performs PATCH /codestream/api/registry-webhooks/{id}

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

  • enabled (boolean) – (optional in body) Indicates whether Git/Docker webhook is enabled or not.

async idem_vra.exec.vra.pipeline.triggers.patch_docker_registry_webhook_by_name_using_patch(hub, ctx, p_name, p_project, **kwargs)[source]#

Patch a Docker Registry Webhook with project and name Patch a Docker Registry Webhook with project and name Performs PATCH /codestream/api/registry-webhooks/{project}/{name}

Parameters:
  • p_name (string) – (required in path) name

  • p_project (string) – (required in path) project

  • 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

  • enabled (boolean) – (optional in body) Indicates whether Git/Docker webhook is enabled or not.

async idem_vra.exec.vra.pipeline.triggers.patch_gerrit_listener_by_id_using_patch(hub, ctx, p_id, connected, **kwargs)[source]#

Patch a Gerrit Listener with id Patch a Gerrit Listener with id Performs PATCH /codestream/api/gerrit-listeners/{id}

Parameters:
  • p_id (string) – (required in path) id

  • connected (boolean) – (required in body) Connect/Disconnect a Gerrit Listener.

  • 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.exec.vra.pipeline.triggers.patch_gerrit_listener_by_name_using_patch(hub, ctx, p_name, p_project, connected, **kwargs)[source]#

Patch a Gerrit Listener with project and name Patch a Gerrit Listener with project and name Performs PATCH /codestream/api/gerrit-listeners/{project}/{name}

Parameters:
  • p_name (string) – (required in path) name

  • p_project (string) – (required in path) project

  • connected (boolean) – (required in body) Connect/Disconnect a Gerrit Listener.

  • 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.exec.vra.pipeline.triggers.patch_gerrit_trigger_by_id_using_patch(hub, ctx, p_id, enabled, **kwargs)[source]#

Patch a Gerrit Trigger with id Patch a Gerrit Trigger with id Performs PATCH /codestream/api/gerrit-triggers/{id}

Parameters:
  • p_id (string) – (required in path) id

  • enabled (boolean) – (required in body) Enable/Disable a Gerrit Trigger.

  • 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.exec.vra.pipeline.triggers.patch_gerrit_trigger_by_name_using_patch(hub, ctx, p_name, p_project, enabled, **kwargs)[source]#

Patch a Gerrit Trigger with project and name Patch a Gerrit Trigger with project and name Performs PATCH /codestream/api/gerrit-triggers/{project}/{name}

Parameters:
  • p_name (string) – (required in path) name

  • p_project (string) – (required in path) project

  • enabled (boolean) – (required in body) Enable/Disable a Gerrit Trigger.

  • 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.exec.vra.pipeline.triggers.resume_or_rerun_docker_registry_event_using_post(hub, ctx, q_action, p_id, **kwargs)[source]#

Re-run/Resume Docker Registry Event Re-run/Resume Docker Registry Event Performs POST /codestream/api/registry-events/{id}

Parameters:
  • q_action (string) – (required in query) Resume/Rerun

  • 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.exec.vra.pipeline.triggers.resume_or_rerun_gerrit_event_using_post(hub, ctx, q_action, p_id, **kwargs)[source]#

Re-run/Resume Gerrit event Re-run/Resume Gerrit event Performs POST /codestream/api/gerrit-events/{id}

Parameters:
  • q_action (string) – (required in query) Resume/Rerun

  • 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.exec.vra.pipeline.triggers.resume_or_rerun_git_event_using_post(hub, ctx, q_action, p_id, **kwargs)[source]#

Re-run/Resume Git Event Re-run/Resume Git Event Performs POST /codestream/api/git-events/{id}

Parameters:
  • q_action (string) – (required in query) Resume/Rerun

  • 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.exec.vra.pipeline.triggers.update_docker_registry_webhook_by_id_using_put(hub, ctx, p_id, name, **kwargs)[source]#

Update a Docker Registry Webhook Update a Docker Registry Webhook Performs PUT /codestream/api/registry-webhooks/{id}

Parameters:
  • p_id (string) – (required in path) id

  • 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

  • description (string) – (optional in body) Docker webhook description.

  • enabled (boolean) – (optional in body) Indicates whether Docker webhook is enabled or not.

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

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

  • imageNameRegExPattern (string) – (optional in body) If provided then the pipeline execution is triggered only when the given image name regex matches the image name in the received payload.

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

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

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

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

  • repoName (string) – (optional in body) Docker Repo Name.

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

  • serverType (string) – (optional in body) Docker server type.

  • slug (string) – (optional in body) Docker webhook name.

  • tagNamePattern (string) – (optional in body) If provided then the pipeline execution is triggered only when the given tag name regex matches the tag name(s) in the received payload.

async idem_vra.exec.vra.pipeline.triggers.update_docker_registry_webhook_by_name_using_put(hub, ctx, p_name, p_project, name, **kwargs)[source]#

Update a Docker Registry Webhook using name Update a Docker Registry Webhook using name Performs PUT /codestream/api/registry-webhooks/{project}/{name}

Parameters:
  • p_name (string) – (required in path) name

  • p_project (string) – (required in path) project

  • 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

  • description (string) – (optional in body) Docker webhook description.

  • enabled (boolean) – (optional in body) Indicates whether Docker webhook is enabled or not.

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

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

  • imageNameRegExPattern (string) – (optional in body) If provided then the pipeline execution is triggered only when the given image name regex matches the image name in the received payload.

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

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

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

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

  • repoName (string) – (optional in body) Docker Repo Name.

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

  • serverType (string) – (optional in body) Docker server type.

  • slug (string) – (optional in body) Docker webhook name.

  • tagNamePattern (string) – (optional in body) If provided then the pipeline execution is triggered only when the given tag name regex matches the tag name(s) in the received payload.

async idem_vra.exec.vra.pipeline.triggers.update_gerrit_listener_by_id_using_put(hub, ctx, p_id, apiToken, description, endpoint, name, **kwargs)[source]#

Update a Gerrit Listener with id Update a Gerrit Listener with id Performs PUT /codestream/api/gerrit-listeners/{id}

Parameters:
  • p_id (string) – (required in path) id

  • apiToken (string) – (required in body) This token is used to authenticate when calling VMware Cloud Services APIs. These tokens are scoped within the organization.

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

  • endpoint (string) – (required in body) The name of the Gerrit Endpoint.

  • 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

  • connected (boolean) – (optional in body) Indicates whether the connection with the Gerrit Server to start receiving events is created or not.

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

async idem_vra.exec.vra.pipeline.triggers.update_gerrit_listener_by_name_using_put(hub, ctx, p_name, p_project, apiToken, description, endpoint, name, **kwargs)[source]#

Update a Gerrit Listener with project and name Update a Gerrit Listener with project and name Performs PUT /codestream/api/gerrit-listeners/{project}/{name}

Parameters:
  • p_name (string) – (required in path) name

  • p_project (string) – (required in path) project

  • apiToken (string) – (required in body) This token is used to authenticate when calling VMware Cloud Services APIs. These tokens are scoped within the organization.

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

  • endpoint (string) – (required in body) The name of the Gerrit Endpoint.

  • 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

  • connected (boolean) – (optional in body) Indicates whether the connection with the Gerrit Server to start receiving events is created or not.

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

async idem_vra.exec.vra.pipeline.triggers.update_gerrit_trigger_by_id_using_put(hub, ctx, p_id, branch, description, gerritProject, listener, name, **kwargs)[source]#

Update a Gerrit Trigger with id Update a Gerrit Trigger with id Performs PUT /codestream/api/gerrit-triggers/{id}

Parameters:
  • p_id (string) – (required in path) id

  • branch (string) – (required in body) Gerrit Project Branch on which the change has to be monitored.

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

  • gerritProject (string) – (required in body) Gerrit Project which is to be monitored for the change.

  • listener (string) – (required in body) Gerrit Listener which will receive the events for this trigger.

  • 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

  • configurations (array) – (optional in body) The configuration of an Gerrit Event.

  • enabled (boolean) – (optional in body) Indicates that this trigger will be addressed on receiving respective events.

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

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

  • 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.

async idem_vra.exec.vra.pipeline.triggers.update_gerrit_trigger_by_name_using_put(hub, ctx, p_name, p_project, branch, description, gerritProject, listener, name, **kwargs)[source]#

Update a Gerrit Trigger with project and name Update a Gerrit Trigger with project and name Performs PUT /codestream/api/gerrit-triggers/{project}/{name}

Parameters:
  • p_name (string) – (required in path) name

  • p_project (string) – (required in path) project

  • branch (string) – (required in body) Gerrit Project Branch on which the change has to be monitored.

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

  • gerritProject (string) – (required in body) Gerrit Project which is to be monitored for the change.

  • listener (string) – (required in body) Gerrit Listener which will receive the events for this trigger.

  • 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

  • configurations (array) – (optional in body) The configuration of an Gerrit Event.

  • enabled (boolean) – (optional in body) Indicates that this trigger will be addressed on receiving respective events.

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

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

  • 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.

async idem_vra.exec.vra.pipeline.triggers.update_git_webhook_by_id_using_put(hub, ctx, p_id, name, **kwargs)[source]#

Update a Git Webhook Update a Git Webhook Performs PUT /codestream/api/git-webhooks/{id}

Parameters:
  • p_id (string) – (required in path) id

  • 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.exec.vra.pipeline.triggers.update_git_webhook_by_name_using_put(hub, ctx, p_name, p_project, name, **kwargs)[source]#

Update a Git Webhook using name Update a Git Webhook using name Performs PUT /codestream/api/git-webhooks/{project}/{name}

Parameters:
  • p_name (string) – (required in path) name

  • p_project (string) – (required in path) project

  • 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.exec.vra.pipeline.triggers.validate_gerrit_listener_using_post(hub, ctx, apiToken, description, endpoint, name, **kwargs)[source]#

Validate a Gerrit Listener Validate a Gerrit Listener Performs POST /codestream/api/gerrit-listeners/validate

Parameters:
  • apiToken (string) – (required in body) This token is used to authenticate when calling VMware Cloud Services APIs. These tokens are scoped within the organization.

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

  • endpoint (string) – (required in body) The name of the Gerrit Endpoint.

  • 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

  • connected (boolean) – (optional in body) Indicates whether the connection with the Gerrit Server to start receiving events is created or not.

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