Class protos.google.cloud.video.transcoder.v1beta1.Job (1.5.0)

Represents a Job.

Package

@google-cloud/video-transcoder!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.video.transcoder.v1beta1.IJob);

Constructs a new Job.

Parameter
Name Description
properties IJob

Properties to set

Properties

config

public config?: (google.cloud.video.transcoder.v1beta1.IJobConfig|null);

Job config.

Property Value
Type Description
(google.cloud.video.transcoder.v1beta1.IJobConfig|null)

createTime

public createTime?: (google.protobuf.ITimestamp|null);

Job createTime.

Property Value
Type Description
(google.protobuf.ITimestamp|null)

endTime

public endTime?: (google.protobuf.ITimestamp|null);

Job endTime.

Property Value
Type Description
(google.protobuf.ITimestamp|null)

failureDetails

public failureDetails: google.cloud.video.transcoder.v1beta1.IFailureDetail[];

Job failureDetails.

Property Value
Type Description
google.cloud.video.transcoder.v1beta1.IFailureDetail[]

failureReason

public failureReason: string;

Job failureReason.

Property Value
Type Description
string

inputUri

public inputUri: string;

Job inputUri.

Property Value
Type Description
string

jobConfig

public jobConfig?: ("templateId"|"config");

Job jobConfig.

Property Value
Type Description
("templateId"|"config")

name

public name: string;

Job name.

Property Value
Type Description
string

originUri

public originUri?: (google.cloud.video.transcoder.v1beta1.Job.IOriginUri|null);

Job originUri.

Property Value
Type Description
(google.cloud.video.transcoder.v1beta1.Job.IOriginUri|null)

outputUri

public outputUri: string;

Job outputUri.

Property Value
Type Description
string

priority

public priority: number;

Job priority.

Property Value
Type Description
number

progress

public progress?: (google.cloud.video.transcoder.v1beta1.IProgress|null);

Job progress.

Property Value
Type Description
(google.cloud.video.transcoder.v1beta1.IProgress|null)

startTime

public startTime?: (google.protobuf.ITimestamp|null);

Job startTime.

Property Value
Type Description
(google.protobuf.ITimestamp|null)

state

public state: (google.cloud.video.transcoder.v1beta1.Job.ProcessingState|keyof typeof google.cloud.video.transcoder.v1beta1.Job.ProcessingState);

Job state.

Property Value
Type Description
(google.cloud.video.transcoder.v1beta1.Job.ProcessingState|keyof typeof google.cloud.video.transcoder.v1beta1.Job.ProcessingState)

templateId

public templateId?: (string|null);

Job templateId.

Property Value
Type Description
(string|null)

Methods

create(properties)

public static create(properties?: google.cloud.video.transcoder.v1beta1.IJob): google.cloud.video.transcoder.v1beta1.Job;

Creates a new Job instance using the specified properties.

Parameter
Name Description
properties IJob

Properties to set
Returns
Type Description
google.cloud.video.transcoder.v1beta1.Job

Job instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.video.transcoder.v1beta1.Job;

Decodes a Job message from the specified reader or buffer.

Parameters
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
length number

Message length if known beforehand
Returns
Type Description
google.cloud.video.transcoder.v1beta1.Job

Job

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.video.transcoder.v1beta1.Job;

Decodes a Job message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
google.cloud.video.transcoder.v1beta1.Job

Job

encode(message, writer)

public static encode(message: google.cloud.video.transcoder.v1beta1.IJob, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Job message. Does not implicitly messages.

Parameters
Name Description
message IJob

Job message or plain object to encode
writer $protobuf.Writer

Writer to encode to
Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.video.transcoder.v1beta1.IJob, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Job message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IJob

Job message or plain object to encode
writer $protobuf.Writer

Writer to encode to
Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.video.transcoder.v1beta1.Job;

Creates a Job message from a plain object. Also converts values to their respective internal types.

Parameter
Name Description
object { [k: string]: any }

Plain object
Returns
Type Description
google.cloud.video.transcoder.v1beta1.Job

Job

toJSON()

public toJSON(): { [k: string]: any };

Converts this Job to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.video.transcoder.v1beta1.Job, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a Job message. Also converts values to other types if specified.

Parameters
Name Description
message google.cloud.video.transcoder.v1beta1.Job

Job
options $protobuf.IConversionOptions

Conversion options
Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a Job message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify
Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not