Package com.google.cloud.video.livestream.v1

Class Event

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.video.livestream.v1.Event
All Implemented Interfaces:
EventOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Event extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getTaskCase

      public Event.TaskCase getTaskCase()
      Specified by:
      getTaskCase in interface EventOrBuilder

    • 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;
      Specified by:
      getName in interface EventOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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;
      Specified by:
      getNameBytes in interface EventOrBuilder
      Returns:
      The bytes for name.

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. The creation time.
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface EventOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. The creation time.
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface EventOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The creation time.
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface EventOrBuilder

    • hasUpdateTime

      public boolean hasUpdateTime()
       Output only. The update time.
      .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasUpdateTime in interface EventOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public com.google.protobuf.Timestamp getUpdateTime()
       Output only. The update time.
      .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTime in interface EventOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. The update time.
      .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface EventOrBuilder

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: EventOrBuilder
       User-defined key/value metadata.
      map<string, string> labels = 4;
      Specified by:
      getLabelsCount in interface EventOrBuilder

    • containsLabels

      public boolean containsLabels(String key)
       User-defined key/value metadata.
      map<string, string> labels = 4;
      Specified by:
      containsLabels in interface EventOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface EventOrBuilder

    • getLabelsMap

      public Map<String,String> getLabelsMap()
       User-defined key/value metadata.
      map<string, string> labels = 4;
      Specified by:
      getLabelsMap in interface EventOrBuilder

    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       User-defined key/value metadata.
      map<string, string> labels = 4;
      Specified by:
      getLabelsOrDefault in interface EventOrBuilder

    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       User-defined key/value metadata.
      map<string, string> labels = 4;
      Specified by:
      getLabelsOrThrow in interface EventOrBuilder

    • hasInputSwitch

      public boolean hasInputSwitch()
       Switches to another input stream.
      .google.cloud.video.livestream.v1.Event.InputSwitchTask input_switch = 5;
      Specified by:
      hasInputSwitch in interface EventOrBuilder
      Returns:
      Whether the inputSwitch field is set.

    • getInputSwitch

      public Event.InputSwitchTask getInputSwitch()
       Switches to another input stream.
      .google.cloud.video.livestream.v1.Event.InputSwitchTask input_switch = 5;
      Specified by:
      getInputSwitch in interface EventOrBuilder
      Returns:
      The inputSwitch.

    • getInputSwitchOrBuilder

      public Event.InputSwitchTaskOrBuilder getInputSwitchOrBuilder()
       Switches to another input stream.
      .google.cloud.video.livestream.v1.Event.InputSwitchTask input_switch = 5;
      Specified by:
      getInputSwitchOrBuilder in interface EventOrBuilder

    • hasAdBreak

      public boolean hasAdBreak()
       Inserts a new ad opportunity.
      .google.cloud.video.livestream.v1.Event.AdBreakTask ad_break = 6;
      Specified by:
      hasAdBreak in interface EventOrBuilder
      Returns:
      Whether the adBreak field is set.

    • getAdBreak

      public Event.AdBreakTask getAdBreak()
       Inserts a new ad opportunity.
      .google.cloud.video.livestream.v1.Event.AdBreakTask ad_break = 6;
      Specified by:
      getAdBreak in interface EventOrBuilder
      Returns:
      The adBreak.

    • getAdBreakOrBuilder

      public Event.AdBreakTaskOrBuilder getAdBreakOrBuilder()
       Inserts a new ad opportunity.
      .google.cloud.video.livestream.v1.Event.AdBreakTask ad_break = 6;
      Specified by:
      getAdBreakOrBuilder in interface EventOrBuilder

    • hasReturnToProgram

      public boolean hasReturnToProgram()
       Stops any running ad break.
      .google.cloud.video.livestream.v1.Event.ReturnToProgramTask return_to_program = 13;
      Specified by:
      hasReturnToProgram in interface EventOrBuilder
      Returns:
      Whether the returnToProgram field is set.

    • getReturnToProgram

      public Event.ReturnToProgramTask getReturnToProgram()
       Stops any running ad break.
      .google.cloud.video.livestream.v1.Event.ReturnToProgramTask return_to_program = 13;
      Specified by:
      getReturnToProgram in interface EventOrBuilder
      Returns:
      The returnToProgram.

    • getReturnToProgramOrBuilder

      public Event.ReturnToProgramTaskOrBuilder getReturnToProgramOrBuilder()
       Stops any running ad break.
      .google.cloud.video.livestream.v1.Event.ReturnToProgramTask return_to_program = 13;
      Specified by:
      getReturnToProgramOrBuilder in interface EventOrBuilder

    • hasSlate

      public boolean hasSlate()
       Inserts a slate.
      .google.cloud.video.livestream.v1.Event.SlateTask slate = 14;
      Specified by:
      hasSlate in interface EventOrBuilder
      Returns:
      Whether the slate field is set.

    • getSlate

      public Event.SlateTask getSlate()
       Inserts a slate.
      .google.cloud.video.livestream.v1.Event.SlateTask slate = 14;
      Specified by:
      getSlate in interface EventOrBuilder
      Returns:
      The slate.

    • getSlateOrBuilder

      public Event.SlateTaskOrBuilder getSlateOrBuilder()
       Inserts a slate.
      .google.cloud.video.livestream.v1.Event.SlateTask slate = 14;
      Specified by:
      getSlateOrBuilder in interface EventOrBuilder

    • hasMute

      public boolean hasMute()
       Mutes the stream.
      .google.cloud.video.livestream.v1.Event.MuteTask mute = 15;
      Specified by:
      hasMute in interface EventOrBuilder
      Returns:
      Whether the mute field is set.

    • getMute

      public Event.MuteTask getMute()
       Mutes the stream.
      .google.cloud.video.livestream.v1.Event.MuteTask mute = 15;
      Specified by:
      getMute in interface EventOrBuilder
      Returns:
      The mute.

    • getMuteOrBuilder

      public Event.MuteTaskOrBuilder getMuteOrBuilder()
       Mutes the stream.
      .google.cloud.video.livestream.v1.Event.MuteTask mute = 15;
      Specified by:
      getMuteOrBuilder in interface EventOrBuilder

    • hasUnmute

      public boolean hasUnmute()
       Unmutes the stream.
      .google.cloud.video.livestream.v1.Event.UnmuteTask unmute = 16;
      Specified by:
      hasUnmute in interface EventOrBuilder
      Returns:
      Whether the unmute field is set.

    • getUnmute

      public Event.UnmuteTask getUnmute()
       Unmutes the stream.
      .google.cloud.video.livestream.v1.Event.UnmuteTask unmute = 16;
      Specified by:
      getUnmute in interface EventOrBuilder
      Returns:
      The unmute.

    • getUnmuteOrBuilder

      public Event.UnmuteTaskOrBuilder getUnmuteOrBuilder()
       Unmutes the stream.
      .google.cloud.video.livestream.v1.Event.UnmuteTask unmute = 16;
      Specified by:
      getUnmuteOrBuilder in interface EventOrBuilder

    • hasUpdateEncryptions

      public boolean hasUpdateEncryptions()
       Updates encryption settings.
      .google.cloud.video.livestream.v1.Event.UpdateEncryptionsTask update_encryptions = 17;
      Specified by:
      hasUpdateEncryptions in interface EventOrBuilder
      Returns:
      Whether the updateEncryptions field is set.

    • getUpdateEncryptions

      public Event.UpdateEncryptionsTask getUpdateEncryptions()
       Updates encryption settings.
      .google.cloud.video.livestream.v1.Event.UpdateEncryptionsTask update_encryptions = 17;
      Specified by:
      getUpdateEncryptions in interface EventOrBuilder
      Returns:
      The updateEncryptions.

    • getUpdateEncryptionsOrBuilder

      public Event.UpdateEncryptionsTaskOrBuilder getUpdateEncryptionsOrBuilder()
       Updates encryption settings.
      .google.cloud.video.livestream.v1.Event.UpdateEncryptionsTask update_encryptions = 17;
      Specified by:
      getUpdateEncryptionsOrBuilder in interface EventOrBuilder

    • 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][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;
      Specified by:
      getExecuteNow in interface EventOrBuilder
      Returns:
      The executeNow.

    • hasExecutionTime

      public 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;
      Specified by:
      hasExecutionTime in interface EventOrBuilder
      Returns:
      Whether the executionTime field is set.

    • getExecutionTime

      public 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;
      Specified by:
      getExecutionTime in interface EventOrBuilder
      Returns:
      The executionTime.

    • getExecutionTimeOrBuilder

      public 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;
      Specified by:
      getExecutionTimeOrBuilder in interface EventOrBuilder

    • 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];
      Specified by:
      getStateValue in interface EventOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • 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];
      Specified by:
      getState in interface EventOrBuilder
      Returns:
      The state.

    • 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];
      Specified by:
      hasError in interface EventOrBuilder
      Returns:
      Whether the error field is set.

    • 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];
      Specified by:
      getError in interface EventOrBuilder
      Returns:
      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];
      Specified by:
      getErrorOrBuilder in interface EventOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Event parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Event parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Event parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Event parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Event parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Event parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Event parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Event parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Event parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Event parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Event parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Event parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Event.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Event.Builder newBuilder()

    • newBuilder

      public static Event.Builder newBuilder(Event prototype)

    • toBuilder

      public Event.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Event.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Event getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Event> parser()

    • getParserForType

      public com.google.protobuf.Parser<Event> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Event getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder