Skip to content

Latest commit

 

History

History
214 lines (136 loc) · 4.4 KB

configuration.md

File metadata and controls

214 lines (136 loc) · 4.4 KB
Raw

Configuration

configuration_controller = client.configuration

Class Name

ConfigurationController

Methods

Get Configuration

Gets application configuration.

def get_configuration(self)

Response Type

ServerConfiguration

Example Usage

result = configuration_controller.get_configuration()

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException

Get Default Metadata Options

Gets a default MetadataOptions object.

def get_default_metadata_options(self)

Response Type

MetadataOptions

Example Usage

result = configuration_controller.get_default_metadata_options()

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException

Get Named Configuration

Gets a named configuration.

def get_named_configuration(self,
                           key)

Parameters

Parameter Type Tags Description
key string Template, Required Configuration key.

Response Type

binary

Example Usage

key = 'key0'

result = configuration_controller.get_named_configuration(key)

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException

Update Configuration

Updates application configuration.

def update_configuration(self,
                        body)

Parameters

Parameter Type Tags Description
body ServerConfiguration Body, Required Configuration.

Response Type

void

Example Usage

body = ServerConfiguration()

result = configuration_controller.update_configuration(body)

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException

Update Media Encoder Path

Updates the path to the media encoder.

def update_media_encoder_path(self,
                             body)

Parameters

Parameter Type Tags Description
body MediaEncoderPathDto Body, Required Media encoder path form body.

Response Type

void

Example Usage

body = MediaEncoderPathDto()

result = configuration_controller.update_media_encoder_path(body)

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException

Update Named Configuration

Updates named configuration.

def update_named_configuration(self,
                              key,
                              body)

Parameters

Parameter Type Tags Description
key string Template, Required Configuration key.
body object Body, Required Configuration.

Response Type

void

Example Usage

key = 'key0'
body = jsonpickle.decode('{"key1":"val1","key2":"val2"}')

result = configuration_controller.update_named_configuration(key, body)

Errors

HTTP Status Code Error Description Exception Class
401 Unauthorized APIException
403 Forbidden APIException