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.v1.ModelContainerSpec
Static Fields
public static final int ARGS_FIELD_NUMBER
Field Value
public static final int COMMAND_FIELD_NUMBER
Field Value
public static final int ENV_FIELD_NUMBER
Field Value
public static final int HEALTH_ROUTE_FIELD_NUMBER
Field Value
public static final int IMAGE_URI_FIELD_NUMBER
Field Value
public static final int PORTS_FIELD_NUMBER
Field Value
public static final int PREDICT_ROUTE_FIELD_NUMBER
Field Value
Static Methods
public static ModelContainerSpec getDefaultInstance()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public static ModelContainerSpec.Builder newBuilder()
Returns
public static ModelContainerSpec.Builder newBuilder(ModelContainerSpec prototype)
Parameter
Returns
public static ModelContainerSpec parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ModelContainerSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ModelContainerSpec parseFrom(byte[] data)
Parameter
| Name | Description |
data | byte[]
|
Returns
Exceptions
public static ModelContainerSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ModelContainerSpec parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static ModelContainerSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ModelContainerSpec parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ModelContainerSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ModelContainerSpec parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ModelContainerSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ModelContainerSpec parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static ModelContainerSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<ModelContainerSpec> parser()
Returns
Methods
public boolean equals(Object obj)
Parameter
Returns
Overrides
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];
| Name | Description |
index | int
The index of the element to return.
|
Returns
| Type | Description |
String | The args at the given 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];
| Name | Description |
index | int
The index of the value to return.
|
Returns
| Type | Description |
ByteString | The bytes of the args at the given index.
|
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];
| Type | Description |
int | The count of args.
|
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];
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];
| Name | Description |
index | int
The index of the element to return.
|
Returns
| Type | Description |
String | The command at the given 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];
| Name | Description |
index | int
The index of the value to return.
|
Returns
| Type | Description |
ByteString | The bytes of the command at the given index.
|
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];
| Type | Description |
int | The count of command.
|
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];
public ModelContainerSpec getDefaultInstanceForType()
Returns
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:
<code><code>json
[
{
"name": "VAR_1",
"value": "foo"
},
{
"name": "VAR_2",
"value": "$(VAR_1) bar"
}
]
</code></code><code>
If you switch the order of the variables in the example, then the expansion
does not occur.
This field corresponds to the </code>env field of the Kubernetes Containers
v1 core
API.
repeated .google.cloud.aiplatform.v1.EnvVar env = 4 [(.google.api.field_behavior) = IMMUTABLE];
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:
<code><code>json
[
{
"name": "VAR_1",
"value": "foo"
},
{
"name": "VAR_2",
"value": "$(VAR_1) bar"
}
]
</code></code><code>
If you switch the order of the variables in the example, then the expansion
does not occur.
This field corresponds to the </code>env field of the Kubernetes Containers
v1 core
API.
repeated .google.cloud.aiplatform.v1.EnvVar env = 4 [(.google.api.field_behavior) = IMMUTABLE];
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:
<code><code>json
[
{
"name": "VAR_1",
"value": "foo"
},
{
"name": "VAR_2",
"value": "$(VAR_1) bar"
}
]
</code></code><code>
If you switch the order of the variables in the example, then the expansion
does not occur.
This field corresponds to the </code>env field of the Kubernetes Containers
v1 core
API.
repeated .google.cloud.aiplatform.v1.EnvVar env = 4 [(.google.api.field_behavior) = IMMUTABLE];
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:
<code><code>json
[
{
"name": "VAR_1",
"value": "foo"
},
{
"name": "VAR_2",
"value": "$(VAR_1) bar"
}
]
</code></code><code>
If you switch the order of the variables in the example, then the expansion
does not occur.
This field corresponds to the </code>env field of the Kubernetes Containers
v1 core
API.
repeated .google.cloud.aiplatform.v1.EnvVar env = 4 [(.google.api.field_behavior) = IMMUTABLE];
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:
<code><code>json
[
{
"name": "VAR_1",
"value": "foo"
},
{
"name": "VAR_2",
"value": "$(VAR_1) bar"
}
]
</code></code><code>
If you switch the order of the variables in the example, then the expansion
does not occur.
This field corresponds to the </code>env field of the Kubernetes Containers
v1 core
API.
repeated .google.cloud.aiplatform.v1.EnvVar env = 4 [(.google.api.field_behavior) = IMMUTABLE];
| Type | Description |
List<? extends com.google.cloud.aiplatform.v1.EnvVarOrBuilder> | |
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];
| Type | Description |
String | The healthRoute.
|
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];
| Type | Description |
ByteString | The bytes for healthRoute.
|
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];
| Type | Description |
String | The imageUri.
|
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];
public Parser<ModelContainerSpec> getParserForType()
Returns
Overrides
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:
<code><code>json
[
{
"containerPort": 8080
}
]
</code></code><code>
Vertex AI does not use ports other than the first one listed. This field
corresponds to the </code>ports field of the Kubernetes Containers
v1 core
API.
repeated .google.cloud.aiplatform.v1.Port ports = 5 [(.google.api.field_behavior) = IMMUTABLE];
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:
<code><code>json
[
{
"containerPort": 8080
}
]
</code></code><code>
Vertex AI does not use ports other than the first one listed. This field
corresponds to the </code>ports field of the Kubernetes Containers
v1 core
API.
repeated .google.cloud.aiplatform.v1.Port ports = 5 [(.google.api.field_behavior) = IMMUTABLE];
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:
<code><code>json
[
{
"containerPort": 8080
}
]
</code></code><code>
Vertex AI does not use ports other than the first one listed. This field
corresponds to the </code>ports field of the Kubernetes Containers
v1 core
API.
repeated .google.cloud.aiplatform.v1.Port ports = 5 [(.google.api.field_behavior) = IMMUTABLE];
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:
<code><code>json
[
{
"containerPort": 8080
}
]
</code></code><code>
Vertex AI does not use ports other than the first one listed. This field
corresponds to the </code>ports field of the Kubernetes Containers
v1 core
API.
repeated .google.cloud.aiplatform.v1.Port ports = 5 [(.google.api.field_behavior) = IMMUTABLE];
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:
<code><code>json
[
{
"containerPort": 8080
}
]
</code></code><code>
Vertex AI does not use ports other than the first one listed. This field
corresponds to the </code>ports field of the Kubernetes Containers
v1 core
API.
repeated .google.cloud.aiplatform.v1.Port ports = 5 [(.google.api.field_behavior) = IMMUTABLE];
| Type | Description |
List<? extends com.google.cloud.aiplatform.v1.PortOrBuilder> | |
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];
| Type | Description |
String | The predictRoute.
|
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];
| Type | Description |
ByteString | The bytes for predictRoute.
|
public int getSerializedSize()
Returns
Overrides
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
Returns
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public ModelContainerSpec.Builder newBuilderForType()
Returns
protected ModelContainerSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public ModelContainerSpec.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
