Google Cloud Ai Platform V1 Client - Class DeploymentSpec (1.54.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class DeploymentSpec.

The specification of a Reasoning Engine deployment.

Generated from protobuf message google.cloud.aiplatform.v1.ReasoningEngineSpec.DeploymentSpec

Namespace

Google \ Cloud \ AIPlatform \ V1 \ ReasoningEngineSpec

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ env array<Google\Cloud\AIPlatform\V1\EnvVar>

Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API.

↳ secret_env array<Google\Cloud\AIPlatform\V1\SecretEnvVar>

Optional. Environment variables where the value is a secret in Cloud Secret Manager. To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent.

↳ psc_interface_config Google\Cloud\AIPlatform\V1\PscInterfaceConfig

Optional. Configuration for PSC-I.

↳ min_instances int

Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 10].

↳ max_instances int

Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100. Range: [1, 1000]. If VPC-SC or PSC-I is enabled, the acceptable range is [1, 100].

↳ resource_limits array|Google\Protobuf\Internal\MapField

Optional. Resource limits for each container. Only 'cpu' and 'memory' keys are supported. Defaults to {"cpu": "4", "memory": "4Gi"}. * * The only supported values for CPU are '1', '2', '4', '6' and '8'. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * * The only supported values for memory are '1Gi', '2Gi', ... '32 Gi'. * * For required cpu on different memory values, go to https://cloud.google.com/run/docs/configuring/memory-limits

↳ container_concurrency int

Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9.

getEnv

Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API.

Returns
Type Description
Google\Protobuf\RepeatedField<Google\Cloud\AIPlatform\V1\EnvVar>

setEnv

Optional. Environment variables to be set with the Reasoning Engine deployment. The environment variables can be updated through the UpdateReasoningEngine API.

Parameter
Name Description
var array<Google\Cloud\AIPlatform\V1\EnvVar>
Returns
Type Description
$this

getSecretEnv

Optional. Environment variables where the value is a secret in Cloud Secret Manager.

To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent.

Returns
Type Description
Google\Protobuf\RepeatedField<Google\Cloud\AIPlatform\V1\SecretEnvVar>

setSecretEnv

Optional. Environment variables where the value is a secret in Cloud Secret Manager.

To use this feature, add 'Secret Manager Secret Accessor' role (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine Service Agent.

Parameter
Name Description
var array<Google\Cloud\AIPlatform\V1\SecretEnvVar>
Returns
Type Description
$this

getPscInterfaceConfig

Optional. Configuration for PSC-I.

Returns
Type Description
Google\Cloud\AIPlatform\V1\PscInterfaceConfig|null

hasPscInterfaceConfig

clearPscInterfaceConfig

setPscInterfaceConfig

Optional. Configuration for PSC-I.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\PscInterfaceConfig
Returns
Type Description
$this

getMinInstances

Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 10].

Returns
Type Description
int

hasMinInstances

clearMinInstances

setMinInstances

Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1. Range: [0, 10].

Parameter
Name Description
var int
Returns
Type Description
$this

getMaxInstances

Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100. Range: [1, 1000].

If VPC-SC or PSC-I is enabled, the acceptable range is [1, 100].

Returns
Type Description
int

hasMaxInstances

clearMaxInstances

setMaxInstances

Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100. Range: [1, 1000].

If VPC-SC or PSC-I is enabled, the acceptable range is [1, 100].

Parameter
Name Description
var int
Returns
Type Description
$this

getResourceLimits

Optional. Resource limits for each container. Only 'cpu' and 'memory' keys are supported. Defaults to {"cpu": "4", "memory": "4Gi"}.

Returns
Type Description
Google\Protobuf\Internal\MapField

setResourceLimits

Optional. Resource limits for each container. Only 'cpu' and 'memory' keys are supported. Defaults to {"cpu": "4", "memory": "4Gi"}.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getContainerConcurrency

Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9.

Returns
Type Description
int

hasContainerConcurrency

clearContainerConcurrency

setContainerConcurrency

Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9.

Parameter
Name Description
var int
Returns
Type Description
$this