Interface EventOrBuilder (0.20.0)

Version 0.20.0

• 0.55.0 (latest)
• 0.54.0
• 0.53.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.8
• 0.3.0

public interface EventOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

User-defined key/value metadata.

map<string, string> labels = 4;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAdBreak()

public abstract Event.AdBreakTask getAdBreak()

Required. Inserts a new ad opportunity.

.google.cloud.video.livestream.v1.Event.AdBreakTask ad_break = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Event.AdBreakTask	The adBreak.

getAdBreakOrBuilder()

public abstract Event.AdBreakTaskOrBuilder getAdBreakOrBuilder()

Required. Inserts a new ad opportunity.

.google.cloud.video.livestream.v1.Event.AdBreakTask ad_break = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Event.AdBreakTaskOrBuilder

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The creation time.

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

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The creation time.

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

Returns
Type	Description
TimestampOrBuilder

getError()

public abstract 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
Type	Description
com.google.rpc.Status	The error.

getErrorOrBuilder()

public abstract 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
Type	Description
com.google.rpc.StatusOrBuilder

getExecuteNow()

public abstract 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
Type	Description
boolean	The executeNow.

getExecutionTime()

public abstract 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
Type	Description
Timestamp	The executionTime.

getExecutionTimeOrBuilder()

public abstract 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
Type	Description
TimestampOrBuilder

getInputSwitch()

public abstract Event.InputSwitchTask getInputSwitch()

Required. Switches to another input stream.

.google.cloud.video.livestream.v1.Event.InputSwitchTask input_switch = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Event.InputSwitchTask	The inputSwitch.

getInputSwitchOrBuilder()

public abstract Event.InputSwitchTaskOrBuilder getInputSwitchOrBuilder()

Required. Switches to another input stream.

.google.cloud.video.livestream.v1.Event.InputSwitchTask input_switch = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Event.InputSwitchTaskOrBuilder

getLabels()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

User-defined key/value metadata.

map<string, string> labels = 4;

Returns
Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

User-defined key/value metadata.

map<string, string> labels = 4;

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

User-defined key/value metadata.

map<string, string> labels = 4;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

User-defined key/value metadata.

map<string, string> labels = 4;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getMute()

public abstract Event.MuteTask getMute()

Required. Mutes the stream.

.google.cloud.video.livestream.v1.Event.MuteTask mute = 15 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Event.MuteTask	The mute.

getMuteOrBuilder()

public abstract Event.MuteTaskOrBuilder getMuteOrBuilder()

Required. Mutes the stream.

.google.cloud.video.livestream.v1.Event.MuteTask mute = 15 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Event.MuteTaskOrBuilder

getName()

public abstract String getName()

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

string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

string name = 1;

Returns
Type	Description
ByteString	The bytes for name.

getReturnToProgram()

public abstract Event.ReturnToProgramTask getReturnToProgram()

Required. Stops any running ad break.

.google.cloud.video.livestream.v1.Event.ReturnToProgramTask return_to_program = 13 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Event.ReturnToProgramTask	The returnToProgram.

getReturnToProgramOrBuilder()

public abstract Event.ReturnToProgramTaskOrBuilder getReturnToProgramOrBuilder()

Required. Stops any running ad break.

.google.cloud.video.livestream.v1.Event.ReturnToProgramTask return_to_program = 13 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Event.ReturnToProgramTaskOrBuilder

getState()

public abstract 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
Type	Description
Event.State	The state.

getStateValue()

public abstract 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
Type	Description
int	The enum numeric value on the wire for state.

getTaskCase()

public abstract Event.TaskCase getTaskCase()

Returns
Type	Description
Event.TaskCase

getUnmute()

public abstract Event.UnmuteTask getUnmute()

Required. Unmutes the stream.

.google.cloud.video.livestream.v1.Event.UnmuteTask unmute = 16 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Event.UnmuteTask	The unmute.

getUnmuteOrBuilder()

public abstract Event.UnmuteTaskOrBuilder getUnmuteOrBuilder()

Required. Unmutes the stream.

.google.cloud.video.livestream.v1.Event.UnmuteTask unmute = 16 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Event.UnmuteTaskOrBuilder

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. The update time.

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

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The update time.

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

Returns
Type	Description
TimestampOrBuilder

hasAdBreak()

public abstract boolean hasAdBreak()

Required. Inserts a new ad opportunity.

.google.cloud.video.livestream.v1.Event.AdBreakTask ad_break = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the adBreak field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The creation time.

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

Returns
Type	Description
boolean	Whether the createTime field is set.

hasError()

public abstract 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
Type	Description
boolean	Whether the error field is set.

hasExecutionTime()

public abstract 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
Type	Description
boolean	Whether the executionTime field is set.

hasInputSwitch()

public abstract boolean hasInputSwitch()

Required. Switches to another input stream.

.google.cloud.video.livestream.v1.Event.InputSwitchTask input_switch = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the inputSwitch field is set.

hasMute()

public abstract boolean hasMute()

Required. Mutes the stream.

.google.cloud.video.livestream.v1.Event.MuteTask mute = 15 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the mute field is set.

hasReturnToProgram()

public abstract boolean hasReturnToProgram()

Required. Stops any running ad break.

.google.cloud.video.livestream.v1.Event.ReturnToProgramTask return_to_program = 13 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the returnToProgram field is set.

hasUnmute()

public abstract boolean hasUnmute()

Required. Unmutes the stream.

.google.cloud.video.livestream.v1.Event.UnmuteTask unmute = 16 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the unmute field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. The update time.

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

Returns
Type	Description
boolean	Whether the updateTime field is set.