Class: Google::Cloud::Video::LiveStream::V1::CreateEventRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/video/livestream/v1/service.rb

Overview

Request message for "LivestreamService.CreateEvent".

Instance Attribute Summary collapse

Instance Attribute Details

#event ⇒ ::Google::Cloud::Video::LiveStream::V1::Event

Returns Required. The event resource to be created.

Returns:



594
595
596
597
 
# File 'proto_docs/google/cloud/video/livestream/v1/service.rb', line 594

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

#event_id ⇒ ::String

Returns Required. The ID of the event resource to be created.

This value must be 1-63 characters, begin and end with a lower-case letter or a number, and consist of only lower-case letters, numbers, and hyphens. In other words, it must match the following regex: ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$.

Returns:

  • (::String) —

    Required. The ID of the event resource to be created.

    This value must be 1-63 characters, begin and end with a lower-case letter or a number, and consist of only lower-case letters, numbers, and hyphens. In other words, it must match the following regex: ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$.



594
595
596
597
 
# File 'proto_docs/google/cloud/video/livestream/v1/service.rb', line 594

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

#parent ⇒ ::String

Returns Required. The parent channel for the resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.

Returns:

  • (::String) —

    Required. The parent channel for the resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.



594
595
596
597
 
# File 'proto_docs/google/cloud/video/livestream/v1/service.rb', line 594

class CreateEventRequest
  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 since 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 since 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).



594
595
596
597
 
# File 'proto_docs/google/cloud/video/livestream/v1/service.rb', line 594

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