Show / Hide Table of Contents

Class SandboxSummary

Sandbox resource representation.

Inheritance
object
SandboxSummary
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.GenerativeaisandboxService.Models
Assembly: OCI.DotNetSDK.Generativeaisandbox.dll
Syntax
public class SandboxSummary

Properties

DisplayName

Declaration
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

Display name for sandbox

ExpirationDuration

Declaration
[JsonProperty(PropertyName = "expirationDuration")]
public string ExpirationDuration { get; set; }
Property Value
Type Description
string

Deprecated. Use expiresInMinutes instead. Existing clients may pass -1 to disable automatic expiration.

ExpiresInMinutes

Declaration
[JsonProperty(PropertyName = "expiresInMinutes")]
public int? ExpiresInMinutes { get; set; }
Property Value
Type Description
int?

Number of minutes from creation until automatic sandbox expiration. Use -1 to disable automatic expiration.

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

Sandbox identifier.

Remarks

Required

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Sandbox.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
Sandbox.LifecycleStateEnum?

The current state of the Sandbox. Allowed values are:

  • RUNNING
  • CREATING
  • UPDATING
  • DELETED
  • FAILED
  • SUSPENDING
  • SUSPENDED
  • RESUMING
  • STOPPING
  • STOPPED
Remarks

Required

ProjectId

Declaration
[JsonProperty(PropertyName = "projectId")]
public string ProjectId { get; set; }
Property Value
Type Description
string

GenerativeAiProject ID that sandbox belongs to

PublishedPortAuthMode

Declaration
[JsonProperty(PropertyName = "publishedPortAuthMode")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Sandbox.PublishedPortAuthModeEnum? PublishedPortAuthMode { get; set; }
Property Value
Type Description
Sandbox.PublishedPortAuthModeEnum?

Persisted published-port authorization mode. Absent for legacy sandboxes.

PublishedPorts

Declaration
[JsonProperty(PropertyName = "publishedPorts")]
public List<PublishedPort> PublishedPorts { get; set; }
Property Value
Type Description
List<PublishedPort>

Published ports for the sandbox proxy endpoint.

Runtime

Declaration
[Required(ErrorMessage = "Runtime is required.")]
[JsonProperty(PropertyName = "runtime")]
public string Runtime { get; set; }
Property Value
Type Description
string

The sandbox runtime type. For customer-provided containers, use a same-region Oracle Cloud Infrastructure Registry image reference.

Remarks

Required

Shape

Declaration
[JsonProperty(PropertyName = "shape")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SandboxSummary.ShapeEnum? Shape { get; set; }
Property Value
Type Description
SandboxSummary.ShapeEnum?

shape for sandbox

TimeCreated

Declaration
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

The date and time the sandbox was created, in RFC 3339 format.

TimeExpires

Declaration
[JsonProperty(PropertyName = "timeExpires")]
public DateTime? TimeExpires { get; set; }
Property Value
Type Description
DateTime?

The date and time the sandbox expires, in RFC 3339 format.

TimeStopped

Declaration
[JsonProperty(PropertyName = "timeStopped")]
public DateTime? TimeStopped { get; set; }
Property Value
Type Description
DateTime?

The date and time the sandbox was stopped or expired, in RFC 3339 format.

TimeUpdated

Declaration
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

The date and time the sandbox was updated, in RFC 3339 format.

WarmpoolName

Declaration
[JsonProperty(PropertyName = "warmpoolName")]
public string WarmpoolName { get; set; }
Property Value
Type Description
string

Name of the source warm pool, when selected explicitly or automatically at creation. The persisted association is retained on retries.

In this article
Back to top