Class Event (1.2.1)

Event(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

NameDescription
name str
The resource name of the event, in the form of: projects/{project}/locations/{location}/channels/{channelId}/events/{eventId}.
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. The creation time.
update_time google.protobuf.timestamp_pb2.Timestamp
Output only. The update time.
labels MutableMapping[str, str]
User-defined key/value metadata.
ad_break google.cloud.video.live_stream_v1.types.Event.AdBreakTask
Required. Inserts a new ad opportunity. This field is a member of oneof_ task.
execute_now bool
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_pb2.Timestamp
The time when the event should be executed. When execute_now is set to true, this field should not be set in CreateEvent request and will be populated with the time that the server schedules the event.
state google.cloud.video.live_stream_v1.types.Event.State
Output only. The state of the event.
error google.rpc.status_pb2.Status
Output only. An error object that describes the reason for the failure. This property is always present when state is FAILED.

Classes

AdBreakTask

AdBreakTask(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Inserts a new ad opportunity.

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
NameDescription
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

State

State(value)

State of the event

Values: STATE_UNSPECIFIED (0): Event state is not specified. SCHEDULED (1): Event is scheduled but not executed yet. RUNNING (2): Event is being executed. SUCCEEDED (3): Event has been successfully executed. FAILED (4): Event fails to be executed. PENDING (5): Event has been created but not scheduled yet. STOPPED (6): Event was stopped before running for its full duration.