Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SandboxEnvironment

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1/classes.rb,
lib/google/apis/aiplatform_v1/representations.rb,
lib/google/apis/aiplatform_v1/representations.rb

Overview

SandboxEnvironment is a containerized environment that provides a customizable secure execution runtime for AI agents.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1SandboxEnvironment

Returns a new instance of GoogleCloudAiplatformV1SandboxEnvironment.



34347
34348
34349
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 34347

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#connection_info ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SandboxEnvironmentConnectionInfo

The connection information of the SandboxEnvironment. Corresponds to the JSON property connectionInfo

Returns:



34273
34274
34275
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 34273

def connection_info
  @connection_info
end

#create_time ⇒ String

Output only. The timestamp when this SandboxEnvironment was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


34278
34279
34280
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 34278

def create_time
  @create_time
end

#display_name ⇒ String

Required. The display name of the SandboxEnvironment. Corresponds to the JSON property displayName

Returns:

  • (String) 


34283
34284
34285
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 34283

def display_name
  @display_name
end

#expire_time ⇒ String

Optional. Timestamp in UTC of when this SandboxEnvironment is considered expired. This is always provided on output, regardless of what expiration was sent on input. Corresponds to the JSON property expireTime

Returns:

  • (String) 


34290
34291
34292
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 34290

def expire_time
  @expire_time
end

#latest_sandbox_environment_snapshot ⇒ String

Output only. The resource name of the latest snapshot taken for this SandboxEnvironment. Corresponds to the JSON property latestSandboxEnvironmentSnapshot

Returns:

  • (String) 


34296
34297
34298
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 34296

def latest_sandbox_environment_snapshot
  @latest_sandbox_environment_snapshot
end

#name ⇒ String

Identifier. The name of the SandboxEnvironment. Corresponds to the JSON property name

Returns:

  • (String) 


34301
34302
34303
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 34301

def name
  @name
end

#owner ⇒ String

Optional. Owner information for this sandbox environment. A Sandbox can only be restored from a snapshot that belongs to the same owner. If not set, sandbox will be created as the default owner. Corresponds to the JSON property owner

Returns:

  • (String) 


34308
34309
34310
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 34308

def owner
  @owner
end

#sandbox_environment_snapshot ⇒ String

Optional. The resource name of the SandboxEnvironmentSnapshot to use for creating this SandboxEnvironment. Format: projects/project/locations/ location/reasoningEngines/reasoning_engine/sandboxEnvironmentSnapshots/ sandbox_environment_snapshot` Corresponds to the JSON propertysandboxEnvironmentSnapshot`

Returns:

  • (String) 


34316
34317
34318
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 34316

def sandbox_environment_snapshot
  @sandbox_environment_snapshot
end

#sandbox_environment_template ⇒ String

Optional. The name of the SandboxEnvironmentTemplate specified in the parent Agent Engine resource that this SandboxEnvironment is created from. Only one of sandbox_environment_template and spec should be set. Corresponds to the JSON property sandboxEnvironmentTemplate

Returns:

  • (String) 


34323
34324
34325
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 34323

def sandbox_environment_template
  @sandbox_environment_template
end

#spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SandboxEnvironmentSpec

The specification of a SandboxEnvironment. Corresponds to the JSON property spec

Returns:



34328
34329
34330
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 34328

def spec
  @spec
end

#state ⇒ String

Output only. The runtime state of the SandboxEnvironment. Corresponds to the JSON property state

Returns:

  • (String) 


34333
34334
34335
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 34333

def state
  @state
end

#ttl ⇒ String

Optional. Input only. The TTL for the sandbox environment. The expiration time is computed: now + TTL. Corresponds to the JSON property ttl

Returns:

  • (String) 


34339
34340
34341
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 34339

def ttl
  @ttl
end

#update_time ⇒ String

Output only. The timestamp when this SandboxEnvironment was most recently updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


34345
34346
34347
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 34345

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



34352
34353
34354
34355
34356
34357
34358
34359
34360
34361
34362
34363
34364
34365
34366
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 34352

def update!(**args)
  @connection_info = args[:connection_info] if args.key?(:connection_info)
  @create_time = args[:create_time] if args.key?(:create_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @expire_time = args[:expire_time] if args.key?(:expire_time)
  @latest_sandbox_environment_snapshot = args[:latest_sandbox_environment_snapshot] if args.key?(:latest_sandbox_environment_snapshot)
  @name = args[:name] if args.key?(:name)
  @owner = args[:owner] if args.key?(:owner)
  @sandbox_environment_snapshot = args[:sandbox_environment_snapshot] if args.key?(:sandbox_environment_snapshot)
  @sandbox_environment_template = args[:sandbox_environment_template] if args.key?(:sandbox_environment_template)
  @spec = args[:spec] if args.key?(:spec)
  @state = args[:state] if args.key?(:state)
  @ttl = args[:ttl] if args.key?(:ttl)
  @update_time = args[:update_time] if args.key?(:update_time)
end