Video API, gRPC: ChannelService
Channel management service.
Call | Description |
---|---|
Get | Returns the specific channel. |
List | List channels for organization. |
Create | Create channel. |
Update | Update channel. |
Delete | Delete channel. |
Calls ChannelService
Get
Returns the specific channel.
rpc Get (GetChannelRequest) returns (Channel)
GetChannelRequest
Field | Description |
---|---|
channel_id | string ID of the channel. |
Channel
Field | Description |
---|---|
id | string ID of the channel. |
organization_id | string ID of the organization where channel should be created. |
title | string Channel title. |
description | string Channel description. |
created_at | google.protobuf.Timestamp Time when channel was created. |
updated_at | google.protobuf.Timestamp Time of last channel update. |
labels | map<string,string> Custom labels as key:value pairs. Maximum 64 per resource. |
List
List channels for organization.
rpc List (ListChannelsRequest) returns (ListChannelsResponse)
ListChannelsRequest
Field | Description |
---|---|
organization_id | string ID of the organization. |
page_size | int64 The maximum number of the results per page to return. Default value: 100. |
page_token | string Page token for getting the next page of the result. |
order_by | string By which column the listing should be ordered and in which direction, format is "createdAt desc". "id asc" if omitted. Possible fields: ["id", "createdAt", "updatedAt"] Both snake_case and camelCase are supported for fields. |
filter | string Filter expression that filters resources listed in the response. Expressions are composed of terms connected by logic operators. Value in quotes: ' or " Example: "key1='value' AND key2='value'" Supported operators: ["AND"]. Supported fields: ["title"] Both snake_case and camelCase are supported for fields. |
ListChannelsResponse
Field | Description |
---|---|
channels[] | Channel List of channels for specific organization. |
next_page_token | string Token for getting the next page. |
Channel
Field | Description |
---|---|
id | string ID of the channel. |
organization_id | string ID of the organization where channel should be created. |
title | string Channel title. |
description | string Channel description. |
created_at | google.protobuf.Timestamp Time when channel was created. |
updated_at | google.protobuf.Timestamp Time of last channel update. |
labels | map<string,string> Custom labels as key:value pairs. Maximum 64 per resource. |
Create
Create channel.
rpc Create (CreateChannelRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreateChannelMetadata
Operation.response:Channel
CreateChannelRequest
Field | Description |
---|---|
organization_id | string ID of the organization. |
title | string Channel title. |
description | string Channel description. |
labels | map<string,string> Custom labels as key:value pairs. Maximum 64 per resource. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
CreateChannelMetadata
Field | Description |
---|---|
channel_id | string ID of the channel. |
Channel
Field | Description |
---|---|
id | string ID of the channel. |
organization_id | string ID of the organization where channel should be created. |
title | string Channel title. |
description | string Channel description. |
created_at | google.protobuf.Timestamp Time when channel was created. |
updated_at | google.protobuf.Timestamp Time of last channel update. |
labels | map<string,string> Custom labels as key:value pairs. Maximum 64 per resource. |
Update
Update channel.
rpc Update (UpdateChannelRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateChannelMetadata
Operation.response:Channel
UpdateChannelRequest
Field | Description |
---|---|
channel_id | string ID of the channel. |
field_mask | google.protobuf.FieldMask Field mask that specifies which fields of the channel are going to be updated. |
title | string Channel title. |
description | string Channel description. |
labels | map<string,string> Custom labels as key:value pairs. Maximum 64 per resource. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateChannelMetadata
Field | Description |
---|---|
channel_id | string ID of the channel. |
Channel
Field | Description |
---|---|
id | string ID of the channel. |
organization_id | string ID of the organization where channel should be created. |
title | string Channel title. |
description | string Channel description. |
created_at | google.protobuf.Timestamp Time when channel was created. |
updated_at | google.protobuf.Timestamp Time of last channel update. |
labels | map<string,string> Custom labels as key:value pairs. Maximum 64 per resource. |
Delete
Delete channel.
rpc Delete (DeleteChannelRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteChannelMetadata
Operation.response:google.protobuf.Empty
DeleteChannelRequest
Field | Description |
---|---|
channel_id | string ID of the channel. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
DeleteChannelMetadata
Field | Description |
---|---|
channel_id | string ID of the channel. |