• Home
• com.google.api.grpc
• proto-google-cloud-live-stream-v1
• 0.56.0
• source code
• EventOrBuilder.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.google.cloud.video.livestream.v1.EventOrBuilder Maven / Gradle / Ivy

/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/video/livestream/v1/resources.proto

// Protobuf Java Version: 3.25.5
package com.google.cloud.video.livestream.v1;

public interface EventOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.video.livestream.v1.Event)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   * 
   * The resource name of the event, in the form of:
   * `projects/{project}/locations/{location}/channels/{channelId}/events/{eventId}`.
   * 
   *
   * string name = 1;
   *
   * @return The name.
   */
  java.lang.String getName();
  /**
   *
   *
   * 
   * The resource name of the event, in the form of:
   * `projects/{project}/locations/{location}/channels/{channelId}/events/{eventId}`.
   * 
   *
   * string name = 1;
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   * 
   * Output only. The creation time.
   * 
   *
   * .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return Whether the createTime field is set.
   */
  boolean hasCreateTime();
  /**
   *
   *
   * 
   * Output only. The creation time.
   * 
   *
   * .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The createTime.
   */
  com.google.protobuf.Timestamp getCreateTime();
  /**
   *
   *
   * 
   * Output only. The creation time.
   * 
   *
   * .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   */
  com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();

  /**
   *
   *
   * 
   * Output only. The update time.
   * 
   *
   * .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return Whether the updateTime field is set.
   */
  boolean hasUpdateTime();
  /**
   *
   *
   * 
   * Output only. The update time.
   * 
   *
   * .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The updateTime.
   */
  com.google.protobuf.Timestamp getUpdateTime();
  /**
   *
   *
   * 
   * Output only. The update time.
   * 
   *
   * .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   */
  com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();

  /**
   *
   *
   * 
   * User-defined key/value metadata.
   * 
   *
   * map<string, string> labels = 4;
   */
  int getLabelsCount();
  /**
   *
   *
   * 
   * User-defined key/value metadata.
   * 
   *
   * map<string, string> labels = 4;
   */
  boolean containsLabels(java.lang.String key);
  /** Use {@link #getLabelsMap()} instead. */
  @java.lang.Deprecated
  java.util.Map getLabels();
  /**
   *
   *
   * 
   * User-defined key/value metadata.
   * 
   *
   * map<string, string> labels = 4;
   */
  java.util.Map getLabelsMap();
  /**
   *
   *
   * 
   * User-defined key/value metadata.
   * 
   *
   * map<string, string> labels = 4;
   */
  /* nullable */
  java.lang.String getLabelsOrDefault(
      java.lang.String key,
      /* nullable */
      java.lang.String defaultValue);
  /**
   *
   *
   * 
   * User-defined key/value metadata.
   * 
   *
   * map<string, string> labels = 4;
   */
  java.lang.String getLabelsOrThrow(java.lang.String key);

  /**
   *
   *
   * 
   * Switches to another input stream.
   * 
   *
   * .google.cloud.video.livestream.v1.Event.InputSwitchTask input_switch = 5;
   *
   * @return Whether the inputSwitch field is set.
   */
  boolean hasInputSwitch();
  /**
   *
   *
   * 
   * Switches to another input stream.
   * 
   *
   * .google.cloud.video.livestream.v1.Event.InputSwitchTask input_switch = 5;
   *
   * @return The inputSwitch.
   */
  com.google.cloud.video.livestream.v1.Event.InputSwitchTask getInputSwitch();
  /**
   *
   *
   * 
   * Switches to another input stream.
   * 
   *
   * .google.cloud.video.livestream.v1.Event.InputSwitchTask input_switch = 5;
   */
  com.google.cloud.video.livestream.v1.Event.InputSwitchTaskOrBuilder getInputSwitchOrBuilder();

  /**
   *
   *
   * 
   * Inserts a new ad opportunity.
   * 
   *
   * .google.cloud.video.livestream.v1.Event.AdBreakTask ad_break = 6;
   *
   * @return Whether the adBreak field is set.
   */
  boolean hasAdBreak();
  /**
   *
   *
   * 
   * Inserts a new ad opportunity.
   * 
   *
   * .google.cloud.video.livestream.v1.Event.AdBreakTask ad_break = 6;
   *
   * @return The adBreak.
   */
  com.google.cloud.video.livestream.v1.Event.AdBreakTask getAdBreak();
  /**
   *
   *
   * 
   * Inserts a new ad opportunity.
   * 
   *
   * .google.cloud.video.livestream.v1.Event.AdBreakTask ad_break = 6;
   */
  com.google.cloud.video.livestream.v1.Event.AdBreakTaskOrBuilder getAdBreakOrBuilder();

  /**
   *
   *
   * 
   * Stops any running ad break.
   * 
   *
   * .google.cloud.video.livestream.v1.Event.ReturnToProgramTask return_to_program = 13;
   * 
   *
   * @return Whether the returnToProgram field is set.
   */
  boolean hasReturnToProgram();
  /**
   *
   *
   * 
   * Stops any running ad break.
   * 
   *
   * .google.cloud.video.livestream.v1.Event.ReturnToProgramTask return_to_program = 13;
   * 
   *
   * @return The returnToProgram.
   */
  com.google.cloud.video.livestream.v1.Event.ReturnToProgramTask getReturnToProgram();
  /**
   *
   *
   * 
   * Stops any running ad break.
   * 
   *
   * .google.cloud.video.livestream.v1.Event.ReturnToProgramTask return_to_program = 13;
   * 
   */
  com.google.cloud.video.livestream.v1.Event.ReturnToProgramTaskOrBuilder
      getReturnToProgramOrBuilder();

  /**
   *
   *
   * 
   * Inserts a slate.
   * 
   *
   * .google.cloud.video.livestream.v1.Event.SlateTask slate = 14;
   *
   * @return Whether the slate field is set.
   */
  boolean hasSlate();
  /**
   *
   *
   * 
   * Inserts a slate.
   * 
   *
   * .google.cloud.video.livestream.v1.Event.SlateTask slate = 14;
   *
   * @return The slate.
   */
  com.google.cloud.video.livestream.v1.Event.SlateTask getSlate();
  /**
   *
   *
   * 
   * Inserts a slate.
   * 
   *
   * .google.cloud.video.livestream.v1.Event.SlateTask slate = 14;
   */
  com.google.cloud.video.livestream.v1.Event.SlateTaskOrBuilder getSlateOrBuilder();

  /**
   *
   *
   * 
   * Mutes the stream.
   * 
   *
   * .google.cloud.video.livestream.v1.Event.MuteTask mute = 15;
   *
   * @return Whether the mute field is set.
   */
  boolean hasMute();
  /**
   *
   *
   * 
   * Mutes the stream.
   * 
   *
   * .google.cloud.video.livestream.v1.Event.MuteTask mute = 15;
   *
   * @return The mute.
   */
  com.google.cloud.video.livestream.v1.Event.MuteTask getMute();
  /**
   *
   *
   * 
   * Mutes the stream.
   * 
   *
   * .google.cloud.video.livestream.v1.Event.MuteTask mute = 15;
   */
  com.google.cloud.video.livestream.v1.Event.MuteTaskOrBuilder getMuteOrBuilder();

  /**
   *
   *
   * 
   * Unmutes the stream.
   * 
   *
   * .google.cloud.video.livestream.v1.Event.UnmuteTask unmute = 16;
   *
   * @return Whether the unmute field is set.
   */
  boolean hasUnmute();
  /**
   *
   *
   * 
   * Unmutes the stream.
   * 
   *
   * .google.cloud.video.livestream.v1.Event.UnmuteTask unmute = 16;
   *
   * @return The unmute.
   */
  com.google.cloud.video.livestream.v1.Event.UnmuteTask getUnmute();
  /**
   *
   *
   * 
   * Unmutes the stream.
   * 
   *
   * .google.cloud.video.livestream.v1.Event.UnmuteTask unmute = 16;
   */
  com.google.cloud.video.livestream.v1.Event.UnmuteTaskOrBuilder getUnmuteOrBuilder();

  /**
   *
   *
   * 
   * 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;
   *
   * @return The executeNow.
   */
  boolean getExecuteNow();

  /**
   *
   *
   * 
   * 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;
   *
   * @return Whether the executionTime field is set.
   */
  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;
   *
   * @return The executionTime.
   */
  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;
   */
  com.google.protobuf.TimestampOrBuilder getExecutionTimeOrBuilder();

  /**
   *
   *
   * 
   * Output only. The state of the event.
   * 
   *
   * 
   * .google.cloud.video.livestream.v1.Event.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The enum numeric value on the wire for state.
   */
  int getStateValue();
  /**
   *
   *
   * 
   * Output only. The state of the event.
   * 
   *
   * 
   * .google.cloud.video.livestream.v1.Event.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * 
   *
   * @return The state.
   */
  com.google.cloud.video.livestream.v1.Event.State getState();

  /**
   *
   *
   * 
   * 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];
   *
   * @return Whether the error field is set.
   */
  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];
   *
   * @return The error.
   */
  com.google.rpc.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];
   */
  com.google.rpc.StatusOrBuilder getErrorOrBuilder();

  com.google.cloud.video.livestream.v1.Event.TaskCase getTaskCase();
}