Class Video.Builder
-
- All Implemented Interfaces:
public final class Video.BuilderA builder for Video.
-
-
Method Summary
Modifier and Type Method Description final Video.Builderid(String id)Unique identifier for the video job. final Video.Builderid(JsonField<String> id)Sets Builder.id to an arbitrary JSON value. final Video.BuildercompletedAt(Long completedAt)Unix timestamp (seconds) for when the job completed, if finished. final Video.BuildercompletedAt(Long completedAt)Alias for Builder.completedAt. final Video.BuildercompletedAt(Optional<Long> completedAt)Alias for calling Builder.completedAt with completedAt.orElse(null).final Video.BuildercompletedAt(JsonField<Long> completedAt)Sets Builder.completedAt to an arbitrary JSON value. final Video.BuildercreatedAt(Long createdAt)Unix timestamp (seconds) for when the job was created. final Video.BuildercreatedAt(JsonField<Long> createdAt)Sets Builder.createdAt to an arbitrary JSON value. final Video.Buildererror(VideoCreateError error)Error payload that explains why generation failed, if applicable. final Video.Buildererror(Optional<VideoCreateError> error)Alias for calling Builder.error with error.orElse(null).final Video.Buildererror(JsonField<VideoCreateError> error)Sets Builder.error to an arbitrary JSON value. final Video.BuilderexpiresAt(Long expiresAt)Unix timestamp (seconds) for when the downloadable assets expire, if set. final Video.BuilderexpiresAt(Long expiresAt)Alias for Builder.expiresAt. final Video.BuilderexpiresAt(Optional<Long> expiresAt)Alias for calling Builder.expiresAt with expiresAt.orElse(null).final Video.BuilderexpiresAt(JsonField<Long> expiresAt)Sets Builder.expiresAt to an arbitrary JSON value. final Video.Buildermodel(VideoModel model)The video generation model that produced the job. final Video.Buildermodel(JsonField<VideoModel> model)Sets Builder.model to an arbitrary JSON value. final Video.Builderobject_(JsonValue object_)Sets the field to an arbitrary JSON value. final Video.Builderprogress(Long progress)Approximate completion percentage for the generation task. final Video.Builderprogress(JsonField<Long> progress)Sets Builder.progress to an arbitrary JSON value. final Video.BuilderremixedFromVideoId(String remixedFromVideoId)Identifier of the source video if this video is a remix. final Video.BuilderremixedFromVideoId(Optional<String> remixedFromVideoId)Alias for calling Builder.remixedFromVideoId with remixedFromVideoId.orElse(null).final Video.BuilderremixedFromVideoId(JsonField<String> remixedFromVideoId)Sets Builder.remixedFromVideoId to an arbitrary JSON value. final Video.Builderseconds(VideoSeconds seconds)Duration of the generated clip in seconds. final Video.Builderseconds(JsonField<VideoSeconds> seconds)Sets Builder.seconds to an arbitrary JSON value. final Video.Buildersize(VideoSize size)The resolution of the generated video. final Video.Buildersize(JsonField<VideoSize> size)Sets Builder.size to an arbitrary JSON value. final Video.Builderstatus(Video.Status status)Current lifecycle status of the video job. final Video.Builderstatus(JsonField<Video.Status> status)Sets Builder.status to an arbitrary JSON value. final Video.BuilderadditionalProperties(Map<String, JsonValue> additionalProperties)final Video.BuilderputAdditionalProperty(String key, JsonValue value)final Video.BuilderputAllAdditionalProperties(Map<String, JsonValue> additionalProperties)final Video.BuilderremoveAdditionalProperty(String key)final Video.BuilderremoveAllAdditionalProperties(Set<String> keys)final Videobuild()Returns an immutable instance of Video. -
-
Method Detail
-
id
final Video.Builder id(String id)
Unique identifier for the video job.
-
id
final Video.Builder id(JsonField<String> id)
Sets Builder.id to an arbitrary JSON value.
You should usually call Builder.id with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
completedAt
final Video.Builder completedAt(Long completedAt)
Unix timestamp (seconds) for when the job completed, if finished.
-
completedAt
final Video.Builder completedAt(Long completedAt)
Alias for Builder.completedAt.
This unboxed primitive overload exists for backwards compatibility.
-
completedAt
final Video.Builder completedAt(Optional<Long> completedAt)
Alias for calling Builder.completedAt with
completedAt.orElse(null).
-
completedAt
final Video.Builder completedAt(JsonField<Long> completedAt)
Sets Builder.completedAt to an arbitrary JSON value.
You should usually call Builder.completedAt with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
createdAt
final Video.Builder createdAt(Long createdAt)
Unix timestamp (seconds) for when the job was created.
-
createdAt
final Video.Builder createdAt(JsonField<Long> createdAt)
Sets Builder.createdAt to an arbitrary JSON value.
You should usually call Builder.createdAt with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
error
final Video.Builder error(VideoCreateError error)
Error payload that explains why generation failed, if applicable.
-
error
final Video.Builder error(Optional<VideoCreateError> error)
Alias for calling Builder.error with
error.orElse(null).
-
error
final Video.Builder error(JsonField<VideoCreateError> error)
Sets Builder.error to an arbitrary JSON value.
You should usually call Builder.error with a well-typed VideoCreateError value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
expiresAt
final Video.Builder expiresAt(Long expiresAt)
Unix timestamp (seconds) for when the downloadable assets expire, if set.
-
expiresAt
final Video.Builder expiresAt(Long expiresAt)
Alias for Builder.expiresAt.
This unboxed primitive overload exists for backwards compatibility.
-
expiresAt
final Video.Builder expiresAt(Optional<Long> expiresAt)
Alias for calling Builder.expiresAt with
expiresAt.orElse(null).
-
expiresAt
final Video.Builder expiresAt(JsonField<Long> expiresAt)
Sets Builder.expiresAt to an arbitrary JSON value.
You should usually call Builder.expiresAt with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
model
final Video.Builder model(VideoModel model)
The video generation model that produced the job.
-
model
final Video.Builder model(JsonField<VideoModel> model)
Sets Builder.model to an arbitrary JSON value.
You should usually call Builder.model with a well-typed VideoModel value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
object_
final Video.Builder object_(JsonValue object_)
Sets the field to an arbitrary JSON value.
It is usually unnecessary to call this method because the field defaults to the following:
JsonValue.from("video")This method is primarily for setting the field to an undocumented or not yet supported value.
-
progress
final Video.Builder progress(Long progress)
Approximate completion percentage for the generation task.
-
progress
final Video.Builder progress(JsonField<Long> progress)
Sets Builder.progress to an arbitrary JSON value.
You should usually call Builder.progress with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
remixedFromVideoId
final Video.Builder remixedFromVideoId(String remixedFromVideoId)
Identifier of the source video if this video is a remix.
-
remixedFromVideoId
final Video.Builder remixedFromVideoId(Optional<String> remixedFromVideoId)
Alias for calling Builder.remixedFromVideoId with
remixedFromVideoId.orElse(null).
-
remixedFromVideoId
final Video.Builder remixedFromVideoId(JsonField<String> remixedFromVideoId)
Sets Builder.remixedFromVideoId to an arbitrary JSON value.
You should usually call Builder.remixedFromVideoId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
seconds
final Video.Builder seconds(VideoSeconds seconds)
Duration of the generated clip in seconds.
-
seconds
final Video.Builder seconds(JsonField<VideoSeconds> seconds)
Sets Builder.seconds to an arbitrary JSON value.
You should usually call Builder.seconds with a well-typed VideoSeconds value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
size
final Video.Builder size(VideoSize size)
The resolution of the generated video.
-
size
final Video.Builder size(JsonField<VideoSize> size)
Sets Builder.size to an arbitrary JSON value.
You should usually call Builder.size with a well-typed VideoSize value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
status
final Video.Builder status(Video.Status status)
Current lifecycle status of the video job.
-
status
final Video.Builder status(JsonField<Video.Status> status)
Sets Builder.status to an arbitrary JSON value.
You should usually call Builder.status with a well-typed Status value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
additionalProperties
final Video.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
-
putAdditionalProperty
final Video.Builder putAdditionalProperty(String key, JsonValue value)
-
putAllAdditionalProperties
final Video.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
-
removeAdditionalProperty
final Video.Builder removeAdditionalProperty(String key)
-
removeAllAdditionalProperties
final Video.Builder removeAllAdditionalProperties(Set<String> keys)
-
-
-
-