data_lake_object.h File Reference

Data lake object module header file. More...

#include "mcl_data_lake/mcl_data_lake_object.h"

Include dependency graph for data_lake_object.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	data_lake_object_t

Enumerations
enum	E_DATA_LAKE_OBJECT_INTERNAL_PARAMETER { DATA_LAKE_OBJECT_INTERNAL_PARAMETER_SIGNED_URL = MCL_DATA_LAKE_OBJECT_PARAMETER_END, DATA_LAKE_OBJECT_INTERNAL_PARAMETER_END }

Functions
MCL_LOCAL mcl_error_t	data_lake_object_set_internal_parameter (mcl_data_lake_object_t *object, E_DATA_LAKE_OBJECT_INTERNAL_PARAMETER parameter, const void *value)
MCL_LOCAL mcl_error_t	data_lake_object_validate (data_lake_object_t *object)

Detailed Description

Data lake object module header file.

Copyright

Copyright (C) 2019 Siemens Aktiengesellschaft.
All rights reserved.

Definition in file data_lake_object.h.

Enumeration Type Documentation

enum E_DATA_LAKE_OBJECT_INTERNAL_PARAMETER

Internal parameters for data lake object.

Enumerator
DATA_LAKE_OBJECT_INTERNAL_PARAMETER_SIGNED_URL	Signed url parameter as char *.
DATA_LAKE_OBJECT_INTERNAL_PARAMETER_END

Definition at line 29 of file data_lake_object.h.

Function Documentation

MCL_LOCAL mcl_error_t data_lake_object_set_internal_parameter	(	mcl_data_lake_object_t *	object,
		E_DATA_LAKE_OBJECT_INTERNAL_PARAMETER	parameter,
		const void *	value
	)

This function is used to set an internal parameter of a data lake object.

Parameters

[in]	object	Data lake object to set its parameter.
[in]	parameter	One of the parameters listed in E_DATA_LAKE_OBJECT_INTERNAL_PARAMETER.
[in]	value	New value of the parameter.

Returns

• MCL_OK in case of success.
• MCL_OUT_OF_MEMORY in case there is not enough memory in the system to proceed.
• MCL_INVALID_PARAMETER if provided parameter is invalid.

Definition at line 82 of file data_lake_object.c.

References DATA_LAKE_OBJECT_INTERNAL_PARAMETER_SIGNED_URL, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_INVALID_PARAMETER, MCL_OK, and mcl_string_util_reset().

Here is the call graph for this function:

MCL_LOCAL mcl_error_t data_lake_object_validate

(

data_lake_object_t *

object

)

This function checks whether all mandatory parameters of a data lake object are set or not.

Parameters

[in]

object

Data lake object to validate.

Returns

• MCL_OK in case of success.
• MCL_INVALID_PARAMETER in case data lake object has one or more missing mandatory parameters.

Definition at line 116 of file data_lake_object.c.

References MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_ERROR_STRING, MCL_INVALID_PARAMETER, MCL_NULL, MCL_OK, data_lake_object_t::path, data_lake_object_t::signed_url, data_lake_object_t::size, and data_lake_object_t::upload_callback.

Referenced by data_lake_processor_upload().

Here is the caller graph for this function: