public final class Model extends com.google.protobuf.GeneratedMessageV3 implements ModelOrBuilder
A trained machine learning Model.Protobuf type
google.cloud.aiplatform.v1beta1.Model| Modifier and Type | Class and Description |
|---|---|
static class |
Model.Builder
A trained machine learning Model.
|
static class |
Model.DeploymentResourcesType
Identifies a type of Model's prediction resources.
|
static class |
Model.ExportFormat
Represents export format supported by the Model.
|
static interface |
Model.ExportFormatOrBuilder |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Method and Description |
|---|---|
boolean |
containsLabels(String key)
The labels with user-defined metadata to organize your Models.
|
boolean |
equals(Object obj) |
String |
getArtifactUri()
Immutable.
|
com.google.protobuf.ByteString |
getArtifactUriBytes()
Immutable.
|
ModelContainerSpec |
getContainerSpec()
Input only.
|
ModelContainerSpecOrBuilder |
getContainerSpecOrBuilder()
Input only.
|
com.google.protobuf.Timestamp |
getCreateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getCreateTimeOrBuilder()
Output only.
|
static Model |
getDefaultInstance() |
Model |
getDefaultInstanceForType() |
DeployedModelRef |
getDeployedModels(int index)
Output only.
|
int |
getDeployedModelsCount()
Output only.
|
List<DeployedModelRef> |
getDeployedModelsList()
Output only.
|
DeployedModelRefOrBuilder |
getDeployedModelsOrBuilder(int index)
Output only.
|
List<? extends DeployedModelRefOrBuilder> |
getDeployedModelsOrBuilderList()
Output only.
|
String |
getDescription()
The description of the Model.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
The description of the Model.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getDisplayName()
Required.
|
com.google.protobuf.ByteString |
getDisplayNameBytes()
Required.
|
EncryptionSpec |
getEncryptionSpec()
Customer-managed encryption key spec for a Model.
|
EncryptionSpecOrBuilder |
getEncryptionSpecOrBuilder()
Customer-managed encryption key spec for a Model.
|
String |
getEtag()
Used to perform consistent read-modify-write updates.
|
com.google.protobuf.ByteString |
getEtagBytes()
Used to perform consistent read-modify-write updates.
|
ExplanationSpec |
getExplanationSpec()
The default explanation specification for this Model.
|
ExplanationSpecOrBuilder |
getExplanationSpecOrBuilder()
The default explanation specification for this Model.
|
Map<String,String> |
getLabels()
Deprecated.
|
int |
getLabelsCount()
The labels with user-defined metadata to organize your Models.
|
Map<String,String> |
getLabelsMap()
The labels with user-defined metadata to organize your Models.
|
String |
getLabelsOrDefault(String key,
String defaultValue)
The labels with user-defined metadata to organize your Models.
|
String |
getLabelsOrThrow(String key)
The labels with user-defined metadata to organize your Models.
|
com.google.protobuf.Value |
getMetadata()
Immutable.
|
com.google.protobuf.ValueOrBuilder |
getMetadataOrBuilder()
Immutable.
|
String |
getMetadataSchemaUri()
Immutable.
|
com.google.protobuf.ByteString |
getMetadataSchemaUriBytes()
Immutable.
|
String |
getName()
The resource name of the Model.
|
com.google.protobuf.ByteString |
getNameBytes()
The resource name of the Model.
|
com.google.protobuf.Parser<Model> |
getParserForType() |
PredictSchemata |
getPredictSchemata()
The schemata that describe formats of the Model's predictions and
explanations as given and returned via
[PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] and [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain].
|
PredictSchemataOrBuilder |
getPredictSchemataOrBuilder()
The schemata that describe formats of the Model's predictions and
explanations as given and returned via
[PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] and [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain].
|
int |
getSerializedSize() |
Model.DeploymentResourcesType |
getSupportedDeploymentResourcesTypes(int index)
Output only.
|
int |
getSupportedDeploymentResourcesTypesCount()
Output only.
|
List<Model.DeploymentResourcesType> |
getSupportedDeploymentResourcesTypesList()
Output only.
|
int |
getSupportedDeploymentResourcesTypesValue(int index)
Output only.
|
List<Integer> |
getSupportedDeploymentResourcesTypesValueList()
Output only.
|
Model.ExportFormat |
getSupportedExportFormats(int index)
Output only.
|
int |
getSupportedExportFormatsCount()
Output only.
|
List<Model.ExportFormat> |
getSupportedExportFormatsList()
Output only.
|
Model.ExportFormatOrBuilder |
getSupportedExportFormatsOrBuilder(int index)
Output only.
|
List<? extends Model.ExportFormatOrBuilder> |
getSupportedExportFormatsOrBuilderList()
Output only.
|
String |
getSupportedInputStorageFormats(int index)
Output only.
|
com.google.protobuf.ByteString |
getSupportedInputStorageFormatsBytes(int index)
Output only.
|
int |
getSupportedInputStorageFormatsCount()
Output only.
|
com.google.protobuf.ProtocolStringList |
getSupportedInputStorageFormatsList()
Output only.
|
String |
getSupportedOutputStorageFormats(int index)
Output only.
|
com.google.protobuf.ByteString |
getSupportedOutputStorageFormatsBytes(int index)
Output only.
|
int |
getSupportedOutputStorageFormatsCount()
Output only.
|
com.google.protobuf.ProtocolStringList |
getSupportedOutputStorageFormatsList()
Output only.
|
String |
getTrainingPipeline()
Output only.
|
com.google.protobuf.ByteString |
getTrainingPipelineBytes()
Output only.
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
com.google.protobuf.Timestamp |
getUpdateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getUpdateTimeOrBuilder()
Output only.
|
String |
getVersionAliases(int index)
User provided version aliases so that a model version can be referenced via
alias (i.e.
|
com.google.protobuf.ByteString |
getVersionAliasesBytes(int index)
User provided version aliases so that a model version can be referenced via
alias (i.e.
|
int |
getVersionAliasesCount()
User provided version aliases so that a model version can be referenced via
alias (i.e.
|
com.google.protobuf.ProtocolStringList |
getVersionAliasesList()
User provided version aliases so that a model version can be referenced via
alias (i.e.
|
com.google.protobuf.Timestamp |
getVersionCreateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getVersionCreateTimeOrBuilder()
Output only.
|
String |
getVersionDescription()
The description of this version.
|
com.google.protobuf.ByteString |
getVersionDescriptionBytes()
The description of this version.
|
String |
getVersionId()
Output only.
|
com.google.protobuf.ByteString |
getVersionIdBytes()
Output only.
|
com.google.protobuf.Timestamp |
getVersionUpdateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getVersionUpdateTimeOrBuilder()
Output only.
|
boolean |
hasContainerSpec()
Input only.
|
boolean |
hasCreateTime()
Output only.
|
boolean |
hasEncryptionSpec()
Customer-managed encryption key spec for a Model.
|
boolean |
hasExplanationSpec()
The default explanation specification for this Model.
|
int |
hashCode() |
boolean |
hasMetadata()
Immutable.
|
boolean |
hasPredictSchemata()
The schemata that describe formats of the Model's predictions and
explanations as given and returned via
[PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] and [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain].
|
boolean |
hasUpdateTime()
Output only.
|
boolean |
hasVersionCreateTime()
Output only.
|
boolean |
hasVersionUpdateTime()
Output only.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapField |
internalGetMapField(int number) |
boolean |
isInitialized() |
static Model.Builder |
newBuilder() |
static Model.Builder |
newBuilder(Model prototype) |
Model.Builder |
newBuilderForType() |
protected Model.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static Model |
parseDelimitedFrom(InputStream input) |
static Model |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Model |
parseFrom(byte[] data) |
static Model |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Model |
parseFrom(ByteBuffer data) |
static Model |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Model |
parseFrom(com.google.protobuf.ByteString data) |
static Model |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Model |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Model |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Model |
parseFrom(InputStream input) |
static Model |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Model> |
parser() |
Model.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int VERSION_ID_FIELD_NUMBER
public static final int VERSION_ALIASES_FIELD_NUMBER
public static final int VERSION_CREATE_TIME_FIELD_NUMBER
public static final int VERSION_UPDATE_TIME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
public static final int VERSION_DESCRIPTION_FIELD_NUMBER
public static final int PREDICT_SCHEMATA_FIELD_NUMBER
public static final int METADATA_SCHEMA_URI_FIELD_NUMBER
public static final int METADATA_FIELD_NUMBER
public static final int SUPPORTED_EXPORT_FORMATS_FIELD_NUMBER
public static final int TRAINING_PIPELINE_FIELD_NUMBER
public static final int CONTAINER_SPEC_FIELD_NUMBER
public static final int ARTIFACT_URI_FIELD_NUMBER
public static final int SUPPORTED_DEPLOYMENT_RESOURCES_TYPES_FIELD_NUMBER
public static final int SUPPORTED_INPUT_STORAGE_FORMATS_FIELD_NUMBER
public static final int SUPPORTED_OUTPUT_STORAGE_FORMATS_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
public static final int DEPLOYED_MODELS_FIELD_NUMBER
public static final int EXPLANATION_SPEC_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
public static final int ENCRYPTION_SPEC_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField in class com.google.protobuf.GeneratedMessageV3protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String getName()
The resource name of the Model.
string name = 1;getName in interface ModelOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
The resource name of the Model.
string name = 1;getNameBytes in interface ModelOrBuilderpublic String getVersionId()
Output only. Immutable. The version ID of the model. A new version is committed when a new model version is uploaded or trained under an existing model id. It is an auto-incrementing decimal number in string representation.
string version_id = 28 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];
getVersionId in interface ModelOrBuilderpublic com.google.protobuf.ByteString getVersionIdBytes()
Output only. Immutable. The version ID of the model. A new version is committed when a new model version is uploaded or trained under an existing model id. It is an auto-incrementing decimal number in string representation.
string version_id = 28 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];
getVersionIdBytes in interface ModelOrBuilderpublic com.google.protobuf.ProtocolStringList getVersionAliasesList()
User provided version aliases so that a model version can be referenced via
alias (i.e.
projects/{project}/locations/{location}/models/{model_id}@{version_alias}
instead of auto-generated version id (i.e.
projects/{project}/locations/{location}/models/{model_id}@{version_id}).
The format is [a-z][a-zA-Z0-9-]{0,126}[a-z0-9] to distinguish from
version_id. A default version alias will be created for the first version
of the model, and there must be exactly one default version alias for a
model.
repeated string version_aliases = 29;getVersionAliasesList in interface ModelOrBuilderpublic int getVersionAliasesCount()
User provided version aliases so that a model version can be referenced via
alias (i.e.
projects/{project}/locations/{location}/models/{model_id}@{version_alias}
instead of auto-generated version id (i.e.
projects/{project}/locations/{location}/models/{model_id}@{version_id}).
The format is [a-z][a-zA-Z0-9-]{0,126}[a-z0-9] to distinguish from
version_id. A default version alias will be created for the first version
of the model, and there must be exactly one default version alias for a
model.
repeated string version_aliases = 29;getVersionAliasesCount in interface ModelOrBuilderpublic String getVersionAliases(int index)
User provided version aliases so that a model version can be referenced via
alias (i.e.
projects/{project}/locations/{location}/models/{model_id}@{version_alias}
instead of auto-generated version id (i.e.
projects/{project}/locations/{location}/models/{model_id}@{version_id}).
The format is [a-z][a-zA-Z0-9-]{0,126}[a-z0-9] to distinguish from
version_id. A default version alias will be created for the first version
of the model, and there must be exactly one default version alias for a
model.
repeated string version_aliases = 29;getVersionAliases in interface ModelOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getVersionAliasesBytes(int index)
User provided version aliases so that a model version can be referenced via
alias (i.e.
projects/{project}/locations/{location}/models/{model_id}@{version_alias}
instead of auto-generated version id (i.e.
projects/{project}/locations/{location}/models/{model_id}@{version_id}).
The format is [a-z][a-zA-Z0-9-]{0,126}[a-z0-9] to distinguish from
version_id. A default version alias will be created for the first version
of the model, and there must be exactly one default version alias for a
model.
repeated string version_aliases = 29;getVersionAliasesBytes in interface ModelOrBuilderindex - The index of the value to return.public boolean hasVersionCreateTime()
Output only. Timestamp when this version was created.
.google.protobuf.Timestamp version_create_time = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasVersionCreateTime in interface ModelOrBuilderpublic com.google.protobuf.Timestamp getVersionCreateTime()
Output only. Timestamp when this version was created.
.google.protobuf.Timestamp version_create_time = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];
getVersionCreateTime in interface ModelOrBuilderpublic com.google.protobuf.TimestampOrBuilder getVersionCreateTimeOrBuilder()
Output only. Timestamp when this version was created.
.google.protobuf.Timestamp version_create_time = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];
getVersionCreateTimeOrBuilder in interface ModelOrBuilderpublic boolean hasVersionUpdateTime()
Output only. Timestamp when this version was most recently updated.
.google.protobuf.Timestamp version_update_time = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasVersionUpdateTime in interface ModelOrBuilderpublic com.google.protobuf.Timestamp getVersionUpdateTime()
Output only. Timestamp when this version was most recently updated.
.google.protobuf.Timestamp version_update_time = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
getVersionUpdateTime in interface ModelOrBuilderpublic com.google.protobuf.TimestampOrBuilder getVersionUpdateTimeOrBuilder()
Output only. Timestamp when this version was most recently updated.
.google.protobuf.Timestamp version_update_time = 32 [(.google.api.field_behavior) = OUTPUT_ONLY];
getVersionUpdateTimeOrBuilder in interface ModelOrBuilderpublic String getDisplayName()
Required. The display name of the Model. The name can be up to 128 characters long and can be consist of any UTF-8 characters.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];getDisplayName in interface ModelOrBuilderpublic com.google.protobuf.ByteString getDisplayNameBytes()
Required. The display name of the Model. The name can be up to 128 characters long and can be consist of any UTF-8 characters.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];getDisplayNameBytes in interface ModelOrBuilderpublic String getDescription()
The description of the Model.
string description = 3;getDescription in interface ModelOrBuilderpublic com.google.protobuf.ByteString getDescriptionBytes()
The description of the Model.
string description = 3;getDescriptionBytes in interface ModelOrBuilderpublic String getVersionDescription()
The description of this version.
string version_description = 30;getVersionDescription in interface ModelOrBuilderpublic com.google.protobuf.ByteString getVersionDescriptionBytes()
The description of this version.
string version_description = 30;getVersionDescriptionBytes in interface ModelOrBuilderpublic boolean hasPredictSchemata()
The schemata that describe formats of the Model's predictions and explanations as given and returned via [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] and [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain].
.google.cloud.aiplatform.v1beta1.PredictSchemata predict_schemata = 4;hasPredictSchemata in interface ModelOrBuilderpublic PredictSchemata getPredictSchemata()
The schemata that describe formats of the Model's predictions and explanations as given and returned via [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] and [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain].
.google.cloud.aiplatform.v1beta1.PredictSchemata predict_schemata = 4;getPredictSchemata in interface ModelOrBuilderpublic PredictSchemataOrBuilder getPredictSchemataOrBuilder()
The schemata that describe formats of the Model's predictions and explanations as given and returned via [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] and [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain].
.google.cloud.aiplatform.v1beta1.PredictSchemata predict_schemata = 4;getPredictSchemataOrBuilder in interface ModelOrBuilderpublic String getMetadataSchemaUri()
Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Model, that is specific to it. Unset if the Model does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI, if no additional metadata is needed, this field is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
string metadata_schema_uri = 5 [(.google.api.field_behavior) = IMMUTABLE];getMetadataSchemaUri in interface ModelOrBuilderpublic com.google.protobuf.ByteString getMetadataSchemaUriBytes()
Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Model, that is specific to it. Unset if the Model does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). AutoML Models always have this field populated by Vertex AI, if no additional metadata is needed, this field is set to an empty string. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
string metadata_schema_uri = 5 [(.google.api.field_behavior) = IMMUTABLE];getMetadataSchemaUriBytes in interface ModelOrBuilderpublic boolean hasMetadata()
Immutable. An additional information about the Model; the schema of the metadata can be found in [metadata_schema][google.cloud.aiplatform.v1beta1.Model.metadata_schema_uri]. Unset if the Model does not have any additional information.
.google.protobuf.Value metadata = 6 [(.google.api.field_behavior) = IMMUTABLE];hasMetadata in interface ModelOrBuilderpublic com.google.protobuf.Value getMetadata()
Immutable. An additional information about the Model; the schema of the metadata can be found in [metadata_schema][google.cloud.aiplatform.v1beta1.Model.metadata_schema_uri]. Unset if the Model does not have any additional information.
.google.protobuf.Value metadata = 6 [(.google.api.field_behavior) = IMMUTABLE];getMetadata in interface ModelOrBuilderpublic com.google.protobuf.ValueOrBuilder getMetadataOrBuilder()
Immutable. An additional information about the Model; the schema of the metadata can be found in [metadata_schema][google.cloud.aiplatform.v1beta1.Model.metadata_schema_uri]. Unset if the Model does not have any additional information.
.google.protobuf.Value metadata = 6 [(.google.api.field_behavior) = IMMUTABLE];getMetadataOrBuilder in interface ModelOrBuilderpublic List<Model.ExportFormat> getSupportedExportFormatsList()
Output only. The formats in which this Model may be exported. If empty, this Model is not available for export.
repeated .google.cloud.aiplatform.v1beta1.Model.ExportFormat supported_export_formats = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSupportedExportFormatsList in interface ModelOrBuilderpublic List<? extends Model.ExportFormatOrBuilder> getSupportedExportFormatsOrBuilderList()
Output only. The formats in which this Model may be exported. If empty, this Model is not available for export.
repeated .google.cloud.aiplatform.v1beta1.Model.ExportFormat supported_export_formats = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSupportedExportFormatsOrBuilderList in interface ModelOrBuilderpublic int getSupportedExportFormatsCount()
Output only. The formats in which this Model may be exported. If empty, this Model is not available for export.
repeated .google.cloud.aiplatform.v1beta1.Model.ExportFormat supported_export_formats = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSupportedExportFormatsCount in interface ModelOrBuilderpublic Model.ExportFormat getSupportedExportFormats(int index)
Output only. The formats in which this Model may be exported. If empty, this Model is not available for export.
repeated .google.cloud.aiplatform.v1beta1.Model.ExportFormat supported_export_formats = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSupportedExportFormats in interface ModelOrBuilderpublic Model.ExportFormatOrBuilder getSupportedExportFormatsOrBuilder(int index)
Output only. The formats in which this Model may be exported. If empty, this Model is not available for export.
repeated .google.cloud.aiplatform.v1beta1.Model.ExportFormat supported_export_formats = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSupportedExportFormatsOrBuilder in interface ModelOrBuilderpublic String getTrainingPipeline()
Output only. The resource name of the TrainingPipeline that uploaded this Model, if any.
string training_pipeline = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
getTrainingPipeline in interface ModelOrBuilderpublic com.google.protobuf.ByteString getTrainingPipelineBytes()
Output only. The resource name of the TrainingPipeline that uploaded this Model, if any.
string training_pipeline = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
getTrainingPipelineBytes in interface ModelOrBuilderpublic boolean hasContainerSpec()
Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel], and all binaries it contains are copied and stored internally by Vertex AI. Not present for AutoML Models.
.google.cloud.aiplatform.v1beta1.ModelContainerSpec container_spec = 9 [(.google.api.field_behavior) = INPUT_ONLY];
hasContainerSpec in interface ModelOrBuilderpublic ModelContainerSpec getContainerSpec()
Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel], and all binaries it contains are copied and stored internally by Vertex AI. Not present for AutoML Models.
.google.cloud.aiplatform.v1beta1.ModelContainerSpec container_spec = 9 [(.google.api.field_behavior) = INPUT_ONLY];
getContainerSpec in interface ModelOrBuilderpublic ModelContainerSpecOrBuilder getContainerSpecOrBuilder()
Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon [ModelService.UploadModel][google.cloud.aiplatform.v1beta1.ModelService.UploadModel], and all binaries it contains are copied and stored internally by Vertex AI. Not present for AutoML Models.
.google.cloud.aiplatform.v1beta1.ModelContainerSpec container_spec = 9 [(.google.api.field_behavior) = INPUT_ONLY];
getContainerSpecOrBuilder in interface ModelOrBuilderpublic String getArtifactUri()
Immutable. The path to the directory containing the Model artifact and any of its supporting files. Not present for AutoML Models.
string artifact_uri = 26 [(.google.api.field_behavior) = IMMUTABLE];getArtifactUri in interface ModelOrBuilderpublic com.google.protobuf.ByteString getArtifactUriBytes()
Immutable. The path to the directory containing the Model artifact and any of its supporting files. Not present for AutoML Models.
string artifact_uri = 26 [(.google.api.field_behavior) = IMMUTABLE];getArtifactUriBytes in interface ModelOrBuilderpublic List<Model.DeploymentResourcesType> getSupportedDeploymentResourcesTypesList()
Output only. When this Model is deployed, its prediction resources are described by the `prediction_resources` field of the [Endpoint.deployed_models][google.cloud.aiplatform.v1beta1.Endpoint.deployed_models] object. Because not all Models support all resource configuration types, the configuration types this Model supports are listed here. If no configuration types are listed, the Model cannot be deployed to an [Endpoint][google.cloud.aiplatform.v1beta1.Endpoint] and does not support online predictions ([PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] or [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain]). Such a Model can serve predictions by using a [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob], if it has at least one entry each in [supported_input_storage_formats][google.cloud.aiplatform.v1beta1.Model.supported_input_storage_formats] and [supported_output_storage_formats][google.cloud.aiplatform.v1beta1.Model.supported_output_storage_formats].
repeated .google.cloud.aiplatform.v1beta1.Model.DeploymentResourcesType supported_deployment_resources_types = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSupportedDeploymentResourcesTypesList in interface ModelOrBuilderpublic int getSupportedDeploymentResourcesTypesCount()
Output only. When this Model is deployed, its prediction resources are described by the `prediction_resources` field of the [Endpoint.deployed_models][google.cloud.aiplatform.v1beta1.Endpoint.deployed_models] object. Because not all Models support all resource configuration types, the configuration types this Model supports are listed here. If no configuration types are listed, the Model cannot be deployed to an [Endpoint][google.cloud.aiplatform.v1beta1.Endpoint] and does not support online predictions ([PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] or [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain]). Such a Model can serve predictions by using a [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob], if it has at least one entry each in [supported_input_storage_formats][google.cloud.aiplatform.v1beta1.Model.supported_input_storage_formats] and [supported_output_storage_formats][google.cloud.aiplatform.v1beta1.Model.supported_output_storage_formats].
repeated .google.cloud.aiplatform.v1beta1.Model.DeploymentResourcesType supported_deployment_resources_types = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSupportedDeploymentResourcesTypesCount in interface ModelOrBuilderpublic Model.DeploymentResourcesType getSupportedDeploymentResourcesTypes(int index)
Output only. When this Model is deployed, its prediction resources are described by the `prediction_resources` field of the [Endpoint.deployed_models][google.cloud.aiplatform.v1beta1.Endpoint.deployed_models] object. Because not all Models support all resource configuration types, the configuration types this Model supports are listed here. If no configuration types are listed, the Model cannot be deployed to an [Endpoint][google.cloud.aiplatform.v1beta1.Endpoint] and does not support online predictions ([PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] or [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain]). Such a Model can serve predictions by using a [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob], if it has at least one entry each in [supported_input_storage_formats][google.cloud.aiplatform.v1beta1.Model.supported_input_storage_formats] and [supported_output_storage_formats][google.cloud.aiplatform.v1beta1.Model.supported_output_storage_formats].
repeated .google.cloud.aiplatform.v1beta1.Model.DeploymentResourcesType supported_deployment_resources_types = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSupportedDeploymentResourcesTypes in interface ModelOrBuilderindex - The index of the element to return.public List<Integer> getSupportedDeploymentResourcesTypesValueList()
Output only. When this Model is deployed, its prediction resources are described by the `prediction_resources` field of the [Endpoint.deployed_models][google.cloud.aiplatform.v1beta1.Endpoint.deployed_models] object. Because not all Models support all resource configuration types, the configuration types this Model supports are listed here. If no configuration types are listed, the Model cannot be deployed to an [Endpoint][google.cloud.aiplatform.v1beta1.Endpoint] and does not support online predictions ([PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] or [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain]). Such a Model can serve predictions by using a [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob], if it has at least one entry each in [supported_input_storage_formats][google.cloud.aiplatform.v1beta1.Model.supported_input_storage_formats] and [supported_output_storage_formats][google.cloud.aiplatform.v1beta1.Model.supported_output_storage_formats].
repeated .google.cloud.aiplatform.v1beta1.Model.DeploymentResourcesType supported_deployment_resources_types = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSupportedDeploymentResourcesTypesValueList in interface ModelOrBuilderpublic int getSupportedDeploymentResourcesTypesValue(int index)
Output only. When this Model is deployed, its prediction resources are described by the `prediction_resources` field of the [Endpoint.deployed_models][google.cloud.aiplatform.v1beta1.Endpoint.deployed_models] object. Because not all Models support all resource configuration types, the configuration types this Model supports are listed here. If no configuration types are listed, the Model cannot be deployed to an [Endpoint][google.cloud.aiplatform.v1beta1.Endpoint] and does not support online predictions ([PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] or [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain]). Such a Model can serve predictions by using a [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob], if it has at least one entry each in [supported_input_storage_formats][google.cloud.aiplatform.v1beta1.Model.supported_input_storage_formats] and [supported_output_storage_formats][google.cloud.aiplatform.v1beta1.Model.supported_output_storage_formats].
repeated .google.cloud.aiplatform.v1beta1.Model.DeploymentResourcesType supported_deployment_resources_types = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSupportedDeploymentResourcesTypesValue in interface ModelOrBuilderindex - The index of the value to return.public com.google.protobuf.ProtocolStringList getSupportedInputStorageFormatsList()
Output only. The formats this Model supports in [BatchPredictionJob.input_config][google.cloud.aiplatform.v1beta1.BatchPredictionJob.input_config]. If [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri] exists, the instances should be given as per that schema. The possible formats are: * `jsonl` The JSON Lines format, where each instance is a single line. Uses [GcsSource][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.gcs_source]. * `csv` The CSV format, where each instance is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses [GcsSource][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.gcs_source]. * `tf-record` The TFRecord format, where each instance is a single record in tfrecord syntax. Uses [GcsSource][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.gcs_source]. * `tf-record-gzip` Similar to `tf-record`, but the file is gzipped. Uses [GcsSource][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.gcs_source]. * `bigquery` Each instance is a single row in BigQuery. Uses [BigQuerySource][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.bigquery_source]. * `file-list` Each line of the file is the location of an instance to process, uses `gcs_source` field of the [InputConfig][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig] object. If this Model doesn't support any of these formats it means it cannot be used with a [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob]. However, if it has [supported_deployment_resources_types][google.cloud.aiplatform.v1beta1.Model.supported_deployment_resources_types], it could serve online predictions by using [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] or [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain].
repeated string supported_input_storage_formats = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSupportedInputStorageFormatsList in interface ModelOrBuilderpublic int getSupportedInputStorageFormatsCount()
Output only. The formats this Model supports in [BatchPredictionJob.input_config][google.cloud.aiplatform.v1beta1.BatchPredictionJob.input_config]. If [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri] exists, the instances should be given as per that schema. The possible formats are: * `jsonl` The JSON Lines format, where each instance is a single line. Uses [GcsSource][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.gcs_source]. * `csv` The CSV format, where each instance is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses [GcsSource][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.gcs_source]. * `tf-record` The TFRecord format, where each instance is a single record in tfrecord syntax. Uses [GcsSource][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.gcs_source]. * `tf-record-gzip` Similar to `tf-record`, but the file is gzipped. Uses [GcsSource][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.gcs_source]. * `bigquery` Each instance is a single row in BigQuery. Uses [BigQuerySource][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.bigquery_source]. * `file-list` Each line of the file is the location of an instance to process, uses `gcs_source` field of the [InputConfig][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig] object. If this Model doesn't support any of these formats it means it cannot be used with a [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob]. However, if it has [supported_deployment_resources_types][google.cloud.aiplatform.v1beta1.Model.supported_deployment_resources_types], it could serve online predictions by using [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] or [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain].
repeated string supported_input_storage_formats = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSupportedInputStorageFormatsCount in interface ModelOrBuilderpublic String getSupportedInputStorageFormats(int index)
Output only. The formats this Model supports in [BatchPredictionJob.input_config][google.cloud.aiplatform.v1beta1.BatchPredictionJob.input_config]. If [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri] exists, the instances should be given as per that schema. The possible formats are: * `jsonl` The JSON Lines format, where each instance is a single line. Uses [GcsSource][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.gcs_source]. * `csv` The CSV format, where each instance is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses [GcsSource][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.gcs_source]. * `tf-record` The TFRecord format, where each instance is a single record in tfrecord syntax. Uses [GcsSource][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.gcs_source]. * `tf-record-gzip` Similar to `tf-record`, but the file is gzipped. Uses [GcsSource][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.gcs_source]. * `bigquery` Each instance is a single row in BigQuery. Uses [BigQuerySource][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.bigquery_source]. * `file-list` Each line of the file is the location of an instance to process, uses `gcs_source` field of the [InputConfig][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig] object. If this Model doesn't support any of these formats it means it cannot be used with a [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob]. However, if it has [supported_deployment_resources_types][google.cloud.aiplatform.v1beta1.Model.supported_deployment_resources_types], it could serve online predictions by using [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] or [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain].
repeated string supported_input_storage_formats = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSupportedInputStorageFormats in interface ModelOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getSupportedInputStorageFormatsBytes(int index)
Output only. The formats this Model supports in [BatchPredictionJob.input_config][google.cloud.aiplatform.v1beta1.BatchPredictionJob.input_config]. If [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri] exists, the instances should be given as per that schema. The possible formats are: * `jsonl` The JSON Lines format, where each instance is a single line. Uses [GcsSource][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.gcs_source]. * `csv` The CSV format, where each instance is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses [GcsSource][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.gcs_source]. * `tf-record` The TFRecord format, where each instance is a single record in tfrecord syntax. Uses [GcsSource][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.gcs_source]. * `tf-record-gzip` Similar to `tf-record`, but the file is gzipped. Uses [GcsSource][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.gcs_source]. * `bigquery` Each instance is a single row in BigQuery. Uses [BigQuerySource][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig.bigquery_source]. * `file-list` Each line of the file is the location of an instance to process, uses `gcs_source` field of the [InputConfig][google.cloud.aiplatform.v1beta1.BatchPredictionJob.InputConfig] object. If this Model doesn't support any of these formats it means it cannot be used with a [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob]. However, if it has [supported_deployment_resources_types][google.cloud.aiplatform.v1beta1.Model.supported_deployment_resources_types], it could serve online predictions by using [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] or [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain].
repeated string supported_input_storage_formats = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSupportedInputStorageFormatsBytes in interface ModelOrBuilderindex - The index of the value to return.public com.google.protobuf.ProtocolStringList getSupportedOutputStorageFormatsList()
Output only. The formats this Model supports in [BatchPredictionJob.output_config][google.cloud.aiplatform.v1beta1.BatchPredictionJob.output_config]. If both [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri] and [PredictSchemata.prediction_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.prediction_schema_uri] exist, the predictions are returned together with their instances. In other words, the prediction has the original instance data first, followed by the actual prediction content (as per the schema). The possible formats are: * `jsonl` The JSON Lines format, where each prediction is a single line. Uses [GcsDestination][google.cloud.aiplatform.v1beta1.BatchPredictionJob.OutputConfig.gcs_destination]. * `csv` The CSV format, where each prediction is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses [GcsDestination][google.cloud.aiplatform.v1beta1.BatchPredictionJob.OutputConfig.gcs_destination]. * `bigquery` Each prediction is a single row in a BigQuery table, uses [BigQueryDestination][google.cloud.aiplatform.v1beta1.BatchPredictionJob.OutputConfig.bigquery_destination] . If this Model doesn't support any of these formats it means it cannot be used with a [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob]. However, if it has [supported_deployment_resources_types][google.cloud.aiplatform.v1beta1.Model.supported_deployment_resources_types], it could serve online predictions by using [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] or [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain].
repeated string supported_output_storage_formats = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSupportedOutputStorageFormatsList in interface ModelOrBuilderpublic int getSupportedOutputStorageFormatsCount()
Output only. The formats this Model supports in [BatchPredictionJob.output_config][google.cloud.aiplatform.v1beta1.BatchPredictionJob.output_config]. If both [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri] and [PredictSchemata.prediction_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.prediction_schema_uri] exist, the predictions are returned together with their instances. In other words, the prediction has the original instance data first, followed by the actual prediction content (as per the schema). The possible formats are: * `jsonl` The JSON Lines format, where each prediction is a single line. Uses [GcsDestination][google.cloud.aiplatform.v1beta1.BatchPredictionJob.OutputConfig.gcs_destination]. * `csv` The CSV format, where each prediction is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses [GcsDestination][google.cloud.aiplatform.v1beta1.BatchPredictionJob.OutputConfig.gcs_destination]. * `bigquery` Each prediction is a single row in a BigQuery table, uses [BigQueryDestination][google.cloud.aiplatform.v1beta1.BatchPredictionJob.OutputConfig.bigquery_destination] . If this Model doesn't support any of these formats it means it cannot be used with a [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob]. However, if it has [supported_deployment_resources_types][google.cloud.aiplatform.v1beta1.Model.supported_deployment_resources_types], it could serve online predictions by using [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] or [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain].
repeated string supported_output_storage_formats = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSupportedOutputStorageFormatsCount in interface ModelOrBuilderpublic String getSupportedOutputStorageFormats(int index)
Output only. The formats this Model supports in [BatchPredictionJob.output_config][google.cloud.aiplatform.v1beta1.BatchPredictionJob.output_config]. If both [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri] and [PredictSchemata.prediction_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.prediction_schema_uri] exist, the predictions are returned together with their instances. In other words, the prediction has the original instance data first, followed by the actual prediction content (as per the schema). The possible formats are: * `jsonl` The JSON Lines format, where each prediction is a single line. Uses [GcsDestination][google.cloud.aiplatform.v1beta1.BatchPredictionJob.OutputConfig.gcs_destination]. * `csv` The CSV format, where each prediction is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses [GcsDestination][google.cloud.aiplatform.v1beta1.BatchPredictionJob.OutputConfig.gcs_destination]. * `bigquery` Each prediction is a single row in a BigQuery table, uses [BigQueryDestination][google.cloud.aiplatform.v1beta1.BatchPredictionJob.OutputConfig.bigquery_destination] . If this Model doesn't support any of these formats it means it cannot be used with a [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob]. However, if it has [supported_deployment_resources_types][google.cloud.aiplatform.v1beta1.Model.supported_deployment_resources_types], it could serve online predictions by using [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] or [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain].
repeated string supported_output_storage_formats = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSupportedOutputStorageFormats in interface ModelOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getSupportedOutputStorageFormatsBytes(int index)
Output only. The formats this Model supports in [BatchPredictionJob.output_config][google.cloud.aiplatform.v1beta1.BatchPredictionJob.output_config]. If both [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.instance_schema_uri] and [PredictSchemata.prediction_schema_uri][google.cloud.aiplatform.v1beta1.PredictSchemata.prediction_schema_uri] exist, the predictions are returned together with their instances. In other words, the prediction has the original instance data first, followed by the actual prediction content (as per the schema). The possible formats are: * `jsonl` The JSON Lines format, where each prediction is a single line. Uses [GcsDestination][google.cloud.aiplatform.v1beta1.BatchPredictionJob.OutputConfig.gcs_destination]. * `csv` The CSV format, where each prediction is a single comma-separated line. The first line in the file is the header, containing comma-separated field names. Uses [GcsDestination][google.cloud.aiplatform.v1beta1.BatchPredictionJob.OutputConfig.gcs_destination]. * `bigquery` Each prediction is a single row in a BigQuery table, uses [BigQueryDestination][google.cloud.aiplatform.v1beta1.BatchPredictionJob.OutputConfig.bigquery_destination] . If this Model doesn't support any of these formats it means it cannot be used with a [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob]. However, if it has [supported_deployment_resources_types][google.cloud.aiplatform.v1beta1.Model.supported_deployment_resources_types], it could serve online predictions by using [PredictionService.Predict][google.cloud.aiplatform.v1beta1.PredictionService.Predict] or [PredictionService.Explain][google.cloud.aiplatform.v1beta1.PredictionService.Explain].
repeated string supported_output_storage_formats = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSupportedOutputStorageFormatsBytes in interface ModelOrBuilderindex - The index of the value to return.public boolean hasCreateTime()
Output only. Timestamp when this Model was uploaded into Vertex AI.
.google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime in interface ModelOrBuilderpublic com.google.protobuf.Timestamp getCreateTime()
Output only. Timestamp when this Model was uploaded into Vertex AI.
.google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTime in interface ModelOrBuilderpublic com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp when this Model was uploaded into Vertex AI.
.google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder in interface ModelOrBuilderpublic boolean hasUpdateTime()
Output only. Timestamp when this Model was most recently updated.
.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasUpdateTime in interface ModelOrBuilderpublic com.google.protobuf.Timestamp getUpdateTime()
Output only. Timestamp when this Model was most recently updated.
.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTime in interface ModelOrBuilderpublic com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Timestamp when this Model was most recently updated.
.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTimeOrBuilder in interface ModelOrBuilderpublic List<DeployedModelRef> getDeployedModelsList()
Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.
repeated .google.cloud.aiplatform.v1beta1.DeployedModelRef deployed_models = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDeployedModelsList in interface ModelOrBuilderpublic List<? extends DeployedModelRefOrBuilder> getDeployedModelsOrBuilderList()
Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.
repeated .google.cloud.aiplatform.v1beta1.DeployedModelRef deployed_models = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDeployedModelsOrBuilderList in interface ModelOrBuilderpublic int getDeployedModelsCount()
Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.
repeated .google.cloud.aiplatform.v1beta1.DeployedModelRef deployed_models = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDeployedModelsCount in interface ModelOrBuilderpublic DeployedModelRef getDeployedModels(int index)
Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.
repeated .google.cloud.aiplatform.v1beta1.DeployedModelRef deployed_models = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDeployedModels in interface ModelOrBuilderpublic DeployedModelRefOrBuilder getDeployedModelsOrBuilder(int index)
Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations.
repeated .google.cloud.aiplatform.v1beta1.DeployedModelRef deployed_models = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDeployedModelsOrBuilder in interface ModelOrBuilderpublic boolean hasExplanationSpec()
The default explanation specification for this Model. The Model can be used for [requesting explanation][PredictionService.Explain] after being [deployed][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel] if it is populated. The Model can be used for [batch explanation][BatchPredictionJob.generate_explanation] if it is populated. All fields of the explanation_spec can be overridden by [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec] of [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1beta1.DeployModelRequest.deployed_model], or [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec] of [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob]. If the default explanation specification is not set for this Model, this Model can still be used for [requesting explanation][PredictionService.Explain] by setting [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec] of [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1beta1.DeployModelRequest.deployed_model] and for [batch explanation][BatchPredictionJob.generate_explanation] by setting [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec] of [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob].
.google.cloud.aiplatform.v1beta1.ExplanationSpec explanation_spec = 23;hasExplanationSpec in interface ModelOrBuilderpublic ExplanationSpec getExplanationSpec()
The default explanation specification for this Model. The Model can be used for [requesting explanation][PredictionService.Explain] after being [deployed][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel] if it is populated. The Model can be used for [batch explanation][BatchPredictionJob.generate_explanation] if it is populated. All fields of the explanation_spec can be overridden by [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec] of [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1beta1.DeployModelRequest.deployed_model], or [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec] of [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob]. If the default explanation specification is not set for this Model, this Model can still be used for [requesting explanation][PredictionService.Explain] by setting [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec] of [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1beta1.DeployModelRequest.deployed_model] and for [batch explanation][BatchPredictionJob.generate_explanation] by setting [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec] of [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob].
.google.cloud.aiplatform.v1beta1.ExplanationSpec explanation_spec = 23;getExplanationSpec in interface ModelOrBuilderpublic ExplanationSpecOrBuilder getExplanationSpecOrBuilder()
The default explanation specification for this Model. The Model can be used for [requesting explanation][PredictionService.Explain] after being [deployed][google.cloud.aiplatform.v1beta1.EndpointService.DeployModel] if it is populated. The Model can be used for [batch explanation][BatchPredictionJob.generate_explanation] if it is populated. All fields of the explanation_spec can be overridden by [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec] of [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1beta1.DeployModelRequest.deployed_model], or [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec] of [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob]. If the default explanation specification is not set for this Model, this Model can still be used for [requesting explanation][PredictionService.Explain] by setting [explanation_spec][google.cloud.aiplatform.v1beta1.DeployedModel.explanation_spec] of [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1beta1.DeployModelRequest.deployed_model] and for [batch explanation][BatchPredictionJob.generate_explanation] by setting [explanation_spec][google.cloud.aiplatform.v1beta1.BatchPredictionJob.explanation_spec] of [BatchPredictionJob][google.cloud.aiplatform.v1beta1.BatchPredictionJob].
.google.cloud.aiplatform.v1beta1.ExplanationSpec explanation_spec = 23;getExplanationSpecOrBuilder in interface ModelOrBuilderpublic String getEtag()
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
string etag = 16;getEtag in interface ModelOrBuilderpublic com.google.protobuf.ByteString getEtagBytes()
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
string etag = 16;getEtagBytes in interface ModelOrBuilderpublic int getLabelsCount()
ModelOrBuilderThe labels with user-defined metadata to organize your Models. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
map<string, string> labels = 17;getLabelsCount in interface ModelOrBuilderpublic boolean containsLabels(String key)
The labels with user-defined metadata to organize your Models. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
map<string, string> labels = 17;containsLabels in interface ModelOrBuilder@Deprecated public Map<String,String> getLabels()
getLabelsMap() instead.getLabels in interface ModelOrBuilderpublic Map<String,String> getLabelsMap()
The labels with user-defined metadata to organize your Models. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
map<string, string> labels = 17;getLabelsMap in interface ModelOrBuilderpublic String getLabelsOrDefault(String key, String defaultValue)
The labels with user-defined metadata to organize your Models. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
map<string, string> labels = 17;getLabelsOrDefault in interface ModelOrBuilderpublic String getLabelsOrThrow(String key)
The labels with user-defined metadata to organize your Models. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
map<string, string> labels = 17;getLabelsOrThrow in interface ModelOrBuilderpublic boolean hasEncryptionSpec()
Customer-managed encryption key spec for a Model. If set, this Model and all sub-resources of this Model will be secured by this key.
.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 24;hasEncryptionSpec in interface ModelOrBuilderpublic EncryptionSpec getEncryptionSpec()
Customer-managed encryption key spec for a Model. If set, this Model and all sub-resources of this Model will be secured by this key.
.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 24;getEncryptionSpec in interface ModelOrBuilderpublic EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()
Customer-managed encryption key spec for a Model. If set, this Model and all sub-resources of this Model will be secured by this key.
.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 24;getEncryptionSpecOrBuilder in interface ModelOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Model parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Model parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Model parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Model parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Model parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Model parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Model parseFrom(InputStream input) throws IOException
IOExceptionpublic static Model parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Model parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Model parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Model parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Model parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Model.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Model.Builder newBuilder()
public static Model.Builder newBuilder(Model prototype)
public Model.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Model.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Model getDefaultInstance()
public static com.google.protobuf.Parser<Model> parser()
public com.google.protobuf.Parser<Model> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Model getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2022 Google LLC. All rights reserved.