Class Channel (0.11.0)

public final class Channel extends GeneratedMessageV3 implements ChannelOrBuilder

Channel resource represents the processor that does a user-defined "streaming" operation, which includes getting an input stream through an input, transcoding it to multiple renditions, and publishing output live streams in certain formats (for example, HLS or DASH) to the specified location.

Protobuf type google.cloud.video.livestream.v1.Channel

Implements

ChannelOrBuilder

Static Fields

ACTIVE_INPUT_FIELD_NUMBER

public static final int ACTIVE_INPUT_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

ELEMENTARY_STREAMS_FIELD_NUMBER

public static final int ELEMENTARY_STREAMS_FIELD_NUMBER
Field Value
TypeDescription
int

INPUT_ATTACHMENTS_FIELD_NUMBER

public static final int INPUT_ATTACHMENTS_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

LOG_CONFIG_FIELD_NUMBER

public static final int LOG_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

MANIFESTS_FIELD_NUMBER

public static final int MANIFESTS_FIELD_NUMBER
Field Value
TypeDescription
int

MUX_STREAMS_FIELD_NUMBER

public static final int MUX_STREAMS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

OUTPUT_FIELD_NUMBER

public static final int OUTPUT_FIELD_NUMBER
Field Value
TypeDescription
int

SPRITE_SHEETS_FIELD_NUMBER

public static final int SPRITE_SHEETS_FIELD_NUMBER
Field Value
TypeDescription
int

STREAMING_ERROR_FIELD_NUMBER

public static final int STREAMING_ERROR_FIELD_NUMBER
Field Value
TypeDescription
int

STREAMING_STATE_FIELD_NUMBER

public static final int STREAMING_STATE_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Channel getDefaultInstance()
Returns
TypeDescription
Channel

getDescriptor()

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

newBuilder()

public static Channel.Builder newBuilder()
Returns
TypeDescription
Channel.Builder

newBuilder(Channel prototype)

public static Channel.Builder newBuilder(Channel prototype)
Parameter
NameDescription
prototypeChannel
Returns
TypeDescription
Channel.Builder

parseDelimitedFrom(InputStream input)

public static Channel parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Channel
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Channel parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Channel
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Channel parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Channel
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Channel parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Channel
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Channel parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Channel
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Channel parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Channel
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Channel parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Channel
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Channel parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Channel
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Channel parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Channel
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Channel parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Channel
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Channel parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Channel
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Channel parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Channel
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Channel> parser()
Returns
TypeDescription
Parser<Channel>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

User-defined key/value metadata.

map<string, string> labels = 4;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getActiveInput()

public String getActiveInput()

Output only. The InputAttachment.key that serves as the current input source. The first input in the input_attachments is the initial input source.

string active_input = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The activeInput.

getActiveInputBytes()

public ByteString getActiveInputBytes()

Output only. The InputAttachment.key that serves as the current input source. The first input in the input_attachments is the initial input source.

string active_input = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for activeInput.

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.

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 Channel getDefaultInstanceForType()
Returns
TypeDescription
Channel

getElementaryStreams(int index)

public ElementaryStream getElementaryStreams(int index)

List of elementary streams.

repeated .google.cloud.video.livestream.v1.ElementaryStream elementary_streams = 10;

Parameter
NameDescription
indexint
Returns
TypeDescription
ElementaryStream

getElementaryStreamsCount()

public int getElementaryStreamsCount()

List of elementary streams.

repeated .google.cloud.video.livestream.v1.ElementaryStream elementary_streams = 10;

Returns
TypeDescription
int

getElementaryStreamsList()

public List<ElementaryStream> getElementaryStreamsList()

List of elementary streams.

repeated .google.cloud.video.livestream.v1.ElementaryStream elementary_streams = 10;

Returns
TypeDescription
List<ElementaryStream>

getElementaryStreamsOrBuilder(int index)

public ElementaryStreamOrBuilder getElementaryStreamsOrBuilder(int index)

List of elementary streams.

repeated .google.cloud.video.livestream.v1.ElementaryStream elementary_streams = 10;

Parameter
NameDescription
indexint
Returns
TypeDescription
ElementaryStreamOrBuilder

getElementaryStreamsOrBuilderList()

public List<? extends ElementaryStreamOrBuilder> getElementaryStreamsOrBuilderList()

List of elementary streams.

repeated .google.cloud.video.livestream.v1.ElementaryStream elementary_streams = 10;

Returns
TypeDescription
List<? extends com.google.cloud.video.livestream.v1.ElementaryStreamOrBuilder>

getInputAttachments(int index)

public InputAttachment getInputAttachments(int index)

A list of input attachments that this channel uses. One channel can have multiple inputs as the input sources. Only one input can be selected as the input source at one time.

repeated .google.cloud.video.livestream.v1.InputAttachment input_attachments = 16;

Parameter
NameDescription
indexint
Returns
TypeDescription
InputAttachment

getInputAttachmentsCount()

public int getInputAttachmentsCount()

A list of input attachments that this channel uses. One channel can have multiple inputs as the input sources. Only one input can be selected as the input source at one time.

repeated .google.cloud.video.livestream.v1.InputAttachment input_attachments = 16;

Returns
TypeDescription
int

getInputAttachmentsList()

public List<InputAttachment> getInputAttachmentsList()

A list of input attachments that this channel uses. One channel can have multiple inputs as the input sources. Only one input can be selected as the input source at one time.

repeated .google.cloud.video.livestream.v1.InputAttachment input_attachments = 16;

Returns
TypeDescription
List<InputAttachment>

getInputAttachmentsOrBuilder(int index)

public InputAttachmentOrBuilder getInputAttachmentsOrBuilder(int index)

A list of input attachments that this channel uses. One channel can have multiple inputs as the input sources. Only one input can be selected as the input source at one time.

repeated .google.cloud.video.livestream.v1.InputAttachment input_attachments = 16;

Parameter
NameDescription
indexint
Returns
TypeDescription
InputAttachmentOrBuilder

getInputAttachmentsOrBuilderList()

public List<? extends InputAttachmentOrBuilder> getInputAttachmentsOrBuilderList()

A list of input attachments that this channel uses. One channel can have multiple inputs as the input sources. Only one input can be selected as the input source at one time.

repeated .google.cloud.video.livestream.v1.InputAttachment input_attachments = 16;

Returns
TypeDescription
List<? extends com.google.cloud.video.livestream.v1.InputAttachmentOrBuilder>

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

getLogConfig()

public LogConfig getLogConfig()

Configuration of platform logs for this channel.

.google.cloud.video.livestream.v1.LogConfig log_config = 19;

Returns
TypeDescription
LogConfig

The logConfig.

getLogConfigOrBuilder()

public LogConfigOrBuilder getLogConfigOrBuilder()

Configuration of platform logs for this channel.

.google.cloud.video.livestream.v1.LogConfig log_config = 19;

Returns
TypeDescription
LogConfigOrBuilder

getManifests(int index)

public Manifest getManifests(int index)

List of output manifests.

repeated .google.cloud.video.livestream.v1.Manifest manifests = 12;

Parameter
NameDescription
indexint
Returns
TypeDescription
Manifest

getManifestsCount()

public int getManifestsCount()

List of output manifests.

repeated .google.cloud.video.livestream.v1.Manifest manifests = 12;

Returns
TypeDescription
int

getManifestsList()

public List<Manifest> getManifestsList()

List of output manifests.

repeated .google.cloud.video.livestream.v1.Manifest manifests = 12;

Returns
TypeDescription
List<Manifest>

getManifestsOrBuilder(int index)

public ManifestOrBuilder getManifestsOrBuilder(int index)

List of output manifests.

repeated .google.cloud.video.livestream.v1.Manifest manifests = 12;

Parameter
NameDescription
indexint
Returns
TypeDescription
ManifestOrBuilder

getManifestsOrBuilderList()

public List<? extends ManifestOrBuilder> getManifestsOrBuilderList()

List of output manifests.

repeated .google.cloud.video.livestream.v1.Manifest manifests = 12;

Returns
TypeDescription
List<? extends com.google.cloud.video.livestream.v1.ManifestOrBuilder>

getMuxStreams(int index)

public MuxStream getMuxStreams(int index)

List of multiplexing settings for output streams.

repeated .google.cloud.video.livestream.v1.MuxStream mux_streams = 11;

Parameter
NameDescription
indexint
Returns
TypeDescription
MuxStream

getMuxStreamsCount()

public int getMuxStreamsCount()

List of multiplexing settings for output streams.

repeated .google.cloud.video.livestream.v1.MuxStream mux_streams = 11;

Returns
TypeDescription
int

getMuxStreamsList()

public List<MuxStream> getMuxStreamsList()

List of multiplexing settings for output streams.

repeated .google.cloud.video.livestream.v1.MuxStream mux_streams = 11;

Returns
TypeDescription
List<MuxStream>

getMuxStreamsOrBuilder(int index)

public MuxStreamOrBuilder getMuxStreamsOrBuilder(int index)

List of multiplexing settings for output streams.

repeated .google.cloud.video.livestream.v1.MuxStream mux_streams = 11;

Parameter
NameDescription
indexint
Returns
TypeDescription
MuxStreamOrBuilder

getMuxStreamsOrBuilderList()

public List<? extends MuxStreamOrBuilder> getMuxStreamsOrBuilderList()

List of multiplexing settings for output streams.

repeated .google.cloud.video.livestream.v1.MuxStream mux_streams = 11;

Returns
TypeDescription
List<? extends com.google.cloud.video.livestream.v1.MuxStreamOrBuilder>

getName()

public String getName()

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

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getOutput()

public Channel.Output getOutput()

Required. Information about the output (that is, the Cloud Storage bucket to store the generated live stream).

.google.cloud.video.livestream.v1.Channel.Output output = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Channel.Output

The output.

getOutputOrBuilder()

public Channel.OutputOrBuilder getOutputOrBuilder()

Required. Information about the output (that is, the Cloud Storage bucket to store the generated live stream).

.google.cloud.video.livestream.v1.Channel.Output output = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Channel.OutputOrBuilder

getParserForType()

public Parser<Channel> getParserForType()
Returns
TypeDescription
Parser<Channel>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSpriteSheets(int index)

public SpriteSheet getSpriteSheets(int index)

List of output sprite sheets.

repeated .google.cloud.video.livestream.v1.SpriteSheet sprite_sheets = 13;

Parameter
NameDescription
indexint
Returns
TypeDescription
SpriteSheet

getSpriteSheetsCount()

public int getSpriteSheetsCount()

List of output sprite sheets.

repeated .google.cloud.video.livestream.v1.SpriteSheet sprite_sheets = 13;

Returns
TypeDescription
int

getSpriteSheetsList()

public List<SpriteSheet> getSpriteSheetsList()

List of output sprite sheets.

repeated .google.cloud.video.livestream.v1.SpriteSheet sprite_sheets = 13;

Returns
TypeDescription
List<SpriteSheet>

getSpriteSheetsOrBuilder(int index)

public SpriteSheetOrBuilder getSpriteSheetsOrBuilder(int index)

List of output sprite sheets.

repeated .google.cloud.video.livestream.v1.SpriteSheet sprite_sheets = 13;

Parameter
NameDescription
indexint
Returns
TypeDescription
SpriteSheetOrBuilder

getSpriteSheetsOrBuilderList()

public List<? extends SpriteSheetOrBuilder> getSpriteSheetsOrBuilderList()

List of output sprite sheets.

repeated .google.cloud.video.livestream.v1.SpriteSheet sprite_sheets = 13;

Returns
TypeDescription
List<? extends com.google.cloud.video.livestream.v1.SpriteSheetOrBuilder>

getStreamingError()

public Status getStreamingError()

Output only. A description of the reason for the streaming error. This property is always present when streaming_state is STREAMING_ERROR.

.google.rpc.Status streaming_error = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
com.google.rpc.Status

The streamingError.

getStreamingErrorOrBuilder()

public StatusOrBuilder getStreamingErrorOrBuilder()

Output only. A description of the reason for the streaming error. This property is always present when streaming_state is STREAMING_ERROR.

.google.rpc.Status streaming_error = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
com.google.rpc.StatusOrBuilder

getStreamingState()

public Channel.StreamingState getStreamingState()

Output only. State of the streaming operation.

.google.cloud.video.livestream.v1.Channel.StreamingState streaming_state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Channel.StreamingState

The streamingState.

getStreamingStateValue()

public int getStreamingStateValue()

Output only. State of the streaming operation.

.google.cloud.video.livestream.v1.Channel.StreamingState streaming_state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for streamingState.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The update time.

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

Returns
TypeDescription
TimestampOrBuilder

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.

hasLogConfig()

public boolean hasLogConfig()

Configuration of platform logs for this channel.

.google.cloud.video.livestream.v1.LogConfig log_config = 19;

Returns
TypeDescription
boolean

Whether the logConfig field is set.

hasOutput()

public boolean hasOutput()

Required. Information about the output (that is, the Cloud Storage bucket to store the generated live stream).

.google.cloud.video.livestream.v1.Channel.Output output = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the output field is set.

hasStreamingError()

public boolean hasStreamingError()

Output only. A description of the reason for the streaming error. This property is always present when streaming_state is STREAMING_ERROR.

.google.rpc.Status streaming_error = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the streamingError 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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Channel.Builder newBuilderForType()
Returns
TypeDescription
Channel.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Channel.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Channel.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Channel.Builder toBuilder()
Returns
TypeDescription
Channel.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException