Class protos.google.cloud.aiplatform.v1.BatchPredictionJob (1.7.2)

Represents a BatchPredictionJob.

Package

@google-cloud/aiplatform!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.aiplatform.v1.IBatchPredictionJob);

Constructs a new BatchPredictionJob.

Parameter
Name Description
properties IBatchPredictionJob

Properties to set

Properties

completionStats

public completionStats?: (google.cloud.aiplatform.v1.ICompletionStats|null);

BatchPredictionJob completionStats.

Property Value
Type Description
(google.cloud.aiplatform.v1.ICompletionStats|null)

createTime

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

BatchPredictionJob createTime.

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

dedicatedResources

public dedicatedResources?: (google.cloud.aiplatform.v1.IBatchDedicatedResources|null);

BatchPredictionJob dedicatedResources.

Property Value
Type Description
(google.cloud.aiplatform.v1.IBatchDedicatedResources|null)

displayName

public displayName: string;

BatchPredictionJob displayName.

Property Value
Type Description
string

encryptionSpec

public encryptionSpec?: (google.cloud.aiplatform.v1.IEncryptionSpec|null);

BatchPredictionJob encryptionSpec.

Property Value
Type Description
(google.cloud.aiplatform.v1.IEncryptionSpec|null)

endTime

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

BatchPredictionJob endTime.

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

error

public error?: (google.rpc.IStatus|null);

BatchPredictionJob error.

Property Value
Type Description
(google.rpc.IStatus|null)

inputConfig

public inputConfig?: (google.cloud.aiplatform.v1.BatchPredictionJob.IInputConfig|null);

BatchPredictionJob inputConfig.

Property Value
Type Description
(google.cloud.aiplatform.v1.BatchPredictionJob.IInputConfig|null)

labels

public labels: { [k: string]: string };

BatchPredictionJob labels.

Property Value
Type Description
{ [k: string]: string }

manualBatchTuningParameters

public manualBatchTuningParameters?: (google.cloud.aiplatform.v1.IManualBatchTuningParameters|null);

BatchPredictionJob manualBatchTuningParameters.

Property Value
Type Description
(google.cloud.aiplatform.v1.IManualBatchTuningParameters|null)

model

public model: string;

BatchPredictionJob model.

Property Value
Type Description
string

modelParameters

public modelParameters?: (google.protobuf.IValue|null);

BatchPredictionJob modelParameters.

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

name

public name: string;

BatchPredictionJob name.

Property Value
Type Description
string

outputConfig

public outputConfig?: (google.cloud.aiplatform.v1.BatchPredictionJob.IOutputConfig|null);

BatchPredictionJob outputConfig.

Property Value
Type Description
(google.cloud.aiplatform.v1.BatchPredictionJob.IOutputConfig|null)

outputInfo

public outputInfo?: (google.cloud.aiplatform.v1.BatchPredictionJob.IOutputInfo|null);

BatchPredictionJob outputInfo.

Property Value
Type Description
(google.cloud.aiplatform.v1.BatchPredictionJob.IOutputInfo|null)

partialFailures

public partialFailures: google.rpc.IStatus[];

BatchPredictionJob partialFailures.

Property Value
Type Description
google.rpc.IStatus[]

resourcesConsumed

public resourcesConsumed?: (google.cloud.aiplatform.v1.IResourcesConsumed|null);

BatchPredictionJob resourcesConsumed.

Property Value
Type Description
(google.cloud.aiplatform.v1.IResourcesConsumed|null)

startTime

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

BatchPredictionJob startTime.

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

state

public state: (google.cloud.aiplatform.v1.JobState|keyof typeof google.cloud.aiplatform.v1.JobState);

BatchPredictionJob state.

Property Value
Type Description
(google.cloud.aiplatform.v1.JobState|keyof typeof google.cloud.aiplatform.v1.JobState)

updateTime

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

BatchPredictionJob updateTime.

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

Methods

create(properties)

public static create(properties?: google.cloud.aiplatform.v1.IBatchPredictionJob): google.cloud.aiplatform.v1.BatchPredictionJob;

Creates a new BatchPredictionJob instance using the specified properties.

Parameter
Name Description
properties IBatchPredictionJob

Properties to set
Returns
Type Description
google.cloud.aiplatform.v1.BatchPredictionJob

BatchPredictionJob instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.BatchPredictionJob;

Decodes a BatchPredictionJob 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.aiplatform.v1.BatchPredictionJob

BatchPredictionJob

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.BatchPredictionJob;

Decodes a BatchPredictionJob 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.aiplatform.v1.BatchPredictionJob

BatchPredictionJob

encode(message, writer)

public static encode(message: google.cloud.aiplatform.v1.IBatchPredictionJob, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified BatchPredictionJob message. Does not implicitly messages.

Parameters
Name Description
message IBatchPredictionJob

BatchPredictionJob 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.aiplatform.v1.IBatchPredictionJob, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IBatchPredictionJob

BatchPredictionJob 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.aiplatform.v1.BatchPredictionJob;

Creates a BatchPredictionJob 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.aiplatform.v1.BatchPredictionJob

BatchPredictionJob

toJSON()

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

Converts this BatchPredictionJob to JSON.

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

JSON object

toObject(message, options)

public static toObject(message: google.cloud.aiplatform.v1.BatchPredictionJob, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message google.cloud.aiplatform.v1.BatchPredictionJob

BatchPredictionJob
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 BatchPredictionJob 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