useroperations#

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

Delete a User Operation by id Delete a User Operation with the given id Performs DELETE /codestream/api/user-operations/{id}

Parameters:
  • p_id (string) – (required in path) The ID of the User Operation

  • 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.useroperations.get_all_user_operations_using_get(hub, ctx, **kwargs)[source]#

Get all User operations Get all User operations with specified paging and filter parameters. Performs GET /codestream/api/user-operations

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

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

  • skip (string) – (optional in query) To skip ‘n’ User Operations for listing

  • top (string) – (optional in query) To list top ‘n’ User Operations 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.useroperations.get_user_operation_by_id_using_get(hub, ctx, p_id, **kwargs)[source]#

Get a User Operation Get a User Operation with the given id Performs GET /codestream/api/user-operations/{id}

Parameters:
  • p_id (string) – (required in path) The ID of the User Operation

  • 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.useroperations.modify_patch_user_operation_using_patch(hub, ctx, p_id, **kwargs)[source]#

Modify a User Operation Modify a User Operation with the given id Performs PATCH /codestream/api/user-operations/{id}

Parameters:
  • p_id (string) – (required in path) The ID of the User Operation

  • 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

  • cancelPreviousPendingUserOp (boolean) – (optional in body) This property tells whether to cancel previous pending user operations for this pipeline.

  • responseMessage (string) – (optional in body) The response message which the responder would like to give.

  • status (string) – (optional in body) The status of this entity.

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

Modify a User Operation Modify a User Operation with the given id Performs POST /codestream/api/user-operations/{id}

Parameters:
  • p_id (string) – (required in path) The ID of the User Operation

  • 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

  • cancelPreviousPendingUserOp (boolean) – (optional in body) This property tells whether to cancel previous pending user operations for this pipeline.

  • responseMessage (string) – (optional in body) The response message which the responder would like to give.

  • status (string) – (optional in body) The status of this entity.