ayx_python_sdk.providers.amp_provider.grpc_helpers package

Submodules

ayx_python_sdk.providers.amp_provider.grpc_helpers.control_msgs module

Helper functions to create record transfer message types.

ayx_python_sdk.providers.amp_provider.grpc_helpers.control_msgs.ctrl_out_wrapper(which_payload: str, set_id: bool = False) Callable[source]

Wrap a payload, returned by the decorated function, in a ControlOut message.

ayx_python_sdk.providers.amp_provider.grpc_helpers.control_msgs.new_control_out_msg(control_values: dict, oneof_key: str) sdk_tool_service_v2_pb2.ControlOut[source]

Create a ControlOut msg from passed values and payload key.

ayx_python_sdk.providers.amp_provider.grpc_helpers.control_msgs.new_ctrl_out_decrypt_msg(pw: str) sdk_tool_service_v2_pb2.ControlOut[source]

Create ControlOut.decrypt_password.

ayx_python_sdk.providers.amp_provider.grpc_helpers.control_msgs.new_ctrl_out_error_msg(err_msg: str) sdk_tool_service_v2_pb2.ControlOut[source]

Create a message with the Error type flag.

ayx_python_sdk.providers.amp_provider.grpc_helpers.control_msgs.new_ctrl_out_info_msg(info_msg: str) sdk_tool_service_v2_pb2.ControlOut[source]

Create a message with the Info type flag.

ayx_python_sdk.providers.amp_provider.grpc_helpers.control_msgs.new_ctrl_out_metadata_msg(anchor_name: str, metadata: Schema) sdk_tool_service_v2_pb2.ControlOut[source]

Create ControlOut.outgoing_metadata_push.

ayx_python_sdk.providers.amp_provider.grpc_helpers.control_msgs.new_ctrl_out_save_config(tool_config: str) sdk_tool_service_v2_pb2.ControlOut[source]

Create a message with the Warn type flag.

ayx_python_sdk.providers.amp_provider.grpc_helpers.control_msgs.new_ctrl_out_translate_msg(msg: str, *args) sdk_tool_service_v2_pb2.ControlOut[source]

Create a ControlOut.translate_message.

ayx_python_sdk.providers.amp_provider.grpc_helpers.control_msgs.new_ctrl_out_warn_msg(warn_msg: str) sdk_tool_service_v2_pb2.ControlOut[source]

Create a message with the Warn type flag.

ayx_python_sdk.providers.amp_provider.grpc_helpers.dcme_msgs module

AMP Provider: Proxy class for DCM API.

ayx_python_sdk.providers.amp_provider.grpc_helpers.dcme_msgs.free_write_lock_msg(connection_id: str, role: str, secret_type: str, lock_id: str) dcm_e_pb2.DcmERequest[source]

Create a UnlockSecret message.

ayx_python_sdk.providers.amp_provider.grpc_helpers.dcme_msgs.get_connection_msg(connection_id: str) dcm_e_pb2.DcmERequest[source]

Create a connection request message.

ayx_python_sdk.providers.amp_provider.grpc_helpers.dcme_msgs.get_write_lock_msg(connection_id: str, role: str, secret_type: str, expires_in: Optional[datetime.datetime] = None) dcm_e_pb2.DcmERequest[source]

Create a LockSecret message.

ayx_python_sdk.providers.amp_provider.grpc_helpers.dcme_msgs.handle_response(res: dcm_e_pb2.DcmEResponse) Dict[source]

Handle DcmE response.

ayx_python_sdk.providers.amp_provider.grpc_helpers.dcme_msgs.update_connection_secret_msg(connection_id: str, lock_id: str, role: str, secret_type: str, value: str, expires_on: Optional[datetime.datetime], parameters: Optional[Dict[str, str]]) dcm_e_pb2.DcmERequest[source]

Create UpdateSecret message.

ayx_python_sdk.providers.amp_provider.grpc_helpers.record_transfer_msgs module

Helper functions to create record transfer message types.

ayx_python_sdk.providers.amp_provider.grpc_helpers.record_transfer_msgs.new_record_transfer_out_msg(record_values: dict, oneof_key: str) sdk_tool_service_v2_pb2.RecordTransferOut[source]

Create a RecordTransferOut msg from passed values and payload key.

Module contents

gRPC Helper Functions.