Class protos.google.cloud.aiplatform.v1beta1.FeatureMonitorJob (6.4.0)

Represents a FeatureMonitorJob.

Package

@google-cloud/aiplatform

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.aiplatform.v1beta1.IFeatureMonitorJob);

Constructs a new FeatureMonitorJob.

Parameter
Name Description
properties IFeatureMonitorJob

Properties to set

Properties

createTime

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

FeatureMonitorJob createTime.

description

public description: string;

FeatureMonitorJob description.

driftBaseFeatureMonitorJobId

public driftBaseFeatureMonitorJobId: (number|Long|string);

FeatureMonitorJob driftBaseFeatureMonitorJobId.

driftBaseSnapshotTime

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

FeatureMonitorJob driftBaseSnapshotTime.

featureSelectionConfig

public featureSelectionConfig?: (google.cloud.aiplatform.v1beta1.IFeatureSelectionConfig|null);

FeatureMonitorJob featureSelectionConfig.

finalStatus

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

FeatureMonitorJob finalStatus.

jobSummary

public jobSummary?: (google.cloud.aiplatform.v1beta1.FeatureMonitorJob.IJobSummary|null);

FeatureMonitorJob jobSummary.

labels

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

FeatureMonitorJob labels.

name

public name: string;

FeatureMonitorJob name.

triggerType

public triggerType: (google.cloud.aiplatform.v1beta1.FeatureMonitorJob.FeatureMonitorJobTrigger|keyof typeof google.cloud.aiplatform.v1beta1.FeatureMonitorJob.FeatureMonitorJobTrigger);

FeatureMonitorJob triggerType.

Methods

create(properties)

public static create(properties?: google.cloud.aiplatform.v1beta1.IFeatureMonitorJob): google.cloud.aiplatform.v1beta1.FeatureMonitorJob;

Creates a new FeatureMonitorJob instance using the specified properties.

Parameter
Name Description
properties IFeatureMonitorJob

Properties to set

Returns
Type Description
FeatureMonitorJob

FeatureMonitorJob instance

decode(reader, length)

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

Decodes a FeatureMonitorJob message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
FeatureMonitorJob

FeatureMonitorJob

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
FeatureMonitorJob

FeatureMonitorJob

encode(message, writer)

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

Encodes the specified FeatureMonitorJob message. Does not implicitly messages.

Parameters
Name Description
message IFeatureMonitorJob

FeatureMonitorJob 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.v1beta1.IFeatureMonitorJob, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IFeatureMonitorJob

FeatureMonitorJob 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.v1beta1.FeatureMonitorJob;

Creates a FeatureMonitorJob 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
FeatureMonitorJob

FeatureMonitorJob

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for FeatureMonitorJob

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message FeatureMonitorJob

FeatureMonitorJob

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