Reference documentation and code samples for the Live Stream V1 API class Google::Cloud::Video::LiveStream::V1::DeleteChannelRequest.
Request message for "LivestreamService.DeleteChannel".
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#force
defforce()->::Boolean
Returns
(::Boolean) — If the force field is set to the default value of false, you must
delete all of a channel's events before you can delete the channel itself.
If the field is set to true, requests to delete a channel also delete
associated channel events.
#force=
defforce=(value)->::Boolean
Parameter
value (::Boolean) — If the force field is set to the default value of false, you must
delete all of a channel's events before you can delete the channel itself.
If the field is set to true, requests to delete a channel also delete
associated channel events.
Returns
(::Boolean) — If the force field is set to the default value of false, you must
delete all of a channel's events before you can delete the channel itself.
If the field is set to true, requests to delete a channel also delete
associated channel events.
#name
defname()->::String
Returns
(::String) — Required. The name of the channel resource, in the form of:
projects/{project}/locations/{location}/channels/{channelId}.
#name=
defname=(value)->::String
Parameter
value (::String) — Required. The name of the channel resource, in the form of:
projects/{project}/locations/{location}/channels/{channelId}.
Returns
(::String) — Required. The name of the channel resource, in the form of:
projects/{project}/locations/{location}/channels/{channelId}.
#request_id
defrequest_id()->::String
Returns
(::String) — A request ID to identify requests. Specify a unique request ID
so that if you must retry your request, the server will know to ignore
the request if it has already been completed. The server will guarantee
that for at least 60 minutes after the first request.
For example, consider a situation where you make an initial request and the
request times out. If you make the request again with the same request ID,
the server can check if original operation with the same request ID was
received, and if so, will ignore the second request. This prevents clients
from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is
not supported (00000000-0000-0000-0000-000000000000).
#request_id=
defrequest_id=(value)->::String
Parameter
value (::String) — A request ID to identify requests. Specify a unique request ID
so that if you must retry your request, the server will know to ignore
the request if it has already been completed. The server will guarantee
that for at least 60 minutes after the first request.
For example, consider a situation where you make an initial request and the
request times out. If you make the request again with the same request ID,
the server can check if original operation with the same request ID was
received, and if so, will ignore the second request. This prevents clients
from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is
not supported (00000000-0000-0000-0000-000000000000).
Returns
(::String) — A request ID to identify requests. Specify a unique request ID
so that if you must retry your request, the server will know to ignore
the request if it has already been completed. The server will guarantee
that for at least 60 minutes after the first request.
For example, consider a situation where you make an initial request and the
request times out. If you make the request again with the same request ID,
the server can check if original operation with the same request ID was
received, and if so, will ignore the second request. This prevents clients
from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is
not supported (00000000-0000-0000-0000-000000000000).
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Live Stream V1 API - Class Google::Cloud::Video::LiveStream::V1::DeleteChannelRequest (v2.2.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.2.0 (latest)](/ruby/docs/reference/google-cloud-video-live_stream-v1/latest/Google-Cloud-Video-LiveStream-V1-DeleteChannelRequest)\n- [2.1.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/2.1.0/Google-Cloud-Video-LiveStream-V1-DeleteChannelRequest)\n- [2.0.1](/ruby/docs/reference/google-cloud-video-live_stream-v1/2.0.1/Google-Cloud-Video-LiveStream-V1-DeleteChannelRequest)\n- [1.3.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/1.3.0/Google-Cloud-Video-LiveStream-V1-DeleteChannelRequest)\n- [1.2.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/1.2.0/Google-Cloud-Video-LiveStream-V1-DeleteChannelRequest)\n- [1.1.1](/ruby/docs/reference/google-cloud-video-live_stream-v1/1.1.1/Google-Cloud-Video-LiveStream-V1-DeleteChannelRequest)\n- [1.0.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/1.0.0/Google-Cloud-Video-LiveStream-V1-DeleteChannelRequest)\n- [0.9.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.9.0/Google-Cloud-Video-LiveStream-V1-DeleteChannelRequest)\n- [0.8.2](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.8.2/Google-Cloud-Video-LiveStream-V1-DeleteChannelRequest)\n- [0.7.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.7.0/Google-Cloud-Video-LiveStream-V1-DeleteChannelRequest)\n- [0.6.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.6.0/Google-Cloud-Video-LiveStream-V1-DeleteChannelRequest)\n- [0.5.1](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.5.1/Google-Cloud-Video-LiveStream-V1-DeleteChannelRequest)\n- [0.4.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.4.0/Google-Cloud-Video-LiveStream-V1-DeleteChannelRequest)\n- [0.3.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.3.0/Google-Cloud-Video-LiveStream-V1-DeleteChannelRequest)\n- [0.2.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.2.0/Google-Cloud-Video-LiveStream-V1-DeleteChannelRequest)\n- [0.1.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.1.0/Google-Cloud-Video-LiveStream-V1-DeleteChannelRequest) \nReference documentation and code samples for the Live Stream V1 API class Google::Cloud::Video::LiveStream::V1::DeleteChannelRequest.\n\nRequest message for \"LivestreamService.DeleteChannel\". \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #force\n\n def force() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- If the `force` field is set to the default value of `false`, you must delete all of a channel's events before you can delete the channel itself. If the field is set to `true`, requests to delete a channel also delete associated channel events.\n\n### #force=\n\n def force=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- If the `force` field is set to the default value of `false`, you must delete all of a channel's events before you can delete the channel itself. If the field is set to `true`, requests to delete a channel also delete associated channel events. \n**Returns**\n\n- (::Boolean) --- If the `force` field is set to the default value of `false`, you must delete all of a channel's events before you can delete the channel itself. If the field is set to `true`, requests to delete a channel also delete associated channel events.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The name of the channel resource, in the form of: `projects/{project}/locations/{location}/channels/{channelId}`.\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The name of the channel resource, in the form of: `projects/{project}/locations/{location}/channels/{channelId}`. \n**Returns**\n\n- (::String) --- Required. The name of the channel resource, in the form of: `projects/{project}/locations/{location}/channels/{channelId}`.\n\n### #request_id\n\n def request_id() -\u003e ::String\n\n**Returns**\n\n- (::String) --- A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.\n\n For example, consider a situation where you make an initial request and the\n request times out. If you make the request again with the same request ID,\n the server can check if original operation with the same request ID was\n received, and if so, will ignore the second request. This prevents clients\n from accidentally creating duplicate commitments.\n\n The request ID must be a valid UUID with the exception that zero UUID is\n not supported `(00000000-0000-0000-0000-000000000000)`.\n\n### #request_id=\n\n def request_id=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.\n\n\n For example, consider a situation where you make an initial request and the\n request times out. If you make the request again with the same request ID,\n the server can check if original operation with the same request ID was\n received, and if so, will ignore the second request. This prevents clients\n from accidentally creating duplicate commitments.\n\n The request ID must be a valid UUID with the exception that zero UUID is\nnot supported `(00000000-0000-0000-0000-000000000000)`. \n**Returns**\n\n- (::String) --- A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.\n\n For example, consider a situation where you make an initial request and the\n request times out. If you make the request again with the same request ID,\n the server can check if original operation with the same request ID was\n received, and if so, will ignore the second request. This prevents clients\n from accidentally creating duplicate commitments.\n\n The request ID must be a valid UUID with the exception that zero UUID is\n not supported `(00000000-0000-0000-0000-000000000000)`."]]
