Class: Google::Cloud::Video::LiveStream::V1::DeleteChannelRequest

Inherits:

Object

• Object
• Google::Cloud::Video::LiveStream::V1::DeleteChannelRequest

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/video/livestream/v1/service.rb

Overview

Request message for "LivestreamService.DeleteChannel".

Instance Attribute Summary

• #force ⇒ ::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.

• #name ⇒ ::String

  Required.

• #request_id ⇒ ::String

  A request ID to identify requests.

Instance Attribute Details

#force ⇒ ::Boolean

Returns 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.

# File 'proto_docs/google/cloud/video/livestream/v1/service.rb', line 243

class DeleteChannelRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns 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}.

# File 'proto_docs/google/cloud/video/livestream/v1/service.rb', line 243

class DeleteChannelRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#request_id ⇒ ::String

Returns 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).

# File 'proto_docs/google/cloud/video/livestream/v1/service.rb', line 243

class DeleteChannelRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end