Class Event.Builder (0.11.0)

public static final class Event.Builder extends GeneratedMessageV3.Builder<Event.Builder> 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

Implements

EventOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Event.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Event.Builder
Overrides

build()

public Event build()
Returns
TypeDescription
Event

buildPartial()

public Event buildPartial()
Returns
TypeDescription
Event

clear()

public Event.Builder clear()
Returns
TypeDescription
Event.Builder
Overrides

clearAdBreak()

public Event.Builder clearAdBreak()

Required. Inserts a new ad opportunity.

.google.cloud.video.livestream.v1.Event.AdBreakTask ad_break = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Event.Builder

clearCreateTime()

public Event.Builder clearCreateTime()

Output only. The creation time.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Event.Builder

clearError()

public Event.Builder clearError()

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
TypeDescription
Event.Builder

clearExecuteNow()

public Event.Builder clearExecuteNow()

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
TypeDescription
Event.Builder

This builder for chaining.

clearExecutionTime()

public Event.Builder clearExecutionTime()

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
TypeDescription
Event.Builder

clearField(Descriptors.FieldDescriptor field)

public Event.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Event.Builder
Overrides

clearLabels()

public Event.Builder clearLabels()
Returns
TypeDescription
Event.Builder

clearName()

public Event.Builder clearName()

The resource name of the event, in the form of: projects/{project}/locations/{location}/channels/{channelId}/events/{eventId}.

string name = 1;

Returns
TypeDescription
Event.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Event.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Event.Builder
Overrides

clearState()

public Event.Builder clearState()

Output only. The state of the event.

.google.cloud.video.livestream.v1.Event.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Event.Builder

This builder for chaining.

clearTask()

public Event.Builder clearTask()
Returns
TypeDescription
Event.Builder

clearUpdateTime()

public Event.Builder clearUpdateTime()

Output only. The update time.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Event.Builder

clone()

public Event.Builder clone()
Returns
TypeDescription
Event.Builder
Overrides

containsLabels(String key)

public boolean containsLabels(String key)

User-defined key/value metadata.

map<string, string> labels = 4;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

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
TypeDescription
Event.AdBreakTask

The adBreak.

getAdBreakBuilder()

public Event.AdBreakTask.Builder getAdBreakBuilder()

Required. Inserts a new ad opportunity.

.google.cloud.video.livestream.v1.Event.AdBreakTask ad_break = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Event.AdBreakTask.Builder

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
TypeDescription
Event.AdBreakTaskOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. The creation time.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The creation time.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The creation time.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Event getDefaultInstanceForType()
Returns
TypeDescription
Event

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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];

Returns
TypeDescription
com.google.rpc.Status

The error.

getErrorBuilder()

public Status.Builder getErrorBuilder()

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
TypeDescription
com.google.rpc.Status.Builder

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
TypeDescription
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
TypeDescription
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
TypeDescription
Timestamp

The executionTime.

getExecutionTimeBuilder()

public Timestamp.Builder getExecutionTimeBuilder()

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
TypeDescription
Builder

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
TypeDescription
TimestampOrBuilder

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

User-defined key/value metadata.

map<string, string> labels = 4;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

User-defined key/value metadata.

map<string, string> labels = 4;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

User-defined key/value metadata.

map<string, string> labels = 4;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

User-defined key/value metadata.

map<string, string> labels = 4;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

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;

Returns
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

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
TypeDescription
Event.State

The state.

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
TypeDescription
int

The enum numeric value on the wire for state.

getTaskCase()

public Event.TaskCase getTaskCase()
Returns
TypeDescription
Event.TaskCase

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The update time.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. The update time.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The update time.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeAdBreak(Event.AdBreakTask value)

public Event.Builder mergeAdBreak(Event.AdBreakTask value)

Required. Inserts a new ad opportunity.

.google.cloud.video.livestream.v1.Event.AdBreakTask ad_break = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueEvent.AdBreakTask
Returns
TypeDescription
Event.Builder

mergeCreateTime(Timestamp value)

public Event.Builder mergeCreateTime(Timestamp value)

Output only. The creation time.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Event.Builder

mergeError(Status value)

public Event.Builder mergeError(Status value)

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];

Parameter
NameDescription
valuecom.google.rpc.Status
Returns
TypeDescription
Event.Builder

mergeExecutionTime(Timestamp value)

public Event.Builder mergeExecutionTime(Timestamp value)

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;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Event.Builder

mergeFrom(Event other)

public Event.Builder mergeFrom(Event other)
Parameter
NameDescription
otherEvent
Returns
TypeDescription
Event.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Event.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Event.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Event.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Event.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Event.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Event.Builder
Overrides

mergeUpdateTime(Timestamp value)

public Event.Builder mergeUpdateTime(Timestamp value)

Output only. The update time.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Event.Builder

putAllLabels(Map<String,String> values)

public Event.Builder putAllLabels(Map<String,String> values)

User-defined key/value metadata.

map<string, string> labels = 4;

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
Event.Builder

putLabels(String key, String value)

public Event.Builder putLabels(String key, String value)

User-defined key/value metadata.

map<string, string> labels = 4;

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
Event.Builder

removeLabels(String key)

public Event.Builder removeLabels(String key)

User-defined key/value metadata.

map<string, string> labels = 4;

Parameter
NameDescription
keyString
Returns
TypeDescription
Event.Builder

setAdBreak(Event.AdBreakTask value)

public Event.Builder setAdBreak(Event.AdBreakTask value)

Required. Inserts a new ad opportunity.

.google.cloud.video.livestream.v1.Event.AdBreakTask ad_break = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueEvent.AdBreakTask
Returns
TypeDescription
Event.Builder

setAdBreak(Event.AdBreakTask.Builder builderForValue)

public Event.Builder setAdBreak(Event.AdBreakTask.Builder builderForValue)

Required. Inserts a new ad opportunity.

.google.cloud.video.livestream.v1.Event.AdBreakTask ad_break = 6 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
builderForValueEvent.AdBreakTask.Builder
Returns
TypeDescription
Event.Builder

setCreateTime(Timestamp value)

public Event.Builder setCreateTime(Timestamp value)

Output only. The creation time.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Event.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Event.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The creation time.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Event.Builder

setError(Status value)

public Event.Builder setError(Status value)

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];

Parameter
NameDescription
valuecom.google.rpc.Status
Returns
TypeDescription
Event.Builder

setError(Status.Builder builderForValue)

public Event.Builder setError(Status.Builder builderForValue)

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];

Parameter
NameDescription
builderForValuecom.google.rpc.Status.Builder
Returns
TypeDescription
Event.Builder

setExecuteNow(boolean value)

public Event.Builder setExecuteNow(boolean value)

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;

Parameter
NameDescription
valueboolean

The executeNow to set.

Returns
TypeDescription
Event.Builder

This builder for chaining.

setExecutionTime(Timestamp value)

public Event.Builder setExecutionTime(Timestamp value)

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;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Event.Builder

setExecutionTime(Timestamp.Builder builderForValue)

public Event.Builder setExecutionTime(Timestamp.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Event.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Event.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Event.Builder
Overrides

setName(String value)

public Event.Builder setName(String value)

The resource name of the event, in the form of: projects/{project}/locations/{location}/channels/{channelId}/events/{eventId}.

string name = 1;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Event.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Event.Builder setNameBytes(ByteString value)

The resource name of the event, in the form of: projects/{project}/locations/{location}/channels/{channelId}/events/{eventId}.

string name = 1;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Event.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Event.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Event.Builder
Overrides

setState(Event.State value)

public Event.Builder setState(Event.State value)

Output only. The state of the event.

.google.cloud.video.livestream.v1.Event.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueEvent.State

The state to set.

Returns
TypeDescription
Event.Builder

This builder for chaining.

setStateValue(int value)

public Event.Builder setStateValue(int value)

Output only. The state of the event.

.google.cloud.video.livestream.v1.Event.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueint

The enum numeric value on the wire for state to set.

Returns
TypeDescription
Event.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Event.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Event.Builder
Overrides

setUpdateTime(Timestamp value)

public Event.Builder setUpdateTime(Timestamp value)

Output only. The update time.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Event.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Event.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The update time.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Event.Builder