Class Event (0.26.0)

public final class Event extends GeneratedMessageV3 implements EventOrBuilder

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.

Protobuf type google.cloud.video.livestream.v1.Event

Implements

EventOrBuilder

Static Fields

AD_BREAK_FIELD_NUMBER

public static final int AD_BREAK_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER
Field Value
TypeDescription
int

EXECUTE_NOW_FIELD_NUMBER

public static final int EXECUTE_NOW_FIELD_NUMBER
Field Value
TypeDescription
int

EXECUTION_TIME_FIELD_NUMBER

public static final int EXECUTION_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

INPUT_SWITCH_FIELD_NUMBER

public static final int INPUT_SWITCH_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

MUTE_FIELD_NUMBER

public static final int MUTE_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

RETURN_TO_PROGRAM_FIELD_NUMBER

public static final int RETURN_TO_PROGRAM_FIELD_NUMBER
Field Value
TypeDescription
int

SLATE_FIELD_NUMBER

public static final int SLATE_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

UNMUTE_FIELD_NUMBER

public static final int UNMUTE_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Event getDefaultInstance()
Returns
TypeDescription
Event

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Event.Builder newBuilder()
Returns
TypeDescription
Event.Builder

newBuilder(Event prototype)

public static Event.Builder newBuilder(Event prototype)
Parameter
NameDescription
prototypeEvent
Returns
TypeDescription
Event.Builder

parseDelimitedFrom(InputStream input)

public static Event parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Event
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Event parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Event
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Event parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Event
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Event parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Event
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Event parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Event
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Event parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Event
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Event parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Event
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Event parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Event
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Event parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Event
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Event parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Event
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Event parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Event
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Event parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Event
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Event> parser()
Returns
TypeDescription
Parser<Event>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

User-defined key/value metadata.

map<string, string> labels = 4;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAdBreak()

public Event.AdBreakTask getAdBreak()

Inserts a new ad opportunity.

.google.cloud.video.livestream.v1.Event.AdBreakTask ad_break = 6;

Returns
TypeDescription
Event.AdBreakTask

The adBreak.

getAdBreakOrBuilder()

public Event.AdBreakTaskOrBuilder getAdBreakOrBuilder()

Inserts a new ad opportunity.

.google.cloud.video.livestream.v1.Event.AdBreakTask ad_break = 6;

Returns
TypeDescription
Event.AdBreakTaskOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. The creation time.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The creation time.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Event getDefaultInstanceForType()
Returns
TypeDescription
Event

getError()

public Status getError()

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

.google.rpc.Status error = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
com.google.rpc.Status

The error.

getErrorOrBuilder()

public StatusOrBuilder getErrorOrBuilder()

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

.google.rpc.Status error = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
com.google.rpc.StatusOrBuilder

getExecuteNow()

public boolean getExecuteNow()

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.

bool execute_now = 9;

Returns
TypeDescription
boolean

The executeNow.

getExecutionTime()

public Timestamp getExecutionTime()

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.

.google.protobuf.Timestamp execution_time = 10;

Returns
TypeDescription
Timestamp

The executionTime.

getExecutionTimeOrBuilder()

public TimestampOrBuilder getExecutionTimeOrBuilder()

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.

.google.protobuf.Timestamp execution_time = 10;

Returns
TypeDescription
TimestampOrBuilder

getInputSwitch()

public Event.InputSwitchTask getInputSwitch()

Switches to another input stream.

.google.cloud.video.livestream.v1.Event.InputSwitchTask input_switch = 5;

Returns
TypeDescription
Event.InputSwitchTask

The inputSwitch.

getInputSwitchOrBuilder()

public Event.InputSwitchTaskOrBuilder getInputSwitchOrBuilder()

Switches to another input stream.

.google.cloud.video.livestream.v1.Event.InputSwitchTask input_switch = 5;

Returns
TypeDescription
Event.InputSwitchTaskOrBuilder

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

User-defined key/value metadata.

map<string, string> labels = 4;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

User-defined key/value metadata.

map<string, string> labels = 4;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

User-defined key/value metadata.

map<string, string> labels = 4;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

User-defined key/value metadata.

map<string, string> labels = 4;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getMute()

public Event.MuteTask getMute()

Mutes the stream.

.google.cloud.video.livestream.v1.Event.MuteTask mute = 15;

Returns
TypeDescription
Event.MuteTask

The mute.

getMuteOrBuilder()

public Event.MuteTaskOrBuilder getMuteOrBuilder()

Mutes the stream.

.google.cloud.video.livestream.v1.Event.MuteTask mute = 15;

Returns
TypeDescription
Event.MuteTaskOrBuilder

getName()

public String getName()

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

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Event> getParserForType()
Returns
TypeDescription
Parser<Event>
Overrides

getReturnToProgram()

public Event.ReturnToProgramTask getReturnToProgram()

Stops any running ad break.

.google.cloud.video.livestream.v1.Event.ReturnToProgramTask return_to_program = 13;

Returns
TypeDescription
Event.ReturnToProgramTask

The returnToProgram.

getReturnToProgramOrBuilder()

public Event.ReturnToProgramTaskOrBuilder getReturnToProgramOrBuilder()

Stops any running ad break.

.google.cloud.video.livestream.v1.Event.ReturnToProgramTask return_to_program = 13;

Returns
TypeDescription
Event.ReturnToProgramTaskOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSlate()

public Event.SlateTask getSlate()

Inserts a slate.

.google.cloud.video.livestream.v1.Event.SlateTask slate = 14;

Returns
TypeDescription
Event.SlateTask

The slate.

getSlateOrBuilder()

public Event.SlateTaskOrBuilder getSlateOrBuilder()

Inserts a slate.

.google.cloud.video.livestream.v1.Event.SlateTask slate = 14;

Returns
TypeDescription
Event.SlateTaskOrBuilder

getState()

public Event.State getState()

Output only. The state of the event.

.google.cloud.video.livestream.v1.Event.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Event.State

The state.

getStateValue()

public int getStateValue()

Output only. The state of the event.

.google.cloud.video.livestream.v1.Event.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getTaskCase()

public Event.TaskCase getTaskCase()
Returns
TypeDescription
Event.TaskCase

getUnmute()

public Event.UnmuteTask getUnmute()

Unmutes the stream.

.google.cloud.video.livestream.v1.Event.UnmuteTask unmute = 16;

Returns
TypeDescription
Event.UnmuteTask

The unmute.

getUnmuteOrBuilder()

public Event.UnmuteTaskOrBuilder getUnmuteOrBuilder()

Unmutes the stream.

.google.cloud.video.livestream.v1.Event.UnmuteTask unmute = 16;

Returns
TypeDescription
Event.UnmuteTaskOrBuilder

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The update time.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The update time.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

hasAdBreak()

public boolean hasAdBreak()

Inserts a new ad opportunity.

.google.cloud.video.livestream.v1.Event.AdBreakTask ad_break = 6;

Returns
TypeDescription
boolean

Whether the adBreak field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. The creation time.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasError()

public boolean hasError()

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

.google.rpc.Status error = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the error field is set.

hasExecutionTime()

public boolean hasExecutionTime()

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.

.google.protobuf.Timestamp execution_time = 10;

Returns
TypeDescription
boolean

Whether the executionTime field is set.

hasInputSwitch()

public boolean hasInputSwitch()

Switches to another input stream.

.google.cloud.video.livestream.v1.Event.InputSwitchTask input_switch = 5;

Returns
TypeDescription
boolean

Whether the inputSwitch field is set.

hasMute()

public boolean hasMute()

Mutes the stream.

.google.cloud.video.livestream.v1.Event.MuteTask mute = 15;

Returns
TypeDescription
boolean

Whether the mute field is set.

hasReturnToProgram()

public boolean hasReturnToProgram()

Stops any running ad break.

.google.cloud.video.livestream.v1.Event.ReturnToProgramTask return_to_program = 13;

Returns
TypeDescription
boolean

Whether the returnToProgram field is set.

hasSlate()

public boolean hasSlate()

Inserts a slate.

.google.cloud.video.livestream.v1.Event.SlateTask slate = 14;

Returns
TypeDescription
boolean

Whether the slate field is set.

hasUnmute()

public boolean hasUnmute()

Unmutes the stream.

.google.cloud.video.livestream.v1.Event.UnmuteTask unmute = 16;

Returns
TypeDescription
boolean

Whether the unmute field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The update time.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Event.Builder newBuilderForType()
Returns
TypeDescription
Event.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Event.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Event.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Event.Builder toBuilder()
Returns
TypeDescription
Event.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException