public final class DeployedModel extends GeneratedMessageV3 implements DeployedModelOrBuilder
A deployment of a Model. Endpoints contain one or more DeployedModels.
Protobuf type google.cloud.vertexai.v1.DeployedModel
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
AUTOMATIC_RESOURCES_FIELD_NUMBER
public static final int AUTOMATIC_RESOURCES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DEDICATED_RESOURCES_FIELD_NUMBER
public static final int DEDICATED_RESOURCES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISABLE_CONTAINER_LOGGING_FIELD_NUMBER
public static final int DISABLE_CONTAINER_LOGGING_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISABLE_EXPLANATIONS_FIELD_NUMBER
public static final int DISABLE_EXPLANATIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ENABLE_ACCESS_LOGGING_FIELD_NUMBER
public static final int ENABLE_ACCESS_LOGGING_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
EXPLANATION_SPEC_FIELD_NUMBER
public static final int EXPLANATION_SPEC_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MODEL_FIELD_NUMBER
public static final int MODEL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MODEL_VERSION_ID_FIELD_NUMBER
public static final int MODEL_VERSION_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PRIVATE_ENDPOINTS_FIELD_NUMBER
public static final int PRIVATE_ENDPOINTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SERVICE_ACCOUNT_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SHARED_RESOURCES_FIELD_NUMBER
public static final int SHARED_RESOURCES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static DeployedModel getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static DeployedModel.Builder newBuilder()
newBuilder(DeployedModel prototype)
public static DeployedModel.Builder newBuilder(DeployedModel prototype)
public static DeployedModel parseDelimitedFrom(InputStream input)
public static DeployedModel parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static DeployedModel parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DeployedModel parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static DeployedModel parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DeployedModel parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DeployedModel parseFrom(CodedInputStream input)
public static DeployedModel parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static DeployedModel parseFrom(InputStream input)
public static DeployedModel parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static DeployedModel parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DeployedModel parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<DeployedModel> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAutomaticResources()
public AutomaticResources getAutomaticResources()
A description of resources that to large degree are decided by Vertex
AI, and require only a modest additional configuration.
.google.cloud.vertexai.v1.AutomaticResources automatic_resources = 8;
getAutomaticResourcesOrBuilder()
public AutomaticResourcesOrBuilder getAutomaticResourcesOrBuilder()
A description of resources that to large degree are decided by Vertex
AI, and require only a modest additional configuration.
.google.cloud.vertexai.v1.AutomaticResources automatic_resources = 8;
getCreateTime()
public Timestamp getCreateTime()
Output only. Timestamp when the DeployedModel was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp when the DeployedModel was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDedicatedResources()
public DedicatedResources getDedicatedResources()
A description of resources that are dedicated to the DeployedModel, and
that need a higher degree of manual configuration.
.google.cloud.vertexai.v1.DedicatedResources dedicated_resources = 7;
getDedicatedResourcesOrBuilder()
public DedicatedResourcesOrBuilder getDedicatedResourcesOrBuilder()
A description of resources that are dedicated to the DeployedModel, and
that need a higher degree of manual configuration.
.google.cloud.vertexai.v1.DedicatedResources dedicated_resources = 7;
getDefaultInstanceForType()
public DeployedModel getDefaultInstanceForType()
getDisableContainerLogging()
public boolean getDisableContainerLogging()
For custom-trained Models and AutoML Tabular Models, the container of the
DeployedModel instances will send stderr and stdout streams to
Cloud Logging by default. Please note that the logs incur cost,
which are subject to Cloud Logging
pricing.
User can disable container logging by setting this flag to true.
bool disable_container_logging = 15;
| Returns |
| Type |
Description |
boolean |
The disableContainerLogging.
|
getDisableExplanations()
public boolean getDisableExplanations()
If true, deploy the model without explainable feature, regardless the
existence of
Model.explanation_spec
or
explanation_spec.
bool disable_explanations = 19;
| Returns |
| Type |
Description |
boolean |
The disableExplanations.
|
getDisplayName()
public String getDisplayName()
The display name of the DeployedModel. If not provided upon creation,
the Model's display_name is used.
string display_name = 3;
| Returns |
| Type |
Description |
String |
The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
The display name of the DeployedModel. If not provided upon creation,
the Model's display_name is used.
string display_name = 3;
| Returns |
| Type |
Description |
ByteString |
The bytes for displayName.
|
getEnableAccessLogging()
public boolean getEnableAccessLogging()
If true, online prediction access logs are sent to Cloud
Logging.
These logs are like standard server access logs, containing
information like timestamp and latency for each prediction request.
Note that logs may incur a cost, especially if your project
receives prediction requests at a high queries per second rate (QPS).
Estimate your costs before enabling this option.
bool enable_access_logging = 13;
| Returns |
| Type |
Description |
boolean |
The enableAccessLogging.
|
getExplanationSpec()
public ExplanationSpec getExplanationSpec()
Explanation configuration for this DeployedModel.
When deploying a Model using
EndpointService.DeployModel,
this value overrides the value of
Model.explanation_spec.
All fields of
explanation_spec
are optional in the request. If a field of
explanation_spec
is not populated, the value of the same field of
Model.explanation_spec
is inherited. If the corresponding
Model.explanation_spec
is not populated, all fields of the
explanation_spec
will be used for the explanation configuration.
.google.cloud.vertexai.v1.ExplanationSpec explanation_spec = 9;
getExplanationSpecOrBuilder()
public ExplanationSpecOrBuilder getExplanationSpecOrBuilder()
Explanation configuration for this DeployedModel.
When deploying a Model using
EndpointService.DeployModel,
this value overrides the value of
Model.explanation_spec.
All fields of
explanation_spec
are optional in the request. If a field of
explanation_spec
is not populated, the value of the same field of
Model.explanation_spec
is inherited. If the corresponding
Model.explanation_spec
is not populated, all fields of the
explanation_spec
will be used for the explanation configuration.
.google.cloud.vertexai.v1.ExplanationSpec explanation_spec = 9;
getId()
Immutable. The ID of the DeployedModel. If not provided upon deployment,
Vertex AI will generate a value for this ID.
This value should be 1-10 characters, and valid characters are /[0-9]/.
string id = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Returns |
| Type |
Description |
String |
The id.
|
getIdBytes()
public ByteString getIdBytes()
Immutable. The ID of the DeployedModel. If not provided upon deployment,
Vertex AI will generate a value for this ID.
This value should be 1-10 characters, and valid characters are /[0-9]/.
string id = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Returns |
| Type |
Description |
ByteString |
The bytes for id.
|
getModel()
Required. The resource name of the Model that this is the deployment of.
Note that the Model may be in a different location than the DeployedModel's
Endpoint.
The resource name may contain version id or version alias to specify the
version.
Example: projects/{project}/locations/{location}/models/{model}@2
or
projects/{project}/locations/{location}/models/{model}@golden
if no version is specified, the default version will be deployed.
string model = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The model.
|
getModelBytes()
public ByteString getModelBytes()
Required. The resource name of the Model that this is the deployment of.
Note that the Model may be in a different location than the DeployedModel's
Endpoint.
The resource name may contain version id or version alias to specify the
version.
Example: projects/{project}/locations/{location}/models/{model}@2
or
projects/{project}/locations/{location}/models/{model}@golden
if no version is specified, the default version will be deployed.
string model = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for model.
|
getModelVersionId()
public String getModelVersionId()
Output only. The version ID of the model that is deployed.
string model_version_id = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
String |
The modelVersionId.
|
getModelVersionIdBytes()
public ByteString getModelVersionIdBytes()
Output only. The version ID of the model that is deployed.
string model_version_id = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
ByteString |
The bytes for modelVersionId.
|
getParserForType()
public Parser<DeployedModel> getParserForType()
Overrides
getPredictionResourcesCase()
public DeployedModel.PredictionResourcesCase getPredictionResourcesCase()
getPrivateEndpoints()
public PrivateEndpoints getPrivateEndpoints()
Output only. Provide paths for users to send predict/explain/health
requests directly to the deployed model services running on Cloud via
private services access. This field is populated if
network is configured.
.google.cloud.vertexai.v1.PrivateEndpoints private_endpoints = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
getPrivateEndpointsOrBuilder()
public PrivateEndpointsOrBuilder getPrivateEndpointsOrBuilder()
Output only. Provide paths for users to send predict/explain/health
requests directly to the deployed model services running on Cloud via
private services access. This field is populated if
network is configured.
.google.cloud.vertexai.v1.PrivateEndpoints private_endpoints = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getServiceAccount()
public String getServiceAccount()
The service account that the DeployedModel's container runs as. Specify the
email address of the service account. If this service account is not
specified, the container runs as a service account that doesn't have access
to the resource project.
Users deploying the Model must have the iam.serviceAccounts.actAs
permission on this service account.
string service_account = 11;
| Returns |
| Type |
Description |
String |
The serviceAccount.
|
getServiceAccountBytes()
public ByteString getServiceAccountBytes()
The service account that the DeployedModel's container runs as. Specify the
email address of the service account. If this service account is not
specified, the container runs as a service account that doesn't have access
to the resource project.
Users deploying the Model must have the iam.serviceAccounts.actAs
permission on this service account.
string service_account = 11;
| Returns |
| Type |
Description |
ByteString |
The bytes for serviceAccount.
|
getSharedResources()
public String getSharedResources()
The resource name of the shared DeploymentResourcePool to deploy on.
Format:
projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}
string shared_resources = 17 [(.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The sharedResources.
|
getSharedResourcesBytes()
public ByteString getSharedResourcesBytes()
The resource name of the shared DeploymentResourcePool to deploy on.
Format:
projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}
string shared_resources = 17 [(.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for sharedResources.
|
hasAutomaticResources()
public boolean hasAutomaticResources()
A description of resources that to large degree are decided by Vertex
AI, and require only a modest additional configuration.
.google.cloud.vertexai.v1.AutomaticResources automatic_resources = 8;
| Returns |
| Type |
Description |
boolean |
Whether the automaticResources field is set.
|
hasCreateTime()
public boolean hasCreateTime()
Output only. Timestamp when the DeployedModel was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the createTime field is set.
|
hasDedicatedResources()
public boolean hasDedicatedResources()
A description of resources that are dedicated to the DeployedModel, and
that need a higher degree of manual configuration.
.google.cloud.vertexai.v1.DedicatedResources dedicated_resources = 7;
| Returns |
| Type |
Description |
boolean |
Whether the dedicatedResources field is set.
|
hasExplanationSpec()
public boolean hasExplanationSpec()
Explanation configuration for this DeployedModel.
When deploying a Model using
EndpointService.DeployModel,
this value overrides the value of
Model.explanation_spec.
All fields of
explanation_spec
are optional in the request. If a field of
explanation_spec
is not populated, the value of the same field of
Model.explanation_spec
is inherited. If the corresponding
Model.explanation_spec
is not populated, all fields of the
explanation_spec
will be used for the explanation configuration.
.google.cloud.vertexai.v1.ExplanationSpec explanation_spec = 9;
| Returns |
| Type |
Description |
boolean |
Whether the explanationSpec field is set.
|
hasPrivateEndpoints()
public boolean hasPrivateEndpoints()
Output only. Provide paths for users to send predict/explain/health
requests directly to the deployed model services running on Cloud via
private services access. This field is populated if
network is configured.
.google.cloud.vertexai.v1.PrivateEndpoints private_endpoints = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the privateEndpoints field is set.
|
hasSharedResources()
public boolean hasSharedResources()
The resource name of the shared DeploymentResourcePool to deploy on.
Format:
projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}
string shared_resources = 17 [(.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
boolean |
Whether the sharedResources field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public DeployedModel.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DeployedModel.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public DeployedModel.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
