Class protos.google.cloud.automl.v1.OperationMetadata (3.1.2)

Version 3.1.2

• 4.0.1 (latest)
• 4.0.0
• 3.1.2
• 2.5.2
• 2.4.5

Represents an OperationMetadata.

Package

@google-cloud/automl

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.automl.v1.IOperationMetadata);

Constructs a new OperationMetadata.

Parameter
Name	Description
properties	IOperationMetadata Properties to set

Properties

batchPredictDetails

public batchPredictDetails?: (google.cloud.automl.v1.IBatchPredictOperationMetadata|null);

OperationMetadata batchPredictDetails.

createDatasetDetails

public createDatasetDetails?: (google.cloud.automl.v1.ICreateDatasetOperationMetadata|null);

OperationMetadata createDatasetDetails.

createModelDetails

public createModelDetails?: (google.cloud.automl.v1.ICreateModelOperationMetadata|null);

OperationMetadata createModelDetails.

createTime

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

OperationMetadata createTime.

deleteDetails

public deleteDetails?: (google.cloud.automl.v1.IDeleteOperationMetadata|null);

OperationMetadata deleteDetails.

deployModelDetails

public deployModelDetails?: (google.cloud.automl.v1.IDeployModelOperationMetadata|null);

OperationMetadata deployModelDetails.

details

public details?: ("deleteDetails"|"deployModelDetails"|"undeployModelDetails"|"createModelDetails"|"createDatasetDetails"|"importDataDetails"|"batchPredictDetails"|"exportDataDetails"|"exportModelDetails");

OperationMetadata details.

exportDataDetails

public exportDataDetails?: (google.cloud.automl.v1.IExportDataOperationMetadata|null);

OperationMetadata exportDataDetails.

exportModelDetails

public exportModelDetails?: (google.cloud.automl.v1.IExportModelOperationMetadata|null);

OperationMetadata exportModelDetails.

importDataDetails

public importDataDetails?: (google.cloud.automl.v1.IImportDataOperationMetadata|null);

OperationMetadata importDataDetails.

partialFailures

public partialFailures: google.rpc.IStatus[];

OperationMetadata partialFailures.

progressPercent

public progressPercent: number;

OperationMetadata progressPercent.

undeployModelDetails

public undeployModelDetails?: (google.cloud.automl.v1.IUndeployModelOperationMetadata|null);

OperationMetadata undeployModelDetails.

updateTime

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

OperationMetadata updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.automl.v1.IOperationMetadata): google.cloud.automl.v1.OperationMetadata;

Creates a new OperationMetadata instance using the specified properties.

Parameter
Name	Description
properties	IOperationMetadata Properties to set

Returns
Type	Description
google.cloud.automl.v1.OperationMetadata	OperationMetadata instance

decode(reader, length)

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

Decodes an OperationMetadata 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.automl.v1.OperationMetadata	OperationMetadata

decodeDelimited(reader)

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

Decodes an OperationMetadata 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.automl.v1.OperationMetadata	OperationMetadata

encode(message, writer)

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

Encodes the specified OperationMetadata message. Does not implicitly messages.

Parameters
Name	Description
message	IOperationMetadata OperationMetadata 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.automl.v1.IOperationMetadata, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name	Description
message	IOperationMetadata OperationMetadata 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.automl.v1.OperationMetadata;

Creates an OperationMetadata 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.automl.v1.OperationMetadata	OperationMetadata

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for OperationMetadata

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 OperationMetadata to JSON.

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

toObject(message, options)

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

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

Parameters
Name	Description
message	google.cloud.automl.v1.OperationMetadata OperationMetadata
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 an OperationMetadata 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