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
Static Fields
AD_BREAK_FIELD_NUMBER
public static final int AD_BREAK_FIELD_NUMBER
Field Value
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
ERROR_FIELD_NUMBER
public static final int ERROR_FIELD_NUMBER
Field Value
EXECUTE_NOW_FIELD_NUMBER
public static final int EXECUTE_NOW_FIELD_NUMBER
Field Value
EXECUTION_TIME_FIELD_NUMBER
public static final int EXECUTION_TIME_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Event getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Event.Builder newBuilder()
Returns
newBuilder(Event prototype)
public static Event.Builder newBuilder(Event prototype)
Parameter
Name | Description |
prototype | Event
|
Returns
public static Event parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Event parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Event parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Event parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Event parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Event parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Event parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Event parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Event parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Event parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Event parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Event parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Event> parser()
Returns
Methods
containsLabels(String key)
public boolean containsLabels(String key)
User-defined key/value metadata.
map<string, string> labels = 4;
Parameter
Returns
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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];
Returns
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];
Returns
getCreateTime()
public Timestamp getCreateTime()
Output only. The creation time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The creation time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getDefaultInstanceForType()
public Event getDefaultInstanceForType()
Returns
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 when the event should be executed. When execute_now is set to
true
, this field should not be set in CreateEvent
request and will be
populated with the time that the server schedules the event.
.google.protobuf.Timestamp execution_time = 10;
Returns
getExecutionTimeOrBuilder()
public TimestampOrBuilder getExecutionTimeOrBuilder()
The time when the event should be executed. When execute_now is set to
true
, this field should not be set in CreateEvent
request and will be
populated with the time that the server schedules the event.
.google.protobuf.Timestamp execution_time = 10;
Returns
getLabels()
public Map<String,String> getLabels()
Returns
getLabelsCount()
public int getLabelsCount()
User-defined key/value metadata.
map<string, string> labels = 4;
Returns
getLabelsMap()
public Map<String,String> getLabelsMap()
User-defined key/value metadata.
map<string, string> labels = 4;
Returns
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
User-defined key/value metadata.
map<string, string> labels = 4;
Parameters
Returns
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
User-defined key/value metadata.
map<string, string> labels = 4;
Parameter
Returns
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
getParserForType()
public Parser<Event> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
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];
Returns
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()
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The update time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The update time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
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 when the event should be executed. When execute_now is set to
true
, this field should not be set in CreateEvent
request and will be
populated with the time that the server schedules the event.
.google.protobuf.Timestamp execution_time = 10;
Returns
Type | Description |
boolean | Whether the executionTime 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
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Event.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Event.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Event.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions