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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
AD_BREAK_FIELD_NUMBER
public static final int AD_BREAK_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ERROR_FIELD_NUMBER
public static final int ERROR_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
EXECUTE_NOW_FIELD_NUMBER
public static final int EXECUTE_NOW_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
EXECUTION_TIME_FIELD_NUMBER
public static final int EXECUTION_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int INPUT_SWITCH_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MUTE_FIELD_NUMBER
public static final int MUTE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RETURN_TO_PROGRAM_FIELD_NUMBER
public static final int RETURN_TO_PROGRAM_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UNMUTE_FIELD_NUMBER
public static final int UNMUTE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Event getDefaultInstance()
| Returns |
|---|
| Type | Description |
Event | |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Event.Builder newBuilder()
newBuilder(Event prototype)
public static Event.Builder newBuilder(Event prototype)
| Parameter |
|---|
| Name | Description |
prototype | Event
|
public static Event parseDelimitedFrom(InputStream input)
| Returns |
|---|
| Type | Description |
Event | |
public static Event parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Event | |
parseFrom(byte[] data)
public static Event parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
| Returns |
|---|
| Type | Description |
Event | |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Event parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Event | |
parseFrom(ByteString data)
public static Event parseFrom(ByteString data)
| Returns |
|---|
| Type | Description |
Event | |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Event parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Event | |
public static Event parseFrom(CodedInputStream input)
| Returns |
|---|
| Type | Description |
Event | |
public static Event parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Event | |
public static Event parseFrom(InputStream input)
| Returns |
|---|
| Type | Description |
Event | |
public static Event parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Event | |
parseFrom(ByteBuffer data)
public static Event parseFrom(ByteBuffer data)
| Returns |
|---|
| Type | Description |
Event | |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Event parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Event | |
parser()
public static Parser<Event> parser()
Methods
containsLabels(String key)
public boolean containsLabels(String key)
User-defined key/value metadata.
map<string, string> labels = 4;
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getAdBreak()
public Event.AdBreakTask getAdBreak()
Required. Inserts a new ad opportunity.
.google.cloud.video.livestream.v1.Event.AdBreakTask ad_break = 6 [(.google.api.field_behavior) = REQUIRED];
getAdBreakOrBuilder()
public Event.AdBreakTaskOrBuilder getAdBreakOrBuilder()
Required. Inserts a new ad opportunity.
.google.cloud.video.livestream.v1.Event.AdBreakTask ad_break = 6 [(.google.api.field_behavior) = REQUIRED];
getCreateTime()
public 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 TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The creation time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Event getDefaultInstanceForType()
| Returns |
|---|
| Type | Description |
Event | |
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 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 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 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 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;
public Event.InputSwitchTask getInputSwitch()
Required. Switches to another input stream.
.google.cloud.video.livestream.v1.Event.InputSwitchTask input_switch = 5 [(.google.api.field_behavior) = REQUIRED];
public Event.InputSwitchTaskOrBuilder getInputSwitchOrBuilder()
Required. Switches to another input stream.
.google.cloud.video.livestream.v1.Event.InputSwitchTask input_switch = 5 [(.google.api.field_behavior) = REQUIRED];
getLabels()
public Map<String,String> getLabels()
getLabelsCount()
public int getLabelsCount()
User-defined key/value metadata.
map<string, string> labels = 4;
| Returns |
|---|
| Type | Description |
int | |
getLabelsMap()
public Map<String,String> getLabelsMap()
User-defined key/value metadata.
map<string, string> labels = 4;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
User-defined key/value metadata.
map<string, string> labels = 4;
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
User-defined key/value metadata.
map<string, string> labels = 4;
| Parameter |
|---|
| Name | Description |
key | String
|
getMute()
public Event.MuteTask getMute()
Required. Mutes the stream.
.google.cloud.video.livestream.v1.Event.MuteTask mute = 15 [(.google.api.field_behavior) = REQUIRED];
getMuteOrBuilder()
public Event.MuteTaskOrBuilder getMuteOrBuilder()
Required. Mutes the stream.
.google.cloud.video.livestream.v1.Event.MuteTask mute = 15 [(.google.api.field_behavior) = REQUIRED];
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 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.
|
getParserForType()
public Parser<Event> getParserForType()
Overrides
getReturnToProgram()
public 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];
getReturnToProgramOrBuilder()
public 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];
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
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];
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 |
|---|
| Type | Description |
int | The enum numeric value on the wire for state.
|
getTaskCase()
public Event.TaskCase getTaskCase()
getUnmute()
public Event.UnmuteTask getUnmute()
Required. Unmutes the stream.
.google.cloud.video.livestream.v1.Event.UnmuteTask unmute = 16 [(.google.api.field_behavior) = REQUIRED];
getUnmuteOrBuilder()
public Event.UnmuteTaskOrBuilder getUnmuteOrBuilder()
Required. Unmutes the stream.
.google.cloud.video.livestream.v1.Event.UnmuteTask unmute = 16 [(.google.api.field_behavior) = REQUIRED];
getUpdateTime()
public 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 TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The update time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasAdBreak()
public 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 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 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 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.
|
public 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()
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 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 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 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.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Event.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Event.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Event.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
