Class ModelContainerSpec (3.46.0)

public final class ModelContainerSpec extends GeneratedMessageV3 implements ModelContainerSpecOrBuilder

Specification of a container for serving predictions. Some fields in this message correspond to fields in the Kubernetes Container v1 core specification.

Protobuf type google.cloud.aiplatform.v1beta1.ModelContainerSpec

Static Fields

ARGS_FIELD_NUMBER

public static final int ARGS_FIELD_NUMBER
Field Value
Type Description
int

COMMAND_FIELD_NUMBER

public static final int COMMAND_FIELD_NUMBER
Field Value
Type Description
int

DEPLOYMENT_TIMEOUT_FIELD_NUMBER

public static final int DEPLOYMENT_TIMEOUT_FIELD_NUMBER
Field Value
Type Description
int

ENV_FIELD_NUMBER

public static final int ENV_FIELD_NUMBER
Field Value
Type Description
int

GRPC_PORTS_FIELD_NUMBER

public static final int GRPC_PORTS_FIELD_NUMBER
Field Value
Type Description
int

HEALTH_PROBE_FIELD_NUMBER

public static final int HEALTH_PROBE_FIELD_NUMBER
Field Value
Type Description
int

HEALTH_ROUTE_FIELD_NUMBER

public static final int HEALTH_ROUTE_FIELD_NUMBER
Field Value
Type Description
int

IMAGE_URI_FIELD_NUMBER

public static final int IMAGE_URI_FIELD_NUMBER
Field Value
Type Description
int

PORTS_FIELD_NUMBER

public static final int PORTS_FIELD_NUMBER
Field Value
Type Description
int

PREDICT_ROUTE_FIELD_NUMBER

public static final int PREDICT_ROUTE_FIELD_NUMBER
Field Value
Type Description
int

SHARED_MEMORY_SIZE_MB_FIELD_NUMBER

public static final int SHARED_MEMORY_SIZE_MB_FIELD_NUMBER
Field Value
Type Description
int

STARTUP_PROBE_FIELD_NUMBER

public static final int STARTUP_PROBE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ModelContainerSpec getDefaultInstance()
Returns
Type Description
ModelContainerSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ModelContainerSpec.Builder newBuilder()
Returns
Type Description
ModelContainerSpec.Builder

newBuilder(ModelContainerSpec prototype)

public static ModelContainerSpec.Builder newBuilder(ModelContainerSpec prototype)
Parameter
Name Description
prototype ModelContainerSpec
Returns
Type Description
ModelContainerSpec.Builder

parseDelimitedFrom(InputStream input)

public static ModelContainerSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ModelContainerSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ModelContainerSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelContainerSpec
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ModelContainerSpec parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ModelContainerSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ModelContainerSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelContainerSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ModelContainerSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ModelContainerSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ModelContainerSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelContainerSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ModelContainerSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ModelContainerSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ModelContainerSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelContainerSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ModelContainerSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ModelContainerSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ModelContainerSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelContainerSpec
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ModelContainerSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ModelContainerSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ModelContainerSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelContainerSpec
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ModelContainerSpec> parser()
Returns
Type Description
Parser<ModelContainerSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getArgs(int index)

public String getArgs(int index)

Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's CMD. Specify this field as an array of executable and arguments, similar to a Docker CMD's "default parameters" form.

If you don't specify this field but do specify the command field, then the command from the command field runs without any additional arguments. See the Kubernetes documentation about how the command and args fields interact with a container's ENTRYPOINT and CMD.

If you don't specify this field and don't specify the command field, then the container's ENTRYPOINT and CMD determine what runs based on their default behavior. See the Docker documentation about how CMD and ENTRYPOINT interact.

In this field, you can reference environment variables set by Vertex AI and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: <code>$(<var>VARIABLE_NAME</var>)</code> Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with $$; for example: <code>$$(<var>VARIABLE_NAME</var>)</code> This field corresponds to the args field of the Kubernetes Containers v1 core API.

repeated string args = 3 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The args at the given index.

getArgsBytes(int index)

public ByteString getArgsBytes(int index)

Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's CMD. Specify this field as an array of executable and arguments, similar to a Docker CMD's "default parameters" form.

If you don't specify this field but do specify the command field, then the command from the command field runs without any additional arguments. See the Kubernetes documentation about how the command and args fields interact with a container's ENTRYPOINT and CMD.

If you don't specify this field and don't specify the command field, then the container's ENTRYPOINT and CMD determine what runs based on their default behavior. See the Docker documentation about how CMD and ENTRYPOINT interact.

In this field, you can reference environment variables set by Vertex AI and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: <code>$(<var>VARIABLE_NAME</var>)</code> Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with $$; for example: <code>$$(<var>VARIABLE_NAME</var>)</code> This field corresponds to the args field of the Kubernetes Containers v1 core API.

repeated string args = 3 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the args at the given index.

getArgsCount()

public int getArgsCount()

Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's CMD. Specify this field as an array of executable and arguments, similar to a Docker CMD's "default parameters" form.

If you don't specify this field but do specify the command field, then the command from the command field runs without any additional arguments. See the Kubernetes documentation about how the command and args fields interact with a container's ENTRYPOINT and CMD.

If you don't specify this field and don't specify the command field, then the container's ENTRYPOINT and CMD determine what runs based on their default behavior. See the Docker documentation about how CMD and ENTRYPOINT interact.

In this field, you can reference environment variables set by Vertex AI and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: <code>$(<var>VARIABLE_NAME</var>)</code> Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with $$; for example: <code>$$(<var>VARIABLE_NAME</var>)</code> This field corresponds to the args field of the Kubernetes Containers v1 core API.

repeated string args = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
int

The count of args.

getArgsList()

public ProtocolStringList getArgsList()

Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's CMD. Specify this field as an array of executable and arguments, similar to a Docker CMD's "default parameters" form.

If you don't specify this field but do specify the command field, then the command from the command field runs without any additional arguments. See the Kubernetes documentation about how the command and args fields interact with a container's ENTRYPOINT and CMD.

If you don't specify this field and don't specify the command field, then the container's ENTRYPOINT and CMD determine what runs based on their default behavior. See the Docker documentation about how CMD and ENTRYPOINT interact.

In this field, you can reference environment variables set by Vertex AI and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: <code>$(<var>VARIABLE_NAME</var>)</code> Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with $$; for example: <code>$$(<var>VARIABLE_NAME</var>)</code> This field corresponds to the args field of the Kubernetes Containers v1 core API.

repeated string args = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ProtocolStringList

A list containing the args.

getCommand(int index)

public String getCommand(int index)

Immutable. Specifies the command that runs when the container starts. This overrides the container's ENTRYPOINT. Specify this field as an array of executable and arguments, similar to a Docker ENTRYPOINT's "exec" form, not its "shell" form.

If you do not specify this field, then the container's ENTRYPOINT runs, in conjunction with the args field or the container's CMD, if either exists. If this field is not specified and the container does not have an ENTRYPOINT, then refer to the Docker documentation about how CMD and ENTRYPOINT interact.

If you specify this field, then you can also specify the args field to provide additional arguments for this command. However, if you specify this field, then the container's CMD is ignored. See the Kubernetes documentation about how the command and args fields interact with a container's ENTRYPOINT and CMD.

In this field, you can reference environment variables set by Vertex AI and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: <code>$(<var>VARIABLE_NAME</var>)</code> Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with $$; for example: <code>$$(<var>VARIABLE_NAME</var>)</code> This field corresponds to the command field of the Kubernetes Containers v1 core API.

repeated string command = 2 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The command at the given index.

getCommandBytes(int index)

public ByteString getCommandBytes(int index)

Immutable. Specifies the command that runs when the container starts. This overrides the container's ENTRYPOINT. Specify this field as an array of executable and arguments, similar to a Docker ENTRYPOINT's "exec" form, not its "shell" form.

If you do not specify this field, then the container's ENTRYPOINT runs, in conjunction with the args field or the container's CMD, if either exists. If this field is not specified and the container does not have an ENTRYPOINT, then refer to the Docker documentation about how CMD and ENTRYPOINT interact.

If you specify this field, then you can also specify the args field to provide additional arguments for this command. However, if you specify this field, then the container's CMD is ignored. See the Kubernetes documentation about how the command and args fields interact with a container's ENTRYPOINT and CMD.

In this field, you can reference environment variables set by Vertex AI and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: <code>$(<var>VARIABLE_NAME</var>)</code> Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with $$; for example: <code>$$(<var>VARIABLE_NAME</var>)</code> This field corresponds to the command field of the Kubernetes Containers v1 core API.

repeated string command = 2 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the command at the given index.

getCommandCount()

public int getCommandCount()

Immutable. Specifies the command that runs when the container starts. This overrides the container's ENTRYPOINT. Specify this field as an array of executable and arguments, similar to a Docker ENTRYPOINT's "exec" form, not its "shell" form.

If you do not specify this field, then the container's ENTRYPOINT runs, in conjunction with the args field or the container's CMD, if either exists. If this field is not specified and the container does not have an ENTRYPOINT, then refer to the Docker documentation about how CMD and ENTRYPOINT interact.

If you specify this field, then you can also specify the args field to provide additional arguments for this command. However, if you specify this field, then the container's CMD is ignored. See the Kubernetes documentation about how the command and args fields interact with a container's ENTRYPOINT and CMD.

In this field, you can reference environment variables set by Vertex AI and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: <code>$(<var>VARIABLE_NAME</var>)</code> Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with $$; for example: <code>$$(<var>VARIABLE_NAME</var>)</code> This field corresponds to the command field of the Kubernetes Containers v1 core API.

repeated string command = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
int

The count of command.

getCommandList()

public ProtocolStringList getCommandList()

Immutable. Specifies the command that runs when the container starts. This overrides the container's ENTRYPOINT. Specify this field as an array of executable and arguments, similar to a Docker ENTRYPOINT's "exec" form, not its "shell" form.

If you do not specify this field, then the container's ENTRYPOINT runs, in conjunction with the args field or the container's CMD, if either exists. If this field is not specified and the container does not have an ENTRYPOINT, then refer to the Docker documentation about how CMD and ENTRYPOINT interact.

If you specify this field, then you can also specify the args field to provide additional arguments for this command. However, if you specify this field, then the container's CMD is ignored. See the Kubernetes documentation about how the command and args fields interact with a container's ENTRYPOINT and CMD.

In this field, you can reference environment variables set by Vertex AI and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: <code>$(<var>VARIABLE_NAME</var>)</code> Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with $$; for example: <code>$$(<var>VARIABLE_NAME</var>)</code> This field corresponds to the command field of the Kubernetes Containers v1 core API.

repeated string command = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ProtocolStringList

A list containing the command.

getDefaultInstanceForType()

public ModelContainerSpec getDefaultInstanceForType()
Returns
Type Description
ModelContainerSpec

getDeploymentTimeout()

public Duration getDeploymentTimeout()

Immutable. Deployment timeout. Limit for deployment timeout is 2 hours.

.google.protobuf.Duration deployment_timeout = 10 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Duration

The deploymentTimeout.

getDeploymentTimeoutOrBuilder()

public DurationOrBuilder getDeploymentTimeoutOrBuilder()

Immutable. Deployment timeout. Limit for deployment timeout is 2 hours.

.google.protobuf.Duration deployment_timeout = 10 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
DurationOrBuilder

getEnv(int index)

public EnvVar getEnv(int index)

Immutable. List of environment variables to set in the container. After the container starts running, code running in the container can read these environment variables.

Additionally, the command and args fields can reference these variables. Later entries in this list can also reference earlier entries. For example, the following example sets the variable VAR_2 to have the value foo bar:

`json [ { "name": "VAR_1", "value": "foo" }, { "name": "VAR_2", "value": "$(VAR_1) bar" } ]

If you switch the order of the variables in the example, then the expansion does not occur.

This field corresponds to the env` field of the Kubernetes Containers v1 core API.

repeated .google.cloud.aiplatform.v1beta1.EnvVar env = 4 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
index int
Returns
Type Description
EnvVar

getEnvCount()

public int getEnvCount()

Immutable. List of environment variables to set in the container. After the container starts running, code running in the container can read these environment variables.

Additionally, the command and args fields can reference these variables. Later entries in this list can also reference earlier entries. For example, the following example sets the variable VAR_2 to have the value foo bar:

`json [ { "name": "VAR_1", "value": "foo" }, { "name": "VAR_2", "value": "$(VAR_1) bar" } ]

If you switch the order of the variables in the example, then the expansion does not occur.

This field corresponds to the env` field of the Kubernetes Containers v1 core API.

repeated .google.cloud.aiplatform.v1beta1.EnvVar env = 4 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
int

getEnvList()

public List<EnvVar> getEnvList()

Immutable. List of environment variables to set in the container. After the container starts running, code running in the container can read these environment variables.

Additionally, the command and args fields can reference these variables. Later entries in this list can also reference earlier entries. For example, the following example sets the variable VAR_2 to have the value foo bar:

`json [ { "name": "VAR_1", "value": "foo" }, { "name": "VAR_2", "value": "$(VAR_1) bar" } ]

If you switch the order of the variables in the example, then the expansion does not occur.

This field corresponds to the env` field of the Kubernetes Containers v1 core API.

repeated .google.cloud.aiplatform.v1beta1.EnvVar env = 4 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
List<EnvVar>

getEnvOrBuilder(int index)

public EnvVarOrBuilder getEnvOrBuilder(int index)

Immutable. List of environment variables to set in the container. After the container starts running, code running in the container can read these environment variables.

Additionally, the command and args fields can reference these variables. Later entries in this list can also reference earlier entries. For example, the following example sets the variable VAR_2 to have the value foo bar:

`json [ { "name": "VAR_1", "value": "foo" }, { "name": "VAR_2", "value": "$(VAR_1) bar" } ]

If you switch the order of the variables in the example, then the expansion does not occur.

This field corresponds to the env` field of the Kubernetes Containers v1 core API.

repeated .google.cloud.aiplatform.v1beta1.EnvVar env = 4 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
index int
Returns
Type Description
EnvVarOrBuilder

getEnvOrBuilderList()

public List<? extends EnvVarOrBuilder> getEnvOrBuilderList()

Immutable. List of environment variables to set in the container. After the container starts running, code running in the container can read these environment variables.

Additionally, the command and args fields can reference these variables. Later entries in this list can also reference earlier entries. For example, the following example sets the variable VAR_2 to have the value foo bar:

`json [ { "name": "VAR_1", "value": "foo" }, { "name": "VAR_2", "value": "$(VAR_1) bar" } ]

If you switch the order of the variables in the example, then the expansion does not occur.

This field corresponds to the env` field of the Kubernetes Containers v1 core API.

repeated .google.cloud.aiplatform.v1beta1.EnvVar env = 4 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1beta1.EnvVarOrBuilder>

getGrpcPorts(int index)

public Port getGrpcPorts(int index)

Immutable. List of ports to expose from the container. Vertex AI sends gRPC prediction requests that it receives to the first port on this list. Vertex AI also sends liveness and health checks to this port.

If you do not specify this field, gRPC requests to the container will be disabled.

Vertex AI does not use ports other than the first one listed. This field corresponds to the ports field of the Kubernetes Containers v1 core API.

repeated .google.cloud.aiplatform.v1beta1.Port grpc_ports = 9 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
index int
Returns
Type Description
Port

getGrpcPortsCount()

public int getGrpcPortsCount()

Immutable. List of ports to expose from the container. Vertex AI sends gRPC prediction requests that it receives to the first port on this list. Vertex AI also sends liveness and health checks to this port.

If you do not specify this field, gRPC requests to the container will be disabled.

Vertex AI does not use ports other than the first one listed. This field corresponds to the ports field of the Kubernetes Containers v1 core API.

repeated .google.cloud.aiplatform.v1beta1.Port grpc_ports = 9 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
int

getGrpcPortsList()

public List<Port> getGrpcPortsList()

Immutable. List of ports to expose from the container. Vertex AI sends gRPC prediction requests that it receives to the first port on this list. Vertex AI also sends liveness and health checks to this port.

If you do not specify this field, gRPC requests to the container will be disabled.

Vertex AI does not use ports other than the first one listed. This field corresponds to the ports field of the Kubernetes Containers v1 core API.

repeated .google.cloud.aiplatform.v1beta1.Port grpc_ports = 9 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
List<Port>

getGrpcPortsOrBuilder(int index)

public PortOrBuilder getGrpcPortsOrBuilder(int index)

Immutable. List of ports to expose from the container. Vertex AI sends gRPC prediction requests that it receives to the first port on this list. Vertex AI also sends liveness and health checks to this port.

If you do not specify this field, gRPC requests to the container will be disabled.

Vertex AI does not use ports other than the first one listed. This field corresponds to the ports field of the Kubernetes Containers v1 core API.

repeated .google.cloud.aiplatform.v1beta1.Port grpc_ports = 9 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
index int
Returns
Type Description
PortOrBuilder

getGrpcPortsOrBuilderList()

public List<? extends PortOrBuilder> getGrpcPortsOrBuilderList()

Immutable. List of ports to expose from the container. Vertex AI sends gRPC prediction requests that it receives to the first port on this list. Vertex AI also sends liveness and health checks to this port.

If you do not specify this field, gRPC requests to the container will be disabled.

Vertex AI does not use ports other than the first one listed. This field corresponds to the ports field of the Kubernetes Containers v1 core API.

repeated .google.cloud.aiplatform.v1beta1.Port grpc_ports = 9 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1beta1.PortOrBuilder>

getHealthProbe()

public Probe getHealthProbe()

Immutable. Specification for Kubernetes readiness probe.

.google.cloud.aiplatform.v1beta1.Probe health_probe = 13 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Probe

The healthProbe.

getHealthProbeOrBuilder()

public ProbeOrBuilder getHealthProbeOrBuilder()

Immutable. Specification for Kubernetes readiness probe.

.google.cloud.aiplatform.v1beta1.Probe health_probe = 13 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ProbeOrBuilder

getHealthRoute()

public String getHealthRoute()

Immutable. HTTP path on the container to send health checks to. Vertex AI intermittently sends GET requests to this path on the container's IP address and port to check that the container is healthy. Read more about health checks.

For example, if you set this field to /bar, then Vertex AI intermittently sends a GET request to the /bar path on the port of your container specified by the first value of this ModelContainerSpec's ports field.

If you don't specify this field, it defaults to the following value when you deploy this Model to an Endpoint: <code>/v1/endpoints/<var>ENDPOINT</var>/deployedModels/<var>DEPLOYED_MODEL</var>:predict</code> The placeholders in this value are replaced as follows:

  • <var>ENDPOINT</var>: The last segment (following endpoints/)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the AIP_ENDPOINT_ID environment variable.)

  • <var>DEPLOYED_MODEL</var>: DeployedModel.id of the DeployedModel. (Vertex AI makes this value available to your container code as the AIP_DEPLOYED_MODEL_ID environment variable.)

string health_route = 7 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The healthRoute.

getHealthRouteBytes()

public ByteString getHealthRouteBytes()

Immutable. HTTP path on the container to send health checks to. Vertex AI intermittently sends GET requests to this path on the container's IP address and port to check that the container is healthy. Read more about health checks.

For example, if you set this field to /bar, then Vertex AI intermittently sends a GET request to the /bar path on the port of your container specified by the first value of this ModelContainerSpec's ports field.

If you don't specify this field, it defaults to the following value when you deploy this Model to an Endpoint: <code>/v1/endpoints/<var>ENDPOINT</var>/deployedModels/<var>DEPLOYED_MODEL</var>:predict</code> The placeholders in this value are replaced as follows:

  • <var>ENDPOINT</var>: The last segment (following endpoints/)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the AIP_ENDPOINT_ID environment variable.)

  • <var>DEPLOYED_MODEL</var>: DeployedModel.id of the DeployedModel. (Vertex AI makes this value available to your container code as the AIP_DEPLOYED_MODEL_ID environment variable.)

string health_route = 7 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for healthRoute.

getImageUri()

public String getImageUri()

Required. Immutable. URI of the Docker image to be used as the custom container for serving predictions. This URI must identify an image in Artifact Registry or Container Registry. Learn more about the container publishing requirements, including permissions requirements for the Vertex AI Service Agent.

The container image is ingested upon ModelService.UploadModel, stored internally, and this original path is afterwards not used.

To learn about the requirements for the Docker image itself, see Custom container requirements.

You can use the URI to one of Vertex AI's pre-built container images for prediction in this field.

string image_uri = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The imageUri.

getImageUriBytes()

public ByteString getImageUriBytes()

Required. Immutable. URI of the Docker image to be used as the custom container for serving predictions. This URI must identify an image in Artifact Registry or Container Registry. Learn more about the container publishing requirements, including permissions requirements for the Vertex AI Service Agent.

The container image is ingested upon ModelService.UploadModel, stored internally, and this original path is afterwards not used.

To learn about the requirements for the Docker image itself, see Custom container requirements.

You can use the URI to one of Vertex AI's pre-built container images for prediction in this field.

string image_uri = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for imageUri.

getParserForType()

public Parser<ModelContainerSpec> getParserForType()
Returns
Type Description
Parser<ModelContainerSpec>
Overrides

getPorts(int index)

public Port getPorts(int index)

Immutable. List of ports to expose from the container. Vertex AI sends any prediction requests that it receives to the first port on this list. Vertex AI also sends liveness and health checks to this port.

If you do not specify this field, it defaults to following value:

`json [ { "containerPort": 8080 } ]

Vertex AI does not use ports other than the first one listed. This field corresponds to the ports` field of the Kubernetes Containers v1 core API.

repeated .google.cloud.aiplatform.v1beta1.Port ports = 5 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
index int
Returns
Type Description
Port

getPortsCount()

public int getPortsCount()

Immutable. List of ports to expose from the container. Vertex AI sends any prediction requests that it receives to the first port on this list. Vertex AI also sends liveness and health checks to this port.

If you do not specify this field, it defaults to following value:

`json [ { "containerPort": 8080 } ]

Vertex AI does not use ports other than the first one listed. This field corresponds to the ports` field of the Kubernetes Containers v1 core API.

repeated .google.cloud.aiplatform.v1beta1.Port ports = 5 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
int

getPortsList()

public List<Port> getPortsList()

Immutable. List of ports to expose from the container. Vertex AI sends any prediction requests that it receives to the first port on this list. Vertex AI also sends liveness and health checks to this port.

If you do not specify this field, it defaults to following value:

`json [ { "containerPort": 8080 } ]

Vertex AI does not use ports other than the first one listed. This field corresponds to the ports` field of the Kubernetes Containers v1 core API.

repeated .google.cloud.aiplatform.v1beta1.Port ports = 5 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
List<Port>

getPortsOrBuilder(int index)

public PortOrBuilder getPortsOrBuilder(int index)

Immutable. List of ports to expose from the container. Vertex AI sends any prediction requests that it receives to the first port on this list. Vertex AI also sends liveness and health checks to this port.

If you do not specify this field, it defaults to following value:

`json [ { "containerPort": 8080 } ]

Vertex AI does not use ports other than the first one listed. This field corresponds to the ports` field of the Kubernetes Containers v1 core API.

repeated .google.cloud.aiplatform.v1beta1.Port ports = 5 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
index int
Returns
Type Description
PortOrBuilder

getPortsOrBuilderList()

public List<? extends PortOrBuilder> getPortsOrBuilderList()

Immutable. List of ports to expose from the container. Vertex AI sends any prediction requests that it receives to the first port on this list. Vertex AI also sends liveness and health checks to this port.

If you do not specify this field, it defaults to following value:

`json [ { "containerPort": 8080 } ]

Vertex AI does not use ports other than the first one listed. This field corresponds to the ports` field of the Kubernetes Containers v1 core API.

repeated .google.cloud.aiplatform.v1beta1.Port ports = 5 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1beta1.PortOrBuilder>

getPredictRoute()

public String getPredictRoute()

Immutable. HTTP path on the container to send prediction requests to. Vertex AI forwards requests sent using projects.locations.endpoints.predict to this path on the container's IP address and port. Vertex AI then returns the container's response in the API response.

For example, if you set this field to /foo, then when Vertex AI receives a prediction request, it forwards the request body in a POST request to the /foo path on the port of your container specified by the first value of this ModelContainerSpec's ports field.

If you don't specify this field, it defaults to the following value when you deploy this Model to an Endpoint: <code>/v1/endpoints/<var>ENDPOINT</var>/deployedModels/<var>DEPLOYED_MODEL</var>:predict</code> The placeholders in this value are replaced as follows:

  • <var>ENDPOINT</var>: The last segment (following endpoints/)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the AIP_ENDPOINT_ID environment variable.)

  • <var>DEPLOYED_MODEL</var>: DeployedModel.id of the DeployedModel. (Vertex AI makes this value available to your container code as the AIP_DEPLOYED_MODEL_ID environment variable.)

string predict_route = 6 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The predictRoute.

getPredictRouteBytes()

public ByteString getPredictRouteBytes()

Immutable. HTTP path on the container to send prediction requests to. Vertex AI forwards requests sent using projects.locations.endpoints.predict to this path on the container's IP address and port. Vertex AI then returns the container's response in the API response.

For example, if you set this field to /foo, then when Vertex AI receives a prediction request, it forwards the request body in a POST request to the /foo path on the port of your container specified by the first value of this ModelContainerSpec's ports field.

If you don't specify this field, it defaults to the following value when you deploy this Model to an Endpoint: <code>/v1/endpoints/<var>ENDPOINT</var>/deployedModels/<var>DEPLOYED_MODEL</var>:predict</code> The placeholders in this value are replaced as follows:

  • <var>ENDPOINT</var>: The last segment (following endpoints/)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the AIP_ENDPOINT_ID environment variable.)

  • <var>DEPLOYED_MODEL</var>: DeployedModel.id of the DeployedModel. (Vertex AI makes this value available to your container code as the AIP_DEPLOYED_MODEL_ID environment variable.)

string predict_route = 6 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for predictRoute.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSharedMemorySizeMb()

public long getSharedMemorySizeMb()

Immutable. The amount of the VM memory to reserve as the shared memory for the model in megabytes.

int64 shared_memory_size_mb = 11 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
long

The sharedMemorySizeMb.

getStartupProbe()

public Probe getStartupProbe()

Immutable. Specification for Kubernetes startup probe.

.google.cloud.aiplatform.v1beta1.Probe startup_probe = 12 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Probe

The startupProbe.

getStartupProbeOrBuilder()

public ProbeOrBuilder getStartupProbeOrBuilder()

Immutable. Specification for Kubernetes startup probe.

.google.cloud.aiplatform.v1beta1.Probe startup_probe = 12 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ProbeOrBuilder

hasDeploymentTimeout()

public boolean hasDeploymentTimeout()

Immutable. Deployment timeout. Limit for deployment timeout is 2 hours.

.google.protobuf.Duration deployment_timeout = 10 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the deploymentTimeout field is set.

hasHealthProbe()

public boolean hasHealthProbe()

Immutable. Specification for Kubernetes readiness probe.

.google.cloud.aiplatform.v1beta1.Probe health_probe = 13 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the healthProbe field is set.

hasStartupProbe()

public boolean hasStartupProbe()

Immutable. Specification for Kubernetes startup probe.

.google.cloud.aiplatform.v1beta1.Probe startup_probe = 12 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the startupProbe field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ModelContainerSpec.Builder newBuilderForType()
Returns
Type Description
ModelContainerSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ModelContainerSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ModelContainerSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ModelContainerSpec.Builder toBuilder()
Returns
Type Description
ModelContainerSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException