Service.Common

Summary
Service.Common
Functions
pingProvide a ping facility for each service
batchSettingChangesPerform a series of object setting changes Aside from being the same as having called create/update/clearObjectSetting, this method will also perform container deploys or loadbalancer reconfigures as needed
createObjectSettingCreate an object setting
clearObjectSettingClear an object setting
updateObjectSettingUpdate an object setting value
getObjectSettingsGet all the object settings, and catalog ids, for an object
getSettingCatalogGet the catalog

Functions

ping

Provide a ping facility for each service

Parameters

echono docs (idx: 1, type: Thrift.string, optional, utf8)

Returns

Types.PingResponse

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

  • customer

batchSettingChanges

Perform a series of object setting changes Aside from being the same as having called create/update/clearObjectSetting, this method will also perform container deploys or loadbalancer reconfigures as needed

Parameters

changesno docs (idx: 1, type: Thrift.list (Types.CRUDObjectSettingChange))

Returns

Thrift.list (Types.CRUDObjectSettingResponse)

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

  • customer

createObjectSetting

Create an object setting

Parameters

contextno docs (idx: 1, type: Types.ObjectSettingContext)
objectIdno docs (idx: 2, type: Types.ObjectId)
settingIdno docs (idx: 3, type: Types.SettingId)
valueno docs (idx: 4, type: Types.SettingValue)

Returns

Types.ObjectSettingId

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

  • customer

clearObjectSetting

Clear an object setting

Parameters

idno docs (idx: 1, type: Types.ObjectSettingId)

Returns

Thrift.void

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

  • customer

updateObjectSetting

Update an object setting value

Parameters

idno docs (idx: 1, type: Types.ObjectSettingId)
valueno docs (idx: 2, type: Types.SettingValue)

Returns

Thrift.void

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

  • customer

getObjectSettings

Get all the object settings, and catalog ids, for an object

Parameters

contextno docs (idx: 1, type: Types.ObjectSettingContext)
objectIdno docs (idx: 2, type: Types.ObjectId)
limitClassesExplicitly state which classes we want (‘PHP’, ‘LB’, ‘Customer’) (idx: 3, type: Thrift.list (Types.SettingClass), optional)

Returns

Types.ComputedObjectSettings

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

  • customer

getSettingCatalog

Get the catalog

Returns

Thrift.list (Types.SettingCatalog)

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

  • customer
A Thrift built-in type.
Response to Common.ping
A Thrift built-in type.
Argument for Common.batchSettingChanges
Response from Common.batchSettingChanges
Base type Thrift.i32
Base type Thrift.i32
Base type Thrift.string
Base type Thrift.i32
A Thrift built-in type.
Base type Thrift.string
A list of computed object settings with the related catalog
A setting catalog item
Close