containerinstances

package
v65.67.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 11, 2024 License: Apache-2.0, UPL-1.0 Imports: 8 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetActionTypeEnumStringValues

func GetActionTypeEnumStringValues() []string

GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum

func GetContainerCapabilityEnumStringValues

func GetContainerCapabilityEnumStringValues() []string

GetContainerCapabilityEnumStringValues Enumerates the set of values in String for ContainerCapabilityEnum

func GetContainerCapabilityTypeEnumStringValues added in v65.61.0

func GetContainerCapabilityTypeEnumStringValues() []string

GetContainerCapabilityTypeEnumStringValues Enumerates the set of values in String for ContainerCapabilityTypeEnum

func GetContainerEmptyDirVolumeBackingStoreEnumStringValues

func GetContainerEmptyDirVolumeBackingStoreEnumStringValues() []string

GetContainerEmptyDirVolumeBackingStoreEnumStringValues Enumerates the set of values in String for ContainerEmptyDirVolumeBackingStoreEnum

func GetContainerHealthCheckFailureActionEnumStringValues

func GetContainerHealthCheckFailureActionEnumStringValues() []string

GetContainerHealthCheckFailureActionEnumStringValues Enumerates the set of values in String for ContainerHealthCheckFailureActionEnum

func GetContainerHealthCheckStatusEnumStringValues

func GetContainerHealthCheckStatusEnumStringValues() []string

GetContainerHealthCheckStatusEnumStringValues Enumerates the set of values in String for ContainerHealthCheckStatusEnum

func GetContainerHealthCheckTypeEnumStringValues

func GetContainerHealthCheckTypeEnumStringValues() []string

GetContainerHealthCheckTypeEnumStringValues Enumerates the set of values in String for ContainerHealthCheckTypeEnum

func GetContainerInstanceContainerRestartPolicyEnumStringValues

func GetContainerInstanceContainerRestartPolicyEnumStringValues() []string

GetContainerInstanceContainerRestartPolicyEnumStringValues Enumerates the set of values in String for ContainerInstanceContainerRestartPolicyEnum

func GetContainerInstanceLifecycleStateEnumStringValues

func GetContainerInstanceLifecycleStateEnumStringValues() []string

GetContainerInstanceLifecycleStateEnumStringValues Enumerates the set of values in String for ContainerInstanceLifecycleStateEnum

func GetContainerLifecycleStateEnumStringValues

func GetContainerLifecycleStateEnumStringValues() []string

GetContainerLifecycleStateEnumStringValues Enumerates the set of values in String for ContainerLifecycleStateEnum

func GetContainerVolumeTypeEnumStringValues

func GetContainerVolumeTypeEnumStringValues() []string

GetContainerVolumeTypeEnumStringValues Enumerates the set of values in String for ContainerVolumeTypeEnum

func GetCreateImagePullSecretDetailsSecretTypeEnumStringValues

func GetCreateImagePullSecretDetailsSecretTypeEnumStringValues() []string

GetCreateImagePullSecretDetailsSecretTypeEnumStringValues Enumerates the set of values in String for CreateImagePullSecretDetailsSecretTypeEnum

func GetImagePullSecretSecretTypeEnumStringValues

func GetImagePullSecretSecretTypeEnumStringValues() []string

GetImagePullSecretSecretTypeEnumStringValues Enumerates the set of values in String for ImagePullSecretSecretTypeEnum

func GetListContainerInstancesSortByEnumStringValues

func GetListContainerInstancesSortByEnumStringValues() []string

GetListContainerInstancesSortByEnumStringValues Enumerates the set of values in String for ListContainerInstancesSortByEnum

func GetListContainerInstancesSortOrderEnumStringValues

func GetListContainerInstancesSortOrderEnumStringValues() []string

GetListContainerInstancesSortOrderEnumStringValues Enumerates the set of values in String for ListContainerInstancesSortOrderEnum

func GetListContainersSortByEnumStringValues

func GetListContainersSortByEnumStringValues() []string

GetListContainersSortByEnumStringValues Enumerates the set of values in String for ListContainersSortByEnum

func GetListContainersSortOrderEnumStringValues

func GetListContainersSortOrderEnumStringValues() []string

GetListContainersSortOrderEnumStringValues Enumerates the set of values in String for ListContainersSortOrderEnum

func GetListWorkRequestErrorsSortByEnumStringValues added in v65.49.0

func GetListWorkRequestErrorsSortByEnumStringValues() []string

GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortOrderEnumStringValues added in v65.49.0

func GetListWorkRequestErrorsSortOrderEnumStringValues() []string

GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestLogsSortByEnumStringValues added in v65.49.0

func GetListWorkRequestLogsSortByEnumStringValues() []string

GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortOrderEnumStringValues added in v65.49.0

func GetListWorkRequestLogsSortOrderEnumStringValues() []string

GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestsSortByEnumStringValues added in v65.49.0

func GetListWorkRequestsSortByEnumStringValues() []string

GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortOrderEnumStringValues added in v65.49.0

func GetListWorkRequestsSortOrderEnumStringValues() []string

GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsStatusEnumStringValues added in v65.49.0

func GetListWorkRequestsStatusEnumStringValues() []string

GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum

func GetOperationStatusEnumStringValues

func GetOperationStatusEnumStringValues() []string

GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum

func GetOperationTypeEnumStringValues

func GetOperationTypeEnumStringValues() []string

GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum

func GetSecurityContextSecurityContextTypeEnumStringValues added in v65.47.1

func GetSecurityContextSecurityContextTypeEnumStringValues() []string

GetSecurityContextSecurityContextTypeEnumStringValues Enumerates the set of values in String for SecurityContextSecurityContextTypeEnum

func GetSortOrderEnumStringValues

func GetSortOrderEnumStringValues() []string

GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum

Types

type ActionTypeEnum

type ActionTypeEnum string

ActionTypeEnum Enum with underlying type: string

const (
	ActionTypeCreated    ActionTypeEnum = "CREATED"
	ActionTypeUpdated    ActionTypeEnum = "UPDATED"
	ActionTypeDeleted    ActionTypeEnum = "DELETED"
	ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
	ActionTypeRelated    ActionTypeEnum = "RELATED"
	ActionTypeFailed     ActionTypeEnum = "FAILED"
)

Set of constants representing the allowable values for ActionTypeEnum

func GetActionTypeEnumValues

func GetActionTypeEnumValues() []ActionTypeEnum

GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum

func GetMappingActionTypeEnum

func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)

GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type BasicImagePullSecret

type BasicImagePullSecret struct {

	// The registry endpoint of the container image.
	RegistryEndpoint *string `mandatory:"true" json:"registryEndpoint"`
}

BasicImagePullSecret A BasicImagePullSecret is a ImagePullSecret which accepts username and password as credentials information.

func (BasicImagePullSecret) GetRegistryEndpoint

func (m BasicImagePullSecret) GetRegistryEndpoint() *string

GetRegistryEndpoint returns RegistryEndpoint

func (BasicImagePullSecret) MarshalJSON

func (m BasicImagePullSecret) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (BasicImagePullSecret) String

func (m BasicImagePullSecret) String() string

func (BasicImagePullSecret) ValidateEnumValue

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

type ChangeContainerInstanceCompartmentDetails

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"`
}

ChangeContainerInstanceCompartmentDetails The configuration details for the move operation.

func (ChangeContainerInstanceCompartmentDetails) String

func (ChangeContainerInstanceCompartmentDetails) ValidateEnumValue

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

type 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
}

ChangeContainerInstanceCompartmentRequest wrapper for the ChangeContainerInstanceCompartment operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerinstances/ChangeContainerInstanceCompartment.go.html to see an example of how to use ChangeContainerInstanceCompartmentRequest.

func (ChangeContainerInstanceCompartmentRequest) BinaryRequestBody

BinaryRequestBody implements the OCIRequest interface

func (ChangeContainerInstanceCompartmentRequest) HTTPRequest

func (request ChangeContainerInstanceCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeContainerInstanceCompartmentRequest) RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ChangeContainerInstanceCompartmentRequest) String

func (ChangeContainerInstanceCompartmentRequest) ValidateEnumValue

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

type ChangeContainerInstanceCompartmentResponse

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"`
}

ChangeContainerInstanceCompartmentResponse wrapper for the ChangeContainerInstanceCompartment operation

func (ChangeContainerInstanceCompartmentResponse) HTTPResponse

func (response ChangeContainerInstanceCompartmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ChangeContainerInstanceCompartmentResponse) String

type Container

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"`
}

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.

func (Container) String

func (m Container) String() string

func (*Container) UnmarshalJSON

func (m *Container) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (Container) ValidateEnumValue

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

type ContainerCapabilities added in v65.61.0

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"`
}

ContainerCapabilities Linux Container capabilities to configure capabilities of container.

func (ContainerCapabilities) String added in v65.61.0

func (m ContainerCapabilities) String() string

func (ContainerCapabilities) ValidateEnumValue added in v65.61.0

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

type ContainerCapabilityEnum

type ContainerCapabilityEnum string

ContainerCapabilityEnum Enum with underlying type: string

const (
	ContainerCapabilityCapNetAdmin ContainerCapabilityEnum = "CAP_NET_ADMIN"
	ContainerCapabilityCapNetRaw   ContainerCapabilityEnum = "CAP_NET_RAW"
)

Set of constants representing the allowable values for ContainerCapabilityEnum

func GetContainerCapabilityEnumValues

func GetContainerCapabilityEnumValues() []ContainerCapabilityEnum

GetContainerCapabilityEnumValues Enumerates the set of values for ContainerCapabilityEnum

func GetMappingContainerCapabilityEnum

func GetMappingContainerCapabilityEnum(val string) (ContainerCapabilityEnum, bool)

GetMappingContainerCapabilityEnum performs case Insensitive comparison on enum value and return the desired enum

type ContainerCapabilityTypeEnum added in v65.61.0

type ContainerCapabilityTypeEnum string

ContainerCapabilityTypeEnum Enum with underlying type: string

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"
)

Set of constants representing the allowable values for ContainerCapabilityTypeEnum

func GetContainerCapabilityTypeEnumValues added in v65.61.0

func GetContainerCapabilityTypeEnumValues() []ContainerCapabilityTypeEnum

GetContainerCapabilityTypeEnumValues Enumerates the set of values for ContainerCapabilityTypeEnum

func GetMappingContainerCapabilityTypeEnum added in v65.61.0

func GetMappingContainerCapabilityTypeEnum(val string) (ContainerCapabilityTypeEnum, bool)

GetMappingContainerCapabilityTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type ContainerCollection

type ContainerCollection struct {

	// List of containers.
	Items []ContainerSummary `mandatory:"true" json:"items"`
}

ContainerCollection A list of containers.

func (ContainerCollection) String

func (m ContainerCollection) String() string

func (ContainerCollection) ValidateEnumValue

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

type ContainerCommandHealthCheck

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"`
}

ContainerCommandHealthCheck Container Health Check with command type.

func (ContainerCommandHealthCheck) GetFailureAction

GetFailureAction returns FailureAction

func (ContainerCommandHealthCheck) GetFailureThreshold

func (m ContainerCommandHealthCheck) GetFailureThreshold() *int

GetFailureThreshold returns FailureThreshold

func (ContainerCommandHealthCheck) GetInitialDelayInSeconds

func (m ContainerCommandHealthCheck) GetInitialDelayInSeconds() *int

GetInitialDelayInSeconds returns InitialDelayInSeconds

func (ContainerCommandHealthCheck) GetIntervalInSeconds

func (m ContainerCommandHealthCheck) GetIntervalInSeconds() *int

GetIntervalInSeconds returns IntervalInSeconds

func (ContainerCommandHealthCheck) GetName

func (m ContainerCommandHealthCheck) GetName() *string

GetName returns Name

func (ContainerCommandHealthCheck) GetStatus

GetStatus returns Status

func (ContainerCommandHealthCheck) GetStatusDetails

func (m ContainerCommandHealthCheck) GetStatusDetails() *string

GetStatusDetails returns StatusDetails

func (ContainerCommandHealthCheck) GetSuccessThreshold

func (m ContainerCommandHealthCheck) GetSuccessThreshold() *int

GetSuccessThreshold returns SuccessThreshold

func (ContainerCommandHealthCheck) GetTimeoutInSeconds

func (m ContainerCommandHealthCheck) GetTimeoutInSeconds() *int

GetTimeoutInSeconds returns TimeoutInSeconds

func (ContainerCommandHealthCheck) MarshalJSON

func (m ContainerCommandHealthCheck) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ContainerCommandHealthCheck) String

func (ContainerCommandHealthCheck) ValidateEnumValue

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

type ContainerConfigFile

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"`
}

ContainerConfigFile The file that is mounted on a container instance through a volume mount.

func (ContainerConfigFile) String

func (m ContainerConfigFile) String() string

func (ContainerConfigFile) ValidateEnumValue

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

type ContainerConfigFileVolume

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"`
}

ContainerConfigFileVolume The volume based on configuration files received during container creation.

func (ContainerConfigFileVolume) GetName

func (m ContainerConfigFileVolume) GetName() *string

GetName returns Name

func (ContainerConfigFileVolume) MarshalJSON

func (m ContainerConfigFileVolume) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ContainerConfigFileVolume) String

func (m ContainerConfigFileVolume) String() string

func (ContainerConfigFileVolume) ValidateEnumValue

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

type ContainerDnsConfig

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"`
}

ContainerDnsConfig DNS settings for containers.

func (ContainerDnsConfig) String

func (m ContainerDnsConfig) String() string

func (ContainerDnsConfig) ValidateEnumValue

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

type ContainerEmptyDirVolume

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"`
}

ContainerEmptyDirVolume The empty directory volume of a container instance. You can create up to 64 EmptyDir per container instance.

func (ContainerEmptyDirVolume) GetName

func (m ContainerEmptyDirVolume) GetName() *string

GetName returns Name

func (ContainerEmptyDirVolume) MarshalJSON

func (m ContainerEmptyDirVolume) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ContainerEmptyDirVolume) String

func (m ContainerEmptyDirVolume) String() string

func (ContainerEmptyDirVolume) ValidateEnumValue

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

type ContainerEmptyDirVolumeBackingStoreEnum

type ContainerEmptyDirVolumeBackingStoreEnum string

ContainerEmptyDirVolumeBackingStoreEnum Enum with underlying type: string

const (
	ContainerEmptyDirVolumeBackingStoreEphemeralStorage ContainerEmptyDirVolumeBackingStoreEnum = "EPHEMERAL_STORAGE"
	ContainerEmptyDirVolumeBackingStoreMemory           ContainerEmptyDirVolumeBackingStoreEnum = "MEMORY"
)

Set of constants representing the allowable values for ContainerEmptyDirVolumeBackingStoreEnum

func GetContainerEmptyDirVolumeBackingStoreEnumValues

func GetContainerEmptyDirVolumeBackingStoreEnumValues() []ContainerEmptyDirVolumeBackingStoreEnum

GetContainerEmptyDirVolumeBackingStoreEnumValues Enumerates the set of values for ContainerEmptyDirVolumeBackingStoreEnum

func GetMappingContainerEmptyDirVolumeBackingStoreEnum

func GetMappingContainerEmptyDirVolumeBackingStoreEnum(val string) (ContainerEmptyDirVolumeBackingStoreEnum, bool)

GetMappingContainerEmptyDirVolumeBackingStoreEnum performs case Insensitive comparison on enum value and return the desired enum

type ContainerHealthCheck

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
}

ContainerHealthCheck Type of container health check which could be either HTTP, TCP, or Command.

type ContainerHealthCheckFailureActionEnum

type ContainerHealthCheckFailureActionEnum string

ContainerHealthCheckFailureActionEnum Enum with underlying type: string

const (
	ContainerHealthCheckFailureActionKill ContainerHealthCheckFailureActionEnum = "KILL"
	ContainerHealthCheckFailureActionNone ContainerHealthCheckFailureActionEnum = "NONE"
)

Set of constants representing the allowable values for ContainerHealthCheckFailureActionEnum

func GetContainerHealthCheckFailureActionEnumValues

func GetContainerHealthCheckFailureActionEnumValues() []ContainerHealthCheckFailureActionEnum

GetContainerHealthCheckFailureActionEnumValues Enumerates the set of values for ContainerHealthCheckFailureActionEnum

func GetMappingContainerHealthCheckFailureActionEnum

func GetMappingContainerHealthCheckFailureActionEnum(val string) (ContainerHealthCheckFailureActionEnum, bool)

GetMappingContainerHealthCheckFailureActionEnum performs case Insensitive comparison on enum value and return the desired enum

type ContainerHealthCheckStatusEnum

type ContainerHealthCheckStatusEnum string

ContainerHealthCheckStatusEnum Enum with underlying type: string

const (
	ContainerHealthCheckStatusHealthy   ContainerHealthCheckStatusEnum = "HEALTHY"
	ContainerHealthCheckStatusUnhealthy ContainerHealthCheckStatusEnum = "UNHEALTHY"
	ContainerHealthCheckStatusUnknown   ContainerHealthCheckStatusEnum = "UNKNOWN"
)

Set of constants representing the allowable values for ContainerHealthCheckStatusEnum

func GetContainerHealthCheckStatusEnumValues

func GetContainerHealthCheckStatusEnumValues() []ContainerHealthCheckStatusEnum

GetContainerHealthCheckStatusEnumValues Enumerates the set of values for ContainerHealthCheckStatusEnum

func GetMappingContainerHealthCheckStatusEnum

func GetMappingContainerHealthCheckStatusEnum(val string) (ContainerHealthCheckStatusEnum, bool)

GetMappingContainerHealthCheckStatusEnum performs case Insensitive comparison on enum value and return the desired enum

type ContainerHealthCheckTypeEnum

type ContainerHealthCheckTypeEnum string

ContainerHealthCheckTypeEnum Enum with underlying type: string

const (
	ContainerHealthCheckTypeHttp    ContainerHealthCheckTypeEnum = "HTTP"
	ContainerHealthCheckTypeTcp     ContainerHealthCheckTypeEnum = "TCP"
	ContainerHealthCheckTypeCommand ContainerHealthCheckTypeEnum = "COMMAND"
)

Set of constants representing the allowable values for ContainerHealthCheckTypeEnum

func GetContainerHealthCheckTypeEnumValues

func GetContainerHealthCheckTypeEnumValues() []ContainerHealthCheckTypeEnum

GetContainerHealthCheckTypeEnumValues Enumerates the set of values for ContainerHealthCheckTypeEnum

func GetMappingContainerHealthCheckTypeEnum

func GetMappingContainerHealthCheckTypeEnum(val string) (ContainerHealthCheckTypeEnum, bool)

GetMappingContainerHealthCheckTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type ContainerHttpHealthCheck

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"`
}

ContainerHttpHealthCheck Container Health Check HTTP type.

func (ContainerHttpHealthCheck) GetFailureAction

GetFailureAction returns FailureAction

func (ContainerHttpHealthCheck) GetFailureThreshold

func (m ContainerHttpHealthCheck) GetFailureThreshold() *int

GetFailureThreshold returns FailureThreshold

func (ContainerHttpHealthCheck) GetInitialDelayInSeconds

func (m ContainerHttpHealthCheck) GetInitialDelayInSeconds() *int

GetInitialDelayInSeconds returns InitialDelayInSeconds

func (ContainerHttpHealthCheck) GetIntervalInSeconds

func (m ContainerHttpHealthCheck) GetIntervalInSeconds() *int

GetIntervalInSeconds returns IntervalInSeconds

func (ContainerHttpHealthCheck) GetName

func (m ContainerHttpHealthCheck) GetName() *string

GetName returns Name

func (ContainerHttpHealthCheck) GetStatus

GetStatus returns Status

func (ContainerHttpHealthCheck) GetStatusDetails

func (m ContainerHttpHealthCheck) GetStatusDetails() *string

GetStatusDetails returns StatusDetails

func (ContainerHttpHealthCheck) GetSuccessThreshold

func (m ContainerHttpHealthCheck) GetSuccessThreshold() *int

GetSuccessThreshold returns SuccessThreshold

func (ContainerHttpHealthCheck) GetTimeoutInSeconds

func (m ContainerHttpHealthCheck) GetTimeoutInSeconds() *int

GetTimeoutInSeconds returns TimeoutInSeconds

func (ContainerHttpHealthCheck) MarshalJSON

func (m ContainerHttpHealthCheck) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ContainerHttpHealthCheck) String

func (m ContainerHttpHealthCheck) String() string

func (ContainerHttpHealthCheck) ValidateEnumValue

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

type ContainerInstance

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"`
}

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.

func (ContainerInstance) String

func (m ContainerInstance) String() string

func (*ContainerInstance) UnmarshalJSON

func (m *ContainerInstance) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (ContainerInstance) ValidateEnumValue

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

type ContainerInstanceClient

type ContainerInstanceClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

ContainerInstanceClient a client for ContainerInstance

func NewContainerInstanceClientWithConfigurationProvider

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

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 (ContainerInstanceClient) ChangeContainerInstanceCompartment

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/latest/containerinstances/ChangeContainerInstanceCompartment.go.html to see an example of how to use ChangeContainerInstanceCompartment API. A default retry strategy applies to this operation ChangeContainerInstanceCompartment()

func (*ContainerInstanceClient) ConfigurationProvider

func (client *ContainerInstanceClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (ContainerInstanceClient) CreateContainerInstance

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/latest/containerinstances/CreateContainerInstance.go.html to see an example of how to use CreateContainerInstance API. A default retry strategy applies to this operation CreateContainerInstance()

func (ContainerInstanceClient) DeleteContainerInstance

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/latest/containerinstances/DeleteContainerInstance.go.html to see an example of how to use DeleteContainerInstance API. A default retry strategy applies to this operation DeleteContainerInstance()

func (ContainerInstanceClient) GetContainer

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/latest/containerinstances/GetContainer.go.html to see an example of how to use GetContainer API. A default retry strategy applies to this operation GetContainer()

func (ContainerInstanceClient) GetContainerInstance

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/latest/containerinstances/GetContainerInstance.go.html to see an example of how to use GetContainerInstance API. A default retry strategy applies to this operation GetContainerInstance()

func (ContainerInstanceClient) GetWorkRequest

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/latest/containerinstances/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()

func (ContainerInstanceClient) ListContainerInstanceShapes

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/latest/containerinstances/ListContainerInstanceShapes.go.html to see an example of how to use ListContainerInstanceShapes API. A default retry strategy applies to this operation ListContainerInstanceShapes()

func (ContainerInstanceClient) ListContainerInstances

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/latest/containerinstances/ListContainerInstances.go.html to see an example of how to use ListContainerInstances API. A default retry strategy applies to this operation ListContainerInstances()

func (ContainerInstanceClient) ListContainers

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/latest/containerinstances/ListContainers.go.html to see an example of how to use ListContainers API. A default retry strategy applies to this operation ListContainers()

func (ContainerInstanceClient) ListWorkRequestErrors

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/latest/containerinstances/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()

func (ContainerInstanceClient) ListWorkRequestLogs

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/latest/containerinstances/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()

func (ContainerInstanceClient) ListWorkRequests

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/latest/containerinstances/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()

func (ContainerInstanceClient) RestartContainerInstance

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/latest/containerinstances/RestartContainerInstance.go.html to see an example of how to use RestartContainerInstance API. A default retry strategy applies to this operation RestartContainerInstance()

func (ContainerInstanceClient) RetrieveLogs

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/latest/containerinstances/RetrieveLogs.go.html to see an example of how to use RetrieveLogs API. A default retry strategy applies to this operation RetrieveLogs()

func (*ContainerInstanceClient) SetRegion

func (client *ContainerInstanceClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (ContainerInstanceClient) StartContainerInstance

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/latest/containerinstances/StartContainerInstance.go.html to see an example of how to use StartContainerInstance API. A default retry strategy applies to this operation StartContainerInstance()

func (ContainerInstanceClient) StopContainerInstance

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/latest/containerinstances/StopContainerInstance.go.html to see an example of how to use StopContainerInstance API. A default retry strategy applies to this operation StopContainerInstance()

func (ContainerInstanceClient) UpdateContainer

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/latest/containerinstances/UpdateContainer.go.html to see an example of how to use UpdateContainer API. A default retry strategy applies to this operation UpdateContainer()

func (ContainerInstanceClient) UpdateContainerInstance

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/latest/containerinstances/UpdateContainerInstance.go.html to see an example of how to use UpdateContainerInstance API. A default retry strategy applies to this operation UpdateContainerInstance()

type ContainerInstanceCollection

type ContainerInstanceCollection struct {

	// List of container instances.
	Items []ContainerInstanceSummary `mandatory:"true" json:"items"`
}

ContainerInstanceCollection Summary information about a list of container instances.

func (ContainerInstanceCollection) String

func (ContainerInstanceCollection) ValidateEnumValue

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

type ContainerInstanceContainer

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"`
}

ContainerInstanceContainer A container on a container instance.

func (ContainerInstanceContainer) String

func (ContainerInstanceContainer) ValidateEnumValue

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

type ContainerInstanceContainerRestartPolicyEnum

type ContainerInstanceContainerRestartPolicyEnum string

ContainerInstanceContainerRestartPolicyEnum Enum with underlying type: string

const (
	ContainerInstanceContainerRestartPolicyAlways    ContainerInstanceContainerRestartPolicyEnum = "ALWAYS"
	ContainerInstanceContainerRestartPolicyNever     ContainerInstanceContainerRestartPolicyEnum = "NEVER"
	ContainerInstanceContainerRestartPolicyOnFailure ContainerInstanceContainerRestartPolicyEnum = "ON_FAILURE"
)

Set of constants representing the allowable values for ContainerInstanceContainerRestartPolicyEnum

func GetContainerInstanceContainerRestartPolicyEnumValues

func GetContainerInstanceContainerRestartPolicyEnumValues() []ContainerInstanceContainerRestartPolicyEnum

GetContainerInstanceContainerRestartPolicyEnumValues Enumerates the set of values for ContainerInstanceContainerRestartPolicyEnum

func GetMappingContainerInstanceContainerRestartPolicyEnum

func GetMappingContainerInstanceContainerRestartPolicyEnum(val string) (ContainerInstanceContainerRestartPolicyEnum, bool)

GetMappingContainerInstanceContainerRestartPolicyEnum performs case Insensitive comparison on enum value and return the desired enum

type ContainerInstanceLifecycleStateEnum

type ContainerInstanceLifecycleStateEnum string

ContainerInstanceLifecycleStateEnum Enum with underlying type: string

const (
	ContainerInstanceLifecycleStateCreating ContainerInstanceLifecycleStateEnum = "CREATING"
	ContainerInstanceLifecycleStateUpdating ContainerInstanceLifecycleStateEnum = "UPDATING"
	ContainerInstanceLifecycleStateActive   ContainerInstanceLifecycleStateEnum = "ACTIVE"
	ContainerInstanceLifecycleStateInactive ContainerInstanceLifecycleStateEnum = "INACTIVE"
	ContainerInstanceLifecycleStateDeleting ContainerInstanceLifecycleStateEnum = "DELETING"
	ContainerInstanceLifecycleStateDeleted  ContainerInstanceLifecycleStateEnum = "DELETED"
	ContainerInstanceLifecycleStateFailed   ContainerInstanceLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for ContainerInstanceLifecycleStateEnum

func GetContainerInstanceLifecycleStateEnumValues

func GetContainerInstanceLifecycleStateEnumValues() []ContainerInstanceLifecycleStateEnum

GetContainerInstanceLifecycleStateEnumValues Enumerates the set of values for ContainerInstanceLifecycleStateEnum

func GetMappingContainerInstanceLifecycleStateEnum

func GetMappingContainerInstanceLifecycleStateEnum(val string) (ContainerInstanceLifecycleStateEnum, bool)

GetMappingContainerInstanceLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type ContainerInstanceShapeCollection

type ContainerInstanceShapeCollection struct {

	// A list of shapes.
	Items []ContainerInstanceShapeSummary `mandatory:"true" json:"items"`
}

ContainerInstanceShapeCollection A collection of container instance shapes.

func (ContainerInstanceShapeCollection) String

func (ContainerInstanceShapeCollection) ValidateEnumValue

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

type ContainerInstanceShapeConfig

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"`
}

ContainerInstanceShapeConfig The shape configuration for a container instance. The shape configuration determines the resources thats are available to the container instance and its containers.

func (ContainerInstanceShapeConfig) String

func (ContainerInstanceShapeConfig) ValidateEnumValue

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

type ContainerInstanceShapeSummary

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"`
}

ContainerInstanceShapeSummary Details about a shape for a container instance.

func (ContainerInstanceShapeSummary) String

func (ContainerInstanceShapeSummary) ValidateEnumValue

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

type ContainerInstanceSummary

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"`
}

ContainerInstanceSummary A set of details about a single container instance returned by list APIs.

func (ContainerInstanceSummary) String

func (m ContainerInstanceSummary) String() string

func (ContainerInstanceSummary) ValidateEnumValue

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

type ContainerLifecycleStateEnum

type ContainerLifecycleStateEnum string

ContainerLifecycleStateEnum Enum with underlying type: string

const (
	ContainerLifecycleStateCreating ContainerLifecycleStateEnum = "CREATING"
	ContainerLifecycleStateUpdating ContainerLifecycleStateEnum = "UPDATING"
	ContainerLifecycleStateActive   ContainerLifecycleStateEnum = "ACTIVE"
	ContainerLifecycleStateInactive ContainerLifecycleStateEnum = "INACTIVE"
	ContainerLifecycleStateDeleting ContainerLifecycleStateEnum = "DELETING"
	ContainerLifecycleStateDeleted  ContainerLifecycleStateEnum = "DELETED"
	ContainerLifecycleStateFailed   ContainerLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for ContainerLifecycleStateEnum

func GetContainerLifecycleStateEnumValues

func GetContainerLifecycleStateEnumValues() []ContainerLifecycleStateEnum

GetContainerLifecycleStateEnumValues Enumerates the set of values for ContainerLifecycleStateEnum

func GetMappingContainerLifecycleStateEnum

func GetMappingContainerLifecycleStateEnum(val string) (ContainerLifecycleStateEnum, bool)

GetMappingContainerLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type ContainerResourceConfig

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"`
}

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.

func (ContainerResourceConfig) String

func (m ContainerResourceConfig) String() string

func (ContainerResourceConfig) ValidateEnumValue

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

type ContainerSummary

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"`
}

ContainerSummary Summary information about a container.

func (ContainerSummary) String

func (m ContainerSummary) String() string

func (*ContainerSummary) UnmarshalJSON added in v65.47.1

func (m *ContainerSummary) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (ContainerSummary) ValidateEnumValue

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

type ContainerTcpHealthCheck

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"`
}

ContainerTcpHealthCheck Container Health Check with TCP type.

func (ContainerTcpHealthCheck) GetFailureAction

GetFailureAction returns FailureAction

func (ContainerTcpHealthCheck) GetFailureThreshold

func (m ContainerTcpHealthCheck) GetFailureThreshold() *int

GetFailureThreshold returns FailureThreshold

func (ContainerTcpHealthCheck) GetInitialDelayInSeconds

func (m ContainerTcpHealthCheck) GetInitialDelayInSeconds() *int

GetInitialDelayInSeconds returns InitialDelayInSeconds

func (ContainerTcpHealthCheck) GetIntervalInSeconds

func (m ContainerTcpHealthCheck) GetIntervalInSeconds() *int

GetIntervalInSeconds returns IntervalInSeconds

func (ContainerTcpHealthCheck) GetName

func (m ContainerTcpHealthCheck) GetName() *string

GetName returns Name

func (ContainerTcpHealthCheck) GetStatus

GetStatus returns Status

func (ContainerTcpHealthCheck) GetStatusDetails

func (m ContainerTcpHealthCheck) GetStatusDetails() *string

GetStatusDetails returns StatusDetails

func (ContainerTcpHealthCheck) GetSuccessThreshold

func (m ContainerTcpHealthCheck) GetSuccessThreshold() *int

GetSuccessThreshold returns SuccessThreshold

func (ContainerTcpHealthCheck) GetTimeoutInSeconds

func (m ContainerTcpHealthCheck) GetTimeoutInSeconds() *int

GetTimeoutInSeconds returns TimeoutInSeconds

func (ContainerTcpHealthCheck) MarshalJSON

func (m ContainerTcpHealthCheck) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ContainerTcpHealthCheck) String

func (m ContainerTcpHealthCheck) String() string

func (ContainerTcpHealthCheck) ValidateEnumValue

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

type ContainerVnic

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"`
}

ContainerVnic An interface to a virtual network available to containers on a container instance.

func (ContainerVnic) String

func (m ContainerVnic) String() string

func (ContainerVnic) ValidateEnumValue

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

type ContainerVolume

type ContainerVolume interface {

	// The name of the volume. This must be unique within a single container instance.
	GetName() *string
}

ContainerVolume A volume represents a directory with data that is accessible across multiple containers in a container instance.

type ContainerVolumeTypeEnum

type ContainerVolumeTypeEnum string

ContainerVolumeTypeEnum Enum with underlying type: string

const (
	ContainerVolumeTypeEmptydir   ContainerVolumeTypeEnum = "EMPTYDIR"
	ContainerVolumeTypeConfigfile ContainerVolumeTypeEnum = "CONFIGFILE"
)

Set of constants representing the allowable values for ContainerVolumeTypeEnum

func GetContainerVolumeTypeEnumValues

func GetContainerVolumeTypeEnumValues() []ContainerVolumeTypeEnum

GetContainerVolumeTypeEnumValues Enumerates the set of values for ContainerVolumeTypeEnum

func GetMappingContainerVolumeTypeEnum

func GetMappingContainerVolumeTypeEnum(val string) (ContainerVolumeTypeEnum, bool)

GetMappingContainerVolumeTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type CreateBasicImagePullSecretDetails

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"`
}

CreateBasicImagePullSecretDetails A CreateBasicImagePullSecretDetails is a ImagePullSecret which accepts username and password as credentials information.

func (CreateBasicImagePullSecretDetails) GetRegistryEndpoint

func (m CreateBasicImagePullSecretDetails) GetRegistryEndpoint() *string

GetRegistryEndpoint returns RegistryEndpoint

func (CreateBasicImagePullSecretDetails) MarshalJSON

func (m CreateBasicImagePullSecretDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateBasicImagePullSecretDetails) String

func (CreateBasicImagePullSecretDetails) ValidateEnumValue

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

type CreateContainerCommandHealthCheckDetails

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"`
}

CreateContainerCommandHealthCheckDetails Container Health Check Command type.

func (CreateContainerCommandHealthCheckDetails) GetFailureAction

GetFailureAction returns FailureAction

func (CreateContainerCommandHealthCheckDetails) GetFailureThreshold

func (m CreateContainerCommandHealthCheckDetails) GetFailureThreshold() *int

GetFailureThreshold returns FailureThreshold

func (CreateContainerCommandHealthCheckDetails) GetInitialDelayInSeconds

func (m CreateContainerCommandHealthCheckDetails) GetInitialDelayInSeconds() *int

GetInitialDelayInSeconds returns InitialDelayInSeconds

func (CreateContainerCommandHealthCheckDetails) GetIntervalInSeconds

func (m CreateContainerCommandHealthCheckDetails) GetIntervalInSeconds() *int

GetIntervalInSeconds returns IntervalInSeconds

func (CreateContainerCommandHealthCheckDetails) GetName

GetName returns Name

func (CreateContainerCommandHealthCheckDetails) GetSuccessThreshold

func (m CreateContainerCommandHealthCheckDetails) GetSuccessThreshold() *int

GetSuccessThreshold returns SuccessThreshold

func (CreateContainerCommandHealthCheckDetails) GetTimeoutInSeconds

func (m CreateContainerCommandHealthCheckDetails) GetTimeoutInSeconds() *int

GetTimeoutInSeconds returns TimeoutInSeconds

func (CreateContainerCommandHealthCheckDetails) MarshalJSON

func (m CreateContainerCommandHealthCheckDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateContainerCommandHealthCheckDetails) String

func (CreateContainerCommandHealthCheckDetails) ValidateEnumValue

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

type CreateContainerConfigFileVolumeDetails

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"`
}

CreateContainerConfigFileVolumeDetails The configuration files to pass to the container using volume mounts.

func (CreateContainerConfigFileVolumeDetails) GetName

GetName returns Name

func (CreateContainerConfigFileVolumeDetails) MarshalJSON

func (m CreateContainerConfigFileVolumeDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateContainerConfigFileVolumeDetails) String

func (CreateContainerConfigFileVolumeDetails) ValidateEnumValue

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

type CreateContainerDetails

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"`
}

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.

func (CreateContainerDetails) String

func (m CreateContainerDetails) String() string

func (*CreateContainerDetails) UnmarshalJSON

func (m *CreateContainerDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (CreateContainerDetails) ValidateEnumValue

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

type CreateContainerDnsConfigDetails

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"`
}

CreateContainerDnsConfigDetails Allow customers to define DNS settings for containers. If this is not provided, the containers use the default DNS settings of the subnet.

func (CreateContainerDnsConfigDetails) String

func (CreateContainerDnsConfigDetails) ValidateEnumValue

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

type CreateContainerEmptyDirVolumeDetails

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"`
}

CreateContainerEmptyDirVolumeDetails The empty directory for the container instance.

func (CreateContainerEmptyDirVolumeDetails) GetName

GetName returns Name

func (CreateContainerEmptyDirVolumeDetails) MarshalJSON

func (m CreateContainerEmptyDirVolumeDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateContainerEmptyDirVolumeDetails) String

func (CreateContainerEmptyDirVolumeDetails) ValidateEnumValue

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

type CreateContainerHealthCheckDetails

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
}

CreateContainerHealthCheckDetails Container Health Check is used to check and report the status of a container.

type CreateContainerHttpHealthCheckDetails

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"`
}

CreateContainerHttpHealthCheckDetails Container Health Check HTTP type.

func (CreateContainerHttpHealthCheckDetails) GetFailureAction

GetFailureAction returns FailureAction

func (CreateContainerHttpHealthCheckDetails) GetFailureThreshold

func (m CreateContainerHttpHealthCheckDetails) GetFailureThreshold() *int

GetFailureThreshold returns FailureThreshold

func (CreateContainerHttpHealthCheckDetails) GetInitialDelayInSeconds

func (m CreateContainerHttpHealthCheckDetails) GetInitialDelayInSeconds() *int

GetInitialDelayInSeconds returns InitialDelayInSeconds

func (CreateContainerHttpHealthCheckDetails) GetIntervalInSeconds

func (m CreateContainerHttpHealthCheckDetails) GetIntervalInSeconds() *int

GetIntervalInSeconds returns IntervalInSeconds

func (CreateContainerHttpHealthCheckDetails) GetName

GetName returns Name

func (CreateContainerHttpHealthCheckDetails) GetSuccessThreshold

func (m CreateContainerHttpHealthCheckDetails) GetSuccessThreshold() *int

GetSuccessThreshold returns SuccessThreshold

func (CreateContainerHttpHealthCheckDetails) GetTimeoutInSeconds

func (m CreateContainerHttpHealthCheckDetails) GetTimeoutInSeconds() *int

GetTimeoutInSeconds returns TimeoutInSeconds

func (CreateContainerHttpHealthCheckDetails) MarshalJSON

func (m CreateContainerHttpHealthCheckDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateContainerHttpHealthCheckDetails) String

func (CreateContainerHttpHealthCheckDetails) ValidateEnumValue

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

type CreateContainerInstanceDetails

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"`
}

CreateContainerInstanceDetails Information to create a container instance.

func (CreateContainerInstanceDetails) String

func (*CreateContainerInstanceDetails) UnmarshalJSON

func (m *CreateContainerInstanceDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (CreateContainerInstanceDetails) ValidateEnumValue

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

type 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
}

CreateContainerInstanceRequest wrapper for the CreateContainerInstance operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerinstances/CreateContainerInstance.go.html to see an example of how to use CreateContainerInstanceRequest.

func (CreateContainerInstanceRequest) BinaryRequestBody

func (request CreateContainerInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateContainerInstanceRequest) HTTPRequest

func (request CreateContainerInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateContainerInstanceRequest) RetryPolicy

func (request CreateContainerInstanceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateContainerInstanceRequest) String

func (request CreateContainerInstanceRequest) String() string

func (CreateContainerInstanceRequest) ValidateEnumValue

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

type CreateContainerInstanceResponse

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"`
}

CreateContainerInstanceResponse wrapper for the CreateContainerInstance operation

func (CreateContainerInstanceResponse) HTTPResponse

func (response CreateContainerInstanceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateContainerInstanceResponse) String

func (response CreateContainerInstanceResponse) String() string

type CreateContainerInstanceShapeConfigDetails

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"`
}

CreateContainerInstanceShapeConfigDetails The size and amount of resources available to the container instance.

func (CreateContainerInstanceShapeConfigDetails) String

func (CreateContainerInstanceShapeConfigDetails) ValidateEnumValue

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

type CreateContainerResourceConfigDetails

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"`
}

CreateContainerResourceConfigDetails The size and amount of resources available to the container.

func (CreateContainerResourceConfigDetails) String

func (CreateContainerResourceConfigDetails) ValidateEnumValue

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

type CreateContainerTcpHealthCheckDetails

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"`
}

CreateContainerTcpHealthCheckDetails Container Health Check TCP type.

func (CreateContainerTcpHealthCheckDetails) GetFailureAction

GetFailureAction returns FailureAction

func (CreateContainerTcpHealthCheckDetails) GetFailureThreshold

func (m CreateContainerTcpHealthCheckDetails) GetFailureThreshold() *int

GetFailureThreshold returns FailureThreshold

func (CreateContainerTcpHealthCheckDetails) GetInitialDelayInSeconds

func (m CreateContainerTcpHealthCheckDetails) GetInitialDelayInSeconds() *int

GetInitialDelayInSeconds returns InitialDelayInSeconds

func (CreateContainerTcpHealthCheckDetails) GetIntervalInSeconds

func (m CreateContainerTcpHealthCheckDetails) GetIntervalInSeconds() *int

GetIntervalInSeconds returns IntervalInSeconds

func (CreateContainerTcpHealthCheckDetails) GetName

GetName returns Name

func (CreateContainerTcpHealthCheckDetails) GetSuccessThreshold

func (m CreateContainerTcpHealthCheckDetails) GetSuccessThreshold() *int

GetSuccessThreshold returns SuccessThreshold

func (CreateContainerTcpHealthCheckDetails) GetTimeoutInSeconds

func (m CreateContainerTcpHealthCheckDetails) GetTimeoutInSeconds() *int

GetTimeoutInSeconds returns TimeoutInSeconds

func (CreateContainerTcpHealthCheckDetails) MarshalJSON

func (m CreateContainerTcpHealthCheckDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateContainerTcpHealthCheckDetails) String

func (CreateContainerTcpHealthCheckDetails) ValidateEnumValue

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

type CreateContainerVnicDetails

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"`
}

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.

func (CreateContainerVnicDetails) String

func (CreateContainerVnicDetails) ValidateEnumValue

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

type CreateContainerVolumeDetails

type CreateContainerVolumeDetails interface {

	// The name of the volume. This must be unique within a single container instance.
	GetName() *string
}

CreateContainerVolumeDetails A volume represents a directory with data that is accessible across multiple containers in a container instance.

type CreateImagePullSecretDetails

type CreateImagePullSecretDetails interface {

	// The registry endpoint of the container image.
	GetRegistryEndpoint() *string
}

CreateImagePullSecretDetails The image pull secrets for accessing private registry to pull images for containers

type CreateImagePullSecretDetailsSecretTypeEnum

type CreateImagePullSecretDetailsSecretTypeEnum string

CreateImagePullSecretDetailsSecretTypeEnum Enum with underlying type: string

const (
	CreateImagePullSecretDetailsSecretTypeBasic CreateImagePullSecretDetailsSecretTypeEnum = "BASIC"
	CreateImagePullSecretDetailsSecretTypeVault CreateImagePullSecretDetailsSecretTypeEnum = "VAULT"
)

Set of constants representing the allowable values for CreateImagePullSecretDetailsSecretTypeEnum

func GetCreateImagePullSecretDetailsSecretTypeEnumValues

func GetCreateImagePullSecretDetailsSecretTypeEnumValues() []CreateImagePullSecretDetailsSecretTypeEnum

GetCreateImagePullSecretDetailsSecretTypeEnumValues Enumerates the set of values for CreateImagePullSecretDetailsSecretTypeEnum

func GetMappingCreateImagePullSecretDetailsSecretTypeEnum

func GetMappingCreateImagePullSecretDetailsSecretTypeEnum(val string) (CreateImagePullSecretDetailsSecretTypeEnum, bool)

GetMappingCreateImagePullSecretDetailsSecretTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type CreateLinuxSecurityContextDetails added in v65.47.1

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"`
}

CreateLinuxSecurityContextDetails Security context for Linux container.

func (CreateLinuxSecurityContextDetails) MarshalJSON added in v65.47.1

func (m CreateLinuxSecurityContextDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateLinuxSecurityContextDetails) String added in v65.47.1

func (CreateLinuxSecurityContextDetails) ValidateEnumValue added in v65.47.1

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

type CreateSecurityContextDetails added in v65.47.1

type CreateSecurityContextDetails interface {
}

CreateSecurityContextDetails Security context for container.

type CreateVaultImagePullSecretDetails

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"`
}

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"
}

```

func (CreateVaultImagePullSecretDetails) GetRegistryEndpoint

func (m CreateVaultImagePullSecretDetails) GetRegistryEndpoint() *string

GetRegistryEndpoint returns RegistryEndpoint

func (CreateVaultImagePullSecretDetails) MarshalJSON

func (m CreateVaultImagePullSecretDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateVaultImagePullSecretDetails) String

func (CreateVaultImagePullSecretDetails) ValidateEnumValue

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

type CreateVolumeMountDetails

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"`
}

CreateVolumeMountDetails Defines the mapping from volume to a mount path in a container.

func (CreateVolumeMountDetails) String

func (m CreateVolumeMountDetails) String() string

func (CreateVolumeMountDetails) ValidateEnumValue

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

type 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
}

DeleteContainerInstanceRequest wrapper for the DeleteContainerInstance operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerinstances/DeleteContainerInstance.go.html to see an example of how to use DeleteContainerInstanceRequest.

func (DeleteContainerInstanceRequest) BinaryRequestBody

func (request DeleteContainerInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteContainerInstanceRequest) HTTPRequest

func (request DeleteContainerInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteContainerInstanceRequest) RetryPolicy

func (request DeleteContainerInstanceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteContainerInstanceRequest) String

func (request DeleteContainerInstanceRequest) String() string

func (DeleteContainerInstanceRequest) ValidateEnumValue

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

type DeleteContainerInstanceResponse

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"`
}

DeleteContainerInstanceResponse wrapper for the DeleteContainerInstance operation

func (DeleteContainerInstanceResponse) HTTPResponse

func (response DeleteContainerInstanceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteContainerInstanceResponse) String

func (response DeleteContainerInstanceResponse) String() string

type 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
}

GetContainerInstanceRequest wrapper for the GetContainerInstance operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerinstances/GetContainerInstance.go.html to see an example of how to use GetContainerInstanceRequest.

func (GetContainerInstanceRequest) BinaryRequestBody

func (request GetContainerInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetContainerInstanceRequest) HTTPRequest

func (request GetContainerInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetContainerInstanceRequest) RetryPolicy

func (request GetContainerInstanceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetContainerInstanceRequest) String

func (request GetContainerInstanceRequest) String() string

func (GetContainerInstanceRequest) ValidateEnumValue

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

type GetContainerInstanceResponse

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"`
}

GetContainerInstanceResponse wrapper for the GetContainerInstance operation

func (GetContainerInstanceResponse) HTTPResponse

func (response GetContainerInstanceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetContainerInstanceResponse) String

func (response GetContainerInstanceResponse) String() string

type 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
}

GetContainerRequest wrapper for the GetContainer operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerinstances/GetContainer.go.html to see an example of how to use GetContainerRequest.

func (GetContainerRequest) BinaryRequestBody

func (request GetContainerRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetContainerRequest) HTTPRequest

func (request GetContainerRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetContainerRequest) RetryPolicy

func (request GetContainerRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetContainerRequest) String

func (request GetContainerRequest) String() string

func (GetContainerRequest) ValidateEnumValue

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

type GetContainerResponse

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"`
}

GetContainerResponse wrapper for the GetContainer operation

func (GetContainerResponse) HTTPResponse

func (response GetContainerResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetContainerResponse) String

func (response GetContainerResponse) String() string

type 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
}

GetWorkRequestRequest wrapper for the GetWorkRequest operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerinstances/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.

func (GetWorkRequestRequest) BinaryRequestBody

func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetWorkRequestRequest) HTTPRequest

func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy

func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetWorkRequestRequest) String

func (request GetWorkRequestRequest) String() string

func (GetWorkRequestRequest) ValidateEnumValue

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

type GetWorkRequestResponse

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"`
}

GetWorkRequestResponse wrapper for the GetWorkRequest operation

func (GetWorkRequestResponse) HTTPResponse

func (response GetWorkRequestResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String

func (response GetWorkRequestResponse) String() string

type HealthCheckHttpHeader

type HealthCheckHttpHeader struct {

	// Container HTTP header Key.
	Name *string `mandatory:"true" json:"name"`

	// Container HTTP header value.
	Value *string `mandatory:"true" json:"value"`
}

HealthCheckHttpHeader Container Http headers for Http health check.

func (HealthCheckHttpHeader) String

func (m HealthCheckHttpHeader) String() string

func (HealthCheckHttpHeader) ValidateEnumValue

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

type ImagePullSecret

type ImagePullSecret interface {

	// The registry endpoint of the container image.
	GetRegistryEndpoint() *string
}

ImagePullSecret The image pull secrets for accessing private registry to pull images for containers

type ImagePullSecretSecretTypeEnum

type ImagePullSecretSecretTypeEnum string

ImagePullSecretSecretTypeEnum Enum with underlying type: string

const (
	ImagePullSecretSecretTypeBasic ImagePullSecretSecretTypeEnum = "BASIC"
	ImagePullSecretSecretTypeVault ImagePullSecretSecretTypeEnum = "VAULT"
)

Set of constants representing the allowable values for ImagePullSecretSecretTypeEnum

func GetImagePullSecretSecretTypeEnumValues

func GetImagePullSecretSecretTypeEnumValues() []ImagePullSecretSecretTypeEnum

GetImagePullSecretSecretTypeEnumValues Enumerates the set of values for ImagePullSecretSecretTypeEnum

func GetMappingImagePullSecretSecretTypeEnum

func GetMappingImagePullSecretSecretTypeEnum(val string) (ImagePullSecretSecretTypeEnum, bool)

GetMappingImagePullSecretSecretTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type LinuxSecurityContext added in v65.47.1

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"`
}

LinuxSecurityContext Security context for Linux container.

func (LinuxSecurityContext) MarshalJSON added in v65.47.1

func (m LinuxSecurityContext) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (LinuxSecurityContext) String added in v65.47.1

func (m LinuxSecurityContext) String() string

func (LinuxSecurityContext) ValidateEnumValue added in v65.47.1

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

type 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
}

ListContainerInstanceShapesRequest wrapper for the ListContainerInstanceShapes operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerinstances/ListContainerInstanceShapes.go.html to see an example of how to use ListContainerInstanceShapesRequest.

func (ListContainerInstanceShapesRequest) BinaryRequestBody

func (request ListContainerInstanceShapesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListContainerInstanceShapesRequest) HTTPRequest

func (request ListContainerInstanceShapesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListContainerInstanceShapesRequest) RetryPolicy

func (request ListContainerInstanceShapesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListContainerInstanceShapesRequest) String

func (request ListContainerInstanceShapesRequest) String() string

func (ListContainerInstanceShapesRequest) ValidateEnumValue

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

type ListContainerInstanceShapesResponse

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"`
}

ListContainerInstanceShapesResponse wrapper for the ListContainerInstanceShapes operation

func (ListContainerInstanceShapesResponse) HTTPResponse

func (response ListContainerInstanceShapesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListContainerInstanceShapesResponse) String

func (response ListContainerInstanceShapesResponse) String() string

type 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
}

ListContainerInstancesRequest wrapper for the ListContainerInstances operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerinstances/ListContainerInstances.go.html to see an example of how to use ListContainerInstancesRequest.

func (ListContainerInstancesRequest) BinaryRequestBody

func (request ListContainerInstancesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListContainerInstancesRequest) HTTPRequest

func (request ListContainerInstancesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListContainerInstancesRequest) RetryPolicy

func (request ListContainerInstancesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListContainerInstancesRequest) String

func (request ListContainerInstancesRequest) String() string

func (ListContainerInstancesRequest) ValidateEnumValue

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

type ListContainerInstancesResponse

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"`
}

ListContainerInstancesResponse wrapper for the ListContainerInstances operation

func (ListContainerInstancesResponse) HTTPResponse

func (response ListContainerInstancesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListContainerInstancesResponse) String

func (response ListContainerInstancesResponse) String() string

type ListContainerInstancesSortByEnum

type ListContainerInstancesSortByEnum string

ListContainerInstancesSortByEnum Enum with underlying type: string

const (
	ListContainerInstancesSortByTimecreated ListContainerInstancesSortByEnum = "timeCreated"
	ListContainerInstancesSortByDisplayname ListContainerInstancesSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListContainerInstancesSortByEnum

func GetListContainerInstancesSortByEnumValues

func GetListContainerInstancesSortByEnumValues() []ListContainerInstancesSortByEnum

GetListContainerInstancesSortByEnumValues Enumerates the set of values for ListContainerInstancesSortByEnum

func GetMappingListContainerInstancesSortByEnum

func GetMappingListContainerInstancesSortByEnum(val string) (ListContainerInstancesSortByEnum, bool)

GetMappingListContainerInstancesSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListContainerInstancesSortOrderEnum

type ListContainerInstancesSortOrderEnum string

ListContainerInstancesSortOrderEnum Enum with underlying type: string

const (
	ListContainerInstancesSortOrderAsc  ListContainerInstancesSortOrderEnum = "ASC"
	ListContainerInstancesSortOrderDesc ListContainerInstancesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListContainerInstancesSortOrderEnum

func GetListContainerInstancesSortOrderEnumValues

func GetListContainerInstancesSortOrderEnumValues() []ListContainerInstancesSortOrderEnum

GetListContainerInstancesSortOrderEnumValues Enumerates the set of values for ListContainerInstancesSortOrderEnum

func GetMappingListContainerInstancesSortOrderEnum

func GetMappingListContainerInstancesSortOrderEnum(val string) (ListContainerInstancesSortOrderEnum, bool)

GetMappingListContainerInstancesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListContainersRequest wrapper for the ListContainers operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerinstances/ListContainers.go.html to see an example of how to use ListContainersRequest.

func (ListContainersRequest) BinaryRequestBody

func (request ListContainersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListContainersRequest) HTTPRequest

func (request ListContainersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListContainersRequest) RetryPolicy

func (request ListContainersRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListContainersRequest) String

func (request ListContainersRequest) String() string

func (ListContainersRequest) ValidateEnumValue

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

type ListContainersResponse

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"`
}

ListContainersResponse wrapper for the ListContainers operation

func (ListContainersResponse) HTTPResponse

func (response ListContainersResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListContainersResponse) String

func (response ListContainersResponse) String() string

type ListContainersSortByEnum

type ListContainersSortByEnum string

ListContainersSortByEnum Enum with underlying type: string

const (
	ListContainersSortByTimecreated ListContainersSortByEnum = "timeCreated"
	ListContainersSortByDisplayname ListContainersSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListContainersSortByEnum

func GetListContainersSortByEnumValues

func GetListContainersSortByEnumValues() []ListContainersSortByEnum

GetListContainersSortByEnumValues Enumerates the set of values for ListContainersSortByEnum

func GetMappingListContainersSortByEnum

func GetMappingListContainersSortByEnum(val string) (ListContainersSortByEnum, bool)

GetMappingListContainersSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListContainersSortOrderEnum

type ListContainersSortOrderEnum string

ListContainersSortOrderEnum Enum with underlying type: string

const (
	ListContainersSortOrderAsc  ListContainersSortOrderEnum = "ASC"
	ListContainersSortOrderDesc ListContainersSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListContainersSortOrderEnum

func GetListContainersSortOrderEnumValues

func GetListContainersSortOrderEnumValues() []ListContainersSortOrderEnum

GetListContainersSortOrderEnumValues Enumerates the set of values for ListContainersSortOrderEnum

func GetMappingListContainersSortOrderEnum

func GetMappingListContainersSortOrderEnum(val string) (ListContainersSortOrderEnum, bool)

GetMappingListContainersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerinstances/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.

func (ListWorkRequestErrorsRequest) BinaryRequestBody

func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) HTTPRequest

func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy

func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListWorkRequestErrorsRequest) String

func (request ListWorkRequestErrorsRequest) String() string

func (ListWorkRequestErrorsRequest) ValidateEnumValue

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

type ListWorkRequestErrorsResponse

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"`
}

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsResponse) HTTPResponse

func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestErrorsSortByEnum added in v65.49.0

type ListWorkRequestErrorsSortByEnum string

ListWorkRequestErrorsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestErrorsSortByTimestamp ListWorkRequestErrorsSortByEnum = "timestamp"
)

Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortByEnumValues added in v65.49.0

func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum

GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum added in v65.49.0

func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)

GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestErrorsSortOrderEnum added in v65.49.0

type ListWorkRequestErrorsSortOrderEnum string

ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string

const (
	ListWorkRequestErrorsSortOrderAsc  ListWorkRequestErrorsSortOrderEnum = "ASC"
	ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestErrorsSortOrderEnumValues added in v65.49.0

func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum

GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum added in v65.49.0

func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)

GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerinstances/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.

func (ListWorkRequestLogsRequest) BinaryRequestBody

func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestLogsRequest) HTTPRequest

func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy

func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListWorkRequestLogsRequest) String

func (request ListWorkRequestLogsRequest) String() string

func (ListWorkRequestLogsRequest) ValidateEnumValue

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

type ListWorkRequestLogsResponse

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"`
}

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsResponse) HTTPResponse

func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestLogsSortByEnum added in v65.49.0

type ListWorkRequestLogsSortByEnum string

ListWorkRequestLogsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestLogsSortByTimestamp ListWorkRequestLogsSortByEnum = "timestamp"
)

Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortByEnumValues added in v65.49.0

func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum

GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum added in v65.49.0

func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)

GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestLogsSortOrderEnum added in v65.49.0

type ListWorkRequestLogsSortOrderEnum string

ListWorkRequestLogsSortOrderEnum Enum with underlying type: string

const (
	ListWorkRequestLogsSortOrderAsc  ListWorkRequestLogsSortOrderEnum = "ASC"
	ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestLogsSortOrderEnumValues added in v65.49.0

func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum

GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum added in v65.49.0

func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)

GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerinstances/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.

func (ListWorkRequestsRequest) BinaryRequestBody

func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestsRequest) HTTPRequest

func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy

func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListWorkRequestsRequest) String

func (request ListWorkRequestsRequest) String() string

func (ListWorkRequestsRequest) ValidateEnumValue

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

type ListWorkRequestsResponse

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"`
}

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

func (ListWorkRequestsResponse) HTTPResponse

func (response ListWorkRequestsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String

func (response ListWorkRequestsResponse) String() string

type ListWorkRequestsSortByEnum added in v65.49.0

type ListWorkRequestsSortByEnum string

ListWorkRequestsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)

Set of constants representing the allowable values for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortByEnumValues added in v65.49.0

func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum

GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum added in v65.49.0

func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)

GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestsSortOrderEnum added in v65.49.0

type ListWorkRequestsSortOrderEnum string

ListWorkRequestsSortOrderEnum Enum with underlying type: string

const (
	ListWorkRequestsSortOrderAsc  ListWorkRequestsSortOrderEnum = "ASC"
	ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsSortOrderEnumValues added in v65.49.0

func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum

GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum added in v65.49.0

func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)

GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestsStatusEnum added in v65.49.0

type ListWorkRequestsStatusEnum string

ListWorkRequestsStatusEnum Enum with underlying type: string

const (
	ListWorkRequestsStatusAccepted   ListWorkRequestsStatusEnum = "ACCEPTED"
	ListWorkRequestsStatusInProgress ListWorkRequestsStatusEnum = "IN_PROGRESS"
	ListWorkRequestsStatusFailed     ListWorkRequestsStatusEnum = "FAILED"
	ListWorkRequestsStatusSucceeded  ListWorkRequestsStatusEnum = "SUCCEEDED"
	ListWorkRequestsStatusCanceling  ListWorkRequestsStatusEnum = "CANCELING"
	ListWorkRequestsStatusCanceled   ListWorkRequestsStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for ListWorkRequestsStatusEnum

func GetListWorkRequestsStatusEnumValues added in v65.49.0

func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum

GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum

func GetMappingListWorkRequestsStatusEnum added in v65.49.0

func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)

GetMappingListWorkRequestsStatusEnum performs case Insensitive comparison on enum value and return the desired enum

type OperationStatusEnum

type OperationStatusEnum string

OperationStatusEnum Enum with underlying type: string

const (
	OperationStatusAccepted   OperationStatusEnum = "ACCEPTED"
	OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
	OperationStatusFailed     OperationStatusEnum = "FAILED"
	OperationStatusSucceeded  OperationStatusEnum = "SUCCEEDED"
	OperationStatusCanceling  OperationStatusEnum = "CANCELING"
	OperationStatusCanceled   OperationStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for OperationStatusEnum

func GetMappingOperationStatusEnum

func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)

GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOperationStatusEnumValues

func GetOperationStatusEnumValues() []OperationStatusEnum

GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum

type OperationTypeEnum

type OperationTypeEnum string

OperationTypeEnum Enum with underlying type: string

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"
)

Set of constants representing the allowable values for OperationTypeEnum

func GetMappingOperationTypeEnum

func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)

GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOperationTypeEnumValues

func GetOperationTypeEnumValues() []OperationTypeEnum

GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum

type 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
}

RestartContainerInstanceRequest wrapper for the RestartContainerInstance operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerinstances/RestartContainerInstance.go.html to see an example of how to use RestartContainerInstanceRequest.

func (RestartContainerInstanceRequest) BinaryRequestBody

func (request RestartContainerInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (RestartContainerInstanceRequest) HTTPRequest

func (request RestartContainerInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (RestartContainerInstanceRequest) RetryPolicy

func (request RestartContainerInstanceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (RestartContainerInstanceRequest) String

func (request RestartContainerInstanceRequest) String() string

func (RestartContainerInstanceRequest) ValidateEnumValue

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

type RestartContainerInstanceResponse

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"`
}

RestartContainerInstanceResponse wrapper for the RestartContainerInstance operation

func (RestartContainerInstanceResponse) HTTPResponse

func (response RestartContainerInstanceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (RestartContainerInstanceResponse) String

func (response RestartContainerInstanceResponse) String() string

type 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
}

RetrieveLogsRequest wrapper for the RetrieveLogs operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerinstances/RetrieveLogs.go.html to see an example of how to use RetrieveLogsRequest.

func (RetrieveLogsRequest) BinaryRequestBody

func (request RetrieveLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (RetrieveLogsRequest) HTTPRequest

func (request RetrieveLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (RetrieveLogsRequest) RetryPolicy

func (request RetrieveLogsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (RetrieveLogsRequest) String

func (request RetrieveLogsRequest) String() string

func (RetrieveLogsRequest) ValidateEnumValue

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

type RetrieveLogsResponse

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"`
}

RetrieveLogsResponse wrapper for the RetrieveLogs operation

func (RetrieveLogsResponse) HTTPResponse

func (response RetrieveLogsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (RetrieveLogsResponse) String

func (response RetrieveLogsResponse) String() string

type SecurityContext added in v65.47.1

type SecurityContext interface {
}

SecurityContext Security context for container.

type SecurityContextSecurityContextTypeEnum added in v65.47.1

type SecurityContextSecurityContextTypeEnum string

SecurityContextSecurityContextTypeEnum Enum with underlying type: string

const (
	SecurityContextSecurityContextTypeLinux SecurityContextSecurityContextTypeEnum = "LINUX"
)

Set of constants representing the allowable values for SecurityContextSecurityContextTypeEnum

func GetMappingSecurityContextSecurityContextTypeEnum added in v65.47.1

func GetMappingSecurityContextSecurityContextTypeEnum(val string) (SecurityContextSecurityContextTypeEnum, bool)

GetMappingSecurityContextSecurityContextTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSecurityContextSecurityContextTypeEnumValues added in v65.47.1

func GetSecurityContextSecurityContextTypeEnumValues() []SecurityContextSecurityContextTypeEnum

GetSecurityContextSecurityContextTypeEnumValues Enumerates the set of values for SecurityContextSecurityContextTypeEnum

type ShapeMemoryOptions

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"`
}

ShapeMemoryOptions For a flexible shape, the amount of memory available for container instances that use this shape.

func (ShapeMemoryOptions) String

func (m ShapeMemoryOptions) String() string

func (ShapeMemoryOptions) ValidateEnumValue

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

type ShapeNetworkingBandwidthOptions

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"`
}

ShapeNetworkingBandwidthOptions For a flexible shape, the amount of networking bandwidth available for container instances that use this shape.

func (ShapeNetworkingBandwidthOptions) String

func (ShapeNetworkingBandwidthOptions) ValidateEnumValue

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

type ShapeOcpuOptions

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"`
}

ShapeOcpuOptions For a flexible shape, the number of OCPUs available for container instances that use this shape.

func (ShapeOcpuOptions) String

func (m ShapeOcpuOptions) String() string

func (ShapeOcpuOptions) ValidateEnumValue

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

type SortOrderEnum

type SortOrderEnum string

SortOrderEnum Enum with underlying type: string

const (
	SortOrderAsc  SortOrderEnum = "ASC"
	SortOrderDesc SortOrderEnum = "DESC"
)

Set of constants representing the allowable values for SortOrderEnum

func GetMappingSortOrderEnum

func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)

GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSortOrderEnumValues

func GetSortOrderEnumValues() []SortOrderEnum

GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum

type 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
}

StartContainerInstanceRequest wrapper for the StartContainerInstance operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerinstances/StartContainerInstance.go.html to see an example of how to use StartContainerInstanceRequest.

func (StartContainerInstanceRequest) BinaryRequestBody

func (request StartContainerInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (StartContainerInstanceRequest) HTTPRequest

func (request StartContainerInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (StartContainerInstanceRequest) RetryPolicy

func (request StartContainerInstanceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (StartContainerInstanceRequest) String

func (request StartContainerInstanceRequest) String() string

func (StartContainerInstanceRequest) ValidateEnumValue

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

type StartContainerInstanceResponse

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"`
}

StartContainerInstanceResponse wrapper for the StartContainerInstance operation

func (StartContainerInstanceResponse) HTTPResponse

func (response StartContainerInstanceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (StartContainerInstanceResponse) String

func (response StartContainerInstanceResponse) String() string

type 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
}

StopContainerInstanceRequest wrapper for the StopContainerInstance operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerinstances/StopContainerInstance.go.html to see an example of how to use StopContainerInstanceRequest.

func (StopContainerInstanceRequest) BinaryRequestBody

func (request StopContainerInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (StopContainerInstanceRequest) HTTPRequest

func (request StopContainerInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (StopContainerInstanceRequest) RetryPolicy

func (request StopContainerInstanceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (StopContainerInstanceRequest) String

func (request StopContainerInstanceRequest) String() string

func (StopContainerInstanceRequest) ValidateEnumValue

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

type StopContainerInstanceResponse

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"`
}

StopContainerInstanceResponse wrapper for the StopContainerInstance operation

func (StopContainerInstanceResponse) HTTPResponse

func (response StopContainerInstanceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (StopContainerInstanceResponse) String

func (response StopContainerInstanceResponse) String() string

type UpdateContainerDetails

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"`
}

UpdateContainerDetails The container information to be updated.

func (UpdateContainerDetails) String

func (m UpdateContainerDetails) String() string

func (UpdateContainerDetails) ValidateEnumValue

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

type UpdateContainerInstanceDetails

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"`
}

UpdateContainerInstanceDetails The information to be updated.

func (UpdateContainerInstanceDetails) String

func (UpdateContainerInstanceDetails) ValidateEnumValue

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

type 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
}

UpdateContainerInstanceRequest wrapper for the UpdateContainerInstance operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerinstances/UpdateContainerInstance.go.html to see an example of how to use UpdateContainerInstanceRequest.

func (UpdateContainerInstanceRequest) BinaryRequestBody

func (request UpdateContainerInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateContainerInstanceRequest) HTTPRequest

func (request UpdateContainerInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateContainerInstanceRequest) RetryPolicy

func (request UpdateContainerInstanceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateContainerInstanceRequest) String

func (request UpdateContainerInstanceRequest) String() string

func (UpdateContainerInstanceRequest) ValidateEnumValue

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

type UpdateContainerInstanceResponse

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"`
}

UpdateContainerInstanceResponse wrapper for the UpdateContainerInstance operation

func (UpdateContainerInstanceResponse) HTTPResponse

func (response UpdateContainerInstanceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateContainerInstanceResponse) String

func (response UpdateContainerInstanceResponse) String() string

type 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
}

UpdateContainerRequest wrapper for the UpdateContainer operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/containerinstances/UpdateContainer.go.html to see an example of how to use UpdateContainerRequest.

func (UpdateContainerRequest) BinaryRequestBody

func (request UpdateContainerRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateContainerRequest) HTTPRequest

func (request UpdateContainerRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateContainerRequest) RetryPolicy

func (request UpdateContainerRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateContainerRequest) String

func (request UpdateContainerRequest) String() string

func (UpdateContainerRequest) ValidateEnumValue

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

type UpdateContainerResponse

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"`
}

UpdateContainerResponse wrapper for the UpdateContainer operation

func (UpdateContainerResponse) HTTPResponse

func (response UpdateContainerResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateContainerResponse) String

func (response UpdateContainerResponse) String() string

type VaultImagePullSecret

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"`
}

VaultImagePullSecret A VaultImagePullSecret is a ImagePullSecret which accepts secretId as credentials information.

func (VaultImagePullSecret) GetRegistryEndpoint

func (m VaultImagePullSecret) GetRegistryEndpoint() *string

GetRegistryEndpoint returns RegistryEndpoint

func (VaultImagePullSecret) MarshalJSON

func (m VaultImagePullSecret) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (VaultImagePullSecret) String

func (m VaultImagePullSecret) String() string

func (VaultImagePullSecret) ValidateEnumValue

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

type VolumeMount

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"`
}

VolumeMount Define the mapping from volume to a mount path in container.

func (VolumeMount) String

func (m VolumeMount) String() string

func (VolumeMount) ValidateEnumValue

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

type WorkRequest

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"`
}

WorkRequest A description of the work request status.

func (WorkRequest) String

func (m WorkRequest) String() string

func (WorkRequest) ValidateEnumValue

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

type WorkRequestError

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"`
}

WorkRequestError An error encountered while executing a work request.

func (WorkRequestError) String

func (m WorkRequestError) String() string

func (WorkRequestError) ValidateEnumValue

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

type WorkRequestErrorCollection

type WorkRequestErrorCollection struct {

	// List of workRequestError objects.
	Items []WorkRequestError `mandatory:"true" json:"items"`
}

WorkRequestErrorCollection Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.

func (WorkRequestErrorCollection) String

func (WorkRequestErrorCollection) ValidateEnumValue

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

type WorkRequestLogEntry

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"`
}

WorkRequestLogEntry A log message from a work request.

func (WorkRequestLogEntry) String

func (m WorkRequestLogEntry) String() string

func (WorkRequestLogEntry) ValidateEnumValue

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

type WorkRequestLogEntryCollection

type WorkRequestLogEntryCollection struct {

	// List of workRequestLogEntries.
	Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}

WorkRequestLogEntryCollection Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.

func (WorkRequestLogEntryCollection) String

func (WorkRequestLogEntryCollection) ValidateEnumValue

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

type WorkRequestResource

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"`
}

WorkRequestResource A resource created or operated on by a work request.

func (WorkRequestResource) String

func (m WorkRequestResource) String() string

func (WorkRequestResource) ValidateEnumValue

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

type WorkRequestSummary

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"`
}

WorkRequestSummary A summary of the status of a work request.

func (WorkRequestSummary) String

func (m WorkRequestSummary) String() string

func (WorkRequestSummary) ValidateEnumValue

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

type WorkRequestSummaryCollection

type WorkRequestSummaryCollection struct {

	// List of workRequestSummary objects.
	Items []WorkRequestSummary `mandatory:"true" json:"items"`
}

WorkRequestSummaryCollection Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.

func (WorkRequestSummaryCollection) String

func (WorkRequestSummaryCollection) ValidateEnumValue

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

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL