Class Video
-
- All Implemented Interfaces:
public final class VideoStructured information describing a generated video job.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classVideo.BuilderA builder for Video.
public final classVideo.StatusCurrent lifecycle status of the video job.
-
Method Summary
Modifier and Type Method Description final Stringid()Unique identifier for the video job. final Optional<Long>completedAt()Unix timestamp (seconds) for when the job completed, if finished. final LongcreatedAt()Unix timestamp (seconds) for when the job was created. final Optional<VideoCreateError>error()Error payload that explains why generation failed, if applicable. final Optional<Long>expiresAt()Unix timestamp (seconds) for when the downloadable assets expire, if set. final VideoModelmodel()The video generation model that produced the job. final JsonValue_object_()The object type, which is always video.final Longprogress()Approximate completion percentage for the generation task. final Optional<String>prompt()The prompt that was used to generate the video. final Optional<String>remixedFromVideoId()Identifier of the source video if this video is a remix. final VideoSecondsseconds()Duration of the generated clip in seconds. final VideoSizesize()The resolution of the generated video. final Video.Statusstatus()Current lifecycle status of the video job. final JsonField<String>_id()Returns the raw JSON value of id. final JsonField<Long>_completedAt()Returns the raw JSON value of completedAt. final JsonField<Long>_createdAt()Returns the raw JSON value of createdAt. final JsonField<VideoCreateError>_error()Returns the raw JSON value of error. final JsonField<Long>_expiresAt()Returns the raw JSON value of expiresAt. final JsonField<VideoModel>_model()Returns the raw JSON value of model. final JsonField<Long>_progress()Returns the raw JSON value of progress. final JsonField<String>_prompt()Returns the raw JSON value of prompt. final JsonField<String>_remixedFromVideoId()Returns the raw JSON value of remixedFromVideoId. final JsonField<VideoSeconds>_seconds()Returns the raw JSON value of seconds. final JsonField<VideoSize>_size()Returns the raw JSON value of size. final JsonField<Video.Status>_status()Returns the raw JSON value of status. final Map<String, JsonValue>_additionalProperties()final Video.BuildertoBuilder()final Videovalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static Video.Builderbuilder()Returns a mutable builder for constructing an instance of Video. -
-
Method Detail
-
completedAt
final Optional<Long> completedAt()
Unix timestamp (seconds) for when the job completed, if finished.
-
error
final Optional<VideoCreateError> error()
Error payload that explains why generation failed, if applicable.
-
expiresAt
final Optional<Long> expiresAt()
Unix timestamp (seconds) for when the downloadable assets expire, if set.
-
model
final VideoModel model()
The video generation model that produced the job.
-
_object_
final JsonValue _object_()
The object type, which is always
video.Expected to always return the following:
JsonValue.from("video")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
remixedFromVideoId
final Optional<String> remixedFromVideoId()
Identifier of the source video if this video is a remix.
-
seconds
final VideoSeconds seconds()
Duration of the generated clip in seconds. For extensions, this is the stitched total duration.
-
status
final Video.Status status()
Current lifecycle status of the video job.
-
_id
final JsonField<String> _id()
Returns the raw JSON value of id.
Unlike id, this method doesn't throw if the JSON field has an unexpected type.
-
_completedAt
final JsonField<Long> _completedAt()
Returns the raw JSON value of completedAt.
Unlike completedAt, this method doesn't throw if the JSON field has an unexpected type.
-
_createdAt
final JsonField<Long> _createdAt()
Returns the raw JSON value of createdAt.
Unlike createdAt, this method doesn't throw if the JSON field has an unexpected type.
-
_error
final JsonField<VideoCreateError> _error()
Returns the raw JSON value of error.
Unlike error, this method doesn't throw if the JSON field has an unexpected type.
-
_expiresAt
final JsonField<Long> _expiresAt()
Returns the raw JSON value of expiresAt.
Unlike expiresAt, this method doesn't throw if the JSON field has an unexpected type.
-
_model
final JsonField<VideoModel> _model()
Returns the raw JSON value of model.
Unlike model, this method doesn't throw if the JSON field has an unexpected type.
-
_progress
final JsonField<Long> _progress()
Returns the raw JSON value of progress.
Unlike progress, this method doesn't throw if the JSON field has an unexpected type.
-
_prompt
final JsonField<String> _prompt()
Returns the raw JSON value of prompt.
Unlike prompt, this method doesn't throw if the JSON field has an unexpected type.
-
_remixedFromVideoId
final JsonField<String> _remixedFromVideoId()
Returns the raw JSON value of remixedFromVideoId.
Unlike remixedFromVideoId, this method doesn't throw if the JSON field has an unexpected type.
-
_seconds
final JsonField<VideoSeconds> _seconds()
Returns the raw JSON value of seconds.
Unlike seconds, this method doesn't throw if the JSON field has an unexpected type.
-
_size
final JsonField<VideoSize> _size()
Returns the raw JSON value of size.
Unlike size, this method doesn't throw if the JSON field has an unexpected type.
-
_status
final JsonField<Video.Status> _status()
Returns the raw JSON value of status.
Unlike status, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final Video.Builder toBuilder()
-
validate
final Video validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static Video.Builder builder()
Returns a mutable builder for constructing an instance of Video.
The following fields are required:
.id() .completedAt() .createdAt() .error() .expiresAt() .model() .progress() .prompt() .remixedFromVideoId() .seconds() .size() .status()
-
-
-
-