Struct google_api_proto::google::cloud::video::livestream::v1::Event

pub struct Event {
    pub name: String,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub labels: BTreeMap<String, String>,
    pub execute_now: bool,
    pub execution_time: Option<Timestamp>,
    pub state: i32,
    pub error: Option<Status>,
    pub task: Option<Task>,
}

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.

Fields

name: String

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

create_time: Option<Timestamp>

Output only. The creation time.

update_time: Option<Timestamp>

Output only. The update time.

labels: BTreeMap<String, String>

User-defined key/value metadata.

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][google.cloud.video.livestream.v1.Event.execution_time] will be populated with the time that the server actually schedules the event.

execution_time: Option<Timestamp>

The time to execute the event. If you set [execute_now][google.cloud.video.livestream.v1.Event.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][google.cloud.video.livestream.v1.Event.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.

state: i32

Output only. The state of the event.

error: Option<Status>

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

task: Option<Task>

Required. Operation to be executed by this event.

Implementations

impl Event

pub fn state(&self) -> State

Returns the enum value of state, or the default if the field is set to an invalid enum value.

pub fn set_state(&mut self, value: State)

Sets state to the provided enum value.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Event

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Event

fn default() -> Self

Returns the “default value” for a type.

impl Message for Event

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Event

fn eq(&self, other: &Event) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Event