Package com.google.cloud.aiplatform.v1
Class Model
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.Model
- All Implemented Interfaces:
ModelOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
@Generated
public final class Model
extends com.google.protobuf.GeneratedMessage
implements ModelOrBuilder
A trained machine learning Model.Protobuf type
google.cloud.aiplatform.v1.Model- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classUser input field to specify the base model source.static interfacestatic final classA trained machine learning Model.static final classStats of data used for train or evaluate the Model.static interfacestatic enumIdentifies a type of Model's prediction resources.static final classRepresents export format supported by the Model.static interfacestatic final classContains information about the original Model if this Model is a copy.static interfaceNested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleancontainsLabels(String key) The labels with user-defined metadata to organize your Models.booleanImmutable.com.google.protobuf.ByteStringImmutable.Optional.Optional.getCheckpoints(int index) Optional.intOptional.Optional.getCheckpointsOrBuilder(int index) Optional.List<? extends CheckpointOrBuilder>Optional.Input only.Input only.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.Stats of data used for training or evaluating the Model.Stats of data used for training or evaluating the Model.The default checkpoint id of a model version.com.google.protobuf.ByteStringThe default checkpoint id of a model version.static ModelgetDeployedModels(int index) Output only.intOutput only.Output only.getDeployedModelsOrBuilder(int index) Output only.List<? extends DeployedModelRefOrBuilder>Output only.The description of the Model.com.google.protobuf.ByteStringThe description of the Model.static final com.google.protobuf.Descriptors.DescriptorRequired.com.google.protobuf.ByteStringRequired.Customer-managed encryption key spec for a Model.Customer-managed encryption key spec for a Model.getEtag()Used to perform consistent read-modify-write updates.com.google.protobuf.ByteStringUsed to perform consistent read-modify-write updates.The default explanation specification for this Model.The default explanation specification for this Model.Deprecated.intThe labels with user-defined metadata to organize your Models.The labels with user-defined metadata to organize your Models.getLabelsOrDefault(String key, String defaultValue) The labels with user-defined metadata to organize your Models.getLabelsOrThrow(String key) The labels with user-defined metadata to organize your Models.com.google.protobuf.ValueImmutable.Output only.com.google.protobuf.ByteStringOutput only.com.google.protobuf.ValueOrBuilderImmutable.Immutable.com.google.protobuf.ByteStringImmutable.Output only.Output only.getName()The resource name of the Model.com.google.protobuf.ByteStringThe resource name of the Model.Output only.Output only.com.google.protobuf.Parser<Model>Optional.com.google.protobuf.ByteStringOptional.The schemata that describe formats of the Model's predictions and explanations as given and returned via [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] and [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].The schemata that describe formats of the Model's predictions and explanations as given and returned via [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] and [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].booleanOutput only.booleanOutput only.intgetSupportedDeploymentResourcesTypes(int index) Output only.intOutput only.Output only.intgetSupportedDeploymentResourcesTypesValue(int index) Output only.Output only.getSupportedExportFormats(int index) Output only.intOutput only.Output only.getSupportedExportFormatsOrBuilder(int index) Output only.List<? extends Model.ExportFormatOrBuilder>Output only.getSupportedInputStorageFormats(int index) Output only.com.google.protobuf.ByteStringgetSupportedInputStorageFormatsBytes(int index) Output only.intOutput only.com.google.protobuf.ProtocolStringListOutput only.getSupportedOutputStorageFormats(int index) Output only.com.google.protobuf.ByteStringgetSupportedOutputStorageFormatsBytes(int index) Output only.intOutput only.com.google.protobuf.ProtocolStringListOutput only.Output only.com.google.protobuf.ByteStringOutput only.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.getVersionAliases(int index) User provided version aliases so that a model version can be referenced via alias (i.e.com.google.protobuf.ByteStringgetVersionAliasesBytes(int index) User provided version aliases so that a model version can be referenced via alias (i.e.intUser provided version aliases so that a model version can be referenced via alias (i.e.com.google.protobuf.ProtocolStringListUser provided version aliases so that a model version can be referenced via alias (i.e.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.The description of this version.com.google.protobuf.ByteStringThe description of this version.Output only.com.google.protobuf.ByteStringOutput only.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.booleanOptional.booleanInput only.booleanOutput only.booleanStats of data used for training or evaluating the Model.booleanCustomer-managed encryption key spec for a Model.booleanThe default explanation specification for this Model.inthashCode()booleanImmutable.booleanOutput only.booleanOutput only.booleanThe schemata that describe formats of the Model's predictions and explanations as given and returned via [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] and [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].booleanOutput only.booleanOutput only.booleanOutput only.protected com.google.protobuf.GeneratedMessage.FieldAccessorTableprotected com.google.protobuf.MapFieldReflectionAccessorinternalGetMapFieldReflection(int number) final booleanstatic Model.Builderstatic Model.BuildernewBuilder(Model prototype) protected Model.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static ModelparseDelimitedFrom(InputStream input) static ModelparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ModelparseFrom(byte[] data) static ModelparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ModelparseFrom(com.google.protobuf.ByteString data) static ModelparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ModelparseFrom(com.google.protobuf.CodedInputStream input) static ModelparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ModelparseFrom(InputStream input) static ModelparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ModelparseFrom(ByteBuffer data) static ModelparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<Model>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
VERSION_ID_FIELD_NUMBER
public static final int VERSION_ID_FIELD_NUMBER- See Also:
-
VERSION_ALIASES_FIELD_NUMBER
public static final int VERSION_ALIASES_FIELD_NUMBER- See Also:
-
VERSION_CREATE_TIME_FIELD_NUMBER
public static final int VERSION_CREATE_TIME_FIELD_NUMBER- See Also:
-
VERSION_UPDATE_TIME_FIELD_NUMBER
public static final int VERSION_UPDATE_TIME_FIELD_NUMBER- See Also:
-
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER- See Also:
-
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER- See Also:
-
VERSION_DESCRIPTION_FIELD_NUMBER
public static final int VERSION_DESCRIPTION_FIELD_NUMBER- See Also:
-
DEFAULT_CHECKPOINT_ID_FIELD_NUMBER
public static final int DEFAULT_CHECKPOINT_ID_FIELD_NUMBER- See Also:
-
PREDICT_SCHEMATA_FIELD_NUMBER
public static final int PREDICT_SCHEMATA_FIELD_NUMBER- See Also:
-
METADATA_SCHEMA_URI_FIELD_NUMBER
public static final int METADATA_SCHEMA_URI_FIELD_NUMBER- See Also:
-
METADATA_FIELD_NUMBER
public static final int METADATA_FIELD_NUMBER- See Also:
-
SUPPORTED_EXPORT_FORMATS_FIELD_NUMBER
public static final int SUPPORTED_EXPORT_FORMATS_FIELD_NUMBER- See Also:
-
TRAINING_PIPELINE_FIELD_NUMBER
public static final int TRAINING_PIPELINE_FIELD_NUMBER- See Also:
-
PIPELINE_JOB_FIELD_NUMBER
public static final int PIPELINE_JOB_FIELD_NUMBER- See Also:
-
CONTAINER_SPEC_FIELD_NUMBER
public static final int CONTAINER_SPEC_FIELD_NUMBER- See Also:
-
ARTIFACT_URI_FIELD_NUMBER
public static final int ARTIFACT_URI_FIELD_NUMBER- See Also:
-
SUPPORTED_DEPLOYMENT_RESOURCES_TYPES_FIELD_NUMBER
public static final int SUPPORTED_DEPLOYMENT_RESOURCES_TYPES_FIELD_NUMBER- See Also:
-
SUPPORTED_INPUT_STORAGE_FORMATS_FIELD_NUMBER
public static final int SUPPORTED_INPUT_STORAGE_FORMATS_FIELD_NUMBER- See Also:
-
SUPPORTED_OUTPUT_STORAGE_FORMATS_FIELD_NUMBER
public static final int SUPPORTED_OUTPUT_STORAGE_FORMATS_FIELD_NUMBER- See Also:
-
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER- See Also:
-
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER- See Also:
-
DEPLOYED_MODELS_FIELD_NUMBER
public static final int DEPLOYED_MODELS_FIELD_NUMBER- See Also:
-
EXPLANATION_SPEC_FIELD_NUMBER
public static final int EXPLANATION_SPEC_FIELD_NUMBER- See Also:
-
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER- See Also:
-
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER- See Also:
-
DATA_STATS_FIELD_NUMBER
public static final int DATA_STATS_FIELD_NUMBER- See Also:
-
ENCRYPTION_SPEC_FIELD_NUMBER
public static final int ENCRYPTION_SPEC_FIELD_NUMBER- See Also:
-
MODEL_SOURCE_INFO_FIELD_NUMBER
public static final int MODEL_SOURCE_INFO_FIELD_NUMBER- See Also:
-
ORIGINAL_MODEL_INFO_FIELD_NUMBER
public static final int ORIGINAL_MODEL_INFO_FIELD_NUMBER- See Also:
-
METADATA_ARTIFACT_FIELD_NUMBER
public static final int METADATA_ARTIFACT_FIELD_NUMBER- See Also:
-
BASE_MODEL_SOURCE_FIELD_NUMBER
public static final int BASE_MODEL_SOURCE_FIELD_NUMBER- See Also:
-
SATISFIES_PZS_FIELD_NUMBER
public static final int SATISFIES_PZS_FIELD_NUMBER- See Also:
-
SATISFIES_PZI_FIELD_NUMBER
public static final int SATISFIES_PZI_FIELD_NUMBER- See Also:
-
CHECKPOINTS_FIELD_NUMBER
public static final int CHECKPOINTS_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number) - Overrides:
internalGetMapFieldReflectionin classcom.google.protobuf.GeneratedMessage
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
getName
The resource name of the Model.
string name = 1;- Specified by:
getNamein interfaceModelOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()The resource name of the Model.
string name = 1;- Specified by:
getNameBytesin interfaceModelOrBuilder- Returns:
- The bytes for name.
-
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];- Specified by:
getVersionIdin interfaceModelOrBuilder- Returns:
- The versionId.
-
getVersionIdBytes
public 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];- Specified by:
getVersionIdBytesin interfaceModelOrBuilder- Returns:
- The bytes for versionId.
-
getVersionAliasesList
public 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;- Specified by:
getVersionAliasesListin interfaceModelOrBuilder- Returns:
- A list containing the versionAliases.
-
getVersionAliasesCount
public 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;- Specified by:
getVersionAliasesCountin interfaceModelOrBuilder- Returns:
- The count of versionAliases.
-
getVersionAliases
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;- Specified by:
getVersionAliasesin interfaceModelOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The versionAliases at the given index.
-
getVersionAliasesBytes
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;- Specified by:
getVersionAliasesBytesin interfaceModelOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the versionAliases at the given index.
-
hasVersionCreateTime
public boolean hasVersionCreateTime()Output only. Timestamp when this version was created.
.google.protobuf.Timestamp version_create_time = 31 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasVersionCreateTimein interfaceModelOrBuilder- Returns:
- Whether the versionCreateTime field is set.
-
getVersionCreateTime
public 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];- Specified by:
getVersionCreateTimein interfaceModelOrBuilder- Returns:
- The versionCreateTime.
-
getVersionCreateTimeOrBuilder
public 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];- Specified by:
getVersionCreateTimeOrBuilderin interfaceModelOrBuilder
-
hasVersionUpdateTime
public 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];- Specified by:
hasVersionUpdateTimein interfaceModelOrBuilder- Returns:
- Whether the versionUpdateTime field is set.
-
getVersionUpdateTime
public 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];- Specified by:
getVersionUpdateTimein interfaceModelOrBuilder- Returns:
- The versionUpdateTime.
-
getVersionUpdateTimeOrBuilder
public 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];- Specified by:
getVersionUpdateTimeOrBuilderin interfaceModelOrBuilder
-
getDisplayName
Required. The display name of the Model. The name can be up to 128 characters long and can consist of any UTF-8 characters.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getDisplayNamein interfaceModelOrBuilder- Returns:
- The displayName.
-
getDisplayNameBytes
public com.google.protobuf.ByteString getDisplayNameBytes()Required. The display name of the Model. The name can be up to 128 characters long and can consist of any UTF-8 characters.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getDisplayNameBytesin interfaceModelOrBuilder- Returns:
- The bytes for displayName.
-
getDescription
The description of the Model.
string description = 3;- Specified by:
getDescriptionin interfaceModelOrBuilder- Returns:
- The description.
-
getDescriptionBytes
public com.google.protobuf.ByteString getDescriptionBytes()The description of the Model.
string description = 3;- Specified by:
getDescriptionBytesin interfaceModelOrBuilder- Returns:
- The bytes for description.
-
getVersionDescription
The description of this version.
string version_description = 30;- Specified by:
getVersionDescriptionin interfaceModelOrBuilder- Returns:
- The versionDescription.
-
getVersionDescriptionBytes
public com.google.protobuf.ByteString getVersionDescriptionBytes()The description of this version.
string version_description = 30;- Specified by:
getVersionDescriptionBytesin interfaceModelOrBuilder- Returns:
- The bytes for versionDescription.
-
getDefaultCheckpointId
The default checkpoint id of a model version.
string default_checkpoint_id = 53;- Specified by:
getDefaultCheckpointIdin interfaceModelOrBuilder- Returns:
- The defaultCheckpointId.
-
getDefaultCheckpointIdBytes
public com.google.protobuf.ByteString getDefaultCheckpointIdBytes()The default checkpoint id of a model version.
string default_checkpoint_id = 53;- Specified by:
getDefaultCheckpointIdBytesin interfaceModelOrBuilder- Returns:
- The bytes for defaultCheckpointId.
-
hasPredictSchemata
public boolean hasPredictSchemata()The schemata that describe formats of the Model's predictions and explanations as given and returned via [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] and [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].
.google.cloud.aiplatform.v1.PredictSchemata predict_schemata = 4;- Specified by:
hasPredictSchematain interfaceModelOrBuilder- Returns:
- Whether the predictSchemata field is set.
-
getPredictSchemata
The schemata that describe formats of the Model's predictions and explanations as given and returned via [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] and [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].
.google.cloud.aiplatform.v1.PredictSchemata predict_schemata = 4;- Specified by:
getPredictSchematain interfaceModelOrBuilder- Returns:
- The predictSchemata.
-
getPredictSchemataOrBuilder
The schemata that describe formats of the Model's predictions and explanations as given and returned via [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] and [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].
.google.cloud.aiplatform.v1.PredictSchemata predict_schemata = 4;- Specified by:
getPredictSchemataOrBuilderin interfaceModelOrBuilder
-
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];- Specified by:
getMetadataSchemaUriin interfaceModelOrBuilder- Returns:
- The metadataSchemaUri.
-
getMetadataSchemaUriBytes
public 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];- Specified by:
getMetadataSchemaUriBytesin interfaceModelOrBuilder- Returns:
- The bytes for metadataSchemaUri.
-
hasMetadata
public boolean hasMetadata()Immutable. An additional information about the Model; the schema of the metadata can be found in [metadata_schema][google.cloud.aiplatform.v1.Model.metadata_schema_uri]. Unset if the Model does not have any additional information.
.google.protobuf.Value metadata = 6 [(.google.api.field_behavior) = IMMUTABLE];- Specified by:
hasMetadatain interfaceModelOrBuilder- Returns:
- Whether the metadata field is set.
-
getMetadata
public 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.v1.Model.metadata_schema_uri]. Unset if the Model does not have any additional information.
.google.protobuf.Value metadata = 6 [(.google.api.field_behavior) = IMMUTABLE];- Specified by:
getMetadatain interfaceModelOrBuilder- Returns:
- The metadata.
-
getMetadataOrBuilder
public 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.v1.Model.metadata_schema_uri]. Unset if the Model does not have any additional information.
.google.protobuf.Value metadata = 6 [(.google.api.field_behavior) = IMMUTABLE];- Specified by:
getMetadataOrBuilderin interfaceModelOrBuilder
-
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.v1.Model.ExportFormat supported_export_formats = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSupportedExportFormatsListin interfaceModelOrBuilder
-
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.v1.Model.ExportFormat supported_export_formats = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSupportedExportFormatsOrBuilderListin interfaceModelOrBuilder
-
getSupportedExportFormatsCount
public 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.v1.Model.ExportFormat supported_export_formats = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSupportedExportFormatsCountin interfaceModelOrBuilder
-
getSupportedExportFormats
Output only. The formats in which this Model may be exported. If empty, this Model is not available for export.
repeated .google.cloud.aiplatform.v1.Model.ExportFormat supported_export_formats = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSupportedExportFormatsin interfaceModelOrBuilder
-
getSupportedExportFormatsOrBuilder
Output only. The formats in which this Model may be exported. If empty, this Model is not available for export.
repeated .google.cloud.aiplatform.v1.Model.ExportFormat supported_export_formats = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSupportedExportFormatsOrBuilderin interfaceModelOrBuilder
-
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) = { ... }- Specified by:
getTrainingPipelinein interfaceModelOrBuilder- Returns:
- The trainingPipeline.
-
getTrainingPipelineBytes
public 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) = { ... }- Specified by:
getTrainingPipelineBytesin interfaceModelOrBuilder- Returns:
- The bytes for trainingPipeline.
-
getPipelineJob
Optional. This field is populated if the model is produced by a pipeline job.
string pipeline_job = 47 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }- Specified by:
getPipelineJobin interfaceModelOrBuilder- Returns:
- The pipelineJob.
-
getPipelineJobBytes
public com.google.protobuf.ByteString getPipelineJobBytes()Optional. This field is populated if the model is produced by a pipeline job.
string pipeline_job = 47 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }- Specified by:
getPipelineJobBytesin interfaceModelOrBuilder- Returns:
- The bytes for pipelineJob.
-
hasContainerSpec
public 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.v1.ModelService.UploadModel], and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models.
.google.cloud.aiplatform.v1.ModelContainerSpec container_spec = 9 [(.google.api.field_behavior) = INPUT_ONLY];- Specified by:
hasContainerSpecin interfaceModelOrBuilder- Returns:
- Whether the containerSpec field is set.
-
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.v1.ModelService.UploadModel], and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models.
.google.cloud.aiplatform.v1.ModelContainerSpec container_spec = 9 [(.google.api.field_behavior) = INPUT_ONLY];- Specified by:
getContainerSpecin interfaceModelOrBuilder- Returns:
- The containerSpec.
-
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.v1.ModelService.UploadModel], and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models.
.google.cloud.aiplatform.v1.ModelContainerSpec container_spec = 9 [(.google.api.field_behavior) = INPUT_ONLY];- Specified by:
getContainerSpecOrBuilderin interfaceModelOrBuilder
-
getArtifactUri
Immutable. The path to the directory containing the Model artifact and any of its supporting files. Not required for AutoML Models.
string artifact_uri = 26 [(.google.api.field_behavior) = IMMUTABLE];- Specified by:
getArtifactUriin interfaceModelOrBuilder- Returns:
- The artifactUri.
-
getArtifactUriBytes
public com.google.protobuf.ByteString getArtifactUriBytes()Immutable. The path to the directory containing the Model artifact and any of its supporting files. Not required for AutoML Models.
string artifact_uri = 26 [(.google.api.field_behavior) = IMMUTABLE];- Specified by:
getArtifactUriBytesin interfaceModelOrBuilder- Returns:
- The bytes for artifactUri.
-
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.v1.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.v1.Endpoint] and does not support online predictions ([PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] or [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]). Such a Model can serve predictions by using a [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob], if it has at least one entry each in [supported_input_storage_formats][google.cloud.aiplatform.v1.Model.supported_input_storage_formats] and [supported_output_storage_formats][google.cloud.aiplatform.v1.Model.supported_output_storage_formats].
repeated .google.cloud.aiplatform.v1.Model.DeploymentResourcesType supported_deployment_resources_types = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSupportedDeploymentResourcesTypesListin interfaceModelOrBuilder- Returns:
- A list containing the supportedDeploymentResourcesTypes.
-
getSupportedDeploymentResourcesTypesCount
public 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.v1.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.v1.Endpoint] and does not support online predictions ([PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] or [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]). Such a Model can serve predictions by using a [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob], if it has at least one entry each in [supported_input_storage_formats][google.cloud.aiplatform.v1.Model.supported_input_storage_formats] and [supported_output_storage_formats][google.cloud.aiplatform.v1.Model.supported_output_storage_formats].
repeated .google.cloud.aiplatform.v1.Model.DeploymentResourcesType supported_deployment_resources_types = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSupportedDeploymentResourcesTypesCountin interfaceModelOrBuilder- Returns:
- The count of supportedDeploymentResourcesTypes.
-
getSupportedDeploymentResourcesTypes
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.v1.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.v1.Endpoint] and does not support online predictions ([PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] or [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]). Such a Model can serve predictions by using a [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob], if it has at least one entry each in [supported_input_storage_formats][google.cloud.aiplatform.v1.Model.supported_input_storage_formats] and [supported_output_storage_formats][google.cloud.aiplatform.v1.Model.supported_output_storage_formats].
repeated .google.cloud.aiplatform.v1.Model.DeploymentResourcesType supported_deployment_resources_types = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSupportedDeploymentResourcesTypesin interfaceModelOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The supportedDeploymentResourcesTypes at the given index.
-
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.v1.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.v1.Endpoint] and does not support online predictions ([PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] or [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]). Such a Model can serve predictions by using a [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob], if it has at least one entry each in [supported_input_storage_formats][google.cloud.aiplatform.v1.Model.supported_input_storage_formats] and [supported_output_storage_formats][google.cloud.aiplatform.v1.Model.supported_output_storage_formats].
repeated .google.cloud.aiplatform.v1.Model.DeploymentResourcesType supported_deployment_resources_types = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSupportedDeploymentResourcesTypesValueListin interfaceModelOrBuilder- Returns:
- A list containing the enum numeric values on the wire for supportedDeploymentResourcesTypes.
-
getSupportedDeploymentResourcesTypesValue
public 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.v1.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.v1.Endpoint] and does not support online predictions ([PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] or [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain]). Such a Model can serve predictions by using a [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob], if it has at least one entry each in [supported_input_storage_formats][google.cloud.aiplatform.v1.Model.supported_input_storage_formats] and [supported_output_storage_formats][google.cloud.aiplatform.v1.Model.supported_output_storage_formats].
repeated .google.cloud.aiplatform.v1.Model.DeploymentResourcesType supported_deployment_resources_types = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSupportedDeploymentResourcesTypesValuein interfaceModelOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The enum numeric value on the wire of supportedDeploymentResourcesTypes at the given index.
-
getSupportedInputStorageFormatsList
public com.google.protobuf.ProtocolStringList getSupportedInputStorageFormatsList()Output only. The formats this Model supports in [BatchPredictionJob.input_config][google.cloud.aiplatform.v1.BatchPredictionJob.input_config]. If [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1.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.v1.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.v1.BatchPredictionJob.InputConfig.gcs_source]. * `tf-record` The TFRecord format, where each instance is a single record in tfrecord syntax. Uses [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source]. * `tf-record-gzip` Similar to `tf-record`, but the file is gzipped. Uses [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source]. * `bigquery` Each instance is a single row in BigQuery. Uses [BigQuerySource][google.cloud.aiplatform.v1.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.v1.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.v1.BatchPredictionJob]. However, if it has [supported_deployment_resources_types][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types], it could serve online predictions by using [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] or [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].
repeated string supported_input_storage_formats = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSupportedInputStorageFormatsListin interfaceModelOrBuilder- Returns:
- A list containing the supportedInputStorageFormats.
-
getSupportedInputStorageFormatsCount
public int getSupportedInputStorageFormatsCount()Output only. The formats this Model supports in [BatchPredictionJob.input_config][google.cloud.aiplatform.v1.BatchPredictionJob.input_config]. If [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1.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.v1.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.v1.BatchPredictionJob.InputConfig.gcs_source]. * `tf-record` The TFRecord format, where each instance is a single record in tfrecord syntax. Uses [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source]. * `tf-record-gzip` Similar to `tf-record`, but the file is gzipped. Uses [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source]. * `bigquery` Each instance is a single row in BigQuery. Uses [BigQuerySource][google.cloud.aiplatform.v1.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.v1.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.v1.BatchPredictionJob]. However, if it has [supported_deployment_resources_types][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types], it could serve online predictions by using [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] or [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].
repeated string supported_input_storage_formats = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSupportedInputStorageFormatsCountin interfaceModelOrBuilder- Returns:
- The count of supportedInputStorageFormats.
-
getSupportedInputStorageFormats
Output only. The formats this Model supports in [BatchPredictionJob.input_config][google.cloud.aiplatform.v1.BatchPredictionJob.input_config]. If [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1.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.v1.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.v1.BatchPredictionJob.InputConfig.gcs_source]. * `tf-record` The TFRecord format, where each instance is a single record in tfrecord syntax. Uses [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source]. * `tf-record-gzip` Similar to `tf-record`, but the file is gzipped. Uses [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source]. * `bigquery` Each instance is a single row in BigQuery. Uses [BigQuerySource][google.cloud.aiplatform.v1.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.v1.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.v1.BatchPredictionJob]. However, if it has [supported_deployment_resources_types][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types], it could serve online predictions by using [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] or [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].
repeated string supported_input_storage_formats = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSupportedInputStorageFormatsin interfaceModelOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The supportedInputStorageFormats at the given index.
-
getSupportedInputStorageFormatsBytes
public com.google.protobuf.ByteString getSupportedInputStorageFormatsBytes(int index) Output only. The formats this Model supports in [BatchPredictionJob.input_config][google.cloud.aiplatform.v1.BatchPredictionJob.input_config]. If [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1.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.v1.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.v1.BatchPredictionJob.InputConfig.gcs_source]. * `tf-record` The TFRecord format, where each instance is a single record in tfrecord syntax. Uses [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source]. * `tf-record-gzip` Similar to `tf-record`, but the file is gzipped. Uses [GcsSource][google.cloud.aiplatform.v1.BatchPredictionJob.InputConfig.gcs_source]. * `bigquery` Each instance is a single row in BigQuery. Uses [BigQuerySource][google.cloud.aiplatform.v1.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.v1.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.v1.BatchPredictionJob]. However, if it has [supported_deployment_resources_types][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types], it could serve online predictions by using [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] or [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].
repeated string supported_input_storage_formats = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSupportedInputStorageFormatsBytesin interfaceModelOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the supportedInputStorageFormats at the given index.
-
getSupportedOutputStorageFormatsList
public com.google.protobuf.ProtocolStringList getSupportedOutputStorageFormatsList()Output only. The formats this Model supports in [BatchPredictionJob.output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config]. If both [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri] and [PredictSchemata.prediction_schema_uri][google.cloud.aiplatform.v1.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.v1.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.v1.BatchPredictionJob.OutputConfig.gcs_destination]. * `bigquery` Each prediction is a single row in a BigQuery table, uses [BigQueryDestination][google.cloud.aiplatform.v1.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.v1.BatchPredictionJob]. However, if it has [supported_deployment_resources_types][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types], it could serve online predictions by using [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] or [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].
repeated string supported_output_storage_formats = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSupportedOutputStorageFormatsListin interfaceModelOrBuilder- Returns:
- A list containing the supportedOutputStorageFormats.
-
getSupportedOutputStorageFormatsCount
public int getSupportedOutputStorageFormatsCount()Output only. The formats this Model supports in [BatchPredictionJob.output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config]. If both [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri] and [PredictSchemata.prediction_schema_uri][google.cloud.aiplatform.v1.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.v1.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.v1.BatchPredictionJob.OutputConfig.gcs_destination]. * `bigquery` Each prediction is a single row in a BigQuery table, uses [BigQueryDestination][google.cloud.aiplatform.v1.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.v1.BatchPredictionJob]. However, if it has [supported_deployment_resources_types][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types], it could serve online predictions by using [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] or [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].
repeated string supported_output_storage_formats = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSupportedOutputStorageFormatsCountin interfaceModelOrBuilder- Returns:
- The count of supportedOutputStorageFormats.
-
getSupportedOutputStorageFormats
Output only. The formats this Model supports in [BatchPredictionJob.output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config]. If both [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri] and [PredictSchemata.prediction_schema_uri][google.cloud.aiplatform.v1.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.v1.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.v1.BatchPredictionJob.OutputConfig.gcs_destination]. * `bigquery` Each prediction is a single row in a BigQuery table, uses [BigQueryDestination][google.cloud.aiplatform.v1.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.v1.BatchPredictionJob]. However, if it has [supported_deployment_resources_types][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types], it could serve online predictions by using [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] or [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].
repeated string supported_output_storage_formats = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSupportedOutputStorageFormatsin interfaceModelOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The supportedOutputStorageFormats at the given index.
-
getSupportedOutputStorageFormatsBytes
public com.google.protobuf.ByteString getSupportedOutputStorageFormatsBytes(int index) Output only. The formats this Model supports in [BatchPredictionJob.output_config][google.cloud.aiplatform.v1.BatchPredictionJob.output_config]. If both [PredictSchemata.instance_schema_uri][google.cloud.aiplatform.v1.PredictSchemata.instance_schema_uri] and [PredictSchemata.prediction_schema_uri][google.cloud.aiplatform.v1.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.v1.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.v1.BatchPredictionJob.OutputConfig.gcs_destination]. * `bigquery` Each prediction is a single row in a BigQuery table, uses [BigQueryDestination][google.cloud.aiplatform.v1.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.v1.BatchPredictionJob]. However, if it has [supported_deployment_resources_types][google.cloud.aiplatform.v1.Model.supported_deployment_resources_types], it could serve online predictions by using [PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict] or [PredictionService.Explain][google.cloud.aiplatform.v1.PredictionService.Explain].
repeated string supported_output_storage_formats = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSupportedOutputStorageFormatsBytesin interfaceModelOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the supportedOutputStorageFormats at the given index.
-
hasCreateTime
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];- Specified by:
hasCreateTimein interfaceModelOrBuilder- Returns:
- Whether the createTime field is set.
-
getCreateTime
public 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];- Specified by:
getCreateTimein interfaceModelOrBuilder- Returns:
- The createTime.
-
getCreateTimeOrBuilder
public 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];- Specified by:
getCreateTimeOrBuilderin interfaceModelOrBuilder
-
hasUpdateTime
public boolean hasUpdateTime()Output only. Timestamp when this Model was most recently updated.
.google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasUpdateTimein interfaceModelOrBuilder- Returns:
- Whether the updateTime field is set.
-
getUpdateTime
public 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];- Specified by:
getUpdateTimein interfaceModelOrBuilder- Returns:
- The updateTime.
-
getUpdateTimeOrBuilder
public 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];- Specified by:
getUpdateTimeOrBuilderin interfaceModelOrBuilder
-
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.v1.DeployedModelRef deployed_models = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getDeployedModelsListin interfaceModelOrBuilder
-
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.v1.DeployedModelRef deployed_models = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getDeployedModelsOrBuilderListin interfaceModelOrBuilder
-
getDeployedModelsCount
public 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.v1.DeployedModelRef deployed_models = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getDeployedModelsCountin interfaceModelOrBuilder
-
getDeployedModels
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.v1.DeployedModelRef deployed_models = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getDeployedModelsin interfaceModelOrBuilder
-
getDeployedModelsOrBuilder
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.v1.DeployedModelRef deployed_models = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getDeployedModelsOrBuilderin interfaceModelOrBuilder
-
hasExplanationSpec
public boolean hasExplanationSpec()The default explanation specification for this Model. The Model can be used for [requesting explanation][google.cloud.aiplatform.v1.PredictionService.Explain] after being [deployed][google.cloud.aiplatform.v1.EndpointService.DeployModel] if it is populated. The Model can be used for [batch explanation][google.cloud.aiplatform.v1.BatchPredictionJob.generate_explanation] if it is populated. All fields of the explanation_spec can be overridden by [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] of [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1.DeployModelRequest.deployed_model], or [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec] of [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. If the default explanation specification is not set for this Model, this Model can still be used for [requesting explanation][google.cloud.aiplatform.v1.PredictionService.Explain] by setting [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] of [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1.DeployModelRequest.deployed_model] and for [batch explanation][google.cloud.aiplatform.v1.BatchPredictionJob.generate_explanation] by setting [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec] of [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob].
.google.cloud.aiplatform.v1.ExplanationSpec explanation_spec = 23;- Specified by:
hasExplanationSpecin interfaceModelOrBuilder- Returns:
- Whether the explanationSpec field is set.
-
getExplanationSpec
The default explanation specification for this Model. The Model can be used for [requesting explanation][google.cloud.aiplatform.v1.PredictionService.Explain] after being [deployed][google.cloud.aiplatform.v1.EndpointService.DeployModel] if it is populated. The Model can be used for [batch explanation][google.cloud.aiplatform.v1.BatchPredictionJob.generate_explanation] if it is populated. All fields of the explanation_spec can be overridden by [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] of [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1.DeployModelRequest.deployed_model], or [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec] of [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. If the default explanation specification is not set for this Model, this Model can still be used for [requesting explanation][google.cloud.aiplatform.v1.PredictionService.Explain] by setting [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] of [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1.DeployModelRequest.deployed_model] and for [batch explanation][google.cloud.aiplatform.v1.BatchPredictionJob.generate_explanation] by setting [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec] of [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob].
.google.cloud.aiplatform.v1.ExplanationSpec explanation_spec = 23;- Specified by:
getExplanationSpecin interfaceModelOrBuilder- Returns:
- The explanationSpec.
-
getExplanationSpecOrBuilder
The default explanation specification for this Model. The Model can be used for [requesting explanation][google.cloud.aiplatform.v1.PredictionService.Explain] after being [deployed][google.cloud.aiplatform.v1.EndpointService.DeployModel] if it is populated. The Model can be used for [batch explanation][google.cloud.aiplatform.v1.BatchPredictionJob.generate_explanation] if it is populated. All fields of the explanation_spec can be overridden by [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] of [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1.DeployModelRequest.deployed_model], or [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec] of [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob]. If the default explanation specification is not set for this Model, this Model can still be used for [requesting explanation][google.cloud.aiplatform.v1.PredictionService.Explain] by setting [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] of [DeployModelRequest.deployed_model][google.cloud.aiplatform.v1.DeployModelRequest.deployed_model] and for [batch explanation][google.cloud.aiplatform.v1.BatchPredictionJob.generate_explanation] by setting [explanation_spec][google.cloud.aiplatform.v1.BatchPredictionJob.explanation_spec] of [BatchPredictionJob][google.cloud.aiplatform.v1.BatchPredictionJob].
.google.cloud.aiplatform.v1.ExplanationSpec explanation_spec = 23;- Specified by:
getExplanationSpecOrBuilderin interfaceModelOrBuilder
-
getEtag
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
string etag = 16;- Specified by:
getEtagin interfaceModelOrBuilder- Returns:
- The etag.
-
getEtagBytes
public com.google.protobuf.ByteString getEtagBytes()Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
string etag = 16;- Specified by:
getEtagBytesin interfaceModelOrBuilder- Returns:
- The bytes for etag.
-
getLabelsCount
public int getLabelsCount()Description copied from interface: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;- Specified by:
getLabelsCountin interfaceModelOrBuilder
-
containsLabels
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;- Specified by:
containsLabelsin interfaceModelOrBuilder
-
getLabels
Deprecated.UsegetLabelsMap()instead.- Specified by:
getLabelsin interfaceModelOrBuilder
-
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;- Specified by:
getLabelsMapin interfaceModelOrBuilder
-
getLabelsOrDefault
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;- Specified by:
getLabelsOrDefaultin interfaceModelOrBuilder
-
getLabelsOrThrow
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;- Specified by:
getLabelsOrThrowin interfaceModelOrBuilder
-
hasDataStats
public boolean hasDataStats()Stats of data used for training or evaluating the Model. Only populated when the Model is trained by a TrainingPipeline with [data_input_config][google.cloud.aiplatform.v1.TrainingPipeline.input_data_config].
.google.cloud.aiplatform.v1.Model.DataStats data_stats = 21;- Specified by:
hasDataStatsin interfaceModelOrBuilder- Returns:
- Whether the dataStats field is set.
-
getDataStats
Stats of data used for training or evaluating the Model. Only populated when the Model is trained by a TrainingPipeline with [data_input_config][google.cloud.aiplatform.v1.TrainingPipeline.input_data_config].
.google.cloud.aiplatform.v1.Model.DataStats data_stats = 21;- Specified by:
getDataStatsin interfaceModelOrBuilder- Returns:
- The dataStats.
-
getDataStatsOrBuilder
Stats of data used for training or evaluating the Model. Only populated when the Model is trained by a TrainingPipeline with [data_input_config][google.cloud.aiplatform.v1.TrainingPipeline.input_data_config].
.google.cloud.aiplatform.v1.Model.DataStats data_stats = 21;- Specified by:
getDataStatsOrBuilderin interfaceModelOrBuilder
-
hasEncryptionSpec
public 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.v1.EncryptionSpec encryption_spec = 24;- Specified by:
hasEncryptionSpecin interfaceModelOrBuilder- Returns:
- Whether the encryptionSpec field is set.
-
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.v1.EncryptionSpec encryption_spec = 24;- Specified by:
getEncryptionSpecin interfaceModelOrBuilder- Returns:
- The encryptionSpec.
-
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.v1.EncryptionSpec encryption_spec = 24;- Specified by:
getEncryptionSpecOrBuilderin interfaceModelOrBuilder
-
hasModelSourceInfo
public boolean hasModelSourceInfo()Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or saved and tuned from Genie or Model Garden.
.google.cloud.aiplatform.v1.ModelSourceInfo model_source_info = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasModelSourceInfoin interfaceModelOrBuilder- Returns:
- Whether the modelSourceInfo field is set.
-
getModelSourceInfo
Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or saved and tuned from Genie or Model Garden.
.google.cloud.aiplatform.v1.ModelSourceInfo model_source_info = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getModelSourceInfoin interfaceModelOrBuilder- Returns:
- The modelSourceInfo.
-
getModelSourceInfoOrBuilder
Output only. Source of a model. It can either be automl training pipeline, custom training pipeline, BigQuery ML, or saved and tuned from Genie or Model Garden.
.google.cloud.aiplatform.v1.ModelSourceInfo model_source_info = 38 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getModelSourceInfoOrBuilderin interfaceModelOrBuilder
-
hasOriginalModelInfo
public boolean hasOriginalModelInfo()Output only. If this Model is a copy of another Model, this contains info about the original.
.google.cloud.aiplatform.v1.Model.OriginalModelInfo original_model_info = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasOriginalModelInfoin interfaceModelOrBuilder- Returns:
- Whether the originalModelInfo field is set.
-
getOriginalModelInfo
Output only. If this Model is a copy of another Model, this contains info about the original.
.google.cloud.aiplatform.v1.Model.OriginalModelInfo original_model_info = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getOriginalModelInfoin interfaceModelOrBuilder- Returns:
- The originalModelInfo.
-
getOriginalModelInfoOrBuilder
Output only. If this Model is a copy of another Model, this contains info about the original.
.google.cloud.aiplatform.v1.Model.OriginalModelInfo original_model_info = 34 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getOriginalModelInfoOrBuilderin interfaceModelOrBuilder
-
getMetadataArtifact
Output only. The resource name of the Artifact that was created in MetadataStore when creating the Model. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.string metadata_artifact = 44 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getMetadataArtifactin interfaceModelOrBuilder- Returns:
- The metadataArtifact.
-
getMetadataArtifactBytes
public com.google.protobuf.ByteString getMetadataArtifactBytes()Output only. The resource name of the Artifact that was created in MetadataStore when creating the Model. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.string metadata_artifact = 44 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getMetadataArtifactBytesin interfaceModelOrBuilder- Returns:
- The bytes for metadataArtifact.
-
hasBaseModelSource
public boolean hasBaseModelSource()Optional. User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models.
.google.cloud.aiplatform.v1.Model.BaseModelSource base_model_source = 50 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
hasBaseModelSourcein interfaceModelOrBuilder- Returns:
- Whether the baseModelSource field is set.
-
getBaseModelSource
Optional. User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models.
.google.cloud.aiplatform.v1.Model.BaseModelSource base_model_source = 50 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getBaseModelSourcein interfaceModelOrBuilder- Returns:
- The baseModelSource.
-
getBaseModelSourceOrBuilder
Optional. User input field to specify the base model source. Currently it only supports specifing the Model Garden models and Genie models.
.google.cloud.aiplatform.v1.Model.BaseModelSource base_model_source = 50 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getBaseModelSourceOrBuilderin interfaceModelOrBuilder
-
getSatisfiesPzs
public boolean getSatisfiesPzs()Output only. Reserved for future use.
bool satisfies_pzs = 51 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSatisfiesPzsin interfaceModelOrBuilder- Returns:
- The satisfiesPzs.
-
getSatisfiesPzi
public boolean getSatisfiesPzi()Output only. Reserved for future use.
bool satisfies_pzi = 52 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getSatisfiesPziin interfaceModelOrBuilder- Returns:
- The satisfiesPzi.
-
getCheckpointsList
Optional. Output only. The checkpoints of the model.
repeated .google.cloud.aiplatform.v1.Checkpoint checkpoints = 57 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];- Specified by:
getCheckpointsListin interfaceModelOrBuilder
-
getCheckpointsOrBuilderList
Optional. Output only. The checkpoints of the model.
repeated .google.cloud.aiplatform.v1.Checkpoint checkpoints = 57 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];- Specified by:
getCheckpointsOrBuilderListin interfaceModelOrBuilder
-
getCheckpointsCount
public int getCheckpointsCount()Optional. Output only. The checkpoints of the model.
repeated .google.cloud.aiplatform.v1.Checkpoint checkpoints = 57 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];- Specified by:
getCheckpointsCountin interfaceModelOrBuilder
-
getCheckpoints
Optional. Output only. The checkpoints of the model.
repeated .google.cloud.aiplatform.v1.Checkpoint checkpoints = 57 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];- Specified by:
getCheckpointsin interfaceModelOrBuilder
-
getCheckpointsOrBuilder
Optional. Output only. The checkpoints of the model.
repeated .google.cloud.aiplatform.v1.Checkpoint checkpoints = 57 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];- Specified by:
getCheckpointsOrBuilderin interfaceModelOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Model parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Model parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Model parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Model parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Model parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Model parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Model parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static Model parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Model parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
- Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-