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

Represents a BatchPredictionJob.

Package

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.

createTime

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

BatchPredictionJob createTime.

dedicatedResources

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

BatchPredictionJob dedicatedResources.

displayName

public displayName: string;

BatchPredictionJob displayName.

encryptionSpec

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

BatchPredictionJob encryptionSpec.

endTime

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

BatchPredictionJob endTime.

error

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

BatchPredictionJob error.

explanationSpec

public explanationSpec?: (google.cloud.aiplatform.v1.IExplanationSpec|null);

BatchPredictionJob explanationSpec.

generateExplanation

public generateExplanation: boolean;

BatchPredictionJob generateExplanation.

inputConfig

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

BatchPredictionJob inputConfig.

instanceConfig

public instanceConfig?: (google.cloud.aiplatform.v1.BatchPredictionJob.IInstanceConfig|null);

BatchPredictionJob instanceConfig.

labels

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

BatchPredictionJob labels.

manualBatchTuningParameters

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

BatchPredictionJob manualBatchTuningParameters.

model

public model: string;

BatchPredictionJob model.

modelParameters

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

BatchPredictionJob modelParameters.

modelVersionId

public modelVersionId: string;

BatchPredictionJob modelVersionId.

name

public name: string;

BatchPredictionJob name.

outputConfig

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

BatchPredictionJob outputConfig.

outputInfo

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

BatchPredictionJob outputInfo.

partialFailures

public partialFailures: google.rpc.IStatus[];

BatchPredictionJob partialFailures.

resourcesConsumed

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

BatchPredictionJob resourcesConsumed.

serviceAccount

public serviceAccount: string;

BatchPredictionJob serviceAccount.

startTime

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

BatchPredictionJob startTime.

state

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

BatchPredictionJob state.

unmanagedContainerModel

public unmanagedContainerModel?: (google.cloud.aiplatform.v1.IUnmanagedContainerModel|null);

BatchPredictionJob unmanagedContainerModel.

updateTime

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

BatchPredictionJob updateTime.

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

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for BatchPredictionJob

Parameter

Name	Description
`typeUrlPrefix`	`string` your custom typeUrlPrefix(default "type.googleapis.com")

Returns

Type	Description
`string`	The default type url

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