@google-cloud/aiplatform
Version:
Vertex AI client for Node.js
1,017 lines (802 loc) • 19.2 MB
TypeScript
// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
import type {protobuf as $protobuf} from "google-gax";
import Long = require("long");
/** Namespace google. */
export namespace google {
/** Namespace cloud. */
namespace cloud {
/** Namespace aiplatform. */
namespace aiplatform {
/** Namespace v1. */
namespace v1 {
/** AcceleratorType enum. */
enum AcceleratorType {
ACCELERATOR_TYPE_UNSPECIFIED = 0,
NVIDIA_TESLA_K80 = 1,
NVIDIA_TESLA_P100 = 2,
NVIDIA_TESLA_V100 = 3,
NVIDIA_TESLA_P4 = 4,
NVIDIA_TESLA_T4 = 5,
NVIDIA_TESLA_A100 = 8,
NVIDIA_A100_80GB = 9,
NVIDIA_L4 = 11,
NVIDIA_H100_80GB = 13,
NVIDIA_H100_MEGA_80GB = 14,
NVIDIA_H200_141GB = 15,
NVIDIA_B200 = 16,
NVIDIA_GB200 = 17,
TPU_V2 = 6,
TPU_V3 = 7,
TPU_V4_POD = 10,
TPU_V5_LITEPOD = 12
}
/** Properties of an Annotation. */
interface IAnnotation {
/** Annotation name */
name?: (string|null);
/** Annotation payloadSchemaUri */
payloadSchemaUri?: (string|null);
/** Annotation payload */
payload?: (google.protobuf.IValue|null);
/** Annotation createTime */
createTime?: (google.protobuf.ITimestamp|null);
/** Annotation updateTime */
updateTime?: (google.protobuf.ITimestamp|null);
/** Annotation etag */
etag?: (string|null);
/** Annotation annotationSource */
annotationSource?: (google.cloud.aiplatform.v1.IUserActionReference|null);
/** Annotation labels */
labels?: ({ [k: string]: string }|null);
}
/** Represents an Annotation. */
class Annotation implements IAnnotation {
/**
* Constructs a new Annotation.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.aiplatform.v1.IAnnotation);
/** Annotation name. */
public name: string;
/** Annotation payloadSchemaUri. */
public payloadSchemaUri: string;
/** Annotation payload. */
public payload?: (google.protobuf.IValue|null);
/** Annotation createTime. */
public createTime?: (google.protobuf.ITimestamp|null);
/** Annotation updateTime. */
public updateTime?: (google.protobuf.ITimestamp|null);
/** Annotation etag. */
public etag: string;
/** Annotation annotationSource. */
public annotationSource?: (google.cloud.aiplatform.v1.IUserActionReference|null);
/** Annotation labels. */
public labels: { [k: string]: string };
/**
* Creates a new Annotation instance using the specified properties.
* @param [properties] Properties to set
* @returns Annotation instance
*/
public static create(properties?: google.cloud.aiplatform.v1.IAnnotation): google.cloud.aiplatform.v1.Annotation;
/**
* Encodes the specified Annotation message. Does not implicitly {@link google.cloud.aiplatform.v1.Annotation.verify|verify} messages.
* @param message Annotation message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.aiplatform.v1.IAnnotation, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified Annotation message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.Annotation.verify|verify} messages.
* @param message Annotation message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.aiplatform.v1.IAnnotation, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes an Annotation message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns Annotation
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.Annotation;
/**
* Decodes an Annotation message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns Annotation
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.Annotation;
/**
* Verifies an Annotation message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates an Annotation message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns Annotation
*/
public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.Annotation;
/**
* Creates a plain object from an Annotation message. Also converts values to other types if specified.
* @param message Annotation
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.aiplatform.v1.Annotation, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this Annotation to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for Annotation
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a UserActionReference. */
interface IUserActionReference {
/** UserActionReference operation */
operation?: (string|null);
/** UserActionReference dataLabelingJob */
dataLabelingJob?: (string|null);
/** UserActionReference method */
method?: (string|null);
}
/** Represents a UserActionReference. */
class UserActionReference implements IUserActionReference {
/**
* Constructs a new UserActionReference.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.aiplatform.v1.IUserActionReference);
/** UserActionReference operation. */
public operation?: (string|null);
/** UserActionReference dataLabelingJob. */
public dataLabelingJob?: (string|null);
/** UserActionReference method. */
public method: string;
/** UserActionReference reference. */
public reference?: ("operation"|"dataLabelingJob");
/**
* Creates a new UserActionReference instance using the specified properties.
* @param [properties] Properties to set
* @returns UserActionReference instance
*/
public static create(properties?: google.cloud.aiplatform.v1.IUserActionReference): google.cloud.aiplatform.v1.UserActionReference;
/**
* Encodes the specified UserActionReference message. Does not implicitly {@link google.cloud.aiplatform.v1.UserActionReference.verify|verify} messages.
* @param message UserActionReference message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.aiplatform.v1.IUserActionReference, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified UserActionReference message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.UserActionReference.verify|verify} messages.
* @param message UserActionReference message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.aiplatform.v1.IUserActionReference, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a UserActionReference message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns UserActionReference
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.UserActionReference;
/**
* Decodes a UserActionReference message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns UserActionReference
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.UserActionReference;
/**
* Verifies a UserActionReference message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a UserActionReference message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns UserActionReference
*/
public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.UserActionReference;
/**
* Creates a plain object from a UserActionReference message. Also converts values to other types if specified.
* @param message UserActionReference
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.aiplatform.v1.UserActionReference, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this UserActionReference to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for UserActionReference
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of an AnnotationSpec. */
interface IAnnotationSpec {
/** AnnotationSpec name */
name?: (string|null);
/** AnnotationSpec displayName */
displayName?: (string|null);
/** AnnotationSpec createTime */
createTime?: (google.protobuf.ITimestamp|null);
/** AnnotationSpec updateTime */
updateTime?: (google.protobuf.ITimestamp|null);
/** AnnotationSpec etag */
etag?: (string|null);
}
/** Represents an AnnotationSpec. */
class AnnotationSpec implements IAnnotationSpec {
/**
* Constructs a new AnnotationSpec.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.aiplatform.v1.IAnnotationSpec);
/** AnnotationSpec name. */
public name: string;
/** AnnotationSpec displayName. */
public displayName: string;
/** AnnotationSpec createTime. */
public createTime?: (google.protobuf.ITimestamp|null);
/** AnnotationSpec updateTime. */
public updateTime?: (google.protobuf.ITimestamp|null);
/** AnnotationSpec etag. */
public etag: string;
/**
* Creates a new AnnotationSpec instance using the specified properties.
* @param [properties] Properties to set
* @returns AnnotationSpec instance
*/
public static create(properties?: google.cloud.aiplatform.v1.IAnnotationSpec): google.cloud.aiplatform.v1.AnnotationSpec;
/**
* Encodes the specified AnnotationSpec message. Does not implicitly {@link google.cloud.aiplatform.v1.AnnotationSpec.verify|verify} messages.
* @param message AnnotationSpec message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.aiplatform.v1.IAnnotationSpec, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified AnnotationSpec message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.AnnotationSpec.verify|verify} messages.
* @param message AnnotationSpec message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.aiplatform.v1.IAnnotationSpec, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes an AnnotationSpec message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns AnnotationSpec
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.AnnotationSpec;
/**
* Decodes an AnnotationSpec message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns AnnotationSpec
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.AnnotationSpec;
/**
* Verifies an AnnotationSpec message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates an AnnotationSpec message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns AnnotationSpec
*/
public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.AnnotationSpec;
/**
* Creates a plain object from an AnnotationSpec message. Also converts values to other types if specified.
* @param message AnnotationSpec
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.aiplatform.v1.AnnotationSpec, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this AnnotationSpec to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for AnnotationSpec
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of an ApiAuth. */
interface IApiAuth {
/** ApiAuth apiKeyConfig */
apiKeyConfig?: (google.cloud.aiplatform.v1.ApiAuth.IApiKeyConfig|null);
}
/** Represents an ApiAuth. */
class ApiAuth implements IApiAuth {
/**
* Constructs a new ApiAuth.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.aiplatform.v1.IApiAuth);
/** ApiAuth apiKeyConfig. */
public apiKeyConfig?: (google.cloud.aiplatform.v1.ApiAuth.IApiKeyConfig|null);
/** ApiAuth authConfig. */
public authConfig?: "apiKeyConfig";
/**
* Creates a new ApiAuth instance using the specified properties.
* @param [properties] Properties to set
* @returns ApiAuth instance
*/
public static create(properties?: google.cloud.aiplatform.v1.IApiAuth): google.cloud.aiplatform.v1.ApiAuth;
/**
* Encodes the specified ApiAuth message. Does not implicitly {@link google.cloud.aiplatform.v1.ApiAuth.verify|verify} messages.
* @param message ApiAuth message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.aiplatform.v1.IApiAuth, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified ApiAuth message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.ApiAuth.verify|verify} messages.
* @param message ApiAuth message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.aiplatform.v1.IApiAuth, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes an ApiAuth message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns ApiAuth
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.ApiAuth;
/**
* Decodes an ApiAuth message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns ApiAuth
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.ApiAuth;
/**
* Verifies an ApiAuth message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates an ApiAuth message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns ApiAuth
*/
public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.ApiAuth;
/**
* Creates a plain object from an ApiAuth message. Also converts values to other types if specified.
* @param message ApiAuth
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.aiplatform.v1.ApiAuth, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this ApiAuth to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for ApiAuth
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
namespace ApiAuth {
/** Properties of an ApiKeyConfig. */
interface IApiKeyConfig {
/** ApiKeyConfig apiKeySecretVersion */
apiKeySecretVersion?: (string|null);
}
/** Represents an ApiKeyConfig. */
class ApiKeyConfig implements IApiKeyConfig {
/**
* Constructs a new ApiKeyConfig.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.aiplatform.v1.ApiAuth.IApiKeyConfig);
/** ApiKeyConfig apiKeySecretVersion. */
public apiKeySecretVersion: string;
/**
* Creates a new ApiKeyConfig instance using the specified properties.
* @param [properties] Properties to set
* @returns ApiKeyConfig instance
*/
public static create(properties?: google.cloud.aiplatform.v1.ApiAuth.IApiKeyConfig): google.cloud.aiplatform.v1.ApiAuth.ApiKeyConfig;
/**
* Encodes the specified ApiKeyConfig message. Does not implicitly {@link google.cloud.aiplatform.v1.ApiAuth.ApiKeyConfig.verify|verify} messages.
* @param message ApiKeyConfig message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.aiplatform.v1.ApiAuth.IApiKeyConfig, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified ApiKeyConfig message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.ApiAuth.ApiKeyConfig.verify|verify} messages.
* @param message ApiKeyConfig message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.aiplatform.v1.ApiAuth.IApiKeyConfig, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes an ApiKeyConfig message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns ApiKeyConfig
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.ApiAuth.ApiKeyConfig;
/**
* Decodes an ApiKeyConfig message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns ApiKeyConfig
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.ApiAuth.ApiKeyConfig;
/**
* Verifies an ApiKeyConfig message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates an ApiKeyConfig message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns ApiKeyConfig
*/
public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.ApiAuth.ApiKeyConfig;
/**
* Creates a plain object from an ApiKeyConfig message. Also converts values to other types if specified.
* @param message ApiKeyConfig
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.aiplatform.v1.ApiAuth.ApiKeyConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this ApiKeyConfig to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for ApiKeyConfig
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
}
/** Properties of an Artifact. */
interface IArtifact {
/** Artifact name */
name?: (string|null);
/** Artifact displayName */
displayName?: (string|null);
/** Artifact uri */
uri?: (string|null);
/** Artifact etag */
etag?: (string|null);
/** Artifact labels */
labels?: ({ [k: string]: string }|null);
/** Artifact createTime */
createTime?: (google.protobuf.ITimestamp|null);
/** Artifact updateTime */
updateTime?: (google.protobuf.ITimestamp|null);
/** Artifact state */
state?: (google.cloud.aiplatform.v1.Artifact.State|keyof typeof google.cloud.aiplatform.v1.Artifact.State|null);
/** Artifact schemaTitle */
schemaTitle?: (string|null);
/** Artifact schemaVersion */
schemaVersion?: (string|null);
/** Artifact metadata */
metadata?: (google.protobuf.IStruct|null);
/** Artifact description */
description?: (string|null);
}
/** Represents an Artifact. */
class Artifact implements IArtifact {
/**
* Constructs a new Artifact.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.aiplatform.v1.IArtifact);
/** Artifact name. */
public name: string;
/** Artifact displayName. */
public displayName: string;
/** Artifact uri. */
public uri: string;
/** Artifact etag. */
public etag: string;
/** Artifact labels. */
public labels: { [k: string]: string };
/** Artifact createTime. */
public createTime?: (google.protobuf.ITimestamp|null);
/** Artifact updateTime. */
public updateTime?: (google.protobuf.ITimestamp|null);
/** Artifact state. */
public state: (google.cloud.aiplatform.v1.Artifact.State|keyof typeof google.cloud.aiplatform.v1.Artifact.State);
/** Artifact schemaTitle. */
public schemaTitle: string;
/** Artifact schemaVersion. */
public schemaVersion: string;
/** Artifact metadata. */
public metadata?: (google.protobuf.IStruct|null);
/** Artifact description. */
public description: string;
/**
* Creates a new Artifact instance using the specified properties.
* @param [properties] Properties to set
* @returns Artifact instance
*/
public static create(properties?: google.cloud.aiplatform.v1.IArtifact): google.cloud.aiplatform.v1.Artifact;
/**
* Encodes the specified Artifact message. Does not implicitly {@link google.cloud.aiplatform.v1.Artifact.verify|verify} messages.
* @param message Artifact message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.aiplatform.v1.IArtifact, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified Artifact message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.Artifact.verify|verify} messages.
* @param message Artifact message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.aiplatform.v1.IArtifact, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes an Artifact message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns Artifact
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.Artifact;
/**
* Decodes an Artifact message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns Artifact
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.Artifact;
/**
* Verifies an Artifact message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates an Artifact message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns Artifact
*/
public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.Artifact;
/**
* Creates a plain object from an Artifact message. Also converts values to other types if specified.
* @param message Artifact
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.aiplatform.v1.Artifact, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this Artifact to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for Artifact
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
namespace Artifact {
/** State enum. */
enum State {
STATE_UNSPECIFIED = 0,
PENDING = 1,
LIVE = 2
}
}
/** Properties of a BatchPredictionJob. */
interface IBatchPredictionJob {
/** BatchPredictionJob name */
name?: (string|null);
/** BatchPredictionJob displayName */
displayName?: (string|null);
/** BatchPredictionJob model */
model?: (string|null);
/** BatchPredictionJob modelVersionId */
modelVersionId?: (string|null);
/** BatchPredictionJob unmanagedContainerModel */
unmanagedContainerModel?: (google.cloud.aiplatform.v1.IUnmanagedContainerModel|null);
/** BatchPredictionJob inputConfig */
inputConfig?: (google.cloud.aiplatform.v1.BatchPredictionJob.IInputConfig|null);
/** BatchPredictionJob instanceConfig */
instanceConfig?: (google.cloud.aiplatform.v1.BatchPredictionJob.IInstanceConfig|null);
/** BatchPredictionJob modelParameters */
modelParameters?: (google.protobuf.IValue|null);
/** BatchPredictionJob outputConfig */
outputConfig?: (google.cloud.aiplatform.v1.BatchPredictionJob.IOutputConfig|null);
/** BatchPredictionJob dedicatedResources */
dedicatedResources?: (google.cloud.aiplatform.v1.IBatchDedicatedResources|null);
/** BatchPredictionJob serviceAccount */
serviceAccount?: (string|null);
/** BatchPredictionJob manualBatchTuningParameters */
manualBatchTuningParameters?: (google.cloud.aiplatform.v1.IManualBatchTuningParameters|null);
/** BatchPredictionJob generateExplanation */
generateExplanation?: (boolean|null);
/** BatchPredictionJob explanationSpec */
explanationSpec?: (google.cloud.aiplatform.v1.IExplanationSpec|null);
/** BatchPredictionJob outputInfo */
outputInfo?: (google.cloud.aiplatform.v1.BatchPredictionJob.IOutputInfo|null);
/** BatchPredictionJob state */
state?: (google.cloud.aiplatform.v1.JobState|keyof typeof google.cloud.aiplatform.v1.JobState|null);
/** BatchPredictionJob error */
error?: (google.rpc.IStatus|null);
/** BatchPredictionJob partialFailures */
partialFailures?: (google.rpc.IStatus[]|null);
/** BatchPredictionJob resourcesConsumed */
resourcesConsumed?: (google.cloud.aiplatform.v1.IResourcesConsumed|null);
/** BatchPredictionJob completionStats */
completionStats?: (google.cloud.aiplatform.v1.ICompletionStats|null);
/** BatchPredictionJob createTime */
createTime?: (google.protobuf.ITimestamp|null);
/** BatchPredictionJob startTime */
startTime?: (google.protobuf.ITimestamp|null);
/** BatchPredictionJob endTime */
endTime?: (google.protobuf.ITimestamp|null);
/** BatchPredictionJob updateTime */
updateTime?: (google.protobuf.ITimestamp|null);
/** BatchPredictionJob labels */
labels?: ({ [k: string]: string }|null);
/** BatchPredictionJob encryptionSpec */
encryptionSpec?: (google.cloud.aiplatform.v1.IEncryptionSpec|null);
/** BatchPredictionJob disableContainerLogging */
disableContainerLogging?: (boolean|null);
/** BatchPredictionJob satisfiesPzs */
satisfiesPzs?: (boolean|null);
/** BatchPredictionJob satisfiesPzi */
satisfiesPzi?: (boolean|null);
}
/** Represents a BatchPredictionJob. */
class BatchPredictionJob implements IBatchPredictionJob {
/**
* Constructs a new BatchPredictionJob.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.aiplatform.v1.IBatchPredictionJob);
/** BatchPredictionJob name. */
public name: string;
/** BatchPredictionJob displayName. */
public displayName: string;
/** BatchPredictionJob model. */
public model: string;
/** BatchPredictionJob modelVersionId. */
public modelVersionId: string;
/** BatchPredictionJob unmanagedContainerModel. */
public unmanagedContainerModel?: (google.cloud.aiplatform.v1.IUnmanagedContainerModel|null);
/** BatchPredictionJob inputConfig. */
public inputConfig?: (google.cloud.aiplatform.v1.BatchPredictionJob.IInputConfig|null);
/** BatchPredictionJob instanceConfig. */
public instanceConfig?: (google.cloud.aiplatform.v1.BatchPredictionJob.IInstanceConfig|null);
/** BatchPredictionJob modelParameters. */
public modelParameters?: (google.protobuf.IValue|null);
/** BatchPredictionJob outputConfig. */
public outputConfig?: (google.cloud.aiplatform.v1.BatchPredictionJob.IOutputConfig|null);
/** BatchPredictionJob dedicatedResources. */
public dedicatedResources?: (google.cloud.aiplatform.v1.IBatchDedicatedResources|null);
/** BatchPredictionJob serviceAccount. */
public serviceAccount: string;
/** BatchPredictionJob manualBatchTuningParameters. */
public manualBatchTuningParameters?: (google.cloud.aiplatform.v1.IManualBatchTuningParameters|null);
/** BatchPredictionJob generateExplanation. */
public generateExplanation: boolean;
/** BatchPredictionJob explanationSpec. */
public explanationSpec?: (google.cloud.aiplatform.v1.IExplanationSpec|null);
/** BatchPredictionJob outputInfo. */
public outputInfo?: (google.cloud.aiplatform.v1.BatchPredictionJob.IOutputInfo|null);
/** BatchPredictionJob state. */
public state: (google.cloud.aiplatform.v1.JobState|keyof typeof google.cloud.aiplatform.v1.JobState);
/** BatchPredictionJob error. */
public error?: (google.rpc.IStatus|null);
/** BatchPredictionJob partialFailures. */
public partialFailures: google.rpc.IStatus[];
/** BatchPredictionJob resourcesConsumed. */
public resourcesConsumed?: (google.cloud.aiplatform.v1.IResourcesConsumed|null);
/** BatchPredictionJob completionStats. */
public completionStats?: (google.cloud.aiplatform.v1.ICompletionStats|null);
/** BatchPredictionJob createTime. */
public createTime?: (google.protobuf.ITimestamp|null);
/** BatchPredictionJob startTime. */
public startTime?: (google.protobuf.ITimestamp|null);
/** BatchPredictionJob endTime. */
public endTime?: (google.protobuf.ITimestamp|null);
/** BatchPredictionJob updateTime. */
public updateTime?: (google.protobuf.ITimestamp|null);
/** BatchPredictionJob labels. */
public labels: { [k: string]: string };
/** BatchPredictionJob encryptionSpec. */
public encryptionSpec?: (google.cloud.aiplatform.v1.IEncryptionSpec|null);
/** BatchPredictionJob disableContainerLogging. */
public disableContainerLogging: boolean;
/** BatchPredictionJob satisfiesPzs. */
public satisfiesPzs: boolean;
/** BatchPredictionJob satisfiesPzi. */
public satisfiesPzi: boolean;
/**
* Creates a new BatchPredictionJob instance using the specified properties.
* @param [properties] Properties to set
* @returns BatchPredictionJob instance
*/
public static create(properties?: google.cloud.aiplatform.v1.IBatchPredictionJob): google.cloud.aiplatform.v1.BatchPredictionJob;
/**
* Encodes the specified BatchPredictionJob message. Does not implicitly {@link google.cloud.aiplatform.v1.BatchPredictionJob.verify|verify} messages.
* @param message BatchPredictionJob message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.aiplatform.v1.IBatchPredictionJob, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified BatchPredictionJob message, length delimited. Does not implicitly {@link google.cloud.aiplatform.v1.BatchPredictionJob.verify|verify} messages.
* @param message BatchPredictionJob message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.aiplatform.v1.IBatchPredictionJob, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a BatchPredictionJob message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns BatchPredictionJob
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.BatchPredictionJob;
/**