package filter

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Commit (ActionCommitRequest, ActionCommitResponse)

  filter.proto:16

  Sets new properties for the [Action] on the server side using a [ActionData] object.

  message ActionCommitRequest

  filter.proto:192

  ACTION ---- Commit

  • optional Action action = 1

  message ActionCommitResponse

  filter.proto:196

  (message has no fields)

• rpc Delete (ActionDeleteRequest, ActionDeleteResponse)

  filter.proto:19

  Delete this [Action]

  message ActionDeleteRequest

  filter.proto:199

  Delete

  • optional Action action = 1

  message ActionDeleteResponse

  filter.proto:203

  (message has no fields)

• rpc GetParentFilter (ActionGetParentFilterRequest, ActionGetParentFilterResponse)

  filter.proto:22

  Returns the [Filter] this action is part of.

  message ActionGetParentFilterRequest

  filter.proto:206

  GetParentFilter

  • optional Action action = 1

  message ActionGetParentFilterResponse

  filter.proto:210

  • optional Filter filter = 1

• rpc CreateAction (FilterCreateActionRequest, FilterCreateActionResponse)

  filter.proto:27

  Creates a new [Action] that will execute for this filter.

  message FilterCreateActionRequest

  filter.proto:216

  FILTER ---- CreateAction

  • optional Filter filter = 1

  • optional Action data = 2

  message FilterCreateActionResponse

  filter.proto:221

  • optional Action action = 1

• rpc CreateMatcher (FilterCreateMatcherRequest, FilterCreateMatcherResponse)

  filter.proto:30

  Creates a new [Matcher] for this filter.

  message FilterCreateMatcherRequest

  filter.proto:226

  CreateMatcher

  • optional Filter filter = 1

  • optional Matcher data = 2

  message FilterCreateMatcherResponse

  filter.proto:231

  • optional Matcher matcher = 1

• rpc Delete (FilterDeleteRequest, FilterDeleteResponse)

  filter.proto:33

  Delete this filter.

  message FilterDeleteRequest

  filter.proto:236

  Delete

  • optional Filter filter = 1

  message FilterDeleteResponse

  filter.proto:240

  (message has no fields)

• rpc FindFilter (FilterFindFilterRequest, FilterFindFilterResponse)

  filter.proto:36

  Find a filter by it's show and name

  message FilterFindFilterRequest

  filter.proto:243

  FindFilter

  • string show = 1

  • string name = 2

  message FilterFindFilterResponse

  filter.proto:248

  • optional Filter filter = 1

• rpc GetActions (FilterGetActionsRequest, FilterGetActionsResponse)

  filter.proto:39

  Returns a list of [Action]s configured for this filter.

  message FilterGetActionsRequest

  filter.proto:253

  GetActions

  • optional Filter filter = 1

  message FilterGetActionsResponse

  filter.proto:257

  • optional ActionSeq actions = 1

• rpc GetMatchers (FilterGetMatchersRequest, FilterGetMatchersResponse)

  filter.proto:42

  Returns a list of [Matcher]s configured for this filter

  message FilterGetMatchersRequest

  filter.proto:262

  GetMatchers

  • optional Filter filter = 1

  message FilterGetMatchersResponse

  filter.proto:266

  • optional MatcherSeq matchers = 1

• rpc LowerOrder (FilterLowerOrderRequest, FilterLowerOrderResponse)

  filter.proto:45

  Lowers the order of the filter, this makes it run after the next filter

  message FilterLowerOrderRequest

  filter.proto:271

  LowerOrder

  • optional Filter filter = 1

  message FilterLowerOrderResponse

  filter.proto:275

  (message has no fields)

• rpc OrderFirst (FilterOrderFirstRequest, FilterOrderFirstResponse)

  filter.proto:48

  Moves the filter to first in the order list.

  message FilterOrderFirstRequest

  filter.proto:278

  OrderFirst

  • optional Filter filter = 1

  message FilterOrderFirstResponse

  filter.proto:282

  (message has no fields)

• rpc OrderLast (FilterOrderLastRequest, FilterOrderLastResponse)

  filter.proto:51

  Moves the filter to last in the order list.

  message FilterOrderLastRequest

  filter.proto:285

  OrderLast

  • optional Filter filter = 1

  message FilterOrderLastResponse

  filter.proto:289

  (message has no fields)

• rpc RaiseOrder (FilterRaiseOrderRequest, FilterRaiseOrderResponse)

  filter.proto:54

  Raises the order of the filter, this makes it run before the previous filter.

  message FilterRaiseOrderRequest

  filter.proto:292

  RaiseOrder

  • optional Filter filter = 1

  message FilterRaiseOrderResponse

  filter.proto:296

  (message has no fields)

• rpc RunFilterOnGroup (FilterRunFilterOnGroupRequest, FilterRunFilterOnGroupResponse)

  filter.proto:57

  Executes the filter on a specified group.

  message FilterRunFilterOnGroupRequest

  filter.proto:299

  RunFilterOnGroup

  • optional Filter filter = 1

  • optional job.Group group = 2

  message FilterRunFilterOnGroupResponse

  filter.proto:304

  (message has no fields)

• rpc RunFilterOnJobs (FilterRunFilterOnJobsRequest, FilterRunFilterOnJobsResponse)

  filter.proto:60

  Executes the filter on a specified sequence of jobs.

  message FilterRunFilterOnJobsRequest

  filter.proto:307

  RunFilterOnJobs

  • optional Filter filter = 1

  • optional job.JobSeq jobs = 2

  message FilterRunFilterOnJobsResponse

  filter.proto:312

  (message has no fields)

• rpc SetEnabled (FilterSetEnabledRequest, FilterSetEnabledResponse)

  filter.proto:63

  Set the filter to enabled or disabled

  message FilterSetEnabledRequest

  filter.proto:315

  SetEnabled

  • optional Filter filter = 1

  • bool enabled = 2

  message FilterSetEnabledResponse

  filter.proto:320

  (message has no fields)

• rpc SetName (FilterSetNameRequest, FilterSetNameResponse)

  filter.proto:66

  Set the filter name.

  message FilterSetNameRequest

  filter.proto:323

  SetName

  • optional Filter filter = 1

  • string name = 2

  message FilterSetNameResponse

  filter.proto:328

  (message has no fields)

• rpc SetOrder (FilterSetOrderRequest, FilterSetOrderResponse)

  filter.proto:69

  Directly sets the order of the filter.

  message FilterSetOrderRequest

  filter.proto:331

  SetOrder

  • optional Filter filter = 1

  • int32 order = 2

  message FilterSetOrderResponse

  filter.proto:336

  (message has no fields)

• rpc SetType (FilterSetTypeRequest, FilterSetTypeResponse)

  filter.proto:72

  Set the type of the filter. See FilterType

  message FilterSetTypeRequest

  filter.proto:339

  SetType

  • optional Filter filter = 1

  • FilterType type = 2

  message FilterSetTypeResponse

  filter.proto:344

  (message has no fields)

• rpc Commit (MatcherCommitRequest, MatcherCommitResponse)

  filter.proto:77

  Sets new properties for the [Matcher] on the server side using a [MatcherData] object.

  message MatcherCommitRequest

  filter.proto:348

  MATCHER ---- Commit

  • optional Matcher matcher = 1

  message MatcherCommitResponse

  filter.proto:352

  (message has no fields)

• rpc Delete (MatcherDeleteRequest, MatcherDeleteResponse)

  filter.proto:80

  Delete this matcher.

  message MatcherDeleteRequest

  filter.proto:355

  Delete

  • optional Matcher matcher = 1

  message MatcherDeleteResponse

  filter.proto:359

  (message has no fields)

• rpc GetParentFilter (MatcherGetParentFilterRequest, MatcherGetParentFilterResponse)

  filter.proto:83

  Returns the [Filter] this matcher is part of.

  message MatcherGetParentFilterRequest

  filter.proto:362

  GetParentFilter

  • optional Matcher matcher = 1

  message MatcherGetParentFilterResponse

  filter.proto:366

  • optional Filter filter = 1

Used in: ActionCommitRequest, ActionDeleteRequest, ActionGetParentFilterRequest, ActionSeq, FilterCreateActionRequest, FilterCreateActionResponse

• string id = 1

• ActionType type = 2

• ActionValueType value_type = 3

• string group_value = 4

• string string_value = 5

• int32 integer_value = 6

• float float_value = 7

• bool boolean_value = 8

Used in: FilterGetActionsResponse

• repeated Action actions = 1

Used in: Action

• MOVE_JOB_TO_GROUP = 0

• PAUSE_JOB = 1

• SET_JOB_MIN_CORES = 2

• SET_JOB_MAX_CORES = 3

• STOP_PROCESSING = 4

• SET_JOB_PRIORITY = 5

• SET_ALL_RENDER_LAYER_TAGS = 6

  Sets all layer tags for any layer with the type "Render"

• SET_ALL_RENDER_LAYER_MEMORY = 7

  Sets all layer minimum memory for any layer with the type "Render"

• SET_ALL_RENDER_LAYER_CORES = 8

  This field is deprecated, use SET_ALL_RENDER_LAYER_MIN_CORES and SET_ALL_RENDER_LAYER_MAX_CORES instead.

• SET_MEMORY_OPTIMIZER = 9

  Set memory optimizer

• SET_ALL_RENDER_LAYER_MIN_CORES = 10

  Sets all min cores for any layer with the type "Render"

• SET_ALL_RENDER_LAYER_MAX_CORES = 11

  Sets all max cores for any layer with the type "Render"

Used in: Action

• GROUP_TYPE = 0

• STRING_TYPE = 1

• INTEGER_TYPE = 2

• FLOAT_TYPE = 3

• BOOLEAN_TYPE = 4

• NONE_TYPE = 5

Used in: ActionGetParentFilterResponse, FilterCreateActionRequest, FilterCreateMatcherRequest, FilterDeleteRequest, FilterFindFilterResponse, FilterGetActionsRequest, FilterGetMatchersRequest, FilterLowerOrderRequest, FilterOrderFirstRequest, FilterOrderLastRequest, FilterRaiseOrderRequest, FilterRunFilterOnGroupRequest, FilterRunFilterOnJobsRequest, FilterSeq, FilterSetEnabledRequest, FilterSetNameRequest, FilterSetOrderRequest, FilterSetTypeRequest, MatcherGetParentFilterResponse, show.ShowCreateFilterResponse, show.ShowFindFilterResponse

• string id = 1

• string name = 2

• FilterType type = 3

• float order = 4

• bool enabled = 5

Used in: show.ShowGetFiltersResponse

• repeated Filter filters = 1

Used in: Filter, FilterSetTypeRequest

• MATCH_ANY = 0

• MATCH_ALL = 1

Used in: Matcher

• JOB_NAME = 0

• SHOW = 1

• SHOT = 2

• USER = 3

• SERVICE_NAME = 4

• PRIORITY = 5

• FACILITY = 6

• LAYER_NAME = 7

Used in: Matcher

• CONTAINS = 0

• DOES_NOT_CONTAIN = 1

• IS = 2

• IS_NOT = 3

• REGEX = 4

• BEGINS_WITH = 5

• ENDS_WITH = 6

Used in: FilterCreateMatcherRequest, FilterCreateMatcherResponse, MatcherCommitRequest, MatcherDeleteRequest, MatcherGetParentFilterRequest, MatcherSeq

• string id = 1

• MatchSubject subject = 2

• MatchType type = 3

• string input = 4

Used in: FilterGetMatchersResponse

• repeated Matcher matchers = 1