com.google.cloud.video.livestream.v1.ClipOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-live-stream-v1 Show documentation
Show all versions of proto-google-cloud-live-stream-v1 Show documentation
Proto library for google-cloud-live-stream
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/video/livestream/v1/resources.proto
// Protobuf Java Version: 3.25.5
package com.google.cloud.video.livestream.v1;
public interface ClipOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.video.livestream.v1.Clip)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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. 1 character minimum, 63 characters maximum
* 2. Only contains letters, digits, underscores, and hyphens
*
*
* string name = 1;
*
* @return The name.
*/
java.lang.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. 1 character minimum, 63 characters maximum
* 2. Only contains letters, digits, underscores, and hyphens
*
*
* string name = 1;
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Output only. The creation timestamp of the clip resource.
*
*
* .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. The creation timestamp of the clip resource.
*
*
* .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Output only. The timestamp when the clip request starts to be processed.
*
*
* .google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the startTime field is set.
*/
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];
*
*
* @return The startTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder();
/**
*
*
*
* Output only. The update timestamp of the clip resource.
*
*
* .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the updateTime field is set.
*/
boolean hasUpdateTime();
/**
*
*
*
* Output only. The update timestamp of the clip resource.
*
*
* .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The updateTime.
*/
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];
*
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
/**
*
*
*
* The labels associated with this resource. Each label is a key-value pair.
*
*
* map<string, string> labels = 5;
*/
int getLabelsCount();
/**
*
*
*
* The labels associated with this resource. Each label is a key-value pair.
*
*
* map<string, string> labels = 5;
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* The labels associated with this resource. Each label is a key-value pair.
*
*
* map<string, string> labels = 5;
*/
java.util.Map getLabelsMap();
/**
*
*
*
* The labels associated with this resource. Each label is a key-value pair.
*
*
* map<string, string> labels = 5;
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* The labels associated with this resource. Each label is a key-value pair.
*
*
* map<string, string> labels = 5;
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* Output only. The state of the clip.
*
*
*
* .google.cloud.video.livestream.v1.Clip.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The enum numeric value on the wire for state.
*/
int getStateValue();
/**
*
*
*
* Output only. The state of the clip.
*
*
*
* .google.cloud.video.livestream.v1.Clip.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The state.
*/
com.google.cloud.video.livestream.v1.Clip.State getState();
/**
*
*
*
* 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;
*
* @return The outputUri.
*/
java.lang.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;
*
* @return The bytes for outputUri.
*/
com.google.protobuf.ByteString getOutputUriBytes();
/**
*
*
*
* 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];
*
* @return Whether the error field is set.
*/
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];
*
* @return The error.
*/
com.google.rpc.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];
*/
com.google.rpc.StatusOrBuilder getErrorOrBuilder();
/**
*
*
*
* The specified ranges of segments to generate a clip.
*
*
* repeated .google.cloud.video.livestream.v1.Clip.Slice slices = 10;
*/
java.util.List getSlicesList();
/**
*
*
*
* The specified ranges of segments to generate a clip.
*
*
* repeated .google.cloud.video.livestream.v1.Clip.Slice slices = 10;
*/
com.google.cloud.video.livestream.v1.Clip.Slice getSlices(int index);
/**
*
*
*
* The specified ranges of segments to generate a clip.
*
*
* repeated .google.cloud.video.livestream.v1.Clip.Slice slices = 10;
*/
int getSlicesCount();
/**
*
*
*
* The specified ranges of segments to generate a clip.
*
*
* repeated .google.cloud.video.livestream.v1.Clip.Slice slices = 10;
*/
java.util.List
getSlicesOrBuilderList();
/**
*
*
*
* The specified ranges of segments to generate a clip.
*
*
* repeated .google.cloud.video.livestream.v1.Clip.Slice slices = 10;
*/
com.google.cloud.video.livestream.v1.Clip.SliceOrBuilder getSlicesOrBuilder(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];
*
*/
java.util.List 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];
*
*/
com.google.cloud.video.livestream.v1.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];
*
*/
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];
*
*/
java.util.List
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];
*
*/
com.google.cloud.video.livestream.v1.Clip.ClipManifestOrBuilder getClipManifestsOrBuilder(
int index);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy