Interface EventOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
Event,Event.Builder
@Generated
public interface EventOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionbooleancontainsLabels(String key) User-defined key/value metadata.Inserts a new ad opportunity.Inserts a new ad opportunity.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.getError()Output only.Output only.booleanWhen 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.com.google.protobuf.TimestampThe time to execute the event.com.google.protobuf.TimestampOrBuilderThe time to execute the event.Switches to another input stream.Switches to another input stream.Deprecated.intUser-defined key/value metadata.User-defined key/value metadata.getLabelsOrDefault(String key, String defaultValue) User-defined key/value metadata.getLabelsOrThrow(String key) User-defined key/value metadata.getMute()Mutes the stream.Mutes the stream.getName()The resource name of the event, in the form of: `projects/{project}/locations/{location}/channels/{channelId}/events/{eventId}`.com.google.protobuf.ByteStringThe resource name of the event, in the form of: `projects/{project}/locations/{location}/channels/{channelId}/events/{eventId}`.Stops any running ad break.Stops any running ad break.getSlate()Inserts a slate.Inserts a slate.getState()Output only.intOutput only.Unmutes the stream.Unmutes the stream.Updates encryption settings.Updates encryption settings.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.booleanInserts a new ad opportunity.booleanOutput only.booleanhasError()Output only.booleanThe time to execute the event.booleanSwitches to another input stream.booleanhasMute()Mutes the stream.booleanStops any running ad break.booleanhasSlate()Inserts a slate.booleanUnmutes the stream.booleanUpdates encryption settings.booleanOutput only.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getName
String getName()The resource name of the event, in the form of: `projects/{project}/locations/{location}/channels/{channelId}/events/{eventId}`.string name = 1;- Returns:
- The name.
-
getNameBytes
com.google.protobuf.ByteString getNameBytes()The resource name of the event, in the form of: `projects/{project}/locations/{location}/channels/{channelId}/events/{eventId}`.string name = 1;- Returns:
- The bytes for name.
-
hasCreateTime
boolean hasCreateTime()Output only. The creation time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the createTime field is set.
-
getCreateTime
com.google.protobuf.Timestamp getCreateTime()Output only. The creation time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The createTime.
-
getCreateTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()Output only. The creation time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
hasUpdateTime
boolean hasUpdateTime()Output only. The update time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the updateTime field is set.
-
getUpdateTime
com.google.protobuf.Timestamp getUpdateTime()Output only. The update time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The updateTime.
-
getUpdateTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()Output only. The update time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getLabelsCount
int getLabelsCount()User-defined key/value metadata.
map<string, string> labels = 4; -
containsLabels
User-defined key/value metadata.
map<string, string> labels = 4; -
getLabels
Deprecated.UsegetLabelsMap()instead. -
getLabelsMap
User-defined key/value metadata.
map<string, string> labels = 4; -
getLabelsOrDefault
User-defined key/value metadata.
map<string, string> labels = 4; -
getLabelsOrThrow
User-defined key/value metadata.
map<string, string> labels = 4; -
hasInputSwitch
boolean hasInputSwitch()Switches to another input stream.
.google.cloud.video.livestream.v1.Event.InputSwitchTask input_switch = 5;- Returns:
- Whether the inputSwitch field is set.
-
getInputSwitch
Event.InputSwitchTask getInputSwitch()Switches to another input stream.
.google.cloud.video.livestream.v1.Event.InputSwitchTask input_switch = 5;- Returns:
- The inputSwitch.
-
getInputSwitchOrBuilder
Event.InputSwitchTaskOrBuilder getInputSwitchOrBuilder()Switches to another input stream.
.google.cloud.video.livestream.v1.Event.InputSwitchTask input_switch = 5; -
hasAdBreak
boolean hasAdBreak()Inserts a new ad opportunity.
.google.cloud.video.livestream.v1.Event.AdBreakTask ad_break = 6;- Returns:
- Whether the adBreak field is set.
-
getAdBreak
Event.AdBreakTask getAdBreak()Inserts a new ad opportunity.
.google.cloud.video.livestream.v1.Event.AdBreakTask ad_break = 6;- Returns:
- The adBreak.
-
getAdBreakOrBuilder
Event.AdBreakTaskOrBuilder getAdBreakOrBuilder()Inserts a new ad opportunity.
.google.cloud.video.livestream.v1.Event.AdBreakTask ad_break = 6; -
hasReturnToProgram
boolean hasReturnToProgram()Stops any running ad break.
.google.cloud.video.livestream.v1.Event.ReturnToProgramTask return_to_program = 13;- Returns:
- Whether the returnToProgram field is set.
-
getReturnToProgram
Event.ReturnToProgramTask getReturnToProgram()Stops any running ad break.
.google.cloud.video.livestream.v1.Event.ReturnToProgramTask return_to_program = 13;- Returns:
- The returnToProgram.
-
getReturnToProgramOrBuilder
Event.ReturnToProgramTaskOrBuilder getReturnToProgramOrBuilder()Stops any running ad break.
.google.cloud.video.livestream.v1.Event.ReturnToProgramTask return_to_program = 13; -
hasSlate
boolean hasSlate()Inserts a slate.
.google.cloud.video.livestream.v1.Event.SlateTask slate = 14;- Returns:
- Whether the slate field is set.
-
getSlate
Event.SlateTask getSlate()Inserts a slate.
.google.cloud.video.livestream.v1.Event.SlateTask slate = 14;- Returns:
- The slate.
-
getSlateOrBuilder
Event.SlateTaskOrBuilder getSlateOrBuilder()Inserts a slate.
.google.cloud.video.livestream.v1.Event.SlateTask slate = 14; -
hasMute
boolean hasMute()Mutes the stream.
.google.cloud.video.livestream.v1.Event.MuteTask mute = 15;- Returns:
- Whether the mute field is set.
-
getMute
Event.MuteTask getMute()Mutes the stream.
.google.cloud.video.livestream.v1.Event.MuteTask mute = 15;- Returns:
- The mute.
-
getMuteOrBuilder
Event.MuteTaskOrBuilder getMuteOrBuilder()Mutes the stream.
.google.cloud.video.livestream.v1.Event.MuteTask mute = 15; -
hasUnmute
boolean hasUnmute()Unmutes the stream.
.google.cloud.video.livestream.v1.Event.UnmuteTask unmute = 16;- Returns:
- Whether the unmute field is set.
-
getUnmute
Event.UnmuteTask getUnmute()Unmutes the stream.
.google.cloud.video.livestream.v1.Event.UnmuteTask unmute = 16;- Returns:
- The unmute.
-
getUnmuteOrBuilder
Event.UnmuteTaskOrBuilder getUnmuteOrBuilder()Unmutes the stream.
.google.cloud.video.livestream.v1.Event.UnmuteTask unmute = 16; -
hasUpdateEncryptions
boolean hasUpdateEncryptions()Updates encryption settings.
.google.cloud.video.livestream.v1.Event.UpdateEncryptionsTask update_encryptions = 17;- Returns:
- Whether the updateEncryptions field is set.
-
getUpdateEncryptions
Event.UpdateEncryptionsTask getUpdateEncryptions()Updates encryption settings.
.google.cloud.video.livestream.v1.Event.UpdateEncryptionsTask update_encryptions = 17;- Returns:
- The updateEncryptions.
-
getUpdateEncryptionsOrBuilder
Event.UpdateEncryptionsTaskOrBuilder getUpdateEncryptionsOrBuilder()Updates encryption settings.
.google.cloud.video.livestream.v1.Event.UpdateEncryptionsTask update_encryptions = 17; -
getExecuteNow
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][google.cloud.video.livestream.v1.Event.execution_time] will be populated with the time that the server actually schedules the event.
bool execute_now = 9;- Returns:
- The executeNow.
-
hasExecutionTime
boolean hasExecutionTime()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.
.google.protobuf.Timestamp execution_time = 10;- Returns:
- Whether the executionTime field is set.
-
getExecutionTime
com.google.protobuf.Timestamp getExecutionTime()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.
.google.protobuf.Timestamp execution_time = 10;- Returns:
- The executionTime.
-
getExecutionTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getExecutionTimeOrBuilder()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.
.google.protobuf.Timestamp execution_time = 10; -
getStateValue
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:
- The enum numeric value on the wire for state.
-
getState
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:
- The state.
-
hasError
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:
- Whether the error field is set.
-
getError
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:
- The error.
-
getErrorOrBuilder
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]; -
getTaskCase
Event.TaskCase getTaskCase()
-