Package com.google.cloud.video.livestream.v1

Class Clip

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.video.livestream.v1.Clip
All Implemented Interfaces:
ClipOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Clip extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getName

      public String getName()
       The resource name of the clip, in the following format:
 `projects/{project}/locations/{location}/channels/{channelId}/clips/{clipId}`.
 `{clipId}` is a user-specified resource id that conforms to the following
 criteria:

 1. 1 character minimum, 63 characters maximum
 2. Only contains letters, digits, underscores, and hyphens
      string name = 1;
      Specified by:
      getName in interface ClipOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       The resource name of the clip, in the following format:
 `projects/{project}/locations/{location}/channels/{channelId}/clips/{clipId}`.
 `{clipId}` is a user-specified resource id that conforms to the following
 criteria:

 1. 1 character minimum, 63 characters maximum
 2. Only contains letters, digits, underscores, and hyphens
      string name = 1;
      Specified by:
      getNameBytes in interface ClipOrBuilder
      Returns:
      The bytes for name.

    • 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];
      Specified by:
      hasCreateTime in interface ClipOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. The creation timestamp of the clip resource.
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface ClipOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The creation timestamp of the clip resource.
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface ClipOrBuilder

    • 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];
      Specified by:
      hasStartTime in interface ClipOrBuilder
      Returns:
      Whether the startTime field is set.

    • getStartTime

      public com.google.protobuf.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];
      Specified by:
      getStartTime in interface ClipOrBuilder
      Returns:
      The startTime.

    • getStartTimeOrBuilder

      public com.google.protobuf.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];
      Specified by:
      getStartTimeOrBuilder in interface ClipOrBuilder

    • 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];
      Specified by:
      hasUpdateTime in interface ClipOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public com.google.protobuf.Timestamp getUpdateTime()
       Output only. The update timestamp of the clip resource.
      .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTime in interface ClipOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. The update timestamp of the clip resource.
      .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface ClipOrBuilder

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: ClipOrBuilder
       The labels associated with this resource. Each label is a key-value pair.
      map<string, string> labels = 5;
      Specified by:
      getLabelsCount in interface ClipOrBuilder

    • containsLabels

      public boolean containsLabels(String key)
       The labels associated with this resource. Each label is a key-value pair.
      map<string, string> labels = 5;
      Specified by:
      containsLabels in interface ClipOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface ClipOrBuilder

    • getLabelsMap

      public Map<String,String> getLabelsMap()
       The labels associated with this resource. Each label is a key-value pair.
      map<string, string> labels = 5;
      Specified by:
      getLabelsMap in interface ClipOrBuilder

    • getLabelsOrDefault

      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;
      Specified by:
      getLabelsOrDefault in interface ClipOrBuilder

    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       The labels associated with this resource. Each label is a key-value pair.
      map<string, string> labels = 5;
      Specified by:
      getLabelsOrThrow in interface ClipOrBuilder

    • 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];
      Specified by:
      getStateValue in interface ClipOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • 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];
      Specified by:
      getState in interface ClipOrBuilder
      Returns:
      The state.

    • 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;
      Specified by:
      getOutputUri in interface ClipOrBuilder
      Returns:
      The outputUri.

    • getOutputUriBytes

      public com.google.protobuf.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;
      Specified by:
      getOutputUriBytes in interface ClipOrBuilder
      Returns:
      The bytes for outputUri.

    • 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];
      Specified by:
      hasError in interface ClipOrBuilder
      Returns:
      Whether the error field is set.

    • getError

      public Status 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];
      Specified by:
      getError in interface ClipOrBuilder
      Returns:
      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];
      Specified by:
      getErrorOrBuilder in interface ClipOrBuilder

    • 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;
      Specified by:
      getSlicesList in interface ClipOrBuilder

    • 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;
      Specified by:
      getSlicesOrBuilderList in interface ClipOrBuilder

    • getSlicesCount

      public int getSlicesCount()
       The specified ranges of segments to generate a clip.
      repeated .google.cloud.video.livestream.v1.Clip.Slice slices = 10;
      Specified by:
      getSlicesCount in interface ClipOrBuilder

    • getSlices

      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;
      Specified by:
      getSlices in interface ClipOrBuilder

    • getSlicesOrBuilder

      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;
      Specified by:
      getSlicesOrBuilder in interface ClipOrBuilder

    • 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];
      Specified by:
      getClipManifestsList in interface ClipOrBuilder

    • 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];
      Specified by:
      getClipManifestsOrBuilderList in interface ClipOrBuilder

    • 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];
      Specified by:
      getClipManifestsCount in interface ClipOrBuilder

    • getClipManifests

      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];
      Specified by:
      getClipManifests in interface ClipOrBuilder

    • getClipManifestsOrBuilder

      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];
      Specified by:
      getClipManifestsOrBuilder in interface ClipOrBuilder

    • getOutputTypeValue

      public int getOutputTypeValue()
       Optional. OutputType of the clip. If not specified, the default value is
 MANIFEST.
      .google.cloud.video.livestream.v1.Clip.OutputType output_type = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getOutputTypeValue in interface ClipOrBuilder
      Returns:
      The enum numeric value on the wire for outputType.

    • getOutputType

      public Clip.OutputType getOutputType()
       Optional. OutputType of the clip. If not specified, the default value is
 MANIFEST.
      .google.cloud.video.livestream.v1.Clip.OutputType output_type = 13 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getOutputType in interface ClipOrBuilder
      Returns:
      The outputType.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Clip parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Clip parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Clip parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Clip parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Clip parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Clip parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Clip parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Clip parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Clip parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Clip parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Clip parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Clip parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Clip.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Clip.Builder newBuilder()

    • newBuilder

      public static Clip.Builder newBuilder(Clip prototype)

    • toBuilder

      public Clip.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Clip.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Clip getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Clip> parser()

    • getParserForType

      public com.google.protobuf.Parser<Clip> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Clip getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder