Package com.google.cloud.aiplatform.v1

Class ReasoningEngineSpec.DeploymentSpec

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.ReasoningEngineSpec.DeploymentSpec
All Implemented Interfaces:
ReasoningEngineSpec.DeploymentSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
ReasoningEngineSpec
public static final class ReasoningEngineSpec.DeploymentSpec extends com.google.protobuf.GeneratedMessage implements ReasoningEngineSpec.DeploymentSpecOrBuilder
 The specification of a Reasoning Engine deployment.
Protobuf type google.cloud.aiplatform.v1.ReasoningEngineSpec.DeploymentSpec
See Also:

  • Field Details

    • ENV_FIELD_NUMBER

      public static final int ENV_FIELD_NUMBER
      See Also:

    • SECRET_ENV_FIELD_NUMBER

      public static final int SECRET_ENV_FIELD_NUMBER
      See Also:

    • PSC_INTERFACE_CONFIG_FIELD_NUMBER

      public static final int PSC_INTERFACE_CONFIG_FIELD_NUMBER
      See Also:

    • MIN_INSTANCES_FIELD_NUMBER

      public static final int MIN_INSTANCES_FIELD_NUMBER
      See Also:

    • MAX_INSTANCES_FIELD_NUMBER

      public static final int MAX_INSTANCES_FIELD_NUMBER
      See Also:

    • RESOURCE_LIMITS_FIELD_NUMBER

      public static final int RESOURCE_LIMITS_FIELD_NUMBER
      See Also:

    • CONTAINER_CONCURRENCY_FIELD_NUMBER

      public static final int CONTAINER_CONCURRENCY_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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.v1.EnvVar env = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEnvList in interface ReasoningEngineSpec.DeploymentSpecOrBuilder

    • 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.v1.EnvVar env = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEnvOrBuilderList in interface ReasoningEngineSpec.DeploymentSpecOrBuilder

    • 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.v1.EnvVar env = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEnvCount in interface ReasoningEngineSpec.DeploymentSpecOrBuilder

    • getEnv

      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.v1.EnvVar env = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEnv in interface ReasoningEngineSpec.DeploymentSpecOrBuilder

    • getEnvOrBuilder

      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.v1.EnvVar env = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEnvOrBuilder in interface ReasoningEngineSpec.DeploymentSpecOrBuilder

    • 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.v1.SecretEnvVar secret_env = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSecretEnvList in interface ReasoningEngineSpec.DeploymentSpecOrBuilder

    • 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.v1.SecretEnvVar secret_env = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSecretEnvOrBuilderList in interface ReasoningEngineSpec.DeploymentSpecOrBuilder

    • 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.v1.SecretEnvVar secret_env = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSecretEnvCount in interface ReasoningEngineSpec.DeploymentSpecOrBuilder

    • getSecretEnv

      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.v1.SecretEnvVar secret_env = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSecretEnv in interface ReasoningEngineSpec.DeploymentSpecOrBuilder

    • getSecretEnvOrBuilder

      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.v1.SecretEnvVar secret_env = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSecretEnvOrBuilder in interface ReasoningEngineSpec.DeploymentSpecOrBuilder

    • hasPscInterfaceConfig

      public boolean hasPscInterfaceConfig()
       Optional. Configuration for PSC-I.
      .google.cloud.aiplatform.v1.PscInterfaceConfig psc_interface_config = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasPscInterfaceConfig in interface ReasoningEngineSpec.DeploymentSpecOrBuilder
      Returns:
      Whether the pscInterfaceConfig field is set.

    • getPscInterfaceConfig

      public PscInterfaceConfig getPscInterfaceConfig()
       Optional. Configuration for PSC-I.
      .google.cloud.aiplatform.v1.PscInterfaceConfig psc_interface_config = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPscInterfaceConfig in interface ReasoningEngineSpec.DeploymentSpecOrBuilder
      Returns:
      The pscInterfaceConfig.

    • getPscInterfaceConfigOrBuilder

      public PscInterfaceConfigOrBuilder getPscInterfaceConfigOrBuilder()
       Optional. Configuration for PSC-I.
      .google.cloud.aiplatform.v1.PscInterfaceConfig psc_interface_config = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPscInterfaceConfigOrBuilder in interface ReasoningEngineSpec.DeploymentSpecOrBuilder

    • hasMinInstances

      public boolean hasMinInstances()
       Optional. The minimum number of application instances that will be kept
 running at all times. Defaults to 1. Range: [0, 10].
      optional int32 min_instances = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasMinInstances in interface ReasoningEngineSpec.DeploymentSpecOrBuilder
      Returns:
      Whether the minInstances field is set.

    • getMinInstances

      public int getMinInstances()
       Optional. The minimum number of application instances that will be kept
 running at all times. Defaults to 1. Range: [0, 10].
      optional int32 min_instances = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMinInstances in interface ReasoningEngineSpec.DeploymentSpecOrBuilder
      Returns:
      The minInstances.

    • hasMaxInstances

      public boolean hasMaxInstances()
       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].
      optional int32 max_instances = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasMaxInstances in interface ReasoningEngineSpec.DeploymentSpecOrBuilder
      Returns:
      Whether the maxInstances field is set.

    • getMaxInstances

      public int 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].
      optional int32 max_instances = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMaxInstances in interface ReasoningEngineSpec.DeploymentSpecOrBuilder
      Returns:
      The maxInstances.

    • getResourceLimitsCount

      public int getResourceLimitsCount()
      Description copied from interface: ReasoningEngineSpec.DeploymentSpecOrBuilder
       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
      map<string, string> resource_limits = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getResourceLimitsCount in interface ReasoningEngineSpec.DeploymentSpecOrBuilder

    • containsResourceLimits

      public boolean containsResourceLimits(String key)
       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
      map<string, string> resource_limits = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsResourceLimits in interface ReasoningEngineSpec.DeploymentSpecOrBuilder

    • getResourceLimits

      @Deprecated public Map<String,String> getResourceLimits()
      Deprecated.
      Use getResourceLimitsMap() instead.
      Specified by:
      getResourceLimits in interface ReasoningEngineSpec.DeploymentSpecOrBuilder

    • 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"}.

 * 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
      map<string, string> resource_limits = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getResourceLimitsMap in interface ReasoningEngineSpec.DeploymentSpecOrBuilder

    • getResourceLimitsOrDefault

      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"}.

 * 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
      map<string, string> resource_limits = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getResourceLimitsOrDefault in interface ReasoningEngineSpec.DeploymentSpecOrBuilder

    • getResourceLimitsOrThrow

      public String getResourceLimitsOrThrow(String key)
       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
      map<string, string> resource_limits = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getResourceLimitsOrThrow in interface ReasoningEngineSpec.DeploymentSpecOrBuilder

    • 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];
      Specified by:
      hasContainerConcurrency in interface ReasoningEngineSpec.DeploymentSpecOrBuilder
      Returns:
      Whether the containerConcurrency field is set.

    • 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];
      Specified by:
      getContainerConcurrency in interface ReasoningEngineSpec.DeploymentSpecOrBuilder
      Returns:
      The containerConcurrency.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ReasoningEngineSpec.DeploymentSpec parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ReasoningEngineSpec.DeploymentSpec parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ReasoningEngineSpec.DeploymentSpec parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ReasoningEngineSpec.DeploymentSpec parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ReasoningEngineSpec.DeploymentSpec parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ReasoningEngineSpec.DeploymentSpec parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ReasoningEngineSpec.DeploymentSpec parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ReasoningEngineSpec.DeploymentSpec parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ReasoningEngineSpec.DeploymentSpec parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ReasoningEngineSpec.DeploymentSpec parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ReasoningEngineSpec.DeploymentSpec parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ReasoningEngineSpec.DeploymentSpec parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ReasoningEngineSpec.DeploymentSpec.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ReasoningEngineSpec.DeploymentSpec.Builder newBuilder()

    • newBuilder

      public static ReasoningEngineSpec.DeploymentSpec.Builder newBuilder(ReasoningEngineSpec.DeploymentSpec prototype)

    • toBuilder

      public ReasoningEngineSpec.DeploymentSpec.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ReasoningEngineSpec.DeploymentSpec.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ReasoningEngineSpec.DeploymentSpec getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ReasoningEngineSpec.DeploymentSpec> parser()

    • getParserForType

      public com.google.protobuf.Parser<ReasoningEngineSpec.DeploymentSpec> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public ReasoningEngineSpec.DeploymentSpec getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder