Class: Google::Cloud::Video::LiveStream::V1::Event

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

Overview

Event is a sub-resource of a channel, which can be scheduled by the user to execute operations on a channel resource without having to stop the channel.

Defined Under Namespace

Modules: State Classes: AdBreakTask, InputSwitchTask, LabelsEntry, MuteTask, ReturnToProgramTask, SlateTask, UnmuteTask, UpdateEncryptionsTask

Instance Attribute Summary collapse

Instance Attribute Details

#ad_break ⇒ ::Google::Cloud::Video::LiveStream::V1::Event::AdBreakTask

Returns Inserts a new ad opportunity.

Note: The following fields are mutually exclusive: ad_break, input_switch, return_to_program, slate, mute, unmute, update_encryptions. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Video::LiveStream::V1::Event::AdBreakTask) —

    Inserts a new ad opportunity.

    Note: The following fields are mutually exclusive: ad_break, input_switch, return_to_program, slate, mute, unmute, update_encryptions. If a field in that set is populated, all other fields in the set will automatically be cleared.



642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 642

class Event
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Switches to another input stream. Automatic failover is then disabled.
  # @!attribute [rw] input_key
  #   @return [::String]
  #     The
  #     {::Google::Cloud::Video::LiveStream::V1::InputAttachment#key InputAttachment.key}
  #     of the input to switch to.
  class InputSwitchTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Inserts a new ad opportunity.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Duration of an ad opportunity. Must be greater than 0.
  class AdBreakTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Inserts a slate.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Duration of the slate. Must be greater than 0 if specified.
  #     Omit this field for a long running slate.
  # @!attribute [rw] asset
  #   @return [::String]
  #     Slate asset to use for the duration. If its duration is less than the
  #     duration of the SlateTask, then the slate loops. The slate must be
  #     represented in the form of:
  #     `projects/{project}/locations/{location}/assets/{assetId}`.
  class SlateTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Stops any events which are currently running. This only applies to events
  # with a duration.
  class ReturnToProgramTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Mutes the stream.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Duration for which the stream should be muted. If omitted, the stream
  #     will be muted until an UnmuteTask event is sent.
  class MuteTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Unmutes the stream. The task fails if the stream is not currently muted.
  class UnmuteTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Update encryption settings.
  # @!attribute [rw] encryptions
  #   @return [::Array<::Google::Cloud::Video::LiveStream::V1::EncryptionUpdate>]
  #     Required. A list of
  #     {::Google::Cloud::Video::LiveStream::V1::EncryptionUpdate EncryptionUpdate}s
  #     that updates the existing encryption settings.
  class UpdateEncryptionsTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the event
  module State
    # Event state is not specified.
    STATE_UNSPECIFIED = 0

    # Event is scheduled but not executed yet.
    SCHEDULED = 1

    # Event is being executed.
    RUNNING = 2

    # Event has been successfully executed.
    SUCCEEDED = 3

    # Event fails to be executed.
    FAILED = 4

    # Event has been created but not scheduled yet.
    PENDING = 5

    # Event was stopped before running for its full duration.
    STOPPED = 6
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The creation time.

Returns:



642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 642

class Event
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Switches to another input stream. Automatic failover is then disabled.
  # @!attribute [rw] input_key
  #   @return [::String]
  #     The
  #     {::Google::Cloud::Video::LiveStream::V1::InputAttachment#key InputAttachment.key}
  #     of the input to switch to.
  class InputSwitchTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Inserts a new ad opportunity.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Duration of an ad opportunity. Must be greater than 0.
  class AdBreakTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Inserts a slate.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Duration of the slate. Must be greater than 0 if specified.
  #     Omit this field for a long running slate.
  # @!attribute [rw] asset
  #   @return [::String]
  #     Slate asset to use for the duration. If its duration is less than the
  #     duration of the SlateTask, then the slate loops. The slate must be
  #     represented in the form of:
  #     `projects/{project}/locations/{location}/assets/{assetId}`.
  class SlateTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Stops any events which are currently running. This only applies to events
  # with a duration.
  class ReturnToProgramTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Mutes the stream.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Duration for which the stream should be muted. If omitted, the stream
  #     will be muted until an UnmuteTask event is sent.
  class MuteTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Unmutes the stream. The task fails if the stream is not currently muted.
  class UnmuteTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Update encryption settings.
  # @!attribute [rw] encryptions
  #   @return [::Array<::Google::Cloud::Video::LiveStream::V1::EncryptionUpdate>]
  #     Required. A list of
  #     {::Google::Cloud::Video::LiveStream::V1::EncryptionUpdate EncryptionUpdate}s
  #     that updates the existing encryption settings.
  class UpdateEncryptionsTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the event
  module State
    # Event state is not specified.
    STATE_UNSPECIFIED = 0

    # Event is scheduled but not executed yet.
    SCHEDULED = 1

    # Event is being executed.
    RUNNING = 2

    # Event has been successfully executed.
    SUCCEEDED = 3

    # Event fails to be executed.
    FAILED = 4

    # Event has been created but not scheduled yet.
    PENDING = 5

    # Event was stopped before running for its full duration.
    STOPPED = 6
  end
end

#error ⇒ ::Google::Rpc::Status (readonly)

Returns Output only. An error object that describes the reason for the failure. This property is always present when state is FAILED.

Returns:

  • (::Google::Rpc::Status) —

    Output only. An error object that describes the reason for the failure. This property is always present when state is FAILED.



642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 642

class Event
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Switches to another input stream. Automatic failover is then disabled.
  # @!attribute [rw] input_key
  #   @return [::String]
  #     The
  #     {::Google::Cloud::Video::LiveStream::V1::InputAttachment#key InputAttachment.key}
  #     of the input to switch to.
  class InputSwitchTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Inserts a new ad opportunity.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Duration of an ad opportunity. Must be greater than 0.
  class AdBreakTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Inserts a slate.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Duration of the slate. Must be greater than 0 if specified.
  #     Omit this field for a long running slate.
  # @!attribute [rw] asset
  #   @return [::String]
  #     Slate asset to use for the duration. If its duration is less than the
  #     duration of the SlateTask, then the slate loops. The slate must be
  #     represented in the form of:
  #     `projects/{project}/locations/{location}/assets/{assetId}`.
  class SlateTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Stops any events which are currently running. This only applies to events
  # with a duration.
  class ReturnToProgramTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Mutes the stream.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Duration for which the stream should be muted. If omitted, the stream
  #     will be muted until an UnmuteTask event is sent.
  class MuteTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Unmutes the stream. The task fails if the stream is not currently muted.
  class UnmuteTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Update encryption settings.
  # @!attribute [rw] encryptions
  #   @return [::Array<::Google::Cloud::Video::LiveStream::V1::EncryptionUpdate>]
  #     Required. A list of
  #     {::Google::Cloud::Video::LiveStream::V1::EncryptionUpdate EncryptionUpdate}s
  #     that updates the existing encryption settings.
  class UpdateEncryptionsTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the event
  module State
    # Event state is not specified.
    STATE_UNSPECIFIED = 0

    # Event is scheduled but not executed yet.
    SCHEDULED = 1

    # Event is being executed.
    RUNNING = 2

    # Event has been successfully executed.
    SUCCEEDED = 3

    # Event fails to be executed.
    FAILED = 4

    # Event has been created but not scheduled yet.
    PENDING = 5

    # Event was stopped before running for its full duration.
    STOPPED = 6
  end
end

#execute_now ⇒ ::Boolean

Returns When this field is set to true, the event will be executed at the earliest time that the server can schedule the event and execution_time will be populated with the time that the server actually schedules the event.

Returns:

  • (::Boolean) —

    When this field is set to true, the event will be executed at the earliest time that the server can schedule the event and execution_time will be populated with the time that the server actually schedules the event.



642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 642

class Event
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Switches to another input stream. Automatic failover is then disabled.
  # @!attribute [rw] input_key
  #   @return [::String]
  #     The
  #     {::Google::Cloud::Video::LiveStream::V1::InputAttachment#key InputAttachment.key}
  #     of the input to switch to.
  class InputSwitchTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Inserts a new ad opportunity.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Duration of an ad opportunity. Must be greater than 0.
  class AdBreakTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Inserts a slate.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Duration of the slate. Must be greater than 0 if specified.
  #     Omit this field for a long running slate.
  # @!attribute [rw] asset
  #   @return [::String]
  #     Slate asset to use for the duration. If its duration is less than the
  #     duration of the SlateTask, then the slate loops. The slate must be
  #     represented in the form of:
  #     `projects/{project}/locations/{location}/assets/{assetId}`.
  class SlateTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Stops any events which are currently running. This only applies to events
  # with a duration.
  class ReturnToProgramTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Mutes the stream.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Duration for which the stream should be muted. If omitted, the stream
  #     will be muted until an UnmuteTask event is sent.
  class MuteTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Unmutes the stream. The task fails if the stream is not currently muted.
  class UnmuteTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Update encryption settings.
  # @!attribute [rw] encryptions
  #   @return [::Array<::Google::Cloud::Video::LiveStream::V1::EncryptionUpdate>]
  #     Required. A list of
  #     {::Google::Cloud::Video::LiveStream::V1::EncryptionUpdate EncryptionUpdate}s
  #     that updates the existing encryption settings.
  class UpdateEncryptionsTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the event
  module State
    # Event state is not specified.
    STATE_UNSPECIFIED = 0

    # Event is scheduled but not executed yet.
    SCHEDULED = 1

    # Event is being executed.
    RUNNING = 2

    # Event has been successfully executed.
    SUCCEEDED = 3

    # Event fails to be executed.
    FAILED = 4

    # Event has been created but not scheduled yet.
    PENDING = 5

    # Event was stopped before running for its full duration.
    STOPPED = 6
  end
end

#execution_time ⇒ ::Google::Protobuf::Timestamp

Returns The time to execute the event. If you set execute_now to true, then do not set this field in the CreateEvent request. In this case, the server schedules the event and populates this field. If you set execute_now to false, then you must set this field to at least 10 seconds in the future or else the event can't be created.

Returns:

  • (::Google::Protobuf::Timestamp) —

    The time to execute the event. If you set execute_now to true, then do not set this field in the CreateEvent request. In this case, the server schedules the event and populates this field. If you set execute_now to false, then you must set this field to at least 10 seconds in the future or else the event can't be created.



642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 642

class Event
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Switches to another input stream. Automatic failover is then disabled.
  # @!attribute [rw] input_key
  #   @return [::String]
  #     The
  #     {::Google::Cloud::Video::LiveStream::V1::InputAttachment#key InputAttachment.key}
  #     of the input to switch to.
  class InputSwitchTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Inserts a new ad opportunity.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Duration of an ad opportunity. Must be greater than 0.
  class AdBreakTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Inserts a slate.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Duration of the slate. Must be greater than 0 if specified.
  #     Omit this field for a long running slate.
  # @!attribute [rw] asset
  #   @return [::String]
  #     Slate asset to use for the duration. If its duration is less than the
  #     duration of the SlateTask, then the slate loops. The slate must be
  #     represented in the form of:
  #     `projects/{project}/locations/{location}/assets/{assetId}`.
  class SlateTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Stops any events which are currently running. This only applies to events
  # with a duration.
  class ReturnToProgramTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Mutes the stream.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Duration for which the stream should be muted. If omitted, the stream
  #     will be muted until an UnmuteTask event is sent.
  class MuteTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Unmutes the stream. The task fails if the stream is not currently muted.
  class UnmuteTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Update encryption settings.
  # @!attribute [rw] encryptions
  #   @return [::Array<::Google::Cloud::Video::LiveStream::V1::EncryptionUpdate>]
  #     Required. A list of
  #     {::Google::Cloud::Video::LiveStream::V1::EncryptionUpdate EncryptionUpdate}s
  #     that updates the existing encryption settings.
  class UpdateEncryptionsTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the event
  module State
    # Event state is not specified.
    STATE_UNSPECIFIED = 0

    # Event is scheduled but not executed yet.
    SCHEDULED = 1

    # Event is being executed.
    RUNNING = 2

    # Event has been successfully executed.
    SUCCEEDED = 3

    # Event fails to be executed.
    FAILED = 4

    # Event has been created but not scheduled yet.
    PENDING = 5

    # Event was stopped before running for its full duration.
    STOPPED = 6
  end
end

#input_switch ⇒ ::Google::Cloud::Video::LiveStream::V1::Event::InputSwitchTask

Returns Switches to another input stream.

Note: The following fields are mutually exclusive: input_switch, ad_break, return_to_program, slate, mute, unmute, update_encryptions. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Video::LiveStream::V1::Event::InputSwitchTask) —

    Switches to another input stream.

    Note: The following fields are mutually exclusive: input_switch, ad_break, return_to_program, slate, mute, unmute, update_encryptions. If a field in that set is populated, all other fields in the set will automatically be cleared.



642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 642

class Event
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Switches to another input stream. Automatic failover is then disabled.
  # @!attribute [rw] input_key
  #   @return [::String]
  #     The
  #     {::Google::Cloud::Video::LiveStream::V1::InputAttachment#key InputAttachment.key}
  #     of the input to switch to.
  class InputSwitchTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Inserts a new ad opportunity.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Duration of an ad opportunity. Must be greater than 0.
  class AdBreakTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Inserts a slate.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Duration of the slate. Must be greater than 0 if specified.
  #     Omit this field for a long running slate.
  # @!attribute [rw] asset
  #   @return [::String]
  #     Slate asset to use for the duration. If its duration is less than the
  #     duration of the SlateTask, then the slate loops. The slate must be
  #     represented in the form of:
  #     `projects/{project}/locations/{location}/assets/{assetId}`.
  class SlateTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Stops any events which are currently running. This only applies to events
  # with a duration.
  class ReturnToProgramTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Mutes the stream.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Duration for which the stream should be muted. If omitted, the stream
  #     will be muted until an UnmuteTask event is sent.
  class MuteTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Unmutes the stream. The task fails if the stream is not currently muted.
  class UnmuteTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Update encryption settings.
  # @!attribute [rw] encryptions
  #   @return [::Array<::Google::Cloud::Video::LiveStream::V1::EncryptionUpdate>]
  #     Required. A list of
  #     {::Google::Cloud::Video::LiveStream::V1::EncryptionUpdate EncryptionUpdate}s
  #     that updates the existing encryption settings.
  class UpdateEncryptionsTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the event
  module State
    # Event state is not specified.
    STATE_UNSPECIFIED = 0

    # Event is scheduled but not executed yet.
    SCHEDULED = 1

    # Event is being executed.
    RUNNING = 2

    # Event has been successfully executed.
    SUCCEEDED = 3

    # Event fails to be executed.
    FAILED = 4

    # Event has been created but not scheduled yet.
    PENDING = 5

    # Event was stopped before running for its full duration.
    STOPPED = 6
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns User-defined key/value metadata.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    User-defined key/value metadata.



642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 642

class Event
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Switches to another input stream. Automatic failover is then disabled.
  # @!attribute [rw] input_key
  #   @return [::String]
  #     The
  #     {::Google::Cloud::Video::LiveStream::V1::InputAttachment#key InputAttachment.key}
  #     of the input to switch to.
  class InputSwitchTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Inserts a new ad opportunity.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Duration of an ad opportunity. Must be greater than 0.
  class AdBreakTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Inserts a slate.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Duration of the slate. Must be greater than 0 if specified.
  #     Omit this field for a long running slate.
  # @!attribute [rw] asset
  #   @return [::String]
  #     Slate asset to use for the duration. If its duration is less than the
  #     duration of the SlateTask, then the slate loops. The slate must be
  #     represented in the form of:
  #     `projects/{project}/locations/{location}/assets/{assetId}`.
  class SlateTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Stops any events which are currently running. This only applies to events
  # with a duration.
  class ReturnToProgramTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Mutes the stream.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Duration for which the stream should be muted. If omitted, the stream
  #     will be muted until an UnmuteTask event is sent.
  class MuteTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Unmutes the stream. The task fails if the stream is not currently muted.
  class UnmuteTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Update encryption settings.
  # @!attribute [rw] encryptions
  #   @return [::Array<::Google::Cloud::Video::LiveStream::V1::EncryptionUpdate>]
  #     Required. A list of
  #     {::Google::Cloud::Video::LiveStream::V1::EncryptionUpdate EncryptionUpdate}s
  #     that updates the existing encryption settings.
  class UpdateEncryptionsTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the event
  module State
    # Event state is not specified.
    STATE_UNSPECIFIED = 0

    # Event is scheduled but not executed yet.
    SCHEDULED = 1

    # Event is being executed.
    RUNNING = 2

    # Event has been successfully executed.
    SUCCEEDED = 3

    # Event fails to be executed.
    FAILED = 4

    # Event has been created but not scheduled yet.
    PENDING = 5

    # Event was stopped before running for its full duration.
    STOPPED = 6
  end
end

#mute ⇒ ::Google::Cloud::Video::LiveStream::V1::Event::MuteTask

Returns Mutes the stream.

Note: The following fields are mutually exclusive: mute, input_switch, ad_break, return_to_program, slate, unmute, update_encryptions. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Video::LiveStream::V1::Event::MuteTask) —

    Mutes the stream.

    Note: The following fields are mutually exclusive: mute, input_switch, ad_break, return_to_program, slate, unmute, update_encryptions. If a field in that set is populated, all other fields in the set will automatically be cleared.



642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 642

class Event
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Switches to another input stream. Automatic failover is then disabled.
  # @!attribute [rw] input_key
  #   @return [::String]
  #     The
  #     {::Google::Cloud::Video::LiveStream::V1::InputAttachment#key InputAttachment.key}
  #     of the input to switch to.
  class InputSwitchTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Inserts a new ad opportunity.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Duration of an ad opportunity. Must be greater than 0.
  class AdBreakTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Inserts a slate.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Duration of the slate. Must be greater than 0 if specified.
  #     Omit this field for a long running slate.
  # @!attribute [rw] asset
  #   @return [::String]
  #     Slate asset to use for the duration. If its duration is less than the
  #     duration of the SlateTask, then the slate loops. The slate must be
  #     represented in the form of:
  #     `projects/{project}/locations/{location}/assets/{assetId}`.
  class SlateTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Stops any events which are currently running. This only applies to events
  # with a duration.
  class ReturnToProgramTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Mutes the stream.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Duration for which the stream should be muted. If omitted, the stream
  #     will be muted until an UnmuteTask event is sent.
  class MuteTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Unmutes the stream. The task fails if the stream is not currently muted.
  class UnmuteTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Update encryption settings.
  # @!attribute [rw] encryptions
  #   @return [::Array<::Google::Cloud::Video::LiveStream::V1::EncryptionUpdate>]
  #     Required. A list of
  #     {::Google::Cloud::Video::LiveStream::V1::EncryptionUpdate EncryptionUpdate}s
  #     that updates the existing encryption settings.
  class UpdateEncryptionsTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the event
  module State
    # Event state is not specified.
    STATE_UNSPECIFIED = 0

    # Event is scheduled but not executed yet.
    SCHEDULED = 1

    # Event is being executed.
    RUNNING = 2

    # Event has been successfully executed.
    SUCCEEDED = 3

    # Event fails to be executed.
    FAILED = 4

    # Event has been created but not scheduled yet.
    PENDING = 5

    # Event was stopped before running for its full duration.
    STOPPED = 6
  end
end

#name ⇒ ::String

Returns The resource name of the event, in the form of: projects/{project}/locations/{location}/channels/{channelId}/events/{eventId}.

Returns:

  • (::String) —

    The resource name of the event, in the form of: projects/{project}/locations/{location}/channels/{channelId}/events/{eventId}.



642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 642

class Event
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Switches to another input stream. Automatic failover is then disabled.
  # @!attribute [rw] input_key
  #   @return [::String]
  #     The
  #     {::Google::Cloud::Video::LiveStream::V1::InputAttachment#key InputAttachment.key}
  #     of the input to switch to.
  class InputSwitchTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Inserts a new ad opportunity.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Duration of an ad opportunity. Must be greater than 0.
  class AdBreakTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Inserts a slate.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Duration of the slate. Must be greater than 0 if specified.
  #     Omit this field for a long running slate.
  # @!attribute [rw] asset
  #   @return [::String]
  #     Slate asset to use for the duration. If its duration is less than the
  #     duration of the SlateTask, then the slate loops. The slate must be
  #     represented in the form of:
  #     `projects/{project}/locations/{location}/assets/{assetId}`.
  class SlateTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Stops any events which are currently running. This only applies to events
  # with a duration.
  class ReturnToProgramTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Mutes the stream.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Duration for which the stream should be muted. If omitted, the stream
  #     will be muted until an UnmuteTask event is sent.
  class MuteTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Unmutes the stream. The task fails if the stream is not currently muted.
  class UnmuteTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Update encryption settings.
  # @!attribute [rw] encryptions
  #   @return [::Array<::Google::Cloud::Video::LiveStream::V1::EncryptionUpdate>]
  #     Required. A list of
  #     {::Google::Cloud::Video::LiveStream::V1::EncryptionUpdate EncryptionUpdate}s
  #     that updates the existing encryption settings.
  class UpdateEncryptionsTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the event
  module State
    # Event state is not specified.
    STATE_UNSPECIFIED = 0

    # Event is scheduled but not executed yet.
    SCHEDULED = 1

    # Event is being executed.
    RUNNING = 2

    # Event has been successfully executed.
    SUCCEEDED = 3

    # Event fails to be executed.
    FAILED = 4

    # Event has been created but not scheduled yet.
    PENDING = 5

    # Event was stopped before running for its full duration.
    STOPPED = 6
  end
end

#return_to_program ⇒ ::Google::Cloud::Video::LiveStream::V1::Event::ReturnToProgramTask

Returns Stops any running ad break.

Note: The following fields are mutually exclusive: return_to_program, input_switch, ad_break, slate, mute, unmute, update_encryptions. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Video::LiveStream::V1::Event::ReturnToProgramTask) —

    Stops any running ad break.

    Note: The following fields are mutually exclusive: return_to_program, input_switch, ad_break, slate, mute, unmute, update_encryptions. If a field in that set is populated, all other fields in the set will automatically be cleared.



642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 642

class Event
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Switches to another input stream. Automatic failover is then disabled.
  # @!attribute [rw] input_key
  #   @return [::String]
  #     The
  #     {::Google::Cloud::Video::LiveStream::V1::InputAttachment#key InputAttachment.key}
  #     of the input to switch to.
  class InputSwitchTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Inserts a new ad opportunity.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Duration of an ad opportunity. Must be greater than 0.
  class AdBreakTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Inserts a slate.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Duration of the slate. Must be greater than 0 if specified.
  #     Omit this field for a long running slate.
  # @!attribute [rw] asset
  #   @return [::String]
  #     Slate asset to use for the duration. If its duration is less than the
  #     duration of the SlateTask, then the slate loops. The slate must be
  #     represented in the form of:
  #     `projects/{project}/locations/{location}/assets/{assetId}`.
  class SlateTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Stops any events which are currently running. This only applies to events
  # with a duration.
  class ReturnToProgramTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Mutes the stream.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Duration for which the stream should be muted. If omitted, the stream
  #     will be muted until an UnmuteTask event is sent.
  class MuteTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Unmutes the stream. The task fails if the stream is not currently muted.
  class UnmuteTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Update encryption settings.
  # @!attribute [rw] encryptions
  #   @return [::Array<::Google::Cloud::Video::LiveStream::V1::EncryptionUpdate>]
  #     Required. A list of
  #     {::Google::Cloud::Video::LiveStream::V1::EncryptionUpdate EncryptionUpdate}s
  #     that updates the existing encryption settings.
  class UpdateEncryptionsTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the event
  module State
    # Event state is not specified.
    STATE_UNSPECIFIED = 0

    # Event is scheduled but not executed yet.
    SCHEDULED = 1

    # Event is being executed.
    RUNNING = 2

    # Event has been successfully executed.
    SUCCEEDED = 3

    # Event fails to be executed.
    FAILED = 4

    # Event has been created but not scheduled yet.
    PENDING = 5

    # Event was stopped before running for its full duration.
    STOPPED = 6
  end
end

#slate ⇒ ::Google::Cloud::Video::LiveStream::V1::Event::SlateTask

Returns Inserts a slate.

Note: The following fields are mutually exclusive: slate, input_switch, ad_break, return_to_program, mute, unmute, update_encryptions. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Video::LiveStream::V1::Event::SlateTask) —

    Inserts a slate.

    Note: The following fields are mutually exclusive: slate, input_switch, ad_break, return_to_program, mute, unmute, update_encryptions. If a field in that set is populated, all other fields in the set will automatically be cleared.



642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 642

class Event
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Switches to another input stream. Automatic failover is then disabled.
  # @!attribute [rw] input_key
  #   @return [::String]
  #     The
  #     {::Google::Cloud::Video::LiveStream::V1::InputAttachment#key InputAttachment.key}
  #     of the input to switch to.
  class InputSwitchTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Inserts a new ad opportunity.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Duration of an ad opportunity. Must be greater than 0.
  class AdBreakTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Inserts a slate.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Duration of the slate. Must be greater than 0 if specified.
  #     Omit this field for a long running slate.
  # @!attribute [rw] asset
  #   @return [::String]
  #     Slate asset to use for the duration. If its duration is less than the
  #     duration of the SlateTask, then the slate loops. The slate must be
  #     represented in the form of:
  #     `projects/{project}/locations/{location}/assets/{assetId}`.
  class SlateTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Stops any events which are currently running. This only applies to events
  # with a duration.
  class ReturnToProgramTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Mutes the stream.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Duration for which the stream should be muted. If omitted, the stream
  #     will be muted until an UnmuteTask event is sent.
  class MuteTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Unmutes the stream. The task fails if the stream is not currently muted.
  class UnmuteTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Update encryption settings.
  # @!attribute [rw] encryptions
  #   @return [::Array<::Google::Cloud::Video::LiveStream::V1::EncryptionUpdate>]
  #     Required. A list of
  #     {::Google::Cloud::Video::LiveStream::V1::EncryptionUpdate EncryptionUpdate}s
  #     that updates the existing encryption settings.
  class UpdateEncryptionsTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the event
  module State
    # Event state is not specified.
    STATE_UNSPECIFIED = 0

    # Event is scheduled but not executed yet.
    SCHEDULED = 1

    # Event is being executed.
    RUNNING = 2

    # Event has been successfully executed.
    SUCCEEDED = 3

    # Event fails to be executed.
    FAILED = 4

    # Event has been created but not scheduled yet.
    PENDING = 5

    # Event was stopped before running for its full duration.
    STOPPED = 6
  end
end

#state ⇒ ::Google::Cloud::Video::LiveStream::V1::Event::State (readonly)

Returns Output only. The state of the event.

Returns:



642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 642

class Event
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Switches to another input stream. Automatic failover is then disabled.
  # @!attribute [rw] input_key
  #   @return [::String]
  #     The
  #     {::Google::Cloud::Video::LiveStream::V1::InputAttachment#key InputAttachment.key}
  #     of the input to switch to.
  class InputSwitchTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Inserts a new ad opportunity.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Duration of an ad opportunity. Must be greater than 0.
  class AdBreakTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Inserts a slate.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Duration of the slate. Must be greater than 0 if specified.
  #     Omit this field for a long running slate.
  # @!attribute [rw] asset
  #   @return [::String]
  #     Slate asset to use for the duration. If its duration is less than the
  #     duration of the SlateTask, then the slate loops. The slate must be
  #     represented in the form of:
  #     `projects/{project}/locations/{location}/assets/{assetId}`.
  class SlateTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Stops any events which are currently running. This only applies to events
  # with a duration.
  class ReturnToProgramTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Mutes the stream.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Duration for which the stream should be muted. If omitted, the stream
  #     will be muted until an UnmuteTask event is sent.
  class MuteTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Unmutes the stream. The task fails if the stream is not currently muted.
  class UnmuteTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Update encryption settings.
  # @!attribute [rw] encryptions
  #   @return [::Array<::Google::Cloud::Video::LiveStream::V1::EncryptionUpdate>]
  #     Required. A list of
  #     {::Google::Cloud::Video::LiveStream::V1::EncryptionUpdate EncryptionUpdate}s
  #     that updates the existing encryption settings.
  class UpdateEncryptionsTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the event
  module State
    # Event state is not specified.
    STATE_UNSPECIFIED = 0

    # Event is scheduled but not executed yet.
    SCHEDULED = 1

    # Event is being executed.
    RUNNING = 2

    # Event has been successfully executed.
    SUCCEEDED = 3

    # Event fails to be executed.
    FAILED = 4

    # Event has been created but not scheduled yet.
    PENDING = 5

    # Event was stopped before running for its full duration.
    STOPPED = 6
  end
end

#unmute ⇒ ::Google::Cloud::Video::LiveStream::V1::Event::UnmuteTask

Returns Unmutes the stream.

Note: The following fields are mutually exclusive: unmute, input_switch, ad_break, return_to_program, slate, mute, update_encryptions. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Video::LiveStream::V1::Event::UnmuteTask) —

    Unmutes the stream.

    Note: The following fields are mutually exclusive: unmute, input_switch, ad_break, return_to_program, slate, mute, update_encryptions. If a field in that set is populated, all other fields in the set will automatically be cleared.



642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 642

class Event
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Switches to another input stream. Automatic failover is then disabled.
  # @!attribute [rw] input_key
  #   @return [::String]
  #     The
  #     {::Google::Cloud::Video::LiveStream::V1::InputAttachment#key InputAttachment.key}
  #     of the input to switch to.
  class InputSwitchTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Inserts a new ad opportunity.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Duration of an ad opportunity. Must be greater than 0.
  class AdBreakTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Inserts a slate.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Duration of the slate. Must be greater than 0 if specified.
  #     Omit this field for a long running slate.
  # @!attribute [rw] asset
  #   @return [::String]
  #     Slate asset to use for the duration. If its duration is less than the
  #     duration of the SlateTask, then the slate loops. The slate must be
  #     represented in the form of:
  #     `projects/{project}/locations/{location}/assets/{assetId}`.
  class SlateTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Stops any events which are currently running. This only applies to events
  # with a duration.
  class ReturnToProgramTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Mutes the stream.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Duration for which the stream should be muted. If omitted, the stream
  #     will be muted until an UnmuteTask event is sent.
  class MuteTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Unmutes the stream. The task fails if the stream is not currently muted.
  class UnmuteTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Update encryption settings.
  # @!attribute [rw] encryptions
  #   @return [::Array<::Google::Cloud::Video::LiveStream::V1::EncryptionUpdate>]
  #     Required. A list of
  #     {::Google::Cloud::Video::LiveStream::V1::EncryptionUpdate EncryptionUpdate}s
  #     that updates the existing encryption settings.
  class UpdateEncryptionsTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the event
  module State
    # Event state is not specified.
    STATE_UNSPECIFIED = 0

    # Event is scheduled but not executed yet.
    SCHEDULED = 1

    # Event is being executed.
    RUNNING = 2

    # Event has been successfully executed.
    SUCCEEDED = 3

    # Event fails to be executed.
    FAILED = 4

    # Event has been created but not scheduled yet.
    PENDING = 5

    # Event was stopped before running for its full duration.
    STOPPED = 6
  end
end

#update_encryptions ⇒ ::Google::Cloud::Video::LiveStream::V1::Event::UpdateEncryptionsTask

Returns Updates encryption settings.

Note: The following fields are mutually exclusive: update_encryptions, input_switch, ad_break, return_to_program, slate, mute, unmute. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 642

class Event
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Switches to another input stream. Automatic failover is then disabled.
  # @!attribute [rw] input_key
  #   @return [::String]
  #     The
  #     {::Google::Cloud::Video::LiveStream::V1::InputAttachment#key InputAttachment.key}
  #     of the input to switch to.
  class InputSwitchTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Inserts a new ad opportunity.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Duration of an ad opportunity. Must be greater than 0.
  class AdBreakTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Inserts a slate.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Duration of the slate. Must be greater than 0 if specified.
  #     Omit this field for a long running slate.
  # @!attribute [rw] asset
  #   @return [::String]
  #     Slate asset to use for the duration. If its duration is less than the
  #     duration of the SlateTask, then the slate loops. The slate must be
  #     represented in the form of:
  #     `projects/{project}/locations/{location}/assets/{assetId}`.
  class SlateTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Stops any events which are currently running. This only applies to events
  # with a duration.
  class ReturnToProgramTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Mutes the stream.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Duration for which the stream should be muted. If omitted, the stream
  #     will be muted until an UnmuteTask event is sent.
  class MuteTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Unmutes the stream. The task fails if the stream is not currently muted.
  class UnmuteTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Update encryption settings.
  # @!attribute [rw] encryptions
  #   @return [::Array<::Google::Cloud::Video::LiveStream::V1::EncryptionUpdate>]
  #     Required. A list of
  #     {::Google::Cloud::Video::LiveStream::V1::EncryptionUpdate EncryptionUpdate}s
  #     that updates the existing encryption settings.
  class UpdateEncryptionsTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the event
  module State
    # Event state is not specified.
    STATE_UNSPECIFIED = 0

    # Event is scheduled but not executed yet.
    SCHEDULED = 1

    # Event is being executed.
    RUNNING = 2

    # Event has been successfully executed.
    SUCCEEDED = 3

    # Event fails to be executed.
    FAILED = 4

    # Event has been created but not scheduled yet.
    PENDING = 5

    # Event was stopped before running for its full duration.
    STOPPED = 6
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The update time.

Returns:



642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 642

class Event
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Switches to another input stream. Automatic failover is then disabled.
  # @!attribute [rw] input_key
  #   @return [::String]
  #     The
  #     {::Google::Cloud::Video::LiveStream::V1::InputAttachment#key InputAttachment.key}
  #     of the input to switch to.
  class InputSwitchTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Inserts a new ad opportunity.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Duration of an ad opportunity. Must be greater than 0.
  class AdBreakTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Inserts a slate.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Optional. Duration of the slate. Must be greater than 0 if specified.
  #     Omit this field for a long running slate.
  # @!attribute [rw] asset
  #   @return [::String]
  #     Slate asset to use for the duration. If its duration is less than the
  #     duration of the SlateTask, then the slate loops. The slate must be
  #     represented in the form of:
  #     `projects/{project}/locations/{location}/assets/{assetId}`.
  class SlateTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Stops any events which are currently running. This only applies to events
  # with a duration.
  class ReturnToProgramTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Mutes the stream.
  # @!attribute [rw] duration
  #   @return [::Google::Protobuf::Duration]
  #     Duration for which the stream should be muted. If omitted, the stream
  #     will be muted until an UnmuteTask event is sent.
  class MuteTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Unmutes the stream. The task fails if the stream is not currently muted.
  class UnmuteTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Update encryption settings.
  # @!attribute [rw] encryptions
  #   @return [::Array<::Google::Cloud::Video::LiveStream::V1::EncryptionUpdate>]
  #     Required. A list of
  #     {::Google::Cloud::Video::LiveStream::V1::EncryptionUpdate EncryptionUpdate}s
  #     that updates the existing encryption settings.
  class UpdateEncryptionsTask
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the event
  module State
    # Event state is not specified.
    STATE_UNSPECIFIED = 0

    # Event is scheduled but not executed yet.
    SCHEDULED = 1

    # Event is being executed.
    RUNNING = 2

    # Event has been successfully executed.
    SUCCEEDED = 3

    # Event fails to be executed.
    FAILED = 4

    # Event has been created but not scheduled yet.
    PENDING = 5

    # Event was stopped before running for its full duration.
    STOPPED = 6
  end
end