func GetCancelSandboxCommandDetailsSignalEnumStringValues() []string
GetCancelSandboxCommandDetailsSignalEnumStringValues Enumerates the set of values in String for CancelSandboxCommandDetailsSignalEnum
func GetListSandboxCommandSortByEnumStringValues() []string
GetListSandboxCommandSortByEnumStringValues Enumerates the set of values in String for ListSandboxCommandSortByEnum
func GetListSandboxCommandSortOrderEnumStringValues() []string
GetListSandboxCommandSortOrderEnumStringValues Enumerates the set of values in String for ListSandboxCommandSortOrderEnum
func GetListSandboxSnapshotsSortByEnumStringValues() []string
GetListSandboxSnapshotsSortByEnumStringValues Enumerates the set of values in String for ListSandboxSnapshotsSortByEnum
func GetListSandboxSnapshotsSortOrderEnumStringValues() []string
GetListSandboxSnapshotsSortOrderEnumStringValues Enumerates the set of values in String for ListSandboxSnapshotsSortOrderEnum
func GetListSandboxesSortByEnumStringValues() []string
GetListSandboxesSortByEnumStringValues Enumerates the set of values in String for ListSandboxesSortByEnum
func GetListSandboxesSortOrderEnumStringValues() []string
GetListSandboxesSortOrderEnumStringValues Enumerates the set of values in String for ListSandboxesSortOrderEnum
func GetSandboxCommandEventEventEnumStringValues() []string
GetSandboxCommandEventEventEnumStringValues Enumerates the set of values in String for SandboxCommandEventEventEnum
func GetSandboxLifecycleStateEnumStringValues() []string
GetSandboxLifecycleStateEnumStringValues Enumerates the set of values in String for SandboxLifecycleStateEnum
func GetSandboxPublishedPortAuthModeEnumStringValues() []string
GetSandboxPublishedPortAuthModeEnumStringValues Enumerates the set of values in String for SandboxPublishedPortAuthModeEnum
func GetSandboxShapeEnumStringValues() []string
GetSandboxShapeEnumStringValues Enumerates the set of values in String for SandboxShapeEnum
func GetSandboxSnapshotLifecycleStateEnumStringValues() []string
GetSandboxSnapshotLifecycleStateEnumStringValues Enumerates the set of values in String for SandboxSnapshotLifecycleStateEnum
func GetSandboxSourceSourceTypeEnumStringValues() []string
GetSandboxSourceSourceTypeEnumStringValues Enumerates the set of values in String for SandboxSourceSourceTypeEnum
func GetSandboxSummaryShapeEnumStringValues() []string
GetSandboxSummaryShapeEnumStringValues Enumerates the set of values in String for SandboxSummaryShapeEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
CancelSandboxCommandDetails Request body used to cancel a sandbox command.
type CancelSandboxCommandDetails struct {
// Signal to send to the running command.
Signal CancelSandboxCommandDetailsSignalEnum `mandatory:"false" json:"signal,omitempty"`
}
func (m CancelSandboxCommandDetails) String() string
func (m CancelSandboxCommandDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CancelSandboxCommandDetailsSignalEnum Enum with underlying type: string
type CancelSandboxCommandDetailsSignalEnum string
Set of constants representing the allowable values for CancelSandboxCommandDetailsSignalEnum
const (
CancelSandboxCommandDetailsSignalSigterm CancelSandboxCommandDetailsSignalEnum = "SIGTERM"
CancelSandboxCommandDetailsSignalSigkill CancelSandboxCommandDetailsSignalEnum = "SIGKILL"
)
func GetCancelSandboxCommandDetailsSignalEnumValues() []CancelSandboxCommandDetailsSignalEnum
GetCancelSandboxCommandDetailsSignalEnumValues Enumerates the set of values for CancelSandboxCommandDetailsSignalEnum
func GetMappingCancelSandboxCommandDetailsSignalEnum(val string) (CancelSandboxCommandDetailsSignalEnum, bool)
GetMappingCancelSandboxCommandDetailsSignalEnum performs case Insensitive comparison on enum value and return the desired enum
CancelSandboxCommandRequest wrapper for the CancelSandboxCommand operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/CancelSandboxCommand.go.html to see an example of how to use CancelSandboxCommandRequest.
type CancelSandboxCommandRequest struct {
// Sandbox identifier. Newly generated Sandbox IDs use `sbx-` followed by 16 lowercase base32 characters (`a-z2-7`); existing legacy IDs remain accepted.
SandboxId *string `mandatory:"true" contributesTo:"path" name:"sandboxId"`
// Sandbox command identifier.
CommandId *string `mandatory:"true" contributesTo:"path" name:"commandId"`
// Request payload for canceling a sandbox command.
CancelSandboxCommandDetails `contributesTo:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CancelSandboxCommandRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelSandboxCommandRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelSandboxCommandRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelSandboxCommandRequest) String() string
func (request CancelSandboxCommandRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CancelSandboxCommandResponse wrapper for the CancelSandboxCommand operation
type CancelSandboxCommandResponse struct {
// The underlying http response
RawResponse *http.Response
// The SandboxCommand instance
SandboxCommand `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CancelSandboxCommandResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelSandboxCommandResponse) String() string
CreateSandboxDetails Request body used to create a sandbox.
type CreateSandboxDetails struct {
// Name of a MANAGED or CUSTOM warm pool in the owning project. Runtime and shape
// are derived from the pool; explicit values must match. Deleting pools cannot be used.
// Snapshot restore, credential brokerage, and nested resource principals are not
// supported with named pools. An empty pool may cold-create using its same template,
// including when desired capacity is zero. Zero capacity stops idle prewarming;
// it does not prevent creation from an available applied template.
// When warmpoolName is omitted, a built-in runtime can automatically select an eligible
// named MANAGED pool in the same project matching its runtime and shape. Omitted runtime
// defaults to python-3.11 and omitted shape defaults to SMALL for automatic matching.
// A digest-pinned customer image can automatically select an eligible CUSTOM pool in the
// same project matching its canonical registry host, repository, digest and shape.
// Tag-based customer images are not automatically matched. Matching pools are considered
// in name order; the first with a valid applied template is selected without reading ready counts.
// Empty pools and zero desired or applied capacity still allow cold creation through
// the selected template. If no eligible pool is found or automatic lookup is unavailable,
// built-in runtimes use the existing managed runtime path, and customer images use the
// ordinary direct customer-image path with its existing validation.
// Automatic matching does not apply when source is supplied, including snapshot restore,
// or when credential brokerage or nested resource principals are used. Explicit names
// retain strict validation and do not fall back to automatic matching or another creation path.
// Retries preserve the original persisted pool binding or the original managed or direct
// customer-image route, even when matching pools change.
// Sandbox and SandboxSummary report an automatically selected pool in warmpoolName.
WarmpoolName *string `mandatory:"false" json:"warmpoolName"`
Source SandboxSource `mandatory:"false" json:"source"`
// User-provided display name for the sandbox.
DisplayName *string `mandatory:"false" json:"displayName"`
// Runtime identifier for the sandbox, either a built-in runtime such as python-3.11 or a same-region Oracle Cloud Infrastructure Registry customer image reference.
Runtime *string `mandatory:"false" json:"runtime"`
// Compute shape for the sandbox.
Shape SandboxShapeEnum `mandatory:"false" json:"shape,omitempty"`
// Authorization for all published-port HTTP requests and WebSocket handshakes.
// OCI_IAM requires Sandbox use and project read permission on the owning project.
// Omission defaults to OCI_IAM for new sandboxes with published ports in enabled
// tenancies; elsewhere omission retains legacy behavior. Explicit OCI_IAM outside
// the rollout, null, unsupported values, or a mode without published ports are rejected.
// The effective mode is immutable and is preserved when restoring protected snapshots.
PublishedPortAuthMode SandboxPublishedPortAuthModeEnum `mandatory:"false" json:"publishedPortAuthMode,omitempty"`
// Published ports to expose for the sandbox.
PublishPorts []string `mandatory:"false" json:"publishPorts"`
// Number of minutes from creation until automatic sandbox expiration. Use `-1` to disable automatic expiration.
ExpiresInMinutes *int `mandatory:"false" json:"expiresInMinutes"`
// Deprecated. Use `expiresInMinutes` instead. Existing clients may pass `-1` to disable automatic expiration.
ExpirationDuration *string `mandatory:"false" json:"expirationDuration"`
// Environment variables to inject into the sandbox runtime.
EnvironmentVariables []EnvironmentVariable `mandatory:"false" json:"environmentVariables"`
// The Project credential profile selected for this Sandbox. Omit this field to select
// no credential profile. The selection and its configuration snapshot are immutable for
// the lifetime of the Sandbox; later Project profile updates apply only to subsequently
// created Sandboxes after configuration propagation.
CredentialProfileLabel *string `mandatory:"false" json:"credentialProfileLabel"`
}
func (m CreateSandboxDetails) String() string
func (m *CreateSandboxDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateSandboxDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateSandboxRequest wrapper for the CreateSandbox operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/CreateSandbox.go.html to see an example of how to use CreateSandboxRequest.
type CreateSandboxRequest struct {
// Required project identifier used to scope sandbox creation.
ProjectId *string `mandatory:"true" contributesTo:"header" name:"project-id"`
// Request payload for sandbox creation.
CreateSandboxDetails `contributesTo:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateSandboxRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateSandboxRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateSandboxRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateSandboxRequest) String() string
func (request CreateSandboxRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateSandboxResponse wrapper for the CreateSandbox operation
type CreateSandboxResponse struct {
// The underlying http response
RawResponse *http.Response
// The Sandbox instance
Sandbox `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateSandboxResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateSandboxResponse) String() string
CreateSandboxSnapshotDetails Request body used to create a sandbox snapshot.
type CreateSandboxSnapshotDetails struct {
// Identifier of the sandbox to snapshot.
SandboxId *string `mandatory:"true" json:"sandboxId"`
// Duration after creation before the sandbox snapshot expires, in ISO 8601 duration format. For example, `P7D` for 7 days or `PT24H` for 24 hours.
ExpirationDuration *string `mandatory:"false" json:"expirationDuration"`
}
func (m CreateSandboxSnapshotDetails) String() string
func (m CreateSandboxSnapshotDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateSandboxSnapshotRequest wrapper for the CreateSandboxSnapshot operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/CreateSandboxSnapshot.go.html to see an example of how to use CreateSandboxSnapshotRequest.
type CreateSandboxSnapshotRequest struct {
// Request payload for sandbox snapshot creation.
CreateSandboxSnapshotDetails `contributesTo:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateSandboxSnapshotRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateSandboxSnapshotRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateSandboxSnapshotRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateSandboxSnapshotRequest) String() string
func (request CreateSandboxSnapshotRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateSandboxSnapshotResponse wrapper for the CreateSandboxSnapshot operation
type CreateSandboxSnapshotResponse struct {
// The underlying http response
RawResponse *http.Response
// The SandboxSnapshot instance
SandboxSnapshot `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateSandboxSnapshotResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateSandboxSnapshotResponse) String() string
DeleteSandboxRequest wrapper for the DeleteSandbox operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/DeleteSandbox.go.html to see an example of how to use DeleteSandboxRequest.
type DeleteSandboxRequest struct {
// Sandbox identifier. Newly generated Sandbox IDs use `sbx-` followed by 16 lowercase base32 characters (`a-z2-7`); existing legacy IDs remain accepted.
SandboxId *string `mandatory:"true" contributesTo:"path" name:"sandboxId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource,
// set the `if-match` parameter to the value of the etag from a previous GET or
// POST response for that resource. The resource is updated or deleted only if
// the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteSandboxRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteSandboxRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteSandboxRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteSandboxRequest) String() string
func (request DeleteSandboxRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteSandboxResponse wrapper for the DeleteSandbox operation
type DeleteSandboxResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteSandboxResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteSandboxResponse) String() string
DeleteSandboxSnapshotRequest wrapper for the DeleteSandboxSnapshot operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/DeleteSandboxSnapshot.go.html to see an example of how to use DeleteSandboxSnapshotRequest.
type DeleteSandboxSnapshotRequest struct {
// Sandbox snapshot identifier.
SnapshotId *string `mandatory:"true" contributesTo:"path" name:"snapshotId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource,
// set the `if-match` parameter to the value of the etag from a previous GET or
// POST response for that resource. The resource is updated or deleted only if
// the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteSandboxSnapshotRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteSandboxSnapshotRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteSandboxSnapshotRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteSandboxSnapshotRequest) String() string
func (request DeleteSandboxSnapshotRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteSandboxSnapshotResponse wrapper for the DeleteSandboxSnapshot operation
type DeleteSandboxSnapshotResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteSandboxSnapshotResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteSandboxSnapshotResponse) String() string
EnvironmentVariable The environment variables for the Sandbox
type EnvironmentVariable struct {
// Name of the environment variable.
Name *string `mandatory:"true" json:"name"`
// Value of the environment variable.
Value *interface{} `mandatory:"true" json:"value"`
}
func (m EnvironmentVariable) String() string
func (m EnvironmentVariable) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ErrorResponse Error information.
type ErrorResponse struct {
// A short error code that defines the error, meant for programmatic parsing.
Code *string `mandatory:"true" json:"code"`
// A human-readable error message.
Message *string `mandatory:"true" json:"message"`
}
func (m ErrorResponse) String() string
func (m ErrorResponse) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ExtendSandboxDetails Request body used to extend a sandbox's duration.
type ExtendSandboxDetails struct {
// Additional duration to extend the sandbox lifetime, in ISO 8601 duration format.
AdditionalDuration *string `mandatory:"true" json:"additionalDuration"`
}
func (m ExtendSandboxDetails) String() string
func (m ExtendSandboxDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ExtendSandboxRequest wrapper for the ExtendSandbox operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/ExtendSandbox.go.html to see an example of how to use ExtendSandboxRequest.
type ExtendSandboxRequest struct {
// Sandbox identifier. Newly generated Sandbox IDs use `sbx-` followed by 16 lowercase base32 characters (`a-z2-7`); existing legacy IDs remain accepted.
SandboxId *string `mandatory:"true" contributesTo:"path" name:"sandboxId"`
// Request payload for extending a sandbox.
ExtendSandboxDetails `contributesTo:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource,
// set the `if-match` parameter to the value of the etag from a previous GET or
// POST response for that resource. The resource is updated or deleted only if
// the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ExtendSandboxRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ExtendSandboxRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ExtendSandboxRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ExtendSandboxRequest) String() string
func (request ExtendSandboxRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ExtendSandboxResponse wrapper for the ExtendSandbox operation
type ExtendSandboxResponse struct {
// The underlying http response
RawResponse *http.Response
// The Sandbox instance
Sandbox `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ExtendSandboxResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ExtendSandboxResponse) String() string
GenerativeAiSandboxClient a client for GenerativeAiSandbox
type GenerativeAiSandboxClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewGenerativeAiSandboxClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client GenerativeAiSandboxClient, err error)
NewGenerativeAiSandboxClientWithConfigurationProvider Creates a new default GenerativeAiSandbox client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewGenerativeAiSandboxClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client GenerativeAiSandboxClient, err error)
NewGenerativeAiSandboxClientWithOboToken Creates a new default GenerativeAiSandbox client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client GenerativeAiSandboxClient) CancelSandboxCommand(ctx context.Context, request CancelSandboxCommandRequest) (response CancelSandboxCommandResponse, err error)
CancelSandboxCommand Requests cancellation of a running sandbox command.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/CancelSandboxCommand.go.html to see an example of how to use CancelSandboxCommand API. A default retry strategy applies to this operation CancelSandboxCommand()
func (client *GenerativeAiSandboxClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client GenerativeAiSandboxClient) CreateSandbox(ctx context.Context, request CreateSandboxRequest) (response CreateSandboxResponse, err error)
CreateSandbox Creates a sandbox resource and returns its initial state.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/CreateSandbox.go.html to see an example of how to use CreateSandbox API. A default retry strategy applies to this operation CreateSandbox()
func (client GenerativeAiSandboxClient) CreateSandboxSnapshot(ctx context.Context, request CreateSandboxSnapshotRequest) (response CreateSandboxSnapshotResponse, err error)
CreateSandboxSnapshot Creates a sandbox snapshot resource and returns its initial state.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/CreateSandboxSnapshot.go.html to see an example of how to use CreateSandboxSnapshot API. A default retry strategy applies to this operation CreateSandboxSnapshot()
func (client GenerativeAiSandboxClient) DeleteSandbox(ctx context.Context, request DeleteSandboxRequest) (response DeleteSandboxResponse, err error)
DeleteSandbox Deletes a sandbox.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/DeleteSandbox.go.html to see an example of how to use DeleteSandbox API. A default retry strategy applies to this operation DeleteSandbox()
func (client GenerativeAiSandboxClient) DeleteSandboxSnapshot(ctx context.Context, request DeleteSandboxSnapshotRequest) (response DeleteSandboxSnapshotResponse, err error)
DeleteSandboxSnapshot Deletes a sandbox snapshot.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/DeleteSandboxSnapshot.go.html to see an example of how to use DeleteSandboxSnapshot API. A default retry strategy applies to this operation DeleteSandboxSnapshot()
func (client GenerativeAiSandboxClient) ExtendSandbox(ctx context.Context, request ExtendSandboxRequest) (response ExtendSandboxResponse, err error)
ExtendSandbox Extends the duration of a sandbox.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/ExtendSandbox.go.html to see an example of how to use ExtendSandbox API. A default retry strategy applies to this operation ExtendSandbox()
func (client GenerativeAiSandboxClient) GetSandbox(ctx context.Context, request GetSandboxRequest) (response GetSandboxResponse, err error)
GetSandbox Gets information about a sandbox.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/GetSandbox.go.html to see an example of how to use GetSandbox API. A default retry strategy applies to this operation GetSandbox()
func (client GenerativeAiSandboxClient) GetSandboxCommand(ctx context.Context, request GetSandboxCommandRequest) (response GetSandboxCommandResponse, err error)
GetSandboxCommand Gets command metadata for a sandbox command.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/GetSandboxCommand.go.html to see an example of how to use GetSandboxCommand API. A default retry strategy applies to this operation GetSandboxCommand()
func (client GenerativeAiSandboxClient) GetSandboxCommandOutput(ctx context.Context, request GetSandboxCommandOutputRequest) (response GetSandboxCommandOutputResponse, err error)
GetSandboxCommandOutput Gets captured output for a sandbox command starting from the requested event sequence.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/GetSandboxCommandOutput.go.html to see an example of how to use GetSandboxCommandOutput API. A default retry strategy applies to this operation GetSandboxCommandOutput()
func (client GenerativeAiSandboxClient) GetSandboxSnapshot(ctx context.Context, request GetSandboxSnapshotRequest) (response GetSandboxSnapshotResponse, err error)
GetSandboxSnapshot Gets information about a sandbox snapshot.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/GetSandboxSnapshot.go.html to see an example of how to use GetSandboxSnapshot API. A default retry strategy applies to this operation GetSandboxSnapshot()
func (client GenerativeAiSandboxClient) ListSandboxCommand(ctx context.Context, request ListSandboxCommandRequest) (response ListSandboxCommandResponse, err error)
ListSandboxCommand Lists sandbox commands for a sandbox with optional pagination.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/ListSandboxCommand.go.html to see an example of how to use ListSandboxCommand API. A default retry strategy applies to this operation ListSandboxCommand()
func (client GenerativeAiSandboxClient) ListSandboxSnapshots(ctx context.Context, request ListSandboxSnapshotsRequest) (response ListSandboxSnapshotsResponse, err error)
ListSandboxSnapshots Lists sandbox snapshot resources with optional filtering and pagination.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/ListSandboxSnapshots.go.html to see an example of how to use ListSandboxSnapshots API. A default retry strategy applies to this operation ListSandboxSnapshots()
func (client GenerativeAiSandboxClient) ListSandboxes(ctx context.Context, request ListSandboxesRequest) (response ListSandboxesResponse, err error)
ListSandboxes Lists sandbox resources with optional filtering and pagination. Specify exactly one of `projectId` or `compartmentId`. A compartment-scoped request returns sandboxes from Generative AI projects directly contained in that compartment; child compartments are not included.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/ListSandboxes.go.html to see an example of how to use ListSandboxes API. A default retry strategy applies to this operation ListSandboxes()
func (client GenerativeAiSandboxClient) ReadSandboxFile(ctx context.Context, request ReadSandboxFileRequest) (response ReadSandboxFileResponse, err error)
ReadSandboxFile Reads a file from a sandbox.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/ReadSandboxFile.go.html to see an example of how to use ReadSandboxFile API. A default retry strategy applies to this operation ReadSandboxFile()
func (client GenerativeAiSandboxClient) ResumeSandbox(ctx context.Context, request ResumeSandboxRequest) (response ResumeSandboxResponse, err error)
ResumeSandbox Resumes a suspended sandbox by scaling its backing runtime back to one replica.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/ResumeSandbox.go.html to see an example of how to use ResumeSandbox API. A default retry strategy applies to this operation ResumeSandbox()
func (client GenerativeAiSandboxClient) RunSandboxCommand(ctx context.Context, request RunSandboxCommandRequest) (response RunSandboxCommandResponse, err error)
RunSandboxCommand Runs a command in a sandbox and returns the command identifier immediately.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/RunSandboxCommand.go.html to see an example of how to use RunSandboxCommand API. A default retry strategy applies to this operation RunSandboxCommand()
func (client GenerativeAiSandboxClient) RunSandboxCommandAndStream(ctx context.Context, request RunSandboxCommandAndStreamRequest) (response RunSandboxCommandAndStreamResponse, err error)
RunSandboxCommandAndStream Runs a command in a sandbox and streams command events as newline-delimited JSON. Each line is a serialized SandboxCommandEvent.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/RunSandboxCommandAndStream.go.html to see an example of how to use RunSandboxCommandAndStream API. A default retry strategy applies to this operation RunSandboxCommandAndStream()
func (client GenerativeAiSandboxClient) RunSandboxCommandAndWait(ctx context.Context, request RunSandboxCommandAndWaitRequest) (response RunSandboxCommandAndWaitResponse, err error)
RunSandboxCommandAndWait Runs a command in a sandbox, blocks until command execution finishes, and returns the final command metadata.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/RunSandboxCommandAndWait.go.html to see an example of how to use RunSandboxCommandAndWait API. A default retry strategy applies to this operation RunSandboxCommandAndWait()
func (client *GenerativeAiSandboxClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client GenerativeAiSandboxClient) StopSandbox(ctx context.Context, request StopSandboxRequest) (response StopSandboxResponse, err error)
StopSandbox Stops a running sandbox.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/StopSandbox.go.html to see an example of how to use StopSandbox API. A default retry strategy applies to this operation StopSandbox()
func (client GenerativeAiSandboxClient) StreamSandboxCommandEvents(ctx context.Context, request StreamSandboxCommandEventsRequest) (response StreamSandboxCommandEventsResponse, err error)
StreamSandboxCommandEvents Streams command events for an existing sandbox command from `fromSeq` through `untilSeq` using Server-Sent Events. Each SSE `data` field contains a serialized SandboxCommandEvent.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/StreamSandboxCommandEvents.go.html to see an example of how to use StreamSandboxCommandEvents API. A default retry strategy applies to this operation StreamSandboxCommandEvents()
func (client GenerativeAiSandboxClient) SuspendSandbox(ctx context.Context, request SuspendSandboxRequest) (response SuspendSandboxResponse, err error)
SuspendSandbox Suspends a running sandbox by scaling its backing runtime to zero replicas while retaining the workspace block volume.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/SuspendSandbox.go.html to see an example of how to use SuspendSandbox API. A default retry strategy applies to this operation SuspendSandbox()
func (client GenerativeAiSandboxClient) UpdateSandbox(ctx context.Context, request UpdateSandboxRequest) (response UpdateSandboxResponse, err error)
UpdateSandbox Updates a sandbox.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/UpdateSandbox.go.html to see an example of how to use UpdateSandbox API. A default retry strategy applies to this operation UpdateSandbox()
func (client GenerativeAiSandboxClient) WriteSandboxFile(ctx context.Context, request WriteSandboxFileRequest) (response WriteSandboxFileResponse, err error)
WriteSandboxFile Writes a file in a sandbox and returns the resulting file resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/WriteSandboxFile.go.html to see an example of how to use WriteSandboxFile API. A default retry strategy applies to this operation WriteSandboxFile()
GetSandboxCommandOutputRequest wrapper for the GetSandboxCommandOutput operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/GetSandboxCommandOutput.go.html to see an example of how to use GetSandboxCommandOutputRequest.
type GetSandboxCommandOutputRequest struct {
// Sandbox identifier. Newly generated Sandbox IDs use `sbx-` followed by 16 lowercase base32 characters (`a-z2-7`); existing legacy IDs remain accepted.
SandboxId *string `mandatory:"true" contributesTo:"path" name:"sandboxId"`
// Sandbox command identifier.
CommandId *string `mandatory:"true" contributesTo:"path" name:"commandId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The first command event sequence number to include.
FromSeq *int64 `mandatory:"false" contributesTo:"query" name:"fromSeq"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetSandboxCommandOutputRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetSandboxCommandOutputRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetSandboxCommandOutputRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetSandboxCommandOutputRequest) String() string
func (request GetSandboxCommandOutputRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetSandboxCommandOutputResponse wrapper for the GetSandboxCommandOutput operation
type GetSandboxCommandOutputResponse struct {
// The underlying http response
RawResponse *http.Response
// The SandboxCommandOutput instance
SandboxCommandOutput `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetSandboxCommandOutputResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetSandboxCommandOutputResponse) String() string
GetSandboxCommandRequest wrapper for the GetSandboxCommand operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/GetSandboxCommand.go.html to see an example of how to use GetSandboxCommandRequest.
type GetSandboxCommandRequest struct {
// Sandbox identifier. Newly generated Sandbox IDs use `sbx-` followed by 16 lowercase base32 characters (`a-z2-7`); existing legacy IDs remain accepted.
SandboxId *string `mandatory:"true" contributesTo:"path" name:"sandboxId"`
// Sandbox command identifier.
CommandId *string `mandatory:"true" contributesTo:"path" name:"commandId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetSandboxCommandRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetSandboxCommandRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetSandboxCommandRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetSandboxCommandRequest) String() string
func (request GetSandboxCommandRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetSandboxCommandResponse wrapper for the GetSandboxCommand operation
type GetSandboxCommandResponse struct {
// The underlying http response
RawResponse *http.Response
// The SandboxCommand instance
SandboxCommand `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetSandboxCommandResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetSandboxCommandResponse) String() string
GetSandboxRequest wrapper for the GetSandbox operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/GetSandbox.go.html to see an example of how to use GetSandboxRequest.
type GetSandboxRequest struct {
// Sandbox identifier. Newly generated Sandbox IDs use `sbx-` followed by 16 lowercase base32 characters (`a-z2-7`); existing legacy IDs remain accepted.
SandboxId *string `mandatory:"true" contributesTo:"path" name:"sandboxId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetSandboxRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetSandboxRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetSandboxRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetSandboxRequest) String() string
func (request GetSandboxRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetSandboxResponse wrapper for the GetSandbox operation
type GetSandboxResponse struct {
// The underlying http response
RawResponse *http.Response
// The Sandbox instance
Sandbox `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetSandboxResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetSandboxResponse) String() string
GetSandboxSnapshotRequest wrapper for the GetSandboxSnapshot operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/GetSandboxSnapshot.go.html to see an example of how to use GetSandboxSnapshotRequest.
type GetSandboxSnapshotRequest struct {
// Sandbox snapshot identifier.
SnapshotId *string `mandatory:"true" contributesTo:"path" name:"snapshotId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetSandboxSnapshotRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetSandboxSnapshotRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetSandboxSnapshotRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetSandboxSnapshotRequest) String() string
func (request GetSandboxSnapshotRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetSandboxSnapshotResponse wrapper for the GetSandboxSnapshot operation
type GetSandboxSnapshotResponse struct {
// The underlying http response
RawResponse *http.Response
// The SandboxSnapshot instance
SandboxSnapshot `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetSandboxSnapshotResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetSandboxSnapshotResponse) String() string
ListSandboxCommandRequest wrapper for the ListSandboxCommand operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/ListSandboxCommand.go.html to see an example of how to use ListSandboxCommandRequest.
type ListSandboxCommandRequest struct {
// Sandbox identifier. Newly generated Sandbox IDs use `sbx-` followed by 16 lowercase base32 characters (`a-z2-7`); existing legacy IDs remain accepted.
SandboxId *string `mandatory:"true" contributesTo:"path" name:"sandboxId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Sandbox command identifier used to filter listed command resources.
CommandId *string `mandatory:"false" contributesTo:"query" name:"commandId"`
// The field to sort by. Only one sort order may be provided. Default order for `timeCreated` is ascending.
SortBy ListSandboxCommandSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListSandboxCommandSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A token representing the position at which to start retrieving results.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListSandboxCommandRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListSandboxCommandRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSandboxCommandRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSandboxCommandRequest) String() string
func (request ListSandboxCommandRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListSandboxCommandResponse wrapper for the ListSandboxCommand operation
type ListSandboxCommandResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of SandboxCommandCollection instances
SandboxCommandCollection `presentIn:"body"`
// For list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListSandboxCommandResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSandboxCommandResponse) String() string
ListSandboxCommandSortByEnum Enum with underlying type: string
type ListSandboxCommandSortByEnum string
Set of constants representing the allowable values for ListSandboxCommandSortByEnum
const (
ListSandboxCommandSortByTimecreated ListSandboxCommandSortByEnum = "timeCreated"
ListSandboxCommandSortByTimestarted ListSandboxCommandSortByEnum = "timeStarted"
ListSandboxCommandSortByTimefinished ListSandboxCommandSortByEnum = "timeFinished"
)
func GetListSandboxCommandSortByEnumValues() []ListSandboxCommandSortByEnum
GetListSandboxCommandSortByEnumValues Enumerates the set of values for ListSandboxCommandSortByEnum
func GetMappingListSandboxCommandSortByEnum(val string) (ListSandboxCommandSortByEnum, bool)
GetMappingListSandboxCommandSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListSandboxCommandSortOrderEnum Enum with underlying type: string
type ListSandboxCommandSortOrderEnum string
Set of constants representing the allowable values for ListSandboxCommandSortOrderEnum
const (
ListSandboxCommandSortOrderAsc ListSandboxCommandSortOrderEnum = "ASC"
ListSandboxCommandSortOrderDesc ListSandboxCommandSortOrderEnum = "DESC"
)
func GetListSandboxCommandSortOrderEnumValues() []ListSandboxCommandSortOrderEnum
GetListSandboxCommandSortOrderEnumValues Enumerates the set of values for ListSandboxCommandSortOrderEnum
func GetMappingListSandboxCommandSortOrderEnum(val string) (ListSandboxCommandSortOrderEnum, bool)
GetMappingListSandboxCommandSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListSandboxSnapshotsRequest wrapper for the ListSandboxSnapshots operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/ListSandboxSnapshots.go.html to see an example of how to use ListSandboxSnapshotsRequest.
type ListSandboxSnapshotsRequest struct {
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The project identifier used to filter listed sandbox snapshot resources.
ProjectId *string `mandatory:"false" contributesTo:"query" name:"projectId"`
// Sandbox snapshot display name used to filter listed sandbox snapshot resources.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// Sandbox identifier used to filter listed sandbox snapshot resources. Newly generated Sandbox IDs use `sbx-` followed by 16 lowercase base32 characters (`a-z2-7`); existing legacy IDs remain accepted.
SandboxId *string `mandatory:"false" contributesTo:"query" name:"sandboxId"`
// Sandbox snapshot identifier used to filter listed sandbox snapshot resources.
SnapshotId *string `mandatory:"false" contributesTo:"query" name:"snapshotId"`
// A filter to return only sandbox snapshot resources whose state matches the given state.
LifecycleState SandboxSnapshotLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for `timeCreated` is ascending.
SortBy ListSandboxSnapshotsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListSandboxSnapshotsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A token representing the position at which to start retrieving results.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListSandboxSnapshotsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListSandboxSnapshotsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSandboxSnapshotsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSandboxSnapshotsRequest) String() string
func (request ListSandboxSnapshotsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListSandboxSnapshotsResponse wrapper for the ListSandboxSnapshots operation
type ListSandboxSnapshotsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of SandboxSnapshotCollection instances
SandboxSnapshotCollection `presentIn:"body"`
// For list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListSandboxSnapshotsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSandboxSnapshotsResponse) String() string
ListSandboxSnapshotsSortByEnum Enum with underlying type: string
type ListSandboxSnapshotsSortByEnum string
Set of constants representing the allowable values for ListSandboxSnapshotsSortByEnum
const (
ListSandboxSnapshotsSortByTimecreated ListSandboxSnapshotsSortByEnum = "timeCreated"
ListSandboxSnapshotsSortByDisplayname ListSandboxSnapshotsSortByEnum = "displayName"
)
func GetListSandboxSnapshotsSortByEnumValues() []ListSandboxSnapshotsSortByEnum
GetListSandboxSnapshotsSortByEnumValues Enumerates the set of values for ListSandboxSnapshotsSortByEnum
func GetMappingListSandboxSnapshotsSortByEnum(val string) (ListSandboxSnapshotsSortByEnum, bool)
GetMappingListSandboxSnapshotsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListSandboxSnapshotsSortOrderEnum Enum with underlying type: string
type ListSandboxSnapshotsSortOrderEnum string
Set of constants representing the allowable values for ListSandboxSnapshotsSortOrderEnum
const (
ListSandboxSnapshotsSortOrderAsc ListSandboxSnapshotsSortOrderEnum = "ASC"
ListSandboxSnapshotsSortOrderDesc ListSandboxSnapshotsSortOrderEnum = "DESC"
)
func GetListSandboxSnapshotsSortOrderEnumValues() []ListSandboxSnapshotsSortOrderEnum
GetListSandboxSnapshotsSortOrderEnumValues Enumerates the set of values for ListSandboxSnapshotsSortOrderEnum
func GetMappingListSandboxSnapshotsSortOrderEnum(val string) (ListSandboxSnapshotsSortOrderEnum, bool)
GetMappingListSandboxSnapshotsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListSandboxesRequest wrapper for the ListSandboxes operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/ListSandboxes.go.html to see an example of how to use ListSandboxesRequest.
type ListSandboxesRequest struct {
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The project identifier used to filter listed sandbox resources.
ProjectId *string `mandatory:"false" contributesTo:"query" name:"projectId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// Sandbox identifier used to filter listed sandbox resources. Newly generated Sandbox IDs use `sbx-` followed by 16 lowercase base32 characters (`a-z2-7`); existing legacy IDs remain accepted.
SandboxId *string `mandatory:"false" contributesTo:"query" name:"sandboxId"`
// Sandbox display name used to filter listed sandbox resources.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources whose state matches the given state.
LifecycleState SandboxLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for `timeCreated` is ascending.
SortBy ListSandboxesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListSandboxesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A token representing the position at which to start retrieving results.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListSandboxesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListSandboxesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSandboxesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSandboxesRequest) String() string
func (request ListSandboxesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListSandboxesResponse wrapper for the ListSandboxes operation
type ListSandboxesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of SandboxCollection instances
SandboxCollection `presentIn:"body"`
// For list pagination. When this header appears in the response, additional pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListSandboxesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSandboxesResponse) String() string
ListSandboxesSortByEnum Enum with underlying type: string
type ListSandboxesSortByEnum string
Set of constants representing the allowable values for ListSandboxesSortByEnum
const (
ListSandboxesSortByTimecreated ListSandboxesSortByEnum = "timeCreated"
ListSandboxesSortByDisplayname ListSandboxesSortByEnum = "displayName"
)
func GetListSandboxesSortByEnumValues() []ListSandboxesSortByEnum
GetListSandboxesSortByEnumValues Enumerates the set of values for ListSandboxesSortByEnum
func GetMappingListSandboxesSortByEnum(val string) (ListSandboxesSortByEnum, bool)
GetMappingListSandboxesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListSandboxesSortOrderEnum Enum with underlying type: string
type ListSandboxesSortOrderEnum string
Set of constants representing the allowable values for ListSandboxesSortOrderEnum
const (
ListSandboxesSortOrderAsc ListSandboxesSortOrderEnum = "ASC"
ListSandboxesSortOrderDesc ListSandboxesSortOrderEnum = "DESC"
)
func GetListSandboxesSortOrderEnumValues() []ListSandboxesSortOrderEnum
GetListSandboxesSortOrderEnumValues Enumerates the set of values for ListSandboxesSortOrderEnum
func GetMappingListSandboxesSortOrderEnum(val string) (ListSandboxesSortOrderEnum, bool)
GetMappingListSandboxesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
PublishedPort Published port key/value pair. Requests to the published URL may supply X-App-Token with the raw application token, without a Bearer prefix. After the sandbox's access policy succeeds, the proxy builds the upstream Authorization header as Bearer followed by the unchanged token and removes X-App-Token. This applies to HTTP, SSE, and WebSocket opening handshakes, and does not replace required OCI authentication. Exactly one nonempty printable ASCII token of at most 8192 bytes is accepted; whitespace, commas, control characters, and duplicate values are rejected with HTTP 400. Both header names must be treated as sensitive credentials.
type PublishedPort struct {
// Key string.
Key *string `mandatory:"true" json:"key"`
// Value string.
Value *string `mandatory:"true" json:"value"`
}
func (m PublishedPort) String() string
func (m PublishedPort) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ReadSandboxFileRequest wrapper for the ReadSandboxFile operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/ReadSandboxFile.go.html to see an example of how to use ReadSandboxFileRequest.
type ReadSandboxFileRequest struct {
// Sandbox identifier. Newly generated Sandbox IDs use `sbx-` followed by 16 lowercase base32 characters (`a-z2-7`); existing legacy IDs remain accepted.
SandboxId *string `mandatory:"true" contributesTo:"path" name:"sandboxId"`
// Absolute path under /workspace of the file to read.
FilePath *string `mandatory:"true" contributesTo:"query" name:"filePath"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ReadSandboxFileRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ReadSandboxFileRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ReadSandboxFileRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ReadSandboxFileRequest) String() string
func (request ReadSandboxFileRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ReadSandboxFileResponse wrapper for the ReadSandboxFile operation
type ReadSandboxFileResponse struct {
// The underlying http response
RawResponse *http.Response
// The io.ReadCloser instance
Content io.ReadCloser `presentIn:"body" encoding:"binary"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Base64-encoded SHA-256 checksum of the sandbox file content.
OpcContentSha256 *string `presentIn:"header" name:"opc-content-sha256"`
}
func (response ReadSandboxFileResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ReadSandboxFileResponse) String() string
ResumeSandboxDetails Empty request body used to resume a sandbox.
type ResumeSandboxDetails struct {
}
func (m ResumeSandboxDetails) String() string
func (m ResumeSandboxDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ResumeSandboxRequest wrapper for the ResumeSandbox operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/ResumeSandbox.go.html to see an example of how to use ResumeSandboxRequest.
type ResumeSandboxRequest struct {
// Sandbox identifier. Newly generated Sandbox IDs use `sbx-` followed by 16 lowercase base32 characters (`a-z2-7`); existing legacy IDs remain accepted.
SandboxId *string `mandatory:"true" contributesTo:"path" name:"sandboxId"`
// Request payload for resuming a sandbox.
ResumeSandboxDetails `contributesTo:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource,
// set the `if-match` parameter to the value of the etag from a previous GET or
// POST response for that resource. The resource is updated or deleted only if
// the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ResumeSandboxRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ResumeSandboxRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ResumeSandboxRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ResumeSandboxRequest) String() string
func (request ResumeSandboxRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ResumeSandboxResponse wrapper for the ResumeSandbox operation
type ResumeSandboxResponse struct {
// The underlying http response
RawResponse *http.Response
// The Sandbox instance
Sandbox `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ResumeSandboxResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ResumeSandboxResponse) String() string
RunSandboxCommandAndStreamRequest wrapper for the RunSandboxCommandAndStream operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/RunSandboxCommandAndStream.go.html to see an example of how to use RunSandboxCommandAndStreamRequest.
type RunSandboxCommandAndStreamRequest struct {
// Sandbox identifier. Newly generated Sandbox IDs use `sbx-` followed by 16 lowercase base32 characters (`a-z2-7`); existing legacy IDs remain accepted.
SandboxId *string `mandatory:"true" contributesTo:"path" name:"sandboxId"`
// Request payload for running a sandbox command.
RunSandboxCommandDetails `contributesTo:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RunSandboxCommandAndStreamRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RunSandboxCommandAndStreamRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RunSandboxCommandAndStreamRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RunSandboxCommandAndStreamRequest) String() string
func (request RunSandboxCommandAndStreamRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RunSandboxCommandAndStreamResponse wrapper for the RunSandboxCommandAndStream operation
type RunSandboxCommandAndStreamResponse struct {
// The underlying http response
RawResponse *http.Response
// The io.ReadCloser instance
Content io.ReadCloser `presentIn:"body" encoding:"binary"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response RunSandboxCommandAndStreamResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RunSandboxCommandAndStreamResponse) String() string
RunSandboxCommandAndWaitRequest wrapper for the RunSandboxCommandAndWait operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/RunSandboxCommandAndWait.go.html to see an example of how to use RunSandboxCommandAndWaitRequest.
type RunSandboxCommandAndWaitRequest struct {
// Sandbox identifier. Newly generated Sandbox IDs use `sbx-` followed by 16 lowercase base32 characters (`a-z2-7`); existing legacy IDs remain accepted.
SandboxId *string `mandatory:"true" contributesTo:"path" name:"sandboxId"`
// Request payload for running a sandbox command.
RunSandboxCommandDetails `contributesTo:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RunSandboxCommandAndWaitRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RunSandboxCommandAndWaitRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RunSandboxCommandAndWaitRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RunSandboxCommandAndWaitRequest) String() string
func (request RunSandboxCommandAndWaitRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RunSandboxCommandAndWaitResponse wrapper for the RunSandboxCommandAndWait operation
type RunSandboxCommandAndWaitResponse struct {
// The underlying http response
RawResponse *http.Response
// The SandboxCommand instance
SandboxCommand `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response RunSandboxCommandAndWaitResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RunSandboxCommandAndWaitResponse) String() string
RunSandboxCommandDetails Request body used to run a command in a sandbox.
type RunSandboxCommandDetails struct {
// The command to execute in the sandbox runtime.
Command *string `mandatory:"true" json:"command"`
// Absolute directory path to use as the working directory for command execution in the sandbox.
Cwd *string `mandatory:"false" json:"cwd"`
// Command arguments.
Args []string `mandatory:"false" json:"args"`
// Environment variables to inject into the command execution.
EnvironmentVariables []EnvironmentVariable `mandatory:"false" json:"environmentVariables"`
// Maximum execution time for the command, in ISO 8601 duration format.
Timeout *string `mandatory:"false" json:"timeout"`
}
func (m RunSandboxCommandDetails) String() string
func (m RunSandboxCommandDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RunSandboxCommandRequest wrapper for the RunSandboxCommand operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/RunSandboxCommand.go.html to see an example of how to use RunSandboxCommandRequest.
type RunSandboxCommandRequest struct {
// Sandbox identifier. Newly generated Sandbox IDs use `sbx-` followed by 16 lowercase base32 characters (`a-z2-7`); existing legacy IDs remain accepted.
SandboxId *string `mandatory:"true" contributesTo:"path" name:"sandboxId"`
// Request payload for running a sandbox command.
RunSandboxCommandDetails `contributesTo:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request RunSandboxCommandRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RunSandboxCommandRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RunSandboxCommandRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RunSandboxCommandRequest) String() string
func (request RunSandboxCommandRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RunSandboxCommandResponse wrapper for the RunSandboxCommand operation
type RunSandboxCommandResponse struct {
// The underlying http response
RawResponse *http.Response
// The SandboxCommandIdentifier instance
SandboxCommandIdentifier `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response RunSandboxCommandResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RunSandboxCommandResponse) String() string
Sandbox Sandbox resource representation.
type Sandbox struct {
// Sandbox identifier.
Id *string `mandatory:"true" json:"id"`
// The current state of the Sandbox.
LifecycleState SandboxLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The sandbox runtime type. For customer-provided containers, use a same-region Oracle Cloud Infrastructure Registry image reference.
Runtime *string `mandatory:"true" json:"runtime"`
// Display name for sandbox
DisplayName *string `mandatory:"false" json:"displayName"`
// GenerativeAiProject ID that sandbox belongs to
ProjectId *string `mandatory:"false" json:"projectId"`
// Name of the source warm pool, when selected explicitly or automatically at creation. The persisted association is retained on retries.
WarmpoolName *string `mandatory:"false" json:"warmpoolName"`
// Persisted published-port authorization mode. Absent for legacy sandboxes. Immutable after creation.
PublishedPortAuthMode SandboxPublishedPortAuthModeEnum `mandatory:"false" json:"publishedPortAuthMode,omitempty"`
// Published ports for the sandbox proxy endpoint.
PublishedPorts []PublishedPort `mandatory:"false" json:"publishedPorts"`
// list of environments for sandbox
EnvironmentVariables []EnvironmentVariable `mandatory:"false" json:"environmentVariables"`
// Number of minutes from creation until automatic sandbox expiration. Use `-1` to disable automatic expiration.
ExpiresInMinutes *int `mandatory:"false" json:"expiresInMinutes"`
// Deprecated. Use `expiresInMinutes` instead. Existing clients may pass `-1` to disable automatic expiration.
ExpirationDuration *string `mandatory:"false" json:"expirationDuration"`
// shape for sandbox
Shape SandboxShapeEnum `mandatory:"false" json:"shape,omitempty"`
// The date and time the sandbox was created, in RFC 3339 format.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the sandbox was updated, in RFC 3339 format.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The date and time the sandbox expires, in RFC 3339 format.
TimeExpires *common.SDKTime `mandatory:"false" json:"timeExpires"`
// The date and time the sandbox was stopped or expired, in RFC 3339 format.
TimeStopped *common.SDKTime `mandatory:"false" json:"timeStopped"`
}
func (m Sandbox) String() string
func (m Sandbox) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SandboxCollection Paginated collection of sandbox resources.
type SandboxCollection struct {
// List of sandbox resources.
Items []SandboxSummary `mandatory:"true" json:"items"`
}
func (m SandboxCollection) String() string
func (m SandboxCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SandboxCommand Sandbox command resource representation.
type SandboxCommand struct {
// Sandbox command identifier.
Id *string `mandatory:"true" json:"id"`
// Sandbox identifier that this command runs against.
SandboxId *string `mandatory:"true" json:"sandboxId"`
// The command executed in the sandbox runtime.
Command *string `mandatory:"true" json:"command"`
// Absolute directory path used as the working directory for command execution in the sandbox.
Cwd *string `mandatory:"false" json:"cwd"`
// Command arguments.
Args []string `mandatory:"false" json:"args"`
// Environment variables injected into the command execution.
EnvironmentVariables []EnvironmentVariable `mandatory:"false" json:"environmentVariables"`
// Process exit code when available.
ExitCode *int `mandatory:"false" json:"exitCode"`
Output *SandboxCommandOutput `mandatory:"false" json:"output"`
// The date and time the command was created, in RFC 3339 format.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the command was last updated, in RFC 3339 format.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The date and time command execution started, in RFC 3339 format.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time command execution finished, in RFC 3339 format.
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m SandboxCommand) String() string
func (m SandboxCommand) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SandboxCommandCollection Paginated collection of sandbox command resources.
type SandboxCommandCollection struct {
// List of sandbox command resources.
Items []SandboxCommandSummary `mandatory:"true" json:"items"`
}
func (m SandboxCommandCollection) String() string
func (m SandboxCommandCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SandboxCommandEvent Base command event emitted while a sandbox command runs.
type SandboxCommandEvent interface {
// Monotonically increasing command event sequence number.
GetSeq() *int64
// The date and time the command event was emitted, in RFC 3339 format.
GetTimestamp() *common.SDKTime
// Sandbox command identifier.
GetCommandId() *string
// Event payload.
GetData() *string
}
SandboxCommandEventEventEnum Enum with underlying type: string
type SandboxCommandEventEventEnum string
Set of constants representing the allowable values for SandboxCommandEventEventEnum
const (
SandboxCommandEventEventStarted SandboxCommandEventEventEnum = "STARTED"
SandboxCommandEventEventStdout SandboxCommandEventEventEnum = "STDOUT"
SandboxCommandEventEventStderr SandboxCommandEventEventEnum = "STDERR"
SandboxCommandEventEventFinished SandboxCommandEventEventEnum = "FINISHED"
)
func GetMappingSandboxCommandEventEventEnum(val string) (SandboxCommandEventEventEnum, bool)
GetMappingSandboxCommandEventEventEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSandboxCommandEventEventEnumValues() []SandboxCommandEventEventEnum
GetSandboxCommandEventEventEnumValues Enumerates the set of values for SandboxCommandEventEventEnum
SandboxCommandFinishedEvent Event emitted when command execution finishes.
type SandboxCommandFinishedEvent struct {
// Monotonically increasing command event sequence number.
Seq *int64 `mandatory:"true" json:"seq"`
// The date and time the command event was emitted, in RFC 3339 format.
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
// Sandbox command identifier.
CommandId *string `mandatory:"true" json:"commandId"`
// Event payload.
Data *string `mandatory:"false" json:"data"`
// Process exit code when available.
ExitCode *int `mandatory:"false" json:"exitCode"`
}
func (m SandboxCommandFinishedEvent) GetCommandId() *string
GetCommandId returns CommandId
func (m SandboxCommandFinishedEvent) GetData() *string
GetData returns Data
func (m SandboxCommandFinishedEvent) GetSeq() *int64
GetSeq returns Seq
func (m SandboxCommandFinishedEvent) GetTimestamp() *common.SDKTime
GetTimestamp returns Timestamp
func (m SandboxCommandFinishedEvent) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m SandboxCommandFinishedEvent) String() string
func (m SandboxCommandFinishedEvent) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SandboxCommandIdentifier Sandbox command identifier response.
type SandboxCommandIdentifier struct {
// Sandbox command identifier.
Id *string `mandatory:"true" json:"id"`
}
func (m SandboxCommandIdentifier) String() string
func (m SandboxCommandIdentifier) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SandboxCommandOutput Captured command output details.
type SandboxCommandOutput struct {
// Sandbox command identifier.
CommandId *string `mandatory:"true" json:"commandId"`
// Last command event sequence number included in the output.
LastSeq *int64 `mandatory:"true" json:"lastSeq"`
// Process exit code when available.
ExitCode *int `mandatory:"false" json:"exitCode"`
// Standard output captured from the requested event sequence.
Stdout *string `mandatory:"false" json:"stdout"`
// Standard error captured from the requested event sequence.
Stderr *string `mandatory:"false" json:"stderr"`
}
func (m SandboxCommandOutput) String() string
func (m SandboxCommandOutput) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SandboxCommandStartedEvent Event emitted when command execution starts.
type SandboxCommandStartedEvent struct {
// Monotonically increasing command event sequence number.
Seq *int64 `mandatory:"true" json:"seq"`
// The date and time the command event was emitted, in RFC 3339 format.
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
// Sandbox command identifier.
CommandId *string `mandatory:"true" json:"commandId"`
// Event payload.
Data *string `mandatory:"false" json:"data"`
}
func (m SandboxCommandStartedEvent) GetCommandId() *string
GetCommandId returns CommandId
func (m SandboxCommandStartedEvent) GetData() *string
GetData returns Data
func (m SandboxCommandStartedEvent) GetSeq() *int64
GetSeq returns Seq
func (m SandboxCommandStartedEvent) GetTimestamp() *common.SDKTime
GetTimestamp returns Timestamp
func (m SandboxCommandStartedEvent) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m SandboxCommandStartedEvent) String() string
func (m SandboxCommandStartedEvent) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SandboxCommandStderrEvent Event containing a standard error chunk.
type SandboxCommandStderrEvent struct {
// Monotonically increasing command event sequence number.
Seq *int64 `mandatory:"true" json:"seq"`
// The date and time the command event was emitted, in RFC 3339 format.
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
// Sandbox command identifier.
CommandId *string `mandatory:"true" json:"commandId"`
// Event payload.
Data *string `mandatory:"false" json:"data"`
}
func (m SandboxCommandStderrEvent) GetCommandId() *string
GetCommandId returns CommandId
func (m SandboxCommandStderrEvent) GetData() *string
GetData returns Data
func (m SandboxCommandStderrEvent) GetSeq() *int64
GetSeq returns Seq
func (m SandboxCommandStderrEvent) GetTimestamp() *common.SDKTime
GetTimestamp returns Timestamp
func (m SandboxCommandStderrEvent) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m SandboxCommandStderrEvent) String() string
func (m SandboxCommandStderrEvent) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SandboxCommandStdoutEvent Event containing a standard output chunk.
type SandboxCommandStdoutEvent struct {
// Monotonically increasing command event sequence number.
Seq *int64 `mandatory:"true" json:"seq"`
// The date and time the command event was emitted, in RFC 3339 format.
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
// Sandbox command identifier.
CommandId *string `mandatory:"true" json:"commandId"`
// Event payload.
Data *string `mandatory:"false" json:"data"`
}
func (m SandboxCommandStdoutEvent) GetCommandId() *string
GetCommandId returns CommandId
func (m SandboxCommandStdoutEvent) GetData() *string
GetData returns Data
func (m SandboxCommandStdoutEvent) GetSeq() *int64
GetSeq returns Seq
func (m SandboxCommandStdoutEvent) GetTimestamp() *common.SDKTime
GetTimestamp returns Timestamp
func (m SandboxCommandStdoutEvent) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m SandboxCommandStdoutEvent) String() string
func (m SandboxCommandStdoutEvent) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SandboxCommandSummary Sandbox command resource summary.
type SandboxCommandSummary struct {
// Sandbox command identifier.
Id *string `mandatory:"true" json:"id"`
// Sandbox identifier that this command runs against.
SandboxId *string `mandatory:"true" json:"sandboxId"`
// The command executed in the sandbox runtime.
Command *string `mandatory:"true" json:"command"`
// Absolute directory path used as the working directory for command execution in the sandbox.
Cwd *string `mandatory:"false" json:"cwd"`
// Command arguments.
Args []string `mandatory:"false" json:"args"`
// Process exit code when available.
ExitCode *int `mandatory:"false" json:"exitCode"`
// The date and time the command was created, in RFC 3339 format.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the command was last updated, in RFC 3339 format.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The date and time command execution started, in RFC 3339 format.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time command execution finished, in RFC 3339 format.
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m SandboxCommandSummary) String() string
func (m SandboxCommandSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SandboxFile Sandbox file resource representation.
type SandboxFile struct {
// Absolute path of the file in the sandbox, under /workspace.
FilePath *string `mandatory:"true" json:"filePath"`
// Sandbox identifier that this file belongs to.
SandboxId *string `mandatory:"false" json:"sandboxId"`
// Base64-encoded SHA-256 checksum of the file content when available.
ContentSha256 *string `mandatory:"false" json:"contentSha256"`
}
func (m SandboxFile) String() string
func (m SandboxFile) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SandboxLifecycleStateEnum Enum with underlying type: string
type SandboxLifecycleStateEnum string
Set of constants representing the allowable values for SandboxLifecycleStateEnum
const (
SandboxLifecycleStateRunning SandboxLifecycleStateEnum = "RUNNING"
SandboxLifecycleStateCreating SandboxLifecycleStateEnum = "CREATING"
SandboxLifecycleStateUpdating SandboxLifecycleStateEnum = "UPDATING"
SandboxLifecycleStateDeleted SandboxLifecycleStateEnum = "DELETED"
SandboxLifecycleStateFailed SandboxLifecycleStateEnum = "FAILED"
SandboxLifecycleStateSuspending SandboxLifecycleStateEnum = "SUSPENDING"
SandboxLifecycleStateSuspended SandboxLifecycleStateEnum = "SUSPENDED"
SandboxLifecycleStateResuming SandboxLifecycleStateEnum = "RESUMING"
SandboxLifecycleStateStopping SandboxLifecycleStateEnum = "STOPPING"
SandboxLifecycleStateStopped SandboxLifecycleStateEnum = "STOPPED"
)
func GetMappingSandboxLifecycleStateEnum(val string) (SandboxLifecycleStateEnum, bool)
GetMappingSandboxLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSandboxLifecycleStateEnumValues() []SandboxLifecycleStateEnum
GetSandboxLifecycleStateEnumValues Enumerates the set of values for SandboxLifecycleStateEnum
SandboxPublishedPortAuthModeEnum Enum with underlying type: string
type SandboxPublishedPortAuthModeEnum string
Set of constants representing the allowable values for SandboxPublishedPortAuthModeEnum
const (
SandboxPublishedPortAuthModeOciIam SandboxPublishedPortAuthModeEnum = "OCI_IAM"
)
func GetMappingSandboxPublishedPortAuthModeEnum(val string) (SandboxPublishedPortAuthModeEnum, bool)
GetMappingSandboxPublishedPortAuthModeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSandboxPublishedPortAuthModeEnumValues() []SandboxPublishedPortAuthModeEnum
GetSandboxPublishedPortAuthModeEnumValues Enumerates the set of values for SandboxPublishedPortAuthModeEnum
SandboxShapeEnum Enum with underlying type: string
type SandboxShapeEnum string
Set of constants representing the allowable values for SandboxShapeEnum
const (
SandboxShapeSmall SandboxShapeEnum = "SMALL"
SandboxShapeMedium SandboxShapeEnum = "MEDIUM"
SandboxShapeLarge SandboxShapeEnum = "LARGE"
)
func GetMappingSandboxShapeEnum(val string) (SandboxShapeEnum, bool)
GetMappingSandboxShapeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSandboxShapeEnumValues() []SandboxShapeEnum
GetSandboxShapeEnumValues Enumerates the set of values for SandboxShapeEnum
SandboxSnapshot Sandbox snapshot resource representation.
type SandboxSnapshot struct {
// Sandbox snapshot identifier.
Id *string `mandatory:"true" json:"id"`
// The current state of the SandboxSnapshot.
LifecycleState SandboxSnapshotLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Display name for the sandbox snapshot.
DisplayName *string `mandatory:"false" json:"displayName"`
// Project identifier that the sandbox snapshot belongs to.
ProjectId *string `mandatory:"false" json:"projectId"`
// Identifier of the sandbox used to create the sandbox snapshot.
SandboxId *string `mandatory:"false" json:"sandboxId"`
// Runtime identifier for the sandbox snapshot.
Runtime *string `mandatory:"false" json:"runtime"`
// Duration after creation before the sandbox snapshot expires, in ISO 8601 duration format. For example, `P7D` for 7 days or `PT24H` for 24 hours.
ExpirationDuration *string `mandatory:"false" json:"expirationDuration"`
// Size of the sandbox snapshot archive in bytes.
SizeBytes *int64 `mandatory:"false" json:"sizeBytes"`
// The date and time the sandbox snapshot was created, in RFC 3339 format.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the sandbox snapshot was last updated, in RFC 3339 format.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The date and time the sandbox snapshot expires, in RFC 3339 format.
TimeExpires *common.SDKTime `mandatory:"false" json:"timeExpires"`
}
func (m SandboxSnapshot) String() string
func (m SandboxSnapshot) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SandboxSnapshotCollection Paginated collection of sandbox snapshot resources.
type SandboxSnapshotCollection struct {
// List of sandbox snapshot resources.
Items []SandboxSnapshotSummary `mandatory:"true" json:"items"`
}
func (m SandboxSnapshotCollection) String() string
func (m SandboxSnapshotCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SandboxSnapshotLifecycleStateEnum Enum with underlying type: string
type SandboxSnapshotLifecycleStateEnum string
Set of constants representing the allowable values for SandboxSnapshotLifecycleStateEnum
const (
SandboxSnapshotLifecycleStateCreating SandboxSnapshotLifecycleStateEnum = "CREATING"
SandboxSnapshotLifecycleStateActive SandboxSnapshotLifecycleStateEnum = "ACTIVE"
SandboxSnapshotLifecycleStateFailed SandboxSnapshotLifecycleStateEnum = "FAILED"
SandboxSnapshotLifecycleStateDeleting SandboxSnapshotLifecycleStateEnum = "DELETING"
SandboxSnapshotLifecycleStateDeleted SandboxSnapshotLifecycleStateEnum = "DELETED"
)
func GetMappingSandboxSnapshotLifecycleStateEnum(val string) (SandboxSnapshotLifecycleStateEnum, bool)
GetMappingSandboxSnapshotLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSandboxSnapshotLifecycleStateEnumValues() []SandboxSnapshotLifecycleStateEnum
GetSandboxSnapshotLifecycleStateEnumValues Enumerates the set of values for SandboxSnapshotLifecycleStateEnum
SandboxSnapshotSource Source configuration for initializing a sandbox from a sandbox snapshot.
type SandboxSnapshotSource struct {
// Identifier of the sandbox snapshot to restore during sandbox creation.
SnapshotId *string `mandatory:"true" json:"snapshotId"`
}
func (m SandboxSnapshotSource) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m SandboxSnapshotSource) String() string
func (m SandboxSnapshotSource) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SandboxSnapshotSummary Sandbox snapshot resource summary.
type SandboxSnapshotSummary struct {
// Sandbox snapshot identifier.
Id *string `mandatory:"true" json:"id"`
// The current state of the SandboxSnapshot.
// Allowed values are:
// - CREATING
// - ACTIVE
// - FAILED
// - DELETING
// - DELETED
LifecycleState SandboxSnapshotLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Display name for the sandbox snapshot.
DisplayName *string `mandatory:"false" json:"displayName"`
// Project identifier that the sandbox snapshot belongs to.
ProjectId *string `mandatory:"false" json:"projectId"`
// Identifier of the sandbox used to create the sandbox snapshot.
SandboxId *string `mandatory:"false" json:"sandboxId"`
// Runtime identifier for the sandbox snapshot.
Runtime *string `mandatory:"false" json:"runtime"`
// Duration after creation before the sandbox snapshot expires, in ISO 8601 duration format. For example, `P7D` for 7 days or `PT24H` for 24 hours.
ExpirationDuration *string `mandatory:"false" json:"expirationDuration"`
// Size of the sandbox snapshot archive in bytes.
SizeBytes *int64 `mandatory:"false" json:"sizeBytes"`
// The date and time the sandbox snapshot was created, in RFC 3339 format.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the sandbox snapshot was last updated, in RFC 3339 format.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The date and time the sandbox snapshot expires, in RFC 3339 format.
TimeExpires *common.SDKTime `mandatory:"false" json:"timeExpires"`
}
func (m SandboxSnapshotSummary) String() string
func (m SandboxSnapshotSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SandboxSource Base source configuration used to initialize a sandbox.
type SandboxSource interface {
}
SandboxSourceSourceTypeEnum Enum with underlying type: string
type SandboxSourceSourceTypeEnum string
Set of constants representing the allowable values for SandboxSourceSourceTypeEnum
const (
SandboxSourceSourceTypeSnapshot SandboxSourceSourceTypeEnum = "SNAPSHOT"
)
func GetMappingSandboxSourceSourceTypeEnum(val string) (SandboxSourceSourceTypeEnum, bool)
GetMappingSandboxSourceSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSandboxSourceSourceTypeEnumValues() []SandboxSourceSourceTypeEnum
GetSandboxSourceSourceTypeEnumValues Enumerates the set of values for SandboxSourceSourceTypeEnum
SandboxSummary Sandbox resource representation.
type SandboxSummary struct {
// Sandbox identifier.
Id *string `mandatory:"true" json:"id"`
// The current state of the Sandbox.
// Allowed values are:
// - RUNNING
// - CREATING
// - UPDATING
// - DELETED
// - FAILED
// - SUSPENDING
// - SUSPENDED
// - RESUMING
// - STOPPING
// - STOPPED
LifecycleState SandboxLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The sandbox runtime type. For customer-provided containers, use a same-region Oracle Cloud Infrastructure Registry image reference.
Runtime *string `mandatory:"true" json:"runtime"`
// Display name for sandbox
DisplayName *string `mandatory:"false" json:"displayName"`
// GenerativeAiProject ID that sandbox belongs to
ProjectId *string `mandatory:"false" json:"projectId"`
// Name of the source warm pool, when selected explicitly or automatically at creation. The persisted association is retained on retries.
WarmpoolName *string `mandatory:"false" json:"warmpoolName"`
// Persisted published-port authorization mode. Absent for legacy sandboxes.
PublishedPortAuthMode SandboxPublishedPortAuthModeEnum `mandatory:"false" json:"publishedPortAuthMode,omitempty"`
// Published ports for the sandbox proxy endpoint.
PublishedPorts []PublishedPort `mandatory:"false" json:"publishedPorts"`
// Number of minutes from creation until automatic sandbox expiration. Use `-1` to disable automatic expiration.
ExpiresInMinutes *int `mandatory:"false" json:"expiresInMinutes"`
// Deprecated. Use `expiresInMinutes` instead. Existing clients may pass `-1` to disable automatic expiration.
ExpirationDuration *string `mandatory:"false" json:"expirationDuration"`
// shape for sandbox
Shape SandboxSummaryShapeEnum `mandatory:"false" json:"shape,omitempty"`
// The date and time the sandbox was created, in RFC 3339 format.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The date and time the sandbox was updated, in RFC 3339 format.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The date and time the sandbox expires, in RFC 3339 format.
TimeExpires *common.SDKTime `mandatory:"false" json:"timeExpires"`
// The date and time the sandbox was stopped or expired, in RFC 3339 format.
TimeStopped *common.SDKTime `mandatory:"false" json:"timeStopped"`
}
func (m SandboxSummary) String() string
func (m SandboxSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SandboxSummaryShapeEnum Enum with underlying type: string
type SandboxSummaryShapeEnum string
Set of constants representing the allowable values for SandboxSummaryShapeEnum
const (
SandboxSummaryShapeSmall SandboxSummaryShapeEnum = "SMALL"
SandboxSummaryShapeMedium SandboxSummaryShapeEnum = "MEDIUM"
SandboxSummaryShapeLarge SandboxSummaryShapeEnum = "LARGE"
)
func GetMappingSandboxSummaryShapeEnum(val string) (SandboxSummaryShapeEnum, bool)
GetMappingSandboxSummaryShapeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSandboxSummaryShapeEnumValues() []SandboxSummaryShapeEnum
GetSandboxSummaryShapeEnumValues Enumerates the set of values for SandboxSummaryShapeEnum
SortOrderEnum Enum with underlying type: string
type SortOrderEnum string
Set of constants representing the allowable values for SortOrderEnum
const (
SortOrderAsc SortOrderEnum = "ASC"
SortOrderDesc SortOrderEnum = "DESC"
)
func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)
GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
StopSandboxDetails Request body used to stop a sandbox.
type StopSandboxDetails struct {
// Whether to send SIGKILL immediately instead of attempting graceful shutdown.
IsForce *bool `mandatory:"false" json:"isForce"`
}
func (m StopSandboxDetails) String() string
func (m StopSandboxDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
StopSandboxRequest wrapper for the StopSandbox operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/StopSandbox.go.html to see an example of how to use StopSandboxRequest.
type StopSandboxRequest struct {
// Sandbox identifier. Newly generated Sandbox IDs use `sbx-` followed by 16 lowercase base32 characters (`a-z2-7`); existing legacy IDs remain accepted.
SandboxId *string `mandatory:"true" contributesTo:"path" name:"sandboxId"`
// Request payload for stopping a sandbox.
StopSandboxDetails `contributesTo:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource,
// set the `if-match` parameter to the value of the etag from a previous GET or
// POST response for that resource. The resource is updated or deleted only if
// the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request StopSandboxRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StopSandboxRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StopSandboxRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StopSandboxRequest) String() string
func (request StopSandboxRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
StopSandboxResponse wrapper for the StopSandbox operation
type StopSandboxResponse struct {
// The underlying http response
RawResponse *http.Response
// The Sandbox instance
Sandbox `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response StopSandboxResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StopSandboxResponse) String() string
StreamSandboxCommandEventsRequest wrapper for the StreamSandboxCommandEvents operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/StreamSandboxCommandEvents.go.html to see an example of how to use StreamSandboxCommandEventsRequest.
type StreamSandboxCommandEventsRequest struct {
// Sandbox identifier. Newly generated Sandbox IDs use `sbx-` followed by 16 lowercase base32 characters (`a-z2-7`); existing legacy IDs remain accepted.
SandboxId *string `mandatory:"true" contributesTo:"path" name:"sandboxId"`
// Sandbox command identifier.
CommandId *string `mandatory:"true" contributesTo:"path" name:"commandId"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The first command event sequence number to include.
FromSeq *int64 `mandatory:"false" contributesTo:"query" name:"fromSeq"`
// The last command event sequence number to include. If omitted, all available events from `fromSeq` are included.
UntilSeq *int64 `mandatory:"false" contributesTo:"query" name:"untilSeq"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request StreamSandboxCommandEventsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StreamSandboxCommandEventsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StreamSandboxCommandEventsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StreamSandboxCommandEventsRequest) String() string
func (request StreamSandboxCommandEventsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
StreamSandboxCommandEventsResponse wrapper for the StreamSandboxCommandEvents operation
type StreamSandboxCommandEventsResponse struct {
// The underlying http response
RawResponse *http.Response
// The io.ReadCloser instance
Content io.ReadCloser `presentIn:"body" encoding:"binary"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response StreamSandboxCommandEventsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StreamSandboxCommandEventsResponse) String() string
SuspendSandboxDetails Empty request body used to suspend a sandbox.
type SuspendSandboxDetails struct {
}
func (m SuspendSandboxDetails) String() string
func (m SuspendSandboxDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SuspendSandboxRequest wrapper for the SuspendSandbox operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/SuspendSandbox.go.html to see an example of how to use SuspendSandboxRequest.
type SuspendSandboxRequest struct {
// Sandbox identifier. Newly generated Sandbox IDs use `sbx-` followed by 16 lowercase base32 characters (`a-z2-7`); existing legacy IDs remain accepted.
SandboxId *string `mandatory:"true" contributesTo:"path" name:"sandboxId"`
// Request payload for suspending a sandbox.
SuspendSandboxDetails `contributesTo:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource,
// set the `if-match` parameter to the value of the etag from a previous GET or
// POST response for that resource. The resource is updated or deleted only if
// the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request SuspendSandboxRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request SuspendSandboxRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request SuspendSandboxRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request SuspendSandboxRequest) String() string
func (request SuspendSandboxRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SuspendSandboxResponse wrapper for the SuspendSandbox operation
type SuspendSandboxResponse struct {
// The underlying http response
RawResponse *http.Response
// The Sandbox instance
Sandbox `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response SuspendSandboxResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response SuspendSandboxResponse) String() string
UpdateSandboxDetails Request body used to update a sandbox.
type UpdateSandboxDetails struct {
// User-provided display name for the sandbox.
DisplayName *string `mandatory:"false" json:"displayName"`
}
func (m UpdateSandboxDetails) String() string
func (m UpdateSandboxDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateSandboxRequest wrapper for the UpdateSandbox operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/UpdateSandbox.go.html to see an example of how to use UpdateSandboxRequest.
type UpdateSandboxRequest struct {
// Sandbox identifier. Newly generated Sandbox IDs use `sbx-` followed by 16 lowercase base32 characters (`a-z2-7`); existing legacy IDs remain accepted.
SandboxId *string `mandatory:"true" contributesTo:"path" name:"sandboxId"`
// Request payload for sandbox update.
UpdateSandboxDetails `contributesTo:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call for a resource,
// set the `if-match` parameter to the value of the etag from a previous GET or
// POST response for that resource. The resource is updated or deleted only if
// the etag provided matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateSandboxRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateSandboxRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateSandboxRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateSandboxRequest) String() string
func (request UpdateSandboxRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateSandboxResponse wrapper for the UpdateSandbox operation
type UpdateSandboxResponse struct {
// The underlying http response
RawResponse *http.Response
// The Sandbox instance
Sandbox `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateSandboxResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateSandboxResponse) String() string
WriteSandboxFileRequest wrapper for the WriteSandboxFile operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaisandbox/WriteSandboxFile.go.html to see an example of how to use WriteSandboxFileRequest.
type WriteSandboxFileRequest struct {
// Sandbox identifier. Newly generated Sandbox IDs use `sbx-` followed by 16 lowercase base32 characters (`a-z2-7`); existing legacy IDs remain accepted.
SandboxId *string `mandatory:"true" contributesTo:"path" name:"sandboxId"`
// Absolute path under /workspace where the file will be written.
FilePath *string `mandatory:"true" contributesTo:"query" name:"filePath"`
// Raw file bytes to write.
WriteSandboxFileContentDetails io.ReadCloser `mandatory:"true" contributesTo:"body" encoding:"binary"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Optional base64-encoded SHA-256 checksum of the sandbox file content. When supported by the sandbox runtime,
// the runtime validates the uploaded file content against this value and rejects the request if the values do not match.
OpcContentSha256 *string `mandatory:"false" contributesTo:"header" name:"opc-content-sha256"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request WriteSandboxFileRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request WriteSandboxFileRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request WriteSandboxFileRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request WriteSandboxFileRequest) String() string
func (request WriteSandboxFileRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WriteSandboxFileResponse wrapper for the WriteSandboxFile operation
type WriteSandboxFileResponse struct {
// The underlying http response
RawResponse *http.Response
// The SandboxFile instance
SandboxFile `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Base64-encoded SHA-256 checksum of the sandbox file content.
OpcContentSha256 *string `presentIn:"header" name:"opc-content-sha256"`
}
func (response WriteSandboxFileResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response WriteSandboxFileResponse) String() string