Class DeployedModel (1.16.0)

publicfinalclass DeployedModelextendsGeneratedMessageV3implementsDeployedModelOrBuilder

A deployment of a Model. Endpoints contain one or more DeployedModels.

Protobuf type google.cloud.vertexai.v1.DeployedModel

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DeployedModel

Implements

DeployedModelOrBuilder

Inherited Members

publicstaticfinalintAUTOMATIC_RESOURCES_FIELD_NUMBER

publicstaticfinalintCREATE_TIME_FIELD_NUMBER

publicstaticfinalintDEDICATED_RESOURCES_FIELD_NUMBER

publicstaticfinalintDISABLE_CONTAINER_LOGGING_FIELD_NUMBER

publicstaticfinalintDISABLE_EXPLANATIONS_FIELD_NUMBER

publicstaticfinalintDISPLAY_NAME_FIELD_NUMBER

publicstaticfinalintENABLE_ACCESS_LOGGING_FIELD_NUMBER

publicstaticfinalintEXPLANATION_SPEC_FIELD_NUMBER

publicstaticfinalintID_FIELD_NUMBER

publicstaticfinalintMODEL_FIELD_NUMBER

publicstaticfinalintMODEL_VERSION_ID_FIELD_NUMBER

publicstaticfinalintPRIVATE_ENDPOINTS_FIELD_NUMBER

publicstaticfinalintSERVICE_ACCOUNT_FIELD_NUMBER

publicstaticfinalintSHARED_RESOURCES_FIELD_NUMBER

publicstaticDeployedModelgetDefaultInstance()

publicstaticfinalDescriptors.DescriptorgetDescriptor()

publicstaticDeployedModel.BuildernewBuilder()

publicstaticDeployedModel.BuildernewBuilder(DeployedModelprototype)

publicstaticDeployedModelparseDelimitedFrom(InputStreaminput)

publicstaticDeployedModelparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticDeployedModelparseFrom(byte[]data)

publicstaticDeployedModelparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)

publicstaticDeployedModelparseFrom(ByteStringdata)

publicstaticDeployedModelparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)

publicstaticDeployedModelparseFrom(CodedInputStreaminput)

publicstaticDeployedModelparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticDeployedModelparseFrom(InputStreaminput)

publicstaticDeployedModelparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticDeployedModelparseFrom(ByteBufferdata)

publicstaticDeployedModelparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)

publicstaticParser<DeployedModel>parser()

publicbooleanequals(Objectobj)

AbstractMessage.equals(Object other)

publicAutomaticResourcesgetAutomaticResources()

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;

publicAutomaticResourcesOrBuildergetAutomaticResourcesOrBuilder()

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;

publicTimestampgetCreateTime()

Output only. Timestamp when the DeployedModel was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

publicTimestampOrBuildergetCreateTimeOrBuilder()

Output only. Timestamp when the DeployedModel was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

publicDedicatedResourcesgetDedicatedResources()

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;

publicDedicatedResourcesOrBuildergetDedicatedResourcesOrBuilder()

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;

publicDeployedModelgetDefaultInstanceForType()

publicbooleangetDisableContainerLogging()

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;

publicbooleangetDisableExplanations()

If true, deploy the model without explainable feature, regardless the existence of Model.explanation_spec or explanation_spec.

bool disable_explanations = 19;

publicStringgetDisplayName()

The display name of the DeployedModel. If not provided upon creation, the Model's display_name is used.

string display_name = 3;

publicByteStringgetDisplayNameBytes()

The display name of the DeployedModel. If not provided upon creation, the Model's display_name is used.

string display_name = 3;

publicbooleangetEnableAccessLogging()

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;

publicExplanationSpecgetExplanationSpec()

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;

publicExplanationSpecOrBuildergetExplanationSpecOrBuilder()

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;

publicStringgetId()

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];

publicByteStringgetIdBytes()

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];

publicStringgetModel()

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) = { ... }

publicByteStringgetModelBytes()

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) = { ... }

publicStringgetModelVersionId()

Output only. The version ID of the model that is deployed.

string model_version_id = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

publicByteStringgetModelVersionIdBytes()

Output only. The version ID of the model that is deployed.

string model_version_id = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

publicParser<DeployedModel>getParserForType()

GeneratedMessageV3.getParserForType()

publicDeployedModel.PredictionResourcesCasegetPredictionResourcesCase()

publicPrivateEndpointsgetPrivateEndpoints()

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];

publicPrivateEndpointsOrBuildergetPrivateEndpointsOrBuilder()

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];

publicintgetSerializedSize()

GeneratedMessageV3.getSerializedSize()

publicStringgetServiceAccount()

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;

publicByteStringgetServiceAccountBytes()

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;

publicStringgetSharedResources()

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) = { ... }

publicByteStringgetSharedResourcesBytes()

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) = { ... }

publicbooleanhasAutomaticResources()

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;

publicbooleanhasCreateTime()

Output only. Timestamp when the DeployedModel was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

publicbooleanhasDedicatedResources()

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;

publicbooleanhasExplanationSpec()

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;

publicbooleanhasPrivateEndpoints()

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];

publicbooleanhasSharedResources()

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) = { ... }

publicinthashCode()

AbstractMessage.hashCode()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()

GeneratedMessageV3.internalGetFieldAccessorTable()

publicfinalbooleanisInitialized()

GeneratedMessageV3.isInitialized()

publicDeployedModel.BuildernewBuilderForType()

protectedDeployedModel.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

publicDeployedModel.BuildertoBuilder()

publicvoidwriteTo(CodedOutputStreamoutput)

GeneratedMessageV3.writeTo(CodedOutputStream output)