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

Interface ClipOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Clip, Clip.Builder
@Generated public interface ClipOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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;
      Returns:
      The name.

    • getNameBytes

      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;
      Returns:
      The bytes for name.

    • hasCreateTime

      boolean hasCreateTime()
       Output only. The creation timestamp of the clip resource.
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      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];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

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

    • hasStartTime

      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:
      Whether the startTime field is set.

    • getStartTime

      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];
      Returns:
      The startTime.

    • getStartTimeOrBuilder

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

    • hasUpdateTime

      boolean hasUpdateTime()
       Output only. The update timestamp of the clip resource.
      .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      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];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

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

    • getLabelsCount

      int getLabelsCount()
       The labels associated with this resource. Each label is a key-value pair.
      map<string, string> labels = 5;

    • containsLabels

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

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

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

    • getLabelsOrDefault

      String getLabelsOrDefault(String key, String defaultValue)
       The labels associated with this resource. Each label is a key-value pair.
      map<string, string> labels = 5;

    • getLabelsOrThrow

      String getLabelsOrThrow(String key)
       The labels associated with this resource. Each label is a key-value pair.
      map<string, string> labels = 5;

    • getStateValue

      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:
      The enum numeric value on the wire for state.

    • getState

      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];
      Returns:
      The state.

    • getOutputUri

      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:
      The outputUri.

    • getOutputUriBytes

      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;
      Returns:
      The bytes for outputUri.

    • hasError

      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:
      Whether the error field is set.

    • getError

      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];
      Returns:
      The error.

    • getErrorOrBuilder

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

    • getSlicesList

      List<Clip.Slice> getSlicesList()
       The specified ranges of segments to generate a clip.
      repeated .google.cloud.video.livestream.v1.Clip.Slice slices = 10;

    • getSlices

      Clip.Slice getSlices(int index)
       The specified ranges of segments to generate a clip.
      repeated .google.cloud.video.livestream.v1.Clip.Slice slices = 10;

    • getSlicesCount

      int getSlicesCount()
       The specified ranges of segments to generate a clip.
      repeated .google.cloud.video.livestream.v1.Clip.Slice slices = 10;

    • getSlicesOrBuilderList

      List<? extends Clip.SliceOrBuilder> getSlicesOrBuilderList()
       The specified ranges of segments to generate a clip.
      repeated .google.cloud.video.livestream.v1.Clip.Slice slices = 10;

    • getSlicesOrBuilder

      Clip.SliceOrBuilder getSlicesOrBuilder(int index)
       The specified ranges of segments to generate a clip.
      repeated .google.cloud.video.livestream.v1.Clip.Slice slices = 10;

    • getClipManifestsList

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

    • getClipManifests

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

    • getClipManifestsCount

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

    • getClipManifestsOrBuilderList

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

    • getClipManifestsOrBuilder

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

    • getOutputTypeValue

      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];
      Returns:
      The enum numeric value on the wire for outputType.

    • getOutputType

      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];
      Returns:
      The outputType.