customintegrations

async idem_vra.exec.vra.pipeline.customintegrations.create_custom_integration_using_post(hub, ctx, name, **kwargs)

Create a Custom Integration Create a Custom Integration to be consumed in pipelines as custom tasks Performs POST /codestream/api/custom-integrations

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) A human-friendly description.

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

• yaml (string) – (optional in body) YAML describing Custom integration details.

async idem_vra.exec.vra.pipeline.customintegrations.create_version_by_id_using_post(hub, ctx, p_id, **kwargs)

Create a Custom Integration version Create a Custom Integration version from the current draft Performs POST /codestream/api/custom-integrations/{id}/versions

Parameters:

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

• 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

• changeLog (string) – (optional in body) Changelog describing the changes between this and previous versions.

• description (string) – (optional in body) Description of the version.

• version (string) – (optional in body) Version of the Custom Integration.

async idem_vra.exec.vra.pipeline.customintegrations.delete_draft_by_id_using_delete(hub, ctx, p_id, q_type, **kwargs)

Delete a Custom Integration and its versions Delete a Custom Integration with the given id and all its versions Performs DELETE /codestream/api/custom-integrations/{id}

Parameters:

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

• q_type (string) – (required in query) The type of the Custom Integration

• 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.customintegrations.delete_version_by_id_using_delete(hub, ctx, p_id, p_version, **kwargs)

Delete a Custom Integration version Delete a Custom Integration version with the given id and version Performs DELETE /codestream/api/custom-integrations/{id}/versions/{version}

Parameters:

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

• p_version (string) – (required in path) The version of the Custom Integration

• 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.customintegrations.deprecate_by_id_and_version_using_post(hub, ctx, p_id, p_version, **kwargs)

Deprecate a Custom Integration version Deprecate a Custom Integration version Performs POST /codestream/api/custom-integrations/{id}/versions/{version}/deprecate

Parameters:

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

• p_version (string) – (required in path) The version of the Custom Integration

• 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.customintegrations.get_all_custom_integration_versions_by_id_using_get(hub, ctx, p_id, **kwargs)

Get all versions of a Custom Integration by id Get all versions of a Custom Integration with specified id, paging and filter

parameters Performs GET /codestream/api/custom-integrations/{id}/versions

Parameters:

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

• filter (string) – (optional in query) To list Custom Integrations with OData like filter

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

• skip (string) – (optional in query) To skip ‘n’ Custom Integrations for listing

• top (string) – (optional in query) To list top ‘n’ Custom Integrations

• 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.customintegrations.get_custom_integration_version_by_id_using_get(hub, ctx, p_id, p_version, **kwargs)

Get a Custom Integration by version Get a Custom Integration with the given id and version Performs GET /codestream/api/custom-integrations/{id}/versions/{version}

Parameters:

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

• p_version (string) – (required in path) The version of the Custom Integration

• 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.customintegrations.get_custom_integrations_using_get(hub, ctx, **kwargs)

Get all Custom Integrations Get all Custom Integrations with specified paging and filter parameters. Performs GET /codestream/api/custom-integrations

Parameters:

• filter (string) – (optional in query) To list Custom Integrations with OData like filter

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

• skip (string) – (optional in query) To skip ‘n’ Custom Integrations for listing

• top (string) – (optional in query) To list top ‘n’ Custom Integrations

• 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

• type (string) – (optional in query) type

async idem_vra.exec.vra.pipeline.customintegrations.get_draft_by_id_using_get(hub, ctx, p_id, **kwargs)

Get a Custom Integration by id Get details of a Custom Integration with the given id Performs GET /codestream/api/custom-integrations/{id}

Parameters:

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

• 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.customintegrations.release_by_id_and_version_using_post(hub, ctx, p_id, p_version, **kwargs)

Release a Custom Integration version Release a Custom Integration version to be consumable in pipelines Performs POST /codestream/api/custom-integrations/{id}/versions/{version}/release

Parameters:

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

• p_version (string) – (required in path) The version of the Custom Integration

• 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.customintegrations.restore_by_id_and_version_using_post(hub, ctx, p_id, p_version, **kwargs)

Restore a Custom Integration from a version to current draft Restore a Custom Integration from the given version to the current draft Performs POST /codestream/api/custom-integrations/{id}/versions/{version}/restore

Parameters:

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

• p_version (string) – (required in path) The version of the Custom Integration

• 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.customintegrations.toggle_latest_using_patch(hub, ctx, p_id, p_version, **kwargs)

Set/Unset a release version as ‘LATEST’. Sets a released Custom Integration version as ‘LATEST’ or unsets a version from

‘LATEST’ Performs PATCH /codestream/api/custom-integrations/{id}/versions/{version}

Parameters:

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

• p_version (string) – (required in path) The version of the Custom Integration

• 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

• setLatest (boolean) – (optional in body) Indicates if a version of CustomIntegration should be set as ‘LATEST’

async idem_vra.exec.vra.pipeline.customintegrations.update_by_id_using_put(hub, ctx, p_id, name, **kwargs)

Update a Custom Integration by id Update a Custom Integration with the given id Performs PUT /codestream/api/custom-integrations/{id}

Parameters:

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

• 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) A human-friendly description.

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

• yaml (string) – (optional in body) YAML describing Custom integration details.

async idem_vra.exec.vra.pipeline.customintegrations.withdraw_by_id_and_version_using_post(hub, ctx, p_id, p_version, **kwargs)

Withdraw a Custom Integration version Withdraw a released/deprecated Custom Integration version to make it un-

consumable in pipelines Performs POST /codestream/api/custom-integrations/{id}/versions/{version}/withdraw

Parameters:

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

• p_version (string) – (required in path) The version of the Custom Integration

• 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