Interface ClipOrBuilder (0.57.0)

public interface ClipOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract 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
Returns
Type Description
boolean

getClipManifests(int index)

public abstract 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
Returns
Type Description
Clip.ClipManifest

getClipManifestsCount()

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

Returns
Type Description
List<ClipManifest>

getClipManifestsOrBuilder(int index)

public abstract 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
Returns
Type Description
Clip.ClipManifestOrBuilder

getClipManifestsOrBuilderList()

public abstract 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 abstract 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 abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The creation timestamp of the clip resource.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getError()

public abstract 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
Type Description
com.google.rpc.Status

The error.

getErrorOrBuilder()

public abstract 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 abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract 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 abstract Map<String,String> getLabelsMap()

The labels associated with this resource. Each label is a key-value pair.

map<string, string> labels = 5;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

The labels associated with this resource. Each label is a key-value pair.

map<string, string> labels = 5;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public abstract 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()

public abstract 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;

Returns
Type Description
String

The name.

getNameBytes()

public abstract 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. 1 character minimum, 63 characters maximum
  2. Only contains letters, digits, underscores, and hyphens

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getOutputUri()

public abstract 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 abstract 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.

getSlices(int index)

public abstract 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
Returns
Type Description
Clip.Slice

getSlicesCount()

public abstract 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 abstract List<Clip.Slice> getSlicesList()

The specified ranges of segments to generate a clip.

repeated .google.cloud.video.livestream.v1.Clip.Slice slices = 10;

Returns
Type Description
List<Slice>

getSlicesOrBuilder(int index)

public abstract 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
Returns
Type Description
Clip.SliceOrBuilder

getSlicesOrBuilderList()

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

Returns
Type Description
TimestampOrBuilder

getState()

public abstract 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
Type Description
Clip.State

The state.

getStateValue()

public abstract 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 abstract 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 abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The update timestamp of the clip resource.

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

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public abstract 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 abstract 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 abstract 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 abstract 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.