Class ReasoningEngineSpec.DeploymentSpec (3.73.0)

public static final class ReasoningEngineSpec.DeploymentSpec extends GeneratedMessageV3 implements ReasoningEngineSpec.DeploymentSpecOrBuilder

The specification of a Reasoning Engine deployment.

Protobuf type google.cloud.aiplatform.v1beta1.ReasoningEngineSpec.DeploymentSpec

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ReasoningEngineSpec.DeploymentSpec

Static Fields

CONTAINER_CONCURRENCY_FIELD_NUMBER

public static final int CONTAINER_CONCURRENCY_FIELD_NUMBER
Field Value
Type Description
int

ENV_FIELD_NUMBER

public static final int ENV_FIELD_NUMBER
Field Value
Type Description
int

MAX_INSTANCES_FIELD_NUMBER

public static final int MAX_INSTANCES_FIELD_NUMBER
Field Value
Type Description
int

MIN_INSTANCES_FIELD_NUMBER

public static final int MIN_INSTANCES_FIELD_NUMBER
Field Value
Type Description
int

PSC_INTERFACE_CONFIG_FIELD_NUMBER

public static final int PSC_INTERFACE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_LIMITS_FIELD_NUMBER

public static final int RESOURCE_LIMITS_FIELD_NUMBER
Field Value
Type Description
int

SECRET_ENV_FIELD_NUMBER

public static final int SECRET_ENV_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ReasoningEngineSpec.DeploymentSpec getDefaultInstance()
Returns
Type Description
ReasoningEngineSpec.DeploymentSpec

getDescriptor()

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

newBuilder()

public static ReasoningEngineSpec.DeploymentSpec.Builder newBuilder()
Returns
Type Description
ReasoningEngineSpec.DeploymentSpec.Builder

newBuilder(ReasoningEngineSpec.DeploymentSpec prototype)

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

parseDelimitedFrom(InputStream input)

public static ReasoningEngineSpec.DeploymentSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ReasoningEngineSpec.DeploymentSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static ReasoningEngineSpec.DeploymentSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ReasoningEngineSpec.DeploymentSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static ReasoningEngineSpec.DeploymentSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ReasoningEngineSpec.DeploymentSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static ReasoningEngineSpec.DeploymentSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ReasoningEngineSpec.DeploymentSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static ReasoningEngineSpec.DeploymentSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ReasoningEngineSpec.DeploymentSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<ReasoningEngineSpec.DeploymentSpec> parser()
Returns
Type Description
Parser<DeploymentSpec>

Methods

containsResourceLimits(String key)

public boolean containsResourceLimits(String key)

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

map<string, string> resource_limits = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

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

getContainerConcurrency()

public int getContainerConcurrency()

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

optional int32 container_concurrency = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The containerConcurrency.

getDefaultInstanceForType()

public ReasoningEngineSpec.DeploymentSpec getDefaultInstanceForType()
Returns
Type Description
ReasoningEngineSpec.DeploymentSpec

getEnv(int index)

public EnvVar getEnv(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
EnvVar

getEnvCount()

public int getEnvCount()

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

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

Returns
Type Description
int

getEnvList()

public List<EnvVar> getEnvList()

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

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

Returns
Type Description
List<EnvVar>

getEnvOrBuilder(int index)

public EnvVarOrBuilder getEnvOrBuilder(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
EnvVarOrBuilder

getEnvOrBuilderList()

public List<? extends EnvVarOrBuilder> getEnvOrBuilderList()

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

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

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

getMaxInstances()

public int getMaxInstances()

Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100.

optional int32 max_instances = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The maxInstances.

getMinInstances()

public int getMinInstances()

Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1.

optional int32 min_instances = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The minInstances.

getParserForType()

public Parser<ReasoningEngineSpec.DeploymentSpec> getParserForType()
Returns
Type Description
Parser<DeploymentSpec>
Overrides

getPscInterfaceConfig()

public PscInterfaceConfig getPscInterfaceConfig()

Optional. Configuration for PSC-I.

.google.cloud.aiplatform.v1beta1.PscInterfaceConfig psc_interface_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PscInterfaceConfig

The pscInterfaceConfig.

getPscInterfaceConfigOrBuilder()

public PscInterfaceConfigOrBuilder getPscInterfaceConfigOrBuilder()

Optional. Configuration for PSC-I.

.google.cloud.aiplatform.v1beta1.PscInterfaceConfig psc_interface_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PscInterfaceConfigOrBuilder

getResourceLimits() (deprecated)

public Map<String,String> getResourceLimits()
Returns
Type Description
Map<String,String>

getResourceLimitsCount()

public int getResourceLimitsCount()

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

map<string, string> resource_limits = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getResourceLimitsMap()

public Map<String,String> getResourceLimitsMap()

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

map<string, string> resource_limits = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getResourceLimitsOrDefault(String key, String defaultValue)

public String getResourceLimitsOrDefault(String key, String defaultValue)

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

map<string, string> resource_limits = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getResourceLimitsOrThrow(String key)

public String getResourceLimitsOrThrow(String key)

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

map<string, string> resource_limits = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getSecretEnv(int index)

public SecretEnvVar getSecretEnv(int index)

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.

repeated .google.cloud.aiplatform.v1beta1.SecretEnvVar secret_env = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
SecretEnvVar

getSecretEnvCount()

public int getSecretEnvCount()

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.

repeated .google.cloud.aiplatform.v1beta1.SecretEnvVar secret_env = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getSecretEnvList()

public List<SecretEnvVar> getSecretEnvList()

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.

repeated .google.cloud.aiplatform.v1beta1.SecretEnvVar secret_env = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<SecretEnvVar>

getSecretEnvOrBuilder(int index)

public SecretEnvVarOrBuilder getSecretEnvOrBuilder(int index)

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.

repeated .google.cloud.aiplatform.v1beta1.SecretEnvVar secret_env = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
SecretEnvVarOrBuilder

getSecretEnvOrBuilderList()

public List<? extends SecretEnvVarOrBuilder> getSecretEnvOrBuilderList()

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.

repeated .google.cloud.aiplatform.v1beta1.SecretEnvVar secret_env = 2 [(.google.api.field_behavior) = OPTIONAL];

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasContainerConcurrency()

public boolean hasContainerConcurrency()

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

optional int32 container_concurrency = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the containerConcurrency field is set.

hasMaxInstances()

public boolean hasMaxInstances()

Optional. The maximum number of application instances that can be launched to handle increased traffic. Defaults to 100.

optional int32 max_instances = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the maxInstances field is set.

hasMinInstances()

public boolean hasMinInstances()

Optional. The minimum number of application instances that will be kept running at all times. Defaults to 1.

optional int32 min_instances = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the minInstances field is set.

hasPscInterfaceConfig()

public boolean hasPscInterfaceConfig()

Optional. Configuration for PSC-I.

.google.cloud.aiplatform.v1beta1.PscInterfaceConfig psc_interface_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the pscInterfaceConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ReasoningEngineSpec.DeploymentSpec.Builder newBuilderForType()
Returns
Type Description
ReasoningEngineSpec.DeploymentSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public ReasoningEngineSpec.DeploymentSpec.Builder toBuilder()
Returns
Type Description
ReasoningEngineSpec.DeploymentSpec.Builder

writeTo(CodedOutputStream output)

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