Package com.google.cloud.aiplatform.v1

Class DeployedModel

  • All Implemented Interfaces:
    DeployedModelOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class DeployedModel
extends com.google.protobuf.GeneratedMessageV3
implements DeployedModelOrBuilder
     A deployment of a Model. Endpoints contain one or more DeployedModels.
    Protobuf type google.cloud.aiplatform.v1.DeployedModel
    See Also:
    Serialized Form

    • Field Detail

      • DEDICATED_RESOURCES_FIELD_NUMBER

        public static final int DEDICATED_RESOURCES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • AUTOMATIC_RESOURCES_FIELD_NUMBER

        public static final int AUTOMATIC_RESOURCES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MODEL_VERSION_ID_FIELD_NUMBER

        public static final int MODEL_VERSION_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DISPLAY_NAME_FIELD_NUMBER

        public static final int DISPLAY_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CREATE_TIME_FIELD_NUMBER

        public static final int CREATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXPLANATION_SPEC_FIELD_NUMBER

        public static final int EXPLANATION_SPEC_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SERVICE_ACCOUNT_FIELD_NUMBER

        public static final int SERVICE_ACCOUNT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DISABLE_CONTAINER_LOGGING_FIELD_NUMBER

        public static final int DISABLE_CONTAINER_LOGGING_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENABLE_ACCESS_LOGGING_FIELD_NUMBER

        public static final int ENABLE_ACCESS_LOGGING_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PRIVATE_ENDPOINTS_FIELD_NUMBER

        public static final int PRIVATE_ENDPOINTS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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.aiplatform.v1.DedicatedResources dedicated_resources = 7;
        Specified by:
        hasDedicatedResources in interface DeployedModelOrBuilder
        Returns:
        Whether the dedicatedResources field is set.

      • 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.aiplatform.v1.DedicatedResources dedicated_resources = 7;
        Specified by:
        getDedicatedResources in interface DeployedModelOrBuilder
        Returns:
        The dedicatedResources.

      • 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.aiplatform.v1.AutomaticResources automatic_resources = 8;
        Specified by:
        hasAutomaticResources in interface DeployedModelOrBuilder
        Returns:
        Whether the automaticResources field is set.

      • 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.aiplatform.v1.AutomaticResources automatic_resources = 8;
        Specified by:
        getAutomaticResources in interface DeployedModelOrBuilder
        Returns:
        The automaticResources.

      • getId

        public String 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];
        Specified by:
        getId in interface DeployedModelOrBuilder
        Returns:
        The id.

      • getIdBytes

        public com.google.protobuf.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];
        Specified by:
        getIdBytes in interface DeployedModelOrBuilder
        Returns:
        The bytes for id.

      • getModel

        public String 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) = { ... }
        Specified by:
        getModel in interface DeployedModelOrBuilder
        Returns:
        The model.

      • getModelBytes

        public com.google.protobuf.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) = { ... }
        Specified by:
        getModelBytes in interface DeployedModelOrBuilder
        Returns:
        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];
        Specified by:
        getModelVersionId in interface DeployedModelOrBuilder
        Returns:
        The modelVersionId.

      • getModelVersionIdBytes

        public com.google.protobuf.ByteString getModelVersionIdBytes()
         Output only. The version ID of the model that is deployed.
        string model_version_id = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getModelVersionIdBytes in interface DeployedModelOrBuilder
        Returns:
        The bytes for modelVersionId.

      • 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;
        Specified by:
        getDisplayName in interface DeployedModelOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         The display name of the DeployedModel. If not provided upon creation,
 the Model's display_name is used.
        string display_name = 3;
        Specified by:
        getDisplayNameBytes in interface DeployedModelOrBuilder
        Returns:
        The bytes for displayName.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. Timestamp when the DeployedModel was created.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface DeployedModelOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. Timestamp when the DeployedModel was created.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface DeployedModelOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Timestamp when the DeployedModel was created.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface DeployedModelOrBuilder

      • hasExplanationSpec

        public boolean hasExplanationSpec()
         Explanation configuration for this DeployedModel.

 When deploying a Model using
 [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel],
 this value overrides the value of
 [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec].
 All fields of
 [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
 are optional in the request. If a field of
 [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
 is not populated, the value of the same field of
 [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec]
 is inherited. If the corresponding
 [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec]
 is not populated, all fields of the
 [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
 will be used for the explanation configuration.
        .google.cloud.aiplatform.v1.ExplanationSpec explanation_spec = 9;
        Specified by:
        hasExplanationSpec in interface DeployedModelOrBuilder
        Returns:
        Whether the explanationSpec field is set.

      • getExplanationSpec

        public ExplanationSpec getExplanationSpec()
         Explanation configuration for this DeployedModel.

 When deploying a Model using
 [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel],
 this value overrides the value of
 [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec].
 All fields of
 [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
 are optional in the request. If a field of
 [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
 is not populated, the value of the same field of
 [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec]
 is inherited. If the corresponding
 [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec]
 is not populated, all fields of the
 [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
 will be used for the explanation configuration.
        .google.cloud.aiplatform.v1.ExplanationSpec explanation_spec = 9;
        Specified by:
        getExplanationSpec in interface DeployedModelOrBuilder
        Returns:
        The explanationSpec.

      • getExplanationSpecOrBuilder

        public ExplanationSpecOrBuilder getExplanationSpecOrBuilder()
         Explanation configuration for this DeployedModel.

 When deploying a Model using
 [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel],
 this value overrides the value of
 [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec].
 All fields of
 [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
 are optional in the request. If a field of
 [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
 is not populated, the value of the same field of
 [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec]
 is inherited. If the corresponding
 [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec]
 is not populated, all fields of the
 [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec]
 will be used for the explanation configuration.
        .google.cloud.aiplatform.v1.ExplanationSpec explanation_spec = 9;
        Specified by:
        getExplanationSpecOrBuilder in interface DeployedModelOrBuilder

      • 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;
        Specified by:
        getServiceAccount in interface DeployedModelOrBuilder
        Returns:
        The serviceAccount.

      • getServiceAccountBytes

        public com.google.protobuf.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;
        Specified by:
        getServiceAccountBytes in interface DeployedModelOrBuilder
        Returns:
        The bytes for serviceAccount.

      • 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](https://cloud.google.com/logging/pricing).

 User can disable container logging by setting this flag to true.
        bool disable_container_logging = 15;
        Specified by:
        getDisableContainerLogging in interface DeployedModelOrBuilder
        Returns:
        The disableContainerLogging.

      • 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;
        Specified by:
        getEnableAccessLogging in interface DeployedModelOrBuilder
        Returns:
        The enableAccessLogging.

      • 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][google.cloud.aiplatform.v1.Endpoint.network] is configured.
        .google.cloud.aiplatform.v1.PrivateEndpoints private_endpoints = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasPrivateEndpoints in interface DeployedModelOrBuilder
        Returns:
        Whether the privateEndpoints field is set.

      • 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][google.cloud.aiplatform.v1.Endpoint.network] is configured.
        .google.cloud.aiplatform.v1.PrivateEndpoints private_endpoints = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getPrivateEndpoints in interface DeployedModelOrBuilder
        Returns:
        The privateEndpoints.

      • 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][google.cloud.aiplatform.v1.Endpoint.network] is configured.
        .google.cloud.aiplatform.v1.PrivateEndpoints private_endpoints = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getPrivateEndpointsOrBuilder in interface DeployedModelOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static DeployedModel parseFrom​(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DeployedModel parseFrom​(ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DeployedModel parseFrom​(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DeployedModel parseFrom​(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DeployedModel parseFrom​(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DeployedModel parseFrom​(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DeployedModel parseFrom​(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException
        Throws:
        IOException

      • newBuilderForType

        public DeployedModel.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public DeployedModel.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected DeployedModel.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static DeployedModel getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<DeployedModel> parser()

      • getParserForType

        public com.google.protobuf.Parser<DeployedModel> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public DeployedModel getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder