func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetContainerCapabilityEnumStringValues() []string
GetContainerCapabilityEnumStringValues Enumerates the set of values in String for ContainerCapabilityEnum
func GetContainerCapabilityTypeEnumStringValues() []string
GetContainerCapabilityTypeEnumStringValues Enumerates the set of values in String for ContainerCapabilityTypeEnum
func GetContainerEmptyDirVolumeBackingStoreEnumStringValues() []string
GetContainerEmptyDirVolumeBackingStoreEnumStringValues Enumerates the set of values in String for ContainerEmptyDirVolumeBackingStoreEnum
func GetContainerHealthCheckFailureActionEnumStringValues() []string
GetContainerHealthCheckFailureActionEnumStringValues Enumerates the set of values in String for ContainerHealthCheckFailureActionEnum
func GetContainerHealthCheckStatusEnumStringValues() []string
GetContainerHealthCheckStatusEnumStringValues Enumerates the set of values in String for ContainerHealthCheckStatusEnum
func GetContainerHealthCheckTypeEnumStringValues() []string
GetContainerHealthCheckTypeEnumStringValues Enumerates the set of values in String for ContainerHealthCheckTypeEnum
func GetContainerInstanceContainerRestartPolicyEnumStringValues() []string
GetContainerInstanceContainerRestartPolicyEnumStringValues Enumerates the set of values in String for ContainerInstanceContainerRestartPolicyEnum
func GetContainerInstanceLifecycleStateEnumStringValues() []string
GetContainerInstanceLifecycleStateEnumStringValues Enumerates the set of values in String for ContainerInstanceLifecycleStateEnum
func GetContainerLifecycleStateEnumStringValues() []string
GetContainerLifecycleStateEnumStringValues Enumerates the set of values in String for ContainerLifecycleStateEnum
func GetContainerVolumeTypeEnumStringValues() []string
GetContainerVolumeTypeEnumStringValues Enumerates the set of values in String for ContainerVolumeTypeEnum
func GetCreateImagePullSecretDetailsSecretTypeEnumStringValues() []string
GetCreateImagePullSecretDetailsSecretTypeEnumStringValues Enumerates the set of values in String for CreateImagePullSecretDetailsSecretTypeEnum
func GetImagePullSecretSecretTypeEnumStringValues() []string
GetImagePullSecretSecretTypeEnumStringValues Enumerates the set of values in String for ImagePullSecretSecretTypeEnum
func GetListContainerInstancesSortByEnumStringValues() []string
GetListContainerInstancesSortByEnumStringValues Enumerates the set of values in String for ListContainerInstancesSortByEnum
func GetListContainerInstancesSortOrderEnumStringValues() []string
GetListContainerInstancesSortOrderEnumStringValues Enumerates the set of values in String for ListContainerInstancesSortOrderEnum
func GetListContainersSortByEnumStringValues() []string
GetListContainersSortByEnumStringValues Enumerates the set of values in String for ListContainersSortByEnum
func GetListContainersSortOrderEnumStringValues() []string
GetListContainersSortOrderEnumStringValues Enumerates the set of values in String for ListContainersSortOrderEnum
func GetListWorkRequestErrorsSortByEnumStringValues() []string
GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum
func GetListWorkRequestErrorsSortOrderEnumStringValues() []string
GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum
func GetListWorkRequestLogsSortByEnumStringValues() []string
GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum
func GetListWorkRequestLogsSortOrderEnumStringValues() []string
GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum
func GetListWorkRequestsSortByEnumStringValues() []string
GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum
func GetListWorkRequestsSortOrderEnumStringValues() []string
GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum
func GetListWorkRequestsStatusEnumStringValues() []string
GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum
func GetOperationStatusEnumStringValues() []string
GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum
func GetOperationTypeEnumStringValues() []string
GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum
func GetSecurityContextSecurityContextTypeEnumStringValues() []string
GetSecurityContextSecurityContextTypeEnumStringValues Enumerates the set of values in String for SecurityContextSecurityContextTypeEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
ActionTypeEnum Enum with underlying type: string
type ActionTypeEnum string
Set of constants representing the allowable values for ActionTypeEnum
const (
ActionTypeCreated ActionTypeEnum = "CREATED"
ActionTypeUpdated ActionTypeEnum = "UPDATED"
ActionTypeDeleted ActionTypeEnum = "DELETED"
ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
ActionTypeRelated ActionTypeEnum = "RELATED"
ActionTypeFailed ActionTypeEnum = "FAILED"
)
func GetActionTypeEnumValues() []ActionTypeEnum
GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum
func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)
GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
BasicImagePullSecret A BasicImagePullSecret is a ImagePullSecret which accepts username and password as credentials information.
type BasicImagePullSecret struct {
// The registry endpoint of the container image.
RegistryEndpoint *string `mandatory:"true" json:"registryEndpoint"`
}
func (m BasicImagePullSecret) GetRegistryEndpoint() *string
GetRegistryEndpoint returns RegistryEndpoint
func (m BasicImagePullSecret) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m BasicImagePullSecret) String() string
func (m BasicImagePullSecret) 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
ChangeContainerInstanceCompartmentDetails The configuration details for the move operation.
type ChangeContainerInstanceCompartmentDetails struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the container instance to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeContainerInstanceCompartmentDetails) String() string
func (m ChangeContainerInstanceCompartmentDetails) 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
ChangeContainerInstanceCompartmentRequest wrapper for the ChangeContainerInstanceCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/ChangeContainerInstanceCompartment.go.html to see an example of how to use ChangeContainerInstanceCompartmentRequest.
type ChangeContainerInstanceCompartmentRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container instance.
ContainerInstanceId *string `mandatory:"true" contributesTo:"path" name:"containerInstanceId"`
// The information to be updated.
ChangeContainerInstanceCompartmentDetails `contributesTo:"body"`
// 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 will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
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 ChangeContainerInstanceCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeContainerInstanceCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeContainerInstanceCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeContainerInstanceCompartmentRequest) String() string
func (request ChangeContainerInstanceCompartmentRequest) 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
ChangeContainerInstanceCompartmentResponse wrapper for the ChangeContainerInstanceCompartment operation
type ChangeContainerInstanceCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 ChangeContainerInstanceCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeContainerInstanceCompartmentResponse) String() string
Container A single container on a container instance. If you delete a container, the record remains visible for a short period of time before being permanently removed.
type Container struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container.
Id *string `mandatory:"true" json:"id"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID of the compartment that contains the container.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The availability domain where the container instance that hosts the container runs.
AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`
// The current state of the container.
LifecycleState ContainerLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The time the container was created, in the format defined by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container instance that the container is running on.
ContainerInstanceId *string `mandatory:"true" json:"containerInstanceId"`
// The container image information. Currently only supports public Docker registry.
// You can provide either the image name (containerImage), image name with version (containerImagev1), or complete Docker image URL
// `docker.io/library/containerImage:latest`.
// If you do not provide a registry, the registry defaults to public Docker hub `docker.io/library`.
// The registry used for the container image must be reachable over the VNIC of the container instance.
ImageUrl *string `mandatory:"true" json:"imageUrl"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`.
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`.
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// The fault domain of the container instance that hosts the container runs.
FaultDomain *string `mandatory:"false" json:"faultDomain"`
// A message that describes the current state of the container in more detail. Can be used to provide
// actionable information.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The exit code of the container process when it stopped running.
ExitCode *int `mandatory:"false" json:"exitCode"`
// The time when the container last deleted (terminated), in the format defined by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeTerminated *common.SDKTime `mandatory:"false" json:"timeTerminated"`
// The time the container was updated, in the format defined by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// This command overrides ENTRYPOINT process of the container.
// If you do not specify this command, the existing ENTRYPOINT process defined in the image is the default.
Command []string `mandatory:"false" json:"command"`
// A list of string arguments for the ENTRYPOINT process of the container.
// Many containers use an ENTRYPOINT process pointing to a shell
// `/bin/bash`. For those containers, you can use the argument list to specify the main command in the container process.
Arguments []string `mandatory:"false" json:"arguments"`
// The working directory within the container's filesystem for
// the container process. If not specified, the default
// working directory from the image is used.
WorkingDirectory *string `mandatory:"false" json:"workingDirectory"`
// A map of additional environment variables to set in the environment of the
// ENTRYPOINT process of the container. These variables are in addition to any variables already defined
// in the container's image.
EnvironmentVariables map[string]string `mandatory:"false" json:"environmentVariables"`
// List of the volume mounts.
VolumeMounts []VolumeMount `mandatory:"false" json:"volumeMounts"`
// List of container health checks
HealthChecks []ContainerHealthCheck `mandatory:"false" json:"healthChecks"`
// Determines if the container will have access to the container instance resource principal.
// This method utilizes resource principal version 2.2. For more information on how to use the exposed resource principal elements, see
// https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdk_authentication_methods.htm#sdk_authentication_methods_resource_principal.
IsResourcePrincipalDisabled *bool `mandatory:"false" json:"isResourcePrincipalDisabled"`
ResourceConfig *ContainerResourceConfig `mandatory:"false" json:"resourceConfig"`
// The number of container restart attempts. Depending on the restart policy, a restart might be attempted after a health check failure or a container exit.
ContainerRestartAttemptCount *int `mandatory:"false" json:"containerRestartAttemptCount"`
SecurityContext SecurityContext `mandatory:"false" json:"securityContext"`
}
func (m Container) String() string
func (m *Container) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m Container) 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
ContainerCapabilities Linux Container capabilities to configure capabilities of container.
type ContainerCapabilities struct {
// A list of additional configurable container capabilities.
AddCapabilities []ContainerCapabilityTypeEnum `mandatory:"false" json:"addCapabilities,omitempty"`
// A list of container capabilities that can be dropped.
DropCapabilities []ContainerCapabilityTypeEnum `mandatory:"false" json:"dropCapabilities,omitempty"`
}
func (m ContainerCapabilities) String() string
func (m ContainerCapabilities) 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
ContainerCapabilityEnum Enum with underlying type: string
type ContainerCapabilityEnum string
Set of constants representing the allowable values for ContainerCapabilityEnum
const (
ContainerCapabilityCapNetAdmin ContainerCapabilityEnum = "CAP_NET_ADMIN"
ContainerCapabilityCapNetRaw ContainerCapabilityEnum = "CAP_NET_RAW"
)
func GetContainerCapabilityEnumValues() []ContainerCapabilityEnum
GetContainerCapabilityEnumValues Enumerates the set of values for ContainerCapabilityEnum
func GetMappingContainerCapabilityEnum(val string) (ContainerCapabilityEnum, bool)
GetMappingContainerCapabilityEnum performs case Insensitive comparison on enum value and return the desired enum
ContainerCapabilityTypeEnum Enum with underlying type: string
type ContainerCapabilityTypeEnum string
Set of constants representing the allowable values for ContainerCapabilityTypeEnum
const (
ContainerCapabilityTypeCapChown ContainerCapabilityTypeEnum = "CAP_CHOWN"
ContainerCapabilityTypeCapDacOverride ContainerCapabilityTypeEnum = "CAP_DAC_OVERRIDE"
ContainerCapabilityTypeCapFsetid ContainerCapabilityTypeEnum = "CAP_FSETID"
ContainerCapabilityTypeCapFowner ContainerCapabilityTypeEnum = "CAP_FOWNER"
ContainerCapabilityTypeCapMknod ContainerCapabilityTypeEnum = "CAP_MKNOD"
ContainerCapabilityTypeCapNetRaw ContainerCapabilityTypeEnum = "CAP_NET_RAW"
ContainerCapabilityTypeCapSetgid ContainerCapabilityTypeEnum = "CAP_SETGID"
ContainerCapabilityTypeCapSetuid ContainerCapabilityTypeEnum = "CAP_SETUID"
ContainerCapabilityTypeCapSetfcap ContainerCapabilityTypeEnum = "CAP_SETFCAP"
ContainerCapabilityTypeCapSetpcap ContainerCapabilityTypeEnum = "CAP_SETPCAP"
ContainerCapabilityTypeCapNetBindService ContainerCapabilityTypeEnum = "CAP_NET_BIND_SERVICE"
ContainerCapabilityTypeCapSysChroot ContainerCapabilityTypeEnum = "CAP_SYS_CHROOT"
ContainerCapabilityTypeCapKill ContainerCapabilityTypeEnum = "CAP_KILL"
ContainerCapabilityTypeCapAuditWrite ContainerCapabilityTypeEnum = "CAP_AUDIT_WRITE"
ContainerCapabilityTypeAll ContainerCapabilityTypeEnum = "ALL"
)
func GetContainerCapabilityTypeEnumValues() []ContainerCapabilityTypeEnum
GetContainerCapabilityTypeEnumValues Enumerates the set of values for ContainerCapabilityTypeEnum
func GetMappingContainerCapabilityTypeEnum(val string) (ContainerCapabilityTypeEnum, bool)
GetMappingContainerCapabilityTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ContainerCollection A list of containers.
type ContainerCollection struct {
// List of containers.
Items []ContainerSummary `mandatory:"true" json:"items"`
}
func (m ContainerCollection) String() string
func (m ContainerCollection) 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
ContainerCommandHealthCheck Container Health Check with command type.
type ContainerCommandHealthCheck struct {
// The list of strings that will be simplified to a single command for checking the status of the container.
Command []string `mandatory:"true" json:"command"`
// Health check name.
Name *string `mandatory:"false" json:"name"`
// The initial delay in seconds before start checking container health status.
InitialDelayInSeconds *int `mandatory:"false" json:"initialDelayInSeconds"`
// Number of seconds between two consecutive runs for checking container health.
IntervalInSeconds *int `mandatory:"false" json:"intervalInSeconds"`
// Number of consecutive failures at which we consider the check failed.
FailureThreshold *int `mandatory:"false" json:"failureThreshold"`
// Number of consecutive successes at which we consider the check succeeded again after it was in failure state.
SuccessThreshold *int `mandatory:"false" json:"successThreshold"`
// Length of waiting time in seconds before marking health check failed.
TimeoutInSeconds *int `mandatory:"false" json:"timeoutInSeconds"`
// A message describing the current status in more details.
StatusDetails *string `mandatory:"false" json:"statusDetails"`
// Status of container
Status ContainerHealthCheckStatusEnum `mandatory:"false" json:"status,omitempty"`
// The action will be triggered when the container health check fails. There are two types of action: KILL or NONE. The default
// action is KILL. If failure action is KILL, the container will be subject to the container restart policy.
FailureAction ContainerHealthCheckFailureActionEnum `mandatory:"false" json:"failureAction,omitempty"`
}
func (m ContainerCommandHealthCheck) GetFailureAction() ContainerHealthCheckFailureActionEnum
GetFailureAction returns FailureAction
func (m ContainerCommandHealthCheck) GetFailureThreshold() *int
GetFailureThreshold returns FailureThreshold
func (m ContainerCommandHealthCheck) GetInitialDelayInSeconds() *int
GetInitialDelayInSeconds returns InitialDelayInSeconds
func (m ContainerCommandHealthCheck) GetIntervalInSeconds() *int
GetIntervalInSeconds returns IntervalInSeconds
func (m ContainerCommandHealthCheck) GetName() *string
GetName returns Name
func (m ContainerCommandHealthCheck) GetStatus() ContainerHealthCheckStatusEnum
GetStatus returns Status
func (m ContainerCommandHealthCheck) GetStatusDetails() *string
GetStatusDetails returns StatusDetails
func (m ContainerCommandHealthCheck) GetSuccessThreshold() *int
GetSuccessThreshold returns SuccessThreshold
func (m ContainerCommandHealthCheck) GetTimeoutInSeconds() *int
GetTimeoutInSeconds returns TimeoutInSeconds
func (m ContainerCommandHealthCheck) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ContainerCommandHealthCheck) String() string
func (m ContainerCommandHealthCheck) 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
ContainerConfigFile The file that is mounted on a container instance through a volume mount.
type ContainerConfigFile struct {
// The name of the file. The fileName should be unique across the volume.
FileName *string `mandatory:"true" json:"fileName"`
// The base64 encoded contents of the file. The contents are decoded to plain text before mounted as a file to a container inside container instance.
Data []byte `mandatory:"true" json:"data"`
// (Optional) Relative path for this file inside the volume mount directory. By default, the file is presented at the root of the volume mount path.
Path *string `mandatory:"false" json:"path"`
}
func (m ContainerConfigFile) String() string
func (m ContainerConfigFile) 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
ContainerConfigFileVolume The volume based on configuration files received during container creation.
type ContainerConfigFileVolume struct {
// The name of the volume. This must be unique within a single container instance.
Name *string `mandatory:"true" json:"name"`
// Contains string key value pairs which can be mounted as individual files inside the container. The value needs to be base64 encoded. It is decoded to plain text before the mount.
Configs []ContainerConfigFile `mandatory:"false" json:"configs"`
}
func (m ContainerConfigFileVolume) GetName() *string
GetName returns Name
func (m ContainerConfigFileVolume) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ContainerConfigFileVolume) String() string
func (m ContainerConfigFileVolume) 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
ContainerDnsConfig DNS settings for containers.
type ContainerDnsConfig struct {
// IP address of the name server..
Nameservers []string `mandatory:"false" json:"nameservers"`
// Search list for hostname lookup.
Searches []string `mandatory:"false" json:"searches"`
// Options allows certain internal resolver variables to be modified.
Options []string `mandatory:"false" json:"options"`
}
func (m ContainerDnsConfig) String() string
func (m ContainerDnsConfig) 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
ContainerEmptyDirVolume The empty directory volume of a container instance. You can create up to 64 EmptyDir per container instance.
type ContainerEmptyDirVolume struct {
// The name of the volume. This must be unique within a single container instance.
Name *string `mandatory:"true" json:"name"`
// The volume type of the empty directory, can be either File Storage or Memory.
BackingStore ContainerEmptyDirVolumeBackingStoreEnum `mandatory:"false" json:"backingStore,omitempty"`
}
func (m ContainerEmptyDirVolume) GetName() *string
GetName returns Name
func (m ContainerEmptyDirVolume) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ContainerEmptyDirVolume) String() string
func (m ContainerEmptyDirVolume) 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
ContainerEmptyDirVolumeBackingStoreEnum Enum with underlying type: string
type ContainerEmptyDirVolumeBackingStoreEnum string
Set of constants representing the allowable values for ContainerEmptyDirVolumeBackingStoreEnum
const (
ContainerEmptyDirVolumeBackingStoreEphemeralStorage ContainerEmptyDirVolumeBackingStoreEnum = "EPHEMERAL_STORAGE"
ContainerEmptyDirVolumeBackingStoreMemory ContainerEmptyDirVolumeBackingStoreEnum = "MEMORY"
)
func GetContainerEmptyDirVolumeBackingStoreEnumValues() []ContainerEmptyDirVolumeBackingStoreEnum
GetContainerEmptyDirVolumeBackingStoreEnumValues Enumerates the set of values for ContainerEmptyDirVolumeBackingStoreEnum
func GetMappingContainerEmptyDirVolumeBackingStoreEnum(val string) (ContainerEmptyDirVolumeBackingStoreEnum, bool)
GetMappingContainerEmptyDirVolumeBackingStoreEnum performs case Insensitive comparison on enum value and return the desired enum
ContainerHealthCheck Type of container health check which could be either HTTP, TCP, or Command.
type ContainerHealthCheck interface {
// Health check name.
GetName() *string
// The initial delay in seconds before start checking container health status.
GetInitialDelayInSeconds() *int
// Number of seconds between two consecutive runs for checking container health.
GetIntervalInSeconds() *int
// Number of consecutive failures at which we consider the check failed.
GetFailureThreshold() *int
// Number of consecutive successes at which we consider the check succeeded again after it was in failure state.
GetSuccessThreshold() *int
// Length of waiting time in seconds before marking health check failed.
GetTimeoutInSeconds() *int
// Status of container
GetStatus() ContainerHealthCheckStatusEnum
// A message describing the current status in more details.
GetStatusDetails() *string
// The action will be triggered when the container health check fails. There are two types of action: KILL or NONE. The default
// action is KILL. If failure action is KILL, the container will be subject to the container restart policy.
GetFailureAction() ContainerHealthCheckFailureActionEnum
}
ContainerHealthCheckFailureActionEnum Enum with underlying type: string
type ContainerHealthCheckFailureActionEnum string
Set of constants representing the allowable values for ContainerHealthCheckFailureActionEnum
const (
ContainerHealthCheckFailureActionKill ContainerHealthCheckFailureActionEnum = "KILL"
ContainerHealthCheckFailureActionNone ContainerHealthCheckFailureActionEnum = "NONE"
)
func GetContainerHealthCheckFailureActionEnumValues() []ContainerHealthCheckFailureActionEnum
GetContainerHealthCheckFailureActionEnumValues Enumerates the set of values for ContainerHealthCheckFailureActionEnum
func GetMappingContainerHealthCheckFailureActionEnum(val string) (ContainerHealthCheckFailureActionEnum, bool)
GetMappingContainerHealthCheckFailureActionEnum performs case Insensitive comparison on enum value and return the desired enum
ContainerHealthCheckStatusEnum Enum with underlying type: string
type ContainerHealthCheckStatusEnum string
Set of constants representing the allowable values for ContainerHealthCheckStatusEnum
const (
ContainerHealthCheckStatusHealthy ContainerHealthCheckStatusEnum = "HEALTHY"
ContainerHealthCheckStatusUnhealthy ContainerHealthCheckStatusEnum = "UNHEALTHY"
ContainerHealthCheckStatusUnknown ContainerHealthCheckStatusEnum = "UNKNOWN"
)
func GetContainerHealthCheckStatusEnumValues() []ContainerHealthCheckStatusEnum
GetContainerHealthCheckStatusEnumValues Enumerates the set of values for ContainerHealthCheckStatusEnum
func GetMappingContainerHealthCheckStatusEnum(val string) (ContainerHealthCheckStatusEnum, bool)
GetMappingContainerHealthCheckStatusEnum performs case Insensitive comparison on enum value and return the desired enum
ContainerHealthCheckTypeEnum Enum with underlying type: string
type ContainerHealthCheckTypeEnum string
Set of constants representing the allowable values for ContainerHealthCheckTypeEnum
const (
ContainerHealthCheckTypeHttp ContainerHealthCheckTypeEnum = "HTTP"
ContainerHealthCheckTypeTcp ContainerHealthCheckTypeEnum = "TCP"
ContainerHealthCheckTypeCommand ContainerHealthCheckTypeEnum = "COMMAND"
)
func GetContainerHealthCheckTypeEnumValues() []ContainerHealthCheckTypeEnum
GetContainerHealthCheckTypeEnumValues Enumerates the set of values for ContainerHealthCheckTypeEnum
func GetMappingContainerHealthCheckTypeEnum(val string) (ContainerHealthCheckTypeEnum, bool)
GetMappingContainerHealthCheckTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ContainerHttpHealthCheck Container Health Check HTTP type.
type ContainerHttpHealthCheck struct {
// Container health check HTTP path.
Path *string `mandatory:"true" json:"path"`
// Container health check HTTP port.
Port *int `mandatory:"true" json:"port"`
// Health check name.
Name *string `mandatory:"false" json:"name"`
// The initial delay in seconds before start checking container health status.
InitialDelayInSeconds *int `mandatory:"false" json:"initialDelayInSeconds"`
// Number of seconds between two consecutive runs for checking container health.
IntervalInSeconds *int `mandatory:"false" json:"intervalInSeconds"`
// Number of consecutive failures at which we consider the check failed.
FailureThreshold *int `mandatory:"false" json:"failureThreshold"`
// Number of consecutive successes at which we consider the check succeeded again after it was in failure state.
SuccessThreshold *int `mandatory:"false" json:"successThreshold"`
// Length of waiting time in seconds before marking health check failed.
TimeoutInSeconds *int `mandatory:"false" json:"timeoutInSeconds"`
// A message describing the current status in more details.
StatusDetails *string `mandatory:"false" json:"statusDetails"`
// Container health check HTTP headers.
Headers []HealthCheckHttpHeader `mandatory:"false" json:"headers"`
// Status of container
Status ContainerHealthCheckStatusEnum `mandatory:"false" json:"status,omitempty"`
// The action will be triggered when the container health check fails. There are two types of action: KILL or NONE. The default
// action is KILL. If failure action is KILL, the container will be subject to the container restart policy.
FailureAction ContainerHealthCheckFailureActionEnum `mandatory:"false" json:"failureAction,omitempty"`
}
func (m ContainerHttpHealthCheck) GetFailureAction() ContainerHealthCheckFailureActionEnum
GetFailureAction returns FailureAction
func (m ContainerHttpHealthCheck) GetFailureThreshold() *int
GetFailureThreshold returns FailureThreshold
func (m ContainerHttpHealthCheck) GetInitialDelayInSeconds() *int
GetInitialDelayInSeconds returns InitialDelayInSeconds
func (m ContainerHttpHealthCheck) GetIntervalInSeconds() *int
GetIntervalInSeconds returns IntervalInSeconds
func (m ContainerHttpHealthCheck) GetName() *string
GetName returns Name
func (m ContainerHttpHealthCheck) GetStatus() ContainerHealthCheckStatusEnum
GetStatus returns Status
func (m ContainerHttpHealthCheck) GetStatusDetails() *string
GetStatusDetails returns StatusDetails
func (m ContainerHttpHealthCheck) GetSuccessThreshold() *int
GetSuccessThreshold returns SuccessThreshold
func (m ContainerHttpHealthCheck) GetTimeoutInSeconds() *int
GetTimeoutInSeconds returns TimeoutInSeconds
func (m ContainerHttpHealthCheck) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ContainerHttpHealthCheck) String() string
func (m ContainerHttpHealthCheck) 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
ContainerInstance A container instance to host containers. If you delete a container instance, the record remains visible for a short period of time before being permanently removed.
type ContainerInstance struct {
// An OCID that cannot be changed.
Id *string `mandatory:"true" json:"id"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The availability domain to place the container instance.
AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`
// The current state of the container instance.
LifecycleState ContainerInstanceLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The containers on the container instance.
Containers []ContainerInstanceContainer `mandatory:"true" json:"containers"`
// The number of containers on the container instance.
ContainerCount *int `mandatory:"true" json:"containerCount"`
// The time the container instance was created, in the format defined by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The shape of the container instance. The shape determines the number of OCPUs, amount of memory, and other resources that are allocated to a container instance.
Shape *string `mandatory:"true" json:"shape"`
ShapeConfig *ContainerInstanceShapeConfig `mandatory:"true" json:"shapeConfig"`
// The virtual networks available to the containers in the container instance.
Vnics []ContainerVnic `mandatory:"true" json:"vnics"`
// The container restart policy is applied for all containers in container instance.
ContainerRestartPolicy ContainerInstanceContainerRestartPolicyEnum `mandatory:"true" json:"containerRestartPolicy"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`.
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`.
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// The fault domain to place the container instance.
FaultDomain *string `mandatory:"false" json:"faultDomain"`
// A message that describes the current state of the container in more detail. Can be used to provide
// actionable information.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// A volume is a directory with data that is accessible across multiple containers in a
// container instance.
Volumes []ContainerVolume `mandatory:"false" json:"volumes"`
// The number of volumes that are attached to the container instance.
VolumeCount *int `mandatory:"false" json:"volumeCount"`
// The time the container instance was updated, in the format defined by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
DnsConfig *ContainerDnsConfig `mandatory:"false" json:"dnsConfig"`
// The amount of time that processes in a container have to gracefully end when the container must be stopped. For example, when you delete a container instance. After the timeout is reached, the processes are sent a signal to be deleted.
GracefulShutdownTimeoutInSeconds *int64 `mandatory:"false" json:"gracefulShutdownTimeoutInSeconds"`
// The image pulls secrets so you can access private registry to pull container images.
ImagePullSecrets []ImagePullSecret `mandatory:"false" json:"imagePullSecrets"`
}
func (m ContainerInstance) String() string
func (m *ContainerInstance) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ContainerInstance) 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
ContainerInstanceClient a client for ContainerInstance
type ContainerInstanceClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewContainerInstanceClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ContainerInstanceClient, err error)
NewContainerInstanceClientWithConfigurationProvider Creates a new default ContainerInstance client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewContainerInstanceClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ContainerInstanceClient, err error)
NewContainerInstanceClientWithOboToken Creates a new default ContainerInstance 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 ContainerInstanceClient) ChangeContainerInstanceCompartment(ctx context.Context, request ChangeContainerInstanceCompartmentRequest) (response ChangeContainerInstanceCompartmentResponse, err error)
ChangeContainerInstanceCompartment Moves a container instance resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/ChangeContainerInstanceCompartment.go.html to see an example of how to use ChangeContainerInstanceCompartment API. A default retry strategy applies to this operation ChangeContainerInstanceCompartment()
func (client *ContainerInstanceClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client ContainerInstanceClient) CreateContainerInstance(ctx context.Context, request CreateContainerInstanceRequest) (response CreateContainerInstanceResponse, err error)
CreateContainerInstance Creates a container instance and deploys the containers on it.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/CreateContainerInstance.go.html to see an example of how to use CreateContainerInstance API. A default retry strategy applies to this operation CreateContainerInstance()
func (client ContainerInstanceClient) DeleteContainerInstance(ctx context.Context, request DeleteContainerInstanceRequest) (response DeleteContainerInstanceResponse, err error)
DeleteContainerInstance Deletes a container instance and its containers.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/DeleteContainerInstance.go.html to see an example of how to use DeleteContainerInstance API. A default retry strategy applies to this operation DeleteContainerInstance()
func (client ContainerInstanceClient) GetContainer(ctx context.Context, request GetContainerRequest) (response GetContainerResponse, err error)
GetContainer Get details about a single container by the container ID.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/GetContainer.go.html to see an example of how to use GetContainer API. A default retry strategy applies to this operation GetContainer()
func (client ContainerInstanceClient) GetContainerInstance(ctx context.Context, request GetContainerInstanceRequest) (response GetContainerInstanceResponse, err error)
GetContainerInstance Gets information about the specified container instance.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/GetContainerInstance.go.html to see an example of how to use GetContainerInstance API. A default retry strategy applies to this operation GetContainerInstance()
func (client ContainerInstanceClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the status of the work request with the given ID.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client ContainerInstanceClient) ListContainerInstanceShapes(ctx context.Context, request ListContainerInstanceShapesRequest) (response ListContainerInstanceShapesResponse, err error)
ListContainerInstanceShapes Lists the shapes that can be used to create container instances.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/ListContainerInstanceShapes.go.html to see an example of how to use ListContainerInstanceShapes API. A default retry strategy applies to this operation ListContainerInstanceShapes()
func (client ContainerInstanceClient) ListContainerInstances(ctx context.Context, request ListContainerInstancesRequest) (response ListContainerInstancesResponse, err error)
ListContainerInstances Returns a list of container instances.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/ListContainerInstances.go.html to see an example of how to use ListContainerInstances API. A default retry strategy applies to this operation ListContainerInstances()
func (client ContainerInstanceClient) ListContainers(ctx context.Context, request ListContainersRequest) (response ListContainersResponse, err error)
ListContainers Returns a list of containers in a compartment.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/ListContainers.go.html to see an example of how to use ListContainers API. A default retry strategy applies to this operation ListContainers()
func (client ContainerInstanceClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Returns a paginated list of errors for a work request.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client ContainerInstanceClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Returns a paginated list of logs for a work request.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client ContainerInstanceClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in a compartment.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client ContainerInstanceClient) RestartContainerInstance(ctx context.Context, request RestartContainerInstanceRequest) (response RestartContainerInstanceResponse, err error)
RestartContainerInstance Restarts a container instance. When provided, If-Match is checked against ETag values of the container instance.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/RestartContainerInstance.go.html to see an example of how to use RestartContainerInstance API. A default retry strategy applies to this operation RestartContainerInstance()
func (client ContainerInstanceClient) RetrieveLogs(ctx context.Context, request RetrieveLogsRequest) (response RetrieveLogsResponse, err error)
RetrieveLogs Returns the most recent 256 KB of logs from the specified container.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/RetrieveLogs.go.html to see an example of how to use RetrieveLogs API. A default retry strategy applies to this operation RetrieveLogs()
func (client *ContainerInstanceClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client ContainerInstanceClient) StartContainerInstance(ctx context.Context, request StartContainerInstanceRequest) (response StartContainerInstanceResponse, err error)
StartContainerInstance Starts a container instance if it is "inactive". No effect otherwise. When provided, If-Match is checked against ETag values of the container instance.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/StartContainerInstance.go.html to see an example of how to use StartContainerInstance API. A default retry strategy applies to this operation StartContainerInstance()
func (client ContainerInstanceClient) StopContainerInstance(ctx context.Context, request StopContainerInstanceRequest) (response StopContainerInstanceResponse, err error)
StopContainerInstance Stops a container instance if it is "active". No effect otherwise. When provided, If-Match is checked against ETag values of the container instance.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/StopContainerInstance.go.html to see an example of how to use StopContainerInstance API. A default retry strategy applies to this operation StopContainerInstance()
func (client ContainerInstanceClient) UpdateContainer(ctx context.Context, request UpdateContainerRequest) (response UpdateContainerResponse, err error)
UpdateContainer Updates a container.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/UpdateContainer.go.html to see an example of how to use UpdateContainer API. A default retry strategy applies to this operation UpdateContainer()
func (client ContainerInstanceClient) UpdateContainerInstance(ctx context.Context, request UpdateContainerInstanceRequest) (response UpdateContainerInstanceResponse, err error)
UpdateContainerInstance Updates a container instance.
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/UpdateContainerInstance.go.html to see an example of how to use UpdateContainerInstance API. A default retry strategy applies to this operation UpdateContainerInstance()
ContainerInstanceCollection Summary information about a list of container instances.
type ContainerInstanceCollection struct {
// List of container instances.
Items []ContainerInstanceSummary `mandatory:"true" json:"items"`
}
func (m ContainerInstanceCollection) String() string
func (m ContainerInstanceCollection) 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
ContainerInstanceContainer A container on a container instance.
type ContainerInstanceContainer struct {
// The OCID of the container.
ContainerId *string `mandatory:"true" json:"containerId"`
// Display name for the Container.
DisplayName *string `mandatory:"false" json:"displayName"`
}
func (m ContainerInstanceContainer) String() string
func (m ContainerInstanceContainer) 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
ContainerInstanceContainerRestartPolicyEnum Enum with underlying type: string
type ContainerInstanceContainerRestartPolicyEnum string
Set of constants representing the allowable values for ContainerInstanceContainerRestartPolicyEnum
const (
ContainerInstanceContainerRestartPolicyAlways ContainerInstanceContainerRestartPolicyEnum = "ALWAYS"
ContainerInstanceContainerRestartPolicyNever ContainerInstanceContainerRestartPolicyEnum = "NEVER"
ContainerInstanceContainerRestartPolicyOnFailure ContainerInstanceContainerRestartPolicyEnum = "ON_FAILURE"
)
func GetContainerInstanceContainerRestartPolicyEnumValues() []ContainerInstanceContainerRestartPolicyEnum
GetContainerInstanceContainerRestartPolicyEnumValues Enumerates the set of values for ContainerInstanceContainerRestartPolicyEnum
func GetMappingContainerInstanceContainerRestartPolicyEnum(val string) (ContainerInstanceContainerRestartPolicyEnum, bool)
GetMappingContainerInstanceContainerRestartPolicyEnum performs case Insensitive comparison on enum value and return the desired enum
ContainerInstanceLifecycleStateEnum Enum with underlying type: string
type ContainerInstanceLifecycleStateEnum string
Set of constants representing the allowable values for ContainerInstanceLifecycleStateEnum
const (
ContainerInstanceLifecycleStateCreating ContainerInstanceLifecycleStateEnum = "CREATING"
ContainerInstanceLifecycleStateUpdating ContainerInstanceLifecycleStateEnum = "UPDATING"
ContainerInstanceLifecycleStateActive ContainerInstanceLifecycleStateEnum = "ACTIVE"
ContainerInstanceLifecycleStateInactive ContainerInstanceLifecycleStateEnum = "INACTIVE"
ContainerInstanceLifecycleStateDeleting ContainerInstanceLifecycleStateEnum = "DELETING"
ContainerInstanceLifecycleStateDeleted ContainerInstanceLifecycleStateEnum = "DELETED"
ContainerInstanceLifecycleStateFailed ContainerInstanceLifecycleStateEnum = "FAILED"
)
func GetContainerInstanceLifecycleStateEnumValues() []ContainerInstanceLifecycleStateEnum
GetContainerInstanceLifecycleStateEnumValues Enumerates the set of values for ContainerInstanceLifecycleStateEnum
func GetMappingContainerInstanceLifecycleStateEnum(val string) (ContainerInstanceLifecycleStateEnum, bool)
GetMappingContainerInstanceLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ContainerInstanceShapeCollection A collection of container instance shapes.
type ContainerInstanceShapeCollection struct {
// A list of shapes.
Items []ContainerInstanceShapeSummary `mandatory:"true" json:"items"`
}
func (m ContainerInstanceShapeCollection) String() string
func (m ContainerInstanceShapeCollection) 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
ContainerInstanceShapeConfig The shape configuration for a container instance. The shape configuration determines the resources thats are available to the container instance and its containers.
type ContainerInstanceShapeConfig struct {
// The total number of OCPUs available to the container instance.
Ocpus *float32 `mandatory:"true" json:"ocpus"`
// The total amount of memory available to the container instance, in gigabytes.
MemoryInGBs *float32 `mandatory:"true" json:"memoryInGBs"`
// A short description of the container instance's processor (CPU).
ProcessorDescription *string `mandatory:"true" json:"processorDescription"`
// The networking bandwidth available to the container instance, in gigabits per second.
NetworkingBandwidthInGbps *float32 `mandatory:"true" json:"networkingBandwidthInGbps"`
}
func (m ContainerInstanceShapeConfig) String() string
func (m ContainerInstanceShapeConfig) 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
ContainerInstanceShapeSummary Details about a shape for a container instance.
type ContainerInstanceShapeSummary struct {
// The name identifying the shape.
Name *string `mandatory:"true" json:"name"`
// A short description of the container instance's processor (CPU).
ProcessorDescription *string `mandatory:"true" json:"processorDescription"`
OcpuOptions *ShapeOcpuOptions `mandatory:"false" json:"ocpuOptions"`
MemoryOptions *ShapeMemoryOptions `mandatory:"false" json:"memoryOptions"`
NetworkingBandwidthOptions *ShapeNetworkingBandwidthOptions `mandatory:"false" json:"networkingBandwidthOptions"`
}
func (m ContainerInstanceShapeSummary) String() string
func (m ContainerInstanceShapeSummary) 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
ContainerInstanceSummary A set of details about a single container instance returned by list APIs.
type ContainerInstanceSummary struct {
// OCID that cannot be changed.
Id *string `mandatory:"true" json:"id"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID of the compartment to create the container instance in.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The availability domain where the container instance runs.
AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`
// The current state of the container instance.
LifecycleState ContainerInstanceLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The time the container instance was created, in the format defined by RFC3339.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The shape of the container instance. The shape determines the resources available to the container instance.
Shape *string `mandatory:"true" json:"shape"`
ShapeConfig *ContainerInstanceShapeConfig `mandatory:"true" json:"shapeConfig"`
// The number of containers in the container instance.
ContainerCount *int `mandatory:"true" json:"containerCount"`
// Container Restart Policy
ContainerRestartPolicy ContainerInstanceContainerRestartPolicyEnum `mandatory:"true" json:"containerRestartPolicy"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`.
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`.
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// The fault domain where the container instance runs.
FaultDomain *string `mandatory:"false" json:"faultDomain"`
// A message that describes the current state of the container instance in more detail. Can be used to provide
// actionable information.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The time the container instance was updated, in the format defined by RFC3339.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The amount of time that processes in a container have to gracefully end when the container must be stopped. For example, when you delete a container instance. After the timeout is reached, the processes are sent a signal to be deleted.
GracefulShutdownTimeoutInSeconds *int64 `mandatory:"false" json:"gracefulShutdownTimeoutInSeconds"`
// The number of volumes that are attached to the container instance.
VolumeCount *int `mandatory:"false" json:"volumeCount"`
}
func (m ContainerInstanceSummary) String() string
func (m ContainerInstanceSummary) 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
ContainerLifecycleStateEnum Enum with underlying type: string
type ContainerLifecycleStateEnum string
Set of constants representing the allowable values for ContainerLifecycleStateEnum
const (
ContainerLifecycleStateCreating ContainerLifecycleStateEnum = "CREATING"
ContainerLifecycleStateUpdating ContainerLifecycleStateEnum = "UPDATING"
ContainerLifecycleStateActive ContainerLifecycleStateEnum = "ACTIVE"
ContainerLifecycleStateInactive ContainerLifecycleStateEnum = "INACTIVE"
ContainerLifecycleStateDeleting ContainerLifecycleStateEnum = "DELETING"
ContainerLifecycleStateDeleted ContainerLifecycleStateEnum = "DELETED"
ContainerLifecycleStateFailed ContainerLifecycleStateEnum = "FAILED"
)
func GetContainerLifecycleStateEnumValues() []ContainerLifecycleStateEnum
GetContainerLifecycleStateEnumValues Enumerates the set of values for ContainerLifecycleStateEnum
func GetMappingContainerLifecycleStateEnum(val string) (ContainerLifecycleStateEnum, bool)
GetMappingContainerLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ContainerResourceConfig The resource configuration for a container. The resource configuration determines the amount of resources allocated to the container and the maximum allowed resources for a container.
type ContainerResourceConfig struct {
// The maximum amount of CPUs that can be consumed by the container's process.
// If you do not set a value, then the process
// may use all available CPU resources on the container instance.
// CPU usage is defined in terms of logical CPUs. This means that the
// maximum possible value on an E3 ContainerInstance with 1 OCPU is 2.0.
VcpusLimit *float32 `mandatory:"false" json:"vcpusLimit"`
// The maximum amount of memory that can be consumed by the container's
// process. If you do not set a value, then the process
// may use all available memory on the instance.
MemoryLimitInGBs *float32 `mandatory:"false" json:"memoryLimitInGBs"`
}
func (m ContainerResourceConfig) String() string
func (m ContainerResourceConfig) 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
ContainerSummary Summary information about a container.
type ContainerSummary struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container.
Id *string `mandatory:"true" json:"id"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"true" json:"displayName"`
// The compartment OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The availability domain where the container instance that hosts this container runs.
AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`
// The current state of the container.
LifecycleState ContainerLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The time the the container was created in the format defined by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container instance on which the container is running.
ContainerInstanceId *string `mandatory:"true" json:"containerInstanceId"`
// A URL identifying the image that the container runs in, such as docker.io/library/busybox:latest. If you do not provide a tag, the tag will default to latest.
// If no registry is provided, will default the registry to public docker hub `docker.io/library`.
// The registry used for container image must be reachable over the Container Instance's VNIC.
ImageUrl *string `mandatory:"true" json:"imageUrl"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`.
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`.
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// The fault domain where the container instance that hosts the container runs.
FaultDomain *string `mandatory:"false" json:"faultDomain"`
// A message that describes the current state of the container in more detail. Can be used to provide
// actionable information.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The time the container was updated in the format defined by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
ResourceConfig *ContainerResourceConfig `mandatory:"false" json:"resourceConfig"`
// Determines whether the container will have access to the container instance resource principal.
// This method utilizes resource principal version 2.2. For information on how to use the exposed resource principal elements, see
// https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdk_authentication_methods.htm#sdk_authentication_methods_resource_principal.
IsResourcePrincipalDisabled *bool `mandatory:"false" json:"isResourcePrincipalDisabled"`
SecurityContext SecurityContext `mandatory:"false" json:"securityContext"`
}
func (m ContainerSummary) String() string
func (m *ContainerSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ContainerSummary) 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
ContainerTcpHealthCheck Container Health Check with TCP type.
type ContainerTcpHealthCheck struct {
// Container health check port.
Port *int `mandatory:"true" json:"port"`
// Health check name.
Name *string `mandatory:"false" json:"name"`
// The initial delay in seconds before start checking container health status.
InitialDelayInSeconds *int `mandatory:"false" json:"initialDelayInSeconds"`
// Number of seconds between two consecutive runs for checking container health.
IntervalInSeconds *int `mandatory:"false" json:"intervalInSeconds"`
// Number of consecutive failures at which we consider the check failed.
FailureThreshold *int `mandatory:"false" json:"failureThreshold"`
// Number of consecutive successes at which we consider the check succeeded again after it was in failure state.
SuccessThreshold *int `mandatory:"false" json:"successThreshold"`
// Length of waiting time in seconds before marking health check failed.
TimeoutInSeconds *int `mandatory:"false" json:"timeoutInSeconds"`
// A message describing the current status in more details.
StatusDetails *string `mandatory:"false" json:"statusDetails"`
// Status of container
Status ContainerHealthCheckStatusEnum `mandatory:"false" json:"status,omitempty"`
// The action will be triggered when the container health check fails. There are two types of action: KILL or NONE. The default
// action is KILL. If failure action is KILL, the container will be subject to the container restart policy.
FailureAction ContainerHealthCheckFailureActionEnum `mandatory:"false" json:"failureAction,omitempty"`
}
func (m ContainerTcpHealthCheck) GetFailureAction() ContainerHealthCheckFailureActionEnum
GetFailureAction returns FailureAction
func (m ContainerTcpHealthCheck) GetFailureThreshold() *int
GetFailureThreshold returns FailureThreshold
func (m ContainerTcpHealthCheck) GetInitialDelayInSeconds() *int
GetInitialDelayInSeconds returns InitialDelayInSeconds
func (m ContainerTcpHealthCheck) GetIntervalInSeconds() *int
GetIntervalInSeconds returns IntervalInSeconds
func (m ContainerTcpHealthCheck) GetName() *string
GetName returns Name
func (m ContainerTcpHealthCheck) GetStatus() ContainerHealthCheckStatusEnum
GetStatus returns Status
func (m ContainerTcpHealthCheck) GetStatusDetails() *string
GetStatusDetails returns StatusDetails
func (m ContainerTcpHealthCheck) GetSuccessThreshold() *int
GetSuccessThreshold returns SuccessThreshold
func (m ContainerTcpHealthCheck) GetTimeoutInSeconds() *int
GetTimeoutInSeconds returns TimeoutInSeconds
func (m ContainerTcpHealthCheck) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ContainerTcpHealthCheck) String() string
func (m ContainerTcpHealthCheck) 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
ContainerVnic An interface to a virtual network available to containers on a container instance.
type ContainerVnic struct {
// The identifier of the virtual network interface card (VNIC) over which
// the containers accessing this network can communicate with the
// larger virtual cloud network.
VnicId *string `mandatory:"false" json:"vnicId"`
}
func (m ContainerVnic) String() string
func (m ContainerVnic) 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
ContainerVolume A volume represents a directory with data that is accessible across multiple containers in a container instance.
type ContainerVolume interface {
// The name of the volume. This must be unique within a single container instance.
GetName() *string
}
ContainerVolumeTypeEnum Enum with underlying type: string
type ContainerVolumeTypeEnum string
Set of constants representing the allowable values for ContainerVolumeTypeEnum
const (
ContainerVolumeTypeEmptydir ContainerVolumeTypeEnum = "EMPTYDIR"
ContainerVolumeTypeConfigfile ContainerVolumeTypeEnum = "CONFIGFILE"
)
func GetContainerVolumeTypeEnumValues() []ContainerVolumeTypeEnum
GetContainerVolumeTypeEnumValues Enumerates the set of values for ContainerVolumeTypeEnum
func GetMappingContainerVolumeTypeEnum(val string) (ContainerVolumeTypeEnum, bool)
GetMappingContainerVolumeTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateBasicImagePullSecretDetails A CreateBasicImagePullSecretDetails is a ImagePullSecret which accepts username and password as credentials information.
type CreateBasicImagePullSecretDetails struct {
// The registry endpoint of the container image.
RegistryEndpoint *string `mandatory:"true" json:"registryEndpoint"`
// The username which should be used with the registry for authentication. The value is expected in base64 format.
Username *string `mandatory:"true" json:"username"`
// The password which should be used with the registry for authentication. The value is expected in base64 format.
Password *string `mandatory:"true" json:"password"`
}
func (m CreateBasicImagePullSecretDetails) GetRegistryEndpoint() *string
GetRegistryEndpoint returns RegistryEndpoint
func (m CreateBasicImagePullSecretDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateBasicImagePullSecretDetails) String() string
func (m CreateBasicImagePullSecretDetails) 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
CreateContainerCommandHealthCheckDetails Container Health Check Command type.
type CreateContainerCommandHealthCheckDetails struct {
// The list of strings that will be simplified to a single command for checking the status of the container.
Command []string `mandatory:"true" json:"command"`
// Health check name.
Name *string `mandatory:"false" json:"name"`
// The initial delay in seconds before start checking container health status.
InitialDelayInSeconds *int `mandatory:"false" json:"initialDelayInSeconds"`
// Number of seconds between two consecutive runs for checking container health.
IntervalInSeconds *int `mandatory:"false" json:"intervalInSeconds"`
// Number of consecutive failures at which we consider the check failed.
FailureThreshold *int `mandatory:"false" json:"failureThreshold"`
// Number of consecutive successes at which we consider the check succeeded again after it was in failure state.
SuccessThreshold *int `mandatory:"false" json:"successThreshold"`
// Length of waiting time in seconds before marking health check failed.
TimeoutInSeconds *int `mandatory:"false" json:"timeoutInSeconds"`
// The action will be triggered when the container health check fails. There are two types of action: KILL or NONE. The default
// action is KILL. If failure action is KILL, the container will be subject to the container restart policy.
FailureAction ContainerHealthCheckFailureActionEnum `mandatory:"false" json:"failureAction,omitempty"`
}
func (m CreateContainerCommandHealthCheckDetails) GetFailureAction() ContainerHealthCheckFailureActionEnum
GetFailureAction returns FailureAction
func (m CreateContainerCommandHealthCheckDetails) GetFailureThreshold() *int
GetFailureThreshold returns FailureThreshold
func (m CreateContainerCommandHealthCheckDetails) GetInitialDelayInSeconds() *int
GetInitialDelayInSeconds returns InitialDelayInSeconds
func (m CreateContainerCommandHealthCheckDetails) GetIntervalInSeconds() *int
GetIntervalInSeconds returns IntervalInSeconds
func (m CreateContainerCommandHealthCheckDetails) GetName() *string
GetName returns Name
func (m CreateContainerCommandHealthCheckDetails) GetSuccessThreshold() *int
GetSuccessThreshold returns SuccessThreshold
func (m CreateContainerCommandHealthCheckDetails) GetTimeoutInSeconds() *int
GetTimeoutInSeconds returns TimeoutInSeconds
func (m CreateContainerCommandHealthCheckDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateContainerCommandHealthCheckDetails) String() string
func (m CreateContainerCommandHealthCheckDetails) 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
CreateContainerConfigFileVolumeDetails The configuration files to pass to the container using volume mounts.
type CreateContainerConfigFileVolumeDetails struct {
// The name of the volume. This must be unique within a single container instance.
Name *string `mandatory:"true" json:"name"`
// Contains key value pairs which can be mounted as individual files inside the container. The value needs to be base64 encoded. It is decoded to plain text before the mount.
Configs []ContainerConfigFile `mandatory:"false" json:"configs"`
}
func (m CreateContainerConfigFileVolumeDetails) GetName() *string
GetName returns Name
func (m CreateContainerConfigFileVolumeDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateContainerConfigFileVolumeDetails) String() string
func (m CreateContainerConfigFileVolumeDetails) 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
CreateContainerDetails Information to create a new container within a container instance. The container created by this call contains both the tags specified in this object and any tags specified in the parent container instance. The container is created in the same compartment, availability domain, and fault domain as its container instance.
type CreateContainerDetails struct {
// A URL identifying the image that the container runs in, such as docker.io/library/busybox:latest. If you do not provide a tag, the tag will default to latest.
// If no registry is provided, will default the registry to public docker hub `docker.io/library`.
// The registry used for container image must be reachable over the Container Instance's VNIC.
ImageUrl *string `mandatory:"true" json:"imageUrl"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
// If you don't provide a name, a name is generated automatically.
DisplayName *string `mandatory:"false" json:"displayName"`
// An optional command that overrides the ENTRYPOINT process.
// If you do not provide a value, the existing ENTRYPOINT process defined in the image is used.
Command []string `mandatory:"false" json:"command"`
// A list of string arguments for a container's ENTRYPOINT process.
// Many containers use an ENTRYPOINT process pointing to a shell
// (/bin/bash). For those containers, this argument list
// specifies the main command in the container process.
// The total size of all arguments combined must be 64 KB or smaller.
Arguments []string `mandatory:"false" json:"arguments"`
// The working directory within the container's filesystem for
// the container process. If not specified, the default
// working directory from the image is used.
WorkingDirectory *string `mandatory:"false" json:"workingDirectory"`
// A map of additional environment variables to set in the environment of the container's
// ENTRYPOINT process. These variables are in addition to any variables already defined
// in the container's image.
// The total size of all environment variables combined, name and values, must be 64 KB or smaller.
EnvironmentVariables map[string]string `mandatory:"false" json:"environmentVariables"`
// List of the volume mounts.
VolumeMounts []CreateVolumeMountDetails `mandatory:"false" json:"volumeMounts"`
// Determines if the container will have access to the container instance resource principal.
// This method utilizes resource principal version 2.2. For information on how to use the exposed resource principal elements, see
// https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdk_authentication_methods.htm#sdk_authentication_methods_resource_principal.
IsResourcePrincipalDisabled *bool `mandatory:"false" json:"isResourcePrincipalDisabled"`
ResourceConfig *CreateContainerResourceConfigDetails `mandatory:"false" json:"resourceConfig"`
// list of container health checks to check container status and take appropriate action if container status is failed.
// There are three types of health checks that we currently support HTTP, TCP, and Command.
HealthChecks []CreateContainerHealthCheckDetails `mandatory:"false" json:"healthChecks"`
SecurityContext CreateSecurityContextDetails `mandatory:"false" json:"securityContext"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`.
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateContainerDetails) String() string
func (m *CreateContainerDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateContainerDetails) 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
CreateContainerDnsConfigDetails Allow customers to define DNS settings for containers. If this is not provided, the containers use the default DNS settings of the subnet.
type CreateContainerDnsConfigDetails struct {
// IP address of a name server that the resolver should query, either an IPv4 address
// (in dot notation), or an IPv6 address in colon (and possibly dot) notation. If null, uses
// nameservers from subnet dhcpDnsOptions.
Nameservers []string `mandatory:"false" json:"nameservers"`
// Search list for host-name lookup. If null, we will use searches from subnet dhcpDnsOptios.
Searches []string `mandatory:"false" json:"searches"`
// Options allows certain internal resolver variables to be modified. Options are a list of objects in
// https://man7.org/linux/man-pages/man5/resolv.conf.5.html. Examples: ["ndots:n", "edns0"].
Options []string `mandatory:"false" json:"options"`
}
func (m CreateContainerDnsConfigDetails) String() string
func (m CreateContainerDnsConfigDetails) 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
CreateContainerEmptyDirVolumeDetails The empty directory for the container instance.
type CreateContainerEmptyDirVolumeDetails struct {
// The name of the volume. This must be unique within a single container instance.
Name *string `mandatory:"true" json:"name"`
// The volume type of the empty directory, can be either File Storage or Memory.
BackingStore ContainerEmptyDirVolumeBackingStoreEnum `mandatory:"false" json:"backingStore,omitempty"`
}
func (m CreateContainerEmptyDirVolumeDetails) GetName() *string
GetName returns Name
func (m CreateContainerEmptyDirVolumeDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateContainerEmptyDirVolumeDetails) String() string
func (m CreateContainerEmptyDirVolumeDetails) 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
CreateContainerHealthCheckDetails Container Health Check is used to check and report the status of a container.
type CreateContainerHealthCheckDetails interface {
// Health check name.
GetName() *string
// The initial delay in seconds before start checking container health status.
GetInitialDelayInSeconds() *int
// Number of seconds between two consecutive runs for checking container health.
GetIntervalInSeconds() *int
// Number of consecutive failures at which we consider the check failed.
GetFailureThreshold() *int
// Number of consecutive successes at which we consider the check succeeded again after it was in failure state.
GetSuccessThreshold() *int
// Length of waiting time in seconds before marking health check failed.
GetTimeoutInSeconds() *int
// The action will be triggered when the container health check fails. There are two types of action: KILL or NONE. The default
// action is KILL. If failure action is KILL, the container will be subject to the container restart policy.
GetFailureAction() ContainerHealthCheckFailureActionEnum
}
CreateContainerHttpHealthCheckDetails Container Health Check HTTP type.
type CreateContainerHttpHealthCheckDetails struct {
// Container health check HTTP path.
Path *string `mandatory:"true" json:"path"`
// Container health check HTTP port.
Port *int `mandatory:"true" json:"port"`
// Health check name.
Name *string `mandatory:"false" json:"name"`
// The initial delay in seconds before start checking container health status.
InitialDelayInSeconds *int `mandatory:"false" json:"initialDelayInSeconds"`
// Number of seconds between two consecutive runs for checking container health.
IntervalInSeconds *int `mandatory:"false" json:"intervalInSeconds"`
// Number of consecutive failures at which we consider the check failed.
FailureThreshold *int `mandatory:"false" json:"failureThreshold"`
// Number of consecutive successes at which we consider the check succeeded again after it was in failure state.
SuccessThreshold *int `mandatory:"false" json:"successThreshold"`
// Length of waiting time in seconds before marking health check failed.
TimeoutInSeconds *int `mandatory:"false" json:"timeoutInSeconds"`
// Container health check HTTP headers.
Headers []HealthCheckHttpHeader `mandatory:"false" json:"headers"`
// The action will be triggered when the container health check fails. There are two types of action: KILL or NONE. The default
// action is KILL. If failure action is KILL, the container will be subject to the container restart policy.
FailureAction ContainerHealthCheckFailureActionEnum `mandatory:"false" json:"failureAction,omitempty"`
}
func (m CreateContainerHttpHealthCheckDetails) GetFailureAction() ContainerHealthCheckFailureActionEnum
GetFailureAction returns FailureAction
func (m CreateContainerHttpHealthCheckDetails) GetFailureThreshold() *int
GetFailureThreshold returns FailureThreshold
func (m CreateContainerHttpHealthCheckDetails) GetInitialDelayInSeconds() *int
GetInitialDelayInSeconds returns InitialDelayInSeconds
func (m CreateContainerHttpHealthCheckDetails) GetIntervalInSeconds() *int
GetIntervalInSeconds returns IntervalInSeconds
func (m CreateContainerHttpHealthCheckDetails) GetName() *string
GetName returns Name
func (m CreateContainerHttpHealthCheckDetails) GetSuccessThreshold() *int
GetSuccessThreshold returns SuccessThreshold
func (m CreateContainerHttpHealthCheckDetails) GetTimeoutInSeconds() *int
GetTimeoutInSeconds returns TimeoutInSeconds
func (m CreateContainerHttpHealthCheckDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateContainerHttpHealthCheckDetails) String() string
func (m CreateContainerHttpHealthCheckDetails) 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
CreateContainerInstanceDetails Information to create a container instance.
type CreateContainerInstanceDetails struct {
// The compartment OCID.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The availability domain where the container instance runs.
AvailabilityDomain *string `mandatory:"true" json:"availabilityDomain"`
// The shape of the container instance. The shape determines the resources available to the container instance.
Shape *string `mandatory:"true" json:"shape"`
ShapeConfig *CreateContainerInstanceShapeConfigDetails `mandatory:"true" json:"shapeConfig"`
// The containers to create on this container instance.
Containers []CreateContainerDetails `mandatory:"true" json:"containers"`
// The networks available to containers on this container instance.
Vnics []CreateContainerVnicDetails `mandatory:"true" json:"vnics"`
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. If you don't provide a name, a name is generated automatically.
DisplayName *string `mandatory:"false" json:"displayName"`
// The fault domain where the container instance runs.
FaultDomain *string `mandatory:"false" json:"faultDomain"`
// A volume is a directory with data that is accessible across multiple containers in a
// container instance.
// You can attach up to 32 volumes to single container instance.
Volumes []CreateContainerVolumeDetails `mandatory:"false" json:"volumes"`
DnsConfig *CreateContainerDnsConfigDetails `mandatory:"false" json:"dnsConfig"`
// The amount of time that processes in a container have to gracefully end when the container must be stopped. For example, when you delete a container instance. After the timeout is reached, the processes are sent a signal to be deleted.
GracefulShutdownTimeoutInSeconds *int64 `mandatory:"false" json:"gracefulShutdownTimeoutInSeconds"`
// The image pulls secrets so you can access private registry to pull container images.
ImagePullSecrets []CreateImagePullSecretDetails `mandatory:"false" json:"imagePullSecrets"`
// Container restart policy
ContainerRestartPolicy ContainerInstanceContainerRestartPolicyEnum `mandatory:"false" json:"containerRestartPolicy,omitempty"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`.
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateContainerInstanceDetails) String() string
func (m *CreateContainerInstanceDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateContainerInstanceDetails) 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
CreateContainerInstanceRequest wrapper for the CreateContainerInstance operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/CreateContainerInstance.go.html to see an example of how to use CreateContainerInstanceRequest.
type CreateContainerInstanceRequest struct {
// Details for the new container instance.
CreateContainerInstanceDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing 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 purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
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 CreateContainerInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateContainerInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateContainerInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateContainerInstanceRequest) String() string
func (request CreateContainerInstanceRequest) 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
CreateContainerInstanceResponse wrapper for the CreateContainerInstance operation
type CreateContainerInstanceResponse struct {
// The underlying http response
RawResponse *http.Response
// The ContainerInstance instance
ContainerInstance `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 CreateContainerInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateContainerInstanceResponse) String() string
CreateContainerInstanceShapeConfigDetails The size and amount of resources available to the container instance.
type CreateContainerInstanceShapeConfigDetails struct {
// The total number of OCPUs available to the container instance.
Ocpus *float32 `mandatory:"true" json:"ocpus"`
// The total amount of memory available to the container instance (GB).
MemoryInGBs *float32 `mandatory:"false" json:"memoryInGBs"`
}
func (m CreateContainerInstanceShapeConfigDetails) String() string
func (m CreateContainerInstanceShapeConfigDetails) 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
CreateContainerResourceConfigDetails The size and amount of resources available to the container.
type CreateContainerResourceConfigDetails struct {
// The maximum amount of CPUs that can be consumed by the container's process.
// If you do not set a value, then the process
// can use all available CPU resources on the instance.
// CPU usage is defined in terms of logical CPUs. This means that the maximum possible value on
// an E3 ContainerInstance with 1 OCPU is 2.0.
// A container with a 2.0 vcpusLimit could consume up to 100% of the CPU resources available on the container instance.
// Values can be fractional. A value of "1.5" means that the container
// can consume at most the equivalent of 1 and a half logical CPUs worth of CPU capacity.
VcpusLimit *float32 `mandatory:"false" json:"vcpusLimit"`
// The maximum amount of memory that can be consumed by the container's
// process.
// If you do not set a value, then the process
// may use all available memory on the instance.
MemoryLimitInGBs *float32 `mandatory:"false" json:"memoryLimitInGBs"`
}
func (m CreateContainerResourceConfigDetails) String() string
func (m CreateContainerResourceConfigDetails) 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
CreateContainerTcpHealthCheckDetails Container Health Check TCP type.
type CreateContainerTcpHealthCheckDetails struct {
// Container health check port.
Port *int `mandatory:"true" json:"port"`
// Health check name.
Name *string `mandatory:"false" json:"name"`
// The initial delay in seconds before start checking container health status.
InitialDelayInSeconds *int `mandatory:"false" json:"initialDelayInSeconds"`
// Number of seconds between two consecutive runs for checking container health.
IntervalInSeconds *int `mandatory:"false" json:"intervalInSeconds"`
// Number of consecutive failures at which we consider the check failed.
FailureThreshold *int `mandatory:"false" json:"failureThreshold"`
// Number of consecutive successes at which we consider the check succeeded again after it was in failure state.
SuccessThreshold *int `mandatory:"false" json:"successThreshold"`
// Length of waiting time in seconds before marking health check failed.
TimeoutInSeconds *int `mandatory:"false" json:"timeoutInSeconds"`
// The action will be triggered when the container health check fails. There are two types of action: KILL or NONE. The default
// action is KILL. If failure action is KILL, the container will be subject to the container restart policy.
FailureAction ContainerHealthCheckFailureActionEnum `mandatory:"false" json:"failureAction,omitempty"`
}
func (m CreateContainerTcpHealthCheckDetails) GetFailureAction() ContainerHealthCheckFailureActionEnum
GetFailureAction returns FailureAction
func (m CreateContainerTcpHealthCheckDetails) GetFailureThreshold() *int
GetFailureThreshold returns FailureThreshold
func (m CreateContainerTcpHealthCheckDetails) GetInitialDelayInSeconds() *int
GetInitialDelayInSeconds returns InitialDelayInSeconds
func (m CreateContainerTcpHealthCheckDetails) GetIntervalInSeconds() *int
GetIntervalInSeconds returns IntervalInSeconds
func (m CreateContainerTcpHealthCheckDetails) GetName() *string
GetName returns Name
func (m CreateContainerTcpHealthCheckDetails) GetSuccessThreshold() *int
GetSuccessThreshold returns SuccessThreshold
func (m CreateContainerTcpHealthCheckDetails) GetTimeoutInSeconds() *int
GetTimeoutInSeconds returns TimeoutInSeconds
func (m CreateContainerTcpHealthCheckDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateContainerTcpHealthCheckDetails) String() string
func (m CreateContainerTcpHealthCheckDetails) 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
CreateContainerVnicDetails Information to create a virtual network interface card (VNIC) which gives the containers on this container instance access to a virtual client network (VCN). You use this object when creating the primary VNIC during container instance launch or when creating a secondary VNIC. This VNIC is created in the same compartment as the specified subnet on behalf of the customer. The VNIC created by this call contains both the tags specified in this object as well as any tags specified in the parent container instance.
type CreateContainerVnicDetails struct {
// The OCID of the subnet to create the VNIC in.
SubnetId *string `mandatory:"true" json:"subnetId"`
// A user-friendly name for the VNIC. Does not have to be unique.
// Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The hostname for the VNIC's primary private IP. Used for DNS.
HostnameLabel *string `mandatory:"false" json:"hostnameLabel"`
// Whether the VNIC should be assigned a public IP address.
IsPublicIpAssigned *bool `mandatory:"false" json:"isPublicIpAssigned"`
// Whether the source/destination check is disabled on the VNIC.
SkipSourceDestCheck *bool `mandatory:"false" json:"skipSourceDestCheck"`
// A list of the OCIDs of the network security groups (NSGs) to add the VNIC to.
NsgIds []string `mandatory:"false" json:"nsgIds"`
// A private IP address of your choice to assign to the VNIC. Must be an
// available IP address within the subnet's CIDR.
PrivateIp *string `mandatory:"false" json:"privateIp"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`.
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateContainerVnicDetails) String() string
func (m CreateContainerVnicDetails) 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
CreateContainerVolumeDetails A volume represents a directory with data that is accessible across multiple containers in a container instance.
type CreateContainerVolumeDetails interface {
// The name of the volume. This must be unique within a single container instance.
GetName() *string
}
CreateImagePullSecretDetails The image pull secrets for accessing private registry to pull images for containers
type CreateImagePullSecretDetails interface {
// The registry endpoint of the container image.
GetRegistryEndpoint() *string
}
CreateImagePullSecretDetailsSecretTypeEnum Enum with underlying type: string
type CreateImagePullSecretDetailsSecretTypeEnum string
Set of constants representing the allowable values for CreateImagePullSecretDetailsSecretTypeEnum
const (
CreateImagePullSecretDetailsSecretTypeBasic CreateImagePullSecretDetailsSecretTypeEnum = "BASIC"
CreateImagePullSecretDetailsSecretTypeVault CreateImagePullSecretDetailsSecretTypeEnum = "VAULT"
)
func GetCreateImagePullSecretDetailsSecretTypeEnumValues() []CreateImagePullSecretDetailsSecretTypeEnum
GetCreateImagePullSecretDetailsSecretTypeEnumValues Enumerates the set of values for CreateImagePullSecretDetailsSecretTypeEnum
func GetMappingCreateImagePullSecretDetailsSecretTypeEnum(val string) (CreateImagePullSecretDetailsSecretTypeEnum, bool)
GetMappingCreateImagePullSecretDetailsSecretTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateLinuxSecurityContextDetails Security context for Linux container.
type CreateLinuxSecurityContextDetails struct {
// The user ID (UID) to run the entrypoint process of the container. Defaults to user specified UID in container image metadata if not provided. This must be provided if runAsGroup is provided.
RunAsUser *int `mandatory:"false" json:"runAsUser"`
// The group ID (GID) to run the entrypoint process of the container. Uses runtime default if not provided.
RunAsGroup *int `mandatory:"false" json:"runAsGroup"`
// Indicates if the container must run as a non-root user. If true, the service validates the container image at runtime to ensure that it is not going to run with UID 0 (root) and fails the container instance creation if the validation fails.
IsNonRootUserCheckEnabled *bool `mandatory:"false" json:"isNonRootUserCheckEnabled"`
// Determines if the container will have a read-only root file system. Default value is false.
IsRootFileSystemReadonly *bool `mandatory:"false" json:"isRootFileSystemReadonly"`
Capabilities *ContainerCapabilities `mandatory:"false" json:"capabilities"`
}
func (m CreateLinuxSecurityContextDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateLinuxSecurityContextDetails) String() string
func (m CreateLinuxSecurityContextDetails) 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
CreateSecurityContextDetails Security context for container.
type CreateSecurityContextDetails interface {
}
CreateVaultImagePullSecretDetails A CreateVaultImagePullSecretDetails is a ImagePullSecret which accepts secretId as credentials information. **Sample Format for username and password in Vault Secret** “`
{
"username": "this-is-not-the-secret",
"password": "example-password"
}
“`
type CreateVaultImagePullSecretDetails struct {
// The registry endpoint of the container image.
RegistryEndpoint *string `mandatory:"true" json:"registryEndpoint"`
// The OCID of the secret for registry credentials.
SecretId *string `mandatory:"true" json:"secretId"`
}
func (m CreateVaultImagePullSecretDetails) GetRegistryEndpoint() *string
GetRegistryEndpoint returns RegistryEndpoint
func (m CreateVaultImagePullSecretDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateVaultImagePullSecretDetails) String() string
func (m CreateVaultImagePullSecretDetails) 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
CreateVolumeMountDetails Defines the mapping from volume to a mount path in a container.
type CreateVolumeMountDetails struct {
// The volume access path.
MountPath *string `mandatory:"true" json:"mountPath"`
// The name of the volume. Avoid entering confidential information.
VolumeName *string `mandatory:"true" json:"volumeName"`
// A subpath inside the referenced volume.
SubPath *string `mandatory:"false" json:"subPath"`
// Whether the volume was mounted in read-only mode. By default, the volume is not read-only.
IsReadOnly *bool `mandatory:"false" json:"isReadOnly"`
// If there is more than one partition in the volume, reference this number of partitions.
// Here is an example:
// Number Start End Size File system Name Flags
// 1 1049kB 106MB 105MB fat16 EFI System Partition boot, esp
// 2 106MB 1180MB 1074MB xfs
// 3 1180MB 50.0GB 48.8GB lvm
Partition *int `mandatory:"false" json:"partition"`
}
func (m CreateVolumeMountDetails) String() string
func (m CreateVolumeMountDetails) 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
DeleteContainerInstanceRequest wrapper for the DeleteContainerInstance operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/DeleteContainerInstance.go.html to see an example of how to use DeleteContainerInstanceRequest.
type DeleteContainerInstanceRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container instance.
ContainerInstanceId *string `mandatory:"true" contributesTo:"path" name:"containerInstanceId"`
// 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 will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
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 DeleteContainerInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteContainerInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteContainerInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteContainerInstanceRequest) String() string
func (request DeleteContainerInstanceRequest) 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
DeleteContainerInstanceResponse wrapper for the DeleteContainerInstance operation
type DeleteContainerInstanceResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 DeleteContainerInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteContainerInstanceResponse) String() string
GetContainerInstanceRequest wrapper for the GetContainerInstance operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/GetContainerInstance.go.html to see an example of how to use GetContainerInstanceRequest.
type GetContainerInstanceRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container instance.
ContainerInstanceId *string `mandatory:"true" contributesTo:"path" name:"containerInstanceId"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
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 GetContainerInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetContainerInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetContainerInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetContainerInstanceRequest) String() string
func (request GetContainerInstanceRequest) 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
GetContainerInstanceResponse wrapper for the GetContainerInstance operation
type GetContainerInstanceResponse struct {
// The underlying http response
RawResponse *http.Response
// The ContainerInstance instance
ContainerInstance `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 GetContainerInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetContainerInstanceResponse) String() string
GetContainerRequest wrapper for the GetContainer operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/GetContainer.go.html to see an example of how to use GetContainerRequest.
type GetContainerRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container.
ContainerId *string `mandatory:"true" contributesTo:"path" name:"containerId"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
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 GetContainerRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetContainerRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetContainerRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetContainerRequest) String() string
func (request GetContainerRequest) 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
GetContainerResponse wrapper for the GetContainer operation
type GetContainerResponse struct {
// The underlying http response
RawResponse *http.Response
// The Container instance
Container `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 GetContainerResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetContainerResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
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 GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
func (request GetWorkRequestRequest) 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
GetWorkRequestResponse wrapper for the GetWorkRequest operation
type GetWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The WorkRequest instance
WorkRequest `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"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *int `presentIn:"header" name:"retry-after"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
HealthCheckHttpHeader Container Http headers for Http health check.
type HealthCheckHttpHeader struct {
// Container HTTP header Key.
Name *string `mandatory:"true" json:"name"`
// Container HTTP header value.
Value *string `mandatory:"true" json:"value"`
}
func (m HealthCheckHttpHeader) String() string
func (m HealthCheckHttpHeader) 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
ImagePullSecret The image pull secrets for accessing private registry to pull images for containers
type ImagePullSecret interface {
// The registry endpoint of the container image.
GetRegistryEndpoint() *string
}
ImagePullSecretSecretTypeEnum Enum with underlying type: string
type ImagePullSecretSecretTypeEnum string
Set of constants representing the allowable values for ImagePullSecretSecretTypeEnum
const (
ImagePullSecretSecretTypeBasic ImagePullSecretSecretTypeEnum = "BASIC"
ImagePullSecretSecretTypeVault ImagePullSecretSecretTypeEnum = "VAULT"
)
func GetImagePullSecretSecretTypeEnumValues() []ImagePullSecretSecretTypeEnum
GetImagePullSecretSecretTypeEnumValues Enumerates the set of values for ImagePullSecretSecretTypeEnum
func GetMappingImagePullSecretSecretTypeEnum(val string) (ImagePullSecretSecretTypeEnum, bool)
GetMappingImagePullSecretSecretTypeEnum performs case Insensitive comparison on enum value and return the desired enum
LinuxSecurityContext Security context for Linux container.
type LinuxSecurityContext struct {
// The user ID (UID) to run the entrypoint process of the container. Defaults to user specified UID in container image metadata if not provided. This must be provided if runAsGroup is provided.
RunAsUser *int `mandatory:"false" json:"runAsUser"`
// The group ID (GID) to run the entrypoint process of the container. Uses runtime default if not provided.
RunAsGroup *int `mandatory:"false" json:"runAsGroup"`
// Indicates if the container must run as a non-root user. If true, the service validates the container image at runtime to ensure that it is not going to run with UID 0 (root) and fails the container instance creation if the validation fails.
IsNonRootUserCheckEnabled *bool `mandatory:"false" json:"isNonRootUserCheckEnabled"`
// Determines if the container will have a read-only root file system. Default value is false.
IsRootFileSystemReadonly *bool `mandatory:"false" json:"isRootFileSystemReadonly"`
Capabilities *ContainerCapabilities `mandatory:"false" json:"capabilities"`
}
func (m LinuxSecurityContext) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m LinuxSecurityContext) String() string
func (m LinuxSecurityContext) 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
ListContainerInstanceShapesRequest wrapper for the ListContainerInstanceShapes operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/ListContainerInstanceShapes.go.html to see an example of how to use ListContainerInstanceShapesRequest.
type ListContainerInstanceShapesRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The name of the availability domain.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"false" contributesTo:"query" name:"availabilityDomain"`
// For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"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 `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 ListContainerInstanceShapesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListContainerInstanceShapesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListContainerInstanceShapesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListContainerInstanceShapesRequest) String() string
func (request ListContainerInstanceShapesRequest) 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
ListContainerInstanceShapesResponse wrapper for the ListContainerInstanceShapes operation
type ListContainerInstanceShapesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ContainerInstanceShapeCollection instances
ContainerInstanceShapeCollection `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"`
// Pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListContainerInstanceShapesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListContainerInstanceShapesResponse) String() string
ListContainerInstancesRequest wrapper for the ListContainerInstances operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/ListContainerInstances.go.html to see an example of how to use ListContainerInstancesRequest.
type ListContainerInstancesRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to only return resources that match the given lifecycle state.
LifecycleState ContainerInstanceLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The name of the availability domain.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"false" contributesTo:"query" name:"availabilityDomain"`
// For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"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 `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The sort order to use (ASC) or (DESC).
SortOrder ListContainerInstancesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order. Default order for timeCreated is descending. Default order for displayName is ascending. If you don't specify a value, timeCreated is the default.
SortBy ListContainerInstancesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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 ListContainerInstancesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListContainerInstancesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListContainerInstancesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListContainerInstancesRequest) String() string
func (request ListContainerInstancesRequest) 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
ListContainerInstancesResponse wrapper for the ListContainerInstances operation
type ListContainerInstancesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ContainerInstanceCollection instances
ContainerInstanceCollection `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"`
// Pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListContainerInstancesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListContainerInstancesResponse) String() string
ListContainerInstancesSortByEnum Enum with underlying type: string
type ListContainerInstancesSortByEnum string
Set of constants representing the allowable values for ListContainerInstancesSortByEnum
const (
ListContainerInstancesSortByTimecreated ListContainerInstancesSortByEnum = "timeCreated"
ListContainerInstancesSortByDisplayname ListContainerInstancesSortByEnum = "displayName"
)
func GetListContainerInstancesSortByEnumValues() []ListContainerInstancesSortByEnum
GetListContainerInstancesSortByEnumValues Enumerates the set of values for ListContainerInstancesSortByEnum
func GetMappingListContainerInstancesSortByEnum(val string) (ListContainerInstancesSortByEnum, bool)
GetMappingListContainerInstancesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListContainerInstancesSortOrderEnum Enum with underlying type: string
type ListContainerInstancesSortOrderEnum string
Set of constants representing the allowable values for ListContainerInstancesSortOrderEnum
const (
ListContainerInstancesSortOrderAsc ListContainerInstancesSortOrderEnum = "ASC"
ListContainerInstancesSortOrderDesc ListContainerInstancesSortOrderEnum = "DESC"
)
func GetListContainerInstancesSortOrderEnumValues() []ListContainerInstancesSortOrderEnum
GetListContainerInstancesSortOrderEnumValues Enumerates the set of values for ListContainerInstancesSortOrderEnum
func GetMappingListContainerInstancesSortOrderEnum(val string) (ListContainerInstancesSortOrderEnum, bool)
GetMappingListContainerInstancesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListContainersRequest wrapper for the ListContainers operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/ListContainers.go.html to see an example of how to use ListContainersRequest.
type ListContainersRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to only return resources that match the given lifecycle state.
LifecycleState ContainerLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container instance.
ContainerInstanceId *string `mandatory:"false" contributesTo:"query" name:"containerInstanceId"`
// The name of the availability domain.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"false" contributesTo:"query" name:"availabilityDomain"`
// For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"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 `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The sort order to use (ASC) or (DESC).
SortOrder ListContainersSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order. Default order for timeCreated is descending. Default order for displayName is ascending. If you don't specify a value, timeCreated is the default.
SortBy ListContainersSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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 ListContainersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListContainersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListContainersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListContainersRequest) String() string
func (request ListContainersRequest) 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
ListContainersResponse wrapper for the ListContainers operation
type ListContainersResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ContainerCollection instances
ContainerCollection `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"`
// Pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListContainersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListContainersResponse) String() string
ListContainersSortByEnum Enum with underlying type: string
type ListContainersSortByEnum string
Set of constants representing the allowable values for ListContainersSortByEnum
const (
ListContainersSortByTimecreated ListContainersSortByEnum = "timeCreated"
ListContainersSortByDisplayname ListContainersSortByEnum = "displayName"
)
func GetListContainersSortByEnumValues() []ListContainersSortByEnum
GetListContainersSortByEnumValues Enumerates the set of values for ListContainersSortByEnum
func GetMappingListContainersSortByEnum(val string) (ListContainersSortByEnum, bool)
GetMappingListContainersSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListContainersSortOrderEnum Enum with underlying type: string
type ListContainersSortOrderEnum string
Set of constants representing the allowable values for ListContainersSortOrderEnum
const (
ListContainersSortOrderAsc ListContainersSortOrderEnum = "ASC"
ListContainersSortOrderDesc ListContainersSortOrderEnum = "DESC"
)
func GetListContainersSortOrderEnumValues() []ListContainersSortOrderEnum
GetListContainersSortOrderEnumValues Enumerates the set of values for ListContainersSortOrderEnum
func GetMappingListContainersSortOrderEnum(val string) (ListContainersSortOrderEnum, bool)
GetMappingListContainersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. You can provide one sort order. Default order for timestamp is descending.
SortBy ListWorkRequestErrorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either ascending (ASC) or descending (DESC).
SortOrder ListWorkRequestErrorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// 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 ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
func (request ListWorkRequestErrorsRequest) 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
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
type ListWorkRequestErrorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestErrorCollection instances
WorkRequestErrorCollection `presentIn:"body"`
// Pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
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 ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestErrorsSortByEnum Enum with underlying type: string
type ListWorkRequestErrorsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum
const (
ListWorkRequestErrorsSortByTimestamp ListWorkRequestErrorsSortByEnum = "timestamp"
)
func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum
GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum
func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)
GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string
type ListWorkRequestErrorsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum
const (
ListWorkRequestErrorsSortOrderAsc ListWorkRequestErrorsSortOrderEnum = "ASC"
ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)
func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum
func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)
GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. You can provide one sort order. Default order for timestamp is descending.
SortBy ListWorkRequestLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either ascending (ASC) or descending (DESC).
SortOrder ListWorkRequestLogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// 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 ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
func (request ListWorkRequestLogsRequest) 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
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
type ListWorkRequestLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestLogEntryCollection instances
WorkRequestLogEntryCollection `presentIn:"body"`
// Pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
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 ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestLogsSortByEnum Enum with underlying type: string
type ListWorkRequestLogsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum
const (
ListWorkRequestLogsSortByTimestamp ListWorkRequestLogsSortByEnum = "timestamp"
)
func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum
func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)
GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsSortOrderEnum Enum with underlying type: string
type ListWorkRequestLogsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum
const (
ListWorkRequestLogsSortOrderAsc ListWorkRequestLogsSortOrderEnum = "ASC"
ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)
func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum
func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)
GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The ID of the asynchronous work request.
WorkRequestId *string `mandatory:"false" contributesTo:"query" name:"workRequestId"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The name of the availability domain.
// Example: `Uocm:PHX-AD-1`
AvailabilityDomain *string `mandatory:"false" contributesTo:"query" name:"availabilityDomain"`
// A filter to return resources with a lifecycleState that matches the given OperationStatus.
Status ListWorkRequestsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`
// The field to sort by. You can provide one sort order. Default order for timeAccepted is descending.
SortBy ListWorkRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either ascending (ASC) or descending (DESC).
SortOrder ListWorkRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The OCID of the resource affected by the work request.
ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`
// 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 ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
func (request ListWorkRequestsRequest) 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
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestSummaryCollection instances
WorkRequestSummaryCollection `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"`
// Pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
ListWorkRequestsSortByEnum Enum with underlying type: string
type ListWorkRequestsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestsSortByEnum
const (
ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)
func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum
func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)
GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsSortOrderEnum Enum with underlying type: string
type ListWorkRequestsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum
const (
ListWorkRequestsSortOrderAsc ListWorkRequestsSortOrderEnum = "ASC"
ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)
func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum
func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)
GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsStatusEnum Enum with underlying type: string
type ListWorkRequestsStatusEnum string
Set of constants representing the allowable values for ListWorkRequestsStatusEnum
const (
ListWorkRequestsStatusAccepted ListWorkRequestsStatusEnum = "ACCEPTED"
ListWorkRequestsStatusInProgress ListWorkRequestsStatusEnum = "IN_PROGRESS"
ListWorkRequestsStatusFailed ListWorkRequestsStatusEnum = "FAILED"
ListWorkRequestsStatusSucceeded ListWorkRequestsStatusEnum = "SUCCEEDED"
ListWorkRequestsStatusCanceling ListWorkRequestsStatusEnum = "CANCELING"
ListWorkRequestsStatusCanceled ListWorkRequestsStatusEnum = "CANCELED"
)
func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum
GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum
func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)
GetMappingListWorkRequestsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
OperationStatusEnum Enum with underlying type: string
type OperationStatusEnum string
Set of constants representing the allowable values for OperationStatusEnum
const (
OperationStatusAccepted OperationStatusEnum = "ACCEPTED"
OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusCanceling OperationStatusEnum = "CANCELING"
OperationStatusCanceled OperationStatusEnum = "CANCELED"
)
func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationStatusEnumValues() []OperationStatusEnum
GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum
OperationTypeEnum Enum with underlying type: string
type OperationTypeEnum string
Set of constants representing the allowable values for OperationTypeEnum
const (
OperationTypeCreateContainerInstance OperationTypeEnum = "CREATE_CONTAINER_INSTANCE"
OperationTypeUpdateContainerInstance OperationTypeEnum = "UPDATE_CONTAINER_INSTANCE"
OperationTypeDeleteContainerInstance OperationTypeEnum = "DELETE_CONTAINER_INSTANCE"
OperationTypeMoveContainerInstance OperationTypeEnum = "MOVE_CONTAINER_INSTANCE"
OperationTypeStartContainerInstance OperationTypeEnum = "START_CONTAINER_INSTANCE"
OperationTypeStopContainerInstance OperationTypeEnum = "STOP_CONTAINER_INSTANCE"
OperationTypeRestartContainerInstance OperationTypeEnum = "RESTART_CONTAINER_INSTANCE"
OperationTypeUpdateContainer OperationTypeEnum = "UPDATE_CONTAINER"
)
func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)
GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationTypeEnumValues() []OperationTypeEnum
GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum
RestartContainerInstanceRequest wrapper for the RestartContainerInstance operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/RestartContainerInstance.go.html to see an example of how to use RestartContainerInstanceRequest.
type RestartContainerInstanceRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container instance.
ContainerInstanceId *string `mandatory:"true" contributesTo:"path" name:"containerInstanceId"`
// 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 will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
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 RestartContainerInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RestartContainerInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RestartContainerInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RestartContainerInstanceRequest) String() string
func (request RestartContainerInstanceRequest) 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
RestartContainerInstanceResponse wrapper for the RestartContainerInstance operation
type RestartContainerInstanceResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 RestartContainerInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RestartContainerInstanceResponse) String() string
RetrieveLogsRequest wrapper for the RetrieveLogs operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/RetrieveLogs.go.html to see an example of how to use RetrieveLogsRequest.
type RetrieveLogsRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container.
ContainerId *string `mandatory:"true" contributesTo:"path" name:"containerId"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Returns the logs for the previous run of the container in a pod.
// If the container fails, this parameter can help you to determine the root cause of the failure.
IsPrevious *bool `mandatory:"false" contributesTo:"query" name:"isPrevious"`
// 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 RetrieveLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RetrieveLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RetrieveLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RetrieveLogsRequest) String() string
func (request RetrieveLogsRequest) 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
RetrieveLogsResponse wrapper for the RetrieveLogs operation
type RetrieveLogsResponse 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 RetrieveLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RetrieveLogsResponse) String() string
SecurityContext Security context for container.
type SecurityContext interface {
}
SecurityContextSecurityContextTypeEnum Enum with underlying type: string
type SecurityContextSecurityContextTypeEnum string
Set of constants representing the allowable values for SecurityContextSecurityContextTypeEnum
const (
SecurityContextSecurityContextTypeLinux SecurityContextSecurityContextTypeEnum = "LINUX"
)
func GetMappingSecurityContextSecurityContextTypeEnum(val string) (SecurityContextSecurityContextTypeEnum, bool)
GetMappingSecurityContextSecurityContextTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSecurityContextSecurityContextTypeEnumValues() []SecurityContextSecurityContextTypeEnum
GetSecurityContextSecurityContextTypeEnumValues Enumerates the set of values for SecurityContextSecurityContextTypeEnum
ShapeMemoryOptions For a flexible shape, the amount of memory available for container instances that use this shape.
type ShapeMemoryOptions struct {
// The minimum amount of memory (GB).
MinInGBs *float32 `mandatory:"true" json:"minInGBs"`
// The maximum amount of memory (GB).
MaxInGBs *float32 `mandatory:"true" json:"maxInGBs"`
// The default amount of memory per OCPU available for this shape (GB).
DefaultPerOcpuInGBs *float32 `mandatory:"true" json:"defaultPerOcpuInGBs"`
// The minimum amount of memory per OCPU available for this shape (GB).
MinPerOcpuInGBs *float32 `mandatory:"true" json:"minPerOcpuInGBs"`
// The maximum amount of memory per OCPU available for this shape (GB).
MaxPerOcpuInGBs *float32 `mandatory:"true" json:"maxPerOcpuInGBs"`
}
func (m ShapeMemoryOptions) String() string
func (m ShapeMemoryOptions) 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
ShapeNetworkingBandwidthOptions For a flexible shape, the amount of networking bandwidth available for container instances that use this shape.
type ShapeNetworkingBandwidthOptions struct {
// The minimum amount of networking bandwidth, in gigabits per second.
MinInGbps *float32 `mandatory:"true" json:"minInGbps"`
// The maximum amount of networking bandwidth, in gigabits per second.
MaxInGbps *float32 `mandatory:"true" json:"maxInGbps"`
// The default amount of networking bandwidth per OCPU, in gigabits per second.
DefaultPerOcpuInGbps *float32 `mandatory:"true" json:"defaultPerOcpuInGbps"`
}
func (m ShapeNetworkingBandwidthOptions) String() string
func (m ShapeNetworkingBandwidthOptions) 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
ShapeOcpuOptions For a flexible shape, the number of OCPUs available for container instances that use this shape.
type ShapeOcpuOptions struct {
// The minimum number of OCPUs.
Min *float32 `mandatory:"true" json:"min"`
// The maximum number of OCPUs.
Max *float32 `mandatory:"true" json:"max"`
}
func (m ShapeOcpuOptions) String() string
func (m ShapeOcpuOptions) 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
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
StartContainerInstanceRequest wrapper for the StartContainerInstance operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/StartContainerInstance.go.html to see an example of how to use StartContainerInstanceRequest.
type StartContainerInstanceRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container instance.
ContainerInstanceId *string `mandatory:"true" contributesTo:"path" name:"containerInstanceId"`
// 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 will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
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 StartContainerInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StartContainerInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StartContainerInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StartContainerInstanceRequest) String() string
func (request StartContainerInstanceRequest) 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
StartContainerInstanceResponse wrapper for the StartContainerInstance operation
type StartContainerInstanceResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 StartContainerInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StartContainerInstanceResponse) String() string
StopContainerInstanceRequest wrapper for the StopContainerInstance operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/StopContainerInstance.go.html to see an example of how to use StopContainerInstanceRequest.
type StopContainerInstanceRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container instance.
ContainerInstanceId *string `mandatory:"true" contributesTo:"path" name:"containerInstanceId"`
// 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 will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
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 StopContainerInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StopContainerInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StopContainerInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StopContainerInstanceRequest) String() string
func (request StopContainerInstanceRequest) 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
StopContainerInstanceResponse wrapper for the StopContainerInstance operation
type StopContainerInstanceResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 StopContainerInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StopContainerInstanceResponse) String() string
UpdateContainerDetails The container information to be updated.
type UpdateContainerDetails struct {
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`.
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateContainerDetails) String() string
func (m UpdateContainerDetails) 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
UpdateContainerInstanceDetails The information to be updated.
type UpdateContainerInstanceDetails struct {
// A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`.
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateContainerInstanceDetails) String() string
func (m UpdateContainerInstanceDetails) 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
UpdateContainerInstanceRequest wrapper for the UpdateContainerInstance operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/UpdateContainerInstance.go.html to see an example of how to use UpdateContainerInstanceRequest.
type UpdateContainerInstanceRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container instance.
ContainerInstanceId *string `mandatory:"true" contributesTo:"path" name:"containerInstanceId"`
// The information to be updated.
UpdateContainerInstanceDetails `contributesTo:"body"`
// 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 will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
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 UpdateContainerInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateContainerInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateContainerInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateContainerInstanceRequest) String() string
func (request UpdateContainerInstanceRequest) 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
UpdateContainerInstanceResponse wrapper for the UpdateContainerInstance operation
type UpdateContainerInstanceResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 UpdateContainerInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateContainerInstanceResponse) String() string
UpdateContainerRequest wrapper for the UpdateContainer operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.63.2/containerinstances/UpdateContainer.go.html to see an example of how to use UpdateContainerRequest.
type UpdateContainerRequest struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container.
ContainerId *string `mandatory:"true" contributesTo:"path" name:"containerId"`
// The information to be updated.
UpdateContainerDetails `contributesTo:"body"`
// 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 will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
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 UpdateContainerRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateContainerRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateContainerRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateContainerRequest) String() string
func (request UpdateContainerRequest) 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
UpdateContainerResponse wrapper for the UpdateContainer operation
type UpdateContainerResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// 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 UpdateContainerResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateContainerResponse) String() string
VaultImagePullSecret A VaultImagePullSecret is a ImagePullSecret which accepts secretId as credentials information.
type VaultImagePullSecret struct {
// The registry endpoint of the container image.
RegistryEndpoint *string `mandatory:"true" json:"registryEndpoint"`
// The OCID of the secret for registry credentials.
SecretId *string `mandatory:"true" json:"secretId"`
}
func (m VaultImagePullSecret) GetRegistryEndpoint() *string
GetRegistryEndpoint returns RegistryEndpoint
func (m VaultImagePullSecret) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m VaultImagePullSecret) String() string
func (m VaultImagePullSecret) 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
VolumeMount Define the mapping from volume to a mount path in container.
type VolumeMount struct {
// Describes the volume access path.
MountPath *string `mandatory:"true" json:"mountPath"`
// The name of the volume.
VolumeName *string `mandatory:"true" json:"volumeName"`
// A sub-path inside the referenced volume.
SubPath *string `mandatory:"false" json:"subPath"`
// Whether the volume was mounted in read-only mode. By default, the volume is mounted with write access.
IsReadOnly *bool `mandatory:"false" json:"isReadOnly"`
// If there is more than one partition in the volume, reference this number of partitions.
// Here is an example:
// Number Start End Size File system Name Flags
// 1 1049kB 106MB 105MB fat16 EFI System Partition boot, esp
// 2 106MB 1180MB 1074MB xfs
// 3 1180MB 50.0GB 48.8GB lvm
Partition *int `mandatory:"false" json:"partition"`
}
func (m VolumeMount) String() string
func (m VolumeMount) 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
WorkRequest A description of the work request status.
type WorkRequest struct {
// Type of work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// Status of current work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The ID of the work request.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment that contains the work request. Work requests should be scoped to
// the same compartment as the resource the work request affects.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources affected by this work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Percentage of the request completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the request was created, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 14.29.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequest) String() string
func (m WorkRequest) 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
WorkRequestError An error encountered while executing a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occured. See API Errors (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm) for a list of error codes.
Code *string `mandatory:"true" json:"code"`
// A description of the issue encountered.
Message *string `mandatory:"true" json:"message"`
// The time the error occured, in the format defined by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestError) String() string
func (m WorkRequestError) 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
WorkRequestErrorCollection Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.
type WorkRequestErrorCollection struct {
// List of workRequestError objects.
Items []WorkRequestError `mandatory:"true" json:"items"`
}
func (m WorkRequestErrorCollection) String() string
func (m WorkRequestErrorCollection) 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
WorkRequestLogEntry A log message from a work request.
type WorkRequestLogEntry struct {
// Human-readable log message.
Message *string `mandatory:"true" json:"message"`
// The time the log message was written, in the format defined by RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestLogEntry) String() string
func (m WorkRequestLogEntry) 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
WorkRequestLogEntryCollection Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.
type WorkRequestLogEntryCollection struct {
// List of workRequestLogEntries.
Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}
func (m WorkRequestLogEntryCollection) String() string
func (m WorkRequestLogEntryCollection) 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
WorkRequestResource A resource created or operated on by a work request.
type WorkRequestResource struct {
// The resource type the work request affects.
EntityType *string `mandatory:"true" json:"entityType"`
// The way in which this resource is affected by the work tracked in the work request.
// A resource being created, updated, or deleted remains in the IN_PROGRESS state until
// work is complete for that resource, at which point it updates to CREATED, UPDATED,
// or DELETED, respectively.
ActionType ActionTypeEnum `mandatory:"true" json:"actionType"`
// The ID of the resource the work request affects.
Identifier *string `mandatory:"true" json:"identifier"`
// The URI path that the user can do a GET on to access the resource metadata.
EntityUri *string `mandatory:"false" json:"entityUri"`
}
func (m WorkRequestResource) String() string
func (m WorkRequestResource) 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
WorkRequestSummary A summary of the status of a work request.
type WorkRequestSummary struct {
// Type of work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// Status of current work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The ID of the work request.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment that contains the work request. Work requests should be scoped to
// the same compartment as the resource the work request affects.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources affected by this work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Percentage of the request completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the request was created, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 14.29.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequestSummary) String() string
func (m WorkRequestSummary) 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
WorkRequestSummaryCollection Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.
type WorkRequestSummaryCollection struct {
// List of workRequestSummary objects.
Items []WorkRequestSummary `mandatory:"true" json:"items"`
}
func (m WorkRequestSummaryCollection) String() string
func (m WorkRequestSummaryCollection) 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