Class: Google::Cloud::Video::LiveStream::V1::Event
- Inherits:
-
Object
- Object
- Google::Cloud::Video::LiveStream::V1::Event
- 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
Instance Attribute Summary collapse
-
#ad_break ⇒ ::Google::Cloud::Video::LiveStream::V1::Event::AdBreakTask
Inserts a new ad opportunity.
-
#create_time ⇒ ::Google::Protobuf::Timestamp
readonly
Output only.
-
#error ⇒ ::Google::Rpc::Status
readonly
Output only.
-
#execute_now ⇒ ::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.
-
#execution_time ⇒ ::Google::Protobuf::Timestamp
The time to execute the event.
-
#input_switch ⇒ ::Google::Cloud::Video::LiveStream::V1::Event::InputSwitchTask
Switches to another input stream.
-
#labels ⇒ ::Google::Protobuf::Map{::String => ::String}
User-defined key/value metadata.
-
#mute ⇒ ::Google::Cloud::Video::LiveStream::V1::Event::MuteTask
Mutes the stream.
-
#name ⇒ ::String
The resource name of the event, in the form of:
projects/{project}/locations/{location}/channels/{channelId}/events/{eventId}
. -
#return_to_program ⇒ ::Google::Cloud::Video::LiveStream::V1::Event::ReturnToProgramTask
Stops any running ad break.
-
#slate ⇒ ::Google::Cloud::Video::LiveStream::V1::Event::SlateTask
Inserts a slate.
-
#state ⇒ ::Google::Cloud::Video::LiveStream::V1::Event::State
readonly
Output only.
-
#unmute ⇒ ::Google::Cloud::Video::LiveStream::V1::Event::UnmuteTask
Unmutes the stream.
-
#update_time ⇒ ::Google::Protobuf::Timestamp
readonly
Output only.
Instance Attribute Details
#ad_break ⇒ ::Google::Cloud::Video::LiveStream::V1::Event::AdBreakTask
Returns Inserts a new ad opportunity.
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 |
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 560 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 # @!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.
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 |
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 560 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 # @!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
.
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 |
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 560 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 # @!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.
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 |
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 560 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 # @!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.
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 |
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 560 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 # @!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.
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 |
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 560 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 # @!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.
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 |
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 560 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 # @!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.
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 |
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 560 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 # @!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}
.
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 |
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 560 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 # @!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.
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 |
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 560 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 # @!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.
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 |
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 560 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 # @!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.
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 |
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 560 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 # @!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.
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 |
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 560 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 # @!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.
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 |
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 560 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 # @!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 |