Recombee API Client
Public Member Functions | Properties | List of all members
Recombee.ApiClient.ApiRequests.SetValues Class Reference

Set/update (some) property values of an entity More...

Inheritance diagram for Recombee.ApiClient.ApiRequests.SetValues:
Inheritance graph
[legend]
Collaboration diagram for Recombee.ApiClient.ApiRequests.SetValues:
Collaboration graph
[legend]

Public Member Functions

 SetValues (Dictionary< string, object > values, bool? cascadeCreate=null)
 Construct the request More...
 
override Dictionary< string, object > QueryParameters ()
 Get query parameters More...
 
override Dictionary< string, object > BodyParameters ()
 Get body parameters More...
 
- Public Member Functions inherited from Recombee.ApiClient.ApiRequests.Request
 Request (HttpMethod httpMethod, int timeoutMilliseconds, bool ensureHttps=false)
 Construct the request More...
 
abstract string Path ()
 
Returns
URI to the endpoint including path parameters
More...
 

Properties

bool? CascadeCreate [get]
 Sets whether the entity should be created if not present in the database. More...
 
Dictionary< string, object > Values [get]
 The values for the individual properties. More...
 
- Properties inherited from Recombee.ApiClient.ApiRequests.Request
TimeSpan Timeout [get, set]
 Timeout for the request in milliseconds More...
 
bool EnsureHttps [get]
 If true, HTTPS must be chosen over HTTP for this request More...
 
HttpMethod RequestHttpMehod [get]
 Used HTTP method More...
 

Additional Inherited Members

- Protected Member Functions inherited from Recombee.ApiClient.ApiRequests.Request
double ConvertToUnixTimestamp (DateTime date)
 
Returns
Converts DateTime to UNIX timestamp (epoch)
More...
 

Detailed Description

Set/update (some) property values of an entity

Constructor & Destructor Documentation

◆ SetValues()

Recombee.ApiClient.ApiRequests.SetValues.SetValues ( Dictionary< string, object >  values,
bool?  cascadeCreate = null 
)
inline

Construct the request

Parameters
valuesThe values for the individual properties. Key in the Dictionary is the name of the property and value is the value to be set.
cascadeCreateSets whether the entity should be created if not present in the database.

Member Function Documentation

◆ BodyParameters()

override Dictionary<string, object> Recombee.ApiClient.ApiRequests.SetValues.BodyParameters ( )
inlinevirtual

Get body parameters

Returns
Dictionary containing values of body parameters (name of parameter: value of the parameter)

Implements Recombee.ApiClient.ApiRequests.Request.

◆ QueryParameters()

override Dictionary<string, object> Recombee.ApiClient.ApiRequests.SetValues.QueryParameters ( )
inlinevirtual

Get query parameters

Returns
Dictionary containing values of query parameters (name of parameter: value of the parameter)

Implements Recombee.ApiClient.ApiRequests.Request.

Property Documentation

◆ CascadeCreate

bool? Recombee.ApiClient.ApiRequests.SetValues.CascadeCreate
get

Sets whether the entity should be created if not present in the database.

◆ Values

Dictionary<string, object> Recombee.ApiClient.ApiRequests.SetValues.Values
get

The values for the individual properties.


The documentation for this class was generated from the following file: