Class SandboxConfig


  • @Generated(value="OracleSDKGenerator",
               comments="API Version: 20231130")
    public final class SandboxConfig
    extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Sandbox configuration under a project.

    Use sandboxOutboundNetworkingConfig to choose whether sandbox outbound traffic originates from an Oracle-managed network or from a customer subnet. The warmPoolConfig field is a read-only projection of reserved MANAGED default-pool capacities. Project create and update requests must omit warmPoolConfig; supplying it, including null or an empty object, is rejected. Newly enabled projects start with zero default-pool capacity. Use the named warm-pool APIs to change capacities or manage CUSTOM pools. On Project Update, omit sandboxConfig to retain the existing configuration. When supplying sandboxConfig, include isEnabled. Sandbox can be enabled after project creation but cannot be disabled after it is enabled. After enablement, isPersistenceEnabled and custom outbound networking cannot change; managed network policy can be updated. Omitted isPersistenceEnabled retains its current value. Credential profiles require unique labels and can be added, removed, or changed on Project Update. Omit credentialProfiles to retain them, or supply the complete desired list; an empty array removes all profiles from the Project. When credentialProfiles is supplied, omitting sandboxOutboundNetworkingConfig retains the current outbound networking configuration. Updates apply to subsequently created Sandboxes after Project configuration propagation. Existing Sandboxes retain their selected profile snapshot, including when that profile is changed or removed from the Project. Updating a secret’s CURRENT version in Vault does not change the Project configuration and remains visible to existing Sandboxes that reference that secret.
    Note: Objects should always be created or deserialized using the SandboxConfig.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the SandboxConfig.Builder, which maintain a set of all explicitly set fields called SandboxConfig.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getIsEnabled

        public Boolean getIsEnabled()
        Indicates whether sandbox config is enabled.
        Returns:
        the value
      • getIsPersistenceEnabled

        public Boolean getIsPersistenceEnabled()
        Indicates whether persistent block volume storage is enabled for sandbox workspaces in this project.

        When omitted, the service-defined default is used.

        Returns:
        the value
      • getCredentialProfiles

        public List<SandboxCredentialProfile> getCredentialProfiles()
        Named credential profiles available for Sandbox creation.

        A Sandbox can explicitly select one profile using credentialProfileLabel; omitting that selector selects none. On Project Update, omission retains existing profiles and a supplied list replaces the complete list. An empty array removes all profiles from the Project. Adding, removing, or changing profiles affects subsequently created Sandboxes after configuration propagation. Existing Sandboxes retain their selected configuration snapshot.

        Returns:
        the value
      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation
      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel