Class ModelContainerSpec.Builder (2.4.0)

public static final class ModelContainerSpec.Builder extends GeneratedMessageV3.Builder<ModelContainerSpec.Builder> 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

Methods

addAllArgs(Iterable<String> values)

public ModelContainerSpec.Builder addAllArgs(Iterable<String> values)

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
NameDescription
valuesIterable<String>

The args to add.

Returns
TypeDescription
ModelContainerSpec.Builder

This builder for chaining.

addAllCommand(Iterable<String> values)

public ModelContainerSpec.Builder addAllCommand(Iterable<String> values)

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
NameDescription
valuesIterable<String>

The command to add.

Returns
TypeDescription
ModelContainerSpec.Builder

This builder for chaining.

addAllEnv(Iterable<? extends EnvVar> values)

public ModelContainerSpec.Builder addAllEnv(Iterable<? extends EnvVar> values)

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

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.aiplatform.v1.EnvVar>
Returns
TypeDescription
ModelContainerSpec.Builder

addAllPorts(Iterable<? extends Port> values)

public ModelContainerSpec.Builder addAllPorts(Iterable<? extends Port> values)

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

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.aiplatform.v1.Port>
Returns
TypeDescription
ModelContainerSpec.Builder

addArgs(String value)

public ModelContainerSpec.Builder addArgs(String value)

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
NameDescription
valueString

The args to add.

Returns
TypeDescription
ModelContainerSpec.Builder

This builder for chaining.

addArgsBytes(ByteString value)

public ModelContainerSpec.Builder addArgsBytes(ByteString value)

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
NameDescription
valueByteString

The bytes of the args to add.

Returns
TypeDescription
ModelContainerSpec.Builder

This builder for chaining.

addCommand(String value)

public ModelContainerSpec.Builder addCommand(String value)

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
NameDescription
valueString

The command to add.

Returns
TypeDescription
ModelContainerSpec.Builder

This builder for chaining.

addCommandBytes(ByteString value)

public ModelContainerSpec.Builder addCommandBytes(ByteString value)

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
NameDescription
valueByteString

The bytes of the command to add.

Returns
TypeDescription
ModelContainerSpec.Builder

This builder for chaining.

addEnv(EnvVar value)

public ModelContainerSpec.Builder addEnv(EnvVar value)

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

Parameter
NameDescription
valueEnvVar
Returns
TypeDescription
ModelContainerSpec.Builder

addEnv(EnvVar.Builder builderForValue)

public ModelContainerSpec.Builder addEnv(EnvVar.Builder builderForValue)

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

Parameter
NameDescription
builderForValueEnvVar.Builder
Returns
TypeDescription
ModelContainerSpec.Builder

addEnv(int index, EnvVar value)

public ModelContainerSpec.Builder addEnv(int index, EnvVar value)

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

Parameters
NameDescription
indexint
valueEnvVar
Returns
TypeDescription
ModelContainerSpec.Builder

addEnv(int index, EnvVar.Builder builderForValue)

public ModelContainerSpec.Builder addEnv(int index, EnvVar.Builder builderForValue)

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

Parameters
NameDescription
indexint
builderForValueEnvVar.Builder
Returns
TypeDescription
ModelContainerSpec.Builder

addEnvBuilder()

public EnvVar.Builder addEnvBuilder()

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

Returns
TypeDescription
EnvVar.Builder

addEnvBuilder(int index)

public EnvVar.Builder addEnvBuilder(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];

Parameter
NameDescription
indexint
Returns
TypeDescription
EnvVar.Builder

addPorts(Port value)

public ModelContainerSpec.Builder addPorts(Port value)

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

Parameter
NameDescription
valuePort
Returns
TypeDescription
ModelContainerSpec.Builder

addPorts(Port.Builder builderForValue)

public ModelContainerSpec.Builder addPorts(Port.Builder builderForValue)

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

Parameter
NameDescription
builderForValuePort.Builder
Returns
TypeDescription
ModelContainerSpec.Builder

addPorts(int index, Port value)

public ModelContainerSpec.Builder addPorts(int index, Port value)

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

Parameters
NameDescription
indexint
valuePort
Returns
TypeDescription
ModelContainerSpec.Builder

addPorts(int index, Port.Builder builderForValue)

public ModelContainerSpec.Builder addPorts(int index, Port.Builder builderForValue)

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

Parameters
NameDescription
indexint
builderForValuePort.Builder
Returns
TypeDescription
ModelContainerSpec.Builder

addPortsBuilder()

public Port.Builder addPortsBuilder()

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

Returns
TypeDescription
Port.Builder

addPortsBuilder(int index)

public Port.Builder addPortsBuilder(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];

Parameter
NameDescription
indexint
Returns
TypeDescription
Port.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ModelContainerSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ModelContainerSpec.Builder
Overrides

build()

public ModelContainerSpec build()
Returns
TypeDescription
ModelContainerSpec

buildPartial()

public ModelContainerSpec buildPartial()
Returns
TypeDescription
ModelContainerSpec

clear()

public ModelContainerSpec.Builder clear()
Returns
TypeDescription
ModelContainerSpec.Builder
Overrides

clearArgs()

public ModelContainerSpec.Builder clearArgs()

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
TypeDescription
ModelContainerSpec.Builder

This builder for chaining.

clearCommand()

public ModelContainerSpec.Builder clearCommand()

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
TypeDescription
ModelContainerSpec.Builder

This builder for chaining.

clearEnv()

public ModelContainerSpec.Builder clearEnv()

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

Returns
TypeDescription
ModelContainerSpec.Builder

clearField(Descriptors.FieldDescriptor field)

public ModelContainerSpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ModelContainerSpec.Builder
Overrides

clearHealthRoute()

public ModelContainerSpec.Builder clearHealthRoute()

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
TypeDescription
ModelContainerSpec.Builder

This builder for chaining.

clearImageUri()

public ModelContainerSpec.Builder clearImageUri()

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
TypeDescription
ModelContainerSpec.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ModelContainerSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ModelContainerSpec.Builder
Overrides

clearPorts()

public ModelContainerSpec.Builder clearPorts()

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

Returns
TypeDescription
ModelContainerSpec.Builder

clearPredictRoute()

public ModelContainerSpec.Builder clearPredictRoute()

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
TypeDescription
ModelContainerSpec.Builder

This builder for chaining.

clone()

public ModelContainerSpec.Builder clone()
Returns
TypeDescription
ModelContainerSpec.Builder
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ProtocolStringList

A list containing the command.

getDefaultInstanceForType()

public ModelContainerSpec getDefaultInstanceForType()
Returns
TypeDescription
ModelContainerSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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

Parameter
NameDescription
indexint
Returns
TypeDescription
EnvVar

getEnvBuilder(int index)

public EnvVar.Builder getEnvBuilder(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];

Parameter
NameDescription
indexint
Returns
TypeDescription
EnvVar.Builder

getEnvBuilderList()

public List<EnvVar.Builder> getEnvBuilderList()

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

Returns
TypeDescription
List<Builder>

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

Returns
TypeDescription
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: <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];

Returns
TypeDescription
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: <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];

Parameter
NameDescription
indexint
Returns
TypeDescription
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: <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];

Returns
TypeDescription
List<? extends com.google.cloud.aiplatform.v1.EnvVarOrBuilder>

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for imageUri.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Port

getPortsBuilder(int index)

public Port.Builder getPortsBuilder(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];

Parameter
NameDescription
indexint
Returns
TypeDescription
Port.Builder

getPortsBuilderList()

public List<Port.Builder> getPortsBuilderList()

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

Returns
TypeDescription
List<Builder>

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

Returns
TypeDescription
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: <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];

Returns
TypeDescription
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: <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];

Parameter
NameDescription
indexint
Returns
TypeDescription
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: <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];

Returns
TypeDescription
List<? extends com.google.cloud.aiplatform.v1.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
TypeDescription
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
TypeDescription
ByteString

The bytes for predictRoute.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ModelContainerSpec other)

public ModelContainerSpec.Builder mergeFrom(ModelContainerSpec other)
Parameter
NameDescription
otherModelContainerSpec
Returns
TypeDescription
ModelContainerSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ModelContainerSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ModelContainerSpec.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ModelContainerSpec.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ModelContainerSpec.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ModelContainerSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ModelContainerSpec.Builder
Overrides

removeEnv(int index)

public ModelContainerSpec.Builder removeEnv(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];

Parameter
NameDescription
indexint
Returns
TypeDescription
ModelContainerSpec.Builder

removePorts(int index)

public ModelContainerSpec.Builder removePorts(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];

Parameter
NameDescription
indexint
Returns
TypeDescription
ModelContainerSpec.Builder

setArgs(int index, String value)

public ModelContainerSpec.Builder setArgs(int index, String value)

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

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The args to set.

Returns
TypeDescription
ModelContainerSpec.Builder

This builder for chaining.

setCommand(int index, String value)

public ModelContainerSpec.Builder setCommand(int index, String value)

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

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The command to set.

Returns
TypeDescription
ModelContainerSpec.Builder

This builder for chaining.

setEnv(int index, EnvVar value)

public ModelContainerSpec.Builder setEnv(int index, EnvVar value)

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

Parameters
NameDescription
indexint
valueEnvVar
Returns
TypeDescription
ModelContainerSpec.Builder

setEnv(int index, EnvVar.Builder builderForValue)

public ModelContainerSpec.Builder setEnv(int index, EnvVar.Builder builderForValue)

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

Parameters
NameDescription
indexint
builderForValueEnvVar.Builder
Returns
TypeDescription
ModelContainerSpec.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ModelContainerSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ModelContainerSpec.Builder
Overrides

setHealthRoute(String value)

public ModelContainerSpec.Builder setHealthRoute(String value)

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

Parameter
NameDescription
valueString

The healthRoute to set.

Returns
TypeDescription
ModelContainerSpec.Builder

This builder for chaining.

setHealthRouteBytes(ByteString value)

public ModelContainerSpec.Builder setHealthRouteBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for healthRoute to set.

Returns
TypeDescription
ModelContainerSpec.Builder

This builder for chaining.

setImageUri(String value)

public ModelContainerSpec.Builder setImageUri(String value)

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

Parameter
NameDescription
valueString

The imageUri to set.

Returns
TypeDescription
ModelContainerSpec.Builder

This builder for chaining.

setImageUriBytes(ByteString value)

public ModelContainerSpec.Builder setImageUriBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for imageUri to set.

Returns
TypeDescription
ModelContainerSpec.Builder

This builder for chaining.

setPorts(int index, Port value)

public ModelContainerSpec.Builder setPorts(int index, Port value)

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

Parameters
NameDescription
indexint
valuePort
Returns
TypeDescription
ModelContainerSpec.Builder

setPorts(int index, Port.Builder builderForValue)

public ModelContainerSpec.Builder setPorts(int index, Port.Builder builderForValue)

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

Parameters
NameDescription
indexint
builderForValuePort.Builder
Returns
TypeDescription
ModelContainerSpec.Builder

setPredictRoute(String value)

public ModelContainerSpec.Builder setPredictRoute(String value)

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

Parameter
NameDescription
valueString

The predictRoute to set.

Returns
TypeDescription
ModelContainerSpec.Builder

This builder for chaining.

setPredictRouteBytes(ByteString value)

public ModelContainerSpec.Builder setPredictRouteBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for predictRoute to set.

Returns
TypeDescription
ModelContainerSpec.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ModelContainerSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ModelContainerSpec.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ModelContainerSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ModelContainerSpec.Builder
Overrides