Represents a Job.
Package
@google-cloud/video-transcoderConstructors
(constructor)(properties)
constructor(properties?: google.cloud.video.transcoder.v1.IJob);
Constructs a new Job.
Name | Description |
properties |
IJob
Properties to set |
Properties
config
public config?: (google.cloud.video.transcoder.v1.IJobConfig|null);
Job config.
createTime
public createTime?: (google.protobuf.ITimestamp|null);
Job createTime.
endTime
public endTime?: (google.protobuf.ITimestamp|null);
Job endTime.
error
public error?: (google.rpc.IStatus|null);
Job error.
inputUri
public inputUri: string;
Job inputUri.
jobConfig
public jobConfig?: ("templateId"|"config");
Job jobConfig.
name
public name: string;
Job name.
outputUri
public outputUri: string;
Job outputUri.
startTime
public startTime?: (google.protobuf.ITimestamp|null);
Job startTime.
state
public state: (google.cloud.video.transcoder.v1.Job.ProcessingState|keyof typeof google.cloud.video.transcoder.v1.Job.ProcessingState);
Job state.
templateId
public templateId?: (string|null);
Job templateId.
ttlAfterCompletionDays
public ttlAfterCompletionDays: number;
Job ttlAfterCompletionDays.
Methods
create(properties)
public static create(properties?: google.cloud.video.transcoder.v1.IJob): google.cloud.video.transcoder.v1.Job;
Creates a new Job instance using the specified properties.
Name | Description |
properties |
IJob
Properties to set |
Type | Description |
google.cloud.video.transcoder.v1.Job | Job instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.video.transcoder.v1.Job;
Decodes a Job message from the specified reader or buffer.
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Type | Description |
google.cloud.video.transcoder.v1.Job | Job |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.video.transcoder.v1.Job;
Decodes a Job message from the specified reader or buffer, length delimited.
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
Type | Description |
google.cloud.video.transcoder.v1.Job | Job |
encode(message, writer)
public static encode(message: google.cloud.video.transcoder.v1.IJob, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Job message. Does not implicitly messages.
Name | Description |
message |
IJob
Job message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.video.transcoder.v1.IJob, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Job message, length delimited. Does not implicitly messages.
Name | Description |
message |
IJob
Job message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.video.transcoder.v1.Job;
Creates a Job message from a plain object. Also converts values to their respective internal types.
Name | Description |
object |
{ [k: string]: any }
Plain object |
Type | Description |
google.cloud.video.transcoder.v1.Job | Job |
toJSON()
public toJSON(): { [k: string]: any };
Converts this Job to JSON.
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.video.transcoder.v1.Job, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a Job message. Also converts values to other types if specified.
Name | Description |
message |
google.cloud.video.transcoder.v1.Job
Job |
options |
$protobuf.IConversionOptions
Conversion options |
Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies a Job message.
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Type | Description |
(string|null) |
|