public final class Clip extends GeneratedMessageV3 implements ClipOrBuilder
Clip is a sub-resource under channel. Each clip represents a clipping
operation that generates a VOD playlist from its channel given a set of
timestamp ranges.
Protobuf type google.cloud.video.livestream.v1.Clip
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CLIP_MANIFESTS_FIELD_NUMBER
public static final int CLIP_MANIFESTS_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 |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
OUTPUT_URI_FIELD_NUMBER
public static final int OUTPUT_URI_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SLICES_FIELD_NUMBER
public static final int SLICES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
START_TIME_FIELD_NUMBER
public static final int START_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATE_FIELD_NUMBER
public static final int STATE_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 Clip getDefaultInstance()
| Returns |
| Type |
Description |
Clip |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Clip.Builder newBuilder()
newBuilder(Clip prototype)
public static Clip.Builder newBuilder(Clip prototype)
| Parameter |
| Name |
Description |
prototype |
Clip
|
public static Clip parseDelimitedFrom(InputStream input)
| Returns |
| Type |
Description |
Clip |
|
public static Clip parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Clip |
|
parseFrom(byte[] data)
public static Clip parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
| Returns |
| Type |
Description |
Clip |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Clip parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Clip |
|
parseFrom(ByteString data)
public static Clip parseFrom(ByteString data)
| Returns |
| Type |
Description |
Clip |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Clip parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Clip |
|
public static Clip parseFrom(CodedInputStream input)
| Returns |
| Type |
Description |
Clip |
|
public static Clip parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Clip |
|
public static Clip parseFrom(InputStream input)
| Returns |
| Type |
Description |
Clip |
|
public static Clip parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Clip |
|
parseFrom(ByteBuffer data)
public static Clip parseFrom(ByteBuffer data)
| Returns |
| Type |
Description |
Clip |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Clip parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Clip |
|
parser()
public static Parser<Clip> parser()
Methods
containsLabels(String key)
public boolean containsLabels(String key)
The labels associated with this resource. Each label is a key-value pair.
map<string, string> labels = 5;
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getClipManifests(int index)
public Clip.ClipManifest getClipManifests(int index)
Required. A list of clip manifests. Currently only one clip manifest is
allowed.
repeated .google.cloud.video.livestream.v1.Clip.ClipManifest clip_manifests = 12 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
| Name |
Description |
index |
int
|
getClipManifestsCount()
public int getClipManifestsCount()
Required. A list of clip manifests. Currently only one clip manifest is
allowed.
repeated .google.cloud.video.livestream.v1.Clip.ClipManifest clip_manifests = 12 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
int |
|
getClipManifestsList()
public List<Clip.ClipManifest> getClipManifestsList()
Required. A list of clip manifests. Currently only one clip manifest is
allowed.
repeated .google.cloud.video.livestream.v1.Clip.ClipManifest clip_manifests = 12 [(.google.api.field_behavior) = REQUIRED];
getClipManifestsOrBuilder(int index)
public Clip.ClipManifestOrBuilder getClipManifestsOrBuilder(int index)
Required. A list of clip manifests. Currently only one clip manifest is
allowed.
repeated .google.cloud.video.livestream.v1.Clip.ClipManifest clip_manifests = 12 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
| Name |
Description |
index |
int
|
getClipManifestsOrBuilderList()
public List<? extends Clip.ClipManifestOrBuilder> getClipManifestsOrBuilderList()
Required. A list of clip manifests. Currently only one clip manifest is
allowed.
repeated .google.cloud.video.livestream.v1.Clip.ClipManifest clip_manifests = 12 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.video.livestream.v1.Clip.ClipManifestOrBuilder> |
|
getCreateTime()
public Timestamp getCreateTime()
Output only. The creation timestamp of the clip resource.
.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 timestamp of the clip resource.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Clip getDefaultInstanceForType()
| Returns |
| Type |
Description |
Clip |
|
getError()
Output only. An error object that describes the reason for the failure.
This property only presents when state is FAILED.
.google.rpc.Status error = 9 [(.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 only presents when state is FAILED.
.google.rpc.Status error = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
com.google.rpc.StatusOrBuilder |
|
getLabels() (deprecated)
public Map<String,String> getLabels()
getLabelsCount()
public int getLabelsCount()
The labels associated with this resource. Each label is a key-value pair.
map<string, string> labels = 5;
| Returns |
| Type |
Description |
int |
|
getLabelsMap()
public Map<String,String> getLabelsMap()
The labels associated with this resource. Each label is a key-value pair.
map<string, string> labels = 5;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
The labels associated with this resource. Each label is a key-value pair.
map<string, string> labels = 5;
| Returns |
| Type |
Description |
String |
|
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
The labels associated with this resource. Each label is a key-value pair.
map<string, string> labels = 5;
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
getName()
The resource name of the clip, in the following format:
projects/{project}/locations/{location}/channels/{c}/clips/{clipId}.
{clipId} is a user-specified resource id that conforms to the following
criteria:
- 1 character minimum, 63 characters maximum
- Only contains letters, digits, underscores, and hyphens
string name = 1;
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
The resource name of the clip, in the following format:
projects/{project}/locations/{location}/channels/{c}/clips/{clipId}.
{clipId} is a user-specified resource id that conforms to the following
criteria:
- 1 character minimum, 63 characters maximum
- Only contains letters, digits, underscores, and hyphens
string name = 1;
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getOutputUri()
public String getOutputUri()
Specify the output_uri to determine where to place the clip segments and
clip manifest files in Cloud Storage. The manifests specified in
clip_manifests fields will be placed under this URI. The exact URI of the
generated manifests will be provided in clip_manifests.output_uri for
each manifest.
Example:
"output_uri": "gs://my-bucket/clip-outputs"
"clip_manifests.output_uri": "gs://my-bucket/clip-outputs/main.m3u8"
string output_uri = 7;
| Returns |
| Type |
Description |
String |
The outputUri.
|
getOutputUriBytes()
public ByteString getOutputUriBytes()
Specify the output_uri to determine where to place the clip segments and
clip manifest files in Cloud Storage. The manifests specified in
clip_manifests fields will be placed under this URI. The exact URI of the
generated manifests will be provided in clip_manifests.output_uri for
each manifest.
Example:
"output_uri": "gs://my-bucket/clip-outputs"
"clip_manifests.output_uri": "gs://my-bucket/clip-outputs/main.m3u8"
string output_uri = 7;
| Returns |
| Type |
Description |
ByteString |
The bytes for outputUri.
|
getParserForType()
public Parser<Clip> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getSlices(int index)
public Clip.Slice getSlices(int index)
The specified ranges of segments to generate a clip.
repeated .google.cloud.video.livestream.v1.Clip.Slice slices = 10;
| Parameter |
| Name |
Description |
index |
int
|
getSlicesCount()
public int getSlicesCount()
The specified ranges of segments to generate a clip.
repeated .google.cloud.video.livestream.v1.Clip.Slice slices = 10;
| Returns |
| Type |
Description |
int |
|
getSlicesList()
public List<Clip.Slice> getSlicesList()
The specified ranges of segments to generate a clip.
repeated .google.cloud.video.livestream.v1.Clip.Slice slices = 10;
getSlicesOrBuilder(int index)
public Clip.SliceOrBuilder getSlicesOrBuilder(int index)
The specified ranges of segments to generate a clip.
repeated .google.cloud.video.livestream.v1.Clip.Slice slices = 10;
| Parameter |
| Name |
Description |
index |
int
|
getSlicesOrBuilderList()
public List<? extends Clip.SliceOrBuilder> getSlicesOrBuilderList()
The specified ranges of segments to generate a clip.
repeated .google.cloud.video.livestream.v1.Clip.Slice slices = 10;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.video.livestream.v1.Clip.SliceOrBuilder> |
|
getStartTime()
public Timestamp getStartTime()
Output only. The timestamp when the clip request starts to be processed.
.google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The startTime.
|
getStartTimeOrBuilder()
public TimestampOrBuilder getStartTimeOrBuilder()
Output only. The timestamp when the clip request starts to be processed.
.google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getState()
public Clip.State getState()
Output only. The state of the clip.
.google.cloud.video.livestream.v1.Clip.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue()
public int getStateValue()
Output only. The state of the clip.
.google.cloud.video.livestream.v1.Clip.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for state.
|
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The update timestamp of the clip resource.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The updateTime.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The update timestamp of the clip resource.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
public boolean hasCreateTime()
Output only. The creation timestamp of the clip resource.
.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 only presents when state is FAILED.
.google.rpc.Status error = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the error field is set.
|
hasStartTime()
public boolean hasStartTime()
Output only. The timestamp when the clip request starts to be processed.
.google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the startTime field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. The update timestamp of the clip resource.
.google.protobuf.Timestamp update_time = 4 [(.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
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Clip.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Clip.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Clip.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
